Loading
 

INTEGRATED CARGO SYSTEM (ICS)

​​​​ICS Control Data Dictionary

Return to index​

This document is the combined Control Data Dictionary for the CONTRL messages and the Interchange Control set used by the Department. It contains descriptions and data representations for the Control data items used in the ICS.

This Data Dictionary should be read in conjunction with the relevant message templates and business rules.

Data items in this dictionary may occur multiple times (e.g. Outbound Message Recipient). This occurs whenever data item usage requires mapping into different message types, which requires differing mapping representation. For ease of usage hotlinks are provided from the Message column to the applicable message template.

The Data Dictionary entries are presented across 8 columns. When read in conjunction the entry for a single data item will provide a business description of the item and data representation sufficient to provide the developer with the required information for the relevant data item. This section describes all data items included in the Customs messages with a cross reference to the element and segment in which they occur. A description of each column is provided below:

Data itemThe data item is the 'common use' name for the information that can be included in the message.
DefinitionA detailed definition is provided for each data item.
MessageIndicates the message or messages in which the data item occurs.
Segment GroupThis column specifies the location of the Segment Group in which the data item occurs. EDIFACT Messages can be divided into three sections, Header, Detail and Summary. Where the data item appears in either the Header or Summary section, this is noted as the Segment Group. For data items contained in the Detail section of the message, a Segment Group number is provided.
OccursThis column indicates the number of times the data item can occur for the ICS implementation of the message. The first digit specifies the minimum and the second the maximum. If the first digit is zero this implies that the data item is optional whereas if it is one then it is mandatory. The second digit specifies the maximum number of occurrences allowed.
FormatThis column specifies the format in which the data must be presented. The data representation table below contains a key to the data representation used in this guide.
Segment NameEach data item is located within the message by pinpointing the segment used within the Segment Group.
ElementFinally, the elements within the segment are indicated. Where code lists are used, the code value is generally provided. Data represented between quotation marks is a literal value that must be quoted within that data element. Where there is no literal value given business information is to be quoted.

Data value representation

The representation of data elements and or component data elements in the SDG is:

aAlphabetic characters
nNumeric characters
anAlpha numeric characters
a33 alphabetic characters, fixed length
an33 alphanumeric characters, fixed length
a..3Up to 3 alphabetic characters
n..3Up to 3 numeric characters
an..3Up to 3 alphanumeric characters
n..15.5Up to 15 numeric characters, which may include up to 5 decimal places. The decimal point symbol will be a full stop and is not included in the character count.

CONTRL Message Table

