© FOD FIN Belgium and IBM Corporation 2012
MASP.be
Message Implementation Guide
CCRM06_ContainerStatus
CCRM07_ContainerStatusAcknowledgement
Author: Marco van der Linden / Sven Rosiers
Owner: FOD FIN D&A
Customer: FOD FIN Belgium
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 1 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
Document History
Revision History
Date of this revision: 5/11/2012
Revision
Number
0.01
0.02
0.03
Revision
Date
26/9/12
5/11/2012
19/11/2012
Summary of Changes
Initial version created
Updates after external review
Updates after internal reviews
Changes
marked
(N)
(N)
(N)
Approvals
This document requires following approvals. Signed approval forms are filed in the Quality section of the
PCB.
Name
Roger Beeckman
Title
Program Manager D&A
Distribution
This document has been distributed to
Name
Roger Beeckman
Title
Program Manager D&A
Ineke Rentmeesters
Project Manager IBM
Walter van Eetvelt
Business Analyst IBM
Stefan Van Assche
Lead Architect IBM
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 2 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
Contents
1.
Introduction ............................................................................................................. 4
1.1
Purpose ........................................................................................................................................... 4
1.2
References ...................................................................................................................................... 4
1.3
Notation ........................................................................................................................................... 4
2.
Functional description ............................................................................................. 5
2.1
Purpose ........................................................................................................................................... 5
2.2
Process Description ....................................................................... Error! Bookmark not defined.
2.3
Timing and other constraints ........................................................................................................... 5
3.
Information Model ................................................................................................... 6
3.1
Information model content and structure ........................................................................................ 6
3.2
Information model description ......................................................................................................... 8
3.3
Response messages..................................................................................................................... 11
4.
Technical message structure ................................................................................ 12
4.1
Web Service description ............................................................................................................... 12
4.2
WSDL ............................................................................................................................................ 12
4.3
XML Schema................................................................................................................................. 12
4.3.1
4.4
Mapping to XML ..................................................................................................................... 12
XML Example ................................................................................................................................ 13
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 3 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
1. Introduction
1.1 Purpose
This document provides the definition of the CCRM06 ContainerStatus and CCRM07
ContainerStatusAcknowledgement message to be used in Electronic Data Interchange (EDI) between
CCRM and other systems.
1.2 References
This document refers to the following external documents and/or Web sites
Ref.
Reference
A1
CCRM
Rules
Title
Conditions
and CCRM MIG Conditions and Rules.doc
V
0.1
1.3 Notation
Acronyms
Description
AEO
Authorised Economic Operator
EDI
Electronic Data Interchange
EDIFACT
EDI for Administration, Commerce and Transport
ENS
ENtry Summary declaration
EORI
Economic Operator Registration and Identification
NCTS
New Computerised Transit System
MIG
Message Implementation Guide
PLDA
Paper-Less Douane & Accijnzen
RD
Reference Data
CCRM
Customs Container Removal authorization Message
WSDL
Web Services Description Language
XSD
XML Schema Definition
XML
eXtensible Mark-up Language
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 4 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
2. Functional description
2.1 Purpose
With the CCRM06 ContainerStatus message Customs will notify Container terminals about the status,
and changes of that status, of specific containers. The status is calculated by the CCRM system from
information reported to Customs in ENS, SATO, SAD Import and Transit declarations.
In response to this message, the receiving container terminal system is expected to notify Customs about
the processing status of the message via a CCRM07 ContainerStatusResponse message. This latter
message is also described in this document.
2.2 Timing and other constraints
Following the processing of container information received by Customs in e.g. ENS, SATO, SAD Import
and Transit declarations, the status of the container in question is calculated. This calculation is triggered
whenever new information about that container is received by Customs. When the resulting status has
changed, the container terminal where the container is located is informed of this new status. Four states
are currently reported by Customs:

RELEASE: the container may be removed from the terminal.

CONTROL: the container was selected for control. It may not be removed from the terminal,
except to be taken to a designated control site (e.g. scanning centre).

TRANSHIPMENT: the container may be removed from the terminal, but only if it is transhipped.

TRANSFER: the container may be removed from the terminal, but only to be transferred to the
designated destination terminal.
For a given container arriving at a terminal at a specific time, each of these statusses will be reported only
once. If the container terminal did not (yet) receive a status report for a container, then that container may
not be removed from the terminal for any intent or purpose.
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 5 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
3. Information Model
3.1 Information model content and structure
The functional message structure of the CCRM06 and CCRM07 messages is described below.
Figure 2: CCRM06 ContainerStatus message structure
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 6 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
Figure 3: CCRM07 ContainerStatusResponse message structure
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 7 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
3.2 Information model description
ContainerStatus
Data group
Data item
Description
Multiplicity
identification
1 R
an..35
referenceIdentification
Identifier that provides a unique identification of the
message. Generated by the sending system
Empty string
1 R
an..35
sender
Name of the sending system
1 R
an..12
receiver
Name of the receiving system
1 R
an..12
Header
Requir Format Rule/Cond
ed
1 R
R006
R007, only CCRM
allowed
MessageRecipient.Nam
e
creationDateTime
action
type
version
Date and time when the message was generated by the
sending system
1 R
an..20
R002, R003
This field identifies whether the message is original,
update or delete. For this message always ORIGINAL
1 R
an..12
R008
This field identifies the message type, for this message
always CONTAINERSTATUS.
1 R
An..12
R016
Version of this message format
1 R
an..5
current version is 1.0
ContainerStatus
1 R
Reference to the manifest on which the container was
reported to Customs.
1 R
an..22
R023
Indicates the initial document type that contained the
container.
1 R
An..10
R022
status
Status of the container
1 R
An..12
R019
statusDateTime
Date when status was updated
1 R
An..20
R002, R003
containerNumber
Container number
manifestReference
manifestType
Container
1 R
location
Location code of the terminal where the container is
discharged
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
1 R
an..17
O
an..35
0..1
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 8 of 13
R005
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
destination
Location of the designated destination terminal.
1 C
Control
an..35
C005
0..* O
requestNumber
controlNumber
The Request Number is a unique number created by
the system that created the control request.
Control Number is a unique number for a control within
a control request.
type
1 R
an..20
1 R
an..20
1 R
an..12
R014
R021
Type refers to the type of Controls that is requested.
Values: Paper , Physical , Scanning, A Posteriori
Document
O
Lists all the documents that are known by CCRM that
handle information about the container.
documentType
documentReference
0..*
The type of document being referenced.
1 R
an..25
Identification number of the document. For example, for
an SAD Import, this will be the MRN.
R
An..35
1
Acknowledgement
Data group
Data item
Description
Multiplicity
identification
1 R
an..35
1 R
an..35
sender
Identifier that provides a unique identification of the
message. Generated by the sending system
Identifier of the message to which this message is a
response.
Name of the sending system
1 R
an..12
receiver
Name of the receiving system
1 R
an..12
R007, always CCRM
creationDateTime
Date and time when the message was generated by the
sending system
1 R
an..20
R002, R003
This field identifies whether the message is original,
update or delete. For this message always ORIGINAL
1 R
an..12
R008
This field identifies the message type, for this message
always ACKNOWLEDGEMENT.
1 R
An..12
R016
Header
Requir Format Rule/Cond
ed
1 R
referenceIdentification
action
type
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 9 of 13
R006
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
version
Version of this message format
status
Processing status.
1 R
Response
an..5
current version is 1.0
1 R
an..17
R020
O
an..12
R024
O
an..35
1 R
reasonCode
reasonText
Cause for the reported status, coded.
1
Cause for / explanation of the reported status, free text.
1
The description of the Rules and Conditions can be found in [A1].
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 10 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
3.3 Response messages
For this message a response message is defined. The receipt of this message by CCRM will be signalled
on the technical level by a HTTP/200 message, and on the functional level by a CCRM07
ContainerStatusAcknowledgement message (see 3.1 and 3.2).
If a message cannot be processed by the receiving system, the sending system will receive a HTTP
status code indicating a problem, or when the webservice SOAP message cannot be processed, a SOAP
Fault will be returned. In case the functional validation fails, a CCRM07 message will be returned with the
following content (see 3.2).
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 11 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
4. Technical message structure
This chapter describes the technical message structure. The message is sent to CCRM via a
webservices interface. This interface is described by the WSDL. This interface will process XML
messages of which an example can be found below. The format of the XML message is described by the
XML Schema (.xsd).
4.1 Web Service description
The CCRM Web Service is used to receive information from the different source systems. It provides an
operation (method) per message type. Multiple clients can invoke the web service simultaneously by
calling the relevant method.
Operation Description
Name
Input Parameters
Returns
4.2 WSDL
4.3 XML Schema
4.3.1 Mapping to XML
The XML mapping is done according to the mapping rules in [A5]. Taking into account that the mapping is
performed in two stages, i.e. functional message structure -> technical message structure -> XML, the
mapping is as follows:
Data group / element
XML tag
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 12 of 13
© FOD FIN Belgium and IBM Corporation 2012
MASP.be
4.4 XML Example
Document:
81922187
Owner:
Subject:
FOD FIN D&A
Message Implementation Guide ENtry Summary declaration
Date: 5/11/2012
Version: 0.02
Status: Draft
Page 13 of 13