Configurar webhooks para o spoke Workday RH

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 15 min. de leitura

    • Recupere os detalhes dos funcionários necessários na aplicação Workday RH para sua instância ServiceNow configurando os webhooks.

    Antes de Iniciar

    Função necessária: administrador

    Configure o cliente de API do Webhook da ServiceNow para OAuth 2.0 em Workday

    Configure o cliente de API no Workday para autenticar solicitações de webhook.

    Antes de Iniciar

    Função necessária: função de administrador do Workday ou a função com permissão concedida para configurar o cliente OAuth 2.0 no Workday.

    Por Que e Quando Desempenhar Esta Tarefa

    Você só precisa configurar esta etapa se quiser usar a plataforma ServiceNow como um endpoint de ouvinte e receber notificações de eventos do Workday. Se você não precisar receber notificações de eventos do Workday, poderá ignorar as configurações mencionadas nesta seção.
    Nota:
    Essas configurações devem ser realizadas no Workday.

    Procedimento

    1. No Workday, umacessa a tarefa Editar configuração de locatário - Segurança.
    2. Selecione a opção Clientes OAuth 2.0 habilitados na seção Configurações do OAuth 2.0.
    3. Acesse a tarefa Registrar cliente de API.
    4. Insira o Nome do cliente.
    5. Selecione o Tipo de Concessão de Cliente como Concessão de Código de Autorização.
    6. Selecione o tipo de token de acesso como Portador.
    7. Insira um URI de redirecionamento válido.
      Nota:
      Certifique-se de que o URI de Redirecionamento do OAuth 2.0 seja um URL HTTPS válido.
    8. Opcional: Selecione o Tempo limite do token de atualização em dias.
    9. Opcional: Selecione a opção Tokens de atualização que não expiram para impedir que o token de atualização expire.
    10. Selecione a opção Conceder consentimento administrativo para conceder permissão OAuth a um cliente de REST API em todo o locatário.
      Ao selecionar esta opção, você não precisa conceder acesso de cliente explicitamente às áreas funcionais do Workday.
    11. No prompt Áreas funcionais, selecione as áreas funcionais às quais o cliente OAuth 2.0 precisa de acesso.
    12. Opcional: Se o cliente OAuth 2.0 exigir acesso aos principais domínios do Workday que não estão em nenhuma área funcional, selecione a opção Incluir escopo próprio do Workday.

    Configurar o Webhook CreateUser para o spoke de RH do Workday

    Use o Webhook CreateUser para obter os detalhes do funcionário recém-integrado do Workday para sua instância da ServiceNow.

    Gerar nome de usuário e senha em sua instância ServiceNow para o webhook Criar usuário

    Gere nome de usuário e senha em sua instância ServiceNow para autenticar solicitações de webhook Criar usuário e recuperar os dados necessários da aplicação Workday.

    Antes de Iniciar

    Função necessária: administrador do ServiceNow

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Definição do Sistema > Tabela.
    3. Filtre e pesquise a tabela de registro do webhook do spoke Workday RH.
      Por exemplo, Registro do Webhook do Workday.
    4. Clique na lista relacionada Mostrar lista.
    5. Clique em Nova.
    6. No formulário, preencha estes valores.
      Campo Descrição
      Descrição Descrição do registro do webhook. Insira evento e autenticação do Workday para Criar usuário.
      UserName Workday usuário que tem direitos de integração usando Workday Web Services.
      Senha Senha do usuário Workday.
      Evento do Workday Evento para o qual o webhook está configurado. Insira Desligamento.
      Instância do Workday URL do host do Workday e nome do locatário. Insira a URL neste formato:https://<workday_host_url> /<workday_tenant_name>
    7. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
    8. Clique em Gerar nome de usuário e senha.
      Copie e registre os valores de nome de usuário e senha. Esses valores devem ser especificados na instância Workday para autenticar as solicitações de webhook.
      Nota:
      Se você tiver mais de um BP de HIRE em seu ambiente, deverá configurar todos os BPs de HIRE para habilitar o webhook Criar usuário para todas as transações de funcionários de HIRE.

    Recuperar o caminho do recurso da sua instância ServiceNow para o webhook Criar usuário

    Recupere o caminho do recurso da sua instância ServiceNow para uso posterior para autenticar solicitações de webhook de criação de usuário e recuperar os dados necessários da aplicação Workday

    Antes de Iniciar

    Função necessária: ServiceNow admin.

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Serviços web do sistema > Serviços web com script > Scripted REST APIs.
    3. Abra o registro do spoke Workday RH.
    4. Na guia Recursos, clique no registro de retorno de chamada.
    5. Registre e salve o valor do caminho do recurso para uso posterior.

    Importar arquivo CLAR para sua instância Workday do webhook Criar usuário

    Importe o arquivo CLAR disponível em ServiceNow Store para configurar o webhook Criar usuário e autenticar solicitações da instância ServiceNow.

    Antes de Iniciar

    • Workday O Studio deve ser instalado.
    • Acesso à política de criação de relatórios personalizados.

      Crie um relatório personalizado no Workday com base na estrutura de relatório New_Hire_record e compartilhe o relatório com o usuário ISU.

    • Acesso para editar a definição do processo de negócios.
    • Acesso para criar e editar o sistema de integração.
    • Função necessária: administrador
    Nota:
    • Exceto o nome da integração, o XPath do campo de relatório (se necessário) e o cabeçalho da instância Workday, os usuários são alertados para não modificar os valores de campos ou propriedades no arquivo CLAR.
    • Essas configurações devem ser realizadas no Workday Studio.

    Procedimento

    1. Na página do spoke do Workday RH em ServiceNow Store, baixe o arquivo Workday-HR-Webhook-Studio-Sample em Links e documentos de suporte.
    2. Descompacte o arquivo de amostra para obter o arquivo CLAR.
    3. Importe o arquivo CLAR para o Workday Studio.
    4. Na guia Propriedades do componente StartHere, navegue até Serviços e selecione o relatório RAAS criado para este webhook.
      Configurar o componente StartHere
    5. Escolha o ambiente em que seu relatório existe, como implementação ou área restrita, e configure o relatório de acordo com seus requisitos.
    6. Forneça um nome de relatório e selecione o relatório necessário.
      Nome do relatório
    7. Forneça o nome do alias do relatório.
      Nome do alias
    8. Depois que o alias do relatório for adicionado, adicione o caminho selecionado do relatório no Caminho Extra que é usado para executar o relatório com base no prompt.
      Caminho extra
    9. No componente Definir cabeçalhos, forneça sua instância Workday para o cabeçalho WorkdayInstance.
      Configurar o componente Definir cabeçalhos
    10. Nas propriedades de HttpOut, preencha estes valores.
      Campo Valor
      Endpoint Endpoint REST
      Nota:
      Para obter mais informações, consulte Recuperar o caminho do recurso da sua instância ServiceNow.
      Método HTTP POST
      Configurar as propriedades de HttpOut
    11. Salve as mudanças.
    12. No Project Explorer, selecione a integração e implante-a no seu sistema Workday.
    13. Faça login na sua instância Workday e navegue até Integração > Sistema de integração > Configurar atributos de integração.
      Configurar atributos de integração
    14. Forneça o nome de usuário e a senha em Configurar atributos de integração que você gerou em Gerar nome de usuário e senha em sua instância ServiceNow.
      Configurar atributos de integração
    15. Modifique um processo de negócios e adicione esta integração ao seu processo de negócios.
      1. Edite a definição do processo de negócios.
        Editar definição
      2. Selecione a data de efetivação e clique em Ok.
      3. Clique no sinal + e adicione uma nova etapa do processo de negócios no BP.
      4. Selecione um pedido após a etapa de conclusão do processo de negócios.
      5. Adicione o processo de negócios e selecione Tipo como Integração.
        Selecionar tipo de integração
      6. Forneça o nome de usuário do ISU em Executar como usuário e clique em OK.
      7. Clique em Configurar integração na etapa do processo de negócios recém-adicionada em Contratar BP.
        Configurar integração
      8. Nos critérios de integração, selecione o tipo de valor como Determinar valor no tempo de execução e selecione o valor como ID do funcionário.
        Determinar valor no tempo de execução

        O campo ID do funcionário selecionado no valor é exibido.

        Campo de ID do funcionário
      9. Clique em OK.
      10. Crie um relatório para o webhook com estes detalhes:

        Definição de relatório:

        Definição de relatório

        Rótulos de coluna:

        Rótulos de colunas

        Detalhes do campo calculado:

        Detalhes do campo calculado

        Detalhes de filtro e solicitação:

        Detalhes de filtro e solicitação

    Configurar webhook de desligamento para o spoke de RH do Workday

    Use o Webhook de desligamento para obter os detalhes do funcionário desligado do Workday para sua instância da ServiceNow.

    Gerar nome de usuário e senha em sua instância ServiceNow para webhook de desligamento

    Gere nome de usuário e senha em sua instância ServiceNow para autenticar solicitações de webhook de desligamento e recuperar os dados necessários da aplicação Workday.

    Antes de Iniciar

    Função necessária: administrador

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Definição do Sistema > Tabela.
    3. Filtre e pesquise a tabela de registro do webhook do spoke Workday RH.
      Por exemplo, Registro do Webhook do Workday.
    4. Clique na lista relacionada Mostrar lista.
    5. Clique em Nova.
    6. No formulário, preencha estes valores.
      Campo Descrição
      Descrição Descrição do registro do webhook. Insira o evento Workday e a autenticação para desligamento.
      UserName Workday usuário que tem direitos de integração usando Workday Web Services.
      Senha Senha do usuário Workday.
      Evento do Workday Evento para o qual o webhook está configurado. Insira Desligamento.
      Instância do Workday URL do host do Workday e nome do locatário. Insira a URL neste formato:https://<workday_host_url> /<workday_tenant_name>
    7. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
    8. Clique em Gerar nome de usuário e senha.
      Copie e registre os valores de nome de usuário e senha. Esses valores devem ser especificados na instância Workday para autenticar as solicitações de webhook.
      Nota:
      Se você tiver mais de um BP de HIRE em seu ambiente, deverá configurar todos os BPs de HIRE para habilitar o webhook Criar usuário para todas as transações de funcionários de HIRE.

    Recuperar o caminho do recurso da sua instância ServiceNow para webhook de desligamento

    Recupere o caminho do recurso da sua instância ServiceNow para uso posterior para autenticar solicitações de webhook de desligamento e recuperar os dados necessários da aplicação Workday

    Antes de Iniciar

    Função necessária: administrador

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Serviços web do sistema > Serviços web com script > Scripted REST APIs.
    3. Abra o registro do spoke Workday RH.
    4. Na guia Recursos, clique no registro de retorno de chamada.
    5. Registre e salve o valor do caminho do recurso para uso posterior.

    Importar arquivo CLAR para sua instância Workday do webhook de desligamento

    Importe o arquivo CLAR disponível em ServiceNow Store para configurar o webhook de desligamento e autenticar solicitações da instância ServiceNow.

    Antes de Iniciar

    • Workday O Studio deve ser instalado.
    • Acesso à política de criação de relatórios personalizados.

      Crie um relatório personalizado no Workday com base na estrutura de relatório New_terminated_record e compartilhe o relatório com o usuário ISU.

    • Acesso para editar a definição do processo de negócios.
    • Acesso para criar e editar o sistema de integração.
    • Função necessária: administrador
    Nota:
    • Exceto o nome da integração, o XPath do campo de relatório (se necessário) e o cabeçalho da instância Workday, os usuários são alertados para não modificar os valores de campos ou propriedades no arquivo CLAR.
    • Essas configurações devem ser realizadas no Workday Studio.

    Procedimento

    1. Na página do spoke do Workday RH em ServiceNow Store, baixe o arquivo Workday-HR-Offboarding-Webhook-Studio-Sample em Links e documentos de suporte.
    2. Descompacte o arquivo de amostra para obter o arquivo CLAR.
    3. Importe o arquivo CLAR para o Workday Studio.
    4. Na guia Propriedades do componente StartHere, navegue até Serviços e selecione o relatório RAAS criado para este webhook.
      Relatório RAAS para spoke de desligamento
    5. Escolha o ambiente em que seu relatório existe, como implementação ou área restrita, e configure o relatório de acordo com seus requisitos.
    6. Forneça um nome de relatório e selecione o relatório necessário.
      Relatório RaaS personalizado para webhook de desligamento
    7. Forneça o nome do alias do relatório.
      Relatório de alias para webhook de desligamento
    8. Depois que o alias do relatório for adicionado, adicione o caminho selecionado do relatório no Caminho Extra que é usado para executar o relatório com base no prompt.
      caminho extra para webhook de desligamento
    9. Selecione o alias do relatório.
    10. No componente Definir cabeçalhos, forneça sua instância Workday para o cabeçalho WorkdayInstance.
      Definir webhook de desligamento do componente de cabeçalhos
    11. Nas propriedades de HttpOut, preencha estes valores.
      Campo Valor
      Endpoint Endpoint REST
      Nota:
      Para obter mais informações, consulte Recuperar o caminho do recurso da sua instância ServiceNow.
      Método HTTP POST
      Propriedades httpout para desligamento
    12. Salve as mudanças.
    13. No Project Explorer, selecione a integração e implante-a no seu sistema Workday.
    14. Faça login na sua instância Workday e navegue até Integração > Sistema de integração > Configurar atributos de integração.
      configurar atributos de integração desligamento
    15. Forneça o nome de usuário e a senha em Configurar atributos de integração que você gerou em Gerar nome de usuário e senha em sua instância ServiceNow para webhook de desligamento.
      atributos de integração configuração desligamento webhook
    16. Modifique um processo de negócios e adicione esta integração ao seu processo de negócios.
      1. Edite a definição do processo de negócios.
      2. Selecione o usuário ISU na caixa Conta do Workday.
      3. Selecione a data de efetivação e clique em Ok.
      4. Clique no sinal + e adicione uma nova etapa do processo de negócios no BP.
      5. Selecione um pedido após a etapa de conclusão do processo de negócios.
      6. Adicione o processo de negócios e selecione Tipo como Integração.
      7. Forneça o nome de usuário do ISU em Executar como usuário e clique em OK.
      8. Clique em Configurar integração na etapa do processo de negócios recém-adicionada em Contratar BP.
        configurar webhook de desligamento de integração
      9. Nos critérios de integração, selecione o tipo de valor como Determinar valor no tempo de execução e selecione o valor como ID do funcionário.
        valor dos critérios de integração no tempo de execução

        O valor do campo ID do funcionário selecionado é exibido.

        ID do funcionário dos critérios de integração para webhook de desligamento
      10. Clique em OK.
      11. Abra a tarefa Criar relatório personalizado.
      12. Insira o nome do relatório, por exemplo, insira New_terminated_record.
      13. Selecione o Tipo de relatório como Avançado.
      14. Desmarque a opção Otimizado para desempenho.
      15. Selecione Fonte de dados como Todos os trabalhadores.
        Exibir relatório personalizado para desligamento
      16. Crie um relatório conforme mostrado abaixo:
        Exemplo de relatório para webhook de desligamento

        Cabeçalhos de coluna de grupo em relatórios Cabeçalhos de coluna de grupo em relatório

        Classificar seção em relatórios

        Seção de filtro em relatórios Seção de filtro em relatórios

      17. Selecione a opção Preencher padrões de prompt indefinido na guia Prompts.
      18. Selecione a opção Habilitar como serviço web na guia Avançado.

    Configurar webhook de licença de dispensa para o spoke de RH do Workday

    Use o Webhook de licença de dispensa para obter detalhes da licença de um funcionário do Workday para sua instância da ServiceNow.

    Gerar nome de usuário e senha em sua instância ServiceNow para o webhook de licença

    Gere nome de usuário e senha em sua instância ServiceNow para autenticar solicitações de webhook de licença e recuperar os dados necessários da aplicação Workday.

    Antes de Iniciar

    Função necessária: administrador

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Definição do Sistema > Tabela.
    3. Filtre e pesquise a tabela de registro de webhook do spoke Workday RH, por exemplo, Registro de webhook do Workday.
    4. Clique na lista relacionada Mostrar lista.
    5. Clique em Nova.
    6. No formulário, preencha estes valores.
      Campo Descrição
      Descrição Descrição do registro do webhook. Insira o evento Workday e a autenticação para licença.
      UserName Workday usuário que tem direitos de integração usando Workday Web Services.
      Senha Senha do usuário Workday.
      Evento do Workday Evento para o qual o webhook está configurado. Insira LicençadeAusência.
      Instância do Workday URL do host do Workday e nome do locatário. Insira a URL neste formato:https://<workday_host_url> /<workday_tenant_name>
    7. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
    8. Clique em Gerar nome de usuário e senha.
      Copie e registre os valores de nome de usuário e senha. Esses valores devem ser especificados na instância Workday para autenticar as solicitações de webhook.
      Nota:
      Se você tiver mais de um BP de HIRE em seu ambiente, deverá configurar todos os BPs de HIRE para habilitar o webhook Criar usuário para todas as transações de funcionários de HIRE.

    Recuperar o caminho do recurso da sua instância ServiceNow para o webhook de licença

    Recupere o caminho do recurso da sua instância ServiceNow para uso posterior para autenticar solicitações de webhook de desligamento e recuperar os dados necessários da aplicação Workday

    Antes de Iniciar

    Função necessária: administrador

    Nota:
    Essas configurações devem ser realizadas em sua instância ServiceNow.

    Procedimento

    1. Faça login na sua instância ServiceNow como um administrador.
    2. Navegar até Todos > Serviços web do sistema > Serviços web com script > Scripted REST APIs.
    3. Abra o registro do spoke Workday RH.
    4. Na guia Recursos, clique no registro de retorno de chamada.
    5. Registre e salve o valor do caminho do recurso para uso posterior.

    Importar arquivo CLAR para sua instância Workday do webhook de licença

    Importe o arquivo CLAR disponível em ServiceNow Store para configurar o webhook de licença e autenticar solicitações da instância ServiceNow.

    Antes de Iniciar

    • Workday O Studio deve ser instalado.
    • Acesso à política de criação de relatórios personalizados.

      Crie um relatório personalizado no Workday com base na estrutura de relatório leave_of_absence_request e compartilhe o relatório com o usuário ISU.

    • Acesso para editar a definição do processo de negócios.
    • Acesso para criar e editar o sistema de integração.
    • Função necessária: administrador
    Nota:
    • Exceto o nome da integração, o XPath do campo de relatório (se necessário) e o cabeçalho da instância Workday, os usuários são alertados para não modificar os valores de campos ou propriedades no arquivo CLAR.
    • Essas configurações devem ser realizadas no Workday Studio.

    Procedimento

    1. Na página do spoke do Workday RH em ServiceNow Store, baixe o arquivo Workday-HR-Leave-of-Absence-Webhook-Studio-Sample em Links e documentos de suporte.
    2. Descompacte o arquivo de amostra para obter o arquivo CLAR.
    3. Importe o arquivo CLAR para o Workday Studio.
    4. Na guia Propriedades do componente StartHere, navegue até Serviços e selecione o relatório RAAS criado para este webhook.
      Relatório RaaS para webhook de licença de dispensa
    5. Escolha o ambiente em que seu relatório existe, como implementação ou área restrita, e configure o relatório de acordo com seus requisitos.
    6. Forneça um nome de relatório e selecione o relatório necessário.
      Relatório Raas personalizado para webhook de licença de dispensa
    7. Forneça o nome do alias do relatório.
      Alias para o nome do relatório
    8. Depois que o alias do relatório for adicionado, adicione o caminho selecionado do relatório no Caminho Extra que é usado para executar o relatório com base no prompt.
      Caminho extra para alias de relatório
    9. Selecione o alias do relatório.
    10. No componente Definir cabeçalhos, forneça sua instância Workday para o cabeçalho WorkdayInstance.
      Definir cabeçalhos para instância do Workday
    11. Nas propriedades de HttpOut, preencha estes valores.
      Campo Valor
      Endpoint Endpoint REST
      Nota:
      Para obter mais informações, consulte Recuperar o caminho do recurso da sua instância ServiceNow.
      Método HTTP POST
      propriedades de saída http para webhook de licença de dispensa
    12. Salve as mudanças.
    13. No Project Explorer, selecione a integração e implante-a no seu sistema Workday.
    14. Faça login na sua instância Workday e navegue até Integração > Sistema de integração > Configurar atributos de integração.
      Configurar atributos de integração para webhook de licença de dispensa
    15. Forneça o nome de usuário e a senha em Configurar atributos de integração que você gerou em Gerar nome de usuário e senha em sua instância ServiceNow para o webhook de licença.
      nome de usuário e senha para configuração de atributos de integração
    16. Modifique um processo de negócios e adicione esta integração ao seu processo de negócios.
      1. Edite a definição do processo de negócios.
        Definição do processo de negócios
      2. Selecione o usuário ISU na caixa Conta do Workday.
      3. Selecione a data de efetivação e clique em Ok.
      4. Clique no sinal + e adicione uma nova etapa do processo de negócios no BP.
      5. Selecione um pedido após a etapa de conclusão do processo de negócios.
      6. Adicione o processo de negócios e selecione Tipo como Integração.
        Integração de tipo de processo de negócios
      7. Forneça o nome de usuário do ISU em Executar como usuário e clique em OK.
      8. Clique em Configurar integração na etapa do processo de negócios recém-adicionada em Contratar BP.
        Configurar integração para processo de negócios
      9. Nos critérios de integração, selecione o tipo de valor como Determinar valor no tempo de execução e selecione o valor como ID do funcionário.
        Valor dos critérios de integração no tempo de execução

        O campo ID do funcionário selecionado no valor é exibido.

        ID do funcionário selecionado para os critérios de integração
      10. Clique em OK.
      11. Abra a tarefa Criar relatório personalizado.
      12. Insira o nome do relatório, por exemplo, leave_of_absence_request.
      13. Selecione o Tipo de relatório como Avançado.
      14. Desmarque a opção Otimizado para desempenho.
      15. Selecione Fonte de dados como Todos os trabalhadores ativos e encerrados.
      16. Crie um relatório conforme mostrado abaixo:
        Relatório de amostra

        Seção Cabeçalho de coluna de grupo no relatório Cabeçalhos de coluna de grupo no relatório

        Seção de filtro no relatório Seção de filtro no relatório

      17. Selecione a opção Preencher padrões de prompt indefinido na guia Prompts.
      18. Selecione a opção Habilitar como serviço web na guia Avançado.