Enhanced return monitor

The enhanced return monitor allows you to monitor the following situations:

The enhanced return monitor can be configured to monitor the following system date types:

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

If you run the Enhanced Return Monitor, you must configure and run the Close Order time-triggered transaction in all applicable pipelines. For more information about the Close Order time-triggered transaction, see Close order.

The same relog interval is used for all document types.

Attributes

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

Table 1. Enhanced order monitor attributes
Attribute Value
Base Transaction ID RETURN_MONITOR_EX
Base Document Type Return Order
Base Process Type Reverse Logistics
Abstract Transaction No
APIs Called None

Criteria parameters

The following are the criteria parameters for this monitor:

Table 2. Enhanced order 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 Order Monitor needs to be run. If not passed, then all enterprises are monitored.
FromStatus Optional. Statuses to monitor that are greater than or equal to the passed status.
ToStatus Optional. Statuses to monitor that are less than or equal to the passed status.
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 monitor:

Table 3. Enhanced order monitor statistics
Statistic Name Description
NumOrdersProcessed Number of orders processed.
NumAlertsRaised Number of alerts raised.

Pending job count

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

Events raised

No events are raised. Individual actions associated with the monitoring rule are run.

The data published is RETURN_MONITOR_EX.xml.

Monitor rule's condition template

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

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

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