Configurar o utilitário ADSync

Este artigo contém os seguintes tópicos:

Este artigo explica como configurar o utilitário ADSync.

Configurações no ServiceAide Cloud Service Management 

Configure como o servidor ServiceAide Cloud Service Management interage com o utilitário ADSync.

Configurar as informações do inquilino e as propriedades de sincronização

O arquivo sync.properties contém as informações do ServiceAide Cloud Service Management para seu inquilino. O utilitário ADSync é configurado com as credenciais de logon do administrador da suborganização ou do inquilino.

Você só pode sincronizar dados de usuários usando o utilitário.

Para obter mais detalhes sobre o arquivo sync.properties, consulte Arquivo sync.properties.

Configurar como a exclusão de usuário é tratada

Para configurar como o ServiceAide Cloud Service Management lida com a exclusão de dados do usuário, vá para GERENCIAR, FERRAMENTAS, Parâmetros de configuração. Configurar o seguinte parâmetro:

• ACTIVE_DIRECTORY_USERS_DEPROVISION_USERS_THRESHOLD

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.

Configure o utilitário ADSync no lado do cliente (LDAP)

O utilitário ADSync baseia-se em um conjunto de arquivos de configuração. Esses arquivos são entregues com o utilitário ADSync. Os arquivos estão localizados na pasta do utilitário ADSync. A equipe de suporte da ServiceAide não tem acesso a esses arquivos. Nesta etapa, você configura arquivos com as seguintes informações de ambiente, e em seguida testa o utilitário:

• Informações de conexão para o servidor LDAP
• Informações de conexão do ServiceAide Cloud Service Management
• Como os valores no seu servidor LDAP são mapeados para os campos nos arquivos de configuração do gestão ServiceAide Cloud Service Management

Todos esses arquivos estão localizados na pasta do utilitário ADSync. Conforme você configurar esses arquivos, certifique-se de manter sua localização nesta pasta. Todos os arquivos ADSync devem permanecer no mesmo local relativo no qual você os descompacta. É possível mover a pasta inteira do Utilitário ADSync, mas todos os arquivos devem permanecer juntos.

Antes de iniciar a sincronização, certifique-se de que você tenha definido a estrutura da organização no ServiceAide Cloud Service Management.

Arquivos de configuração do Utilitário ADSync

Este tópico explica os arquivos de configuração incluídos com o Utilitário ADSync.

searchBase.list

Esse arquivo contém uma lista de todas as OUs (Organization Units – Unidades Organizacionais). A lista é usada para extrair dados de usuário enviados para o ServiceAide Cloud Service Management. Cada linha consiste em uma OU totalmente qualificada, como:

• OU=Users,DC=Bedford,DC=Nimsoft Service Desk,DC=InteQ,DC=com
• OU=Users,DC=Boston,DC=Nimsoft Service Desk,DC=InteQ,DC=com
• OU=Users,DC=Seattle,DC=Nimsoft Service Desk,DC=InteQ,DC=com

Se o arquivo searchBase.list estiver vazio, o utilitário busca os dados de todos os registros do servidor LDAP.

attribute_map.list

Este arquivo contém uma lista de todos os atributos de usuário a serem coletados para cada conta de usuário. Edite este arquivo para aplicar o devido nome de atributo do AD (Active Directory) nos campos do Cloud Service Management.

Os valores são mapeados usando a seguinte equação:

Atributo do Cloud Service Management=Atributo do Active Directory

Você pode fazer o mapeamento de qualquer um dos seguintes formatos:

• É possível mapear um valor do AD com o respectivo valor no Cloud Service Management. Digite apenas o nome de seu atributo do AD com o atributo do Cloud Service Management.

Por exemplo: first_name=givenName

• É possível transferir vários valores do Active Directory para um atributo do ServiceAide Cloud Service Management no seguinte formato: ${Value1} ${Value2}.

Por exemplo: name=${last_name}, ${first_name}

Os espaços entre os valores ou quaisquer outros itens colocados fora de ${} serão tratados como valores estáticos e incluídos na definição do atributo exatamente como aparecem.

• É possível transmitir um valor estático (texto) como mapeamento para um atributo do Cloud Service Management. Se todo o valor no lado direito for estático, coloque-o entre aspas duplas.

Por exemplo: title="este é um exemplo de uma sequência de caracteres estática"

• Também é possível transmitir uma combinação de valores estáticos e atributos do AD para um atributo do Cloud Service Management. Siga estas regras estritamente:

  • Quando usa uma combinação de atributos do AD e valores estáticos, certifique-se de que o atributo do AD está incluído entre ${}.

Por exemplo: job_title=Sr. ${title}

Aqui, o valor estático é "Sr." e o valor do AD é title.

• • NÃO use aspas duplas para representar um valor estático ao transmitir uma combinação de valores estáticos e atributos do AD. Nesse caso, qualquer coisa que não esteja incluído em ${} será tratada como uma sequência de caracteres estática por padrão. Se usar aspas duplas, elas se tornam parte do valor estático.

Por exemplo: job_title=“Sr.” ${title}

