Defining a process type's templates (Fulfillment process types only)

Document templates are used at various times throughout Sterling™ Order Management System. The template type indicates how it is used.

About this task

Typically, templates are required in scenarios in which a particular set of attributes of a given entity need to be considered for processing. For example, when calling the copyOrder() API, the Copy Order template is used to indicate which order attributes should be copied.

You can determine which XML attributes and elements should be included or excluded from master template XMLs for a given fulfillment process type.

To define a process type's XML templates:

Procedure

  1. From the tree in the application rules side panel, choose Process Modeling. The Process Modeling window displays in the work area.
  2. In the Process Modeling window, select the Order, Load, or General tab to view the corresponding process modeling tree for that base document type.
  3. In the Process Types swimlane, right-click on the applicable process type and choose Details. The Process Type Details window displays.
  4. Choose the Templates tab. The available master templates for the fulfillment process type you are working with display as tabs. These master templates are retrieved from the YFS_BASE_DOCUMENT_TYPE table.
  5. Choose the tab of the applicable master template. The master template XML is loaded from the YFS_BASE_DOCUMENT_TEMPLATE table and is combined with the template XML stored for this document type in the YFS_DOCUMENT_TEMPLATE table. Extended attributes are also added to the master template for each element that has extended attributes. The resulting XML is shown in hierarchical format in the tree.
    Note: The extended branch of the template XML is automatically generated. It is not stored in either the YFS_DOCUMENT_TEMPLATE or YFS_BASE_DOCUMENT_TEMPLATE tables.
  6. Choose the Create New icon to include an XML attribute or element in the master template XML for this process type. Choose the Delete icon to exclude an XML attribute in the master template XML for this process type.
    Note: If you want to exclude all of an element's attributes, you must exclude the entire element.
    Note: Some attributes are mandatory and cannot be excluded from the template.