Adding Fields to an IS Document Type

By adding fields to an IS document type, you define the structure and content of instances of the IS document type.

Note:
When defining an IS document type, avoid adding identically named fields to the IS document. In particular, avoid adding identically named fields that are the same data type. While Designer allows this, the identically named fields may cause some anomalies especially with regards to mapping data in the pipeline.

Keep the following points in mind if you intend to make the IS document type publishable:

If you intend to use Broker as the messaging provider, keep in mind that the Broker has restrictions for field names. When a document is published to Broker, fields with names that do not meet these restrictions will be passed through byBroker. If you create a trigger that subscribes to the publishable document type, any filters that include field names containing restricted characters will be saved on the Integration Server only. The filters will not be saved on the Broker, possibly affecting Integration Server performance. For more information, see Creating a webMethods Messaging Trigger .

If you intend to use Universal Messaging as the messaging provider and use protocol buffers as the encoding type, keep in mind that some field names might not work with protocol buffers. If a publishable document type contains fields that use unsupported characters, these fields and their contents will be passed through to Universal Messaging. Subscribing triggers will decode the field properly. However, Universal Messaging cannot filter on the contents of these fields.

Note:
If a publishable document types uses protocol buffers encoding type, Software AG recommends using a letter as the first character of a field name and avoiding special characters with the exception of the _ (underscore) character.

To add fields to the IS document type

1. In Package Navigator view, double-click the document type to which you want to add fields.

The document type opens in the Tree tab of the document type editor.

2. Drag the document type field that you want to define from the Palette to the Tree tab in the editor.

3. Type the name of the field and then press ENTER.

Note:
Do not use the % symbol in variable names. The % symbol is a reserved character because it is used in expressions for BRANCH steps and trigger filters.

Note:Designer prevents the insertion of fields named _env in an IS document type. For details about the _env field, see About the Envelope Field.

4. With the field selected, set field properties and apply constraints in the Properties view (optional).

5. If the field is a document or a document list, repeat the preceding steps to define and set the properties and constraints for each of its members. Use

to indent each member field beneath the document or document list field.

6. Enter comments or notes, if any, in the Comments tab.

7. Select File > Save.

Note:Designer displays small symbols next to a field icon to indicate validation constraints. Designer uses

to indicate an optional field. Designer uses the ‡ symbol to denote a field with a content constraint. For information about applying constraints to fields, see About Variable Constraints.