Integration Configuration Workflow

Assuming you've already created an orchestration plan definition, here's the general flow for integrating with an external system:

Note
Note

You can make multiple interfaces for each system. Not only can each interface can have multiple endpoints, you can also set up different adapters (for example, one for synchronous responses and one for asynchronous responses).

  1. Create a System record. This record contains the API URL for the system that you plan to communicate with. See Create a System Record for Industries Order Management

  2. Create a System Interface record. This record contains the endpoint for the specific thing that you want to do in the external system. For example, if a given system allows you to reach an /activate endpoint, you enter that here. You associate this record with the System that you created earlier. See Create a System Interface for Integration

  3. Create a callout definition. A callout is an orchestration item that uses the information specified in the System and System Interface records to communicate with the external system. You can also associate the callout with a DataRaptor, and with a specific implementation. Creating a Callout Orchestration Item Definition