1. Using the Rapid Adapter Builder with Oracle Integration 3
  2. Build an Adapter Using the Rapid Adapter Builder
  3. Plan and Design an Adapter
  4. Complete the Prerequisites

Complete the Prerequisites

Before you can start building an adapter, you must complete a few tasks, such as, obtaining access to Oracle Integration, installing the required software, and so on.

Order Task More information

1

Get access to Oracle Integration

If you don't have them already, get:

  • An account on Oracle Integration, including your sign-in credentials
  • The URL for your Oracle Integration instance

Work with your Oracle Integration administrator to complete this task.

2

Create a client application in IDCS for your Oracle Integration instance and obtain the client credentials

See Create a Client Application and Obtain Credentials.

3

Assign the integration-instance developer role to the client application you created previously

See Assign the Integration-Instance Developer Role to the Client Application.

4

Download and install the required software

See Download and Install the Required Software.

5

Install the VS Code extension for Rapid Adapter Builder

See Install the VS Code Extension for Rapid Adapter Builder.

6

Configure the VS Code extension for Rapid Adapter Builder

See Configure the VS Code Extension for Rapid Adapter Builder.

Create a Client Application and Obtain Credentials

In Oracle Identity Cloud Service (IDCS), create a client application for your Oracle Integration instance and obtain the client credentials.

You'll use these client credentials in your publisher-profile details while publishing an adapter using the Rapid Adapter Builder.

To create an IDCS application and obtain the required details, see Prerequisites for Client Credentials in Using OAuth 2.0 Grants in Oracle Identity Cloud Service Environments.

You must obtain the following details for your Oracle Integration instance:

  • Host: URL of the Oracle Integration instance

  • integrationInstance: Name of the Oracle Integration instance

  • The following client credentials:

    • tokenUrl
    • clientId
    • clientSecret
    • scope

Assign the Integration-Instance Developer Role to the Client Application

To successfully use the client credentials, assign the integration-instance developer role to the client application you created previously.

To assign the required role to the client application:

  1. Log in to the Oracle Identity Cloud Service (IDCS) console.
  2. Click Oracle Cloud Services.

    The Oracle Cloud Services page appears.

  3. Search for your Oracle Integration instance and select it.

    The details of the instance appear.

  4. Click Application Roles.

    The list of all applicable roles appears.

  5. Locate and click the ServiceDeveloper role, and then click Assign Applications.
    The Assign Applications dialog appears, displaying the client application you created previously.
  6. Select the client application and click OK.

    Now, IDCS assigns the integration-instance developer role to the application.

Download and Install the Required Software

To use the Rapid Adapter Builder, you require additional applications or software installed on your system.

  1. Download and install the Postman application. Visit the Download Postman page. Create an account on Postman to access full features.
  2. Download and install VS Code. Visit the Download Visual Studio Code page.

    You must use VS Code version 1.73.0 or higher.

Install the VS Code Extension for Rapid Adapter Builder

Download and install the VS Code extension for Rapid Adapter Builder.

  1. On Visual Studio Marketplace, visit Oracle's page.
  2. Find and click the Oracle Integration Cloud Rapid Adapter Builder tile.
    The Details page opens.
  3. Click Install.
    The extension file opens in VS Code.
  4. Click Install in VS Code.
    Now, the extension is installed and appears on the sidebar.

Configure the VS Code Extension for Rapid Adapter Builder

After you install the VS Code extension for Rapid Adapter Builder, you must initialize a workspace on your system and configure the publisher profile for the extension.

Select a folder on your system to use as a structured workspace and organize adapter-related artifacts within it. Initialize this workspace using the VS Code extension.

Additionally, update the publisher profile of the extension with the details of the Oracle Integration instance that you'll publish the adapter to. You'll enter the client credentials you obtained earlier along with some additional data. The information in the publisher profile is used to communicate with the specified Oracle Integration instance for various tasks. The extension securely stores the client credentials you enter for each Oracle Integration instance in the publisher-profiles.yaml file. The structure of the yaml file is as follows:

