Introdução ao Utilitário ADSync

Este artigo contém os seguintes tópicos:

Este artigo explica como o utilitário ADSync funciona e o orienta na execução da configuração inicial do utilitário. Depois de executar a configuração inicial, consulte Configurar o utilitário ADSync para saber como configurar o utilitário.

Configuração inicial

Esta seção explica as tarefas a serem executadas ao começar a usar o utilitário ADSync.

Verifique os requisitos de sistema

Certifique-se de que o sistema atenda aos seguintes requisitos antes de executar o utilitário ADSync:

• Servidores LDAP v2 e v3 suportados: Microsoft Active Directory (AD), ServiceAide Directory
• Sistema operacional do diretório: Windows, UNIX
• Versão mais recente do Java (versão 8 ou posterior)
• Memória: mínimo de 2 GB
• Compatibilidade com o protocolo de comunicação segura de HTTPS
• Compatibilidade com o ServiceAide Cloud Service Management

Observação: cada inquilino deve ter sua própria instância do utilitário ADSync.

Adquirir e descompactar o utilitário

O utilitário ADSync é fornecido como um arquivo ZIP. Este arquivo contém o utilitário e todos os arquivos de suporte necessários para o processo.

Você pode adquirir o utilitário por meio dos métodos a seguir:

• Fazer download a partir do ServiceAide Cloud Service Management. Vá para GERENCIAR, ADMINISTRAÇÃO, Ferramentas, Downloads.
• Obtenha-o com um administrador que tenha as permissões apropriadas para acessar o utilitário.

Considerações sobre a descompactação do utilitário:

• O arquivo pode ser descompactado em qualquer ambiente com JRE configurado.
• Todos os arquivos e JARs devem permanecer juntos, exatamente como foram descompactados. Não tire nada do layout descompactado.
• O local de instalação deve conseguir se conectar ao servidor do LDAP e ao ServiceAide Cloud Service Management.

Uma vez que o utilitário foi descompactado, você está pronto para configurar o utilitário.

Implantar

O utilitário ADSync é implantado como um aplicativo independente no cliente. É necessário ter o Java Runtime Environment para executar este aplicativo. Configure o utilitário ADSync em um servidor VMWare que possa comunicar-se com ou conectar-se ao diretório específico.

Configure uma conta de serviço que tenha permissões para se conectar ao servidor de diretório e executar consultas.

Programação

Você pode programar o processo de sincronização para ser executado conforme necessário. O ideal é executar o processo de sincronização uma vez por dia. Programe o processo fora do horário comercial.

O agendador é executado como uma tarefa de plano de fundo do Windows/Linux. Para obter mais informações, consulte o tópico Criar um agendador de tarefas em Configurar o utilitário ADSync.

Design

Ao executar o utilitário ADSync, os dados do ServiceAide Cloud Service Management são comparados com os do seu LDAP. Em seguida, as diferenças entre o servidor LDAP e os dados do ServiceAide Cloud Service Management são sincronizadas da seguinte maneira:

Restrições

• Todas as IDs de usuário diferenciam maiúsculas de minúsculas. Quando você executar a sincronização com êxito, o utilitário cria um arquivo de backup para todos os seus dados. Quando você executar a sincronização da próxima vez, somente as diferenças são atualizadas no ServiceAide Cloud Service Management. No caso de uma ID de usuário no arquivo de backup que não é idêntica à ID no LDAP, a que se encontra no arquivo de backup é excluída. Se você deseja modificar uma ID após a geração do backup, exclua o backup e modifique a ID manualmente.
• Na ausência de arquivos de backup, o utilitário ADSync não pode remover usuários.
• Se você deseja executar uma sincronização completa, remova todos os arquivos de backup.

• Criar as estruturas da organização dos registros no ServiceAide Cloud Service Management antes de começar a usar o utilitário ADSync. Na ausência de estrutura de organização, os usuários não são mapeados para suas respectivas empresas.

• Use somente uma instância do utilitário ADSync para cada servidor de diretório.
  Se você alterar o filtro de pesquisa, os arquivos de backup correspondentes são inutilizados. O novo filtro de pesquisa resulta em novo arquivo de backup (ou arquivos de backup, dependendo do número de bases de pesquisa).

Como funciona o utilitário ADSync

