Customize an EDIFACT, X12 or X12HIPAA Document Definition

You can customize an EDIFACT, X12 or X12 HIPAA document definition.

If you click Customize for EDIFACT, X12, or X12HIPAA, the Clone standard schema dialog is displayed. This option enables you to customize the standard schema to satisfy your business requirements.


The Document schema list is shown. The Customize button appears to the right.

  1. Enter the details to create a new B2B document definition.
  2. Click Save.

    This creates a copy of the standard EDIFACT, X12, or X12HIPAA 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

  3. 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.
  4. Edit the element details as necessary for your business environment. For this example, select Code List Code list icon to add new code.
  5. Click Add a new code list (if the element does not already have a code list defined).
  6. Define the syntax rules.
  7. When complete, click X in the upper right corner to close the dialog.
  8. Return to the B2B document's details page and click Save to associate the customized schema to the document.
  9. 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.
  10. Note that the customized document definition is now available to use from the Document schema list in the wizard.


    Document schema list with schemas available for selection. The Edit button is also displayed.