An integration adapter is a collection of objects and settings that Order Management uses to communicate with external systems. For example, one that reserves a port, or activates an account.
Integration adapters in Order Management require the following three objects:
-
The System object: Contains the API URL of the external system. See: Create a System Record for Industries Order Management
-
The System Interface object: Contains the specific endpoint of the external system that the callout is working with. For example, /activate or /reserve. You also specify the appropriate implementation (one that's included with Order Management, or your own custom version). See: Create a System Interface for Integration
-
The callout item definition: This object defines the orchestration item that activates during the orchestration workflow to call to the external system. Here, you point to the system interface, as well as to any DataRaptor Bundles that you've set up. See Creating a Callout Orchestration Item Definition
- Create a System Record for Industries Order Management
When setting up an integration adapter, use the System record to hold the API URL for the system that Order Management is integrating with. - Create a System Interface for Integration
The System Interface defines the endpoint for an API URL that points to an external system. For example,/activateor/reserve. When you create a callout, you point to the system interface. - Creating a Callout Orchestration Item Definition
Order Management communicates with external systems using a special orchestration item called a callout (or callout task).