Salesforce Connector V1.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.

Salesforce Connector V1.0

Salesforce es una herramienta de gestión de relaciones con los clientes (CRM) para gestionar los equipos de soporte, ventas y marketing. Puede utilizarla Amazon Kendra para indexar sus objetos estándar de Salesforce e incluso objetos personalizados.

importante

Amazon Kendra utiliza la API versión 48 de Salesforce. Salesforce API limita la cantidad de solicitudes que puede realizar por día. Si Salesforce supera esas solicitudes, lo volverá a intentar hasta que pueda continuar.

nota

El conector V1.0 de Salesforce SalesforceConfiguration API finalizó en 2023. Recomendamos migrar al conector V2.0/de Salesforce o usarlo. TemplateConfiguration API

Para solucionar problemas de su conector de fuente de datos de Amazon Kendra Salesforce, consulte. Solución de problemas con los orígenes de datos

Características admitidas

Amazon Kendra El conector de fuente de datos de Salesforce admite las siguientes funciones:

  • Asignaciones de campo

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

Requisitos previos

Antes de poder utilizarla Amazon Kendra para indexar su fuente de datos de Salesforce, realice estos cambios en Salesforce y AWS en sus cuentas.

En Salesforce, asegúrese de que:

  • Ha creado una cuenta de Salesforce y ha anotado el nombre de usuario y la contraseña que utiliza para conectarse a Salesforce.

  • Ha creado una cuenta de Salesforce Connected App OAuth con la clave de consumidor (ID de cliente) y el secreto de consumidor (secreto de cliente) asignados a su aplicación Salesforce Connected. El ID de cliente y el secreto del cliente se utilizan como credenciales de autenticación almacenadas en un AWS Secrets Manager secreto. Consulte la Documentación de Salesforce sobre aplicaciones conectadas para obtener más información.

    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).

  • Ha copiado el token de seguridad de Salesforce asociado a la cuenta utilizada para conectarse a Salesforce.

  • Se ha copiado la instancia URL de Salesforce que desea indexar. Por lo general, esto es https://<company>.salesforce.com/. El servidor debe ejecutar una aplicación conectada a Salesforce.

  • Se agregaron credenciales a su servidor de Salesforce para un usuario con acceso de solo lectura a Salesforce. Para ello, clonó el ReadOnly perfil y, a continuación, agregó los permisos Ver todos los datos y Administrar artículos. Estas credenciales identifican al usuario que realiza la conexión y a la aplicación conectada de Salesforce a la que se conecta. Amazon Kendra

  • Ha comprobado que cada documento es único en Salesforce y en otros orígenes de datos que vaya a utilizar para el mismo índice. Cada origen de datos que desee utilizar para un índice no debe contener el mismo documento en varios orígenes de datos. IDsLos documentos son globales en relación con un índice y deben ser únicos por índice.

En el tuyo Cuenta de AWS, asegúrate de tener:

  • Creó un Amazon Kendra índice y, si lo usaAPI, anotó el ID del índice.

  • Creó un IAM rol para la fuente de datos yAPI, si lo usó, anotó el ARN 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 autenticación de Salesforce en un AWS Secrets Manager secreto y, si las usóAPI, anotó el ARN 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 datos de Salesforce. Amazon Kendra Si utiliza elAPI, debe proporcionar el IAM rol y el ARN Secrets Manager secreto existentes y un ID de índice.

Instrucciones de conexión

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

Console

