Next-generation platform

Configuring options for alert rules

Users can create alert rules in Order Hub to be alerted when the fulfillment process is running behind schedule and presents a risk to the timely fulfillment of an order.

Procedure

You can customize the default business process that is preselected when a user creates an alert. You might want to set the default business process to the most often used process pipeline that handles Sales Orders for an organization. By setting a default business process, you make the job easier for the users that are creating the alerts since they might not know which business process to choose.

  1. Set the defaultPipelineKey property to the pipeline that you want to use as the default.
    You can set the property multiple ways.
    • In the customer_overrides.properties file.
      1. Open <INSTALL_DIR>/runtime/properties/customer_overrides.properties
      2. Set the following properties, where yfs.sba.agent.alerts.order defines the default for Order-type alerts, and yfs.sba.agent.alerts.shipment defines the default for Shipment-type alerts.
        yfs.sba.agent.alerts.order.<EnterpriseCode>.defaultPipelineKey=<PipelineKey>
        yfs.sba.agent.alerts.shipment.<EnterpriseCode>.defaultPipelineKey=<PipelineKey>
        
        For example,
        
        yfs.sba.agent.alerts.order.Aurora.defaultPipelineKey=SALES-SERVICE-9.5  
        yfs.sba.agent.alerts.shipment.Aurora.defaultPipelineKey=SALES-SHIPMENT-9.5  
        yfs.sba.agent.alerts.order.Aurora-Corp.defaultPipelineKey=SALES-SERVICE-9.5  
        yfs.sba.agent.alerts.shipment.Aurora-Corp.defaultPipelineKey=SALES-SHIPMENT-9.5  
    • Using the System Administration console. For more information, see Managing properties in the database using the System Management Administrator.

To add options to the If order status has not reached drop-down menu:

  1. Log in to Applications Manager and select Applications > Distributed Order Management.
    For more information about Applications Manager, see Starting the Applications Manager.
  2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Fulfillment.
  3. Right-click Order Monitoring and select Details.
  4. Click the Milestones tab.
  5. Create a milestone and complete both the Primary Info tab and then Milestone statuses tab. For more information about the fields, see Order fulfillment: creating a milestone.
    The Milestone Status is the value that is displayed in the drop-down menu.
    Note: Creating an order milestone populates rows in the YFS_ORDER_DATE table.

To add options to the Date drop-down menu (for order alerts):

  1. Log in to Applications Manager and select Applications > Distributed Order Management.
  2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Fulfillment.
  3. Right-click Order Monitoring and select Details.
  4. Click the Date Types tab.
  5. Create a date type. For more information, see Order fulfillment: creating a date type.
    The date type Description is the value that is displayed in the Date drop-down menu.

To add options to the Delivery type drop-down menu (for order alerts):

  1. Log in to Applications Manager and select Applications > Application Platform.
  2. In Application Platform (DEFAULT), right-click Process Modeling and select Details.
  3. In the Process Types swimlane, right-click Order Fulfillment and select Model Process.
  4. Click the Conditions tab from the Order Fulfillment left panel.
  5. Expand Conditions.
  6. Right-click Order Hub (<yourOrg>) for the applicable organization and select Create.
  7. Complete the details to create a condition. For more information, see Creating a condition.
    • The Condition name is the value that is displayed in the drop-down menu.
    • Ensure that the Condition value includes the statement Enterprise Code Is '<EnterpriseCode>' to keep rules associated with a specific organization. For example,
      Enterprise Code Is 'Sales1'

To add options to the Assign to queue drop-down menu (for order alerts):

Note: By default, Order Hub creates an order queue and a shipment queue for an enterprise, and all order or shipment alerts for the enterprise as assigned to the respective queue. You can assign alerts to different queues for different purposes. For example, you might want to create a separate queue for an individual buying organization MyFavoriteCustomer.

  1. Create a condition as explained in step 12 but include a condition value to satisfy your queue requirements.
    For the example for buying organization MyFavoriteCustomer, include the following statement.
    Enterprise Code Is 'Sales1' AND Buyer Organization is 'MyFavoriteCustomer'
  2. Create a queue.
    1. In Application Platform, right-click Queue Management and select Details.
    2. Create a queue and set the Queue Id and Destination Name.
      The Destination name is the value that is displayed in the drop-down menu.
  3. Create a Service Definition that sends the alert to the queue.
    1. In Application Platform, right-click Process modeling and select Details.
    2. In the Process Types swimlane, right-click Order Fulfillment and select Model Process.
    3. Click the Service Definitions tab from the Order Fulfillment left panel.
    4. Right-click Order Fulfillment Services > Order Hub and select Create.
    5. Enter information in the applicable Create new service dialog box. Ensure that you select In a Synchronous Mode. For more information about all the fields, see Creating a service.
    6. In the Service Detail window, select Components and add an Alert between Start and End.
    7. On the Alert properties, set Alert Queue Name to the queue (Destination Name) that you created in step 20.
    8. Set the Exception Type to ORDER_HUB_ORDER_DELAY.
  4. Create a Monitor event.
    1. In Applications Manager, select Applications > Distributed Order Management.
    2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Fulfillment.
    3. Right-click Monitor Events and select Details.
    4. Create a monitor event. For more information, see Order fulfillment: creating an event rule.
      • For Order-type alerts, set the Event Id value to begin with the text that follows the format OHO<EnterpriseCode>CUSTOM. For example, OHOMyFavoriteCustomerCUSTOMeventA.
      • Set the Description to be the same as the Queue Destination Name.
      • Enable Automatically Resolve Alerts.
      • Set the Service To Be Invoked to the service that you created in step 21.
      • Enable Event Identified By "Order line".
      • Enable Aggregate And Invoke Service For "Order".

