Introduction
In this document, we describe a number of functional scenarios that you can test to see if your system interface with Notification Export Documentation is working properly. More information about the service can be found in the article Creating a system interface with Notification Export Documentation.
In this article, we use message specifications and example messages that you can find in this download.
The service NED is intended to pre-notify documents for Export shipments at a terminal. New documents can be submitted, updated, and deleted via the screen or a system interface. Additionally, you can receive status updates via the system interface, regardless of how documents have been submitted.
Process flow service NED
Scenario 1: Submit new NED document
- Create an M114 message from your own system, according to the specifications. See the example messages in the download.
- Choose 'original' as contentAction
- Use only a type from the list of NED documentTypes as documentType.
- Fill <documentNumber> with the MRN of the Export or Transit declaration. In the case of other documentTypes, use the reference number of that document.
- If you want to test a functional rejection, use the same MRN twice with different equipment in subsequent messages. Since the MRN must be unique, the second will be rejected.
- Send the message to PCS in the KT environment of Portbase.
Possible results:
- In case of Technical rejection. You receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of Technical acceptance. You receive a TA07 Technical acknowledgement message with code 'AK'
- You only receive this if you have chosen to always receive a 'technical acknowledgement'.
Next
- In case of Functional rejection. You receive an M116 message with responseTypeCode 'RP'.
- The reason for rejection is described in the <errorDescription> field.
- See the M116 message specifications in the download for the list of possible rejection reasons.
- In case of Functional acceptance. You receive an M116 message with responseTypeCode 'AR'.
- The document is then accepted and will be forwarded to terminals expecting the booking from the message.
Next
- In case of Document Status change. You receive an M115 message with a statusCode of the document.
- See the M115 message specifications in the download for the list of statusCodes and their meanings.
- M115 messages are only sent for Export and Transit documents. Other documentTypes do not receive status updates, as they are not sent to Customs by Portbase.
- You only receive M115 messages if you are registered for this with Portbase.
Scenario 2: Modify / replace existing NED document
- First, execute Scenario 1.
- Create a new M114 message from your own system, according to the specifications. See the example messages in the download.
- Fill <contentReference> with a new unique value.
- Choose 'replace' as contentAction.
- Fill <previousContentReference> with the value of <contentReference> from the M114 message in Scenario 1.
- Modify one or more values in the <contentBody>.
- Modify document or equipment details.
- You can add or delete equipment, provided at least 1 equipment remains per document.
- You can add or delete a document, with its own equipment, provided at least 1 document remains.
- Send the message to PCS in the KT environment of Portbase.
Possible results:
- In case of technical rejection. You receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of technical acceptance. You receive a TA07 Technical acknowledgement message with code 'AK'
- You only receive this if you have chosen to always receive a 'technical acknowledgement'.
Next
- In case of Functional rejection. You receive an M116 message with responseTypeCode 'RP'.
- The reason for rejection is described in the <errorDescription> field.
- See the M116 message specifications in the download for the list of possible rejection reasons.
- Depending on the status of the document, modifications may no longer be allowed.
- In case of Functional acceptance. You receive an M116 message with responseTypeCode 'AR'.
- The requested modification is then stored in NED and will be forwarded to terminals expecting the booking from the message.
Next
- In case of Document Status change. You receive an M115 message containing a statusCode of the document.
- See the M115 message specifications in the download for the list of statusCodes and their meanings.
- M115 messages are only sent for Export and Transit documents. Other documentTypes do not receive status updates, as these are not sent by Portbase to Customs.
- You receive M115 messages only if you are registered for this with Portbase.
Scenario 3: delete existing NED document
- First execute Scenario 1.
- Create a new M114 message from your own system, according to the specifications. See the example messages in the download for this.
- Fill <contentReference> with a new unique value
- Choose 'deletion' as contentAction
- Fill <previousContentReference> with the value of <contentReference> from the M114 message from Scenario 1.
- Repeat the values from the <contentBody> of the message from Scenario 1.
- Send the message to PCS in the KT environment of Portbase.
Possible results:
- In case of Technical rejection. You receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of Technical acceptance. You receive a TA07 Technical acknowledgement message with code 'AK'
- You only receive this if you have chosen to always receive a Technical acknowledgement.
Next
- In case of Functional rejection. You receive an M116 message with responseTypeCode 'RP'.
- The reason for rejection is described in the field <errorDescription>.
- See the M116 message specifications in the download for the list of possible rejection reasons.
- Depending on the status of the document, deletions may no longer be allowed. For example, when the document is already listed on an Export Manifest.
- In case of Functional acceptance. You receive an M116 message with responseTypeCode 'AR'.
- The document is then deleted from NED. The terminals expecting the booking from the message will also receive the deletion.
Next
- In case of Document Status change. You receive an M115 message containing a statusCode of the document.
- See the M115 message specifications in the download for the list of statusCodes and their meanings.
- M115 messages are only sent for Export and Transit documents. Other documentTypes do not receive status updates, as these are not sent by Portbase to Customs.
- You receive M115 messages only if you are registered for this with Portbase.