Aqui, a sequência de caracteres de todo o texto, "Sr.", inclusive as aspas, será tratada como uma sequência de caracteres estática.

• • Ao transmitir uma combinação de valores estáticos e atributos do AD, NÃO coloque o todo valor à direita entre aspas duplas. Nesse caso, o ADSync ignora o valor do AD e o trata como parte da sequência de caracteres de texto estático.

Por exemplo: name="este é um exemplo de um valor estático, que inclui um atributo do AD ${department}"

Neste exemplo, ${departamento} não será tratado como uma variável já que está incluído dentro das aspas. Em vez disso, ${departamento} também será tratado como texto.

Se uma conta de usuário não tiver nenhum valor correspondente ao atributo do AD especificado por você, apenas os valores estáticos são transmitidos para a conta. Essa regra não é aplicável ao atributo org_name. Consulte Configurar o atributo org_name para obter mais informações sobre org_name.

Verifique a descrição de cada atributo na lista de atributos para detectar exceções.

Considerações importantes:

• Se alterar o mapeamento de um atributo depois de executar o utilitário ADSync, os novos valores substituirão os existentes no ServiceAide Cloud Service Management na próxima vez em que o utilitário for executado. Da mesma forma, se excluir o valor mapeado, ele será excluído do ServiceAide Cloud Service Management quando o utilitário for executado novamente.
• O atributo time_zone não está mais disponível. A versão atual do aplicativo atualiza automaticamente o fuso horário do usuário conectado de acordo com suas configurações do sistema. Portanto, a configuração manual não é mais necessária.
• Não é possível mapear um atributo do AD para mais de dois atributos no ServiceAide Cloud Service Management. Ao mapear um atributo pela segunda vez, certifique-se de que você digitou-o no formato ${atributo}.
  Por exemplo: suponhamos que deseje mapear o atributo de email no LDAP para os atributos e_mail e user_login no ServiceAide Cloud Service Management.

Defina os atributos da seguinte maneira:
e_mail=mail
user_login=${mail}

Lista de atributos para o Microsoft Active Directory

Lista de atributos para o Novell eDirectory:

• #Nimsoft Service Desk Field = Directory Service Field Name
• first_name=givenName
• last_name=sn
• job_title=title
• e_mail=mail
• user_login=uid
• manager=manager
• org_name=${company} >> ${physicalDeliveryOfficeName} >> ${ou}
  Consulte Configurar o atributo org_name para obter mais informações sobre org_name.
• lvl1_name=company
• lvl2_name=physicalDeliveryOfficeName
• lvl3_name=ou
  Observação: sempre use o atributo org_name em vez de lvl1_name, lvl2_name e lvl3_name. Se você estiver usando o atributo org_name, não é necessário definir lvl1_name, lvl2_name e lvl3_name. Esses níveis são fornecidos somente para compatibilidade com versões anteriores do aplicativo.
• phone1=telephoneNumber
• phone2=mobile

logger.properties

Este arquivo permite configurar os níveis de log e os arquivos de saída para o processo de sincronização do Active Directory. Os pares de nome-valor a serem configurados para fins de registro são os seguintes:

sync.properties

Este arquivo fornece o centro de configuração principal para a sincronização de dados. Os pares nome-valor disponíveis para configuração são os seguintes:

Durante a solução de problemas, a equipe de suporte pode solicitar que você valide os valores definidos no arquivo sync.properties.

• Token de autorização = authtoken para o mecanismo de integração do usuário no slice do cliente
• Token do slice = slicetoken do slice em que o processo de sincronização grava
• URL de ação = o URL para a instância correta para a qual o cliente deseja enviar a saída de sincronização

Configurar o atributo org_name

O atributo org_name representa a hierarquia organizacional. Esse atributo é configurado no arquivo attribute_map.list. O valor que você especifica aqui exibe todos os níveis da hierarquia organizacional.

É possível definir um org_name usando atributos do AD (Active Directory), valores estáticos ou uma combinação de ambos.

As regras a seguir devem ser seguidas ao configurar um org_name:

• Se usar um atributo do AD para representar um nível, certifique-se de que o atributo seja colocado entre ${ }. Por exemplo: ${department}.
  Esse formato não é necessário para valores estáticos. Por exemplo: Recursos Humanos.
• Cada nível deve ser separado pela sequência de caracteres "espaço simples>>espaço simples". Por exemplo: ${company_name} >> ${department} ou ${company_name} >> Recursos Humanos.
  Não use nenhum outro caractere para separar os níveis.
• Não há nenhuma limitação no número de níveis no org_name.
• Se usar atributos do AD no org_name, certifique-se de que cada usuário seja mapeado para pelo menos um dos atributos no org_name. Se um usuário não for mapeado para um dos atributos do AD no org_name, esse usuário não será mapeado para nenhuma organização.
• Não adicione caracteres de espaço nem qualquer outro caractere no início e no final da definição do org_name.
• Não use aspas duplas para representar valores estáticos na hierarquia do org_name. No entanto, é preciso usar aspas duplas quando sua definição do org_name inteira é um valor estático.

