Instalando e usando o utilitário ADSync

Este artigo contém os seguintes tópicos:

Este artigo fornece uma breve visão geral dos procedimentos de instalação, configuração e execução do utilitário ADSync. Para integrar o utilitário ADSync com o aplicativo do ServiceAide Cloud Service Management, execute as tarefas descritas neste artigo.

Pré-requisitos

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.
A versão mais recente do Java (versão 8 ou mais recente) é instalada no sistema em que você instalar o utilitário ADSync.
O sistema tem conectividade de rede com o Active Directory (é possível instalar no próprio servidor do AD).

Instalação

Siga estas etapas:

Faça download do utilitário ADSync na seção Downloads no ServiceAide Cloud Service Management. Vá para GERENCIAR, ADMINISTRAÇÃO, Ferramentas, Downloads.
Crie uma conta no AD (Active Directory) que possa acessar e executar consultas no servidor do Active Directory.
Descompacte a pasta ADSync.
No sistema em que você descompactar o utilitário ADSync, modifique o caminho da variável de ambiente. Vá para Meu computador, Configurações avançadas, Variáveis de ambiente, Caminho.
Defina o caminho para o diretório bin da instalação do JRE.

Não modifique, em nenhuma circunstância, a estrutura de pastas.

Para obter mais detalhes, consulte Introdução ao Utilitário ADSync.

Configuração

Para definir o utilitário ADSync, siga estas etapas:

Configurar arquivos

O utilitário ADSync inclui três arquivos de configuração na pasta do diretório de instalação \AdsyncUtility\ad-user-sync\conf. Os arquivos são:

sync.properties:

Esse arquivo contém as informações de seu inquilino. Atualize os parâmetros a seguir:

LDAP GC e LDAP DC: esses valores geralmente são os mesmos. Altere esses valores para o servidor do AD ou o controlador de domínio.
Exemplo:
# Servidor de catálogo global
ldap.gc=ldap://localhost:3268
# Servidor de controlador de domínio
ldap.dc=ldap://localhost:389
Authtoken e slicetoken: esses valores são preenchidos automaticamente quando faz download do utilitário ADSync. NÃO edite esses valores. Se editar esses valores por engano, faça download do utilitário ADSync novamente.
action.url: trata-se do URL para a instância do aplicativo. Esse valor é preenchido automaticamente quando você faz download do utilitário ADSync. NÃO edite este valor. Se você editar esse valor por engano, faça download do utilitário ADSync novamente.
Observação: para transações grandes, a equipe de suporte pode fornecer um URL de direcionamento para o aplicativo, para resolver problemas de tempo limite. Somente em tais casos, você pode atualizar esse atributo manualmente.
Credenciais LDAP Bind: as credenciais LDAP Bind são a conta de serviço que você criou no AD.
send.data: esse parâmetro determina se o fluxo de dados passa no Cloud Service Management ou não. O valor é definido como Sim. No entanto, é possível defini-lo como Não durante a execução do utilitário ADSync para fins de diagnóstico.

Para obter mais informações sobre o arquivo sync.properties, consulte Configurar o utilitário ADSync e procure sync.properties.

searchBase.list:

O aplicativo passa em cada OU (Organization Unit – Unidade Organizacional) e procura usuários com base nos critérios de pesquisa. Digite o DN do recipiente que deseja sincronizar.
Exemplo:
OU=HR,DC=ForwardInc,DC=ca,DC=com
O utilitário ADSync sincroniza os usuários a partir da organização RH para o aplicativo com a base de pesquisa abaixo.
Se o arquivo estiver vazio, o utilitário busca todos os dados do servidor LDAP.

attribute_map.list:

Esse arquivo é usado para mapear os campos do AD com os campos do ServiceAide Cloud Service Management. Configure-o, mapeando os atributos do aplicativo com seus atributos do AD correspondentes, no seguinte formato:
Atributo CSM = atributo do AD

Para obter mais informações sobre esses arquivos e atributos, consulte Configurar o utilitário ADSync e procure attribute_map.list.

Configurar SSL para ADSync

Para ativar qualquer ambiente SSL para o utilitário ADSync, execute as seguintes etapas:

Clique em Exibir informações do site (o ícone de bloqueio) ao lado do URL do aplicativo na barra de endereço do navegador.
Vá para Certificado, Detalhes e clique em Copiar para arquivo.
Clique em Avançar e defina o formato como Binário codificado por .DER X.509 (*.cer).
Clique em Avançar, digite o nome do arquivo e salve o arquivo.
Clique em Avançar, verifique o caminho e clique em Concluir.
Copie o arquivo de certificado salvo para o local da raiz do ADSync (ad-user-sync\).
Vá para o local ad-user-sync\.
Importe o arquivo de certificado salvo para o repositório de chaves si local do ADSync, executando o seguinte comando a partir do local ad-user-sync:
Keytool –import –trustcacerts –alias aliasname –keystore si –file saved_certificate_file_name.cer
1. Use itmaas como senha, quando solicitada uma.
2. O nome do alias pode ser qualquer coisa, por exemplo, CSM-AD-connection.
3. Depois que o comando é executado com êxito, um nome de arquivo si é criado no local ad-user-sync.

Para obter informações mais detalhadas sobre configuração, consulte Configurar o utilitário ADSync.

Executando o utilitário ADSync

É possível testar o utilitário ADSync sem realmente enviar dados ao ServiceAide Cloud Service Management. Defina o atributo send.data no arquivo sync.properties como Não.

Execute o arquivo em lote a partir de <diretório da instalação>\ADSyncUtility\ad-user-sync\script\sync.bat.

A saída do comando acima é exibida no arquivo sync_data.log em <diretório de instalação>\ADSyncUtility\ad-user-sync\sync\logs.

É possível revisar esses logs para verificar se o ADSync está funcionando conforme o esperado. Após o teste, redefina o atributo send.data como Sim.

Você pode programar o utilitário para execução diária, usando o Agendador de tarefas do Microsoft Windows.

O diagrama a seguir explica como funciona o utilitário ADSync:

Para obter mais detalhes, consulte Introdução ao Utilitário ADSync.

Informações sobre solução de problemas

As falhas de sincronização podem ser identificadas e abordadas nos seguintes documentos:

Arquivo de log de dados de sincronização: depois que a sincronização estiver concluída, o CSM gera um arquivo XML que é gravado em <diretório de instalação>\sync\logs\sync_data.log.0. Qualquer erro durante a sincronização pode ser visto aqui.
Arquivo de backup: o arquivo de backup é gerado no seguinte local:
<Diretório de instalação>\sync\backup
O arquivo de backup armazena as alterações que são gravadas nos dados após a última sincronização bem-sucedida.

Para obter mais informações sobre dicas de solução de problemas, consulte Solucionar erros do Utilitário ADSync.