Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 5 Current »


SOAP (Protocolo simple de acceso a objetos) es un protocolo de mensajes que permite que las aplicaciones que se ejecutan en diferentes sistemas operativos y con diferentes tecnologías se comuniquen entre sí. Es un protocolo basado en XML para intercambiar información entre aplicaciones que utilizan servicios web. Los mensajes SOAP están escritos completamente en XML y, por lo tanto, son independientes del idioma y la plataforma.

Luma Virtual Agent es compatible con el protocolo SOAP para interactuar con aplicaciones de terceros.

Crear aplicación

Para crear una aplicación:

  1. En el menú Tenant (Tenant), haga clic en Integrations (Integraciones). La página Connected Apps (Aplicaciones conectadas) aparece como se muestra a continuación. 
    Aquí podemos configurar una integración entre Luma y un sistema de terceros. Una vez que se ha creado la aplicación conectada, el paso siguiente es crear la instancia de la aplicación y las operaciones de servicios web correspondientes.




  1. Haga clic en  Crear aplicación  para crear una nueva aplicación.
    Aparecerá la página Create App (Crear aplicación) como se muestra a continuación.

  Detalles: 

  1. Introduzca el  Nombre de la aplicación.
  2. Seleccione el tipo de integración como SOAP

Configuración de la aplicación: a continuación, se muestra la lista de detalles que se deben configurar.

  1. Introduzca el Nombre de la aplicación
  2. Seleccione la dirección URL de WSDL o el nombre de archivo WSDL.
  3. Introduzca la dirección URL de WSDL, el nombre de la URL de WSDL o el nombre de archivo de WSDL.
  4. Tipo de autorización : 
    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 tenant 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.

  1. Haga clic en Create (Crear) para completar la creación de la aplicación. 

La aplicación creada está disponible en la lista Connected Apps  (Aplicaciones conectadas). El paso siguiente es crear una instancia.  



Si la aplicación de terceros requiere diferentes URL o archivos de WSDL para conectarse a diferentes entornos o módulos, puede agregar varias URL o archivos WSDL o con datos de autenticación.

Crear instancia

Una vez creada la aplicación, se debe crear la Instancia de la aplicación. En el caso del tipo de integración SOAP, se puede proporcionar la configuración de la solicitud (encabezados globales) en el nivel de la instancia de la aplicación, que son comunes para todas las operaciones del servicio web creadas para la aplicación.  

Para crear una instancia:

  1. En la página de Connected Apps (Aplicaciones conectadas), haga clic en Create Instance (Crear instancia) como se muestra a continuación.


  1. Aparecerá la página Create Instance (Crear instancia).
  2. Introduzca el  Nombre  y la  Descripción de la instancia. El paso siguiente es definir las credenciales y los detalles de conexión para esta instancia.
  3. Agregar detalles de configuración de la instancia:

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

    2. 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 tenant 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. 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.

  4. Haga clic en Create (Crear) para crear la instancia de la aplicación.

    La primera instancia que se agrega se considera la instancia predeterminada.

Crear operaciones

Una vez que se hayan creado la aplicación y la instancia, se pueden crear las operaciones necesarias para que se ejecuten con el sistema de integración. Una operación define la tarea que se debe llevar a cabo como parte de la habilidad. 

