Copyright IBM Corporation and Maersk GTD Inc. 2018, 2019
The Shipment Manager UI is the main end user UI for TradeLens and allows you to visualize your consignments (shipments) and documents associated with your consignments. You can search and filter consignments using different criteria. You can drill down into each consignment that you have access to, and visualize all the transport equipment (containers) involved. You can also view the list of events per transport equipment and filter by Admin, Current Progress, Transport Plan, and Documents.
Shipment Manager UI URLs
The Shipment Manager UI URLs for the Sandbox and Production zones are shown below.
Note: If you have been onboarded onto a different stack than "platform", replace "platform" with your stack name, for example "maersk", in the URLs.
Using the Shipment Manager
In this section, we will go through some of the features of the Shipment Manager UI. We will discuss:
- Viewing Consignments and Transport Equipment
- Filtering to limit the search results
- User Management
- Subscription Management
Viewing Consignments and Transport Equipment
The Shipment Manager UI allows you to view information about consignments you have started, or consignments that have been shared with you. The consignments that are visible from the Shipment Manager UI, or the Platform Query API for consignments (API Documentation), are based on the organization ID of the user. You will see consignments if at least one of the following is true:
The sender of the Start Consignment Tracking (POST .../consignments) was from your org
A Consignment Visibility Added (POST .../consignments/partyAdded) event was submitted to share visibility of a consignment with your org
Someone from your org has done a query with a delegation ID associated with the consignment
Your org is a port, country, or terminal that was derived from the transport plan (planned events only) for the transport equipment, or from the transport plan for the consignment once it has associated transport equipment.
For the old V1 Start Consignment Tracking and Start Transport Equipment Tracking APIs: If your org is a port or country, you will have visibility to the consignment if the port or country was defined in a transport equipment for the consignment, or if a Transport Equipment Locations Updated (POST .../transportEquipment/locationsUpdated) includes your port or country. If your org is a terminal, you will have visibility to the consignment if any transport event (planed, estimated, actual) has the terminal defined.
Note: A Consignment Visibility Added (POST .../consignments/partyAdded) is the preferred way to share visibility to the consignment; this also provides access to documents based on the partyRole, see the Document Sharing section for details on document permissions. Alternatively, if a delegation ID has been shared with you from the originator of the Start Consignment Tracking, you can do a query with the delegation ID to get visibility to the consignment. However, a query with the delegation ID does not grant access to any documents.
First log into the Shipment Manager UI. You can find the URL information in the Shipment Manager UI URLs section above.
If your id is an Org Admin, you will see a choice to "Continue as an Organization Admin of organization" for the organizations where you are an Admin. As an Org Admin, you will have access to the User Management function in the main menu. For this part of the example, we choose the non-Admin option and log in.
The Account option in the top menu will show you what ID you are signed in with, and contains the option to Sign off.
You will see all of the consignments that you are authorized to view.
We will cover the Search and Filter options in the Filtering section below. For now, we will take a look at a couple of the consignments to see what information is available.
You will see some summary information for the consignment from the main display.
You can see any additional data by clicking SUMMARY to expand the consignment card. You can see booking data (if available) displayed on the consignment card.
Consignment level events can be seen from the Events tab after you click on the consignment card (click in the box for a specific consignment), or click on FULL DETAILS. Here is an example that shows All Event Types for the consignment. Note that with the All Event Types view, the events are sorted by eventSubmissionTime.
You can select the Transport Plan events for the consignment. Note that with the Transport Plan view, the events are sorted by eventOccurrenceTime.
You can select the Admin events for the consignment.
You can select the Document events for the consignment.
If there is transport equipment information available, you can click on the consignment card (click in the box for a specific consignment), or click on FULL DETAILS, then select the Containers tab to see more details about the transport equipment. You will notice the Shipment Manager indicates the progress events for the transport equipment on the transport equipment card. The example below is for a completed consignment, so the progress shows it has arrived at the destination. Notice that you can select several different tabs: Events, Containers, and Documents. Each of these will give you more information about the consignment.
If you click on a transport equipment card (click in the box for a specific transport equipment), it will show additional information about the transport equipment, including the events submitted for the transport equipment and consignment; you might also hear the Shipment Manager referred to as the Event Visibility Dashboard (EVD). Notice that there are links at the top to return to the consignment list or the transport equipment list. Depending on what type of events are present, the Shipment Manager UI will preselect a filter. In this example, there are "Actual" transport events so the Current Progress filter is preselected. We will discuss these filters in more detail later. When we look at the events for the transport equipment, it has many events that show the movement for the transport equipment and consignment. The most current event is at the top, so scroll to the bottom if you want to follow the cargo from start (bottom) to finish (top). The image below shows the most current events at the top.
You can click on any of the events to see more details about that specific event. For example, here are the details for an "Actual Gate In" that has the fullStatus set to Full:
The filter within the transport equipment view allows you to filter by: Current Progress, Transport Plan, Admin, Documents, and All Event Types. See the Platform Event Model section for more details on the three types of transport events (Planned, Estimated, and Actual). The table below shows a summary of the filter combinations and the event types that will be displayed.
Table 1 - Current Progress/Transport Plan/Admin/Documents/All Event Types with Latest Events/All Events
|Latest Events||All Events|
|Current Progress||latest Plan, latest Estimated without an Actual, all Actuals for current progress leg - associated events are grouped by their planned, estimated, and actual events if available||latest Plan, all Estimated, all Actuals for current progress leg - associated events are grouped by their planned, estimated, and actual events if available|
|Transport Plan||latest Plan, latest Estimated without an Actual, all Actuals - associated events are grouped by their planned, estimated, and actual events if available||latest Plan, all Estimated, all Actuals - associated events are grouped by their planned, estimated, and actual events if available|
|Admin||latest Transport Equipment and Consignment||all Transport Equipment and Consignment|
|Documents||latest version of each Document||all versions of each Document|
|All Event Types||latest Plan, latest Estimated, all Actuals, latest other non-tp events||all events submitted|
Consignments and transport equipment can have documents. We will take a look at documents for a consignment. The process is very similar for transport equipment. If you have authority to view a document and want to see an image of the document, click on the document event and then click on the link for the document in the Document Information section. The image is displayed in a browser pop-up, so make sure that your browser is allowing pop-ups.
For example, here is a sample Packing List for the consignment:
You can click the Documents icon from the consignment card on the main page of the Shipment Manager UI, or click on Full Details and then select the Documents tab to see the documents. If you are authorized to view a document, you can click on the document link to see a preview.
For more information about documents, see the topic Document Sharing.
Filtering is available to help you narrow down your consignment view, or to look for specific consignments or transport equipment. The top search field can be used for each of the options listed above it. Just click one of the options and enter the appropriate value for the selected type.
The filters below the top search field are additional filters. You can expand the section to select a specific filter and then enter the value.
Note: If you want to search for all ports within a country, you can use the 2 digit country code followed by * as a wildcard. For example:
Consignment Hierarchy view
If your consignment is part of a consignment hierarchy (see the Consignment Hierarchy section for more details), there will be a Linked Consignments tab in the Full Details view of the consignment. Any linked consignments will be relative to the level of your consignment in the hierarchy. For example, there might be child consignments if your consignment is a parent, or parent consignments if your consignment is a child. If the owner of the linked consignment has granted visibility to the consignment to your organization, then you will be able to view the consignment; otherwise you will know that it exists, but it will be grayed out and the details will not be visible.
Here is an example where a freight forwarder organization has created two parent consignments with carrier booking numbers (CBN) CBN1TestFFWD and CBN2TestFFWD. An ocean carrier has created a consignment with CBN3TestCarrier. Then the freight forwarder organization has subcontracted each of its consignments to the ocean carrier's consignment. So we have two parent consignments that are connected (subcontracted) to a child consignment.
Since the owners of the consignments have not granted visibility yet to their consignment(s), the details for the linked consignment(s) will not be visible to the other organizations in the hierarchy. Here is the view from the freight forwarder.
When we click on the Full Details for one of the consignments, we will see the Linked Consignments tab.
Since the freight forwarder organization has not been granted visibility yet, the child consignment of the ocean carrier will be grayed out.
In our example, the ocean carrier adds the freight forwarder to the ocean carrier's consignment with the roles of ORIGIN_3PL and DESTINATION_3PL. This now gives the freight forwarder visibility to the subcontracted (child) consignment CBN3TestCarrier. The consignment will be visible from the main view for the freight forwarder.
The subcontracted consignment will also be visible from the Linked Consignments tab.
If you are an Organization Admin and have signed in as an admin, you can click User Management in the top menu. As an Org Admin, you can add, edit, or delete users for your organization. These users can be human users or system users. Human users can be granted Admin authority or left as a regular user. System users are used for "code" that will interact with the TradeLens APIs. See section Authentication and Token Generation for API usage for more details.
Notice in the screen images below, you can Edit or Delete users. For human users, an Edit will let you change the Description and change the Administrator setting for the user. If you have added a user as a non-admin, and later want to make them an admin, you should use the Edit button for that user, check the Administrator box and save. To remove Administrator authority from a user, use the Edit button and uncheck the Administrator box and save. For system users, an Edit will let you change the Description. To add a new human or system user, click Add New User.
You can select whether the new user is a System User, or by default it will be created as a Human User. If the user is a Human User, you can check the Administrator box if you want the user to have Org Admin privileges, like the ability to manage (add, edit, delete) users for your organization.
If you are adding a System User, you must enter the entire serviceid, including the "serviceid-" portion, for example "serviceid-4807b3fb-11d9-4304-b3da-8205a77d6f8a". See section Authentication and Token Generation for API usage for more details on ServiceIDs.
Click Add New User to complete the process.
The Subscription Management function is available by clicking the main menu icon. From the Subscription Management area, you can view and manage the subscriptions available for your organization.
See section Setting Up Subscriptions for details on how to set up and test subscriptions.