Configurar o First Advantage spoke

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 6 min. de leitura

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

    Antes de Iniciar

    • Solicitar uma assinatura de Integration Hub.
    • Ative o First Advantage spoke.
    • Função necessária: administrador

    Criar registro de conexão para o First Advantage spoke

    Crie um registro de conexão para integrar sua instância ServiceNow e o servidor First Advantage. Sua instância ServiceNow usa este registro de conexão para executar as ações de spoke do First Advantage.

    Antes de Iniciar

    Função necessária: administrador

    Adquira a chave de API do servidor First Advantage.

    Procedimento

    1. Navegar até Tudo > Automação de Processo > Workflow Studio.
    2. Selecione Integrações.
    3. Selecione a guia Conexões.
    4. No campo Pesquisar todas as conexões, insira First Advantage.
      Confirme se a guia Saída está selecionada.
    5. No bloco FirstAdvantage, selecione Exibir detalhes.
      Botão Exibir detalhes no bloco de alias do FirstAdvantage.
    6. Selecione Configurar.
    7. Preencha o formulário.
      Tabela 1. Formulário de conexão do spoke do First Advantage
      Campo Descrição
      Nome da conexão O nome da conexão. O nome padrão e somente leitura do primeiro registro é o mesmo do alias de conexão. Você pode fornecer um nome diferente ao criar um registro de conexão clicando em Adicionar conexão.
      URL de conexão Opção para fornecer o URL de conexão ao servidor First Advantage. O URL é https://rest-ua.fadv.com.
      E-mail de distribuição Opção para fornecer um ID de e-mail de distribuição.
      Versão Opção para fornecer a versão da API.
      Chave de API Opção para inserir a chave de API que o servidor First Advantage usa para autenticar solicitações de acesso.
      Formulário de conexão do First Advantage.
    8. Selecione Configurar conexão.
      O registro de conexão está configurado.

    Criar estados First Advantage em sua instância ServiceNow

    Crie estados First Advantage a serem exibidos na lista de estados 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 2. Registro 1 - Estado de rascunho
      Campo Valor
      Tabela Tarefa [task]
      Elemento estado
      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 3. Registro 2 - Estado pronto
      Campo Valor
      Tabela Tarefa [task]
      Elemento estado
      Rótulo Pronto
      Valor 173
      Tabela 4. Registro 3 - Estado em andamento
      Campo Valor
      Tabela Tarefa [task]
      Elemento estado
      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é Tudo > 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 o texto Cancelado em Novo 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 o texto Concluído no item Novo.
      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 quebrado

    Crie os estados Concluído - Sucesso e Concluído - Negócio quebrado 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é Tudo > 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 o texto de item Concluído - Sucesso em Novo.
      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 o texto de item Concluído - Negócio quebrado em novo.
      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 - Êxito e Concluído - Negócio quebrado são criados na tabela Tarefa do funcionário do First Advantage [sn_fadv_spoke_first_advantage_employee_task_table].

    Configurar First Advantage webhooks

    Receba atualizações de eventos de convite e pedido na instância ServiceNow configurando os webhooks.

    Antes de Iniciar

    Função necessária: administrador

    Forneça a chave em 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é Tudo > 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 de 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é Tudo > 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 Resource path, 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 Resource path, 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 esses 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 de API para eventos de convite neste formato:<ServiceNow-instance-URL> /api/sn_fadv_spoke/fadv/invite_status
    • Endpoint de 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é Tudo > Spoke do First Advantage > Contas.
    2. Clique em Nova.
    3. No formulário, preencha os valores.
      Tabela 5. Formulário da conta
      Campo Descrição
      Conta principal Opção para especificar que a 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 > Pacotes.
    8. Clique no link relacionado Obter pacotes.

    Resultado

    Os detalhes da conta First Advantage e do pacote são recuperados.
    Nota:
    Somente usuários com a função de administrador 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.