Para crear una operación:

  1. En la página de Aplicaciones conectadas , haga clic en  Crear operación  como se muestra a continuación.


  2. Aparecerá la página Create Operation (Crear operación).
  3. En la pestaña Operation Details (Detalles de la operación), agregue los detalles de la operación:
    1. Introduzca el Operation Name (Nombre de la aplicación).
    2. Seleccione uno de los WSDL agregados para la aplicación. 
    3. Seleccione el método de enlace. Los métodos de enlace se rellenan automáticamente en función del WSDL seleccionado.
  4. Seleccione la operación. El sistema muestra automáticamente las operaciones admitidas para el WSDL y el método de enlace seleccionados.
  5. Se debe especificar Timeout (in milliseconds) (Tiempo de espera [en milisegundos]). Es la cantidad de tiempo de espera para una respuesta de servicio web al invocar una solicitud saliente.  El valor predeterminado es de 10.000 milisegundos, 10 segundos, el valor mínimo es 1000 milisegundos y el valor máximo permitido es de 3 minutos, 180.000 milisegundos.
  6. Haga clic en Next (Siguiente) para especificar los detalles de la configuración de la solicitud . La página Request Configuration (Configuración de la solicitud) aparece como se muestra a continuación.
    1. Encabezados: los encabezados se clasifican principalmente como encabezados de solicitudes. Se deberán establecer los encabezados de la solicitud cuando se envíe la solicitud. Los encabezados especificados a nivel de instancia se rellenan automáticamente. Puede sobrescribir la configuración definida en el nivel de instancia o continuar utilizando la misma
    2. Ignore Global Header (Ignorar encabezados globales): si necesita sobrescribir la configuración definida en el nivel de instancia, seleccione Ignore Global Headers (Ignorar encabezados globales) y podrá agregar la variable y los valores específicos de la operación. 
      1. Introduzca el Campo externo y el Valor.


    3. Outbound Payload (Carga útil saliente): carga que debe pasarse a la aplicación externa. Form Data es la codificación predeterminada que usa un formulario web para transferir datos. El área del cuadro de texto acepta pares simples de clave-valor y JSON complejos o anidados. 
  7. Haga clic en Continuar para crear la configuración de la respuesta. La sección Response Configuration (Configuración de la respuesta) se utiliza para procesar los datos o la respuesta recibida del servicio web externo.

    • Inbound Mapping (Asignación de entrada): en esta sección, se pueden transformar los datos que se reciben como respuesta y asignarlos a Atributos de usuario local, global y personalizado. Estos datos, a su vez, se pueden utilizar en la generación de habilidades como operaciones de terceros, evaluación de reglas, definición de respuestas de bot y asignación de valores a los atributos personalizados del usuario. Hay dos formas de configurar los atributos. 
      • Set Attribute  (Establecer atributo): se utiliza para almacenar información en un atributo. Seleccione Set Attribute (Establecer atributo).
      • Transform  (Transformar): las funciones de transformación se utilizan cuando la información recibida de la integración debe someterse a una conversión antes de utilizarse en una operación o en la habilidad. 
        Por ejemplo, extraer el número de ticket del identificador del ticket recibido de un sistema ITSM y proporcionarlo a un cliente.  Luma proporciona una variedad de funciones de transformación para permitir a los desarrolladores de habilidades manipular los datos según sea necesario, como Dividir, Recortar, Subcadena, Reemplazar, Fecha y hora personalizada, etc.


        Para establecer la asignación de entrada, siga los pasos a continuación: 
        • Agregar 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 se asigna al atributo,por ejemplo, @{response.body}, @{response.code}.
          • Use Expression Type (Tipo de expresión) y JSONPath cuando un valor de la respuesta de JSON recibida se asignará al atributo, por ejemplo,  Expression (Expresión) apunta a una ruta de acceso a JSON.
          • 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
          • Utilice Expression Type (Tipo de expresión) → XPath cuando un valor que se asigna al atributo, es decir, Expression (Expresión), apunta a una ruta, por ejemplo, //AddResponse/AddResult.
        • Set Output to Attribute (Establecer salida en atributo): se utiliza para almacenar los datos.
          1. Scope (Alcance): representa el alcance del atributo que se utilizará para contener los valores entrantes.
            1. 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 durante la ejecución de las habilidades.
            2. 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. El valor de la variable local se conserva entre las solicitudes y se utiliza para pasar datos entre varias integraciones, mensajes de usuario o reglas. Si se utiliza después de una respuesta del bot, se pierde el valor del atributo Local.
            3. 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.
          2. Attribute (Atributo): es el nombre del atributo.
          3. Data Type (Tipo de dato): representa el tipo de dato del valor. Entero,  largo, booleano, etc.

        • Para utilizar la función Transformation (Transformación), utilice  Transform (Transformar) en Set Attribute (Establecer atributo). Para obtener más información sobre cómo utilizar las funciones de transformación, consulte  Usar las funciones de transformación

          • Cuando se agrega una operación al flujo de conversación de una habilidad, se pueden utilizar los atributos locales creados en las operaciones para generar la habilidad. Se puede hacer referencia a un atributo local como @{local.<Attribute identifier>}
          • Utilice los atributos de tipo XML para almacenar los datos XML recibidos desde la integración. Para hacer referencia a una lista/matriz de valores en una ruta XML, utilice el atributo de tipo LIST.
          • La expresión INDIRECT JSONPATH y INDIRECT XPATH se puede utilizar para asignar valores a los atributos de tipo JSON y XML.
    • Error Handling (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. 
       

      • 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:
        1. Es igual a
        2. No es igual a
        3. es mayor que
        4. es mayor o igual que
        5. es menor que
        6. es menor o igual que
        7. Comienza con
        8. No comienza con
        9. Termina con
        10. No termina con
        11. Contiene
        12. No contiene
        13. está vació
        14. no está vacío
        15. coincide con el patrón

    • No data Handling (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).

    • Success Handling (Manejo de operaciones correctas): esta sección sea utiliza para definir el comportamiento y la respuesta del bot al usuario cuando la ejecución de la operación se ha realizado correctamente. Cree múltiples reglas que gestionen satisfactoriamente las operaciones del servicio web. 

Editar aplicación

Para editar una aplicación:

  1. En el menú Tenant (Tenant), haga clic en Integrations (Integraciones).
  2. Todas las aplicaciones conectadas se enumeran como se muestra a continuación donde está disponible la opción para editar.
  3. Haga clic en el botón Edit (Editar) . Aparecerá la página Connected App (Aplicación conectada). 
  4. Aquí se pueden editar los detalles como el tipo de integración, la instancia predeterminada, la operación de inicio de sesión y la operación de cierre de sesión.
    Las operaciones Login (Iniciar sesión) y Logout (Cerrar sesión) son útiles cuando una funcionalidad/operación requiere una condición previa al inicio de sesión y posterior al cierre de sesión. 
    Por ejemplo, la operación de inicio de sesión y cierre de sesión se puede utilizar para el control de la sesión. Al ejecutar una operación a través de una habilidad, la operación de inicio de sesión generaría un token y reserva la sesión. Al finalizar la tarea, la operación de cierre de sesión liberará la sesión. Esto garantiza una utilización óptima de las sesiones asignadas al usuario de la API.

  5. Una vez seleccionadas las operaciones necesarias, haga clic en Update (Actualizar) para guardar los cambios.


  • No labels