Data Definition XML Files

These generated files were briefly introduced in Under the Hood. The .xml files describe the database tables and the constraints that should be placed on them.

Data Definition XML Files, shows a sample table definition. An entity can have any number of attribute elements. Not all elements will have all the attributes (the size attribute is only present for strings and Large Objects).

Figure 1. Table Definitions
<entities>
  <entity tablename="Fully qualified tablename"
    <attribute ddltype="DD Type from the UML Model"
               notnull="Indicator whether Nulls are allowed"
               size="Size qualifier for the DDL Type"
               />
  </entity>
</entities>

Data Definition XML Files, shows a sample foreign key constraint. There can be any number of key, association and foreignkeypair elements.

Note: If foreign keys are applied to a DB2 for z/OS database by the Data Manager manual intervention will be required to move the tables from the check_pending state. Please consult with your local Database Administrator (DBA) to resolve this.
Figure 2. Foreign Key Constraints
<foreignkeys>
  <key>
   <association tablename="Local Table name"
                othertablename="Remote table name"
                >
     <foreignkeypair localfield="Local field name"
                     remotefield="Remote field name"/>
    </association>
  </key>
</foreignkeys>

Data Definition XML Files, shows a sample primary key constraint. There can be any number of key and attribute elements.

Figure 3. Primary Key Constraints
<primarykeys>
  <key tablename="Fully qualified tablename">
    <attribute keyname="Field name"/>
  </key>
</primarykeys>

Data Definition XML Files, shows a sample index constraint. There can be any number of index and indexattribute elements.

Figure 4. Index Constraints
<indices>
  <index>
    <indexdetails tablename="Fully qualified tablename"
                  indexname="Name for the Index" >
      <indexattribute attribute="Field name"/>
    </indexdetails>
  </index>
</indices>

Data Definition XML Files, shows a sample Unique Constraint. This can have any number of constraint, association and attribute elements as necessary.

Figure 5. Unique Constraints
<uniqueconstraints>
  <constraint>
    <association tablename="fully qualified tablename">
      <attribute field="field name on table for constraint">
    </association>
  </constraint>
</uniqueconstraints>

Data Definition XML Files, shows a sample of the metadata that is generated to support the batch processes that have been modeled by the developer. There may be any number of batch processes which have any number of parameters.

Figure 6. Batch Metadata
<batches>
  <batch process="Process Name"
         operation="Operation Name"
         application="Application Name"
         >
    <parameter name="Parameter name"
               type="Domain Type"/>
  </batch>
</batches>

Data Definition XML Files, shows a sample of the metadata that is generated to support the security that has been modeled by the developer. There may be any number of function identifiers (FIDs).

Figure 7. Security Metadata
<fids>
  <fid
    name="Function identifier name"
    operation="Operation to allow access to"
    fidenabled="Indicate whether enabled by default or not"
    iswebservice="Indicate whether this is a web service"
   />
</fids>

Data Definition XML Files, shows a sample of the metadata that is generated to support the field level security that has been modeled by the developer. There may be any number of fields returned.

Figure 8. Field Level Security Metadata
<fieldsreturned>
    <fieldreturned
     operationname="Function identifier name"
     fieldname="Field name"
     sidname="Associated SID"
    />
</fieldsreturned>