Explore What You Can Do

Before building an adapter, familiarize yourself with the features and limitations of the Rapid Adapter Builder.

• Features
• Security
• Extendability
• Limitations
• Limits

Features

The Rapid Adapter Builder provides numerous features to support your business requirements.

Feature	More information
Outbound and inbound integration capabilities	Your adapter supports the following types of integration activities: Outbound integration from Oracle Integration to another application. For example, you can send requests to external APIs, data sources, or applications. The requests can create, modify, delete, or query resources. Inbound integration from another application to Oracle Integration. For example, an integration starts running when a state change occurs, such as when a person creates an order.
Supported APIs	The adapter that you build can integrate with an application's: Public REST APIs Private REST APIs You can use the connectivity agent to integrate with any APIs that are hosted in your data center or private cloud.
Creation and life cycle management	The creation and lifecycle management of an integration is the same, regardless of whether you or Oracle builds the adapters that the integration uses. For example, the tasks to export, import, and promote integrations to higher environments are the same, regardless of the author of the adapter.
Support for data model extension	Your adapter can support the dynamic retrieval of custom attributes for the standard business objects that are present in an application. Therefore, if you've extended an application, integration developers can refresh the model and get the latest schemas when configuring a connection.
Support for content types while invoking the REST API services	Support for the following content types while invoking the REST API services: application/JSON application/octet-stream multipart/mixed multipart/form-data
Support for webhook triggers	Development of webhook triggers to facilitate automatic starting of integrations when specific state changes occur in the event producer application. Support for automatic and manual registration of webhook triggers during flow activation. Support for verifying the digitally signed messages, such as HMAC and RSA, that are posted to Oracle Integration. Support for modeling the pre-flight requests to allow for event producer applications to validate the integrity of webhook. Support for filtering the events. See Update Trigger Definitions.
Language support	You can define the following in the adapter definition document: Cloud Native Computing Foundation (CNCF) functions JQ expressions See Supported CNCF and jq Functions.
Constructs from the CNCF Serverless Workflow specification	In the adapter definition document, you can model the flow implementation by using a subset of the constructs that are supported in the Serverless Workflow specification of the Cloud Native Computing Foundation (CNCF) project.
Higher-order functions that use the Domain Specific Language pattern	The Rapid Adapter Builder provides the following higher-order functions, which use the Domain Specific Language pattern for security, message format translation domains, and so on: Custom CNCF Serverless Workflow functions Custom JQ functions See Supported CNCF and jq Functions.
Inbound concurrent rate limit	Service limits with respect to concurrent rate limit (on the inbound) are automatically enforced for the inbound requests posted to the endpoints stood up using Rapid Adapter Builder based adapters.
Modeling of endpoint user experience	Declaratively modeling various types of user interfaces in the adapter definition document for both action and trigger specific endpoint configuration. See Update Action Definitions.
Extension for Visual Studio (VS) Code	The VS Code extension for Rapid Adapter Builder enables you to use VS Code as an Integrated Development Environment (IDE) for your adapter-development work. The extension facilitates conversion of a Postman collection or an OpenAPI document into an adapter definition document. Additionally, the extension provides several other features, like workspace initialization, validation, code snippets, and so on. The extension integrates with Oracle Integration for seamless creation of adapters. See Use VS Code as an Integrated Development Environment.

Security

The Rapid Adapter Builder provides native support for several authentication mechanisms in the form of security policies for both inbound and outbound invocations.

Security feature	Supported schemes
Outbound authentication	The following authentication and authorization schemes are supported natively using managed security policies for authenticating against the external endpoints and APIs: HTTP Basic Authentication API Key Based Authentication OCI Signature Version 1 OAuth 1.0 One-Legged Authentication OAuth Resource Owner Password Credentials OAuth Client Credentials OAuth Authorization Code OAuth JWT User Assertion OAuth JWT Client Assertion Each connection definition in the adapter can support one or more outbound authentication schemes. See Learn About Security Policies for Invoke Connections.
Inbound authentication	The following schemes, including authentication and authorization schemes and Digital Signature verification schemes, are supported natively using managed security policies for processing inbound requests: Basic Authentication OAuth 2.0 Access Tokens HMAC Signature Validation RSA Signature Validation JWT Validation Each connection definition in the adapter can support one or more inbound authentication schemas. See Learn About Security Policies for Trigger Connections.
Extension of OAuth authentication	When an external OAuth provider flow is not RFC 6749 compatible, you can extend the following OAuth authentication schemes: OAuth Resource Owner Password Credentials OAuth Client Credentials OAuth Authorization Code Policy
Additional security features	The adapters that you build using the Rapid Adapter Builder have the following capabilities: In OCI Vault, automatically securing customer-sensitive information that is captured by a connection. Calling TLS-protected APIs (TLS v1.3) Calling external APIs protected using self-signed certificates or lesser known CA signed certificates Guardrails to ensure that all the outbound requests made on behalf of adapters are only to the domains advertised in the adapter definition document Automatic GET retries for 502, 503, and 504 Sending requests in clear text without transport level security By default, the non-SSL support is disabled Note: Adapters that send requests in clear text without transport level security have lower security.

Extendability

The Rapid Adapter Builder provides native support for plugging in additional behaviors for the adapters that you build.

The adapter definition document includes the following extension points for plugging in additional behaviors.

