Invoke Pop-Up Notifications for Events in Oracle Fusion Applications

Invoke Pop-Up Notifications for Events in Oracle Fusion Applications

Use this recipe to invoke notifications for user-defined events in Oracle Fusion Applications. This recipe works with all Oracle Fusion Applications, such as SCM, ERP, HCM, and CX.

Note: This recipe is available as REST — Oracle Fusion Applications | Invoke Pop-Up Notifications in the Integration Store. Oracle provides this recipe as a sample only. The recipe is meant only for guidance, and is not warranted to be error-free. No support is provided for this recipe.

Overview

This recipe enables you to invoke notifications in your Oracle Fusion Application for user-defined events. You can send notifications to specific Fusion Application users after certain events, such as creation of Fusion records (like sales orders) using APIs, either through Oracle Integration or external applications.

This is an application-driven recipe that creates a new notification in an Oracle Fusion Application when it receives a REST request with the notification data from an external application or from another integration flow in Oracle Integration.

To use the recipe, you must install the recipe package and configure the connections and other resources within the package. Subsequently, you can activate the integration flow of the package and send a REST request with the notification data to the integration’s endpoint URL from an external application or from another integration flow in Oracle Integration. When triggered, the recipe’s integration flow creates a notification in your Oracle Fusion Application using the data received and returns a success or failure response.

The notification shows up on the Fusion Application’s home page for the specified user. You can customize the notification’s message as required by any scenario.

System and Access Requirements

Before You Install the Recipe

To access an Oracle Fusion Application from Oracle Integration and invoke notifications for events, you’ll require a separate user account on the Oracle Fusion Application.

Log in to the Oracle ERP Cloud instance as an Administrator and perform the following tasks.

  1. Create a user account for Oracle Integration. Make a note of the user name and password you set for the account. You’ll use the credentials of this user account to connect to Oracle ERP Cloud from Oracle Integration.

  2. Assign the following roles to the user account. See Assign Required Roles to an Integration User.

  3. Additionally, assign the Human Capital Management Integration Specialist role to the account to provide access to the User Accounts APIs. See the support document: 2610503.1.

Install and Configure the Recipe

On your Oracle Integration instance, install the recipe package to deploy and configure the integration and associated resources.

  1. On the Oracle Integration Home page, in the Pick a Recipe/Accelerator section, click View All.

  2. Find the recipe you want to install.

  3. Hover over the recipe, then click Install Install icon.
    A message confirms that the recipe was successfully installed, and the recipe card shows INSTALLED.

  4. Hover over the recipe again, and click Configure Configure icon to configure the resources of the recipe.

    The Configuration Editor opens, displaying all the resources of the recipe. Configure the following resources before you activate and run the recipe.

Configure the Oracle REST OIC API Connection

  1. In the Configuration Editor, under Connections, hover over Oracle REST OIC API Connection, then click Edit Edit icon.
    The connection configuration page appears.

  2. In the Properties section, enter the following details.

    Field Information to Enter
    Connection Type Leave REST API Base URL selected.
    Connection URL Enter the host name of the Oracle Integration instance in which you’ve installed the recipe.

  3. In the Security section, enter the following details.

    Field Information to Enter
    Security Policy Select Basic Authentication.
    Username Enter the user name of the Oracle Integration user account with the Service Invoker role. See System and Access Requirements.
    Password Enter the password of the Oracle Integration user account with the Service Invoker role.

  4. Click Save. If prompted, click Save for a second time.

  5. Click Test to ensure that your connection is successfully configured.
    A confirmation message is displayed if your test is successful.

  6. Click Go back Back icon to return to the Configuration Editor. Click Save again if prompted.

Configure the Oracle ERP Cloud Notification Connection

  1. In the Configuration Editor, under Connections, hover over Oracle ERP Cloud Notification Connection, then click Edit Edit icon.
    The connection configuration page appears.

  2. In the Properties section, enter the Oracle ERP Cloud host name. For example: https://your_domain_name.fa.DC.oraclecloud.com.

  3. In the Security section, enter the following details.

    Field Information to Enter
    Security Policy Select Username Password Token.
    User Name Enter the user name of the account created for Oracle Integration on Oracle ERP Cloud. See Before You Install the Recipe.
    Password Enter the password of the account created for Oracle Integration on Oracle ERP Cloud.

  4. Click Save. If prompted, click Save for a second time.

  5. Click Test to ensure that your connection is successfully configured.
    A confirmation message is displayed if your test is successful.

  6. Click Go back Back icon to return to the Configuration Editor. Click Save again if prompted.

Activate and Run the Recipe

After you’ve configured the connections, activate the recipe package and run it.

  1. On the Configuration Editor, click Activate in the title bar. In the Activate Package dialog, click Activate again.
    A confirmation message is displayed informing that the integration has been submitted for activation. Refresh the page to view the updated status of the integration.

  2. Run the recipe from an external application.

    1. In the Configuration Editor, click Activation to view the integrations in the recipe.

    2. Hover over the integration flow, then click Actions Actions icon and select Run.

    3. On the Configure and run page, click Endpoint Metadata.

    4. In the panel that opens, copy the Endpoint URL value. This is the integration flow’s endpoint URL.

    5. From the external application, send a POST request to this endpoint URL along with the notification data. Provide the notification data in the POST request’s Body field. See the subsequent step for an example request payload.
      The recipe invokes a notification in your Oracle Fusion Application for the user account specified in the notification data.

  3. Test the recipe in Oracle Integration.

    1. In the Configuration Editor, click Activation to view the integrations in the recipe.

    2. Hover over the integration flow, then click Actions Actions icon and select Run.

    3. On the Configure and run page, in the Request section, click Body and enter the notification data. The data must contain the following elements:

      • UserName: Enter an existing user in your Oracle Fusion Application for whom the notification is intended. This field is case-sensitive.
      • Message: Enter a message to show in the notification.
      • TaskCreator: Enter the name of the notifier.

      Here’s an example data set:

      {
        "UserName": "Robert.James",
        "Message": "Testing the Notification Recipe",
        "TaskCreator": "Admin User"

    }

    4. Click Run.
      The recipe invokes a notification in your Oracle Fusion Application for the user account specified in the notification data. The Activity Stream pane appears displaying the status of the integration instance’s execution.

    5. In the Response section of the Configure and run page, under the Body tab, you’ll find a success response, 200 OK.

  4. Log in to your Oracle Fusion Application instance with the user account specified in the Request payload previously, and check for the new notification.

    1. On the home page, the Bell icon in the top right corner displays a new notification.
      Click the icon to view the notification’s content. The notification also contains the name of the notifier, specified in the Request payload.

    2. You can also view the same notification under the Things to Finish section on the home page.

Related Documentation