Using the CA Repository Universal XML Exchange Control File Builder › Control File Tags

Control File Tags

The following section lists the control file tags and their usage:

• CARepository_Control

  Defines the Control File document. All other tags must be enclosed between <CARepository_Control> and </CARepository_Control>;

• Object_Map

  Defines the mapping of XML objects to their repository tables. Each object in the XML document can map to multiple tables in the repository so the Repository_Table tag can appear multiple times for the same object.

  This groups the processing of an XML object, which is defined as any item that has an attribute defined as ID="..." providing a unique identifier to the XML document.

• Object

  Describes the ID and location of XML objects.

  Attribute:

  key—The key attribute in an XML object defines the ID for that particular object. If the key attribute is not present in the XML object, the ID (IdAttr) specified at the top of the XML file is taken as the default.

• Repository_Table

  Groups the information to be recorded in one of the repository tables. Each object can be recorded in one or more tables in the repository.

• Table

  Provides the name of the repository table that is to receive the data.

  Attribute:

  output—Determines whether this entry is always created, or is dependent on the attribute data found inside the XML object. The output attribute has the following values:

  • Mandatory—Always records in this table.
  • Optional—Records if applicable. A <Rule> indicates when this applies.
  • Choice—Records in any one of the tables used. Rule tags determine which one applies. Only one table (without rules) can be the default to use if no rules match.
• Attr_Map

  Groups the recording and rule checking for a single tag in the XML stream.

• Attr

  Provides the tag name to search for in the XML stream. Do not include the < and > characters.

  Note: Do not include the < and > characters.

  Attributes:

  • check—Determines whether this XML element or a parent XML element contains the tagname in the XML document. The check attribute has the following values:
    • Parent—Searches the tagname in a parent XML element.
    • None—Searches the tagname in the XML element currently being processed.
  • default—An attribute default = "…." can exist inside Attr. If this attribute does not exist in the input XML file, this default value is uploaded to the work tables. Otherwise, the attribute value from the input XML file is uploaded to the work tables.
• Column

  Defines the name of the column in the repository that receives the data.

  Note: Text such as descriptions, comments, and so forth are stored separately and must be specified using <TextCol>.

• TextCol

  Specifies that the attribute contents are stored as Text. The required attribute type determines which repository text table receives the data.

• Rule

  Determines whether the rule for the current table (optional or choice) applies.

  Attributes:

  • action—Includes or excludes attribute from processing. The action attribute has the following values:
    • Include—Includes the attribute if the rule is satisfied.
    • Exclude—Excludes the attribute if the rule is satisfied.
  • type—The type is mandatory. The type attribute has the following values:
    • Exists—Records in the current table if this tag is found.
    • Equals—Records whether the tag in the XML file has the same contents as in the control file.
    • LT—Records whether the contents are less than this value. Operators LE, GE, GT, and NE are also supported.
• Relationship

  Groups the tags defining when an association or relationship is recorded in the repository. The Relationship tag encloses the definitions of the containment and split-entity associations and relationships.

• RelName

  Defines the name of the repository association or relationship. For relationships, you can specify that the relationship be recorded only if a corresponding Table, typically having output=optional, is being recorded.

  Attributes:

  • output—Determines whether this entry is always created, or whether this is dependent on attribute data of the source or target. The output attribute has the following values:
    • mandatory—Always records in this.
    • optional—Records if applicable. A <Rule> indicates when this applies.
  • type—Determines whether relationship is dependent or not on another object existing in the XML document for the repository relationship. The type attribute has the following values:
    • standard—Makes this a nonconditional relationship
    • conditional—Makes this a conditional relationship.

    Default: Standard

  • test—Determines which entity controls the recording of this relationship. The test attribute has the following values:
    • Source
    • Target
• Source

  Defines the name of the repository entity-type (Table) that is the source end of the relationship.

  Attribute:

  key—The attribute key="..." is written in the source only if it is different from ID (IdAttr). Otherwise, the ID (IdAttr) is taken as the key.

• Target

  Defines the name of the repository target end of the relationship.

  Attribute:

  key—The attribute key="..." is written in the target only if it is different from ID (IdAttr). Otherwise, the ID (IdAttr) is taken as the key.

• Type

  Determines the type of relationship. The Type tag contains the following values:

  • CONTAINS—Used when the target entity is found inside the tags for the source entity in the XML file (or conversely).
  • SIBLINGS—Used when an XML object is recorded in more than one Repository table. This relationship is created when the source and the target entity types derive from the same origin.

REFERENCE—This relationship is recorded if the XML attribute or XML element points to the ID attribute elsewhere in the document and a relationship is to be created between these XML objects. Enter the XML attribute or XML element that references the ID attribute if the type is Reference. Select SrcAsRefAttr check box if source is the reference attribute in the Reference relationship. If target is the reference attribute in this relationship then do not select SrcAsRefAttr.

• ATPAR—This relationship is used when a relationship needs to be created between two elements that are at the same level in an XML file. This relationship has the following additional tags:
  • SourceRef—Describes the path for source ID
  • TargetRef—Describes the path for target ID
  • RelidRef—Describes the path for relationship ID

  Note: For the relationship types - CONTAINS, SIBLINGS and REFERENCE - the KEY_GUID generated in the work tables, is either from source_id or target_id. However, for the ATPAR relationship, the KEY_GUID is generated from the RelidRef attribute.

Attribute:

SrcAsRefAttr= true /false—Determines whether the source or the target is the reference attribute. Must be used with Type – tagname when source and target are same objects

• Mapping

  Contains the specifications for translating the content of an XML tag to the content of a repository column.

  Example: true->Y; false->N.

  Allows replacement of string pattern using tags FromPattern and ToPattern

  For example: replace dashes on underscores

  <FromPattern>-</FromPattern>

  <ToPattern>_</ToPattern>

• FromSource

  Groups a combination of Object and Attr tags to declare the source tag in the XML file.

• ToRepository

  Correspondingly groups the Table and the Column to receive the translated content.

• Convert

  Groups the before and after content of the mapping.

• FromValue

  Defines the value to find in the original XML tag.

• ToValue

  Defines the value to record in the repository column.

• FromPattern

  Defines the value of the replaced string in the original XML tag.

• ToPattern

  Defines the value of the replacing string in the repository column.