Introduction
This document describes a number of functional scenarios that you can test to check whether your connection is working properly from your position as a terminal. In the attached download you will find the message specifications and example messages to set up the system interface referred to in this article.
To test in our Customer Test environment (KT environment), a separate register is required. Please contact our Integration department for this.
Process flow service
The process flow for the service 'Notification Import Documentation' for ferry and container terminals (V2):
Attention! Please include the following exceptions in the expected process:
- Terminals are required to connect to 'Berichtenflow V2'.
- The withdrawal request is a 'web only' application; processing a withdrawal request can be handled via both email and EDI. Inform Portbase of your preferred process.
Scenario 1a: NID document received (container cargo)
For container cargo, you can expect the following test messages:
- An M2401 message is available at PCS. Use the sample messages 'ImportDocument In Container' for this purpose.
- The <receiverIdentifier> element contains the value “TERM1LADING”. In production, this is the name of your own terminal.
- The <importDocument><number> element contains a scenario code from the table below for the different scenarios. This is followed by a unique code; the document number and document type must always form a unique combination.
- For container cargo, this means the <equipmentlist> element must be completed.
| Scenario | <receiverIdentifier> | <importDocument><number> = review code |
| Acceptance by terminal | TERM1LADING | Regular document type and number. Do not start with RE. Example: FWV with number DOC123. |
| Rejection by terminal | TERM1LADING | Regular document type and number. Start with RE. Example: FWV with number RE132. |
| No response from terminal | 3199LD875 | Regular document type and number. |
Scenario 1b: NID document receipt confirmation (container cargo)
After receiving an M2401 message, a confirmation message is expected from the terminal. See the sample M2402 message 'ImportDocument Functional Acknowledgement In' for this.
- Create an M2402 message
- In the <responseTypeCode> element, a 'PR' code is expected for receipt
| <receiverIdentifier> | review code | <responseTypeCode> | Status description |
| TERM1LADING | <none> | PR | <empty> |
| TERM1LADING | RE | PR | Not accepted, document type unknown. |
Scenario 1c: NID document receipt confirmation (container cargo)
After receiving and processing an M2401 message, the acceptance status is expected from the terminal. See the sample M2402 message 'ImportDocument Functional Acknowledgement In' for this.
- Create an M2402 message
- In the <responseTypeCode> element, a code is expected for receipt that matches the chosen scenario from the M2401 message. See the table below for the options:
| <receiverIdentifier> | review code | <responseTypeCode> | Status description |
| TERM1LADING | <none> | AP | <empty> |
| TERM1LADING | RE | RE | Not accepted, document type unknown. |
Scenario 2a: NID document submission (ferry cargo)
For ferry cargo, you can expect the following test messages:
- An M2401 message is available at PCS. Use the sample messages 'ImportDocument In Shipment' for this purpose.
- The <receiverIdentifier> element contains the value “TERM1LADING”. In production, this is the name of your own terminal.
- The <importDocument><number> element contains a scenario code from the table below for the different scenarios. This is followed by a unique code; the document number and document type must always form a unique combination.
- Complete all mandatory elements for testing. For ferry cargo, this means the <shipmentId> element must be completed.
| Scenario | <receiverIdentifier> | <importDocument><number> = review code |
| Acceptance by terminal | TERM1LADING | Regular document type and number. Do not start with RE. Example: FWV with number DOC123. |
| Rejection by terminal | TERM1LADING | Regular document type and number. Start with RE. Example: FWV with number RE132. |
Scenario 2b: NID document receipt confirmation (ferry cargo)
After receiving an M2401 message, a confirmation message is expected from the terminal. See the sample M2402 message 'ImportDocument Functional Acknowledgement In' for this.
- Create an M2402 message
- In the <responseTypeCode> element, a 'PR' code is expected for receipt
| <receiverIdentifier> | review code | <responseTypeCode> | Status description |
| TERM1LADING | <none> | PR | <empty> |
| TERM1LADING | RE | PR | Not accepted, document type unknown. |
Scenario 2c: NID document response (ferry cargo)
After receiving and processing an M2401 message, the acceptance status is expected from the terminal. See the sample M2402 message 'ImportDocument Functional Acknowledgement In' for this.
- Create an M2402 message
- In the <responseTypeCode> element, a code is expected for receipt that matches the chosen scenario from the M2401 message. See the table below for the options:
| <receiverIdentifier> | review code | <responseTypeCode> | Status description |
| TERM1LADING | <none> | AP | <empty> |
| TERM1LADING | RE | RE | Not accepted, document type unknown. |
Related to