Create a Connection

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

To create a connection in Oracle Integration:

  1. In the navigation pane, click Design, then Connections.

  2. Click Create.

    Note:

    You can also create a connection in the integration canvas. See Define Inbound Triggers and Outbound Invokes.
  3. In the Create connection panel, 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.

  4. 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 (trigger, invoke, or both). Only the roles supported by the adapter are displayed for selection. 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.

  5. Click Create.

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

Configure Connection Properties

Enter connection information so your application can process requests.

  1. Go to the Properties section.
    The Connection Properties dialog is displayed. The information to specify was obtained when you completed the Workday Adapter prerequisites. See Prerequisites for Creating a Connection.
  2. In the Hostname field, enter the host name of the Workday server.
  3. In the Tenant Name field, provide the tenant name.
  4. In the Web Service Version field, enter the Workday web service APIs version. If you do not provide the version, the default version (for example, v31.0) is applied.
    The value in the Web Service Version field is used in the following manner in different scenarios:
    • Creation of a new integration: While creating a new integration using the Workday Adapter, the version available on the Connection page of the Workday Adapter (user-provided or default) is used.
    • Editing an integration:
      • The user-provided version on the Connection page is used, if present.
      • Otherwise, the version on which the Workday Adapter endpoint was originally configured is used (in this case, the Workday Adapter extracts the original version).

        Note: If you do not provide any value on the Connection page, then when editing, the integration default version (v31.0) is not used.

    • Regeneration of the adapter endpoint: The version on which the Workday Adapter endpoint was originally configured is used (in this case, the Workday Adapter extracts the original version).
    • Activation of the integration: The version on which the Workday Adapter endpoint was originally configured is used (in this case, the Workday Adapter extracts the original version).
  5. In the URL Prefix field, enter the prefix of your Workday instance URL in the following format:
    host-prefix.workday.com
    For example, if you log in to Workday using the following URL:
    https://impl.workday.com/wday/authgwy/tenant_name/login.htmld?redirect=n
    For this example, enter impl.workday.com in the URL Prefix field.

    Note:

    You must provide the URL prefix to use the Authorization Code Credentials security policy. The URL Prefix field is not marked with an asterisk (*). This incorrectly implies that this field is not mandatory. This field is mandatory if you want to use the Authorization Code Credentials security policy.

Configure Connection Security

Configure security for your Workday Adapter connection.

  1. Go to the Security section.
    The Security Policy field is displayed. Only the Workday Username Token Policy is supported. It cannot be deselected.
  2. Enter a username authorized to access the Workday account and the password. Section “Creating a Workday User Account” of Prerequisites for Creating a Connection describes the integration user and roles. You can also assign the admin role named Security Admin to the user.

    Note:

    • You must provide the client ID and client secret values to use the Authorization Code Credentials security policy. These fields are not marked with an asterisk (*). This incorrectly implies that these field are not mandatory. These fields are mandatory if you want to use the Authorization Code Credentials security policy.
    • The username and password are only used to retrieve web service metadata. The Workday Adapter does not use them for any other purpose.
  3. In the Client Id field, enter the client ID that you obtained while registering an API client. See Prerequisites to Use the Authorization Code Credentials Security Policy.
  4. In the Client Secret field, enter the client secret key that you obtained while registering an API client. See Prerequisites to Use the Authorization Code Credentials Security Policy.

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.

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.