CDD syntax

Each customization definition document (CDD) must follow a particular syntax, which is based on Extensible Markup Language (XML) syntax:
  • Information is organized using elements, each of which is represented by a start tag and an end tag. The start and end tags have identical names, except that the name of the end tag is preceded by a slash (/). In the following example, the outermost pair of begin and end tags describes an element called ServerList. The <ServerList> tag is the begin tag and the </ServerList> tag is the end tag. Everything in between these tags, including other tag pairs, is the content of the ServerList element. 
    <ServerList>
  <Server name="SERV1" primaryServer="true"  type="broker"></Server>
</ServerList>
  • Elements of the form <element_name>content</element_name> are used to specify the type and content of each piece of information. The begin and end tags of an element indicate the type of the information located between them. For example, the tags <ServerList>...</ServerList> indicate that the information between the two tags is a list of servers.
  • Elements can have attributes, which are included within the begin tag. Example: <OU name='BANKA'> has the attribute name, which has the value BANKA.
  • An element that contains no content between the start and end tag pair (<element_name></element_name>) can instead use a single tag of the form <element_name/>. For example, the following are equivalent: 
    <OU name="BANKA"></OU>
<OU name="BANKA"/>
  • Lines that begin with the characters <!-- indicate a comment. A comment can span any number of lines, and is ended by the characters -->.

The list of SVB assignments contains an SVB element for each public service bundle that is to be assigned to the OU and server specified by the corresponding attributes of the Assignment tag. The SVB elements determine which services each server can perform for each OU.

During the supplement step, the CDP:
  • Inserts Placeholder elements within each element to which they apply:
    • Instance
    • Server
    • OU
  • Creates the broker list section with the following elements:
    <BrokerList>
 <Broker servername="SERV1">
  <ExecutionGroupList>
   <ExecutionGroup name="EG1">
    <BrokerArchive additionalinstances="0" commitcount="1" commitinterval="0" name="barfile"/>
   </ExecutionGroup>
  </ExecutionGroupList>
 </Broker>
</BrokerList>

These placeholder-definition elements are empty, and each must be assigned a value before you issue the prepare command.

Figure 6 shows an excerpt from an example of a CDD. Table 1 describes the elements that can be used in a CDD.

Table 1. CDD elements
Element and its attributes Domain Min: Max Notes
CustomizationDefinition 1:1 Contains the elements that describe one instance. It is a mandatory element.
CustomizationControl 0:1 Contains the elements that describe the control elements. It is an optional subelement of the CustomizationDefinition element.
  DBType DB2 0:1 Type of the database. It controls which database statements are created.
Instance 1:1 Used to specify the attributes of and placeholders for an instance. It is a mandatory subelement of the CustomizationDefinition element.
  name [A-Z0-9] {1,8} 1:1 Name of the instance
ServerList 1:1 Contains the elements that describe the servers in the instance. It is a mandatory subelement of the CustomizationDefinition element.
Server 1:n Used to specify the attributes of and placeholders for a server. It is a mandatory subelement of the ServerList element.
  name [A-Z0-9] {1,8} 1:1 Name of the server
type broker|sag|was 0:1 Type of the server. Possible values are defined by the definition files of the service bundle sets being used. The default is broker.
primaryServer true|false 0:1 Whether the server is the primary server. A primary server is the server on which all resources that are to be deployed exactly once per instance are deployed. The default is false.
OUList 1:1 Contains the elements that describe the OUs in the instance. It is a mandatory subelement of the CustomizationDefinition element.
OU 1:n Used to specify the attributes of and placeholders for an OU. It is a mandatory subelement of the OUList element.
  name [A-Z0-9] {1,8} 1:1 Name of the OU
AssignmentList 1:1 Contains the elements that describe the service bundle assignments in the instance. It is a mandatory subelement of the CustomizationDefinition element.
Assignment 1:n Used to specify the attributes of and placeholders for a service bundle assignment. It is a mandatory subelement of the AssignmentList element.
  server [A-Z0-9] {1,8} 1:1 Name of the server that is to provide the services of the service bundles included in this assignment.
ou [A-Z0-9] {1,8} 1:1 Name of the OU to which the services of the service bundles included in this assignment are to be made available.
SVB 1:n Specifies a service bundle for a service bundle assignment. It is a mandatory subelement of the Assignment element.
  svbset string 1:1 Service bundle set to which the service bundle belongs.
name [A-Z0-9] {1,16} 1:1 Name of the service bundle.
BrokerList 0:1 Contains the elements that describe the broker servers in the instance.
Broker 1:n Contains the elements that describe a particular broker server.
  servername [A-Z0-9]{1,8} 1:1 Name of the broker server as defined in the CDD.
ExecutionGroupList 1:1 Contains the elements that describe the execution groups of a particular broker server.
ExecutionGroup 1:n Contains the elements that describe a particular execution group.
  name string 1:1 Name of the execution group.
BrokerArchive 1:n Assigns a BAR file to an execution group. It is a mandatory subelement of the ExecutionGroup element.
  additionalinstances integer 1:1 The value for the message flow attribute additional instances. The default is 0.
  commitcount integer 1:1 The value for the message flow attribute commit count. The default is 1.
  commitinterval integer 1:1 The value for the message flow attribute commit interval. The default is 0.
  name string 1:1 Name of the BAR file.
Placeholder 0:n Specifies the name of and value for a placeholder.
  name [A-Za-z0-9_<>] {5,20} 1:1 Name of the placeholder.
svbset string 1:1 Service bundle set to which the placeholder belongs.
value (depends on the domain specified for the placeholder in the service bundle set definition file) 1:1 Value with which all occurrences of the placeholder in the resource files are to be replaced when the deployment data is generated. This value must satisfy any restrictions specified for the placeholder in the service bundle set definition in which it is defined.
Notes:
  • In the Domain column, the values in square brackets indicate allowable characters, and the values in braces indicate the minimum and maximum number of characters. For example, [A-Z0-9] {1,8} indicates that the value must be between one and eight characters long, and can contain only digits and uppercase letters.
  • The Cardinality column indicates the minimum and maximum number of times an element or attribute can be specified.