Agents

Agent to Send a New Shipment to IoT FM

• Agent ID: IOT SEND SHIPMENT
• Agent Type: SHIPMENT
• Triggered on: "Secure Resources – Accepted" or "Secure Resources - Pickup Notification"
• Saved Condition: <blank>
• Actions:
  • Sends OTM Shipment to the External System "IOT_FM".
  • Sets IoT FM SENT status = IOT_FM_SENT.
  • Sets the shipment GID as a reference number on the shipment with the Reference Number Qualifier "IOT_FM_ID".

Note: You must configure the Out XML Profile on the external system to include the following relative xpath: ShipmentStop/StopType.

Agent to Send Modified Shipment to IoT FM

• Agent ID: IOT SEND SHIPMENT UPDATE
• Agent Type: SHIPMENT
• Triggered on: "SHIPMENT - DATES MODIFIED" or "SHIPMENT - LOCATION MODIFIED"
• Saved Condition: IOT SENT SHIPMENTS (for shipments already sent to IoT FM)
• Actions:
  • Sends OTM Shipment to the External System "IOT_FM".

Note: You must configure the Out XML Profile on the external system to include the following relative xpath: ShipmentStop/StopType.

Agent to Send Delete Shipment Transmission

• Agent ID: IOT DELETE SHIPMENT
• Agent Type: SHIPMENT
• Triggered on: Shipment status changes to SECURE RESOURCES_WITHDRAWN
• Saved Condition: IOT SENT SHIPMENTS (for shipments already sent to IoT FM)
• Actions:
  • Sends OTM Shipment to the External System "IOT_FM" with a remark "DELETE SHIPMENT".
  • Sets IoT FM SENT status = IOT_FM_NOT_SENT.
  • Sets the IOT_FM_ID Reference Number on the shipment to the value "DELETED".

Note: You must configure the Out XML Profile on the external system to include the following relative xpath: ShipmentStop/StopType.

Note: Trips in IoT FM can only be deleted if the Trips are in the PLANNED state.

Agent to Copy Reference Numbers from Order Release Line To Shipment Ship Unit Line

• Agent ID: <EXAMPLE - NOT STAGED>
• Agent Type: ORDER RELEASE
• Triggered on: ORDER - STATUS CHANGED
• Saved Condition: <blank>
• Actions:
  • Select the Data Type Association ORDER RELEASE TO ORDER RELEASE LINE.
  • Copy Refnums from the order release line to the shipment ship unit line.
    • Use the Agent Action COPY REFNUMS FROM ORDER RELEASE LINE.
    • Set the Associated Object to ORDER RELEASE LINE TO SHIPMENT SHIP UNIT LINE.
    • Select the Reference Number Qualifiers that should be copied such as IOT_ASSET_NAME, IOT_DEVICE_HARDWARE_ID_1, and IOT_DEVICE_NAME_1.

Agent to Send Shipment Tracking Number to Carrier

• Agent ID: <EXAMPLE – NOT STAGED>
• Agent Type: TRACKING EVENT
• Triggered on: TRACKING EVENT - CREATED
• Saved Condition: <blank>
• Actions:
  • Associate the tracking event to the shipment using the TRACKING_NUMBER Shipment Reference Number Qualifier.
    • Use the Agent Action MATCH OBJECT BY TRACKING NUMBER
  • Copy remarks from the tracking event to the shipment.
    • Use the Agent Action COPY REMARKS FROM TRACKING EVENT
    • Select the Associated Object to TRACKING EVENT TO SHIPMENT
  • Send updated shipment information to the carrier :
    • Change the Data Type Association to TRACKING EVENT TO SHIPMENT.
    • Use the Agent Action MODIFY TENDER.

Agent to Handle Exception Events

• Agent ID: <EXAMPLE – NOT STAGED>
• Agent Type: TRACKING EVENT
• Triggered on: TRACKING EVENT – PROCESSING REQUEST
  • Can be further constrained to specific exception events by selecting the corresponding Status Code in the Restrictions field.
• Saved Condition: <blank>
• Actions:
  • IF <Status Code> indicates a violation of the temperature thresholds.
    • Flag for higher visibility on Workbench by using the Agent Action SET INDICATOR to ORANGE.
  • END IF
  • IF <Status Code> indicates theft or tampering and needs intervention services.
    • Send critical alert using the Agent Action NOTIFY CONTACT.
  • END IF