Este tópico descreve como a sincronização funciona.

No Servidor de diretório (No cliente)

• O utilitário ADSync usa uma conta de serviço para estabelecer conexão com o servidor de catálogo global e controladores de domínio.
• Uma lista de Base de pesquisa é usada para procurar usuários da lista de OUs (Organization Units - Unidades Organizacionais).
• O aplicativo passa por cada OU e procura os usuários com base nos critérios de pesquisa. Esses critérios são definidos da seguinte maneira:
  (&(objectClass=user)(objectClass=person)(objectClass=organizationalPerson))
• Os campos no servidor de diretório são mapeados com os campos no ServiceAide Cloud Service Management usando o arquivo attribute_map.list.
• Para cada entrada correspondente, o aplicativo procura determinados atributos. Exemplos de tais atributos são primeiro nome, sobrenome e email. A lista completa de atributos pode ser encontrada no arquivo attribute_map.list. O aplicativo também procura contas desativadas e expiradas, marcando-as como usuários inativos no feed de dados. Os atributos userAccountControl e loginDisabled são usados para a verificação de contas desativadas. O atributo accountExpires é usado para a verificação de contas expiradas.
• O aplicativo grava as entradas correspondentes em um arquivo CSV no utilitário ADSyncUtility após passar por todas as OUs. O aplicativo também cria um documento XML com os dados e o transmite para o ServiceAide Cloud Service Management.
• A resposta do servidor contém os erros e avisos encontrados durante o processamento dos dados. A resposta é gerada no formato XML e gravada na marca INFO do arquivo de log. O arquivo de log está em <:Install_Directory>/sync/logs/sync_data.log.0. Para obter mais informações sobre esse arquivo, consulte o arquivo logger.properties. Você pode configurar monitores de arquivo nesse arquivo de log. Como parte do serviço de monitoramento, procure erros e avisos. As sequências de caracteres a pesquisar, de uma perspectiva de monitoramento, seriam:
  • "notes" - a marca "notes" contém o resumo da resposta geral recebida do servidor.
  • "SEVERE"
  • "<erros>" ou "<erro>" - a marca de "erros" lista todos os erros e a marca de "erro" contém cada erro individual.
  • "<warnings>" ou "<warning>" - a marca "avisos" lista todos os avisos, e a marca "aviso" contém cada aviso individual.
  • "response" - a marca "response" contém a resposta XML do servidor. Os dados de LDAP são gravados no ServiceAide Cloud Service Management em lotes de 500 registros. O servidor gera uma resposta XML de cada lote após processá-lo.

No ServiceAide Cloud Service Management (servidor)

• Os dados do LDAP são gravados primeiro no utilitário ADSync. Em seguida, eles são validados antes de serem transferidos para o banco de dados do ServiceAide Cloud Service Management.
• Você pode configurar um valor de limite para a exclusão de registros de usuário do banco do ServiceAide Cloud Service Management. Nenhum registro é excluído se o número de registros marcados para exclusão for superior a esse valor. A sincronização dos dados restantes não é afetada. As informações sobre uma violação de limite são registradas no arquivo sync_data.log.0.
• Ao receber os dados do LDAP, o ServiceAide Cloud Service Management inicia o processamento imediato dos dados.
• Com base na ID de usuário do feed de entrada, o registro de contato correspondente é identificado no ServiceAide Cloud Service Management. 
• A entrada é comparada com os dados existentes no ServiceAide Cloud Service Management. Uma instrução de atualização automática é criada com base na diferença entre os dois. Essa condição se aplica às alterações em atributos como telefone, email e departamento.
• Cada novo registro é criado como um usuário de autoatendimento. Esses usuários têm seus grupos e licenças principais definidos como Autoatendimento. O fuso horário para o novo contato se baseia no local correspondente.
• Para todos os contatos inativos no feed:

  • Todos os contatos que são usuários de autoatendimento são desativados e o sinalizador de logon ativado é definido como falso. Essa alteração impede efetivamente o usuário de efetuar logon no ServiceAide Cloud Service Management.

  • Todos esses contatos que são técnicos são desativados e o sinalizador de logon ativado é definido como falso. Essa alteração impede efetivamente o usuário de efetuar logon no ServiceAide Cloud Service Management.

  • Todos os contatos que fazem parte do grupo de administração também são desativados e o sinalizador de logon ativado é definido como falso. Essa alteração impede efetivamente o usuário de efetuar logon no ServiceAide Cloud Service Management.

  • Todos os usuários desativados que existem no servidor de diretório, mas não no ServiceAide Cloud Service Management, permanecerão no feed de dados. No entanto, novos registros não são criados para tais usuários.

  • Todos os usuários no servidor de diretório não fariam parte do feed de dados. O processo define todas as contas do ServiceAide Cloud Service Management que não fazem parte do feed como inativas. Esses nomes de usuário são liberados para serem reutilizados em contas futuras.

