Setting Up the Track and Trace Cloud Service

Prerequisites

Before you can set up the Track and Trace cloud service:

1. Make sure that your license for Supply Chain Orchestrator includes the Track and Trace feature.

2. If you have not done so yet, set up a Supply Chain Framework instance, installing with Supply Chain Framework version 1.6.0.

Overview of Service Usernames

The setup process involves three service accounts (username/password). This section summarizes them for convenience:

• Within Supply Chain Orchestrator, there must be a user that is a member of the SC_API_CloudService role. You define this user manually within Supply Chain Orchestrator as part of the setup process.

  You provide this username and password as IRIS Username and IRIS Password when you deploy the Track and Trace service. The deployment process authenticates to Supply Chain Orchestrator and sets up the users listed the next two list items.

• Within the Track and Trace service, there must be a user that can access the Supply Chain Orchestrator APIs. This user is created automatically when you deploy the Track and Trace service. You specify the username and password via the Track & Trace SCO API Username, Track & Trace SCO API Password. and Confirm Track & Trace SCO API Password fields.

  The Track and Trace service uses this username and password to authenticate all its calls to the Supply Chain Orchestrator instance.

• Also within the Track and Trace service, there must be a user that can access the Track and Trace service APIs. This user is created automatically when you deploy the Track and Trace service. You specify the username and password via the Track & Trace MacroPoint API Username, Track & Trace MacroPoint API Password, Confirm Track & Trace MacroPoint API Password fields.

  When you configure MacroPoint, you use this username and password to authenticate connections to the Track and Trace service.

Descartes MacroPoint also requires a username and password, which you obtain as part of the setup process. When you deploy the Track and Trace service, you provide this username and password so that the Track and Trace service can authenticate its calls to MacroPoint.

Setup

To set up the Track and Trace service, you need to update your data loading processes for Supply Chain Orchestrator to provide the required input data needed by the Track and Trace cloud service; for details, see Data Requirements.

You also must complete the following steps:

1. Obtain a contract with Descartes MacroPoint to provide shipment tracking updates. The contract will include details on the following:

   • Type of shipment (Truck, Rail, Air, Ocean) to be tracked

   • Location update frequency

   • Maximum tracking duration in hours

2. Complete the onboarding process with MacroPoint, which may include onboarding carriers and brokers who are not yet using MacroPoint.

3. In your Supply Chain Orchestrator instance, define a service user (username/password) for use in communicating with the Track and Trace service and for the service registration process.

   Specifically, this user must be a member of the SC_API_CloudService role.

4. In the InterSystems Cloud Services portal, deploy and register the Track and Trace cloud service. Make note of the deployment URL, which you will later use when configuring MacroPoint.

5. In the MacroPoint web portal, update your MacroPoint configuration so that MacroPoint automatically sends updates to the appropriate Track and Trace URLs.

Deploying the Track and Trace Cloud Service

1. Log into the InterSystems Cloud Services portal (creating an account if necessary, see Get StartedOpens in a new tab).

2. On the Services pageOpens in a new tab, subscribe to the Track & Trace Service with Descartes MacroPoint.

3. On the Deployments pageOpens in a new tab, click Create New Deployment.

4. Choose Track & Trace Service with Descartes MacroPoint.

5. Enter the following details:

   • MacroPoint Username: Enter the username required to authenticate API requests to MacroPoint. You will find this information in your contract with MacroPoint.

   • MacroPoint Password: Enter the corresponding password.

   • MacroPoint Create Order URL: Enter the end point that you use to create orders for tracking requests; this is in your contract with MacroPoint. For example: https://macropoint-lite.com/api/1.0/orders/createorder

   • Supply Chain Orchestrator Host: Enter the host name of the Supply Chain Orchestrator instance.

   • IRIS Server Port: Enter the port number of the Supply Chain Orchestrator instance. E.g. 52773

   • IRIS Username: Enter the username of the service account defined in the Supply Chain Orchestrator instance (the user that is a member of the SC_API_CloudService role). This username is used to access the Supply Chain Orchestrator APIs and also to register the cloud service.

   • IRIS Password: Enter the corresponding password.

   • Datamodel Path: Enter the path of the data model API in your instance. For example: api/sc/scdata/v1

   • Cloud Service Path: Enter the path of the cloud services in your instance. For example: api/sc/sccs/v1

   • Notification Email and Confirm Notification Email: Specify an email address to send notification in case of errors.

   • Track & Trace SCO API Username: Enter a new service username to define in the Track and Trace service; the service will use this when communicating with Supply Chain Orchestrator.

   • Track & Trace SCO API Password and Confirm Track & Trace SCO API Password: Enter a password for this user.

   • Track & Trace MacroPoint API Username: Enter another new service username to define in the Track and Trace service; MacroPoint will use this username when authenticating to the Track and Trace service.

   • Track & Trace MacroPoint API Password and Confirm Track & Trace MacroPoint API Password: Enter the corresponding password.

   • Allowed CIDRs: You’ll need the CIDR for your Supply Chain Orchestrator instance. This is for white listing of the IP address so that Track and Trace will accept the incoming requests from the Supply Chain Orchestrator instance. For example: 127.0.0.1/32

6. Click Create.

7. Complete registering the cloud service. This includes providing the Supply Chain Orchestrator license key.

Configuring MacroPoint

To configure MacroPoint for use with the Track and Trace cloud service:

1. Log in to the MacroPoint web portal.

2. Go to Company Administration > Update Company Preferences. Then update the following items:

   • Location Updates: {{TRACK_&_TRACE_DEPLOYMENT_URL}}/macropoint/locationUpdate

   • Order Status Changes: {{TRACK_&_TRACE_DEPLOYMENT_URL}}/macropoint/orderStatus

   • Trip Event Updates: {{TRACK_&_TRACE_DEPLOYMENT_URL}}/macropoint/tripEvents

   • Schedule Alerts: {{TRACK_&_TRACE_DEPLOYMENT_URL}}/macropoint/scheduleAlerts

   • Enhanced Shipment Status: {{TRACK_&_TRACE_DEPLOYMENT_URL}}/macropoint/enhancedShipmentStatus

   For these items, also click Url Requires Authentication. For the username and password, enter the values from the Track & Trace MacroPoint API Username and Track & Trace MacroPoint API Password fields, as configured within the Track and Trace cloud service.

   Note that {{TRACK_&_TRACE_DEPLOYMENT_URL}} is the deployment URL you obtained from the InterSystems Cloud Services portal, when deploying the Track and Trace cloud service.

Next Steps

• Track and Trace Data Requirements