ServiceNow

Contact Center AI Platform (CCAI Platform) proporciona integración en el CRM de ServiceNow.

Configuración para desarrolladores de ServiceNow

Requisitos mínimos preferidos de la versión de ServiceNow: Tokyo patch 1

Configura un usuario de autenticación básica

Es probable que la cuenta de administrador de ServiceNow tenga habilitada la verificación en 2 pasos y esté asociada a ese usuario. Como resultado, no se puede usar para obtener acceso de administrador en CCAI Platform. Para ello, debes crear una cuenta de usuario en ServiceNow.

Crea un usuario básico con credenciales:

  1. Ve a Usuario > Nuevo.

  2. Completa los detalles y selecciona Web service access only.

  3. Anota el ID de usuario y la contraseña.

Roles obligatorios en ServiceNow

Los roles predeterminados en ServiceNow están preconfigurados para proporcionar acceso y permisos específicos dentro de la plataforma. Los administradores pueden crear y configurar roles que otorguen permisos específicos, que rigen lo que pueden hacer los usuarios y grupos con ese rol.

Para realizar esta integración, debes tener los siguientes roles en ServiceNow:

  • user_admin: Este rol está diseñado para administradores que necesitan administrar usuarios, grupos, ubicaciones y empresas dentro de la instancia de ServiceNow.

  • sn_incident_read: Este rol proporciona acceso de solo lectura a la aplicación de administración de incidentes y sus funciones relacionadas. Permite que los usuarios vean los registros de incidentes.

  • sn_incident_write: Este rol otorga acceso de escritura a la aplicación de administración de incidentes y sus funciones relacionadas, lo que permite a los usuarios crear y modificar registros de incidentes.

  • personalize_dictionary: Este rol permite personalizar las entradas y etiquetas del diccionario para cumplir con requisitos empresariales específicos.

  • function_field_admin: Este rol está destinado a los usuarios que necesitan crear, editar y ver campos de funciones específicamente en el diseñador de informes. No proporciona la capacidad de crear o borrar campos de función desde la lista o el formulario de la plataforma.

Configura vistas de instancias

En las siguientes secciones, se describen los cambios de configuración necesarios para crear instancias de vistas.

Agrega favoritos (opcional)

Los favoritos son una forma rápida de encontrar los vínculos de uso frecuente en la instancia de ServiceNow. Para agregar un favorito, selecciona el ícono de estrella junto a un campo en el panel Navegador. Si más adelante quieres filtrar el panel de navegación para ver solo tus favoritos, puedes seleccionar el ícono de estrella que se encuentra directamente debajo del campo de filtro en el panel de navegación.

Estos son algunos ejemplos de favoritos útiles:

  • Incidentes: Asociaciones a registros para CRM personalizado.

  • Usuarios: Asociaciones a cuentas para CRM personalizado.

  • Explorador de APIs de REST: Es una buena forma de probar la API.

Agrega campos personalizados de forma manual

Selecciona el ícono de expansión (3 líneas horizontales) en la esquina superior izquierda dentro de la vista de objeto que deseas cambiar. Puedes hacerlo en la vista de autoservicio o en la vista predeterminada.

  1. En el menú, selecciona Configure > Form Design para abrir el diseñador de formularios.

  2. En la columna de la izquierda, selecciona la pestaña Tipos de campo.

  3. Arrastra el tipo de campo personalizado que quieras agregar.

  4. Después de soltar el tipo de campo en la sección que desees, selecciona el ícono de ajustes para ver la Configuración.

  5. Dentro de la ventana, cambia la etiqueta y toma nota del nombre. El nombre es lo que usas en la configuración de la app de CCAI Platform.

  6. Selecciona Guardar en la esquina superior derecha de la pantalla.

Asigna datos de la sesión al CRM

Debes asignar los datos de sesión adecuados de CCAIP con Dialogflow y usar los siguientes parámetros:

Datos del agente virtual

{
  "ujet": {
    "session_variable": {
      "capture_target": "payload",
      "payload": {
        "value_one": "$session.params.payload_value_one"
      };
      "capture_type": [ "comment", "field" ] // optional, default of ["comment"]
    }
  }
}

Metadatos

