Alfresco - Amazon Kendra
Atributos compatíveisPré-requisitosInstruções de conexãoSaiba mais

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Alfresco

OAlfresco é um serviço de gerenciamento de conteúdo que ajuda os clientes a armazenar e gerenciar o conteúdo. Você pode usar Amazon Kendra para indexar sua biblioteca de Alfresco documentos, Wiki e blog.

Amazon Kendra oferece suporte Alfresco local e Alfresco na nuvem (plataforma como serviço).

Você pode se conectar Amazon Kendra à sua fonte de Alfresco dados usando o Amazon Kendra console ou a TemplateConfigurationAPI.

Para solucionar problemas do conector da fonte de dados Amazon Kendra Alfresco, consulteSolucionar problemas de origens de dados.

Atributos compatíveis

o conector de fonte de dados do Amazon Kendra Alfresco oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Sincronizações de conteúdo completas e incrementais

  • OAuth 2.0 e autenticação básica

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Alfresco, faça essas alterações em seu Alfresco e. Contas da AWS

No Alfresco, verifique se você:

  • Copiou o URL do repositório do Alfresco e o URL do aplicativo da Web. Se quiser indexar apenas um site específico do Alfresco, copie também o ID do site.

  • Anote suas credenciais de autenticação do Alfresco, que incluem um nome de usuário e senha com no mínimo permissão de leitura. Para usar a autenticação OAuth 2.0, adicione o usuário ao grupo de administradores do Alfresco.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

  • Opcional: configurou as credenciais do OAuth 2.0 em. Alfresco As credenciais incluem ID do cliente, senha do cliente e URL do token. Para obter mais informações sobre como configurar clientes no Alfresco on-premises, consulte a documentação do Alfresco. Para usar o Cloud (PaaS) do Alfresco, entre em contato com o suporte da Hyland para a autenticação OAuth 2.0 do Alfresco.

  • Verifique se cada documento é exclusivo no Alfresco e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. Os IDs de documentos são globais para um índice e devem ser exclusivos por índice.

No seu Conta da AWS, verifique se você tem:

  • Criou um Amazon Kendra índice e, se estiver usando a API, anotei o ID do índice.

  • Criou uma IAM função para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.

  • Armazenou as credenciais de autenticação do Alfresco em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Alfresco a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Alfresco, você deve fornecer os detalhes necessários da sua fonte de dados do Alfresco para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Alfresco para Amazon Kendra, consultePré-requisitos.

Console

Para se conectar Amazon Kendra a Alfresco

  1. Faça login no AWS Management Console e abra o Amazon Kendra console.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha Conector Alfresco e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Alfresco com a etiqueta “V2.0".

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão — Escolha um idioma para filtrar seus documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. Alfrescotipo — Escolha se você usa Alfresco local/servidor ou Alfresco nuvem (plataforma como serviço).

    2. URL do repositório do Alfresco: insira o URL do repositório do Alfresco. Por exemplo, se você usa o Cloud (PaaS) do Alfresco, o URL do repositório pode ser https://company.alfrescocloud.com. Ou, se você usa o Alfredo on-premises, o URL do repositório pode ser https://company-alfresco-instance.company-domain.suffix:port.

    3. Aplicativo do usuário do Alfresco. URL: insira o URL da interface de usuário do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, o URL da interface do usuário pode ser https://example.com.

    4. Local do certificado SSL — Insira o caminho para o certificado SSL armazenado em um bucket. Amazon S3 Você usa isso para se conectar ao Alfresco on-premises com uma conexão SSL segura.

    5. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

    6. Autenticação: escolha a Autenticação básica ou Autenticação OAuth 2.0. Em seguida, escolha uma senha do Secrets Manager existente ou crie um novo segredo para armazenar as credenciais do Alfresco. Se você optar por criar um novo segredo, uma janela AWS Secrets Manager secreta será aberta.

      Se escolher a Autenticação básica, insira um nome para a senha, o nome de usuário e a senha do Alfresco.

      Se escolheu a Autenticação OAuth 2.0, insira um nome para a senha, o ID do cliente, a senha do cliente e a chave privada.

    7. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    8. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

    9. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    10. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Escopo de sincronização: defina limites de crawling determinados e filtre o conteúdo usando padrões de expressão regex.

      1. Conteúdo: escolha se deseja rastrear conteúdo marcado com “Aspectos” no Alfresco, conteúdo em um site específico do Alfresco ou conteúdo em todos os sites do Alfresco.

      2. (Opcional) Configurações adicionais: defina as seguintes configurações opcionais:

        • Incluir comentários: escolha incluir comentários na biblioteca de documentos e no blog do Alfresco.

        • Padrões Regex: os padrões de expressão regular para incluir ou excluir determinados arquivos.

    3. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização.

      • Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.

      • Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    4. Em Cronograma de execução de sincronização, em Frequência — Escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar seu índice.

    5. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.

    2. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra a Alfresco

Você deve especificar um JSON do esquema da fonte de dados usando a API TemplateConfiguration. Você deve fornecer as seguintes informações:

  • Fonte de dados — especifique o tipo de fonte de dados como ALFRESCO quando você usa o esquema TemplateConfigurationJSON. Também especifique a fonte de dados como TEMPLATE quando você chama a CreateDataSourceAPI.

  • ID do site do Alfresco: especifique o ID do site do Alfresco.

  • URL do repositório do Alfresco: especifique o URL do repositório do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, se você usa o Cloud (PaaS) do Alfresco, o URL do repositório pode ser https://company.alfrescocloud.com. Ou, se você usa o Alfredo on-premises, o URL do repositório pode ser https://company-alfresco-instance.company-domain.suffix:port.

  • URL do aplicativo da Web do Alfresco: especifique o URL da interface do usuário do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, o URL da interface do usuário pode ser https://example.com.

  • Tipo de autenticação: especifique qual tipo de autenticação deseja usar: OAuth2 ou Basic.

  • Tipo do Alfresco: especifique qual o tipo do Alfresco uado: PAAS (nuvem/plataforma como serviço) ou ON_PREM (on-premises).

  • Nome do recurso da Amazon (ARN) da senha: para usar a autenticação básica, forneça uma senha que armazena as credenciais de autenticação do nome de usuário e da senha. Você fornece o Amazon Resource Name (ARN) de um AWS Secrets Manager segredo. A senha deve conter uma estrutura JSON com as seguintes chaves:

    {
    "username": "user name",
    "password": "password"
}

    Para usar a autenticação OAuth 2.0, a senha é armazenada em uma estrutura JSON com as seguintes chaves:

    {
    "clientId": "client ID",
    "clientSecret": "client secret",
    "tokenUrl": "token URL"
}

  • IAM role — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar as APIs públicas necessárias para o conector Alfresco e. Amazon Kendra Para obter mais informações, Funções do IAM para fontes de dados do Alfresco.

Você também pode adicionar os seguintes recursos opcionais:

  • Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para ter mais informações, consulte Configuração Amazon Kendra para usar um Amazon VPC.

  • Tipo de conteúdo: o tipo de conteúdo que você deseja rastrear, seja um conteúdo marcado com “Aspectos” no Alfresco, conteúdo em um site específico do Alfresco ou conteúdo em todos os sites do Alfresco. Você também pode listar conteúdo específico de “Aspectos”.

  • Filtros de inclusão e exclusão: especifique se deseja incluir ou excluir determinadas arquivos.

    nota

    A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

  • Modo de sincronização — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização. Escolha uma das seguintes opções:

    • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

    • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Alfresco para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

    nota

    O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o Esquema do modelo do Alfresco.

Saiba mais

Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Alfresco, consulte: