The service Notification Export Documentation has been rebuilt and is currently being rolled out to all users. The information in this article applies to both the old and the rebuilt service (Notification Export Documentation). Nothing has been adjusted in the system interface.
Introduction
In this document we describe a number of functional scenarios that you can test to see whether your system interface with Notification Export Documentation works correctly. More information about the service can be found in the article Create a system interface with Notification Export Documentation.
In this article we use message specifications and sample messages that you can find in this download.
The NED service is intended to pre-notify documents for export shipments at a terminal. New documents can be entered, updated and deleted via the screen or a system interface. In addition, you can receive status updates via the system interface, regardless of how the documents were entered.
Process flow NED service
Scenario 1: Submit new NED document
- Create an M114 message from your own system, according to the specifications. For this, see the sample messages in the download.
- Choose contentAction 'original'
- For documentType, use only a type from the list of NED-documentTypes.
- 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 consecutive messages. Because the MRN must be unique, the 2nd one will be rejected.
- Send the message to PCS in the KT environment of Portbase.
Possible results:
- In case of technical rejection, you will receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of technical acceptance, you will receive a TA07 Technical acknowledgement message with code 'AK'
- You will only receive this if you have chosen to always receive a 'technical acknowledgement'.
Next
- In case of functional rejection, you will 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 reasons for rejection.
- In case of functional acceptance, you will receive an M116 message with responseTypeCode 'AR'.
- The document is then accepted and will be forwarded to terminals that expect the booking from the message.
Next
- In case of a document status change, you will 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 meaning.
- M115 messages are only sent for export and transit documents. Other documentTypes do not receive status updates because these are not sent by Portbase to Customs.
- You will only receive M115 messages if you have registered for this with Portbase.
Scenario 2: Adjust / replace an existing NED document
- First, carry out Scenario 1.
- Create a new M114 message from your own system, according to the specifications. For this, see the sample messages in the download.
- Fill <contentReference> with a new unique value.
- Choose contentAction 'replace'.
- Fill <previousContentReference> with the value of <contentReference> from the M114 message from Scenario 1.
- Adjust one or more values in the <contentBody>.
- Adjust document or equipment details.
- You can add or delete equipment, provided at least 1 equipment per document remains.
- 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 will receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of technical acceptance, you will receive a TA07 Technical acknowledgement message with code 'AK'
- You will only receive this if you have chosen to always receive a 'technical acknowledgement'.
Next
- In case of functional rejection, you will 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 reasons for rejection.
- Depending on the status of the document, changes may no longer be permitted.
- In case of functional acceptance, you will receive an M116 message with responseTypeCode 'AR'.
- The requested adjustment is then stored in NED and will be forwarded to terminals that expect the booking from the message.
Next
- In case of a document status change, you will 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 meaning.
- M115 messages are only sent for export and transit documents. Other documentTypes do not receive status updates because these are not sent by Portbase to Customs.
- You will only receive M115 messages if you have registered for this with Portbase.
Scenario 3: Delete an existing NED document
- First, carry out Scenario 1.
- Create a new M114 message from your own system, according to the specifications. For this, see the sample messages in the download.
- Fill <contentReference> with a new unique value
- Choose contentAction 'deletion'
- 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 will receive a TA07 Technical acknowledgement message with code 'NAK'
- In case of technical acceptance, you will receive a TA07 Technical acknowledgement message with code 'AK'
- You will only receive this if you have chosen to always receive a Technical acknowledgement.
Next
- In case of functional rejection, you will 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 reasons for rejection.
- Depending on the status of the document, deletions may no longer be permitted. For example, when the document is already listed on an export manifest.
- In case of functional acceptance, you will receive an M116 message with responseTypeCode 'AR'.
- The document is then deleted from NED. The terminals that expect the booking from the message will also be informed of the deletion.
Next
- In case of a document status change, you will 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 meaning.
- M115 messages are only sent for export and transit documents. Other documentTypes do not receive status updates because these are not sent by Portbase to Customs.
- You will only receive M115 messages if you have registered for this with Portbase.