Descripción general

Las integraciones definen cómo

...

Luma Virtual Agent se conecta a los sistemas externos. Esto se puede utilizar para

...

realizar una acción en el sistema de terceros o recuperar datos de los otros sistemas

...

. Luma permite a los administradores crear y gestionar integraciones en el sistema de destino mediante la creación de aplicaciones, instancias de la aplicación (

...

credenciales para conectarse

...

con los sistemas de destino) y

...

operaciones. Los servicios web (API) se utilizan para crear estas integraciones que, a continuación, se pueden utilizar en las habilidades para realizar

...

las solicitudes de los usuarios en los sistemas de destino

...

necesarios.

...

El administrador deberá definir las integraciones en el nivel

...

Crear aplicación

Las instancias de aplicación son los sistemas de destino en los que se ejecutan las habilidades y los atributos para el cumplimiento. Al crear la instancia de la aplicación, se de tenant.

Hay 3 componentes de una definición de integración:

1. Aplicación

2. Instancia

3. Operación

Aplicación:

La “aplicación” representa la aplicación o sistema de terceros que se puede integrar con Luma mediante servicios web/API. Las integraciones se definen en el nivel de tenant y definen los mecanismos de conectividad y autenticación que utiliza Luma para el conectarse al sistema de destino. Se puede definir Aquí definimos el nombre de la aplicación (como ISM, SDM) y el tipo de integración (por ejemplo, REST, ISM, SDM, correo electrónico, etc.). El tipo de aplicación seleccionado en la definición de la operación debe indicar el tipo de integración que hará que se presente la plantilla para la configuración de la operación solicitada. Para crear una aplicación:

...

Crear instancia

Una vez creada la aplicación, se debe crear la Instancia de la aplicación. En resumen, la instancia de la aplicación define los mecanismos de autenticación y conectividad para el sistema de destinoSOAP).

Instancia:

La instancia de la aplicación representa el entorno específico de los sistemas de destino donde se lleva a cabo la solicitud. La instancia de la aplicación ayuda a definir los detalles del el entorno de destino para la ejecución de las operaciones del servicio web. El desarrollador utiliza los detalles de la Aquí definimos el servicio web, el tipo de autorización y otros parámetros globales necesarios para conectarse al sistema de destino. La instancia de la aplicación se selecciona en el cumplimiento de la habilidad o el cumplimiento del atributo para realizar la operación en para identificar el entorno de destino solicitado. En el caso del tipo de integración REST de la aplicación conectada, se puede proporcionar la configuración de la solicitud (ruta de acceso, consulta y encabezados) en el nivel de la instancia de la aplicación, que son comunes para todas las operaciones en el que se ejecutará la operación del servicio web.  

Para crear una instancia:

...

Introduzca la URL base a la que Luma se debe conectar.

...

Luma usa el tipo de autorización para iniciar sesión y realizar las operaciones especificadas como parte de la operación del servicio web.

Luma es compatible con los siguientes tipos de autorizaciones:

1. No auth (Sin autenticación): utilice esta opción si no necesita ninguna autenticación para iniciar sesión en los sistemas de terceros.
2. Basic Auth (Autenticación básica): utilice esta opción para autenticar las aplicaciones externas para interactuar con el inquilino de Luma. La autenticación básica consta de los siguientes campos:
   
   1. Username (Nombre de usuario): especifique el nombre de usuario. Luma lo utiliza como un nombre de usuario de autenticación para iniciar sesión en los sistemas de terceros.
   2. Contraseña: especifique la  contraseña. Luma utiliza esta contraseña durante la autenticación con el sistema de terceros.
   3. Authorization Header Name (Nombre del encabezado de autorización): de forma predeterminada, el nombre del encabezado de autorización es especificado como autorización por Luma.
3. Bearer Token (Token de portador): este es el token único de autenticación que se necesita para que las aplicaciones externas se comuniquen con la API de Luma. 
   Image Removed
   El token de portador consta de los siguientes campos:
   
   1. Authorization Header Name (Nombre del encabezado de autorización): de forma predeterminada, el nombre del encabezado de autorización es especificado como autorización por Luma.
   2. Token: introduzca el token de autenticación exclusivo para que las aplicaciones externas se comuniquen con la API de Luma.

...

1. Introduzca el Campo externo y el Valor.

...

1. Introduzca el Campo externo y el Valor.

...

1. Introduzca el Campo externo y el Valor.
   Los siguientes encabezados de muestra son los que más se encuentran.
   • Authorization (Autorización): incluye credenciales que contienen la información de autenticación del cliente para el recurso que se solicita. 

   • Accept-charset (Aceptar conjunto de caracteres): se trata de un encabezado que se establece con la solicitud y que indica al servidor qué conjuntos de caracteres son aceptables para el cliente. 

   • Content-Type (Tipo de contenido): indica el tipo de medio (texto/HTML o texto/JSON, XML/personalizado) de la respuesta que el servidor envía al cliente, por lo que el cliente podrá procesar correctamente el cuerpo de la respuesta.

Click Create to create the app instance.

Crear operaciones

...

Operaciones:

Las operaciones son las acciones que se deben realizar en los sistemas de destino. Representan las funciones expuestas por la API del sistema de destino. Como administrador, puede crear y editar las operaciones en dentro de la aplicación seleccionada para las habilidades en el nivel de dominio, lo cual se debe ejecutar en el entorno de destino como parte del cumplimiento de la habilidad. 

Una vez que se han creado la instancia de la aplicación y la aplicación, se deben crear las operaciones necesarias. Una operación define la tarea que se debe llevar a cabo en el cumplimiento. Para crear una operación:

