Introduction to Action Definitions

For business purposes, a company can chose to expose an application's APIs with some operations, such as creating or updating a record. When designing an integration, an integration developer can program the integration to perform these operations by configuring one or more actions. Each action calls one or more application-specific APIs. Actions provide a user-centric encapsulation of the target application's operations.

The adapter definition document specifies all the actions that are available to integration developers. Each action has a reference. An action can also be a flow that implements this action. It can also contain the input schema and output schema definitions if the action has input and output data.

Many business scenarios have a requirement to initiate operations from the adapter to the external applications. For example, the adapter for a typical Customer Relationship Management (CRM) tool may be required to perform actions such as:

  • Create, update, and delete customer data.
  • Create an account.
  • Create an opportunity.
  • Log a ticket.

The action objects in an adapter definition document model the higher-order encapsulation of an adapters' operations on the external applications. The Rapid Adapter Builder platform supports:

  • Invoking one or more APIs of the external application.
  • Chaining API calls.

Additionally, the Rapid Adapter Builder platform provides the following capabilities that help integration developers design action definitions:

  • Define the user facing identity and description of the action presented on the user interface.
  • Define the design time experience for configuring an action definition with selection fields and dependencies.
  • Define the request contract to the action definition exposed in the Oracle Integration mapper that may be different than the API contract.
  • Process logic that maps the request contract exposed in the Oracle Integration mapper to one or more API invocations to the external applications.

To understand more about the properties of an action definition in the adapter definition document, see Action Definition Properties and Sample Code.