Work order monitor

This time-triggered transaction alerts the enterprise when a work order remains in a particular state or hold type for a specific amount of time.

Use this monitor to track how long work orders stay in a particular state or hold type.

Attributes

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

Table 1. Work order monitor attributes
Attribute Value
Base Transaction ID WORK_ORDER_MONITOR
Base Document Type Work Order
Base Process Type VAS Process
Abstract Transaction No

Criteria parameters

The following are the criteria parameters for this monitor:

Table 2. Work 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 Work Order Monitor needs to be run. If not passed, then all enterprises are monitored.
Node Optional. Node for which the Work Order Monitor needs to be run. If not passed, then all nodes 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. Work order monitor statistics
Statistic Name Description
NumWorkOrdersMonitored Number of work orders monitored.

Pending job count

For this transaction the pending job count is the number of Work Orders that are monitored, where NEXT_ALERT_TS less than or equal to (<=) current date.

Events raised

No events are raised. Individual actions associated with the monitoring rule are run. Data published to the actions is workOrder_dbd.txt.

Monitor rule's condition template

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

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

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