Create a Custom B2B Document Definition

You can create customized document definitions to use in your B2B integrations. Custom document definitions are useful for scenarios in which your trading partner requires specific customizations to meet certain business requirements.

  1. In the navigation pane, click B2B, then Documents.
  2. On the Documents page, click Create.

    The Create B2B document panel is displayed.

  3. Enter the following details to create a new B2B document definition.
    Element Description
    Name Enter a document name.
    Identifier This field is automatically populated with the document name. You can manually change this value.
    Description Enter an optional description of the customization details for this document.
    Document standard
    • EDIFACT
    • X12
    • X12HIPAA
    • OAG
    • Custom
    • RosettaNet (version 2.0)
    • FixedLength
    Document version
    Specify the document version.
    • Select a document version from the drop-down list for EDIFACT, X12, or X12HIPAA. The versions shown are based on the document standard you selected.
    • Manually enter a document version for FixedLength.
    Document type
    Specify the document type.
    • Select a document type from the drop-down list for EDIFACT, X12, or X12HIPAA. The types shown are based on the document version you selected.
    • Manually enter a document type for FixedLength.
  4. Click Create.

    The details page for your new B2B document is displayed.

If You Selected EDIFACT, X12, or X12HIPAA

  1. Note that the document version and document type values you selected previously are displayed. These cannot be changed.

    The Document schema field shows Standard as the schema type by default.


    Document schema field with Standard selected. The Customize button is shown to the right.

  2. Click Customize if you want to customize the standard schema to satisfy your business requirements. If you had previously created custom schemas, they are also displayed for selection in the drop-down list. If you want, you can select those schemas to create further customizations.

    The Clone standard schema dialog is displayed.

  3. Enter the details to create a new B2B document definition.
  4. Click Save.

    This action creates a copy of the standard EDI X12 or EDIFACT schema for you to use as a baseline to customize. For this example, the EDIFACT schema is shown.


    Description of clone_standard_schema2.png follows
    Description of the illustration clone_standard_schema2.png

  5. On the schema page, find the element you want to customize, and select Edit icon. As an example, select the UNH01 currency code element (part of the UNH segment) to edit it. You can also add new constructs to the schema. See Edit Properties of Segments and Other Schema Constructs.


    Description of clone_standard_schema3.png follows
    Description of the illustration clone_standard_schema3.png

    The Properties panel is displayed.


    Description of clone_standard_schema4.png follows
    Description of the illustration clone_standard_schema4.png

    The three tabs on the Details pane enable you to perform customizations.
    Tab Description
    Properties Properties icon Displayed by default when you initially access the Details pane. You can modify the following standard EDI X12 properties for the selected segment or element:
    • Purpose of element
    • Requirement (mandatory, optional, or conditional)
    • Usage (must use, do not use, recommended, or not recommended)
    • Minimum and maximum number of characters
    • Number of times to repeat the element
    Code List Code list icon Click to view the code list for the element. A code list defines an enumeration of allowed values for the element.
    Notes
    Notes icon

    Click to add notes to the element.
  6. Edit the element details as necessary for your business environment. For this example, select Code List Code list icon to add new code.
  7. Click Add a new code list (if the element does not already have a code list defined).
  8. Define the syntax rules.
  9. When complete, click X in the upper right corner to close the dialog.
  10. Return to the B2B document's details page and click Save to associate the customized schema to the document.
  11. Go to an orchestration integration either to add a new B2B action or edit an already configured B2B action that is not part of an activated integration. See Use the B2B Action in Standalone Mode.
  12. Note that the customized document definition is now available to use from the Document schema list in the wizard.


    Document Definition field with custom document available for selection

If You Selected RosettaNet

  1. Note that the document version and document type values are displayed.

    The Document schema field shows Standard as the schema type by default.

  2. Click Create to create the schema to satisfy your business requirements. If you had previously created custom schemas, they are also displayed for selection in the drop-down list. If you want, you can select those schemas to create further customizations.
  3. See Edit the RosettaNet Service Headers to Ensure Correct Message Correlation.

If You Selected OAG or Custom

  1. Enter a document version number in the Document Version field.
    • For custom XML documents, you can enter anything.
    • For OAG documents, you ideally would enter the supported version (7.1, 7.2.1, or 10.1).
  2. Enter a document type in the Document Type field.
    • For custom XML documents, you can enter anything.
    • For OAG documents, you ideally would enter the document type (for example, ProcessShipment).
  3. Click Create if you want to use a standard schema to satisfy your business requirements. If you had previously created custom schemas, they are also displayed for selection in the drop-down list. If you want, you can select those schemas to create further customizations.


    Document schema field with Standard selected. The Create button is shown to the right.

    The Clone standard schema dialog is displayed.

  4. Enter the details to create a new B2B document definition.
  5. Click Save.
  6. If you created an OAGIS document:
    1. Click Save, then click Back <.
    2. Scroll to the Document Property section at the bottom.
    3. Optionally enter a logical ID and auth ID.


      This image shows the Document selection field at the top. Below this are the Description field, Document standard field, Document version, Document type field, and Document schema field, Below this is the Document property section. The Business identifiers section is expanded to show the Expression field, Name field, DTD/XSD conversion field, Logical ID field, and Auth ID field.

  7. If you created a custom XML document:
    1. Click Save, then click Back <.
    2. Scroll to the Document Property section at the bottom.
    3. In the Identification expression (XPath) field, specify the identification type as an XPath expression. For example:
      /*[local-name()='FDG_INBOUND']

      This expression uniquely identifies the document. For this example, the XPath expression identifies that the document must have a root element of FDG_INBOUND. At runtime, when a document comes in, it identifies that this document belongs to this schema (for this example, CUSTOM_0_0_5_FDG).


      This image shows the Document selection field at the top. Below this are the Description field, Document standard field, Document type field, and Document schema field, Below this is the Document property section. The Business identifiers section is expanded to show the Expression field, Name field, Identification type list, Identification expression (XPath) field, and Identification value field.

If You Selected FixedLength

  1. Note that the document version and document type values you selected previously are displayed. These cannot be changed.

    The Document schema field shows a schema previously created (for this example, FL-SCH-1) as the schema type.


    Document schema field with FL-SCH-1 selected. The Edit button is shown to the right.

  2. Scroll down and specify values for the following fields.
    Element Description
    Expression Click to select business identifiers.
    Identification type Displays Flat. This value cannot be changed.
    Identification value Enter the segment key for identifying the payload (for example, BGM).
    Identification start position Enter the character position for the identifier (for example, 1).
    Identification end position Enter the character position for the identifier (for example, 3).
  3. Click Save.