Edit Properties of Segments and Other Schema Constructs

B2B for Oracle Integration allows you to modify properties of existing constructs of a schema that's derived from a standard schema.

  1. To edit the properties of constructs in a project.
    1. In the navigation pane, click Projects.
    2. Click the project in which to edit the properties of constructs.
    3. Click B2B B2B icon.
    4. In the Schemas section, hover over the schema and click Actions Actions icon, then select Edit.
  2. To edit the properties of constructs in a standalone environment.
    1. In the navigation pane, click B2B, then Schemas.
    2. Hover over the schema and click Edit Edit icon.
  3. Expand the segment to edit.
  4. Hover over a row you want to modify and click Edit details Edit icon.

    A panel open on the right, displaying the Properties tab. The property fields displayed in the tab vary for element, composite, segment, and loop rows. You can edit the field values to customize and deviate from the X12 standard according to your business requirements. The following sections describe the different property fields that are displayed for each construct type.

Element Properties

Property Description
Name

A descriptive name for the element.
Element ID

The ID that identifies this element in the EDI X12, X12 HIPAA, or EDIFACT element dictionary. This field is not editable.
Position

The element's position number within the parent segment or composite. This field is not editable.
Purpose

A detailed description of the element's purpose.
Requirement
  • Mandatory: The element must have a nonempty value in an EDI document.
  • Optional: The element may have a value or be empty.
  • Conditional: The element may have a value or not depending on syntax rules defined on the parent segment or composite.

This setting is preselected by the X12, X12 HIPAA, or EDIFACT standard and typically not modified. To override this setting, modify the Usage field.

Usage

This field overrides the Requirement field. When this field is left blank (no value selected), it implies that the element is used and the selection made in the Requirement field is enforced.

  • Must Use: Overrides the selection in the Requirement field and treats the element as mandatory.
  • Not Used: Overrides the selection in the Requirement field and specifies that the element should remain empty (that is, not have a value).
  • Recommended: Follows the selection in the Requirement field, but suggests that the element is a preferred element.
  • Not Recommended: Follows the selection in the Requirement field, but suggests that the element is not a preferred element.
Type

The element's type as defined by the X12 standard in the EDI X12 element dictionary, X12 HIPAA standard, or EDIFACT standard in the EDIFACT element dictionary.

The type is one of the following: ID (Identifier), AN (Alphanumeric Text String), DT (date), TM (time), N(0-9) (Integer with implied decimal), R (Decimal), or B (Binary). This field is not editable.
Length (Min / Max)

The minimum and maximum characters (or numeric digits) that the element's value allows.
Repeat

Specifies if it's a repeating element.

  • 1: Indicates that the element has a single value (non-repeating).
  • A number greater than one or the >1 symbol: Indicates that this is a repeating element; that is, one element accommodates multiple values.

The EDI X12 version 4012 and older versions do not support repeating elements; therefore, this setting is ignored for those versions.

Composite Properties

A composite has property settings similar to an element construct, except for the Type and Length fields.

Segment Properties

A segment has several property settings similar to an element construct. However, it doesn't have the Element ID, Type, and Length fields. In addition, there are the following differences.

Property Description
Repeat

For a segment, this property indicates how many consecutive instances of the segment may occur in an EDI document. Segment repetition is supported in all X12 versions, unlike elements.
Table Area

Indicates the section of the EDI document to which this segment belongs. Typically, an EDI document is defined with a heading, summary, and detail sections, also called table areas.

Loop Properties

A loop has four property settings, namely Requirement, Usage, Repeat, and Table Area, which have similar meanings as those of a segment.