Managing enterprise asset shipments

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • Track and manage your enterprise asset shipments in real-time by integrating the Enterprise Asset Management application with third-party shipping carriers using the IT Asset Management integration framework.

    Shipping carrier integration overview.

    Prerequisites

    Before you can integrate the Enterprise Asset Management application with a third-party shipping carrier, the shipping carrier must complete the following prerequisites:
    • Enable cross scope access on their third-party application.
    • Create a script include that extends the base ITAMShipmentIntegration script so that you can connect to their third-party application and retrieve shipment details in real-time.
      • The script include must be available in the IT Asset Management application scope. However, the Caller access isn't restricted and Accessible from fields must be available in All application scopes.
      • Business logic must be implemented within the fetchShipmentinfo function to enable communication with the carrier API based on tracking numbers. The carrier API is required for connecting to the third-party application and for retrieving shipment details.
      • The fetchShipmentinfo function must return a JSON object with the following HTTP response code and message:
        {
httpResponseCode: 200, httpResponseMessage: ‘SUCCESS’
}
      • When the script include is in test mode, the shipping carrier invokes the carrier API to validate your connection to their third-party application. The shipping carrier can then either verify and return the response or query the shipments and invoke the processResponse function using the following response format:
        [
{
trackingNumber: ‘’,
deliveryDate: ‘’,
pickupDate: ‘’,
packageStatus: ‘’.
statusDetail: ‘’,
trackingURL: ‘’,
parcelWeight: ‘’,
deliveryServicesCost: ‘’,
currency: ‘’
}
	]
        If the shipping carrier invokes the processResponse function, they must return the response after the function completes.
    • Create an integration profile with the appropriate name, carrier API details, and connection details. This integration profile enables you to connect to the third-party application so that you can retrieve shipment details.
    • If the third-party application uses the ServiceNow Credentials [discovery_credentials] table or any other ServiceNow table with Password2 fields, provide a KMF access map policy to enable access to those tables. For more information on KMF access map policies, see Password2 encryption with the Key Management Framework (KMF).
    After the shipping carrier completes these prerequisites, you must complete these additional prerequisites:
    • If the integration profile contains connection details through a connection and credentials alias, update those details as needed so that you can successfully authenticate and connect to the carrier API.
    • Associate the shipping carrier with the integration profile.