Atividade de Consulta do ServiceNow¶

Introdução¶

Uma atividade ServiceNow Query, usando sua conexão ServiceNow, recupera registros do ServiceNow e deve ser usado como fonte para fornecer dados em uma operação.

Problemas Conhecidos¶

Ao configurar uma atividade ServiceNow Query, você deve estar ciente deste problema conhecido atual:

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

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

  • Solução alternativa: Na transformação, espelhe o esquema, edite-o e altere o tipo de dados de qualquer Campos 'dateTime' para string.

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

  • Resumo: Qualquer nome de tabela prefixado com sys_ são renomeados para começar system_ para evitar um nome reservado do ServiceNow.

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

Crie uma Atividade de Consulta do ServiceNow¶

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

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

Uma atividade existente do ServiceNow Query pode ser editada nestes locais:

• A quadro de design (consulte Menu Ações do componente em Quadro de Design).
• A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia Componentes do painel do projeto).

Configurar uma Atividade de Consulta do ServiceNow¶

Siga estas etapas para configurar uma atividade Query do ServiceNow:

• Etapa 1: Insira um nome e selecione um objeto
  Forneça um nome para a atividade e selecione o objeto a ser consultado.

• Etapa 2: Crie sua consulta
  Defina condições em uma consultar usando os campos de objeto e aplique paginação a uma consultar.

• Etapa 3: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta são exibidos.

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.

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

• Selecione um objeto: Esta seção exibe objetos disponíveis no endpoint do ServiceNow.

  • Objeto ServiceNow selecionado: Depois que um objeto é selecionado, ele é listado aqui.

  • Pesquisar: Insira qualquer parte do nome do objeto na caixa de pesquisa para filtrar a lista de objetos. A busca não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

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

  • Selecionando um objeto: Na tabela, clique em qualquer lugar de 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 de objeto, Table ou View.

    • Descrição: A descrição do objeto do ServiceNow.

  Dica

  Se a tabela não for preenchida com objetos disponíveis, a conexão ServiceNow pode não ter sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Crie Sua Consulta¶

Nesta etapa, defina condições em uma consultar usando os campos de objeto e aplique paginação a uma consultar. Cada elemento da interface do usuário desta etapa é descrito abaixo.

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

• Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar campos do objeto do endpoint ServiceNow.

• Selecionar tudo: 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: Marque as caixas de seleção dos campos que você deseja incluir na consultar para que sejam adicionados automaticamente à instrução SELECT na String de consulta. Você também pode Selecionar todos os campos de uma vez usando a caixa de seleção.

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

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

  • 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 aparecem na caixa de texto Query String.

  • Objeto: Campo: Use o menu suspenso para selecionar um campo do objeto selecionado.

  • Operador: Use o menu suspenso para selecionar um operador apropriado para o tipo de dados do campo:

    Operador	Etiqueta	Descrição
    =	Igual a
    !=	Não é igual
    COMO 'string'	Curtir	Como string
    COMO 'string%'	Começa com	Começa com string
    LIKE '%string'	Termina com	Termina com string
    COMO '%string%'	Contém	Contém string
    <	Menos que
    <=	Menor ou igual
    >	Maior que
    >=	Maior ou igual

  • Valor: Insira o valor desejado para usar com as seleções suspensas.

    Dica

    Ao usar variáveis globais nas condições de uma cláusula WHERE, é recomendado especificar um valor padrão para que o teste do script seja possível. Caso contrário, como as variáveis globais obtêm seu valor em tempo de execução, a sintaxe poderá ser invalidada durante o teste ou nenhum dado poderá ser retornado se nenhum valor padrão for especificado.

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

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

  Importante

  Os campos na tabela Propriedades HTTP avançadas exibem o ícone de variável somente 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 a paginação, a instrução de consultar nesta caixa de texto é preenchida automaticamente com os campos, condições e limites de paginação selecionados.

• Consulta de Teste: Clique para validar a consultar. Se a consultar for válida, uma amostra de até 10 registros recuperados da consultar será exibida em uma tabela. Se a consultar não for válida, serão exibidas mensagens de erro relevantes.

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

• Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revise 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.

• 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 usa a API REST ServiceNow. Para obter mais informações sobre os campos do esquema, consulte Esquemas e consulte a API REST do ServiceNow em documentação do desenvolvedor do ServiceNow, ajustando o URL da documentação selecionando 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 atualização ou a palavra Refresh para regenerar esquemas do endpoint ServiceNow. Esta ação também regenera um esquema em outros locais 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos¶

Depois de configurar uma atividade ServiceNow Query, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas de operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu Ações da atividade em Noções básicas do conector.

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

• Padrão de transformação
• Padrão de arquivo de dois alvos (apenas como a primeira fonte)
• Padrão de arquivo HTTP de dois destinos (apenas como a primeira fonte)
• Padrão de duas transformações (como a primeira ou segunda fonte)

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

Quando estiver pronto, implantar e execute a operação e validar o comportamento verificando os logs de operação.