1. Orchestrator Guide
  2. Creating a Soft Coding Record for a REST Connection

Creating a Soft Coding Record for a REST Connection

  1. On the Orchestrator Studio Home page, click the Connections icon.
  2. On the Connections side panel, click the New button and select REST from the drop-down list.
  3. On the Connection design page, complete these fields:

    • Name. Enter a unique name for the REST connection.

    • Description. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the respective location in the description of each of the soft coding record.

      The Type of connection is displayed next to the Description field.

    • User/Role. Enter the user who is authorized to run the originating orchestration, which is the orchestration on the local system that will call the external REST service. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the local orchestrations reside.

  4. On the Service Information tab, enter the URL for accessing the REST services in the Endpoint field.
    Important: Oracle strongly recommends that all external calls use the SSL protocol (https) with a certificate from a reputable certificate authority.
  5. Click the Security tab and from the Security Policy drop-down list, select the type of security you want to use and then follow the appropriate steps:

    • For Basic Authorization, complete these fields:

      User

      Password

    • For OAuth 2.0 Client Credential:

      This type of security allows orchestrations to exchange REST calls and data with Oracle Cloud services and other third-party systems.

      1. In the Token Endpoint URL field, enter the address of the server that will provide the OAuth token.
      2. In the OAUTH Client ID field, enter ID of the client.
      3. In the OAUTH Secret field, enter the value for client secret you have received after registering the application.
      4. If the client requires additional header parameters, in the OAUTH Parameters area:

        1. Click Add. The system adds a new row in the OAUTH Parameters table.

        2. Enter a name and value for the parameter in the table.

      5. (Release 9.2.5.2) Enable the Use Parameters option if you want to send the client ID and client secret as form parameters in the request body. Do not enable this option to pass the client ID and client secret in the Basic Authentication header.

    • (Release 9.2.8.2) For OCI API Key-Based Authentication:
      Note: You must have permissions enabled in Oracle Cloud to access each of the Oracle Cloud Infrastructure (OCI) services you want to call. Each OCI service requires different permissions associated with it in OCI. Try to use the OCI web interface to run the service first, and then the system will display a message if additional permissions are required to use that service. Use this security policy to authenticate to external services provided by Oracle Cloud Infrastructure (OCI). This security policy enables the use of Oracle Cloud Infrastructure API Signature Version 1 to authenticate to services such as Oracle Document Understanding. To know more about the available OCI services, see https://docs.oracle.com/en-us/iaas/api/

      1. In the OCI Configuration File field, copy and paste the OCI configuration file details from your OCI account.

      2. In the Private Key File Name field, drag the OCI private key (.pem) file from your system and drop it on the field name, or click and then upload the key file.

        Note: You can generate and download an OCI private key in your OCI user account from Oracle Cloud.
      3. Click Save. The system adds the OCI authentication information as record in the Soft Coding Record Table (F954001).
  6. If the connection is being made to an external server, on the Proxy tab, specify a proxy server for accessing the external server:

    • Proxy Host. Enter the URL of the proxy server.

    • Proxy Port. Enter the port number of the proxy server.

    • Use Proxy. Slide the toggle to the right to enable the proxy.

  7. On the HTTP Headers tab, perform the following steps to add a header record that will be used in the HTTP request to execute the external REST service:
    1. Click the Add button.
    2. In the pop-up box, complete these fields:

      Name.

      Value.

    3. Slide the Encrypt toggle to the right to enable encryption.
    4. Click Add.

      The Orchestrator Studio adds a row to the grid in the HTTP Headers tab.

    5. Add additional header records as necessary.
  8. Click Save.