ServiceNow conector V2.0 - Amazon Kendra

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ServiceNow conector V2.0

ServiceNow proporciona un sistema de administración de servicios basado en la nube para crear y administrar flujos de trabajo a nivel de organización, como los servicios de TI, los sistemas de emisión de tickets y el soporte. Puede utilizarlo Amazon Kendra para indexar sus ServiceNow catálogos, artículos de conocimiento, incidentes y sus archivos adjuntos.

Para solucionar problemas del conector de la fuente de Amazon Kendra ServiceNow datos, consulteSolución de problemas con los orígenes de datos.

Características admitidas

Amazon Kendra ServiceNow el conector de fuente de datos admite las siguientes funciones:

  • Asignaciones de campo

  • control de acceso de usuarios

  • Filtros de inclusión/exclusión

  • Sincronización de contenido completa e incremental

  • ServiceNow versiones de instancia: Roma, Sandiego, Tokio, otras

  • Nube privada virtual (VPC)

Requisitos previos

Antes de poder utilizarla Amazon Kendra para indexar la fuente de ServiceNow datos, realiza estos cambios en tus AWS cuentas ServiceNow y.

En ServiceNow, asegúrate de tener:

  • Ha creado una instancia de desarrollador personal o empresarial y dispone de una ServiceNow instancia con una función administrativa.

  • Ha copiado el host de la URL de la ServiceNow instancia. El formato de la URL del host que introduzca es your-domain.service-now.com. Necesitas la URL de tu ServiceNow instancia para conectarte Amazon Kendra.

  • Apuntó sus credenciales de autenticación básicas, es decir, un nombre de usuario y una contraseña Amazon Kendra para poder conectarse a la ServiceNow instancia.

    nota

    Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

  • Opcional: credenciales de cliente de OAuth 2.0 configuradas que pueden identificarse Amazon Kendra mediante un nombre de usuario, una contraseña y un identificador de cliente generado y un secreto de cliente. Consulte ServiceNow la documentación sobre la autenticación de OAuth 2.0 para obtener más información.

  • Comprobaste que cada documento es único en ServiceNow las demás fuentes de datos que planeas usar para el mismo índice y entre ellas. Cada origen de datos que desee utilizar para un índice no debe contener el mismo documento en varios orígenes de datos. Los ID de documento son globales para un índice y deben ser únicos por índice.

En el suyo Cuenta de AWS, asegúrese de tener:

  • Creó un Amazon Kendra índice y, si usa la API, anotó el ID del índice.

  • Creó un IAM rol para su fuente de datos y, si usa la API, anotó el ARN del IAM rol.

    nota

    Si cambias el tipo de autenticación y las credenciales, debes actualizar tu IAM rol para acceder al ID AWS Secrets Manager secreto correcto.

  • Guardó sus credenciales de ServiceNow autenticación en un AWS Secrets Manager secreto y, si usa la API, anotó el ARN del secreto.

    nota

    Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No se recomienda volver a utilizar las credenciales y los datos secretos en varios orígenes de datos ni en las versiones 1.0 y 2.0 del conector (si procede).

Si no tiene un IAM rol o secreto existente, puede usar la consola para crear un nuevo IAM rol y un Secrets Manager secreto al conectar su fuente de ServiceNow datos. Amazon Kendra Si utiliza la API, debe proporcionar el ARN de un IAM rol y un Secrets Manager secreto existentes y un ID de índice.

Instrucciones de conexión

Para conectarse Amazon Kendra a su fuente de ServiceNow datos, debe proporcionar los detalles necesarios de la fuente de ServiceNow datos para que Amazon Kendra pueda acceder a sus datos. Si aún no lo ha configurado ServiceNow , Amazon Kendra consulteRequisitos previos.

Console