https://INSTANCE.service-now.com/api/now/table/sys_dictionary?sysparm_query=name%3Dsys_user https://INSTANCE.service-now.com/api/now/table/sys_dictionary?sysparm_query=name%3Dincident

Etiqueta: column_label

Clave de API: element

Los campos personalizados están en el mismo nivel que los campos estándar en la respuesta de sys_user o incident.

Sube un archivo de CCAI Platform al CRM

https://INSTANCE_URL.service-now.com/api/now/attachment/upload

Método: POST

Formato de los datos de la solicitud: property

Ubicación de los datos de respuesta: data.result

Tipo: Multi-part form

Tipo de archivo adjunto: Attachment Url

URL del archivo adjunto: download_link

Parámetros: table below

Ejemplo de solicitud:

{
    file: FILE_DATA,
    table_name: incident,
    table_sys_id: RECORD_ID
}

Integra adaptadores de agentes (formularios personalizados)

En los siguientes pasos, se explica cómo habilitar los adaptadores de agentes y la función de clic para llamar en la instancia de ServiceNow.

Instala y configura OpenFrame

  1. Navega a Todos > Aplicaciones del sistema > Todas las aplicaciones disponibles > Todos.

  2. Busca OpenFrame.

  3. Instala OpenFrame.

  4. Después de la instalación, navega a All > OpenFrame > Configurations.

  5. Crea una configuración con una URL. Si tienes varios parámetros de configuración dentro de una instancia de ServiceNow, es posible que tu usuario no tenga acceso a un parámetro de configuración recién creado. Verifica tus grupos y la lista de pedidos de configuración de OpenFrame para determinar qué configuración está usando tu usuario.

  6. Escribe sys_properties.list en la búsqueda.

  7. Editar glide.ui.concourse.onmessage_enforce_same_origin_whitelist.

  8. Agrega la URL nueva a la lista de valores.

  9. Editar sn_openframe.cross.origin.access.

  10. Agrega autoplay a la lista de valores.

Habilita la experiencia de la IU de Next para los usuarios

  1. Escribe sys_properties.list en la barra de navegación y presiona Intro.

  2. Establece la propiedad del sistema glide.ui.polaris.experience en true.

  3. Establece la preferencia del usuario glide.ui.polaris.use en false para el sistema.

  4. Establece la preferencia de usuario glide.ui.polaris.use en true para un usuario. (Puedes crear una fila de preferencias del usuario).

Actualiza las propiedades del sistema

  1. Ingresa sys_properties.list en la barra de navegación y presiona Intro.

  2. Editar glide.ui.concourse.onmessage_enforce_same_origin_whitelist.

  3. Agrega la URL a la lista de valores. Los valores múltiples deben estar separados por comas.

  4. Editar sn_openframe.cross.origin.access.

  5. Agrega autoplay a la lista de valores.

  6. Editar glide.ui.polaris.experience.

  7. Cámbialo a false, ya que algunas funciones no se ejecutan si está habilitado.

Agrega la función de clic para llamar en la parte superior del formulario

  1. Navega a IU del sistema > Acciones de la IU.

  2. Selecciona Crear acción nueva.

  3. En el formulario, como se ilustra, selecciona la tabla de la que formará parte esta función de clic para llamar.

  4. En el caso de los formularios con una referencia a un contacto o usuario, usa la API de g_form.getReference para acceder al número de teléfono del usuario. En el caso de las tablas personalizadas, el ID de referencia y los atributos resultantes pueden variar. La comunicación con CCAI Platform será la misma, por lo que la carga útil y la estructura de datos deben ser idénticas a las siguientes:

    function clickToDial() {
      var user = g_form.getReference('caller_id',function(res) {
        var phone = res.phone || res.mobile_phone;
        var payload = {"name": "clicktodial", "number": phone};
        var data = {"payload": payload, "method": "openframe_communication" };
        CustomEvent.fireAll("openframe_request", data);
      });
    }
    
  5. En el caso de los formularios que incluyen un número para llamar, usa la API de g_form.getValue para recuperar los valores pertinentes. Este es un ejemplo de la acción de la IU para la tabla Users. En el caso de las tablas personalizadas, los nombres de los campos del formulario pueden variar. La comunicación con CCAI Platform será la misma, por lo que la carga útil y la estructura de datos deben permanecer idénticas a las siguientes:

    function clickToDial() {
      var phone = g_form.getValue('phone') || g_form.getValue('mobile_phone');
      var payload = {"name": "clicktodial", "number": phone};
      var context = {"payload": payload, "method" : "openframe_communication" };
      CustomEvent.fireAll("openframe_request", context);
    }
    