Exemplo:

Caso 1: o org_name inclui somente atributos do Active Directory:

org_name=${empresa} >> ${NomeEscritórioEntregaFísico} >> ${departamento} >> ${nível adicional} >> ${nível adicional}

Caso 2: o org_name é uma combinação de atributos do Active Directory e de valores estáticos:

org_name = empresa XYZ >> EUA >> ${estado} >> ${município} >> ${cidade} >> Recursos Humanos

Neste exemplo:

• • Empresa XYZ, EUA e Recursos Humanos são valores estáticos.
  • ${estado}, ${município} e ${cidade} são atributos do AD.

É possível adicionar qualquer número de níveis como valores estáticos no org_name.

Caso 3: todo o org_name é um valor estático:

org_name = "empresa XYZ >> EUA >> Nova York >> Recursos Humanos"

Certifique-se de que, nesse caso, o valor no lado direito seja incluído entre aspas duplas.

Ativar qualquer ambiente SSL para o utilitário ADSync

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

1. Clique em Exibir informações do site (o ícone de bloqueio) ao lado do URL do ServiceAide Cloud Service Management na barra de endereço do navegador.
2. Vá para Certificado, Detalhes e clique em Copiar para arquivo.
3. Clique em Avançar e defina o formato que você deseja usar como X.509 binário codificado por .DER (.CER).
4. Clique em Avançar, digite o nome do arquivo e salve o arquivo.
5. Clique em Avançar, verifique o caminho e clique em Concluir.
6. Copie o arquivo de certificado salvo para o local da raiz do ADSync (ad-user-sync\).
7. Execute o comando keytool do local da raiz do ADSync (ad-user-sync\).

8. Importe o certificado salvo para o arquivo si do keystore local do ADSync, executando o seguinte comando a partir da raiz do ADSync:
   keytool -import -trustcacerts -alias aliasname -keystore si -file saved_certificate_file_name
   Observação: para executar o comando keytool a partir da raiz do ADSync, você precisa ter o jre/bin na variável de ambiente PATH.
   Substitua aliasname pelo alias de sua escolha. Por exemplo, cacloudsmcert.
   Substitua saved_certificate_file_name pelo nome do arquivo de certificado salvo. Por exemplo, cacloudsmcert.cer
   Use itmaas quando for solicitada a senha. O prompt de comando solicita que você confirme se o certificado pode ser confiável. Digite Y.
   Uma mensagem é exibida indicando que o certificado foi adicionado ao keystore.

Testar o utilitário

É possível executar o Utilitário ADSync sem realmente enviar os dados ao banco de dados do ServiceAide Cloud Service Management. Para impedir que os dados sejam enviados para o banco de dados, defina o atributo send.data no arquivo sync.properties como Não. Os dados de saída são exibidos no arquivo sync_data.log.0. Os dados também são adicionados no arquivo DATA.csv. É possível revisar esses arquivos para verificar se o utilitário está sendo executado conforme esperado.

Após o teste, redefina o atributo send.data como Sim.

Faça as execuções de testes para algumas das tentativas de sincronização iniciais, para garantir que o utilitário seja configurado corretamente.

Você também pode usar o atributo send.data para testar as modificações em valores de parâmetro. Ao modificar um valor de parâmetro, faça uma sincronização de teste. Atualize o ServiceAide Cloud Service Management apenas quando a execução de teste for bem-sucedida.

Criar um programador de tarefas

Você pode criar um programador de tarefas para executar a sincronização regularmente. Por exemplo, se você tiver um ambiente UNIX, crie uma tarefa do cron para executar o utilitário. O agendador de tarefas chama um dos arquivos de script fornecidos para executar o utilitário ADSync. Os arquivos de script são:

• sync.bat (Windows)
• sync.sh (UNIX)

Esses scripts são incluídos no arquivo zip e são usados como estão; sem edição necessária. Os arquivos estão localizados na pasta script no Utilitário ADSync.

Configure o agendador de tarefas para que ele chame o arquivo de script apropriado no intervalo desejado. Certifique-se de que os direitos de acesso suficientes foram concedidos para executar o arquivo de script. Agora, você está pronto para executar o utilitário ADSync.

Atualizar o utilitário

O utilitário ADSync é atualizado periodicamente. É possível atualizar para uma versão mais recente quando ela estiver disponível. Para evitar a perda de dados, siga as instruções fornecidas neste tópico.

Enquanto você estiver atualizando para a nova versão, verifique se a configuração do utilitário permanece inalterada da instalação existente. Também, certifique-se de que o backup mais recente esteja disponível no utilitário atualizado.

Siga estas etapas:

1. Faça download e descompacte a nova versão do utilitário.
2. Copie todos os arquivos de propriedades modificados da pasta Utilitário ADSync para o mesmo local na nova pasta do ADSync.
3. Adicione novamente todos os novos parâmetros são introduzidos na atualização.
4. Copie todo o conteúdo da pasta de backup, exceto a pasta dtd, da pasta ADSync existente para a nova pasta.