Shipment monitor

This time-triggered transaction reports the states of a shipment, based on rules in the YFS_MONITOR_RULE table. This transaction enables you to monitor the following situations:

  • If the Shipment has been in a status for more than a specified amount of time.
  • If a specified date that is associated with the shipment is:
    • n hours before another specified date
    • n hours after another specified date
    • n hours not before another specified date
    • n hours not after another specified date
  • If the Shipment has been in a hold type for a specified amount of time.
  • If the Shipment has been in a hold type for n hours before a specified date.

Monitoring rules can be configured for shipment's origin and destination points.

Monitoring rules cannot be configured for a shipment's intermediate pickup and drop off points. A shipment has intermediate pickup or drop off only if it has multiple pickup or drop off points. For example, a shipment has more than one loads carrying it. The shipment status on first load deposit, second load deposit, and so forth cannot be monitored. Once the last load deposits the shipment at its destination, then the shipment status can be marked and monitored.

This is not a pipeline transaction. It also does not work from the task queue.

For more information about milestones, date types, and monitoring rules, see the Configuring Sterling Supply Collaboration topic, the Configuring Distributed Order Management topic, and the Configuring Sterling Reverse Logistics topic.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Shipment monitor attributes
Attribute Value
Base Transaction ID SHIPMENT_MONITOR
Base Document Type Order
Base Process Type Order Delivery
Abstract Transaction No
APIs Called None

Criteria parameters

The following are the criteria parameters for this monitor:

Table 2. Shipment monitor criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
EnterpriseCode Optional. Enterprise for which the Shipment Monitor needs to be run. If not passed, then all enterprises are monitored.
CollectPendingJobs If this parameter is set to N, the agent does not collect information on the pending jobs for this monitor. This pending job information is used for monitoring the monitor in the System Management Console.
ColonyID Required in a multi schema deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Shipment monitor statistics
Statistic Name Description
NumShipmentsMonitored Number of shipments monitored.

Pending job count

For this transaction the pending job count is the number of open shipments with the value of NEXT_ALERT_TS less than or equal to (<=) the current date.

Events raised

This invokes the actions configured against shipment statuses.

Key Data - Not Applicable.

Data Published - SHIPMENT_MONITOR.xml

Monitor rule's condition template

If a monitor rule contains a condition, the <INSTALL_DIR>/repository/xapi/template/source/smcfs/monitor/SHIPMENT_MONITOR_CONDITION.xml template file is used to obtain the shipment details and the evaluating monitor rule details. See the provided <INSTALL_DIR>/repository/xapi/template/source/smcfs/monitor/SHIPMENT_MONITOR_CONDITION.xml.sample file for more details.

If the <INSTALL_DIR>/repository/xapi/template/source/smcfs/monitor/SHIPMENT_MONITOR_CONDITION.xml template file does not exist, the MonitorConsolidation->Shipment element of the default monitor template, the <INSTALL_DIR>/repository/xapi/template/source/smcfs/monitor/SHIPMENT_MONITOR.xml file, is used.

If the default monitor template is used, the MonitorConsolidation->Shipment-> MonitorRule element is ignored and is not passed into the condition.