Agrega la función de hacer clic para llamar junto a las referencias

  1. El botón de llamada junto a las referencias a los contactos se debe editar dentro del formulario. Haz clic con el botón derecho en el campo y navega a Configure Dictionary. Para los atributos, agrega el valor show_phone o show_phone_customer_service al valor ref_contributions.

  2. En UI Macros, edita show_phone y show_phone_customer_service.

  3. Reemplaza lo siguiente:

Anterior:

var task =    {"entity": p.attr('data-task-table'), "query" :"sys_id="+p.attr('data-task-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-task-value'),"label":p.attr('data-task-label')};
                                        var company = {"entity": p.attr('data-company-table'),"query":"sys_id="+p.attr('data-company-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-company-value'),"label":p.attr('data-company-label')};
                                        var caller = {"entity": p.attr('data-caller-table'),"query": "sys_id="+p.attr('data-caller-id')+"$[AMP]sysparm_view="+p.attr('data-task-view'),"value":p.attr('data-caller-value'),"label":p.attr('data-caller-label')};

                                        var callContext = [];
                                        callContext.push(task);
                                        callContext.push(company);
                                        callContext.push(caller);

                                        var metaData = {"phoneNumber":p.attr('data-caller-phone'),"taskId":p.attr('data-task-id')};

                                        var data =    {"metaData":metaData , "data": callContext};
                                        var payload = {"type": "OUTGOING_CALL", "data" : data};
                                        var createInteractionData ={};
                                        createInteractionData.interactionSysId = -1;
                                        createInteractionData.direction = 'outbound';
                                        createInteractionData.context_document = p.attr('data-task-id');
                                        createInteractionData.context_table = p.attr('data-task-table');
                                        createInteractionData.account = p.attr('data-company-id');
                                        if(p.attr('data-caller-table') === 'customer_contact')
                                                createInteractionData.contact = p.attr('data-caller-id');
                                        createInteractionData.opened_for = p.attr('data-caller-id');

                                        var ga = new GlideAjax('sn_openframe.OpenFrameAjaxUtility');
                                        ga.addParam('sysparm_name', 'createInteractionWithPropertyCheck');
                                        ga.addParam('context', JSON.stringify(createInteractionData));
                                        ga.getXML(function(serverResponse) {
                                                var result = serverResponse.responseXML.getElementsByTagName("result");
                                                var output = JSON.parse(result[0].getAttribute("data"));
                                                if(output.status == "success"){
                                                        var interaction = {"entity": "interaction", "query" :"sys_id="+output.fields.interactionSysId, "value":output.fields.number, "label":"Interaction", "display":false};
                                                        payload.data.data.push(interaction);
                                                }
                                                var context = {"payload": payload, "method" : "openframe_communication" };
                                                jslog("context with interaction : "+ JSON.stringify(context));
                                                CustomEvent.fireAll("openframe_request", context);
                                        });

Nuevo:

var phone = p.attr('data-caller-phone')
                   var payload = {"name": "clicktodial", "number": phone};
                   var data = {"payload": payload, "method": "openframe_communication" };
                   CustomEvent.fireAll("openframe_request", data);

Configuración de CRM

