Crie uma ação de fluxo de dados para obter a atividade do usuário

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

    • Crie uma ação de fluxo de dados para obter a atividade do usuário de uma aplicação SaaS.

    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 a atividade do usuário 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

    Por Que e Quando Desempenhar Esta Tarefa

    Monitore a atividade do usuário para encontrar assinaturas de software pelas quais sua empresa está pagando, mas não estão sendo usadas. Você pode recuperar essas assinaturas não utilizadas para reduzir as despesas de software da sua empresa.

    Antes de criar a ação de fluxo de dados, decida como você deseja definir a atividade significativa do usuário. A atividade significativa pode ser uma combinação de ações do usuário. Crie uma ação de fluxo de dados separada para cada métrica de atividade do usuário. Por exemplo, o sistema de base WebexA integração de reuniões define atividade significativa como hospedar uma reunião. Ele usa uma ação de fluxo de dados para obter as datas das reuniões hospedadas mais recentemente para todos os usuários. Se você também queria o. WebexPara incluir o login como atividade significativa, você criaria uma segunda ação de fluxo de dados para obter os horários de login mais recentes para todos os usuários.

    Sua ação de fluxo de dados para obter usuários pode retornar uma métrica de atividade do usuário, como hora do último login. Nesse caso, você não precisa criar uma ação de fluxo de dados para obter a atividade do usuário ou um subfluxo para obter a atividade do usuário, a menos que você queira definir métricas adicionais de atividade do usuário. Certifique-se de que o subfluxo para obter usuários defina esta métrica de atividade do usuário como Última atividade entrada no Assinatura de usuário de upsert ação.

    Procedimento

    1. Navegar até Tudo > Flow Designer > Designer.
    2. Clique em Novo e, em seguida, selecione Fluxo de dados .
    3. No formulário, preencha os campos.
      Tabela 1. Formulário Propriedades da ação
      Campo Valor
      Nome Nome de sua escolha. Por exemplo, Obter atividade do usuário .
      Acessível de Selecione Todos os escopos da aplicação .
      Categoria Deixe este campo em branco.
      Proteção Selecione 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.
    4. Clique em Enviar.
    5. Na seção Entradas da Estrutura de tópicos da ação, clique em Criar entrada .
    6. Adicione uma entrada de tempo de retrospectiva.
      Tabela 2. Entradas
      Rótulo Nome Tipo Obrigatório
      Tempo de reversão look_back_time Data/Hora Sim
    7. Se a API com a qual você está trabalhando exigir autenticação do usuário para solicitações, adicione entradas para autenticação.
      Exemplos de entradas comuns de autenticação de usuário são o ID de usuário administrador e o nome do site. Consulte a documentação Para que sua API escolhida saiba 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.

    8. Clique em Solicitação Na Descrição da ação.
    9. No formulário, preencha os campos.
      Tabela 3. 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 da aplicação SaaS à qual você está integrando.
      Habilitar paginação Selecionado.
      Execute um script antes de cada solicitação Não selecionado.
    10. Clique em Etapa de Configuração de paginação Na Descrição da ação.
    11. Defina variáveis de paginação com base nos parâmetros de consulta usados pela API SaaS.

      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.
    12. 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 concluído 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, converta o valor em um número inteiro, execute as operações necessárias e converta-o de volta em uma cadeia de caracteres.
    13. Clique em Etapa SOAP ou Etapa REST Na Descrição da ação, dependendo da opção selecionada para como você obterá dados.
    14. Se você selecionou SOAP , preencha os detalhes.
      Tabela 4. 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. É definido como o URL de conexão do registro de conexão HTTP(s) vinculado ao alias.
      Detalhes da solicitação
      Criar os Envelopes Manualmente .
      Ações de SOAP Solicitação de API para obter uma lista de atividades significativas do usuário. Por exemplo, o sistema de base WebexA integração de reuniões define atividades significativas do usuário como hospedar uma reunião para que ele use o. LstsummaryMeeting solicitação para obter uma lista de todas as reuniões. 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 atividades significativas do usuário, uma data de início definida como Retroceda no tempo 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 atividade do usuário usada no WebexAtualizar subfluxo de atividade do usuário.
    15. Se você selecionou DESCANSO , preencha os detalhes.
      Tabela 5. 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 documentação Para a API com a qual você está trabalhando para saber como construir 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 Configuração de paginação.
      Adicione outro parâmetro para a data de início para que a solicitação retorne resultados da data de início até a data atual. Defina o valor como Retroceda no tempo entrada.
      Nota:
      Certifique-se de Retroceda no tempo A variável de data/hora de entrada está formatada corretamente para a API com a qual você está trabalhando. Se você precisar reformatar ou converter para outro tipo de dados, como uma cadeia de caracteres, faça isso na ação Pré-processamento etapa de script.

      A imagem a seguir mostra um exemplo concluído da etapa REST. Este exemplo é da ação Obter fluxo de dados do log de auditoria usada no JiraAtualizar subfluxo de atividade do usuário.

      Etapa REST
    16. Clique em Analisando Na Descrição da ação.
    17. No formulário, preencha os campos.
      Tabela 6. 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
    18. Clique em Etapa do divisor Na Descrição da ação.
    19. No formulário, preencha os campos.
      Tabela 7. Formulário de 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 atividade significativo 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/meeting
      • Caminho do item JSON de exemplo: .data.reunião
    20. Clique em Saídas Na Descrição da ação.
    21. Clique em Criar saída e edite a variável conforme mostrado.
      Tabela 8. Ação de saída
      Rótulo Nome Tipo Obrigatório
      targetObject targetObject Objeto Não
    22. Adicione itens secundários para TargetObject para armazenar o e-mail do usuário e a data da atividade significativa.
      Por exemplo, uma resposta XML pode ser semelhante a esta.
      <message>​
  <body>​
    <meeting>
      <meetingID>​12345</meetingID>​
      <startDate>​08/13/2019 20:08:16</startDate>​
      <hostEmail>​email@email.com</hostEmail>​
    </meeting>​
    <meeting>
      ...
    </meeting>
  </body>​
</message>
      Para esta resposta, adicione os itens secundários conforme mostrado.
      Tabela 9. Itens secundários para targetObject
      Rótulo Nome Tipo Obrigatório
      e-mail e-mail Cadeia de caracteres Não
      last_activity last_activity Cadeia de caracteres Não
    23. Na Estrutura de tópicos da ação, clique em Etapa do analisador de scripts .
    24. Crie um TargetObject objeto de saída para cada elemento de atividade significativo na resposta e mapeie cada data de atividade e e-mail do usuário para TargetObject itens secundários.

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

      Nota:
      Estes exemplos mostram os tipos de elementos que podem estar contidos em uma resposta. 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.email = xmlDoc.getNodeText('/meeting/hostEmail');
    outputs.targetObject.last_activity = xmlDoc.getNodeText('/meeting/startDate');
})(inputs, outputs)
      Script de exemplo que analisa uma resposta JSON. 
      (function parse(inputs, outputs) {
    var record = JSON.parse(inputs.sourceItem);
    outputs.targetObject.email = record.hostEmail;
    outputs.targetObject.last_activity = record.startDate;
})(inputs, outputs)
    25. Para testar sua ação de fluxo de dados, clique em 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.
    26. Depois de verificar se a ação de fluxo de dados está funcionando conforme esperado, clique em Publicar .