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:
Work with your Oracle Integration administrator to complete this task. |
2 |
Create a client application in Oracle Cloud Infrastructure Identity and Access Management (IAM) for your Oracle Integration instance and obtain the client 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 |
|
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 Cloud Infrastructure Identity and Access Management (IAM), 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 a client application and obtain the required details, see Prerequisites for Client Credentials and Resource Owner Password Credentials in Using OAuth 2.0 Grants in Oracle Identity Domain Environments. Select the Client credentials grant type.
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:
Download and Install the Required Software
To use the Rapid Adapter Builder, you require additional applications or software installed on your system.
Install the VS Code Extension for Rapid Adapter Builder
Download and install the VS Code extension for Rapid Adapter Builder.
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 |
---|---|
|
The active profile to use. The value must match a profile name from the profiles list. |
|
The array of profile objects. |
|
The unique name for a profile. |
|
The design-time URL of the Oracle Integration instance for REST API. |
|
The name of your Oracle Integration instance. |
|
The get-token URL for your Oracle Integration instance, obtained from Oracle Cloud Infrastructure Identity and Access Management (IAM). |
|
The client ID of the configured application in IAM. |
profiles[*].auth.clientSecret |
The client secret of the configured application in IAM. |
profiles[*].auth.scope |
The allowed scope of the configured application in IAM. |
Perform the following tasks in VS Code to make the required configuration.