Configure Guideline Requirements

As a leader, you can configure guideline requirements:

  1. Open a draft guideline.
  2. For each loop and segment:
    • Select a usage: Mandatory, Optional, X - Conditional, Recommended, Not Recommended.
    • Define a Max use, meaning the number of times a loop or segment can be repeated.
    • Define syntax notes for segments only, meaning define relational conditions within elements of the segment. See Add syntax notes on a guideline.
    • Enter a description for any valuable information to convey to your followers.
  3. For each elements:
    • Select a usage: Mandatory, Optional, X - Conditional, Recommended, Not Recommended, Not Used.
    • Define a min and max length.
    • Define a type:
      • ID: Pre-defined codes
      • B: Binary
      • AN - Alphanumeric: You can use any number, letters and characters
      • N / Nn: Numeric data with implied decimal.
      • R: Decimal numeric data
      • DT: Date (YYMMDD)
      • DT: Long Date (CCYYMMDD)
      • TM: Time
    • Add codes: You can add codes defined in the X12 specs or custom codes.
    • Enter a description for any valuable information to convey to your followers.

📘

General notes:

  • If you want to add or remove a specific segment or loop, you can always click on “Edit structure” and update the guideline structure.
  • You won’t be able to save a guideline if no element is used for a specific segment.
  • You won’t be able to save a guideline if an element is marked Conditional but has no corresponding syntax note on its parent segment or if the element usage is contradicting a syntax note.
  • If your loop or segment usage is different based on conditional logic, you can configure condition sets or variants. If your element usage is different based on conditional logic, you can configure condition sets or syntax notes.

📘

Notes around guideline validation errors:

  • Validation errors happen when the sender of a transaction doesn’t provide a mandatory loop or segment or elements.
  • Validation errors happen when the sender of a transaction doesn’t use an allowed code for a specific element, regardless of its type.
  • Conditional segments or loops, Optional, Recommended or Not Recommended loops are loops, segments or elements don’t trigger validation errors if you send the corresponding information or not.