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 Define Inbound Triggers, Outbound Invokes, and Actions.

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

Enter connection information so your application can process requests.

  1. Go to the Properties section.
  2. Enter the URL used to connect to your application and process requests in the Connection URL field.

    For production, the URL format is as follows:

    https://instance_name.fs.ocs.oraclecloud.com

    For examples of the URL format, see REST API for Oracle Fusion Field Service Cloud Service.

    For development and testing, use the URL provided by Oracle when your Oracle Fusion Field Service instance is provisioned.

  3. Enter the instance ID in the Instance ID field.
    The instance ID is provided by Oracle when your Oracle Fusion Field Service instance is provisioned.

Configure Connection Security

Select the security policy and define the user credentials for the connection. User authentication restricts access to authorized users.

  1. Go to the Security section.
  2. Select a security policy.
    Selected Security Policy Fields
    Client Credentials
    • Client Id: Enter the registered client application key.
    • Client Secret: Enter the registered client application secret.
    • Confirm Client Secret: Reenter the registered client application secret.

    See Create an Application.

    OAuth Authorization Code (Recommended)
    • Client ID: Enter the client identifier issued to the client during the registration process. See Create an Oracle Fusion Field Service API Client Confidential Application.

    • Client Secret: Enter the client secret. See Create an Oracle Fusion Field Service API Client Confidential Application.

    • Authorization Code URI: Enter the URI from which to request the authorization code.

    • Access Token URI: Enter the URI to use for the access token.

    • Scope: (Optional) Enter 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.

    • Client Authentication: (Optional) 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.
    • Use PKCE (Proof Key for Code Exchange) — Select Yes to optionally enable the PKCE extension for the OAuth authorization code flow. When enabled, Oracle Integration generates and includes the code challenge and code verifier in the authorization and token requests, respectively. The code challenge method used is always S256. PKCE adds an additional layer of security to the authorization flow for servers that support it.

      For information on PKCE, see What is PKCE?.

    • Provide Consent: Click to test the connection. The connection is only successful after you click the Provide Consent. Configuring all the details alone is not sufficient.
    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.
    Basic Authentication
    • Username: Enter the name of a user with access to the destination web service.
    • Password: Enter the password.
    • Confirm Password: Re-enter the password.

    See Manage Permissions and Restrictions for the Selected User Types.

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

  1. Go to the Access type section.
  2. 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.

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.

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.