• As exceções encontradas durante a sincronização são gravadas no arquivo syn_data.log. O log contém informações sobre:

  • Erros encontrados durante o processamento de dados.
  • Contatos sem locais.
  • Contatos que se tornaram inativos.
  • As contas administrativas que estavam inativas no feed de entrada, mas não se tornaram inativas no ServiceAide Cloud Service Management.

Para obter mais detalhes sobre os arquivos de configuração mencionados neste artigo, consulte Configurar o utilitário ADSync.

Backup

Depois que o processo de sincronização for bem-sucedido, o ServiceAide Cloud Service Management gera uma resposta no formato XML. Essas informações XML são adicionadas ao arquivo sync_data.log.0 no utilitário ADSync. Com base no arquivo sync_data.log.0, o utilitário ADSync gera um arquivo de backup em um local predeterminado. Os dados de backup são armazenados em <:Install_Directory>/sync/backup. Não modifique a estrutura desse diretório. Quando você executar a sincronização com êxito na primeira vez, o utilitário cria um arquivo de backup para todos os seus dados. Quando você executar a sincronização da próxima vez, somente as alterações de delta são atualizadas no ServiceAide Cloud Service Management. Se você deseja executar uma sincronização completa, exclua os arquivos de backup existentes. Caso contrário, não modifique o conteúdo desta pasta.

O arquivo de backup é gerado somente se a sincronização for bem sucedida como um todo. Em alguns casos, a sincronização geral é bem-sucedida, mas um registro individual falha. Atualizar esses registros manualmente.

A pasta de backup consiste nos seguintes elementos:

• Arquivo de backup - O utilitário cria um arquivo XML para criar o backup. Esse arquivo está em <:Install_Directory>/sync/backup. O nome do arquivo começa com "bak_".
• Arquivo backupIDMapper.properties – Esse arquivo está localizado em <:Install_Directory>/sync/backup/idMapper. O utilitário grava um arquivo de backup separado para cada combinação de uma entrada de base de pesquisa e um filtro de pesquisa. As informações sobre cada combinação são gravadas no arquivo backupIDMapper.properties. Se esse arquivo não estiver no local padrão, o processo de sincronização falha. Nesse caso, nenhum dado será enviado para o ServiceAide Cloud Service Management. Se você excluir esse arquivo, todos os arquivos de backup existentes são inutilizados.
• Arquivo ProcessXMLDocument.dtd - Esse arquivo fornece um modelo para processar os arquivos XML de backup. Esse arquivo está em <:Install_Directory>/sync/backup/dtd.

Configurar a rede de proxy

Você também pode executar o utilitário ADSync em uma rede de proxy. Definir as configurações de proxy:

1. Configure o arquivo sync.properties. Siga estas etapas:
   1. Navegue até <:Install_Directory>/conf/sync.properties.
   2. No arquivo sync.properties, atualize os detalhes do host e da porta do proxy. Se você estiver usando serviços de autenticação de proxy, também forneça os detalhes de nome e senha de usuário do proxy. O Utilitário ADSync oferece suporte à autenticação básica.
      Para obter mais informações sobre esses atributos, consulte Configurar o utilitário ADSync.
   3. Salve e feche o arquivo sync.properties.
2. Defina as configurações do navegador para permitir o servidor Proxy. Siga estas etapas para o Internet Explorer:
   1. Navegue até Ferramentas, Opções da internet, Conexões, Configurações da LAN.
   2. Ativar o Servidor Proxy e, em seguida, forneça o endereço IP do servidor proxy e o número da porta. Os detalhes do host e da porta devem ser os mesmos configurados no arquivo sync.properties.