9.2 IDL Source Location

Go To Top

Return to DDS / IDL / Type Generation

The Repository should store IDL source files in the approved IDL source directory. The recommended location is:

• idl/

The team may organize IDL files by Runtime Plane, Domain, or subject. A representative structure is:

• idl/

  • control/
  • data/
  • release/
  • common/

The idl/control/ directory should contain structures used by Control Plane topics, such as Node status and Node command messages. The idl/data/ directory should contain structures used by Data Plane topics. The idl/release/ directory should contain structures used by authorized release or external exchange topics if Phase 0 introduces them. The idl/common/ directory should contain shared structures used by more than one Runtime Plane or Domain.

IDL file names should identify the structures they define. The team should avoid generic file names such as types.idl, common.idl, or messages.idl unless the file genuinely defines a narrow, documented common set. More specific names improve Traceability and review.

Representative IDL file names include:

• NodeStatus.idl
• NodeCommand.idl
• FxTransaction.idl
• CashFlow.idl
• ProvenanceRecord.idl