Bill of Lading TD Conformance for Carriers

This page provides a step-by-step guide for measuring the conformance of a carrier application with the Transport Document module of the DCSA Bill of Lading 3.0.0 standard.

To access all conformance documentation, return to the DCSA Conformance page.

 

Create and configure the sandbox

Use the instructions in the Conformance Sandboxes page to create a sandbox with the following parameters:

Use the instructions in the Conformance Sandbox Configuration page to configure:

• how the DCSA synthetic shipper running in the sandbox will make API requests to your carrier application
• how your carrier application will send notification API requests to the DCSA synthetic shipper running in the sandbox (if you are implementing notifications at this time).

 

Run each scenario

Read the Conformance Scenarios page to understand the key concepts involved in executing DCSA conformance scenarios to measure the conformance of your application with the implemented DCSA standard.

Start each scenario from the sandbox home page that is supported by your application at this time, and perform each action as explained in the general scenario page above and illustrated in the example below.

Scenario actions use the name of the use cases from the Bill of Lading 3.0.0 State Transition Diagram.

 

Example TD scenario run

This is a step-by-step example of running the most common TD scenario:

• UC6 (carrier publishes the transport document)
• UC8 (carrier issues the transport document)
• UC12 (shipper requests surrender for delivery)
• UC13 (carrier processes surrender request for delivery)

 

Supply scenario parameters

As soon as you start the scenario, you will be prompted to supply the scenario parameters with which your application can run this scenario.

Copy the example JSON parameters into the text area below, and adjust each attribute to match the corresponding value in a transport document that you will use in this scenario:

 

UC6: Carrier publishes transport document

After you submit the scenario parameters, you are prompted to have your application publish a transport document (UC6) and provide its transport document reference as additional input.

Once your application has published the transport document, copy the template input into the text area below and replace "Insert TDR here" with the TDR (transport document reference) of the TD your application just published:

As soon as you provide the TDR, which completes UC6 (sending a notification to the shipper about the TD publication), you will see temporary grey notifications indicating that the orchestrator is waiting for the DCSA synthetic shipper to perform "GET", and then the shipper is waiting for your carrier application to respond. If your application responds as expected, you should see the updated scenario status as follows:

Note: For this step and for every other step involving notifications, if your application does not yet send notifications, you can complete the action without the notification being sent, and the corresponding checks will continue to be marked with a grey question mark indicating a missing HTTP exchange.

Press "Action completed" and confirm to complete step GET after UC6.

 

UC8: Carrier issues the transport document

After completing UC6 and the subsequent GET above, the scenario status indicates that it is your carrier application's turn to issue the transport document with UC8:

Have your application issue the transport document, which should trigger a notification to the shipper, then refresh the status:

Press "Action completed" to complete UC8.

Press "Action completed" again to complete the GET after UC8.

 

UC12: Shipper requests surrender for delivery

After completing UC8 and the subsequent GET above, the scenario indicates that your carrier application receives an out-of-band surrender request for delivery and needs to complete UC12 by sending a notification to the shipper that the TD is now in state PENDING SURRENDER FOR DELIVERY:

Have your application send the notification, then refresh the status:

Press "Action completed" to complete UC12.

Press "Action completed" again to complete the GET after UC12.

 

UC13: Carrier processes surrender request for delivery

After completing UC12 and the subsequent GET above, the scenario expects your carrier application to process and approve the surrender request for delivery, and to complete UC13 by sending a notification to the shipper that the TD is now in state SURRENDERED FOR DELIVERY:

Have your application send the notification, then refresh the status:

Press "Action completed" to complete UC13.

Press "Action completed" again to complete the GET after UC13, which also completes the entire scenario (otherwise the scenario would still be running and you could not start another one):

Back to the sandbox overview, the scenario is now complete and you can start another scenario, or restart the same one if there were errors that you want to fix in your carrier application and retest: