Jitendra Buge 16 th April, 2015 Support Technical Exchange session on Enhanced Order Monitor Document number
Agenda Enhanced Order Monitor Overview Time Triggered Transaction Monitors Enhanced Order Monitor - Monitor Rule Enhanced Order Monitor - Transaction Agent details Enhanced Order Monitor - Monitor Event Working of Enhanced Order Monitor with respect to threads Basic Enhanced Order Monitor operation with Milestones Close Order Transaction Demo - Queue and Connection Factory Setup Transaction Agent Setup Pipeline's monitoring rules setup Monitor Event Setup Monitor Event s Service setup Common Issues and Resolutions Q & A 2 Enhanced Order Monitor - (IBM SSFS)
Enhanced Order Monitor Enhanced Order Monitor is a time triggered transaction which helps in monitoring the orders for certain conditions and raises an alert. It makes use of Monitor rules, Monitor Events and Services. Enhanced Order Monitor transaction represents the advanced set of parameters used to monitor orders in the system. It does watch for processes or circumstances that are out of bounds and then raise alerts. E.g. IF Order has been in Reserved for 1 elapsed hours THEN raise JB_EOM. The order has been in hold type x for y hours. Milestone x has not been reached y hours before a given date type. Useful in raising the alerts for the business processing delays and exceptions. ORDER MONITOR does not work for Monitors on Pipelines. It is for status monitoring. 3 Enhanced Order Monitor - (IBM SSFS)
Time-triggered transaction Sterling Selling and Fulfillment Foundation provides a collection of time-triggered transactions, which are utilities that perform a variety of individual functions, automatically and at specific time intervals. Sterling Selling and Fulfillment Foundation provides the following types of time-triggered transactions: - Business Process Transactions - Purge Transactions - Task Queue Syncher Transactions - Monitors Transactions All time-triggered transactions are threadable. 4 Enhanced Order Monitor - (IBM SSFS)
Monitors Monitors are transactions that watch for processes or circumstances that are out of bounds and then raise alerts. CollectPendingJobs criteria parameter. - All Monitors have this criteria parameter - This pending job information is used for monitoring the monitor in the System Management Console. - By default, CollectPendingJobs is set to Y. - If set to N, the agent does not collect information on the pending jobs for that monitor. - It can be helpful to set it to N if one monitor is performing a significant amount of getpendingjobs queries and the overhead cost is too high. 5 Enhanced Order Monitor - (IBM SSFS)
Enhanced Order Monitor Monitoring rules Monitoring rules defines the rules which are used by the EOM transactions to monitor the order or shipment for certain condition and then to raise a definite type ofalerts. SSFS provides 33 types of Rule Types: 6 Enhanced Order Monitor - (IBM SSFS)
7 Enhanced Order Monitor - (IBM SSFS)
The order monitor can be configured to monitor the following system date types: Actual Order Date - ORDER_DATE column of the YFS_ORDER_HEADER table. Actual Next Iteration Date - NEXT_ITER_DATE column of the YFS_ORDER_HEADER table. Requested Ship Date - If there is an order release, read from the REQ_SHIP_DATE column of the YFS_ORDER_RELEASE table. Otherwise, read from the REQ_SHIP_DATE of the YFS_ORDER_LINE table. Expected Ship Date EXPECTED_SHIPMENT_DATE column of the YFS_ORDER_LINE_SCHEDULE table. If it is null, uses the same logic as Requested Ship Date. Actual Ship Date - If the date is before 01/01/2500, read from he EXPECTED_SHIPMENT_DATE column of the YFS_ORDER_LINE_SCHEDULE table. If the date is on or after 01/01/2500, this date type is returned as null. Requested Delivery Date - If there is a release, read from the REQ_DELIVERY_DATE column of the YFS_ORDER_RELEASE table. Expected Delivery Date - EXPECTED_DELIVERY_DATE column of the YFS_ORDER_LINE_SCHEDULE table. If it is null, uses the same logic as Requested Delivery Date. Actual Delivery Date - If the date is before 01/01/2500, read from he EXPECTED_DELIVERY_DATE column of the YFS_ORDER_LINE_SCHEDULE table. If the date is on or after 01/01/2500, this date type is returned as null. NOTE : For Order Fulfillment, Planned Order Execution, Reverse Logistics, and Purchase Order Execution pipelines, the system defined dates such as Shipment and Delivery are stored without a time component. Therefore when you configure a rule using these dates, all time computations are carried out assuming they are always 12:00:00 AM. 8 Enhanced Order Monitor - (IBM SSFS)
Milestones You can configure applicable statuses in a process type to be milestones. A milestone is a type of date that Sterling Selling and Fulfillment Foundation automatically determines when an order moves from one status to another. A milestone represents a significant point in the processing lifecycle that can be used as a criterion for monitoring. Milestones can be defined at the order, order line, order release, and order release line levels. Milestones and Date types : - Application Manager -> DOM -> Sales Order -> Fulfillment -> Order Modification -> Order Monitoring - Conditions are used from the conditions available for the Order fulfillment process type. 9 Enhanced Order Monitor - (IBM SSFS)
10 Enhanced Order Monitor - (IBM SSFS)
Field Date Type Description Requested Description Enter the name of the milestone being created. Enter a brief description of the milestone. Select this field to indicate if the milestone represents a date requested by a Buyer, user, etc. Expected Actual Milestone Statuses Select this field to indicate if the milestone represents a date the system expects or has calculated something to occur. This field is not applicable for milestones You can add statuses to associate with the milestone Date Type Status The date type if any associated with the milestone. Select the status you want use to indicate the milestone has been reached. Level Quantity Type Order / Order Line / Order Release Select Initial to indicate that the milestone is met when any quantity at the above selected level moves into the status. Select Complete to indicate that the milestone is met when all quantity at the above selected level moves into the status. 11 Enhanced Order Monitor - (IBM SSFS)
Enhanced Order Monitor transaction 12 Enhanced Order Monitor - (IBM SSFS)
Attributes for this time-triggered transaction : Attribute Base Transaction ID Base Document Type Base Process Type Abstract Transaction APIs Called Criteria parameters for this monitor : Value ORDER_MONITOR_EX Order Order Fulfillment No None Parameter Action Number of Records To Buffer EnterpriseCode ColonyID Description If left blank, it defaults to Get, the only valid value. Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000. Optional. Enterprise for which the Order Monitor needs to be run. If not passed, then all enterprises are monitored. Required in a multi schema deployment where a table may exist in multiple schemas. Runs the agent for the colony. 13 Enhanced Order Monitor - (IBM SSFS)
Statistics Tracked : Statistic Name NumOrdersProcessed NumAlertsRaised Description Number of orders processed. 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 : The Enhance Order Monitor transaction raises the ON_AUTO_CANCEL event, but does not cancel the order. A service on this event should be configured to cancel the order. User Exits : YFSShouldOrderMonitorAlertBeRaisedUE : This user exit can be used to apply any external logic to determine if the alert should be raised. YFSGetMonitoringCalendarForOrderUE : This user exit can be used to apply any external logic to determine the calendar to be considered for computing working hours. 14 Enhanced Order Monitor - (IBM SSFS)
Colony ID and Enterprise Code For enterprise agents, you can set the ColonyId or EnterpriseCode attribute in the agent criteria. If the EnterpriseCode attribute is passed in the agent criteria, the agent runs for the specified enterprise. If only the ColonyId attribute is passed in the agent criteria, the agent runs for those enterprises that match the ColonyId. Consider the following scenarios in which either ColonyId and/or EnterpriseCode is passed when the Enhanced Order Monitor agent is run : Scenario 1: Only ColonyId is passed. It is a Store colony and no enterprise is assigned to this colony In this case, no enterprise is identified and no orders will be monitored. The agent is an enterprise agent and monitoring at the Seller level is not supported. It is an Enterprise colony In this case, enterprises that match the ColonyId are derived first, and for each enterprise, the orders present in multiple colonies are monitored. Scenario 2: If EnterpriseCode is passed In this case, the orders present in multiple colonies for this enterprise are monitored. This is irrespective of whether ColonyId is passed in the criteria or not. 15 Enhanced Order Monitor - (IBM SSFS)
Enhanced Order Monitor - Monitor Event Events are used in instances where the Enhanced Order Monitor may raise multiple alerts of the same type. For example If an order with multiple lines that are shipped together has a shipment delay and you have configured the Enhanced Order Monitor to raise alerts when shipments are delayed at the line level, an alert of the same type would be raised against each line in the order. You can create rules to aggregate all of these similar alerts and raise one "root cause". 16 Enhanced Order Monitor - (IBM SSFS)
Event Rule Creation Applications Manager -> DOM -> Document Specific (Document Type) -> Fulfillment -> Monitor Events. The Monitor Events window displays: 17 Enhanced Order Monitor - (IBM SSFS)
Field Event ID Description Requires Realert Description Enter a Event ID Enter a brief description of the event. Select this field if you want users to be re-alerted if the issue has not been resolved within a certain timeframe. Realert Interval Automatically Resolve Alerts If you selected Requires Realert, enter the interval (in hours) that re-alerts should be sent. This flag must be checked to trigger a monitor event every time an alert condition is detected on an order. To trigger an alert only once when the alert condition is met, uncheck this flag. Event Identified By Select this field if you want two or more alert conditions to be treated the same if they belong to the same order / orderline / orderrelease / shipnode / seller / Buyer. Service To Be Invoked Select the alert service to be invoked should the event consolidation rule conditions be met. Aggregate And Invoke Service For Select this field if you want only one alert to be raised for an order / orderline / order release / ship node when alert conditions are detected. 18 Enhanced Order Monitor - (IBM SSFS)
Working of Enhanced Order Monitor with respect to threads To understand how do threads work in conjunction with the monitoring rules, lets consider an example where we have 50 monitoring rules, for a YFS_ORDER_HEADER table having 1,00,000 records and the monitor being configured with 4 threads. In this case, when the monitor is triggered, a query will be fired to fetch all open records from the YFS_ORDER_HEADER table. Now the threads configured, will work on the resultant set of records and for each Order, all the monitoring rules will be checked. Hence in case of 4 threads, 4 orders will be picked up at a time and for each of these orders, all the 50 rules will be checked. 19 Enhanced Order Monitor - (IBM SSFS)
Basic Enhanced Order Monitor operation, with Milestones Configuration: Milestone (Has Been in status) is configured which will check if the order is in 1500 (Scheduled) status (0.167 hrs=10 mins) and raise an alert. for x hrs Here are the steps followed for controlled testing: 1. Create an order 2. Schedule the order. Hence moving it to 1500 status NEXT_ALERT_TS= 12:06:30 PM (current system date) 3. Trigger the monitor agent. NEXT_ALERT_TS = 12:16:31 PM (current sys date + 10 min) 4. Change any attribute in the order NEXT_ALERT_TS = 12:16:33 PM (current system date) 5. Trigger the monitor agent. NEXT_ALERT_TS = 12:26:34 PM (current sys date + 10 min) The NEXT_ALERT_TS stamp is seen from the YFS_ORDER_HEADER table. Hence, any change in the order will cause the NEXT_ALERT_TS to be stamped as current date. When the Enhanced Order Monitor is run, it will check the status of the order, if it does match, depending on the elapsed hour setting, it will update the NEXT_ALERT_TS. Enhanced order monitor does not pick up closed orders for monitoring. 20 Enhanced Order Monitor - (IBM SSFS)
Close Order Transaction The Close Order agent must be run before running the Monitor agent in order to avoid alerts getting raised for cancelled orders. This time-triggered transaction sets the order's ORDER_CLOSED flag to Y' and raises the ON_SUCCESS event. These actions are only performed when the entire ORDER_QTY for all the order lines reaches the configured pickup status. If an order has ORDER_CLOSED set to Y', it is not picked up for monitoring. The Close Order agent must be configured along with the Purge transaction in the pipeline. 21 Enhanced Order Monitor - (IBM SSFS)
Demo Queue and Connection Factory Setup Setting up communication between an agent (time-triggered transaction) and a JMS server requires that you do some prerequisite setup such as creating Queue and Connection Factory on application server. 22 Enhanced Order Monitor - (IBM SSFS)
Transaction Agent Setup For the JMS server to communicate with the application, there must be a time-triggered transaction configured with the JMS server and ICF information. o Open the Applications Manager. From the tree in the application rules side panel, doubleclick Process Modeling. The Process Modeling window displays in the work area. o Select the desired tab, then Base Document Type, then double-click Process Type. o Double-click the transaction that corresponds to the agent to be run. o Select the Time Triggered tab. 23 Enhanced Order Monitor - (IBM SSFS)
Pipeline's monitoring rules setup Using the monitoring rule components you configured while defining the process type, you can define the parameters used to monitor orders and shipments throughout their life cycle in fulfillment and shipment process type pipelines. Open the Applications Manager and select the application that you want. In the Process Modeling window, select the Order, Load, or General tab to view the corresponding process modeling tree for that base document type. In the Process Types swimlane, right-click on the applicable process type and choose Model Process. The Repository Details window and work area display for the corresponding process type. Choose the Pipeline tab. Expand the Pipelines branch. Select the applicable pipeline and choose the Configure Monitoring Rules icon. The Monitor Rules window displays in the work area. E.g Milestone has not reached before a date If Order/Shipment has not reached a milestone n calendar hours before a date type, then raise a monitor event. Note : Hold-based monitoring rules can monitor holds that belong to the organization owning the pipeline. 24 Enhanced Order Monitor - (IBM SSFS)
Monitor Event Setup Applications Manager -> DOM -> Document Specific (Document Type) > Fulfillment > Monitor Events. The Monitor Events window displays. 25 Enhanced Order Monitor - (IBM SSFS)
Monitor Event s Service setup Applications Manager -> Application platform -> Process Modeling -> Process Type -> Service Create a synchronous service which can send the input from agent to DB YFS_EXPORT table. 26 Enhanced Order Monitor - (IBM SSFS)
Common Issues and Resolutions In this section, We will discuss the common issues which customers came across in the past in relation to Enhanced order monitor and the resolutions provided to them. 27 Enhanced Order Monitor - (IBM SSFS)
28 Enhanced Order Monitor - (IBM SSFS)
Sterling Selling and Fulfillment Suite is now on twitter! https://twitter.com/ibm_ssfssupport Follow us @IBM_SSFSsupport to stay notified of the latest. 29 Enhanced Order Monitor - (IBM SSFS)
30 Enhanced Order Monitor - (IBM SSFS)