Info Properties and Sample Code
The info
section of an adapter definition document typically contains the properties listed here and has the following sample structure.
Properties
The info
section includes the following properties.
Property | Description |
---|---|
|
Unique identifier of the adapter.
Note: Ensure that theid value is prefixed with a namespace
and is separated from the identifier with a colon. For
example: "id" : "oracle:zuora" , where
oracle is the namespace.
|
|
Type of application that the adapter connects to. Choose from the following values:
|
|
Name of the adapter. This name appears in several places on the user interface of Oracle Integration, for example, the adapter registry page, and connection creation and selection related pages. You can localize this field, and also modify the name if the third party decides on an identity or a name change. |
|
Description of the adapter. This value appears in Oracle Integration on the Adapters page, which is within the Design page. |
|
Version of the adapter. While specifying the version, ensure to follow the semantic version rules where the first digit represents a major version, which is backward incompatible with the last major version. The next digit represents backward compatible functional additions and the third digit presents fixes that do not change the contract of the adapter actions and triggers. For more information on semantic versioning, see https://semver.org/. When you update the version number, the Rapid Adapter Builder platform validates it against the existing adapter version. for more information, see Rules for the Semantic Version Check. |
|
Version of the language that the adapter definition document uses. This field indicates to the Rapid Adapter Builder which language version to execute. |
|
Category for the application for which you're creating an adapter. The category determines how the adapter is organized within Oracle Integration. Choose from the following values:
|
|
Information about the adapter. This information typically is relevant if you are part of the Oracle Partner Network and plan to distribute the adapter outside your organization. The following properties are available:
|
|
Information about the organization that developed the adapter (typically the organization that you work for). The following properties are available:
|
|
Information about the adapter's security settings and functional capabilities.
|
Sample Code
{
"info": {
"id": "cloud:microsoft-task",
"displayName": "Microsoft To-do Task",
"description": "Microsoft To-do Task is a cloud-based task management service.",
"version": "1.0.0",
"specVersion": "1.0",
"categories": [],
"appInfo": {
"name": "Oracle Corporation",
"description": "https://www.oracle.com/about",
"contactUS": "http://www.oracle.com/us/corporate/contact/index.html",
"supportURL": "http://otn.oracle.com",
"documentationURL": "https://www.oracle.com/pls/topic/lookup?ctx=appintICSGM-GUID-66A8F995-D32F-420B-9250-290B7D210FBB"
},
"publisherInfo": {
"name": "Oracle Corporation",
"description": "https://www.oracle.com/about",
"contactUS": "http://www.oracle.com/us/corporate/contact/index.html",
"supportURL": "http://otn.oracle.com",
"documentationURL": "https://www.oracle.com/pls/topic/lookup?ctx=appintICSGM-GUID-66A8F995-D32F-420B-9250-290B7D210FBB"
},
"settings": {
}
}
}