Para conectarse Amazon Kendra a ServiceNow

  1. Inicie sesión en la Amazon Kendra consola AWS Management Console y ábrala.

  2. En el panel de navegación izquierdo, elija Índices y, a continuación, elija el índice que desee usar de la lista de índices.

    nota

    Puede elegir configurar o editar los ajustes de Control de acceso de usuarios en la Configuración del índice.

  3. En la página Introducción, seleccione Agregar origen de datos.

  4. En la página Agregar fuente de datos, elija el ServiceNow conector y, a continuación, elija Agregar conector. Si utiliza la versión 2 (si corresponde), elija el ServiceNow conector con la etiqueta «V2.0".

  5. En la página Especificar detalles del origen de datos, introduzca la siguiente información:

    1. En Nombre y descripción, en Nombre del origen de datos: introduzca un nombre para el origen de datos. Puede incluir guiones, pero no espacios.

    2. (Opcional) Descripción: introduzca una descripción opcional para el origen de datos.

    3. En el idioma predeterminado: elija un idioma para filtrar los documentos para el índice. A menos que especifique lo contrario, el idioma predeterminado es el inglés. El idioma especificado en los metadatos del documento anula el idioma seleccionado.

    4. En Etiquetas, para añadir una nueva etiqueta: incluya etiquetas opcionales para buscar y filtrar sus recursos o realizar un seguimiento de sus AWS costes.

    5. Elija Siguiente.

  6. En la página Definir acceso y seguridad, introduzca la siguiente información:

    1. ServiceNow host: introduzca la URL del ServiceNow host. El formato de la URL del host que introduzca es your-domain.service-now.com.

    2. ServiceNow versión: seleccione la versión de la ServiceNow instancia. Puede seleccionar entre Roma, Sandiego, Tokio u otros.

    3. Autorización: active o desactive la información de la lista de control de acceso (ACL) para sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

    4. Autenticación: elija entre la autenticación básica y la autenticación Oauth 2.0.

    5. AWS Secrets Manager secreto: elija un secreto existente o cree uno nuevo para almacenar sus Secrets Manager credenciales de autenticación. ServiceNow Si decide crear un secreto nuevo, se abrirá una ventana de secreto de AWS Secrets Manager . En la ventana, introduzca la siguiente información:

      1. Nombre del secreto: un nombre para su secreto. El prefijo 'AmazonKendra- ServiceNow -' se añade automáticamente a tu nombre secreto.

      2. Si utilizas la autenticación básica, introduce el nombre secreto, el nombre de usuario y la contraseña de tu cuenta. ServiceNow

        Si utilizas la autenticación OAuth2.0, introduce el nombre secreto, el nombre de usuario, la contraseña, el ID de cliente y el secreto de cliente que creaste en tu cuenta. ServiceNow

      3. Guarda y añade tu secreto.

    6. Nube privada virtual (VPC): puede optar por utilizar una VPC. Si es así, debe agregar Subredes y Grupos de seguridad de VPC.

    7. Rastreador de identidad: especifique si se debe activar el rastreador Amazon Kendra de identidad. El rastreador de identidades utiliza la información de la lista de control de acceso (ACL) de los documentos para filtrar los resultados de la búsqueda en función del acceso del usuario o de su grupo a los documentos. Si tiene una ACL para sus documentos y decide utilizarla, también puede optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda según el contexto del usuario. De lo contrario, si el rastreador de identidades está desactivado, se pueden realizar búsquedas públicas en todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar información de acceso de usuarios y grupos para filtrar el contexto de los usuarios.

    8. IAM rol: elija un IAM rol existente o cree uno nuevo IAM para acceder a las credenciales del repositorio y al contenido del índice.

      nota

      IAM los roles utilizados para los índices no se pueden usar para las fuentes de datos. Si no está seguro de si un rol existente se utiliza para un índice o para las preguntas frecuentes, elija Crear un nuevo rol para evitar errores.

    9. Elija Siguiente.

  7. En la página Configurar ajustes de sincronización, introduzca la siguiente información:

    1. En Artículos de Knowledge, elija entre las siguientes opciones:

      • Artículos de conocimiento: elija si desea indexar los artículos de conocimiento.

      • Archivos adjuntos de artículos de conocimiento: elija si desea indexar los archivos adjuntos de los artículos de conocimiento.

      • Tipo de artículos de conocimiento: elija entre Solo artículos públicos y artículos de conocimiento basados en una consulta de ServiceNow filtro según su caso de uso. Si selecciona Incluir artículos según una consulta de ServiceNow filtro, debe introducir una consulta de filtro copiada de su ServiceNow cuenta. Entre los ejemplos de consultas de filtro se incluye: workflow_state=draft^EQ, kb_knowledge_base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ, article_type=text^active=true^EQ.

        importante

        Si elige rastrear solo los artículos públicos, Amazon Kendra rastreará solo los artículos de conocimiento a los que se haya asignado una función de acceso público en. ServiceNow

      • Incluir artículos según el filtro de descripción breve: especifique patrones de expresión regular para incluir o excluir artículos específicos.

    2. En Elementos del catálogo de servicios:

      • Elementos del catálogo de servicios: elija si desea indexar los elementos del catálogo de servicios.

      • Archivos adjuntos de elementos del catálogo de servicios: elija si desea indexar los archivos adjuntos de los elementos del catálogo de servicios.

      • Elementos activos del catálogo de servicios: elija si desea indexar los elementos activos del catálogo de servicios.

      • Elementos inactivos del catálogo de servicios: elija si desea indexar los elementos inactivos del catálogo de servicios.

      • Consulta de filtrado: elija incluir los elementos del catálogo de servicios en función de un filtro definido en su instancia. ServiceNow Entre los ejemplos de consultas de filtro se incluye: short_descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ, nameSTARTSWITHService^active=true^EQ.

      • Incluir los elementos del catálogo de servicios según un filtro de descripción breve: especifique un patrón de regex para incluir elementos del catálogo específicos.

    3. En Incidentes:

      • Incidentes: elija si desea indexar los incidentes de servicio.

      • Archivos adjuntos de incidentes: elija si desea indexar los archivos adjuntos de incidentes.

      • Incidentes activos: elija si desea indexar los incidentes activos.

      • Incidentes inactivos: elija si desea indexar los incidentes inactivos.

      • Tipo de incidente activo: elija entre Todos los incidentes, Incidentes abiertos, Incidentes abiertos: no asignados e Incidentes resueltos, según el caso de uso.

      • Consulta de filtro: elija incluir los incidentes en función de un filtro definido en la instancia ServiceNow . Entre los ejemplos de consultas de filtro se incluye: short_descriptionLIKETest^urgency=3^state=1^EQ, priority=2^category=software^EQ.

      • Incluir incidentes según el filtro de descripción breve: especifique un patrón de regex para incluir incidentes específicos.

    4. En Configuración adicional:

      • Información de ACL: las listas de control de acceso de las entidades que ha seleccionado se incluyen de forma predeterminada. Al anular la selección de una lista de control de acceso, todos los archivos de esa categoría serán públicos. Las opciones de ACL se desactivan automáticamente para las entidades no seleccionadas. En el caso de los artículos públicos, no se aplica la ACL.

      • Para Tamaño máximo de archivo: especifique el límite de tamaño de archivo en MB que Amazon Kendra rastreará. Amazon Kendra rastreará solo los archivos dentro del límite de tamaño que usted defina. El tamaño predeterminado del archivo es de 50 MB. El tamaño máximo del archivo debe ser superior a 0 MB e inferior o igual a 50 MB.

      • Patrones de regex de archivos adjuntos: añada patrones de expresiones regulares para incluir o excluir determinados archivos adjuntos de catálogos, artículos de conocimiento e incidentes. Puede agregar hasta 100 patrones.

    5. Modo de sincronización: elija cómo desea actualizar el índice cuando cambie el contenido del origen de datos. Al sincronizar la fuente de datos Amazon Kendra por primera vez, todo el contenido se rastrea e indexa de forma predeterminada. Debes realizar una sincronización completa de los datos si la sincronización inicial ha fallado, incluso si no eliges la sincronización completa como opción de modo de sincronización.

      • Sincronización completa: indexa todo el contenido de forma inmediata y reemplaza el contenido existente cada vez que la fuente de datos se sincronice con el índice.

      • Sincronización nueva, modificada o eliminada: indexe solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

    6. En el programa de ejecución sincronizado, para Frecuencia: elija la frecuencia con la que desea sincronizar el contenido de la fuente de datos y actualizar el índice.

    7. Elija Siguiente.

  8. En la página Establecer asignaciones de campos, especifique la siguiente información:

    1. Asignaciones de campos predeterminadas: seleccione entre las fuentes de datos predeterminadas Amazon Kendra generadas los campos que desee asignar a su índice.

    2. Agregar campo: para agregar campos de origen de datos personalizados para crear un nombre de campo de índice al que asignarlos y el tipo de datos del campo.

    3. Elija Siguiente.

  9. En la página Revisar y crear, compruebe que la información que ha introducido es correcta y, a continuación, seleccione Añadir origen de datos. También puede elegir editar la información desde esta página. El origen de datos aparecerá en la página Orígenes de datos una vez que el origen de datos se haya agregado correctamente.

