Skip to main content
Feedback

EDI profile’s Data Elements tab, segment details

Updated 

Select a segment in the tree to view or edit its details. The details appear in the panel on the right.

FieldDescription
Segment IDThe ID used to read or generate a group of related elements. It appears in the tree. The Map step always uses this ID to populate the segment in the output, so you cannot add a default value to a segment ID in a map.
PositionThe segment's location relative to its parent. The number changes if you move the segment.
NameA reference name that describes the segment's purpose.
MandatoryIf selected, the segment's presence is validated when reading or writing.
Max UseThe maximum number of times the segment can appear in its loop, as defined by the standard. You can change this value. The limit is not enforced. If Max Use is greater than 1, more than one occurrence is allowed.
Repeat ActionHow to handle repeating data when reading or writing the segment in a map. Options: N/A, Concatenate when Reading, Repeat when Writing, Break repeated sets when reading, Combine repeated sets when writing.
Max Repeat SetsThe number of repeated sets allowed within one segment. Used with the data element's Set Repeat Type.
Looping OptionHow to write loops and segments. Unique writes only unique instances; if two or more are identical, only the first is written. Occurrence writes every instance.

Additional Criteria

Use additional criteria when a segment ID alone cannot identify the segment. Instance identifiers handle most cases, such as date segments with different qualifiers. Use additional criteria when a segment repeats in a specific place in the document, such as the HL segments in an X12 856 transaction.

  • Use Additional Criteria to Define Segment. Select to specify the identifying data.
  • Data Element. The child data element that identifies the segment.
  • Element Value. The text value the data element must have.

Validation Rules

The table lists each rule with its type, definition, and the elements it evaluates. Select Add Rule to add a rule, or select a rule's type to edit it. Select the trash icon to remove a rule.

  • Rules are applied to documents only when Segment Validation Rules is selected on the Options tab. Cleared rules keep their definitions.
  • When you import segments into an X12 profile, the standard's rules for the selected version are added automatically.
  • Rules can be added to X12, EDIFACT, and ODETTE profiles only. Refer to Adding validation rules for more information.

Rule types

  • X12: (P) Paired/Multiple, (R) Required, (E) Exclusion, (C) Conditional, (L) List Conditional.
  • EDIFACT and ODETTE: (D1) One and Only One, (D2) All or None, (D3) One or More, (D4) One or None, (D5) If First Then All, (D6) If First, Then At Least One More, (D7) If First, Then None of the Others.
On this Page