Creating an IS Document Type from a Broker Document Type

You can create an IS document type from a Broker document type in Designer, if the Integration Server is connected to a Broker. The IS document type retains the structure, fields, data types, and publication properties defined in the Broker document type.

When you create an IS document type from a Broker document type, you create a publishable document type. A publishable document type is an IS document type with specific publishing properties, such as storage type and time to live. Additionally, a publishable document type on an Integration Server is bound to a Broker document type. An instance of a publishable document type can be published to a Broker or locally within an Integration Server. For more information about publishable document types, see Working with Publishable Document Types.

3. In the Element name field, type a name for the IS document type using any combination of letters, numbers, and/or the underscore character. For information about restricted characters, see About Element Names.

6. On the Select a Broker Document Type panel, do one of the following to specify the source file for the document type:

a. Select the Broker document type from which you want to create an IS document type, from the displayed list of Broker document types on the Broker territory to which the Integration Server is connected.

You can also type a search string in the Enter Broker document type name field to filter the list of Broker document types.

b. If you want to replace existing elements in the Integration Server namespace with identically named elements referenced by the Broker document type, select the Overwrite existing elements when importing referenced elements check box.

Important: Overwriting the existing elements completely replaces the existing element with the content of the referenced element. Any elements on the Integration Server that depend on the replaced element, such as flow services, IS document types, and specifications, might be affected. For more information about overwriting referenced elements, see Importing and Overwriting References During Synchronization.

7. Click Finish. Designer refreshes the Package Navigator view automatically and displays the new document type.

When you create an IS document type from a Broker document type that references other elements, Designer will also create an element for each referenced element. Integration Server will contain a document type that corresponds to the Broker document type and one new element for each element the Broker document type references. Designer also creates the folder in which the referenced element was located. Designer saves the new elements in the package you selected for storing the new publishable document type.

For example, suppose that the Broker document type references a document type named address in the customerInfo folder. Designer would create an IS document type named address and save it in the customerInfo folder. If a field in the Broker document type was constrained by a simple type definition declared in the IS schema purchaseOrder, Designer would create the referenced IS schema purchaseOrder.

You can associate only one IS document type with a given Broker document type. If you try to create a publishable document type from a Broker document type that is already associated with a publishable document type on your Integration Server, Designer displays an error message.

If you did not select the Overwrite existing elements when importing referenced elements check box and the Broker document type references an element with the same name as an existing Integration Server element, Designer will not create the publishable document type. For more information about overwriting referenced elements, see Importing and Overwriting References During Synchronization

In the Publication category of the Properties panel, the Provider definition property displays the name of the Broker document type used to create the publishable document type. Or, if you are not connected to a Broker, this field displays Not Publishable. You cannot edit the contents of this field. For more information about the contents of this field, see About the Associated Provider Definition.

Once a publishable document type has an associated Broker document type, you need to make sure that the document types remain in sync. That is, changes in one document type must be made to the associated document type. You can update one document type with changes in the other by synchronizing them. For information about synchronizing document types, see About Synchronizing Publishable Document Types.