Crie uma ação de fluxo de dados para obter usuários

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

    • Crie uma ação de fluxo de dados para obter uma lista de assinaturas de usuário do SaaSaplicação.

    Antes de Iniciar

    Se você estiver usando um existente ServiceNow® Integration Hubspoke, descubra se ele tem uma ação de fluxo de dados para obter uma lista de usuários que você pode usar em vez de criar uma. Para obter mais informações sobre ações de fluxo de dados, consulte Ações de fluxo de dados .

    Função necessária: Flow_designer ou administrador

    Procedimento

    1. Navegar até Tudo > Flow Designer > Designer.
    2. Selecione Novo.
    3. Selecione Fluxo de dados .
    4. No formulário, preencha os campos.
      Tabela 1. Formulário Propriedades da ação
      Campo Valor
      Nome Nome de sua escolha.

      Por exemplo, Obter usuários .
      Acessível de Todos os escopos da aplicação .
      Categoria Deixe este campo em branco.
      Proteção Nenhum .
      Aplicação Aplicativo Spoke para integrar ao SaaSaplicação.

      Este app Spoke pode ser um existente Integration Hubspoke ou um novo spoke que você criou.
      Anotação em fluxo Deixe este campo em branco.
      Descrição Descrição de sua escolha.
    5. Selecione Enviar.
    6. Se a API com a qual você está trabalhando exigir autenticação de usuário para solicitações, selecione Entradas Na Descrição de ação e adicione entradas para autenticação.
      Exemplos de entradas comuns de autenticação de usuário são id do usuário administrador e. nome do local . Consulte a documentação da API escolhida para saber mais sobre os requisitos de autenticação de usuário em seu caso específico.Se a API exigir um token de acesso, um Valor da credencial a variável é criada automaticamente mais tarde. Você não precisa adicionar um token de acesso como uma entrada.

      Ao usar sua ação de fluxo de dados concluída em um subfluxo, você define quais valores passar como essas entradas.

    7. Selecione Solicitação Na Descrição da ação.
    8. No formulário, preencha os campos.
      Tabela 2. Formulário de solicitação
      Campo Valor
      Como você obterá dados Escolha uma das opções Etapa REST ou Etapa SOAP .

      Sua escolha depende da API do SaaSa aplicação à qual você está integrando.
      Habilitar paginação Selecionado .
      Execute um script antes de cada solicitação Não selecionado.
    9. Selecione Etapa de Configuração de paginação Na Descrição da ação.
    10. Defina variáveis de paginação com base nos parâmetros de consulta usados pelo SaaSAPI.

      Se você estiver usando paginação baseada em deslocamento, use o modelo de paginação Limite/deslocamento para carregar a configuração de paginação.

      Nota:
      O valor do reservado GetNextPage a variável determina se outra página de resultados deve ser solicitada. Desde que GetNextPage a variável é verdadeiro , a ação continua enviando solicitações para a próxima página.
    11. Escreva um Variáveis de paginação script para atualizar as variáveis de paginação.

      O script é executado em cada solicitação. Se você estiver usando um modelo de paginação, ajuste o script pré-carregado conforme necessário.

      A imagem a seguir mostra um exemplo da conclusão da etapa de configuração da paginação. Este exemplo é da ação Obter fluxo de dados de usuários usada no WebexSubfluxo de assinaturas de download.

      Etapa de Configuração de paginação
      Nota:
      As variáveis de paginação são compatíveis somente com o tipo de dados de cadeia de caracteres. Para executar operações matemáticas, você deve converter o valor em um número inteiro, executar todas as operações necessárias e convertê-lo de volta em uma cadeia de caracteres.
    12. Selecione Etapa SOAP ou Etapa REST Na Descrição de ação para receber dados.
      • Se você selecionou Etapa SOAP , preencha os detalhes.
        Tabela 3. Formulário de etapa SOAP
        Campo Valor
        Detalhes da Conexão
        Conexão Usar alias de conexão .
        Alias de Conexão Alias de conexão que você criou quando criou o perfil de integração. Se você ainda não criou um perfil de integração, siga as etapas a. crie um perfil de integração personalizado com um alias de conexão.
        Endpoint Este valor é preenchido automaticamente quando você seleciona o alias de conexão.

        Este valor é definido como o URL de conexão do registro de conexão HTTPS vinculado ao alias.
        Detalhes da solicitação
        Criar os Envelopes Manualmente .
        Ações de SOAP Solicitação de API para obter uma lista de todos os usuários. Consulte a documentação da API escolhida para selecionar a solicitação apropriada.
        Envelope de SOAP Mensagem de solicitação XML para obter uma lista de todos os usuários. Consulte a documentação da API escolhida para saber como escrever uma mensagem de solicitação XML. Em geral, o cabeçalho deve ter suas variáveis de entrada para autenticação do usuário, bem como Valor da credencial o token de acesso. O corpo deve incluir a solicitação para obter uma lista de todos os usuários e suas variáveis da etapa de configuração da paginação.
        Nota:
        Para obter um exemplo de um envelope SOAP, consulte a ação Obter fluxo de dados de usuários usada no WebexSubfluxo de assinaturas de download.
      • Se você selecionou Etapa REST , preencha os detalhes.
        Tabela 4. Formulário de etapa REST
        Campo Valor
        Detalhes da Conexão
        Conexão Usar alias de conexão .
        Alias de Conexão Alias de conexão que você criou quando criou o perfil de integração. Se você ainda não criou um perfil de integração, siga as etapas a. crie um perfil de integração personalizado com um alias de conexão.
        URL base Este valor é preenchido automaticamente quando você seleciona o alias de conexão. É definido como o URL de conexão do registro de conexão HTTP(s) vinculado ao alias.
        Detalhes da solicitação
        Criar solicitação Manualmente .
        Caminho do recurso Caminho para o recurso. Este valor é anexado ao URL base. Consulte a documentação da API com a qual você está trabalhando para saber como criar o caminho do recurso.
        Método HTTP OBTER .
        Parâmetros de consulta Adicione parâmetros para paginação. Defina os valores como as variáveis que você criou na etapa de configuração da paginação.

        A imagem a seguir mostra um exemplo concluído da etapa REST. Este exemplo é do GET JiraAção de fluxo de dados de usuários usada no JiraSubfluxo de assinaturas de download.

        Etapa REST
    13. Selecione Analisando Na Descrição da ação.
    14. No formulário, preencha os campos.
      Tabela 5. Analisando formulário
      Campo Valor
      Como você identificará cada registro Divisor de JSON/XML
      Como você analisará cada item em um objeto Analisador de Script
    15. Selecione Etapa do divisor Na Descrição da ação.
    16. No formulário, preencha os campos.
      Tabela 6. Etapa do divisor
      Campo Valor
      Formatos de Origem Selecione XML ou JSON , Dependendo do formato retornado pela resposta da API.
      Caminhos do Item Caminho absoluto para um elemento de usuário na mensagem de resposta. Consulte a documentação da API com a qual você está trabalhando para obter informações sobre o formato da mensagem de resposta.
      • Caminho do item XML de exemplo: /message/body/user
      • Caminho do item JSON de exemplo: usd .data.user
    17. Selecione Saídas Na Descrição da ação.
    18. Selecione Criar saída e edite a variável conforme mostrado.
      Tabela 7. Ação de saída
      Rótulo Nome Tipo Obrigatório
      targetObject targetObject Objeto Não
    19. Adicione itens secundários para TargetObject com base nos elementos secundários do usuário retornados na mensagem de resposta.
      Por exemplo, uma resposta XML pode ser semelhante a esta.
      <message>​
  <body>​
    <user>
      <userID>​12345</userID>​
      ​<email>​email@email.com</email>​
      <firstName>​Jane</firstName>​
      <lastName>​Doe</lastName>​
      <lastLoginTime>​08/13/2019 20:08:16</lastLoginTime>​
      <active>​TRUE</active>​
    </user>​
    <user>
      ...
    </user>
  </body>​
