Connect to Process Cloud APIs

You can connect to Process Cloud APIs using identity propagation or fixed credentials.

Note:

Process for Visual Builder, which is included in the Enterprise edition of Oracle Integration Gen 2, is deprecated. See Deprecated Features for details.

Connect to Process APIs Using Identity Propagation

To connect to Process APIs using identity propagation, the Process and Visual Builder instances must be located in the same domain and use the same IDCS instance for authentication.

Using "Oracle Cloud Account" authentication provides identity propagation from Visual Builder to Process without the need for any additional configuration. No CORS configuration is required because the instances are in the same domain.

To connect to Process APIs using identity propagation:

  1. Open Services in the Navigator, click the + sign, and select Service Connection.
  2. Click Define by Endpoint in the Create Service Connection wizard.
  3. Provide the full applicable URL.
    For example, the URL might be similar to https://<process cloud instance>/bpm/api/4.0/processes to retrieve a list of processes.
  4. Select Oracle Cloud Account as the authentication methods.
  5. Choose an appropriate connection type, such as Dynamic, the service supports CORS to take advantage of direct flows.
  6. Test the service connection.
  7. Optional: If you want to make the service connection accessible to anonymous users of the app, select the Allow anonymous access to the Service Connection Infrastructure check box in the Edit Server dialog that you invoke from the Servers tab. Use the Authentication for anonymous users drop-down list to configure an authentication type for anonymous users.

Connect to Process APIs Using Fixed Credentials

To connect to Process APIs using fixed credentials, you can choose to use Basic Auth, OAuth 2.0 Client Credentials or OAuth 2.0 Resource Owner Password as the authentication method.

For access to Process APIs using fixed credentials, the Process and Visual Builder instances do not need not be located in the same domain or governed by the same IDCS instance. The steps are the same if they use the same IDCS instance. When creating the service connection, you can use one of the following authentication method for the service connection:

Authentication method Details
Basic

To use this option you need to provide the following details:

  • User name and Password. These can be the valid credentials of any user that has access to the Process API.
OAuth 2.0 Client Credentials

To use this option you need to provide the following details:

  • Client ID and Secret. This is from the IDCS of Process
  • Token URL. The instance token URL from IDCS.
  • Scope. This is from the IDCS of Process.
OAuth 2.0 Resource Owner Password

To use this option you need to provide the following details:

  • Client ID and Secret. This is from the IDCS of Process
  • Username and Password. These can be the valid credentials of any user that has access to the Process REST endpoint.
  • Token URL. The instance token URL from IDCS.
  • Scope. This is from the IDCS of Process.

If you do not have access to IDCS, you will need to request the authentication details from an administrator if you want to use the OAuth 2.0 Client Credentials or OAuth 2.0 Resource Owner Password authentication methods.

To connect to Process APIs using fixed credentials:

  1. Open Services in the Navigator, click the + sign, and select Service Connection.
  2. Click Define by Endpoint in the Create Service Connection wizard.
  3. Provide the full applicable URL.
    For example, the URL might be similar to https://<process cloud instance>/bpm/api/4.0/processes to retrieve a list of processes.
  4. Select one of the supported authentication methods and provide the authentication details.
  5. Test the service connection.
  6. Optional: If you want to make the service connection accessible to anonymous users of the app, select the Allow anonymous access to the Service Connection Infrastructure check box in the Edit Server dialog that you invoke from the Servers tab. Use the Authentication for anonymous users drop-down list to configure an authentication type for anonymous users.