Overview

Integrations define how Luma Virtual Agent connects to external systems. This can be used to perform an action in the third party system or retrieve data from the other systems. Luma allows the Administrators to create and manage integrations to the target System by creating Applications, Instances of the application (credentials to connect with target systems), and Operations. Web services (APIs) are used to create these integrations which can then be used in skills to action user requests in the required target systems. The Administrator will need to define the Integrations at the tenant level.

There are 3 components of an Integration definition:

1. Application

2. Instance

3. Operation

Application:

‘Application’ represents the third party application or system which can be integrated with Luma using Web Services/APIs. Integrations are defined at the Tenant level and define the connectivity and authentication mechanisms used by Luma to connect to the target system. Here we define the name of the application (like ISM, SDM), and integration type (for example, REST, SOAP).

Instance:

The application instance represents the specific environment of the target systems where the request is actioned. The App Instance helps to set the target environment for the execution of the web service operations. Here we define the Web service, authorization type, and other Global parameters required to connect to the target system. The App instance is selected in the skill to identify the application environment on which the Web service operation will be executed.

Operations:

Operations are the actions that should be performed on the target systems. These represent the functions that are exposed by the Target system’s API. As an Administrator, you can create and edit the operations inside the selected application. Here we define the function to be used, request parameters to be passed to the Webservice, and the attributes that will hold the response received by Luma. Skill Developers add the Operations in the skill conversation flow to perform a specific operation on the required target environment. In the operations, you may also process the web service error responses, no data, and success conditions.

Luma Virtual Agent supports two types of integrations with 3rd party systems :