Creating Custom Event Monitoring Integrations

In Task Manager, you can create an Event Monitoring integration for an external application. The Event Monitoring integration is triggered when an external event occurs in another Cloud service or on-premises application. An example of an Event Monitoring integration is a trigger from Oracle E-Business Suite - General Ledger when a period, for example, January 2018, is closed.

Make sure you have the prerequisites and follow these steps to set up an integration between Task Manager and an external application.

For an overview of the custom integrations flow, see Creating Custom Integrations.

Prerequisites

Note:

Event monitoring can also be triggered through any integration tool capable of invoking REST APIs. In that case you do not need the below prerequisites.

To integrate Task Manager with an external application, you need:

• A subscription to Oracle Integration Cloud Service, to integrate with on-premises and non-EPM Cloud services.

  Note:

  You need one Integration Cloud instance per Oracle EPM cloud instance.
• The external application set up.

1. Subscribe to Oracle Integration Cloud / Oracle Autonomous Integration Cloud. See Integration Cloud Service Documentation for detailed information.
2. Install Integration Cloud Agent in your application environment to communicate with your Oracle EPM cloud instance. For details on setting up Integration Cloud Agent, see Managing Agent Groups.

   Note:

   If the on-premises application services are deployed in an environment set up in a demilitarized zone (DMZ) configuration so that these services are publicly accessible through the Internet, you do not need to install Integration Cloud Agent.

Setting Up the Integration in Task Manager

1. On the Home page, click Application, and then click Task Manager.
2. Click the Integrations tab on the left, and then click New.
3. On the Properties tab, specify the required information:

4. 1. For Name, enter a name for the Integration.

   2. For Code, enter an Integration Code for the integration task.

      The code is used to execute the Integration and to map updates to an Integration from a file import.

   3. Optional: In Description, enter a description for the integration task.

   4. For Connection, select an application to which the task belongs.

      You can maintain the list of applications from the Manage Connections icon in the Manage Connections dialog box.

   5. For Execution Type, select Event Monitoring.

   6. For Event Name, enter a name for the event.

5. On the Parameters tab, click New and specify the required information:

   1. For Name, enter a name for the parameter.

   2. For Parameter Code, enter a parameter code.

   3. Optional: Enter a parameter tooltip.

   4. From the Parameter Type list, select a type, and enter additional information for the parameter:

      • Checkbox: Boolean value

      • Date: Date value

      • Integer: Numeric value in whole numbers

      • Number: Numeric value in whole numbers or fractions

      • Options Group: Check box for a predefined set of values

      • Static List: Predefined set of text values

      • Task Information: Task information, for example, Assignee, duration, start and end dates

      • Text: Free-form text value

      • EPM Artifact: Name of the artifact, such as the form or report

   5. If the parameter requires a value, select Required.

   6. Click OK to save the parameter.

   7. Click Save and Close to save the Integration.

Creating a Task Type for the Integration

1. On the Home page, click Application, and then click Task Manager.

2. Click the Task Types tab on the left.

3. Click New.

4. On the Properties tab, specify a Task Type Name and Task Type ID.

5. For Integration, click Search, select the Integration, and then click OK.

6. On the Parameters tab, set the Task Type parameters.

Setting Up the Integration Cloud Connection in Task Manager

Task Manager uses Oracle Integration Cloud for all the integrations to external applications. You can setup a connection to Oracle Integration Cloud in Task Manager using Basic or OAuth 2.0 authentication.

Note:

• For Oracle Integration Cloud Generation 2, both Basic Auth and OAuth 2.0 is supported.
• For Oracle Integration Cloud Generation 3, only OAuth 2.0 is supported.
• Basic Auth user must have the Service Administrator role for Oracle Integration Cloud.
• For OAuth 2.0, only client credentials are supported. OAuth 2.0 client application should have the Service Administrator role for Integration Cloud and allowed scope should be all.

Before setting up the OAuth 2.0 connection, make sure you’ve the client credentials such as access token URL, client ID, client secret, and scope. For setting up the OAuth client application, see OAuth Authentication in Oracle Integration in Oracle Integration Cloud Generation 3 documentation.

To setup the Integration Cloud connection in Task Manager:

1. On the Home page, click Application, and then click Task Manager.

2. Click the Integrations tab on the left.

3. Click Manage Connections, and then from Actions, select Integration Cloud Connection.
4. Select one of the following authentication mechanisms:
   • Basic Auth: Specify the Integration Cloud URL, service administrator user ID, and password.
   • OAuth 2.0: Provide the Integration Cloud URL, access token URL, client ID, client secret, and scope.

   Note:

   Enter the URL: https://<SERVICE_NAME>-<TENANT_NAME>.integration.ocp.oraclecloud.com
5. Click Validate. After validation is successful, click Save. This saves the server and credentials of the connection.

Setting Up the Integration in Integration Cloud

Note:

If you are not planning to use Integration Cloud, skip this step.

To set up the integration in Integration Cloud:

1. Log in to Integration Cloud.
2. Create a connection using Oracle Enterprise Performance Management Cloud adapter to your EPM service. Refer to this link for more details: Create a Connection to Oracle Enterprise Performance Management Cloud.
3. Create one or more connections to the other application as needed.
4. Create Event Monitoring Integration using the connections created and activate. Refer to this example: Using the Oracle Enterprise Performance Management Cloud Adapter with Oracle Integration.

Setting Up the Integration without Integration Cloud

Note:

If you are planning to use Integration Cloud, skip this step.

Configure the integration tool which you are planning to use.

1. Review the REST API, Update Task Status for Event Monitoring in REST API for Oracle Enterprise Performance Management Cloud.

2. Configure the integration tool to call the REST API to close the Event Monitoring task passing the parameters for the event.

For more information, see Update Task Status for Event Monitoring in REST API for Oracle Enterprise Performance Management Cloud.

Completing the Integration Setup in Task Manager

Use these steps to complete the Integration setup in Task Manager.

1. On the Home page, click Application, and then click Task Manager.
2. Click the Integrations tab on the left, and verify that the new Integration is displayed.
3. In Task Manager, click Schedules, and create a new Schedule in Pending state. See Manually Creating Schedules.
4. Create the event monitoring task and add it to the schedule. See Creating Tasks.
5. From Schedules, select and open the schedule.
6. Trigger the action that generates the event in the external application (for example, EBS). If you are not using Integration Cloud but other integration tool, invoke the REST API from the integration tool.

   Note:

   Pass the parameters as expected by the integration type, event, parameters, otherwise the task will not be considered if they do not match.
7. Wait for the task to be completed.
8. Optional: To monitor the status of the Integration in Integration Cloud Services, log in to Integration Cloud and navigate to Monitoring.