Configurar o First Advantage spoke

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 7 min. de leitura

    • Integre a instância ServiceNow à sua conta First Advantage usando uma chave de API para autenticar solicitações ServiceNow.

    Antes de Iniciar

    • Solicite a assinatura do IntegrationHub.
    • Ativar o First Advantage spoke
    • Função necessária: administrador

    Criar registro de credencial para First Advantage spoke

    Crie registros de credencial para o First Advantage spoke. O alias de conexão e credencial First Advantage spoke usa essas credenciais para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Credenciais.
    2. Clique em Nova.
      O sistema exibe a mensagem Que tipo de credenciais você deseja criar?.
    3. Selecione Credenciais de chave de API.
      Um formulário em branco de Credenciais de chave de API será exibido.
    4. Insira estes valores.
      Campo Valor necessário
      Nome Nome para identificar exclusivamente o registro. Por exemplo, insira Credenciais FADV.
      Ativo Opção de usar ativamente o registro de credencial.
      Chave de API Chave de API gerada para sua instância First Advantage.
      Nota:
      Entre em contato com a equipe First Advantage para obter a chave de API.
      Ordem Selecione a ordem para aplicar esta credencial. Por exemplo, insira 100.
    5. Clique em Enviar.

    Criar registro de conexão para o First Advantage spoke

    Crie um registro de conexão com a API First Advantage. O alias de conexão e credencial First Advantage spoke usa essas conexões para executar ações em First Advantage.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Aberto para o registro do First Advantage.
    3. Na guia Conexões, clique em Novo.
      O sistema exibe um formulário de conexão HTTP(s) em branco.
    4. Insira estes valores.
      Campo Valor necessário
      Nome Nome para identificar o registro da conexão com exclusividade. Por exemplo, insira Conexão FADV.
      Credencial Registro de credencial que você criou para First Advantage. Por exemplo, selecione Credenciais FADV.
      URL de conexão First Advantage URL de conexão. Insira https://rest-ua.fadv.com.
    5. Na guia Atributos, insira esses valores.
      Campo Descrição
      E-mail de distribuição E-mail de distribuição da sua organização.
      u_version v1.1
      Nota:
      Se você estiver usando qualquer outra versão de First Advantage, especifique o número da versão.
    6. Clique em Enviar.
    7. Navegar até Conexões e Credenciais > Aliases de conexão e credencial.
    8. Aberto para o registro do First Advantage.
    9. Clique na guia Atributos de conexão.
    10. Modifique os valores padrão dos registros de atributos de conexão de acordo com seu requisito.
      Registro de atributos de conexão Valor-padrão
      E-mail de distribuição E-mail de distribuição da sua organização.
      Versão v1.1
      Nota:
      Se você estiver usando qualquer outra versão de First Advantage, especifique o número da versão.

    Crie estados First Advantage em sua instância ServiceNow

    Crie estados First Advantage a serem exibidos na lista Estado em sua instância ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Criar os estados Rascunho, Pronto e Em andamento

    Crie os estados Rascunho, Pronto e Em andamento na tabela Tarefa [task].

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. No Navegador de filtros, insira sys_choice.list.
      Os registros na tabela Opção [sys_choice] são exibidos.
    2. Clique em Nova.
    3. No formulário, preencha esses valores e crie três registros para o estado Rascunho.
      Tabela 1. Registro 1 - Estado de rascunho
      Campo Valor
      Tabela Tarefa [task]
      Elemento state
      Rótulo Rascunho
      valor 137
      Nota:
      • Certifique-se de fornecer os números exatos no campo Valor, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      • Certifique-se de que o registro seja criado na aplicação Global.
    4. Clique em Enviar.
    5. Da mesma forma, crie registros para os estados Pronto e Em andamento.
      Tabela 2. Registro 2 - Estado pronto
      Campo Valor
      Tabela Tarefa [task]
      Elemento state
      Rótulo Pronto
      valor 173
      Tabela 3. Registro 3 - Estado em andamento
      Campo Valor
      Tabela Tarefa [task]
      Elemento state
      Rótulo Em andamento
      valor 181
      Nota:
      • Certifique-se de fornecer os números exatos no campo Valor, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      • Certifique-se de que o registro seja criado na aplicação Global.

    Resultado

    Os estados Rascunho, Pronto e Em andamento são criados na tabela Tarefa [task]

    Criar os estados Concluído e Cancelado

    Crie os estados Concluído e Cancelado na tabela Tarefa do First Advantage [sn_fadv_spoke_first_advantage_task].

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Spoke do First Advantage > Tarefas de pedido.
    2. Clique em Nova.
      Nota:
      Certifique-se de que o registro seja criado na aplicação First Advantage.
    3. Clique com o botão direito do mouse em Estado e clique em Configurar opções.
    4. Execute estas etapas para criar o estado Cancelado:
      1. Insira Cancelado em Novo texto de item.
      2. Insira 149 em Valor numérico.
        Nota:
        Certifique-se de fornecer os números exatos no campo Valor numérico, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      3. Clique em Adicionar.
      4. Clique em Salvar.
    5. Execute estas etapas para criar o estado Concluído:
      1. Insira Concluído em Novo texto de item.
      2. Insira 127 em Valor numérico.
        Nota:
        Certifique-se de fornecer os números exatos no campo Valor numérico, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      3. Clique em Adicionar.
      4. Clique em Salvar.

    Resultado

    Os estados Concluído e Cancelado são criados na tabela Tarefa do First Advantage [sn_fadv_spoke_first_advantage_task].

    Criar os estados Concluído - Êxito e Concluído - Acordo interrompido

    Crie os estados Concluído - Sucesso e Concluído - Acordo interrompido na tabela Tarefa do funcionário do First Advantage [sn_fadv_spoke_first_advantage_employee_task_table].

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Spoke do First Advantage > Tarefa do funcionário.
    2. Clique em Nova.
      Nota:
      Certifique-se de que o registro seja criado na aplicação First Advantage.
    3. Clique com o botão direito do mouse em Estado e clique em Configurar opções.
    4. Execute estas etapas para criar o estado Cancelado:
      1. Insira Concluído - Êxito no texto do novo item.
      2. Insira 161 em Valor numérico.
        Nota:
        Certifique-se de fornecer os números exatos no campo Valor numérico, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      3. Clique em Adicionar.
      4. Clique em Salvar.
    5. Execute estas etapas para criar o estado Concluído:
      1. Insira Concluído - Acordo interrompido em Novo texto de item.
      2. Insira 117 em Valor numérico.
        Nota:
        Certifique-se de fornecer os números exatos no campo Valor numérico, conforme mencionado aqui. Os fluxos de spoke não serão acionados se houver alguma mudança nesses números.
      3. Clique em Adicionar.
      4. Clique em Salvar.

    Resultado

    Os estados Concluído - Sucesso e Concluído - Acordo interrompido são criados na tabela Tarefa do funcionário do First Advantage [sn_fadv_spoke_first_advantage_employee_task_table].

    Configurar webhooks First Advantage

    Receba atualizações de evento de pedido e convite em sua instância ServiceNow configurando os webhooks.

    Antes de Iniciar

    Função necessária: administrador

    Forneça a chave na sua instância ServiceNow

    Configure o webhook First Advantage fornecendo a chave para o cliente do webhook First Advantage.

    Antes de Iniciar

    • Gere uma chave segura de acordo com seus requisitos e registre o valor. Por exemplo, uma chave codificada em base64.
    • Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Spoke do First Advantage > Detalhes de cliente do webhook FADV.
    2. Clique em Nova.
    3. No formulário, preencha estes valores.
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro.
      Chave de Autorização Chave que você gerou de acordo com seu requisito.
    4. Clique em Enviar.

    Acessar endpoints da API

    Acesse o endpoint da API para os eventos de convite e pedido e compartilhe os detalhes necessários com First Advantage para configurar os webhooks.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Serviços web do sistema > Scripted REST APIs.
    2. Abra o registro para o First Advantage spoke, por exemplo, Webhook do First Advantage.
    3. Na guia Recursos :
      1. Abra o registro do evento de convite, por exemplo, Status do convite.
      2. Copie e registre o caminho fornecido em Caminho do recurso, por exemplo, /api/sn_fadv_spoke/fadv/invite_status.
      3. Abra o registro do evento de pedido, por exemplo, Status do pedido.
      4. Copie e registre o caminho fornecido em Caminho do recurso, por exemplo, /api/sn_fadv_spoke/fadv/order_status.

    O que Fazer Depois

    Entre em contato com First Advantage para configurar webhooks para sua instância ServiceNow. Para isso, compartilhe estes detalhes com First Advantage:
    • Cabeçalho personalizado neste formato: fadvKey<authorization-key> .
      Nota:
      • Certifique-se de que o cabeçalho personalizado esteja somente neste formato. Os fluxos de spoke não serão acionados se houver alguma mudança.
      • Forneça a mesma chave fornecida anteriormente em Spoke do First Advantage > Detalhes de cliente do webhook FADV.
      • Use o mesmo caso mencionado aqui: fadvKey.
    • Endpoint da API para os eventos de convite neste formato:<ServiceNow-instance-URL> /api/sn_fadv_spoke/fadv/invite_status
    • Endpoint da API para os eventos de pedido neste formato:<ServiceNow-instance-URL> /api/sn_fadv_spoke/fadv/order_status

    Sincronizar First Advantage contas e pacotes com ServiceNow

    Armazene os detalhes das First Advantage contas e pacotes sincronizando First Advantage contas e pacotes com ServiceNow.

    Antes de Iniciar

    Função necessária: administrador do First Advantage

    Procedimento

    1. Navegar até Todos > Spoke do First Advantage > Contas.
    2. Clique em Nova.
    3. No formulário, preencha os valores.
      Tabela 4. Formulário da conta
      Campo Descrição
      Conta principal Opção para especificar que a conta é uma conta primária. Marque a caixa de seleção.
      ID da conta ID da conta primária.
      Nome da conta Nome da conta primária.
    4. Clique em Enviar.
      A conta primária é criada e o registro é exibido.
    5. Navegar até Spoke do First Advantage > Contas.
    6. Clique na lista relacionada Obter contas.
    7. Navegar até Spoke do First Advantage > Packages.
    8. Clique no link relacionado Obter pacotes.

    Resultado

    A conta First Advantage e os detalhes do pacote são recuperados.
    Nota:
    Somente usuários com a função de administrador do FADV podem sincronizar os detalhes da conta e do pacote. Usuários com a função de usuário FADV só podem exibir os detalhes recuperados.