Ir para o conteúdo

Atividade Query do ServiceNow v2 no Jitterbit Studio

Introdução

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

Criar uma atividade Query do ServiceNow v2

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

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, consulte Criando uma instância de atividade em Reutilização de componentes.

Uma atividade Query do ServiceNow v2 existente pode ser editada a partir destes locais:

Configurar uma atividade Query do ServiceNow v2

Siga estas etapas para configurar uma atividade Query do ServiceNow v2:

Etapa 1: Insira um nome e selecione um objeto ServiceNow

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

  • Menu de endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, consulte Alterar o endpoint atribuído em Telas de configuração.

    • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint selecionado no momento.

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

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

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

    • Pesquisa: 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 serão filtrados em tempo real a cada digitação. Para recarregar objetos do endpoint ao pesquisar, insira critérios de pesquisa e depois atualize, conforme descrito abaixo.

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

    • Selecionando um objeto: Na 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 v2:

  • Nome: O nome do objeto do ServiceNow.

    -   **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 v2 pode não ter sido bem-sucedida. 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 fechar 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 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: Construir sua consulta

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

Dica

Campos com um ícone de variável permitem usar variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete de abertura [ no campo ou clique no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • Pesquisar: Digite qualquer parte de um nome de 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 digitação.

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

  • 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 deseja incluir na consulta para adicioná-los automaticamente à instrução SELECT na Cadeia de consulta. Você também pode Selecionar tudo 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 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 uma 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 do menu suspenso e no valor inserido. A cláusula de paginação construída automaticamente aparece na caixa de texto Cadeia 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 aparecem na caixa de texto Cadeia de consulta.

    • 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 Rótulo Descrição
      = Igual a
      != Não igual a
      LIKE 'string' Contém Contém 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: Digite o valor desejado para usar com as seleções do menu suspenso.

    Dica

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

  • Adicionar: Clique para construir automaticamente a cláusula com base nas seleções do menu suspenso 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.

  • Query String: Conforme você seleciona campos, especifica condições e define paginação, a instrução de consulta nesta caixa de texto é preenchida automaticamente com os campos selecionados, condições e limites de paginação. Esta instrução é editável.

    Dica

    A Query String aceita sintaxe SQL padrão para cláusulas não disponíveis com as opções de cláusula Conditions e Paging acima. Por exemplo, adicione uma cláusula ORDER BY para classificar resultados (ORDER BY <field> ASC ou ORDER BY <field> DESC), ou use IS NULL e IS NOT NULL em uma cláusula WHERE para filtrar se um campo tem um valor.

  • Test Query: 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 da operação, o limite de 50 registros não é aplicado a menos que seja especificado no campo Paging (descrito anteriormente).

  • 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 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: Revisar os esquemas de dados

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

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

    Nota

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

    O conector ServiceNow v2 usa a API REST do ServiceNow. Consulte a documentação da API para obter informações sobre os nós de esquema e campos.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas do endpoint ServiceNow v2. 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 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óximas etapas

Importante

Os campos datetime da atividade ServiceNow v2 devem ter seus tipos de dados definidos como string para preservar seus dados em transformações. Para fazer isso, espelhe o esquema na transformação, edite-o e altere o tipo de dados de qualquer campo dateTime para string.

Se uma consulta válida fornecida a uma atividade Query do ServiceNow v2 não corresponder a nenhum registro, a operação será concluída com um status de operação Success operation status. Isso ocorre porque a API REST do ServiceNow retorna um código de status HTTP bem-sucedido (200) mesmo quando nenhum registro corresponde.

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

As ações de menu de uma atividade são acessíveis no painel do projeto e na tela de design. Para detalhes, consulte Activity actions menu em Connector basics.

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

Para usar a atividade com funções de script, escreva os dados em um local temporário e depois 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.