Para conectarse a Amazon Kendra Salesforce

  1. Inicie sesión en la consola AWS de administración y abra la Amazon Kendra consola.

  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 origen de datos, seleccione Salesforce Connector V1.0 y, a continuación, seleccione Añadir conector.

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

    1. Nombre de 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. Idioma predeterminado: 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 anula el idioma seleccionado.

    4. Agregar nueva etiqueta: etiquetas para buscar y filtrar los recursos o hacer un seguimiento de los costos compartidos.

    5. Elija Next (Siguiente).

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

    1. Salesforce URL: introduzca la instancia del sitio URL de Salesforce que desea indexar.

    2. En Tipo de autenticación, elija entre Existente y Nuevo para almacenar las credenciales de autenticación de Salesforce. Si decide crear un secreto nuevo, se abrirá una ventana AWS Secrets Manager secreta.

      1. Introduzca la siguiente información en la ventana Crear un secreto de AWS Secrets Manager :

        1. Nombre del secreto: un nombre para su secreto. El prefijo «AmazonKendra-Salesforce-» se añade automáticamente a su nombre secreto.

        2. Para el nombre de usuario, la contraseña, el token de seguridad, la clave de consumidor, el secreto del consumidor y la autenticación, URL introduzca los valores de las credenciales de autenticación que creó en su cuenta de Salesforce.

        3. Seleccione Guardar autenticación.

    3. IAM rol: elija un IAM rol existente o cree uno nuevo IAM para acceder a las credenciales de su 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 se utiliza un rol existente para un índiceFAQ, o bien, elija Crear un nuevo rol para evitar errores.

    4. Elija Next (Siguiente).

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

    1. En Rastrear archivos adjuntos: seleccione esta opción para rastrear todos los objetos, artículos y feeds adjuntos.

    2. En Objetos estándar, Artículos de conocimiento y Fuente de chat, seleccione las entidades o los tipos de contenido de Salesforce que desee rastrear.

      nota

      Debe proporcionar información de configuración para indexar al menos uno de los objetos estándar, artículos de conocimiento o fuentes de chat. Si decide rastrear los Artículos de conocimiento, debe especificar los tipos de artículos de conocimiento que desea indexar, el nombre de los artículos y si desea indexar los campos estándar de todos los artículos de conocimiento o solo los campos de un tipo de artículo personalizado. Si decide indexar artículos personalizados, debe especificar el nombre interno del tipo de artículo. Puede especificar hasta 10 tipos de artículos.

    3. Frecuencia: la frecuencia con la Amazon Kendra que se sincronizará con la fuente de datos.

    4. Elija Next (Siguiente).

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

    1. Para ver el artículo de conocimiento estándar, los archivos adjuntos a objetos estándar y las asignaciones de campos sugeridas adicionales, seleccione entre los campos de fuentes de datos predeterminados Amazon Kendra generados que desee asignar a su índice.

      nota

      Es necesaria una asignación de índice a _document_body. No puede cambiar la asignación entre el campo Salesforce ID y el campo _document_id de Amazon Kendra .

    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 Next (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 Salesforce Amazon Kendra

Debe especificar lo siguiente: SalesforceConfigurationAPI

  • Servidor URL: la instancia URL del sitio de Salesforce que desea indexar.

  • Nombre secreto del recurso de Amazon (ARN): proporcione el nombre del recurso de Amazon (ARN) de un Secrets Manager secreto que contenga las credenciales de autenticación de su cuenta de Salesforce. El secreto se almacena en una JSON estructura con las siguientes claves:

    { "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token", "consumerKey": "Application public key generated when you created your Salesforce application", "consumerSecret": "Application private key generated when you created your Salesforce application.", "password": "Password associated with the user logging in to the Salesforce instance", "securityToken": "Token associated with the user account logging in to the Salesforce instance", "username": "User name of the user logging in to the Salesforce instance" }
  • 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 al público requerido APIs para el conector de Salesforce y. Amazon Kendra Para obtener más información, consulte Roles de IAM para orígenes de datos de Salesforce.

  • Debe proporcionar información de configuración para indexar al menos uno de los objetos estándar, artículos de conocimiento o fuentes de chat.

    • Objetos estándar: si decide rastrear los Objetos estándar, debe especificar el nombre del objeto estándar y el nombre del campo de la tabla de objetos estándar que contiene el contenido del documento.

    • Artículos de conocimiento: si decide rastrear los Artículos de conocimiento, debe especificar los tipos de artículos de conocimiento que desea indexar, los estados de los artículos de conocimiento que desea indexar y si quiere indexar los campos estándar de todos los artículos de conocimiento o solo los campos de un tipo de artículo personalizado.

    • Fuentes de Chatter: si decide rastrear las fuentes de Chatter, debe especificar el nombre de la columna de la FeedItem tabla de Salesforce que contiene el contenido que se va a indexar.

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

  • Filtros de inclusión y exclusión: especifique si desea incluir o excluir determinados archivos adjuntos.

    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.

  • Asignaciones de campos: elija asignar los campos del origen de datos de Salesforce a los campos de índice de 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 para Amazon Kendra 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.

  • Filtrado por contexto de usuario y control de acceso:Amazon Kendra rastrea la lista de control de acceso (ACL) de sus documentos, si tiene una lista ACL para ellos. La ACL información se utiliza para filtrar los resultados de la 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.