</message>
      Para esta resposta, adicione os itens secundários conforme mostrado.
      Tabela 8. Itens secundários para targetObject
      Rótulo Nome Tipo Obrigatório
      userID userID Cadeia de caracteres Não
      e-mail e-mail Cadeia de caracteres Não
      nome nome Cadeia de caracteres Não
      sobrenome sobrenome Cadeia de caracteres Não
      LatstLoginTime LatstLoginTime Cadeia de caracteres Não
      ativo ativo Verdadeiro/Falso Não
    20. Selecione Etapa do analisador de scripts Na Descrição da ação.
    21. Crie um TargetObject objeto de saída para cada elemento de usuário na resposta e, em seguida, mapeie cada elemento secundário de usuário para um TargetObject item secundário.

      O script do analisador é executado para cada elemento de usuário.

      Nota:
      Estes exemplos mostram os tipos de elementos que geralmente estão contidos em uma resposta a uma solicitação Obter usuários. Não copie diretamente esses scripts. Use nomes de elementos da documentação da API com a qual você está trabalhando.
      Script de exemplo que analisa uma resposta XML. 
      (function parse(inputs, outputs) {
    var xmlDoc = new XMLDocument(inputs.sourceItem, false);
    outputs.targetObject.userID = xmlDoc.getNodeText('/user/userID');
    outputs.targetObject.email = xmlDoc.getNodeText('/user/email');
    outputs.targetObject.firstName = xmlDoc.getNodeText('/user/firstName');
    outputs.targetObject.lastName = xmlDoc.getNodeText('/user/lastName');
    outputs.targetObject.lastLoginTime = xmlDoc.getNodeText('/user/lastLoginTime');
    outputs.targetObject.active = xmlDoc.getNodeText('/user/active');
})(inputs, outputs)
      Script de exemplo que analisa uma resposta JSON. 
      (function parse(inputs, outputs) {
    var record = JSON.parse(inputs.sourceItem);
    outputs.targetObject.userID = record.userID;
    outputs.targetObject.email = record.email;
    outputs.targetObject.firstName = record.firstName;
    outputs.targetObject.lastName = record.lastName;
    outputs.targetObject.lastLoginTime = record.lastLoginTime;
    outputs.targetObject.active = record.active;
})(inputs, outputs)
    22. Para testar sua ação de fluxo de dados, selecione Teste .
      1. Exiba os resultados de testes e os logs do sistema para obter detalhes sobre erros.
        Para exibir logs do sistema, navegue até Logs do sistema > Log do Sistema > Tudo.
      2. Se sua ação de fluxo de dados tiver erros, verifique se você está usando os endpoints corretos e se as solicitações e respostas da API estão estruturadas conforme o esperado.
    23. Depois de verificar se a ação de fluxo de dados está funcionando conforme esperado, selecione Publicar .

    O que Fazer Depois

    Crie um subfluxo para obter usuários.