To add options to the If shipment status has not reached drop-down menu:

  1. Log in to Applications Manager and select Applications > Distributed Order Management.
  2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Outbound Logistics.
  3. Right-click Shipment Monitoring and select Details.
  4. Click the Milestones tab.
  5. Create a milestone and complete both the Primary Info tab and then Milestone statuses tab. For more information about the fields, see Shipments: creating a milestone.
    The Milestone Status is the value that is displayed in the drop-down menu.
    Note: Creating a shipment milestone populates rows in the YFS_ADDITIONAL_DATE table for all shipments.

To add options to the Date drop-down menu (for shipment alerts):

  1. Log to Applications Manager and select Applications > Distributed Order Management.
  2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Outbound Logistics.
  3. Right-click Shipment Monitoring and select Details.
  4. Click the Date Types tab.
  5. Create a date type. For more information, see Shipments: creating a date type.
    The date type Description is the value that is displayed in the Date drop-down menu.

To add options to the Delivery type drop-down menu (for shipment alerts):

  1. Log in to Applications Manager and select Applications > Application Platform.
  2. In Application Platform (DEFAULT), right-click Process Modeling and select Details.
  3. In the Process Types swimlane, right-click Outbound Shipment and select Model Process.
  4. Click the Conditions tab from the Outbound Shipment left panel.
  5. Expand Conditions.
  6. Right-click Order Hub (<yourOrg>) for the applicable organization and select Create.
  7. Complete the details to create a condition. For more information, see Creating a condition.
    • The Condition name is the value that is displayed in the drop-down menu.
    • Ensure that the Condition value includes the statement Enterprise Code Is '<EnterpriseCode>' to keep rules associated with a specific organization. For example,
      Enterprise Code Is 'Sales1'

To add options to the Assign to queue drop-down menu (for shipment alerts):

Note: By default, Order Hub creates an order queue and a shipment queue for an enterprise, and all order or shipment alerts for the enterprise as assigned to the respective queue. You can assign alerts to different queues for different purposes. For example, you might want to create a separate queue for an individual buying organization MyFavoriteCustomer.

  1. Create a condition as explained in step 33 but include a condition value to satisfy your queue requirements.
    For the example for buying organization MyFavoriteCustomer, include the following statement.
    Enterprise Code Is 'Sales1' AND Buyer Organization is 'MyFavoriteCustomer'
  2. Create a queue.
    1. In Application Platform, right-click Queue Management and select Details.
    2. Create a queue and set the Queue Id and Destination Name.
      The Destination name is the value that is displayed in the drop-down menu.
  3. Create a Service Definition that sends the alert to the queue.
    1. In Application Platform, right-click Process modeling and select Details.
    2. In the Process Types swimlane, right-click Outbound Shipment and select Model Process.
    3. Click the Service Definitions tab from the Outbound Shipment left panel.
    4. Right-click Outbound Shipment Services > Order Hub and select Create.
    5. Enter information in the applicable Create new service dialog box. Ensure that you select In a Synchronous Mode. For more information about all the fields, see Creating a service.
    6. In the Service Detail window, select Components and add an Alert between Start and End.
    7. On the Alert properties, set Alert Queue Name to the Queue Destination Name that you created in step 41.b.
    8. Set the Exception Type to ORDER_HUB_SHIPMENT_DELAY.
  4. Create a Monitor event.
    1. In Applications Manager, select Applications > Distributed Order Management.
    2. In DOM (DEFAULT), expand Distributed Order Management > Document Specific > Sales Order > Outbound Logistics.
    3. Right-click Monitor Events and select Details.
    4. Create a monitor event. For more information, see Shipments: creating an event rule.
      • For Shipment type alerts, set the Event Id value to begin with the text that follows the format OHS<EnterpriseCode>CUSTOM. For example, OHSMyFavoriteCustomerCUSTOMeventA.
      • Set the Description to be the same as the Queue Destination Name.
      • Enable Automatically Resolve Alerts.
      • Set the Service To Be Invoked to the service that you created in step 42.
      • Enable Event Identified By "Shipment".
      • Enable Aggregate And Invoke Service For "Shipment".