Data Item NameDescriptionFormatOccursMessageSeg GroupSeg NameElement
Acknowledgement Request A flag to indicate that an acknowledgement CONTRL message should be returned upon receipt of the interchange.n10..1 CTLSET HeaderUNB0031=1
Interchange Action Code A code used to indicate receipt of the interchange.n11..1 CONTRL
ICONTRL 		HeaderUCI 0083= 'Code List'
Interchange Component Data Element Position The position of an erroneous component data element within a data element.n..30..1 CONTRL HeaderUCI0104=
Interchange Control Reference Number The unique interchange identifier assigned by the sender.n..141..1 CTLSET Header Trailer UNB UNZ 0020= 0020=
Interchange Control Reference Number The unique interchange identifier assigned by the sender.n..141..1 ICONTRL HeaderUCI0020=
Interchange Control Reference Number (Inbound) The unique interchange identifier assigned by the sender of the inbound message.n..141..1 CONTRL HeaderUCI0020=
Interchange Creator A unique identifier for an EDI Site for a Client. This equates to the legacy concept of EDI Site. I.e. the site from which a client may send EDI messages to the Department. The EDI Site ID is assigned by the Department at the time the EDI Site is registered.an..101..1 ICONTRL HeaderUCI0004=
Interchange Creator A unique identifier for an EDI Site for a Client. This equates to the legacy concept of EDI Site. I.e.. the site from which a client may send EDI messages to the Department. The EDI Site ID is assigned by the Department at the time the EDI Site is registered.an..101..1 CTLSET HeaderUNB0004=
Interchange Creator (Inbound) The site id of the creator of the interchange being responded to.an..101..1 CONTRL HeaderUCI0004=
Interchange Data Element Position The position of an erroneous data element within a segment.n..30..1 CONTRL HeaderUCI0098=
Interchange Message Count The count of messages contained within the interchange.n..61..1 CTLSET HeaderUNZ0036=
Interchange Owner A unique identifier for an EDI Site for a Client. This equates to the legacy concept of EDI Site. I.e.. the site from which a client may send EDI messages to the Department. The EDI Site ID is assigned by the Department at the time the EDI Site is registered.an..101..1 ICONTRL HeaderUCI0008=
Interchange Owner A unique identifier for an EDI Site for a Client. This equates to the legacy concept of EDI Site. I.e.. the site from which a client may send EDI messages to the Department. The EDI Site ID is assigned by the Department at the time the EDI Site is registered.an..101..1 CTLSET HeaderUNB0008=
Interchange Owner (Inbound) This is the interchange owner site identifier. This will be copied from the inbound interchange header.an..101..1 CONTRL HeaderUCI0008=
Interchange Recipient Identification This is the identifier of the party the interchange being responded to was sent to.an..101..1 ICONTRL HeaderUCI0010=
Interchange Recipient Identification This is the identifier of the party the interchange being responded to was sent to.an..101..1 CTLSET HeaderUNB0010=
Interchange Recipient Identification (Inbound) This is the identifier of the party the inbound interchange was sent to.an..101..1 CONTRL HeaderUCI0010=
Interchange Segment Tag The segment tag identifier of the interchange service segment that is in error which is either the UNA, UNB or UNZ.a30..1 CONTRL HeaderUCI0013=
Interchange Syntax Error Code A code used to indicate the syntax error detected within an interchange.an..30..1 CONTRL HeaderUCI 0085=' Code List '
Message Action Code A code indicating that syntax errors have been detected in a message and that it has been rejected.n11..1 CONTRL 1UCM 0083=' Code List'
Message Component Data Element Position The position of an erroneous component data element within a data element.n..30..99 CONTRL 2UCD0104=
Message Data Element Position The position of an erroneous data element within a segment.n..30..99 CONTRL 2UCD0098=
Message Data Element Syntax Error Code A code used to notify of a syntax error within a message.n..20..1 CONTRL 2UCD 0085=' Code List'
Message Identifier The UN/CEFACT identifiers which identify the message type and directory, of a message that is being reported as being in error.an..61..1 CONTRL
ICONTRL 		HeaderUNH 0065=CONTRL
0052=D
0054=3
0051=UN
Message Reference Number The Message Reference Number (MRN) is a message reference assigned by the Interchange creator. The MRNs within each Interchange will consist of consecutive numbers starting from 1 and incrementing by 1 up to the number of messages in the interchange.n..61..1 CONTRL
ICONTRL 		Header Trailer UNH UNT 0062= 0062=
Message Reference Number (Inbound) The Message Reference Number from a received inbound message for which errors are being reported.n..60..999999 CONTRL HeaderUCM0062=
Message Segment Position The numerical count position of a segment within a message.n..60..999 CONTRL 2UCS0096=
Message Segment Syntax Error Code A code used to notify of a syntax error detected in a message.n..20..1 CONTRL 2UCS 0085=" Code List "
Message Syntax Error Code
A code used to notify of a syntax error detected in a message.n..20..1 CONTRL 2UCM 0085=" Code List "
Message Wrapper Segment Tag The segment tag identifier of the message segment that is in error.a30..1 CONTRL 1UCM0013=
Message Type Identifier The type of message that is in error.an..61..1 CONTRL 1UCM0065=
Message Type Release Number The release number of the type of message that is in error.an31..1 CONTRL 1UCM0054=
Message Type Version Number The version number of the type of message that is in error.an11..1 CONTRL 1UCM0052=
Message Wrapper Component Data Element Position The position of an erroneous component data element within a data element.n..30..1 CONTRL 1UCM0104=
Message Wrapper Data Element Position The position of an erroneous data element within a segment.n..30..1 CONTRL 1UCM0098=
Number of Segments in the Message The number of segments found in an EDI message. The count begins at the UNH and ends with the UNT.n..61..1 CONTRL
ICONTRL 		TrailerUNT0074=
Syntax Identifier The EDIFACT message syntax and version number employed by the messages.a41..1 CTLSET HeaderUNB 0001=UNOC
0002=3
Test Indicator An indicator to show that the messages within the interchange are test messages.a10..1 CTLSET HeaderUNB0035=1
Transmission Date The date the interchange was sent.n61..1 CTLSET HeaderUNB0017=
Transmission Time The time the interchange was sent.n41..1 CTLSET HeaderUNB0019=

V 1.7 03 OCT 2004