What is a Document Structure

Modified on Fri, May 22 at 10:44 AM

What is a Document Structure?

 

Definition

A Document Structure is a schema that tells the translation engine exactly how to read or write a file. It defines what constitutes each record type in a document — such as header, detail, and trailer records — and how to tell them apart.

It captures the full layout of a file, including:

 

Components

  • Field Layout — For fixed-width files: start position and length of every field. For delimited files: delimiter character, field sequence, and optional qualifier. For XML/JSON: element path and expected data type.
  • Data Types and Formats — Character, numeric, date formats (e.g., YYYYMMDD or MMDDYY), packed decimal, signed/unsigned values.
  • Conditional Logic — Which records are mandatory, which are optional, and how many times a detail record can repeat.

 

Where to Find It

Navigate to: Advance Config → Document Types → open a Document Type → Structure tab.

 

Title: Document Types — list view (Name, Description, Format Type, Alias) - Description: Document Types — list view (Name, Description, Format Type, Alias)

Document Types — list view (Name, Description, Format Type, Alias)

Click ··· on a Document Type and select Config, then go to the Structure tab:

Title: Document Type — actions menu (Config / Clone) - Description: Document Type — actions menu (Config / Clone)

Document Type — actions menu (Config / Clone)

Title: Structure tab — full document structure tree (Document, ISA, FGrp, IEA) - Description: Structure tab — full document structure tree (Document, ISA, FGrp, IEA)

Structure tab — full document structure tree (Document, ISA, FGrp, IEA)

Enable "Show special fields only" to highlight fields marked as special (e.g., Integration Key fields):

Title: Structure tab — Show special fields only (key icon marks special fields like BIG02, BIG04) - Description: Structure tab — Show special fields only (key icon marks special fields like BIG02, BIG04)

Structure tab — Show special fields only (key icon marks special fields like BIG02, BIG04)

Use the action buttons in the top-right to manage the structure:

Title: Structure tab — Xpath Config button (configure Partner XPath, Split XPath, etc.) - Description: Structure tab — Xpath Config button (configure Partner XPath, Split XPath, etc.)

Structure tab — Xpath Config button (configure Partner XPath, Split XPath, etc.)

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article