Skip to main content
Feedback

EDI profile instance identifiers

Updated 

Instance identifiers are placeholders in an EDI profile that identify a specific data set. At the loop and segment level, they categorize repeated data by occurrence (the first loop or segment, for example), by qualifier, or by both.

Example

A purchase order's shipping information appears in the N1 through N4 segments. Each N1 segment is either a Ship From (SF) or a Ship To (ST) address, and both sit in one repeating loop. An instance identifier lets you address each address separately.

ST*850*0001~
BEG**161905A*0032080731**~
N9*CR*01~
N1*SF*BOOMI HQ~
N3*801 CASSATT ROAD*SUITE 120~
N4*BERWYN*PA*19132~
N1*ST*FOOD STORES~
N3*123 SOUTH STREET~
N4*CHICAGO*IL*84593~
...

Sample instance identifier as described in the surrounding text.

How to identify each loop instance

To identify each loop instance as unique in your integration:

  • Add qualifiers to the N101 data element. [LINK: Adding qualifiers to a data element]
  • Add an instance identifier at the loop level (the N1 loop) for each qualifier. [LINK: Adding an instance identifier to an EDI profile]

Limits and nesting

  • A profile can have up to 200 instance identifiers.
  • Identifiers can be nested. If a child loop has an instance identifier, the profile adds the same child identifiers to each parent instance automatically. All of them count toward the 200 limit.

Use in lookups and maps

Process steps can use instance identifiers to select a specific data element. For example, a Decision step can check whether the Ship To city is Chicago. Without an instance identifier, the profile cannot select the Ship To data in a standard EDI profile.

Maps can use instance identifiers to map only one occurrence or qualifier. For example, you can map only the Ship To data from an EDI source file to build the output.

On this Page