Como configurar a integração do UKGReady no ADManager Plus

Pré-requisitos:

Certifique-se de fornecer a chave de API e as credenciais para recuperar as informações desejadas e executar tarefas no UKGReady. Consulte as referências de API do UKGReady para mais detalhes.

Privilégios:

Importar usuários (ação de entrada): A conta utilizada na autorização deve ter permissão para ler todas as contas de usuário.

Para executar qualquer ação ou consulta no UKGReady (ação de saída): A conta usada deve ter permissão para realizar a ação desejada.

Configuração de autorização

• Faça login no ADManager Plus e acesse a guia Automation.
• No painel esquerdo, em Configuration, clique em Application Integrations.
• Em Enterprise Applications, clique em UKG Ready.
• Ative o botão Enable UKG Ready Integration .
• Na página UKG Ready Configuration, clique em Authorization.
• Escolha Bearer como o tipo de autorização para a integração do API.
• Navegue e clique em API widget com o painel de configuração da integração para configurar a autenticação personalizada.
• Na janela API for Authorization:
  • Vá para o campo Endpoint URL e substitua {hostname} pelo nome do host da sua instância do UKG Ready.
  • Na seção Headers, insira a API-Key associada à sua instância do UKG Ready.
  • No campo Message Type, substitua os espaços reservados {username}, {password} e {company} pelas respectivas credenciais e identificador da empresa para sua instância UKG Ready.
  • Clique no botão Test and Configure para validar as configurações e concluir a integração.
  • Selecione o access token gerado e clique em Save.
• Clique em Configure.

Configuração de webhook de entrada

O webhook de entrada permite ao ADManager Plus obter dados de usuários diretamente do UKG Ready. O mapeamento de atributos definido aqui poderá ser selecionado como fonte de dados ao configurar automatizações. Para configurar um webhook de entrada para o UKG Ready:

• Em Inbound Webhook, clique em UKG Ready Endpoint Configuration.
• No campo Endpoint URL, substitua {hostname} pelo nome do host da sua instância do UKG Ready.
• Insira a API-Key apropriada, associada à sua instância UKG Ready na seção Headers.
• Substitua {username}, {password} e {company} no campo Message Type pelas respectivas credenciais para sua instância do UKG Ready.
• Clique em Test and Configure para validar as configurações e concluir o processo de configuração.
• Clique em Test & Save. A janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos pela chamada da API. Após verificar se os parâmetros desejados foram retornados, clique em Proceed.

Nota:

• Consulte as referências de API do UKG Ready para saber os parâmetros que devem ser configurados para obter apenas parâmetros específicos.
• Você pode configurar diversos endpoints para o UKG Ready usando o botão + Add API endpoint. Clique aqui para saber como.
• Clique em Data Source - LDAP Attribute Mapping para vincular endpoints e mapear atributos LDAP do AD aos respectivos atributos no UKG Ready.
• Clique em + Add New Configuration e faça o seguinte:
  • Insira o Nome da configuração e a Descrição, e selecione a Categoria de automação no menu suspenso.
  • No campo Select Endpoint, selecione o endpoint desejado e uma Chave primária exclusiva a cada usuário (por exemplo, employeeIdentifier).

  Nota: Quando vários endpoints estiverem configurados, essa chave deve manter o mesmo valor em todos eles.

  • No campo Attribute Mapping, selecione o atributo no menu suspenso LDAP Attribute Name e associe ele ao atributo correspondente no UKG Ready.
  • Se quiser criar um formato personalizado, clique em Add New Format.
  • Clique em Save.

Configuração de webhook de saída

Webhook de saída permite que você envie mudanças feitas no AD para o UKG Ready e execute tarefas no UKG Ready — tudo a partir do ADManager Plus. Os webhooks configurados nesta seção podem ser incluídos em Modelos de orquestração, que, por sua vez, podem ser usados durante automações acionadas por eventos e agendadas. Eles também podem ser aplicados diretamente aos usuários desejados para executar uma sequência de ações neles (Management > Advanced Management > Orchestration). Para configurar os webhooks de saída para o UKG Ready:

• Em Outbound Webhook, clique em UKG Ready Webhook Configuration.
• Clique em + Add Webhook.
• Insira um nome e uma descrição para este webhook.
• Decida sobre a ação que deve ser executada e consulte as referências de API do UKG Ready para obter os detalhes de API, tais como URL, cabeçalhos, parâmetros e outros requisitos que serão necessários.
• Selecione, no menu suspenso, o método HTTP que permitirá executar a ação desejada no endpoint.
• Insira a URL do endpoint.
• Configure os cabeçalhos, os parâmetros e o tipo de mensagem no formato apropriado com base na chamada de API que você deseja executar.
• Clique em Test and Save.
• Uma janela pop-up exibirá uma lista de usuários e grupos do AD para testar a chamada de API configurada. Selecione o usuário ou grupo desejado para testar a chamada de API e clique em OK. Isso enviará uma solicitação em tempo real para a URL do endpoint e aplicará as modificações configuradas aos objetos selecionados.
• Os detalhes da solicitação e da resposta do webhook serão exibidos. Verifique se a API está respondendo corretamente e clique em Save.