DIRDEF Directory definition message (D17A)

This is the standard EDIFACT D17A spec, with 13 loops and 50 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.

Loading the spec…
The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (53 KB) Generate classes
The ediFabric .NET template, class TSDIRDEF. It needs the common segments, composites and codes of EDIFACT D17A, one download for every transaction in the version. Download C# (1 KB) Common files (69 KB)
The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and EDIFACT is coming. Download Native (1 KB)

Use the DIRDEF spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read DIRDEF files into TSDIRDEF objects. See ediFabric .NET.

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D17A to this Native model with set_map to parse DIRDEF files to JSON from Python, Java, C or C#. See ediFabric Native.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate DIRDEF classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each DIRDEF as JSON. To work with DIRDEF data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSDIRDEF. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

DIRDEF structure

Loops and segments of the standard DIRDEF, with their usage and maximum repeats.

IDNameUsageMax use
UNHUNHMandatory1
BGMBGMMandatory1
DIIDIIMandatory1
DTMDTMOptional9
FTXFTXOptional9
Loop NADNADOptional9
NADNADMandatory1
Loop CTACTAOptional9
CTACTAMandatory1
COMCOMOptional9
Loop MSGMSGOptional9999
MSGMSGMandatory1
ATTATTOptional99
FTXFTXOptional999
DTMDTMMandatory1
Loop SGUSGUOptional999
SGUSGUMandatory1
ATTATTOptional9
FTXFTXOptional99
Loop GRUGRUOptional1
GRUGRUMandatory1
ATTATTOptional9
FTXFTXOptional99
Loop FNTFNTOptional99
FNTFNTMandatory1
RELRELOptional1
GIRGIROptional9
ATTATTOptional9
FTXFTXOptional9
Loop SEGSEGOptional9999
SEGSEGMandatory1
ATTATTOptional9
FTXFTXOptional9
ELUELUOptional99
Loop FNTFNTOptional99
FNTFNTMandatory1
RELRELOptional1
GIRGIROptional9
ATTATTOptional9
FTXFTXOptional9
Loop CMPCMPOptional9999
CMPCMPMandatory1
ATTATTOptional9
FTXFTXOptional9
ELUELUOptional99
Loop FNTFNTOptional99
FNTFNTMandatory1
RELRELOptional1
GIRGIROptional9
ATTATTOptional9
FTXFTXOptional9
Loop ELMELMOptional9999
ELMELMMandatory1
ATTATTOptional9
FTXFTXOptional9
Loop CDSCDSOptional9999
CDSCDSMandatory1
FTXFTXOptional9
Loop CDVCDVOptional9999
CDVCDVMandatory1
ATTATTOptional9
FTXFTXOptional9
UNTUNTMandatory1