Enhanced quote monitor
The enhanced quote monitor enables you to monitor the following situations:
- Milestone x has not been reached y hours before a given date type.
- Milestone x has not been reached within y hours of a given date type.
- Milestone x has not been reached within y hours of milestone z.
- Milestone x has been reached y hours before a given date type.
- Milestone x has been reached within y hours of a given date type.
- Milestone x has been reached within y hours after milestone z.
- The order has been in status x for y hours.
- Date type x is y hours before date type z.
- Date type x is y hours after date type z.
The quote monitor can be configured to monitor the following system date types:
- Actual Expiration Date - Read from the EXPIRATION_DATE column of the YFS_ORDER_HEADER table.
For more information about milestones, date types, and monitoring rules, refer to the Configuring Distributed Order Management topic.
If you run the Enhanced Quote 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:
| Attribute | Value |
|---|---|
| Transaction ID | ORDER_MONITOR_EX.0015 |
| Document Type | Quote |
| Process Type | Quote Fulfillment |
| Abstract Transaction | No |
| APIs Called | None |
Criteria parameters
The following are the criteria parameters for this monitor:
| 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 Quote 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 monitor:
| Statistic Name | Description |
|---|---|
| NumOrdersProcessed | Number of quotes 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 ORDER_MONITOR_EX.0015.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.