Using the Software Developer's Guide

This guide is divided in several sections. A description and purpose for each of the sections is provided below. Links are provided to facilitate easy access to information.

The business rules, data dictionary and message specifications MUST BE READ IN CONCERT, to gain an understanding of the requirements for each message used by the ICS. The Data Dictionaries provide Customs usage for each data item and are the primary reference for Customs usage and definition of data requirements. Where a message type is used for multiple functions a separate representation is provided for each usage.

Any material which is under development or incomplete is:

highlighted in yellow

 

Introduction

This section provides the reader with the purpose of the Software Developer’s Guide as well as a link to a short explanation of the Integrated Cargo System (ICS). It also links to the terms and conditions under which this guide has been made available. All readers are encouraged to read the Copyright and Disclaimer Notice as the use of this guide is bound by these terms.

Connection

Provides the reader with the information required to transmit EDI messages to the Customs Connect Facility (CCF). Business rules contained in the section are to be applied globally to the ICS.

Message Management

This section details the information software developers require to ensure that EDI messages sent to and received from the Customs Connect Facility will be processed successfully.

EDI Messaging

Details the messaging standards, specifications and the rules being applied by Customs to messages used by the Integrated Cargo System.

The EDI Message Implementation Guides (MIG's) MUST BE READ IN CONJUNCTION WITH THE RELEVANT DATA ITEM ENTRIES IN THE DATA DICTIONARIES AND THE BUSINESS RULES. Bi-Directional hyper links are provided between the data dictionary items and the MIG's.

At the bottom of each segment in a MIG an example of "sample code" for the segment which precedes it has been included.

Throughout this guide the MIG's are reached by following the Message Mapping link for the appropriate message.

Reference Information

The reference section contains information about reference files, individual data items used within the ICS and a glossary of terms. This data will be expanded as functionality is released for the ICS.

Data Dictionaries

There are three data dictionaries (DDs) provided.

1- Data items for inbound messages are contained in the User Data Dictionary (DDs).

2- Data items for messages being transmitted by Customs are contained in the Customs Data Dictionary (DDs).

3- Data Items pertinent to the User and Customs Control messages are held in the Control Data Dictionary (DDs) which is accessible via hotlink from both the User and Customs DD's.