...

• Get  (Obtener): para recuperar datos
• Post  (Publicar): para crear datos
• Colocar:  para editar los datos
• Delete  (Eliminar): para eliminar los datos

...

1. Introduzca el Campo externo y el Valor.

...

1. Introduzca el Campo externo y el Valor.

...

Accept-charset (Aceptar conjunto de caracteres): se trata de un encabezado que se establece con la solicitud y que indica al servidor qué conjuntos de caracteres son aceptables para el cliente. 

Content Type: indica el tipo de medio (texto/HTML, texto/JSON, XML/personalizado o multipart/form-data) de la respuesta que el servidor envía al cliente, por lo que el cliente podrá procesar correctamente el cuerpo de la respuesta.

...

Image Removed

...

Configuración de la respuesta

Esta sección se utiliza para procesar los datos o la respuesta recibida del servicio web externo.

Mapeo de entrada

Se pueden crear los atributos locales y personalizados del usuario para almacenar los datos que se utilizan en una operación. El atributo local almacena los datos temporales en el flujo de trabajo de acción que se van a pasar entre varias operaciones. Se utiliza como un marcador de posición en las plantillas y las reglas de mensajes del usuario dentro del flujo de trabajo de acción. El atributo de usuario personalizado almacena los datos extraídos de la entrada de usuario, de la operación de integración de terceros , de respuestas, etc.

Image Removed

A continuación se muestran los detalles necesarios para el Mapeo de entrada:

• Scope (Alcance): representa el alcance del atributo que se utilizará para contener los valores entrantes.
  • Utilice Global para asignar el valor a un atributo global que se utilizará en la habilidad. Aunque los atributos estén disponibles para que se puedan utilizar otras habilidades, el valor se mantiene hasta la ejecución de las habilidades.
  • Utilice Local (Local) para crear y establecer el valor de un atributo local. Estos atributos son válidos y están disponibles únicamente durante la ejecución de la habilidad.
  • Utilice User Custom (Personalizado del usuario) para asignar el valor a un atributo personalizado del usuario. Estos atributos mantienen los valores asignados a menos que se sobrescriban.
• Attribute (Atributo): es el nombre del atributo.
• Data Type (Tipo de dato): representa el tipo de dato del valor. 
• Expression Type (Tipo de expresión) y Expression (Expresión): representan el tipo (valor o JSON) y la ruta de la ubicación del  valor  que se asigna al atributo.
  • Utilice Expression Type (Tipo de expresión) → Value  (Valor) cuando un valor que se asigna al atributo, es decir, Expression (Expresión), apunta a un valor directo, por ejemplo, @{response.body}, @{response.code}.
  • Use Tipo de expresión y  JSONPath cuando un valor de la respuesta de JSON recibida se asignará al atributo, por ejemplo,  Expresión apunta a una ruta de acceso a JSON (por ejemplo, $.data.TicketIdentifier, $.data.items[*].Priority).
  • Use Expression Type (Tipo de expresión) → Indirect JSONPath (JSONPath indirecto) cuando un valor del atributo de tipo JSON se asignará al atributo, por ejemplo, Expression (Expresión) apunta a un atributo que mantiene una ruta de acceso a JSON (por ejemplo, @{local.items}→$).[*].TicketIdentifier

Manejo de errores

Esta sección se utiliza para definir el comportamiento y la respuesta de bot para el usuario cuando se produce un error durante la ejecución de la operación. Se pueden crear varias reglas que controlen errores desde las operaciones del servicio web.

 Image Removed

Seleccione una de las siguientes opciones para definir una regla para enviar el mensaje de error. El mensaje de error se enviará solo si se validan las condiciones especificadas:

• Coincidencia con alguna de las siguientes condiciones: una de las condiciones especificadas debe coincidir para analizar el mensaje de error.
• Coincidencia con todas las siguientes condiciones: es necesario validar todas las condiciones especificadas para analizar el mensaje de error.
• Definición de criterios personalizados: se pueden definir criterios personalizados en función de las condiciones proporcionadas para analizar el mensaje de error si se valida.
  Por ejemplo, 1 y 2 o 3. Las condiciones primera y segunda deben coincidir, o solo la tercera condición debe coincidir. Se pueden introducir solo números, y, o, (,)

Especifique @response.StatusCode en el campo Key (Clave) seguido por un operador.  A continuación, se muestra la lista de operadores compatibles:

• Es igual a
• No es igual a
• es mayor que
• es mayor o igual que
• es menor que
• es menor o igual que
• Comienza con
• No comienza con
• Termina con
• No termina con
• Contiene
• No contiene
• está vació
• no está vacío
• coincide con el patrón

Sin manejo de datos

Esta sección se utiliza para definir el comportamiento y la respuesta del bot para el usuario cuando la ejecución de la operación no produce datos. Se pueden crear varias reglas sin ningún escenario de datos desde las operaciones del servicio web. Siga los valores de la devolución de la API de los sistemas externos desde los cuales recibe los datos, y escriba o evalúe los valores correspondientes en la sección Rules/conditions (Reglas/condiciones).

Manejo de operaciones correctas

...

. Aquí definimos la función que se utilizará, los parámetros de solicitud que se pasarán al servicio web y los atributos que contendrán la respuesta recibida por Luma. Los desarrolladores de habilidades agregan las operaciones en el flujo de conversación de habilidades para realizar una operación específica en el entorno de destino requerido. En las operaciones, también puede procesar las respuestas de error del servicio web, la ausencia de datos y las condiciones de éxito.

Luma Virtual Agent admite dos tipos de integraciones con sistemas de terceros: