1. Using the Oracle Utilities Adapter with Oracle Integration 3
  2. Create an Oracle Utilities Adapter Connection
  3. Create a Connection

Create a Connection

Before you can build an integration, you must create the connections to the applications with which you want to share data.

Note:

You can also create a connection in the integration canvas. See why working with projects is preferred.

To create a connection in Oracle Integration:

  1. Decide where to start:
    • Work in a project (see why working with projects is preferred).
      1. In the navigation pane, click Projects.
      2. Select the project name.
      3. Click Integrations Integrations icon.
      4. In the Connections section, click Add if no connections currently exist or + if connections already exist. The Create connection panel opens.
    • Work outside a project.
      1. In the navigation pane, click Design, then Connections.
      2. Click Create. The Create connection panel opens.

  2. Select the adapter to use for this connection. To find the adapter, scroll through the list, or enter a partial or full name in the Search field.

  3. Enter the information that describes this connection.
    Element Description
    Name

    Enter a meaningful name to help others find your connection when they begin to create their own integrations.

    Identifier

    Automatically displays the name in capital letters that you entered in the Name field. If you modify the identifier name, don't include blank spaces (for example, SALES OPPORTUNITY).

    Role

    Select the role (direction) in which to use this connection.

    Note: Only the roles supported by the adapter you selected are displayed for selection. Some adapters support all role combinations (trigger, invoke, or trigger and invoke). Other adapters support fewer role combinations.

    When you select a role, only the connection properties and security policies appropriate to that role are displayed on the Connections page. If you select an adapter that supports both invoke and trigger, but select only one of those roles, you'll get an error when you try to drag the adapter into the section you didn't select.

    For example, assume you configure a connection for the Oracle Service Cloud (RightNow) Adapter as only an invoke. Dragging the adapter to a trigger section in the integration produces an error.

    Keywords

    Enter optional keywords (tags). You can search on the connection keywords on the Connections page.
    Description

    Enter an optional description of the connection.
    Share with other projects

    Note: This field only appears if you are creating a connection in a project.

    Select to make this connection publicly available in other projects. Connection sharing eliminates the need to create and maintain separate connections in different projects.

    When you configure an adapter connection in a different project, the Use a shared connection field is displayed at the top of the Connections page. If the connection you are configuring matches the same type and role as the publicly available connection, you can select that connection to reference (inherit) its resources.

    See Add and Share a Connection Across a Project.

  4. Click Create.

    Your connection is created. You're now ready to configure the connection properties, security policies, and (for some connections) access type.

  5. Follow the steps to configure a connection.

    The connection property and connection security values are specific to each adapter. Your connection may also require configuration with an access type such as a private endpoint or an agent group.

  6. Test the connection.

Configure Connection Properties

You can consume the SOAP-based catalog or REST web service catalog provided by OUAF in the Oracle Utilities Adapter.

  1. Go to the Connection Properties section.
  2. Enter the SOAP-based catalog or REST web service catalog URL exposed by an OUAF application in the Catalog URL field and click OK.
    The configured REST web service catalog should return only a list of REST inbound/outbound services:
    • Inbound services consist of REST Integrated Web Services (IWS).
    • Outbound services consist of the external system: the outbound message type for a real-time HTTP or JSON sender.
    The configured SOAP-based catalog should return only a list of SOAP inbound/outbound services:
    • Inbound services consist of SOAP Integrated Web Services (IWS).
    • Outbound services consist of the external system: the outbound message type for a real-time HTTP/SOAP message sender.

Configure Connection Security

Configure security for your Oracle Utilities Adapter connection by selecting the security policy.

  1. Go to the Security section.
  2. Select a security policy, and then complete the fields. You must already have created your client application to complete the necessary fields.
    The following security policy restrictions apply when configuring a Utilities Adapter connection with the trigger and invoke role on the Connections page:
    • If you select Basic Authentication, it can be used as a trigger and an invoke.
    • If you select the OAuth Resource Owner security policy, it can only be used as an invoke. Dragging the connection to the trigger area causes an exception error to be displayed. OAuth Resource Owner is only supported for REST on-cloud applications.
    • For existing integrations, the above restrictions do not apply when editing the Utilities Adapter in the Adapter Endpoint Configuration Wizard.
    • If you select OAuth Client Credentials as the security policy, it can be used as a trigger and an invoke. For triggering the integration with OAuth, the Oracle Utilities Adapter trigger connection must also use the OAuth Client Credentials security policy.
    • If you select Username Password Token as the security policy, it can be used as a trigger and an invoke.
    • If you use the OAuth Client Credentials using JWT Client Assertion security policy or OAuth using JWT User Assertion security policy, they can only be used with REST cloud-based connections.
    Element Description
    Basic Authentication

    Enter the following information:

    • Username
    • Password
    OAuth Resource Owner Password Credentials

    Note: When using this security policy, do not configure the connectivity agent. This policy can only be used with REST-based connections.

    		This policy is for a catalog protected with OAuth 2.0 Token-Based Authentication. This enables you to consume an OpenAPI 3.x API protected with OAuth 2.0 Token-Based Authentication. This policy is useful when the Basic Authentication security policy is not sufficient.
    • Access Token URI: The OAuth server URL from which to obtain the access token. It is generally used by Oracle Identity Cloud Service server to identify where your application is registered (for example, https://idcs_hostname/oauth2/v1/token).
    • Client ID: The client identifier issued to the client during the registration process of the application with the Oracle Identity Cloud Service server.
    • Client Secret: The client secret issued to the client during the registration process of the application with the Oracle Identity Cloud Service server.
    • Scope: The scope for accessing the request. The scope enables you to specify which type of access you need. Scopes limit access for the OAuth token. They do not grant any additional permissions beyond that which you already possess (for example, http:hostname:port/*).
    • Auth Request Media Type : The format of the data you want to receive (for example, application/x-www-form-urlencoded;charset=UTF-8). This is an optional parameter that can be kept blank.
    • Username: The resource owner’s username (the application username).
    • Password: The resource owner's password (the application user password).
    • Client Authentication: It specifies how to send the client credentials in the request. The drop-down list provides two options:
      • Send client credentials as basic auth header
      • Send client credentials in body

      This is an optional parameter that if kept blank uses the default value of Send client credentials as basic auth header.

    Username Password Token

    Note: Username Password Token security cannot be used with REST- based connections. An error is displayed when clicking Test to test the connection.

    		This policy is only supported for a SOAP-based catalog connection.
    • Username
    • Password
    OAuth Client Credentials

    • Access Token URI — The URL from which to obtain the access token.

    • Client Id — The client identifier issued to the client during the registration process.

    • Client Secret — The client secret.

    • Scope — The scope of the access request. Scopes enable you to specify which type of access you need. Scopes limit access for the OAuth token. They do not grant any additional permission beyond that which the user already possesses.

    • Auth Request Media Type — The format of the data you want to receive. This is an optional parameter that can be kept blank.

    • Client Authentication — You can optionally configure OAuth flows with client authentication. This is similar to the Postman user interface feature for configuring client authentication.

      • Send client credentials as basic auth header: Pass the client ID and client secret in the header as basic authentication.
      • Send client credentials in body: Pass the client ID and client secret in the body as form fields.
    OAuth Client Credentials using JWT Client Assertion

    Note: This policy is typically used to invoke application-driven APIs where you use the client ID.

    • Access Token URI: Enter the OAuth server URL from which to obtain the access token. It is generally used by the Oracle Identity Cloud Service server to identify where your application is registered. For example:
      https://idcs_hostname/oauth2/v1/token)
    • JWT headers in JSON format: Upload the JWT header file in JSON format.
    • JWT payload in JSON format: Upload the JWT payload file in JSON format. This payload contains sub as the client ID of the client application.
    • JWT private key alias: Enter the JWT private key alias. This is the same alias you specified when uploading the signing key certificate on the Certificates page.
    • Scope: (Optional) Enter the scope for accessing the request. The scope enables you to specify which type of access you need. Scopes limit access for the OAuth token. They do not grant any additional permissions beyond that which you already possess.
    • Access token request: (Optional) Enter the request to obtain the access token. The format you specify can vary by service provider.
    OAuth using JWT User Assertion

    Note: This policy is typically used on behalf of a user.

    • Access Token URI: The OAuth server URL from which to obtain the access token. It is generally used by the Oracle Identity Cloud Service server to identify where your application is registered. For example:
      https://idcs_hostname/oauth2/v1/token
    • JWT headers in JSON format: Upload the JWT header file in JSON format.
    • JWT payload in JSON format: Upload the JWT payload file in JSON format. This payload contains sub as the user name of the application.
    • JWT private key alias: Enter the JWT private key alias. This is the same alias you specified when uploading the signing key certificate on the Certificates page.
    • Scope: (Optional) Enter the scope for accessing the request. The scope enables you to specify which type of access you need. Scopes limit access for the OAuth token. They do not grant any additional permissions beyond that which you already possess.
    • Access token request: (Optional) Enter the request to obtain the access token. The format you specify can vary by service provider.

Configure the Endpoint Access Type

Configure access to your endpoint. Depending on the capabilities of the adapter you are configuring, options may appear to configure access to the public internet, to a private endpoint, or to an on-premises service hosted behind a fire wall.

Select the Endpoint Access Type

Select the option for accessing your endpoint.

Option This Option Appears If Your Adapter Supports ...
Public gateway Connections to endpoints using the public internet.
Private endpoint Connections to endpoints using a private virtual cloud network (VCN).

Note: To connect to private endpoints, you must complete prerequisite tasks in the Oracle Cloud Infrastructure Console. Failure to do so results in errors when testing the connection. See Connect to Private Resources in Provisioning and Administering Oracle Integration 3 and Troubleshoot Private Endpoints in Using Integrations in Oracle Integration 3.

Connectivity agent

Connections to on-premises endpoints through the connectivity agent.

  1. Click Associate agent group.

    The Associate agent group panel appears.

  2. Select the agent group, and click Use.

To configure an agent group, you must download and install the on-premises connectivity agent. See Download and Run the Connectivity Agent Installer and About Creating Hybrid Integrations Using Oracle Integration in Using Integrations in Oracle Integration 3.

Ensure Private Endpoint Configuration is Successful

  • To connect to private endpoints, you must complete prerequisite tasks in the Oracle Cloud Infrastructure Console. Failure to do so results in errors when testing the connection. See Connect to Private Resources in Provisioning and Administering Oracle Integration 3.
  • When configuring an adapter on the Connections page to connect to endpoints using a private network, specify the fully-qualified domain name (FQDN) and not the IP address. If you enter an IP address, validation fails when you click Test.
  • IPSec tunneling and FastConnect are not supported for use with private endpoints.

Test the Connection

Test your connection to ensure that it's configured successfully.

  1. In the page title bar, click Test. What happens next depends on whether your adapter connection uses a Web Services Description Language (WSDL) file. Only some adapter connections use WSDLs.
    If Your Connection... Then...

    Doesn't use a WSDL

    The test starts automatically and validates the inputs you provided for the connection.

    Uses a WSDL

    A dialog prompts you to select the type of connection testing to perform:

    • Validate and Test: Performs a full validation of the WSDL, including processing of the imported schemas and WSDLs. Complete validation can take several minutes depending on the number of imported schemas and WSDLs. No requests are sent to the operations exposed in the WSDL.

    • Test: Connects to the WSDL URL and performs a syntax check on the WSDL. No requests are sent to the operations exposed in the WSDL.

  2. Wait for a message about the results of the connection test.
    • If the test was successful, then the connection is configured properly.
    • If the test failed, then edit the configuration details you entered. Check for typos and verify URLs and credentials. Continue to test until the connection is successful.
  3. When complete, click Save.