DIRDEF Directory definition message (D01B)

This is the standard EDIFACT D01B 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 (54 KB) Generate classes
The ediFabric .NET template, class TSDIRDEF. It needs the common segments, composites and codes of EDIFACT D01B, one download for every transaction in the version. Download C# (1 KB) Common files (57 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 D01B 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
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
DIIDIRECTORY IDENTIFICATIONMandatory1
DTMDATE/TIME/PERIODOptional9
FTXFREE TEXTOptional9
Loop NADNAME AND ADDRESSOptional9
NADNAME AND ADDRESSMandatory1
Loop CTACONTACT INFORMATIONOptional9
CTACONTACT INFORMATIONMandatory1
COMCOMMUNICATION CONTACTOptional9
Loop MSGMESSAGE TYPE IDENTIFICATIONOptional9999
MSGMESSAGE TYPE IDENTIFICATIONMandatory1
ATTATTRIBUTEOptional99
FTXFREE TEXTOptional999
DTMDATE/TIME/PERIODMandatory1
Loop SGUSEGMENT USAGE DETAILSOptional999
SGUSEGMENT USAGE DETAILSMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional99
Loop GRUSEGMENT GROUP USAGE DETAILSOptional1
GRUSEGMENT GROUP USAGE DETAILSMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional99
Loop FNTFOOTNOTEOptional99
FNTFOOTNOTEMandatory1
RELRELATIONSHIPOptional1
GIRRELATED IDENTIFICATION NUMBERSOptional9
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
Loop SEGSEGMENT IDENTIFICATIONOptional9999
SEGSEGMENT IDENTIFICATIONMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
ELUDATA ELEMENT USAGE DETAILSOptional99
Loop FNTFOOTNOTEOptional99
FNTFOOTNOTEMandatory1
RELRELATIONSHIPOptional1
GIRRELATED IDENTIFICATION NUMBERSOptional9
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
Loop CMPCOMPOSITE DATA ELEMENT IDENTIFICATIONOptional9999
CMPCOMPOSITE DATA ELEMENT IDENTIFICATIONMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
ELUDATA ELEMENT USAGE DETAILSOptional99
Loop FNTFOOTNOTEOptional99
FNTFOOTNOTEMandatory1
RELRELATIONSHIPOptional1
GIRRELATED IDENTIFICATION NUMBERSOptional9
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
Loop ELMSIMPLE DATA ELEMENT DETAILSOptional9999
ELMSIMPLE DATA ELEMENT DETAILSMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
Loop CDSCODE SET IDENTIFICATIONOptional9999
CDSCODE SET IDENTIFICATIONMandatory1
FTXFREE TEXTOptional9
Loop CDVCODE VALUE DEFINITIONOptional9999
CDVCODE VALUE DEFINITIONMandatory1
ATTATTRIBUTEOptional9
FTXFREE TEXTOptional9
UNTMessage TrailerOptional1