En los siguientes pasos, se ilustra cómo conectar la API a ServiceNow con el portal de CCAI Platform.

  1. En el portal de CCAI Platform, navega a Configuración > Configuración para desarrolladores > CRM.

  2. En la sección Agent Platform, selecciona ServiceNow.

  3. Ingresa la información de tu dominio de ServiceNow en el campo Dominio de ServiceNow. Esta puede ser una instancia de desarrollador o de proveedor, según sea necesario, pero es una correlación directa con la instancia y es la primera parte de la URL en la dirección web del portal de ServiceNow: https://{your instance}.servicenow.com.

  4. En el campo ServiceNow Cloud Selection, selecciona Incident para un tipo de ticket básico. Si seleccionas Custom, aparecerán opciones adicionales. Los incidentes son extensiones de la tabla de tareas; los objetos personalizados deben ser extensiones de los incidentes.

  5. En los campos Credenciales de autenticación, ingresa tu nombre de usuario y contraseña.

  6. Si seleccionaste Incident para el tipo de campo de selección de nube, verás los siguientes campos:

    • Lookup account object incluye tres campos desplegables: Object Type, Phone Number lookup fields y Phone number primary field.
  7. Si seleccionaste Custom para el tipo de campo de selección de nube, verás los siguientes campos:

    • Objeto de registro de búsqueda:

      • Tipo de objeto de registro base: Selecciona un tipo de tabla task o incident.

      • Tipo de objeto de registro: Este campo se completará con datos si se extendió una tabla de incidentes, y puedes seleccionarlo si es necesario.

      • Lookup account object incluye tres campos desplegables: Object Type, Phone Number lookup fields y Phone number primary field.

  8. Campos de ID de usuario personalizados: Marca esta casilla si quieres habilitar los campos de búsqueda de usuarios personalizados para las sesiones del SDK web o para dispositivos móviles, o de la API de Apps (Chat).

  9. Formato de número de teléfono: Te permite seleccionar el formato que deseas usar para mostrar los números de teléfono.

  10. Archivo de metadatos de la sesión: Marca esta casilla para adjuntar metadatos de la sesión a los registros de CRM.

  11. Haz clic en Guardar para guardar las selecciones.

Campos personalizados para registros

Estos son los campos personalizados que ya se crearon para la instancia de ServiceNow en el diseñador de formularios y que se pueden usar en CCAI Platform. También puedes crear otros campos personalizados seleccionando Create en la sección Campos personalizados para registros del menú.

Campo Tipo Definición
u_ujet_custom_field_after_call_work String Duración de las tareas después de la llamada
u_ujet_custom_field_call_duration String Duración de la llamada
u_ujet_custom_field_comm_id Número entero ID de llamada o chat según el tipo de contacto
u_ujet_custom_field_rating Número entero Puntuación de Satisfacción del cliente (CSAT)
u_ujet_custom_field_email_via_web String Correo electrónico enviado desde la Web
u_ujet_custom_field_feedback String Comentarios
u_ujet_custom_field_from_phone_number String Número de teléfono del emisor
u_ujet_custom_field_hold_duration String Tiempo total de espera
u_ujet_custom_field_menu_path String Selección del menú
u_ujet_custom_field_queue_name String Nombre de la tarea en cola
u_ujet_custom_field_session_type String Tipo de sesión
u_ujet_custom_field_verification Verdadero o falso Confirma que se completó la verificación
u_ujet_custom_field_wait_time String Tiempo total de espera

Configura OAuth

Para configurar OAuth, sigue los pasos para crear una aplicación de OAuth en ServiceNow. Luego, ingresa las credenciales (ID de cliente de OAuth y secreto del cliente de OAuth) en Configuración para desarrolladores > CRM > Método de autenticación.

Crea una aplicación de OAuth en ServiceNow

  1. En tu cuenta de ServiceNow, navega a Todos > System OAuth > Registro de aplicaciones.

  2. Crea una aplicación de OAuth y selecciona Crear un extremo de API de OAuth para clientes externos.

  3. Configura los siguientes campos:

    • Nombre: Ingresa un nombre único.

    • ID de cliente: El servidor de OAuth de ServiceNow genera automáticamente el ID de cliente.

    • Secreto del cliente: Es el secreto del cliente para la aplicación de OAuth. Déjalo vacío para que se genere automáticamente.

    • Vida útil del token de actualización: Es el tiempo, en segundos, que el token de actualización será válido.

    • Vida útil del token de acceso: Es el tiempo, en segundos, que el token de acceso será válido.

    • URL de redireccionamiento: Ingresa la URL de tu entorno más el subdirectorio. Por ejemplo: https://servicenow.yourcompany.co/v1/servicenow/oauth_callback

    • Aplicar restricción de token: Restringe el uso del token de acceso a las APIs definidas en las políticas de acceso a la API de REST que se encuentran en la documentación de ServiceNow. Si anulas la selección de esta opción, se permitirá el uso de tokens de acceso en otras APIs de REST.

  4. Haz clic en Enviar.

  5. Después de crear la aplicación, vuelve al registro y recupera el ID de cliente y el secreto del cliente recién creado.