API

Para conectarse a Amazon Kendra ServiceNow

Debe especificar un JSON del esquema de la fuente de datos mediante la TemplateConfigurationAPI. Debe proporcionar la siguiente información:

  • Fuente de datos: especifique el tipo de fuente de datos como SERVICENOWV2 cuando utiliza el esquema TemplateConfigurationJSON. Especifique también la fuente de datos TEMPLATE al llamar a la CreateDataSourceAPI.

  • URL del host: especifique la versión de la instancia del ServiceNow host. Por ejemplo, your-domain.service-now.com.

  • Tipo de autenticación: especifique el tipo de autenticación que utiliza, ya sea OAuth2 para su ServiceNow instancia basicAuth o para ella.

  • ServiceNow versión de instancia: especifique la ServiceNow instancia que utiliza, Tokyo SandiegoRome, o. Others

  • Modo de sincronización: especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Al sincronizar la fuente de datos Amazon Kendra por primera vez, todo el contenido se rastrea e indexa de forma predeterminada. Debes realizar una sincronización completa de los datos si la sincronización inicial ha fallado, incluso si no eliges la sincronización completa como opción de modo de sincronización. Puede elegir entre las siguientes opciones:

    • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

    • FULL_CRAWLpara indexar solo el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • Nombre secreto de recurso de Amazon (ARN): proporcione el nombre de recurso de Amazon (ARN) de un Secrets Manager secreto que contenga las credenciales de autenticación que creó en su cuenta. ServiceNow

    Si utiliza la autenticación básica, el secreto se almacena en una estructura JSON con las siguientes claves:

    { "username": "user name", "password": "password" }
  • Si utiliza las credenciales de cliente de OAuth2, el secreto se almacena en una estructura JSON con las siguientes claves:

    { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
  • IAM rol: especifique RoleArn cuándo llama CreateDataSource para proporcionar a un IAM rol permisos para acceder a su Secrets Manager secreto y para llamar a las API públicas requeridas para el ServiceNow conector y. Amazon Kendra Para obtener más información, consulte las IAM funciones de las fuentes ServiceNow de datos.

También puede añadir las siguientes características opcionales:

  • Nube privada virtual (VPC): especifique a VpcConfiguration cuándo llamar a CreateDataSource. Para obtener más información, consulte Configuración Amazon Kendra para usar un Amazon VPC.

  • Filtros de inclusión y exclusión: puede especificar si desea incluir o excluir determinados archivos adjuntos mediante los nombres y tipos de archivos de los artículos de conocimiento, los catálogos de servicios y los incidentes.

    nota

    La mayoría de los orígenes de datos utilizan patrones de expresiones regulares, que son patrones de inclusión o exclusión denominados filtros. Si especifica un filtro de inclusión, solo se indexará el contenido que coincida con el filtro de inclusión. Los documentos que no coincidan con el filtro de inclusión no se indexan. Si especifica un filtro de inclusión y exclusión, los documentos que coincidan con el filtro de exclusión no se indexarán, aunque coincidan con el filtro de inclusión.

  • Documentos específicos para indexar: puede utilizar una ServiceNow consulta para especificar los documentos que desee de una o más bases de conocimiento, incluidas las bases de conocimiento privadas. El acceso a las bases de conocimiento lo determina el usuario que utilice para conectarse a la ServiceNow instancia. Para obtener más información, consulte Especificar documentos a indexar con una consulta.

  • Parámetros de indexación: también puede optar por especificar si desea:

    • Indexar artículos de conocimiento, catálogos de servicios e incidentes, o todos ellos. Si decide indexar artículos de conocimiento, artículos del catálogo de servicios e incidentes, debe proporcionar el nombre del ServiceNow campo que se asigna al campo de contenido del documento de Amazon Kendra índice del índice.

    • Indexar los archivos adjuntos de los artículos de conocimiento, los elementos del catálogo de servicios y los incidentes.

    • Incluir artículos de conocimiento, elementos del catálogo de servicios e incidentes según el patrón de filtrado short description.

    • Elegir filtrar los elementos e incidentes del catálogo de servicios activos e inactivos.

    • Elegir filtrar los incidentes en función de su tipo.

    • Elegir de qué entidades se debe rastrear la ACL.

    • Puede utilizar una ServiceNow consulta para especificar los documentos que desee de una o más bases de conocimiento, incluidas las bases de conocimiento privadas. El acceso a las bases de conocimiento lo determina el usuario que utilice para conectarse a la ServiceNow instancia. Para obtener más información, consulte Especificar documentos a indexar con una consulta.

  • Rastreador de identidad: especifique si se debe activar el rastreador Amazon Kendra de identidad. El rastreador de identidades utiliza la información de la lista de control de acceso (ACL) de los documentos para filtrar los resultados de la búsqueda en función del acceso del usuario o de su grupo a los documentos. Si tiene una ACL para sus documentos y decide utilizarla, también puede optar por activar el rastreador de identidades para configurar el filtrado Amazon Kendra de los resultados de búsqueda según el contexto del usuario. De lo contrario, si el rastreador de identidades está desactivado, se pueden realizar búsquedas públicas en todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar información de acceso de usuarios y grupos para filtrar el contexto de los usuarios.

  • Asignaciones de campos: elija asignar los campos de la fuente de ServiceNow datos a los campos de índice. Amazon Kendra Para obtener más información, consulte Asignación de campos de origen de datos.

    nota

    El campo del cuerpo del documento o el cuerpo del documento equivalente de sus documentos es obligatorio Amazon Kendra para poder buscarlos. Debe asignar el nombre del campo del cuerpo del documento en la fuente de datos al nombre del campo de índice_document_body. Todos los demás campos son opcionales.

Para ver una lista de otras claves JSON importantes que debes configurar, consulta el esquema ServiceNow de la plantilla.

Más información

Para obtener más información sobre la integración Amazon Kendra con su fuente de ServiceNow datos, consulte: