Design Document for National Import Application (DDNIA) / Ver: 12.20
List of Figures
OWNER:
DG TAXUD / ISSUE DATE:
28/04/2015 / VERSION:
12.20
Taxation and Customs Union DG
SUBJECT:
Design Document for National Import Application (DDNIA)
Framework Contract TAXUD/2013/CC/124
Specific Contract 03
Status: Final, after review by DG TAXUD & National Administrations.
Published on CIRCABC (Library > 04_ICS > 03_TECHNICAL_SPECS > 01_DDNIA)
Aligned to: DDNA_RFC-List.28.
DDNIA-Main Document-v12.20-SfA.docxPage 1 of55
CUSTDEV3 – FC TAXUD/2013/CC/124 – SC 03 / REF: DDNIA-Main DocumentDesign Document for National Import Application (DDNIA) / Ver: 12.20
List of Figures
Document History
Edi. / Rev. / Date / Description / Action (*) / Pages0 / 10 / 13/09/2007 / Implementing internal review comments.
Submitted for pre-validation to Taxation and Customs Union DG. / I / All
0 / 20 / 01/10/2007 / Submitted for review to Taxation and Customs Union DG. / I / All
1 / 00 / 13/12/2007 / Submitted for acceptance to Taxation and Customs Union DG / I / All
1 / 10 / 25/01/2008 / Submitted for review to Taxation and Customs Union DG. / I / All
2 / 00 / 15/02/2008 / Submitted for acceptance to Taxation and Customs Union DG. / I / All
3 / 00 / 09/04/2008 / Implementing NAs comments based on the 63th ECG, Brussels, March 28th 2008.
Submitted for acceptance to Taxation & Customs Union DG. / I / As Required
3 / 10 / 15/04/2008 / Updated with the implementation of ECG comment 227.
Submitted for acceptance to Taxation and Customs Union DG. / I / As Required
3 / 20 / 24/09/2008 / Updated with DDNA KEL 0.17b.
Submitted for review to Taxation and Customs Union DG. / I, R / As Required
4 / 00 / 30/09/2008 / Submitted for acceptance to Taxation & Customs Union DG. / I / As Required
4 / 10 / 30/04/2010 / Updated with the implementation required under QTM 970 and QTM 987 (DDNA KEL 0.22).
Implementing internal review comments.
Submitted for review to Taxation and Customs Union DG. / I, R / Sections I, III, IV, VII, X
5 / 00 / 18/05/2010 / Implementing QA and DG TAXUD comments.
Submitted for acceptance to Taxation & Customs Union DG. / I, R / As Required
5 / 10 / 19/07/2010 / Updated after ECG Review regarding the implementation performed under QTM 970 and QTM 987 (DDNA KEL 0.22).
Implementing internal review comments.
Submitted for review to Taxation and Customs Union DG. / I, R / Sections III.4.5.1, III.5.2
6 / 00 / 20/07/2010 / Submitted for acceptance to Taxation & Customs Union DG. / - / As Required
7 / 00 / 14/02/2011 / Project and contractual data is updated.
Aligned with KEL 0.23.
Submitted for review to Taxation & Customs Union DG. / I, R / As Required
7 / 10 / 19/09/2011 / Aligned with the updated KEL v0.23.
Submitted for review to Taxation & Customs Union DG. / I, R / 1, 3
7 / 11 / 26/01/2012 / Project and contractual data updated. Aligned with the KEL v0.24.
Sent for internal review. / I, R / Sections:I.1.8 I.3.1 I.3.2
III.5.2 X.1.1
7 / 12 / 30/01/2012 / Comments from the internal review are implemented.
Sent for internal language review. / I, R / Pages 1, 3, 14 and 18
7 / 20 / 08/02/2012 / Comments from the language review are implemented.
Submitted for review to Taxation & Customs Union DG. / I, R / As Required
8 / 00 / 29/02/2012 / Submitted for acceptance to Taxation and Customs Union DG. / I / 3
8 / 10 / 31/07/2013 / Project and contractual data updated. Aligned with the KEL v0.25.
WARNING: This and the next version do NOT include the changes for KEL24a.
Submitted for review to Taxation & Customs Union DG. / I, R / Sections: I.1.8 I.3.1 I.3.2
9 / 00 / 28/08/2012 / Implementing DG TAXUD comments.
Submitted for acceptance to Taxation and Customs Union DG. / I,R / Pages 4, 10 - 12, 23, 34, 36
8 / 60 / 15/02/2013 / Project and contractual data updated. Aligned with the KEL v0.24a (KEL entry #321).
This and the next version were created in a side branch to address urgent business needs.
Submitted for review to Taxation & Customs Union DG. / I,R / Pages 15, 18 and 19
8 / 70 / 07/03/2013 / Review comments implemented.
Submitted for acceptance to Taxation and Customs Union DG. / I,R / As required
9 / 10 / 06/03/2013 / Project and contractual data updated. Aligned with the KEL v0.25a.
This and the next version also includethe changes introduced within KEL v0.24a.
Submitted for review to Taxation & Customs Union DG. / I,R / Pages 15,18 and 19
9 / 50 / 08/04/2013 / Review comments implemented.
Submitted for acceptance to Taxation and Customs Union DG / I,R / Page 15
9 / 51 / 15/08/2013 / Project and contractual data updated. Aligned with the KEL v0.26.
Sent for internal review. / I,R / Pages 17, 20-21, 33-34 and 59
9 / 60 / 26/08/2013 / Comments from the internal review are implemented.
Submitted for review to Taxation & Customs Union DG. / I,R / Pages 6-7, 18 and 20
10 / 00 / 03/10/2013 / Review comments implemented.
Submitted for acceptance to Taxation and Customs Union DG. / I,R / Pages 20-21, 56
10 / 01 / 16/01/2014 / Project and contractual data updated. Aligned with the KEL v0.27 (KEL entries #346, #351).
Sent for internal review. / I,R / Pages 16, 17, 20, 21
10 / 10 / 21/01/2014 / Comments from the internal review are implemented.
Submitted for review to Taxation & Customs Union DG. / I,R / As required
11 / 00 / 19/02/2014 / Comments from the review are implemented.
Submitted for acceptance to Taxation & Customs Union DG. / I,R / Pages 5, 8, 12, 14 – 19, 21 – 30, 33, 34, 37 – 39, 42 – 46, 55; Appendices A1, A2, A3
11 / 10 / 12/03/2015 / Implementing QTM037 (RFC-List.28 Movements System).
Submitted for Review (SfR) to Taxation & Customs Union DG. / I / Pages 20, 21, 42, 52
12 / 00 / 15/04/2015 / Implementing QA3 and DG TAXUD review comments.
Submitted for Acceptance (SfA) to Taxation & Customs Union DG. / I/R / As required
12 / 10 / 17/04/2015 / Implementing DG TAXUD sanity check comments.
Re-submitted for Acceptance (re-SfA) to Taxation & Customs Union DG. / I/R / Appendices C, X
12 / 20 / 28/04/2015 / Implementing DG TAXUD sanity check comments.
Re-submitted for Acceptance (re-SfA2) to Taxation & Customs Union DG. / I/R / Appendices C, X (add BG in CL070, correct mk)
Table of Contents
Section IGeneral Introduction
I.1Document Overview
I.1.1Purpose of DDNA document
I.1.2DDNA Structure
I.1.3Purpose of the DDNIA volume
I.1.4Scope of DDNIA volume
I.1.5Intended audience
I.1.6Structure of DDNIA volume
I.1.7Document service information
I.1.8Change history
I.2Definitions
I.2.1Definitions
I.2.2Terminology
I.2.3Acronyms and Abbreviations
I.3Applicable and Reference documents
I.3.1Applicable documents
I.3.2Reference documents
I.3.3DDNIA usage policy
I.4Symbolism and Conventions Used
Section IIScope of development
II.1Information Exchange overview
II.2Information Exchange Maps
Section IIIICS Phase 1
III.1Introduction
III.1.1Overview
III.1.2Import Actors
III.2Scenarios and Sequence Diagrams
III.3Sequence Diagrams versus State Transition Diagrams
III.4Sequence Diagrams
III.4.1Core Flow
III.4.2ENS submitted at the Office of Lodgement
III.4.3Advanced Intervention Notification
III.4.4No Risk identified at the Office of first Entry
III.4.5Request for Diversion
III.4.6Amendment Request
III.4.7Rejections
III.5State Transition Diagrams
III.5.1Office of Lodgement
III.5.2Office of first Entry
III.5.3Actual Office of first Entry
III.5.4Office of subsequent Entry
III.6Timers
III.6.1Timely Response Recommendations
III.6.2CCN/CSI Related Timers
Section IVCentral Services
IV.1Exchange of statistics and availability data
IV.1.1Statistics management
IV.2Message exchanges with CS/MIS across the Web
IV.2.1Introduction
IV.2.2CS/MIS HTTP exchanges protocols
IV.2.3CS/MIS manual mode of operation
IV.3Message exchanges with CS/MIS via CCN/CSI
IV.3.1Sending IE411 data to CS/MIS
IV.3.2Exchanges of requests/responses of MRN Follow up information
Section VSystems Administration
Section VITechnical Message Structure
Section VIIDesign principles
VII.1Approach
VII.2Constraints
VII.2.1Timing constraints
VII.2.2Suspension of sending messages
VII.3Exception Handling
Section VIIIEDIFACT message formatting
Section IXXML message formatting
Section XTransport of messages via CCN/CSI
X.1The CCN communication reminder
X.1.1Message Descriptor
X.1.2The quality of service
Section XITransport of messages via the Inter(Extra)net
XI.1Message formats and usage for exchanges with CS/MIS
XI.1.14.1 Exchange Policy variables
List of Appendices
Appendix A1: Full Message Scope...... Appendix
Appendix A2: Mandatory and Strongly Recommended Messages...... Appendix
Appendix A3: Messages per Business Scope...... Appendix
Appendix C: ICS Phase 1 Codelists...... Appendix
Appendix C2: Applicability of Business Codelists per Domain...... Appendix
Appendix J: ICS Phase 1 Correlation tables...... Appendix
Appendix Q1: Technical Message Structures (Documented amendments)...... Appendix
Appendix Q2: Technical Message Structures (Messages & Rules and conditions)..Appendix
Appendix R: XML Mapping...... Appendix
Appendix X: XML Schemas...... Appendix
Appendix Y: Data Groups & Transaction Hierarchy...... Appendix
Appendix Z: Data Items...... Appendix
List of Figures
Figure 1: Overview of Information Exchanges for ICS Phase 1
Figure 2: ICS Phase 1 Core Flow
Figure 3: ENS submitted to Office of Lodgement with MRN communicated to Trader at Entry from the Office of Lodgement
Figure 4: ENS submitted to Office of Lodgement with MRN communicated to Trader at Entry from the Office of first Entry
Figure 5: Advanced Intervention Notification at the Office of first Entry after submission of the ENS at the Office of first Entry
Figure 6: Advanced Intervention Notification at the Office of first Entry after submission of the ENS at the Office of Lodgement
Figure 7: Subsequent Offices involved and No Risk identified at the Office of first Entry
Figure 8: Accepted diversion after request at the Office of first Entry declared
Figure 9: Valid amendment request at the Office of first Entry by the Person Lodging the ENS or his Representative
Figure 10: Valid amendment request at the Office of first Entry by the Person Lodging the ENS or his Representative after the ENS data has been sent to Offices of subsequent Entry
Figure 11: Invalid ENS submitted at the Office of first Entry
Figure 12: Invalid ENS submitted at the Office of Lodgement
Figure 13: Invalid Amendment request
Figure 14: Invalid Diversion Request at the Office of first Entry declared
Figure 15: State Transition Diagram for Office of Lodgement
Figure 16: State Transition Diagram for Office of first Entry
Figure 17: State Transition Diagram for Actual Office of first Entry
Figure 18: State Transition Diagram for the Office of subsequent Entry
Figure 19: Exception and expiration reports
List of Tables
Table 1: Acronyms
Table 2: Applicable Documents
Table 3: Reference Documents
Table 4: Role types and organisations in Import Control
Table 5: States of an MRN at an Office of Lodgement
Table 6: States of an MRN at an Office of first Entry
Table 7: States of an MRN at an Actual Office of first Entry
Table 8: States of an MRN at an Office of subsequent Entry
Table 9: Suspension of sending messages for ICS Phase 1
Table 10: The Exceptional CorrelID values of the CCN/CSI message descriptor
Table 11: High priority Information Exchanges for ICS Phase 1
Table 12: Programmatic interface variables for CS/MIS
DDNIA-Main Document-v12.20-SfA.docxPage 1 of55
CUSTDEV3 – FC TAXUD/2013/CC/124 – SC 03 / REF:DDNIA-Main DocumentDesign Document for National Import Application (DDNIA) / Ver: 12.20
General Introduction- Symbolism and Conventions Used
Section IGeneral Introduction
I.1Document Overview
I.1.1Purpose of DDNA document
The DDNA, the Design Document for National Applications, supersedes the DDNTA, the Design Document for National Transit Applications for NCTS Phase 3.2 and ECS. Itspecifies the design requirements to which any Customs Movement Application needs to conform.
The DDNA is applicable to every Transit, Export and/or Import Control Application and must be considered as a mandatory document for all implementation and verification activities.
The DDNA is aligned with [A1], [A2], [A4] and [R4].
Documents [A1] and [R4] contain the specifications for the entire NCTS (encompassing all Phases and sub-Phases), foreseeing a number of electronic and other (paper) Information Exchanges.
Document [A2] contains the functional specifications for ICS, foreseeing a number of electronic and other (paper) Information Exchanges.
Document [R7] contains the functional specifications for ECS, foreseeing a number of electronic and other (paper) Information Exchanges.
The DDNA consists of four volumes. One volume exists for each system (Transit, Export and Import) defining the design requirements of the specific system. One volume, defines common operations and methods for all systems namely the Design Document for Common Operations and Methods (DDCOM). For more information about DDNIA’s purpose and structure, please refer to sections I.1.3 and I.1.6, respectively.
Information Exchanges are foreseen in the Common Domain (between National Administrations), in the National Domain (local to a National Administration), and in the External Domain (between National Administration and Traders). Common Domain exchanges will always take place via the CCN/CSI communication platform or the Inter(Extra)net. The different formatting and transport mechanisms will therefore be defined in detail in the DDNA. Moreover, additional design constraints and additional details on error and exception handling will be stated.
Within the Customs systems, the Central Project Team will initially produce a number of Centrally Developed Customs Application (CDCA) tools (e.g. STTA, TTA, CS/RD, and CS/MIS) in order to assist the NAs to implement, verify and operate their National Customs Application (NCA). All these CDCA tools must conform to this document, although their specification is not part of this document. In order to construct a NCA, the NA should therefore use this document, in order to decide which functionality remains to be implemented.
I.1.2DDNA Structure
The DDNA consists of the following four volumes:
- Design Document for National Transit Application volume (DDNTA);
- Design Document for National Export Application volume (DDNXA);
- Design Document for National Import Application volume (DDNIA);
- Design Document for Common Operations and Methods volume (DDCOM).
I.1.3Purpose of the DDNIA volume
This volume, which is the Design Document for National Import Applications is applicable to every NICA and must be considered as a mandatory document for all implementation and verification activities.
The purpose of this volume is twofold:
- To state unambiguously what needs to be developed. This will be achieved by specifying the sequences of Information Exchanges to be supported, as a number of message exchange protocols and the detailed structure and building rules of these Information Exchanges;
- To define how the Information Exchanges need to be performed and transported between the NICAs. The XML format,as the transport mechanism,is described in the DDCOM volume.
I.1.4Scope of DDNIA volume
This volume is restricted to the electronic Information Exchanges within ICS and is aligned with [A2].
The [A4] defines the EBPs and IEs to be implemented and these are also specified in Appendix A of this volume. It also contains the specifications for ICS Phase 1, foreseeing a number of electronic exchanges.
It should be noted that [A4] identifies a certain number of mandatory Information Exchanges, while it provides only recommendations (or strong recommendations) for a number of other Information Exchanges. For the first category of (mandatory) Information Exchanges, DDNIA should therefore be considered as an applicable document, while for the latter category of (Recommended, Strongly Recommended or Optional) Information Exchanges, DDNIA should only be considered as a guideline with recommendations. The applicability of DDNIA is discussed further in this document (see Scope of development).
I.1.5Intended audience
The intended audience for this document includes:
- Any person responsible for the functional specifications of ICS;
- Any person responsible for the development of software in the context of ICS;
- Any person responsible for the definition of tests for ICS;
- Any person within the affected service suppliers in the CCN/CSI projects responsible for the delivery of the required services to ICS;
- Any other authorised body affected by ICS, including Electronic Customs Coordination Group (ECCG), OLAF, and Traders Associations.
Readers are assumed to have a good understanding of the IT concepts and terminology used in this document. Also, it is assumed that readers are familiar with [A4] and [A2].
I.1.6Structure of DDNIA volume
The DDNIA volume is structured in sections (further subdivided in chapters) and a number of appendices.
This document comprises the sections, chapters and lists of appendices summarised below:
Section IGeneral Introductionincludes the following chapters:
- Chapter 1 describes the purpose and the scope of DDNIA, the intended audience, the internal structure of the document,plus some document service information;
- Chapter 2 contains definitions used in this document (terminology, acronyms and abbreviations);
- Chapter 3 describes the relationship of this document with other Customs baseline documents. It defines dependencies with these documents and states the applicability of these documents. It also explains how this document, together with the other Customs documentation, should be used during the development and verification of any Customs application;
- Chapter 4 describes the symbolism and the conventions used in the various models included in this document. It also discusses the technical naming conventions used for the data dictionary that has been included in this document.
Section IIScope of developmentdiscusses the items that need to be developed in ICS Phase 1 applications. Appendix A for ICS Phase 1 accompanies this section.
The following sections contain a detailed definition of the message protocols to be supported for the different Business Processes. These message protocols are described by a collection of Sequence Diagrams, supported by State Transition Diagrams. Each section deals with one of the following Business Process areas:
Section IIIICSdescribes the Core Business for ICS Phase 1. In particular, it specifies the main Import Control scenarios.
Section IVCentral Services deals with the centralised collection and distribution of data that is of interest to the various MS for ICS Phase 1 and also covers availability reporting and statistics. It is subdivided as follows:
- Chapter 1 defines the Messages involved in Central Services;
- Chapter 2 defines how common RD and COL are exchanged;
- Chapter 3 defines how statistics and availability data are exchanged;
- Chapter 4 defines the message protocols to be used for exchanges with the CS/RD application via the Inter(Extra)net (for COL and common RD exchanges). In addition to the Information Exchanges, a number of Inter(Extra)net messages are introduced in this chapter;
- Chapter 5 defines the message protocols to be used for exchanges with the CS/RD application via CCN/CSI (for COL and common RD exchanges);
- Chapter 6 defines the message protocols to be used for exchanges with the CS/MIS application via the Inter(Extra)net (for exchanges of statistics data and availability data).
Section V Systems Administration deals with issues such as logging and tracing and any other administration function to be foreseen.
Section VITechnical Message Structuredefines the detailed technical structure of the Information Exchanges of ICS Phase 1.
Section VIIDesign principlesexplains how the system, defined in the previous sections, needs to be built. Basically, every Information Exchange needs to be formatted in XML format and needs to be transmitted across one of two communications platforms (CCN/CSI or Inter(Extra)net). This section states a number of principles that are common, regardless of the message format and transportation mechanism:
- Chapter 1 discusses the overall approach;
- Chapter 2 discusses the usage of character sets and Data Item conventions;
- Chapter 3 defines exception handling (how ICS should prevent and handle failures, defects, errors or mistakes);
- Chapter 4 defines constraints (any restrictions that are applicable to ICS development).
Section VIIIEDIFACT message formatting
The Section VI of DDCOM [A3] is not applicable to ICS Phase 1.
Section IXXML message formattingdefines how messages need to be formatted in an XML format.
Section XTransport of messages via CCN/CSIdefines how messages need to be transported across the CCN/CSI communication platform. This section is subdivided as follows: