PMM Simple Document Template

PMM Simple Document Template

© 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 History

Revision History

Date of this revision: 5/11/2012
Revision Number / Revision Date / Summary of Changes / Changes marked
0.01 / 26/9/12 / Initial version created / (N)
0.02 / 5/11/2012 / Updates after external review / (N)
0.03 / 19/11/2012 / Updates after internal reviews / (N)

Approvals

This document requires following approvals. Signed approval forms are filed in the Quality section of the PCB.

Name / Title
Roger Beeckman / Program Manager D&A

Distribution

This document has been distributed to

Name / Title
Roger Beeckman / Program Manager D&A
Ineke Rentmeesters / Project Manager IBM
Walter van Eetvelt / Business Analyst IBM
Stefan Van Assche / Lead Architect IBM

Contents

1.Introduction

1.1Purpose

1.2References

1.3Notation

2.Functional description

2.1Purpose

2.2Process Description

2.3Timing and other constraints

3.Information Model......

3.1Information model content and structure

3.2Information model description

3.3Response messages......

4.Technical message structure

4.1Web Service description

4.2WSDL

4.3XML Schema

4.3.1Mapping to XML

4.4XML Example

1.Introduction

1.1Purpose

This document provides the definition of the CCRM06ContainerStatus and CCRM07 ContainerStatusAcknowledgement message to be used in Electronic Data Interchange (EDI) between CCRM and other systems.

1.2References

This document refers to the following external documents and/or Web sites

Ref. / Reference / Title / V
A1 / CCRM Conditions and Rules / CCRM MIG Conditions and Rules.doc / 0.1

1.3Notation

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

2.Functional description

2.1Purpose

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.2Timing 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.

3.Information Model

3.1Information model content and structure

The functional message structure of the CCRM06 and CCRM07 messages is described below.

Figure 2: CCRM06ContainerStatus message structure

Figure 3: CCRM07 ContainerStatusResponse message structure

Document:masp.be_CCRM_MIG_CCRM06_ContainerStatus.docDate: 5/11/2012
Version: 0.02
Owner:FOD FIN D&AStatus: Draft

Subject:Message Implementation GuideENtry Summary declaration

Page 1of13

© FOD FIN Belgium and IBM Corporation 2012

MASP.be

3.2Information model description

ContainerStatus

Data group / Data item / Description / Multiplicity / Required / Format / Rule/Cond
Header / 1 / R
identification / Identifier that provides a unique identification of the message. Generated by the sending system / 1 / R / an..35 / R006
referenceIdentification / Empty string / 1 / R / an..35
sender / Name of the sending system / 1 / R / an..12 / R007, only CCRM allowed
receiver / Name of the receiving system / 1 / R / an..12 / MessageRecipient.Name
creationDateTime / Date and time when the message was generated by the sending system / 1 / R / an..20 / R002, R003
action / This field identifies whether the message is original, update or delete. For this message always ORIGINAL / 1 / R / an..12 / R008
type / This field identifies the message type, for this message always CONTAINERSTATUS. / 1 / R / An..12 / R016
version / Version of this message format / 1 / R / an..5 / current version is 1.0
ContainerStatus / 1 / R
manifestReference / Reference to the manifest on which the container was reported to Customs. / 1 / R / an..22 / R023
manifestType / 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
Container / 1 / R
containerNumber / Container number / 1 / R / an..17
location / Location code of the terminal where the container is discharged / 0..1 / O / an..35 / R005
destination / Location of the designated destination terminal. / 1 / C / an..35 / C005
Control / 0..* / O
requestNumber / The Request Number is a unique number created by the system that created the control request. / 1 / R / an..20
controlNumber / Control Number is a unique number for a control within a control request. / 1 / R / an..20
type / Type refers to the type of Controlsthat is requested.Values: Paper , Physical , Scanning, APosteriori / 1 / R / an..12 / R014
Document / Lists all the documents that are known by CCRM that handle information about the container. / 0..* / O
documentType / The type of document being referenced. / 1 / R / an..25 / R021
documentReference / Identification number of the document. For example, for an SAD Import, this will be the MRN. / 1 / R / An..35

Acknowledgement

Data group / Data item / Description / Multiplicity / Required / Format / Rule/Cond
Header / 1 / R
identification / Identifier that provides a unique identification of the message. Generated by the sending system / 1 / R / an..35 / R006
referenceIdentification / Identifier of the message to which this message is a response. / 1 / R / an..35
sender / 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
action / This field identifies whether the message is original, update or delete. For this message always ORIGINAL / 1 / R / an..12 / R008
type / This field identifies the message type, for this message always ACKNOWLEDGEMENT. / 1 / R / An..12 / R016
version / Version of this message format / 1 / R / an..5 / current version is 1.0
Response / 1 / R
status / Processing status. / 1 / R / an..17 / R020
reasonCode / Cause for the reported status, coded. / 1 / O / an..12 / R024
reasonText / Cause for / explanation of the reported status, free text. / 1 / O / an..35

The description of the Rules and Conditions can be found in [A1].

Document:masp.be_CCRM_MIG_CCRM06_ContainerStatus.docDate: 5/11/2012
Version: 0.02
Owner:FOD FIN D&AStatus: Draft

Subject:Message Implementation GuideENtry Summary declaration

Page 1of13

© FOD FIN Belgium and IBM Corporation 2012

MASP.be

3.3Response 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 CCRM07ContainerStatusAcknowledgement 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).

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.1Web 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.2WSDL

4.3XML Schema

4.3.1Mapping 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

4.4XML Example

Document:masp.be_CCRM_MIG_CCRM06_ContainerStatus.docDate: 5/11/2012
Version: 0.02
Owner:FOD FIN D&AStatus: Draft

Subject:Message Implementation GuideENtry Summary declaration

Page 1of13