Property Name Definition

active

The active profile to use. The value must match a profile name from the profiles list.

profiles

The array of profile objects.

profiles[*].name

The unique name for a profile.

profiles[*].host

The design-time URL of the Oracle Integration instance for REST API.

profiles[*].integrationInstance

The name of your Oracle Integration instance.

profiles[*].auth.tokenUrl

The IDCS get-token URL for your Oracle Integration instance.

profiles[*].auth.clientId

The client ID of the configured application in IDCS.
profiles[*].auth.clientSecret

The client secret of the configured application in IDCS.
profiles[*].auth.scope

The allowed scope of the configured application in IDCS.

Perform the following tasks in VS Code to make the required configuration.

  1. Initialize a workspace using the VS Code extension.
    1. In VS Code, click Explorer Explorer icon on the sidebar.
    2. Click Open Folder, and choose a folder on your system as the workspace for adapter development.
      The folder is now listed on the left in the Explorer view.

      Note:

      You can also click File in the top ribbon, and select Open Folder... to open a folder in VS Code.
    3. Press Ctrl + Shift + P to open the command palette, type RAB: Initialize Workspace, and hit Enter.
      The VS Code extension now initializes the workspace, and creates a few directories and template files in the workspace. The directories and files created are displayed in the Explorer view on the left. The following directories and files are created:
      • api: You can save all OpenAPI files in this folder.

        Note:

        For the VS Code extension to package an OpenAPI document into an adapter bundle, rename the OpenAPI document as openapi.resource.json.

      • definitions: The extension creates a default adapter definition document, main.add.json, in this folder. You can overwrite the default document with the data from a Postman collection or an OpenAPI file. Additionally, all the other adapter definition documents you generate are saved in this folder. The file names of all adapter definition documents are appended with .add.json.

      • misc: You can save all Postman collections in this folder. Ensure that the file names of all Postman collections are appended with .postman_collection.json.

      • logo.svg: A default logo file for your adapter is created under the root folder. You can replace this file with the required image.

  2. Configure the publisher profile for the extension.
    1. In VS Code, click OIC Rapid Adapter Builder on the sidebar.
    2. In the resulting view, click Edit in the Publisher Profiles section.
      The publisher-profiles.yaml file opens in the editor.
    3. Update the file with the client credentials you obtained earlier. See Create a Client Application and Obtain Credentials. In addition, update the active field with the name of the profile to use.
    4. Press Ctrl+S on your keyboard to save the file.

    If you enter credentials for more than one Oracle Integration instance, the .yaml file stores them in a hierarchical structure, implemented by indenting the details.

    The following example shows the details of two Oracle Integration instances, named Test_Lab1 and Test_Lab2, stored in a .yaml file. 

    # select which profile to use.
active: Test_Lab1

# multiple profiles can be defined.
profiles:  
  - name: Test_Lab1
    host: https://<oicinstance.oraclecloud.com>
    integrationInstance: example-instance1
    auth:
      tokenUrl: https://<idcs-token>/oauth2/v1/token
      clientId: ef8xxxxxbf0c4101a4f74ae5fe301exx
      clientSecret: 0ebdae12-xxxx-4182-9051-8dbd83b2xxxx
      scope: https://08DADxxxx9D4496F9FBAFxxCFA1B0657.integration.region-1.oraclecloud.com:443urn:opc:resource:consumer::all
  - name: Test_Lab2
    host: https://<oicinstance.oraclecloud.com>
    integrationInstance: example-instance2
    auth:
      tokenUrl: https://<idcs-token>/oauth2/v1/token
      clientId: ef9xxxxxbf0c4101a4f74ae5fe301exx
      clientSecret: 1ebdae12-xxxx-4182-9051-8dbd83b2xxxx
      scope: https://18DADxxxx9D4496F9FBAFxxCFA1B0657.integration.region-2.oraclecloud.com:443urn:opc:resource:consumer::all