Overview of Sending Notifications from Order Management to Other Systems

Use a business event to send a notification to a system that resides outside of Oracle Order Management when a change happens, such as when details in a sales order or fulfillment line change.

You can send the notification to an upstream system, such as an order capture system, or to a downstream system, such as a fulfillment system or billing system.

A business event is something that happens that's significant enough that requires Order Management to take an action. Here are some examples.

  • A change to an order attribute happens.

  • Order Management applies a hold.

  • A jeopardy priority changes.

  • A fulfillment line splits.

  • The status on an order header changes.

  • A fulfillment line closes.

  • A fulfillment line achieves a status.

  • Compensation for an orchestration process finishes successfully or not successfully.

Here's how it works.

how you can use a business event to communicate

Note

  1. Order Management monitors conditions that happen during order fulfillment according to the trigger points that you specify.

    For example, if you enable the Notify External System option for the Shipped status value on a status rule set, then Order Management communicates the business event each time it sets a fulfillment line status to Shipped, and it sends the business event to the endpoint URL of the connector that you set up for the Fulfillment Line Status Update business event. For details, see Add Status Conditions to Fulfillment Lines.

  2. You use the Manage Business Event Trigger Points page in the Setup and Maintenance work area to specify the trigger point. If Order Management determines a trigger point happened, then it uses the Connector Name attribute on the Manage Business Event Trigger Points page to identify the connector it will use to communicate with the system.

  3. The connector communicates with the system. You use the connector to specify the URL that locates the system and the security credentials that your system needs to communicate data. For example, the fulfillment line status is Shipped, so you notify your invoicing system that the order is ready to invoice.

  4. As an option, you can use the Notify Frequency parameter to specify how frequently Order Management sends notifications. For details, see Manage Order Management Parameters.

You can also use a web service to communicate details about the event.

Use the set up described in this topic only to integrate with an application that resides outside of Oracle.

Manage Business Event Trigger Points

A business event trigger point is the condition that causes a business event to happen.

  • You must associate a connector with the business event that you specify. For details, see Send Notifications from Order Management to Other Systems.

  • The business events that this page displays aren't active, by default, except for business events that monitor closing a fulfillment line.

  • A modification that you make on this page takes effect immediately.

  • The settings that you make affect only one instance of Order Management.

  • You can't add or delete the business events that this page displays.

  • Set up only the business event trigger points that you need. Each trigger point might affect performance.

Use Predefined Trigger Points

Predefined Business Event

Description

Change Order Compensation Complete

Send a notification when Order Management finishes processing a change order. If the change order results in an error, then this business event reports the error.

Fulfillment Line Status Update

Send a notification when Order Management changes a fulfillment line's status value.

You can specify the status values that the trigger notification.

  1. Navigate to the Manage Orchestration Process Definitions page.

  2. On the Edit Status Rule Set page, add a check mark to the Notify External System option next to each status value that you want to trigger.

Fulfillment Line Closed

Send a notification when Order Management closes a fulfillment line. Some applications, such as Cost Management, can use these details to do downstream processing on the fulfillment line.

Hold

Send a notification when a user applies a hold, or when the order capture system or fulfillment system applies a hold on an entity.

  • Order

  • Order line

  • Fulfillment line

Note

  • If a hold doesn't go into effect immediately, for example, if the hold applies to a future task, then Order Management communicates the business event when the hold goes into effect, not when the request to add the hold happens.

  • If change management releases or applies a hold, then Order Management doesn't communicate the business event.

Jeopardy

Send a notification when Order Management changes a jeopardy priority value, such as High, Medium, or Low. You can specify the value to notify.

Order Attribute Update

Send a notification when Order Management changes a fulfillment line attribute during order fulfillment. You can choose each attribute from the set of attributes that the task references.

  • Each attribute that the Order Update Attributes That Trigger Events section displays can trigger a business event. These attributes are predefined. You can also set up an extensible flexfield that modifies these attributes.

    If you set up an extensible flexfield, then Order Management displays it in the Select and Add Attributes That Trigger Events dialog. If you select one or more segments, and then click OK or Apply, then Order Management displays the segments that you select in the Order Attribute Update Attributes That Trigger Events section.

  • If Order Management updates more than one attribute of the Order Attribute Update business event at the same time, then it sends only one notification. This notification includes details about the attributes that it updated.

  • The status values in the Order Header Status Update, Status Values That Trigger Events section start the Order Header Status Update business event. These values are predefined. You can't add status values in this section.

Order Header Status Update

Send a notification when Order Management cancels, partially closes, or closes a sales order. You can specify the status value to notify.

Split

Send a notification when a partial shipment happens or when an integrated system splits a fulfillment line.

What Happens If I Need More Than One Event?

Assume you need to send an event when you modify an attribute's value and when you split a line. So you set up the Order Attribute Update business event to update the Scheduled Ship Date attribute, and you set up the Split business event to send a notification when you split a fulfillment line. However, you notice that you receive the split event but you don’t receive the event to update the attribute. This happens because Order Management only sends one business event at a time. It will send only the split event.