Create a B2B Document to Define Custom Definitions

You can create a customized document definition that you select in the Document Definition field of the EDI Translate Action Wizard in an integration. Custom document definitions are useful for environments in which your trading partner requires specific customizations to satisfy business requirements.

  1. From the left navigation pane on the Oracle Integration home page, select B2B > B2B Documents.
  2. Click Create.
  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 EDI X12 is automatically selected for use and cannot be deselected.
    Document Version Select the document version.
    Document Type Select the document type.

    For example:

  4. Click Create.
    The details page for your new B2B document is displayed. The Document Schema field shows Standard as the schema type by default.
    Document Schema field with Standard selected. Customize button is to the right.
  5. Click Customize 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 dropdown list. If you want, you can select those schemas to create further customizations.
    The Clone Standard Schema dialog is displayed.
  6. Enter a name and optional description for your custom schema.

  7. Click Clone.
    This action creates a copy of the standard EDI X12 schema for you to use as a baseline to customize.

  8. Find the element you want to customize, and select View Details. For this example, the CUR02 currency code element (part of the CUR segment) is selected.

    The Properties page is displayed.

    Three Properties page tabs enable you to perform customizations.
    Icon Description
    Properties icon Displayed by default when you initially access the Properties page. 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 icon Click to view the code list for the element. A code list defines an enumeration of allowed values for the element.
    Notes icon Click to add notes to the element.
  9. Edit properties as necessary for your business environment. For this example, Code list icon is selected to add new code.
  10. Click Add a New Code List (if the element does not already have a code list defined).
  11. Add a currency code name and optional description, and click x to save your updates.
  12. Add more, as necessary for your business requirements. For this example, EUR (for the Euro currency) and USD (for US dollars) currency codes are added.

  13. When complete, click X in the upper right corner to close the dialog and save your changes.
    The segment (CUR) and the element (CUR02) that you customized to deviate from the standard schema are identified by a round dot.

  14. Click Save.
  15. Return to the B2B document's details page and click Save to associate the customized schema to the document.
  16. Go to an orchestrated integration either to add a new EDI Translate action or edit an already configured EDI Translate action that is not part of an activated integration. See Use the EDI Translate Action.
  17. Note that the customized document definition is now selectable from the Document Definition list in the wizard.
    Document Definition field with custom document available for selection