Salesforce Connector V1.0 - Amazon Kendra
Características admitidasRequisitos previosInstrucciones de conexión

Salesforce Connector V1.0

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

importante

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

nota

El conector de Salesforce V1.0 y la API de SalesforceConfiguration finalizaron en 2023. Recomendamos migrar o utilizar Salesforce Connector V2.0 / la API TemplateConfiguration.

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

Características admitidas

El conector de origen de datos de Salesforce de Amazon Kendra admite las siguientes características:

  • Asignaciones de campos

  • Control de acceso de usuarios

  • Filtros de inclusión/exclusión

Requisitos previos

Antes de poder utilizar Amazon Kendra para indexar el origen de datos de Salesforce, realice estos cambios en sus cuentas de Salesforce y AWS.

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 la aplicación Salesforce Connected con OAuth activada y ha copiado la clave de consumidor (ID de cliente) y el secreto de consumidor (secreto de cliente) asignados a la aplicación Salesforce Connected. El ID y el secreto de cliente se utilizan como credenciales de autenticación almacenadas en un secreto de AWS Secrets Manager. 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.

  • Ha copiado la URL de la instancia de Salesforce que desea indexar. Normalmente, es https://<company>.salesforce.com/. El servidor debe ejecutar una aplicación conectada de Salesforce.

  • Ha añadido credenciales a su servidor de Salesforce para un usuario con acceso de solo lectura a Salesforce clonando el perfil ReadOnly y, a continuación, agregando los permisos View All Data y Manage Articles. 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. Los ID de documento son globales para un índice y deben ser únicos por índice.

En su Cuenta de AWS, asegúrese de que:

  • Ha creado un índice de Amazon Kendra y, si usa la API, ha anotado el ID del índice.

  • Ha creado un rol de IAM para el origen de datos y, si usa la API, ha anotado el ARN del rol de IAM.

    nota

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

  • Ha guardado sus credenciales de autenticación de Salesforce en un secreto de AWS Secrets Manager y, si utiliza la API, ha anotado 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 rol o secreto de IAM existente, puede usar la consola para crear un nuevo rol de IAM y secreto de Secrets Manager al conectar el origen de datos de Salesforce a Amazon Kendra. Si utiliza la API, debe proporcionar el ARN de un rol de IAM y un secreto de Secrets Manager existentes y un ID de índice.

Instrucciones de conexión

Para conectar Amazon Kendra al origen de datos de Salesforce, debe proporcionar los detalles necesarios del origen de datos de Salesforce para que Amazon Kendra pueda acceder a los datos. Si aún no ha configurado Salesforce para Amazon Kendra, consulte Requisitos previos.

Console

Para conectar Amazon Kendra a Salesforce

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

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

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

    1. URL de Salesforce: introduzca la URL de la instancia para el sitio 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 de secreto de AWS Secrets Manager.

      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 al nombre del secreto.

        2. En Nombre de usuario, Contraseña, Token de seguridad, Clave de consumidor, Secreto del consumidor y URL de autenticación: introduzca los valores de las credenciales de autenticación que creó en la cuenta de Salesforce.

        3. Seleccione Guardar autenticación.

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

      nota

      Los roles de IAM utilizados para los índices no se pueden usar para los orígenes 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.

    4. Elija 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 que Amazon Kendra se sincronizará con el origen de datos.

    4. Elija Siguiente.

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

    1. En Artículo de conocimiento estándar, Archivos adjuntos de objetos estándar y Otras asignaciones de campo sugeridas: seleccione entre los orígenes de datos predeterminados generados por Amazon Kendra los campos 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 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 conectar Amazon Kendra a Salesforce

Debe especificar lo siguiente en la API SalesforceConfiguration:

  • URL del servidor: la URL de la instancia para el sitio de Salesforce que desea indexar.

  • Nombre de recurso de Amazon (ARN) de secreto: proporcione el nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contenga las credenciales de autenticación para su cuenta de Salesforce. El secreto se almacena en una estructura JSON 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"
}

  • Rol de IAM: especifique a RoleArn cuándo llamar a CreateDataSource para proporcionar a un rol de IAM permisos para acceder a su secreto de Secrets Manager y para llamar a las API públicas necesarias 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 chat: si decide rastrear las Fuentes de chat, debe especificar el nombre de la columna en la tabla FeedItem de Salesforce que contiene el contenido para 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 los documentos es obligatorio para que Amazon Kendra busque en los documentos. Debe asignar el nombre del campo del cuerpo del documento en el origen de datos al nombre del campo de índice _document_body. Todos los demás campos son opcionales.

  • Filtrado de contexto de usuario y control de acceso: Amazon Kendra rastrea la lista de control de acceso (ACL) para los documentos, si tiene una ACL para los documentos. 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.