1. Using the Oracle HCM Cloud Adapter with Oracle Integration 3
  2. Create an Oracle HCM Cloud 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.

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 fields that are displayed are based on your version of Oracle Integration.

  2. For new connections created with the initial release of the simplified connections page on 2/18/20, the HCM Cloud Host field is displayed. Enter the Oracle HCM Cloud host name. For example:
    https://customer_chosen_domain_name.fa.DC.oraclecloud.com

    Note:

    The Oracle HCM Cloud host name can easily be derived from the Oracle HCM Cloud login URL. For example: https://customer_chosen_domain_name.fa.DC.oraclecloud.com/fscmUI/faces/FuseWelcome
  3. For existing connections created prior to the initial release of the simplified connections page on 2/18/20, the HCM Services Catalog WSDL URL and Interface Catalog URL fields are displayed. Specify the URLs to use in this integration.
    1. In the HCM Services Catalog WSDL URL field, specify the URL to use in this integration.
    2. In the Interface Catalog URL field, optionally specify the URL to consume Oracle HCM Cloud REST API business resources.
      If the interface catalog URL is not specified, the Subscribe to Updates (via ATOM Feed) option does not appear for selection on the Actions page of the Adapter Endpoint Configuration Wizard.

Configure Connection Security

Configure security for your Oracle HCM Cloud Adapter connection by selecting the security policy and security token.

  1. Go to the Security section.
  2. Select the security policy to use. Based on your selection, the page is refreshed to display various login credential fields.
    Element Description
    Username Password Token With PGP Key Support Specify the following details to upload an encrypted file to Oracle WebCenter Content (Universal Content Management (UCM). The supported algorithm for the public key is RSA for encryption and key size should be 1024 bits long.
    • Username: Enter the username.
    • Password: Enter the password.
    • Client PGP Private Key: Click Upload link, then browse for and upload the private key to decipher encrypted content. The supported algorithm for the private key is RSA for decryption and the key size must be 1024 bits in size.
    • Client PGP Passphrase: Enter the passphrase registered with the PGP private key.
    • PGP Public Key for UCM Upload: Click Upload link, then browse for and upload the public key to encrypt the file. The PGP public key must already be created. See Upload Files to Oracle WebCenter Content.
    Username Password Token You receive the username and password to enter when subscribing to Oracle HCM Cloud.
    • Username: Enter the username.
    • Password: Enter the password.
    OAuth Authorization Code Credentials
    • Client ID: Enter the client identifier (ID) issued during OAuth client application creation. The client ID identifies the client (the software requesting an access token) making the request. See Perform Prerequisites to Use the OAuth Authorization Code Credentials Security Policy.
    • Client Secret: Enter the client secret issued during OAuth client application creation. See Perform Prerequisites to Use the OAuth Authorization Code Credentials Security Policy.
    • Authorization Code URI: Enter the URI from which to request the authorization code. This endpoint is used to initiate the OAuth authentication and authorization process during which a user is directed to the OAuth server to provide credentials, to review granted permissions, and to provide consent.
      https://IDCS_URL/oauth2/v1/authorize
    • Access Token URI: Enter the URI to use for the access token. A request must be sent to this URI to obtain an access token.
      https://IDCS_URL/oauth2/v1/token
    • Scope: Enter the scopes specified during OAuth client application creation:
      • The URL that corresponds to the federated Oracle Fusion Application instance.
      • offline_access
      https://FA_URL:443/ offline_access
      Scopes enable you to specify the 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. See Perform Prerequisites to Use the OAuth Authorization Code Credentials Security Policy.
    • 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.

    When configuration is complete, perform the following steps:

    1. Click Provide Consent to test the OAuth flow.
    2. If the Oracle Identity Cloud Service Oracle Integration and Oracle Fusion Applications users are different, log in to the respective instance when prompted.

      Note: You are not prompted to log in if these users are the same.

    3. Return to the Connections page and click Test.

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.