1. Using B2B for Oracle Integration Generation 2
  2. B2B Documents and B2B Schemas
  3. Work with B2B Schemas
  4. Generate an Implementation Guide

Generate an Implementation Guide

You can generate implementation guides for standard or customized schemas to share with your trading partners.

Topics:

About the Implementation Guide

An implementation guide is a single, consolidated document with full details about a B2B schema.

Typically, a host company shares the implementation guide for an EDI schema with their trading partners. This guide is shared especially when a schema has been customized to deviate from a standard X12 document. It points out some of the customizations made to the standard schema (not all customizations are highlighted in the document).

In B2B for Oracle Integration, you can generate implementation guides for both standard and custom B2B schemas. The guide is generated as an HTML document, which you can edit to apply branding and print as a PDF file if necessary.

Note:

You cannot currently generate an implementation guide for EDIFACT documents.

The following image shows an example implementation guide:

Description of sample-implementation-guide.png follows
Description of the illustration sample-implementation-guide.png

Structure of an Implementation Guide

List of Segments and Loops

The guide begins with a listing of each segment and loop defined in the document schema. Each row defines a segment or loop with the following columns:
  • Pos.No: The position number of the segment as defined in the X12 standard.
  • Seg.ID: The segment identifier.
  • Name: A descriptive name for the segment.
  • Req.Des: The requirement designator (M = Mandatory, O = Optional, C = Conditional).
  • Max Use: The Repeat property of the segment.
  • Loop Repeat: The Repeat property of the loop, when the row represents a loop.
  • Usage: The Usage property of the segment (Must Use, Not Used, Recommended, Not Recommended).

Details Section for Each Segment

Each segment has a details section that lists elements in the segment as shown in the following image:

Description of segment-detail.png follows
Description of the illustration segment-detail.png

The Data Element Summary table lists the elements declared in the segment and has the following columns:
  • User Option: The Usage property of the element (Must Use, Not Used, Recommended, Not Recommended).
  • Ref Des: The reference designator of the element, which is a convention to represent an element. For example, BEG01 is the first element in the segment BEG. If an element is a composite element, the child elements in the composite use the convention REF04-01, where 01 is the sub-element position, 04 is the composite element's position, and REF is the segment.
  • Data Element: The identifier of the element's definition.
  • Name: A descriptive name assigned to the element.
  • Attributes: Includes more properties of the element's definition. A value like M ID 2/2 is made of the following parts:
    • The requirement designator for the element (M = Mandatory, O = Optional, C = Conditional).
    • Element's data type (ID=Identifier, AN=Alphanumeric String, N0=integer number, etc.).
    • Element's minimum and maximum character length. A value 1/30 implies that the element's value must be between 1 and 30 characters to be valid.

Generate the Implementation Guide for a Schema

View or download the implementation guide for a schema in the HTML format.

To generate an implementation guide:
  1. For a standard schema: On the B2B Schemas page, click Generate, then click Implementation Guide.
  2. For a custom schema: On the B2B Schemas page, hover over a schema row and click Actions Actions icon, then select Generate Implementation Guide.
  3. On the Generate Implementation Guide page, click Download or View to generate the document in the HTML format.