11Business Events

This chapter contains the following:

Overview of Public Business Events

A public event, also known as business event, is a definable logical occurrence in a business scenario. It can be a high-level occurrence such as payables invoice creation or a specialized event such as status change.

If you want to perform operations in other systems based on public events in Oracle Financials Cloud, then you can use public event features. You must enable the business event if it isn't enabled by default.

After you enable these features, the application sends a signal, along with a payload containing information about the public event, whenever an event occurs. The public event signal is also known as a public event.

The application sends signals irrespective of the source or cause of the event. For example, the application sends a payables invoice creation signal when an invoice is created using a user interface or REST API.

Integration developers and administrators can subscribe to public events from the Oracle Integration Cloud using the Oracle ERP Cloud Adapter. Then, they can use the information in the payload to configure event handlers that perform business operations. For more information, refer to Oracle ERP Cloud Adapter Capabilities and Developing Integrations with Oracle Integration Cloud Service.

Business Events for Payables

For Oracle Payables Cloud business events, Payables sends an event occurrence signal when the event has happened using a user interface or by a REST API.

Note: A signal isn't raised when the event occurs using a scheduled process, such as the Import Payables Invoices process, or by using a SOAP web service, such as the Payables Invoice Management web service.

This table describes the business events supported by Payables.

Supported Business Event Description Enable By Using First Release Available Event Initiation

Payables Invoice Approved

Signals when an invoice is approved.

AP: Enable Business Events profile option at the site level

18C

  • Force Approve button on Payables Dashboard

  • Force Approve button on Invoices landing page

  • Force Approve button on Manage Invoices page

  • Force Approve action on Create and Edit Invoice pages

Payables Invoice Cancelled

Signals when an invoice is canceled.

AP: Enable Business Events profile option at the site level

18C

  • Cancel invoice option using the Void Payment button on Payables Dashboard

  • Cancel button on Invoices landing page

  • Cancel Invoice action on Create and Edit Invoice pages

  • Cancel Invoice action on Manage Invoices page

  • Cancel Invoice action on Invoice Details page

  • Cancel invoice option using the Void Payment button on Manage Payment page

  • Cancel an invoice using Invoices REST API

Payables Invoice Created

Signals when an invoice is created.

AP: Enable Business Events profile option at the site level

18C

  • Create Invoice page

  • Create Invoice button on Invoices landing page

  • Create Invoice page from Supplier Portal

  • Create Invoice Without PO page from Supplier Portal

  • Issue Refund action in Edit Receipt page in Oracle Receivables Cloud

  • Create an invoice using Invoices REST API

Invoice Hold Applied

Signals when an invoice hold is placed.

AP: Enable Business Events profile option at the site level

18B

  • Manage Holds page from the Create and Edit Invoice pages

  • Holds on Invoice Details page

  • Validate button on Invoice landing page

  • Validate action on Create and Edit Invoice pages

  • Validate button on Manage Invoices page

  • Place hold on invoice option using the Void Payment button on Payables Dashboard

  • Place hold on invoice option using the Void action on Manage Payments page

  • Validate an invoice using Invoices REST API

  • Create an invoice hold using Invoice Holds REST API

Invoice Hold Released

Signals when an invoice hold is released.

AP: Enable Business Events profile option at the site level

18B

  • Release button on Payables Dashboard

  • Release button on Invoices landing page

  • Release Holds action on Manage Invoices page

  • Release button on Invoice Details page

  • Manage Holds invoice action on Create and Edit Invoice pages

  • Invoice hold is released using Hold resolution workflow

  • Validate action on Create and Edit Invoice pages

  • Validate an invoice using Invoices REST API

  • Release an invoice hold using Invoice Holds REST API

Payables Invoice Validated

Signals when an invoice is validated online.

AP: Enable Business Events profile option at the site level

18C

  • Validate button on Invoices landing page

  • Validate action on Create and Edit Invoice pages

  • Validate button or action on Manage Invoices page

  • Validate action on Invoice Details page

  • Holds resolution workflow when an invoice hold is released and the invoice status is updated to Validated

  • Release button on Payables Dashboard

  • Release button on Invoices landing page

  • Release Holds on Manage Invoices page

  • Release button on Invoice Details page

  • Manage Holds on Create and Edit Invoice pages

  • Validate an invoice using Invoices REST API

Payables Payment Created

Signals when a single payment is created.

AP: Enable Business Events profile option at the site level

18C

  • Pay button on Invoices landing page

  • Pay in Full action on Create and Edit Invoice pages

  • Pay in Full action on Manage Invoices page

  • Pay in Full button on Manage Invoices page

  • Pay in Full action on Invoice Details page

  • Create Payment page

  • Create payment icon on Manage Payments page

  • Create a payment using Payables Payments REST API

Payables Payment Voided

Signals when a payment is voided.

AP: Enable Business Events profile option at the site level

19A

  • Void Payment button on Payables Dashboard

  • Void Payment button on Payments landing page

  • Void action on Manage Payments page

  • Reissue actions on Manage Payments page

  • Void Payment action on Payment page

  • Reissue action on Payment page

  • Void a payment using Payables Payments REST API

Enable the Payables Business Events Profile Option

If you want Oracle Payables Cloud to signal when a defined business event occurs, then enable the AP: Enable Business Events profile option.

You must have one of these roles to enable business events for Payables:

  • Application Implementation Consultant

  • Financial Administrator

Enable the Profile Option Value

To enable the profile option value, complete these steps:

  1. In the Setup and Maintenance work area, go to the Manage Administrator Profile Values task.

  2. On the Manage Administrator Profile Values page in the Search: Profile Option section, enter AP: Enable Business Events in the Profile Display Name field.

  3. Click Search.

  4. In the Search Results: Profile Options section, select the profile option.

  5. In the Profile Values section, select Yes in the Profile Value field for the site level.

  6. Click Save and Close.

Business Events for Payments

For Oracle Payments Cloud business events, Payments sends an event occurrence signal when the event has happened. This table describes the business event supported by Payments.

Supported Business Event Description Enable By Using First Release Available Event Initiation

Payment File Created

Signals when a payment file is created.

IBY: Enable Business Events profile option at the site level

18C

Upon completion of payment file

Enable the Payments Business Events Profile Option

If you want Oracle Payments Cloud to signal when a defined business event occurs, then enable the IBY: Enable Business Events profile option.

You must have one of these roles to enable business events for Payments:

  • Application Implementation Consultant

  • Financial Administrator

Enable the Profile Option Value

To enable the profile option value, complete these steps:

  1. In the Setup and Maintenance work area, go to the Manage Administrator Profile Values task.

  2. On the Manage Administrator Profile Values page in the Search: Profile Option section, enter IBY: Enable Business Events in the Profile Display Name field.

  3. Click Search.

  4. In the Search Results: Profile Options section, select the profile option.

  5. In the Profile Values section, select Yes in the Profile Value field for the site level.

  6. Click Save and Close.