Actualiza la configuración en la configuración para desarrolladores

  1. Navega a Configuración para desarrolladores > CRM.

  2. Asegúrate de que los parámetros de configuración se ingresen y establezcan según los pasos anteriores.

  3. En el método de autenticación, haz clic en OAuth.

  4. Ingresa el ID de cliente de OAuth y el secreto del cliente de OAuth. (Consulta el paso 5 más arriba).

  5. Haz clic en Guardar.

  6. Haz clic en vincular credenciales.

Asignación de campos personalizados para el agente virtual

Si usas el agente virtual, configura este campo en la pantalla Asignaciones de campos personalizados. Esto permite que las variables del agente virtual se transfieran de la carga útil de la sesión del agente virtual a ServiceNow. Los nombres de las variables pueden ser cualquier cadena. Las etiquetas de campo que se indican aquí son un ejemplo.

En la pantalla Asignaciones de campos personalizados, configura la conexión entre las variables creadas por las definiciones de carga útil que usaste en la configuración inicial del agente virtual y la variable relevante dentro de ServiceNow.

Título de la asignación de campos Etiqueta de campo de CRM Etiqueta de campo de datos personalizado
Comentarios sobre el agente virtual ccaip_custom_field_incident_feedback va_feedback

Agregar asignación de campos de CRM

  1. Ve a Configuración > Administración de operaciones.

  2. Ve a la sección Asignación de campos personalizados de CRM > haz clic en Ver todo.

  3. Haz clic en el vínculo + Agregar asignación de campos de CRM.

    • Título de la asignación de campos: Es el nombre de CCAI Platform para esta asignación de campos personalizados que se usa en el portal de CCAI Platform.

    • Etiqueta del campo de CRM: Es la etiqueta dentro de tu CRM del campo de CRM al que estás asignando los datos.

    • Etiqueta de campo de datos personalizados (clave de datos personalizados): Es el nombre de la clave de nivel superior en la carga útil de datos personalizados de CCAI Platform desde la que deseas realizar la asignación (por ejemplo, device para cargas útiles de SDK o orderId para cargas útiles de chat de la API de Apps). Esta clave debe enviarse a través de los SDK web o para dispositivos móviles de CCAI Platform o (en el caso de las interacciones de chat) con el endpoint Send custom data in a chat de la API de Apps. La clave debe coincidir exactamente (incluido el uso de mayúsculas).

  4. Haz clic en Guardar.

Establece otros parámetros de configuración

Encontrarás los otros parámetros de configuración que te permitirán integrar correctamente CCAI Platform en tu instancia de ServiceNow en el menú desplegable Configuración. Consulta los vínculos de la siguiente lista para obtener más información sobre cómo configurar cada sección.

Resultados de la prueba

Ahora puedes verificar la funcionalidad de tus flujos de llamadas y chats haciendo clic en los botones correspondientes en la parte superior de la pantalla del portal de CCAI Platform. Es importante que te asegures de que el bloqueador de ventanas emergentes esté inhabilitado cuando ejecutes esta prueba.

Deberías esperar que se cree un incidente en ServiceNow, con el contacto de llamada o chat que aparece en la sección Actividades del incidente. Esto debería aparecer como una nota de trabajo, en lugar de un comentario de incidente, para que esta actividad de backend no sea visible para los clientes.

La descripción del caso se completará automáticamente con "Llamar con CCAI Platform" o "Chatear con CCAI Platform", y es posible que los agentes deban actualizarla.

Una vez que estés conforme con los resultados de la llamada o el chat, puedes ingresar un código de resolución y una nota (si se configuraron los campos de código de resolución y notas de ServiceNow) y, luego, cerrar el caso.

Para verificar que el caso se haya cerrado, es posible que debas hacer clic en el botón de navegación back en tu navegador. En la instancia de ServiceNow, se espera que, después de resolver el caso, este se cierre automáticamente y se te dirija a la página de registro del cliente.