Ir para o conteúdo

Atividade de Consulta do ServiceNow

Introdução

Uma atividade de Consulta do ServiceNow, utilizando sua conexão do ServiceNow, recupera registros do ServiceNow e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Problemas conhecidos

Ao configurar uma atividade de Consulta do ServiceNow, é importante estar ciente deste problema conhecido atual:

  • Os campos DateTime usam o tipo de dado errado no esquema de resposta gerado por uma atividade de Consulta do ServiceNow

    • Resumo: Durante a configuração de uma atividade de Consulta do ServiceNow, no esquema gerado na etapa 3, um campo DateTime que está retornando um valor (seja um DateTime ou um nulo) em vez disso usa uma string 'dateTime'.

    • Solução alternativa: Na transformação, espelhe o esquema, depois edite-o e mude o tipo de dado de quaisquer campos 'dateTime' para string.

  • Nomes de tabelas prefixados com sys_ são renomeados para começar com system_ para evitar um nome reservado do ServiceNow

    • Resumo: Quaisquer nomes de tabelas prefixados com sys_ são renomeados para começar com system_ para evitar um nome reservado do ServiceNow.

    • Solução alternativa: Esteja ciente ao especificar tabelas que esses nomes foram expostos pelo conector por esses nomes revisados.

Criar uma atividade de Consulta do ServiceNow

Uma instância de uma atividade de Consulta do ServiceNow é criada a partir de uma conexão do ServiceNow usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Consulta do ServiceNow existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta do ServiceNow

Siga estas etapas para configurar uma atividade de Consulta do ServiceNow:

Etapa 1: Insira um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de Consulta do ServiceNow etapa 1

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do ServiceNow e não deve conter barras normais / ou dois pontos :.

  • Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do ServiceNow.

    • Objeto do ServiceNow Selecionado: Após um objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar objetos do endpoint ServiceNow. Isso pode ser útil se objetos foram adicionados ao ServiceNow. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

  • Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint ServiceNow:

    -   **Nome:** O nome do objeto do ServiceNow.

-   **Tipo:** O tipo do objeto, que pode ser _Tabela_ ou _Visualização_.

-   **Descrição:** A descrição do objeto do ServiceNow.

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão com o ServiceNow pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Construa sua consulta

Nesta etapa, construa uma declaração de consulta definindo condições para os campos do objeto e aplicando paginação, seja através do construtor de consultas ou inserindo manualmente uma declaração de consulta. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Nota

Você pode ignorar o construtor de consultas e inserir uma declaração de consulta no campo String de consulta.

Configuração da atividade de consulta do ServiceNow etapa 2

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • Pesquisar: Insira qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos do objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada tecla pressionada.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar os campos do objeto a partir do endpoint do ServiceNow.

  • Selecionar Todos: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma vez.

  • Selecionar Campos: Selecione as caixas de seleção dos campos que você deseja incluir na consulta para que sejam adicionados automaticamente à declaração da consulta na String de consulta. Você também pode Selecionar Todos os campos de uma vez usando a caixa de seleção.

  • Paginação: Para adicionar uma cláusula de paginação (um limite no número de registros com um deslocamento opcional), você pode usar o dropdown para definir o limite de paginação e o campo para inserir um deslocamento. Se um deslocamento não for especificado, o padrão é 0. Uma única cláusula de paginação é suportada. Se a cláusula de paginação não for incluída, todos os registros são retornados.

    • Aplicar: Clique para construir automaticamente a cláusula com base nas seleções do dropdown e no valor inserido. A cláusula de paginação construída automaticamente aparece na caixa de texto da String de consulta.

    • Remover: Clique para remover uma cláusula de paginação que foi aplicada.

  • Condições: Para adicionar cláusulas condicionais, use os campos abaixo como entrada para ajudar a construir as cláusulas, que então aparecem na caixa de texto da String de consulta.

    • Campo: Use o dropdown para selecionar um campo do objeto selecionado.

    • Operador: Use o dropdown para selecionar um operador que seja apropriado para o tipo de dado do campo:

      Operador Rótulo Descrição
      = Igual
      != Diferente
      LIKE 'string' Como Como string
      LIKE 'string%' Começa com Começa com string
      LIKE '%string' Termina com Termina com string
      LIKE '%string%' Contém Contém string
      < Menor que
      <= Menor ou igual
      > Maior que
      >= Maior ou igual

  • Valor: Insira o valor desejado a ser utilizado com as seleções do dropdown.

  • Adicionar: Clique para construir automaticamente a cláusula com base nas seleções do dropdown e no valor inserido. A cláusula condicional é adicionada à caixa de texto String de consulta.

  • Remover Todos: Clique para remover todas as cláusulas condicionais inseridas.

    Importante

    Os campos na tabela Propriedades HTTP Avançadas exibem o ícone de variável apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

  • String de Consulta: À medida que você seleciona campos, especifica condições e define paginação, a declaração de consulta nesta caixa de texto é preenchida automaticamente com os campos selecionados, condições e limites de paginação. Este campo é editável, o que significa que você pode inserir manualmente uma declaração de consulta ou editar a declaração preenchida automaticamente.

    Nota

    Os valores de quaisquer variáveis globais usadas na String de consulta não são preenchidos ao usar o botão Testar Consulta, mesmo que um valor padrão seja especificado. Os valores das variáveis globais serão obtidos em tempo de execução quando a consulta for executada. Para testar a consulta com um valor de variável padrão, use uma variável de projeto em vez disso.

  • Testar Consulta: Clique para validar a consulta. Se a consulta for válida, um máximo de 50 registros recuperados da consulta é exibido em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas.

    Nota

    Durante a execução, o limite de 50 registros não é imposto, a menos que seja especificado no campo Paginação (descrito anteriormente). Se você editar a String de consulta manualmente, a consulta deve ser válida e validada através deste botão para habilitar o botão Próximo.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de consulta ServiceNow - etapa 3

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    O conector ServiceNow utiliza a API REST do ServiceNow. Para mais informações sobre os campos do esquema, consulte Esquemas e consulte a API REST do ServiceNow na documentação do desenvolvedor do ServiceNow, ajustando a URL da documentação ao selecionar sua versão de lançamento do ServiceNow.

    Nota

    Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do ServiceNow. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Consulta do ServiceNow, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações de menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Fundamentos do conector.

As atividades Query do ServiceNow podem ser usadas como fonte com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.