Extension point	Supported extendability
Input/Output	Allows you to define the input and output schema of the action or trigger. You can either use a static value for the JSON schema or dynamically determine the JSON schema by calling a flow.
Actions execute	Allows you to extend the default implementation of the flow (as pass-through), and perform more complicated tasks, such as: Call JQ and CNCF functions. Execute calls to third parties. Convert a message from Oracle Integration into a form that the API expects. Collate and enrich the incoming data into another form that the API expects (which may require accessing other sources to retrieve data). In the same flow, the extension point allows you to perform the following tasks: Parse the response into a more user-friendly form. Enrich the response with additional data. Transform the response to a form required for the integration in Oracle Integration.
Triggers execute	Allows you to perform the following tasks: Perform post-processing on the information to send to the next activity in the integration. Transform a message, where a webhook message schema is different from the input message schema (required by Oracle Integration).
Activate integrations	Allows automatic registration of subscription and webhook for a specific event in the event producer or the source application.
Deactivate integrations	Allows automatic de-registration of subscription or webhook for a specific event from the event producer or source application.
Test a connection while designing an integration	Allows you to extend the default ping behavior, with advanced and custom logic. For example, call any idempotent API and ensure success. See Implement the Test-Connection Behavior Using Flows.
Authorize and authenticate during design time and runtime	By default, the OAuth-2 policies are RFC 6749 compatible. However, many implementations differ from RFC standards. Extensible, managed security policies allow you to extend some security policies and override one or more steps.

Limitations

When building an adapter using the adapter definition document and creating connections based on your adapter, be aware of the restrictions.

Area	Limitations
Adapter definition document	The adapter definition document has the following limitations. Some constructs of the CNCF Serverless Workflow specification aren't supported for modeling the flows in the adapter definition document. Some JQ functions used in JQ expressions aren't supported. Oracle doesn't provide version support for adapter definition documents. After pushing an adapter to Oracle Integration, when you need to update an adapter definition document, you are responsible for ensuring backward compatibility for each of the adapters that you build.
Types of external endpoints and APIs that are not supported	An adapter that you build using the Rapid Adapter Builder has the following limitations: The adapter can't use private endpoints to access resources that are hosted in a private cloud or in your organization's data center. The adapter can't interface with the following: SOAP APIs, gRPC APIs, GraphQL APIs, and WebSockets. Endpoints that use a non-HTTP protocol, such as JDBC, AMQP, MQTT, or FTP. The adapter can't use REST APIs that accept Application/XML as the content type for requests. Similarly, the adapter can't receive responses of Application/XML Content type from the external APIs. The adapter can't implement custom security schemes for authorization and authentication. The adapter can't use triggers that are based on synchronous request and response patterns. The adapter can't call external REST APIs that are protected using mTLS (2-way SSL). The adapter can't use HTTP-based or non-HTTP-based polling messages and events as triggers to start integrations.

Limits

The Rapid Adapter Builder has limits for several areas. A limit is the quota or allowance for a resource. You cannot change the limits.

Limit categories: General | Schemas | Connections and Security Policies | Triggers | Actions | Actions Runtime | Categories | Triggers Runtime | CNCF Flows

General

Resource	Minimum required	Maximum allowed
The size of the adapter definition document you can include in the adapter bundle, created using the Rapid Adapter Builder.	0	10 MB
The size of the OpenAPI document you can include in the adapter bundle, created using the Rapid Adapter Builder.	0	10 MB
The size of the adapter icon you can include in the adapter bundle, created using the Rapid Adapter Builder.	0	100 KB
Rapid Adapter Builder based adapters in a service instance	0	10
Allowable domains defined for an adapter	0 Note: An adapter with 0 allowedDomains is not secure.	10
Schemas defined for an adapter within the adapter definition document	1	100

Schemas

Resource	Minimum required	Maximum allowed
Schemas defined in the adapter definition document	0	500

Connections and Security Policies

Resource	Minimum required	Maximum allowed
Security policies defined within a trigger/action connection definition	1	6
Properties including hidden connection properties defined within a connection definition	0	10
Non-hidden connection properties defined within a connection definition	0	10
Security properties including hidden properties defined within a connection definition	1	10
Security properties excluding the hidden properties defined within a connection definition	0	5

Triggers

Resource	Minimum required	Maximum allowed
Static triggers defined for an adapter within the adapter definition document	0	100
Trigger configurations within a single trigger	0	20
Webhooks defined within a trigger within the adapter definition document	0	1

Actions

Resource	Minimum required	Maximum allowed
Static actions defined for an adapter within the adapter definition document	1	100
Action configurations within a single action	0	20

Actions Runtime

Resource	Maximum allowed
Size of the structured payload that can be sent by Rapid Adapter Builder based adapter to the external endpoint	100 MB
Size of the structured payload that can be received as a response by the Rapid Adapter Builder based adapter from an external endpoint	100 MB
Size of the attachment that can be received as part of the response by the Rapid Adapter Builder based adapter from an external endpoint	1 GB

Categories

Resource	Minimum required	Maximum allowed
Categories defined	0	10

Triggers Runtime

Resource	Maximum allowed
Maximum size of the structured payload that can be received by the Rapid Adapter Builder based adapter endpoint	100 MB

CNCF Flows

Resource	Minimum required	Maximum allowed
Cloud Native Computing Foundation (CNCF) actions within a state	1	10
Actions in a state	1	10
States within a flow	1	10
Flows defined within an adapter	1	100
Outbound invocations (network calls) made using connectivity::rest within any flow, regardless of whether the flow is used in designtime or runtime	0	4