Atividade de Query do ServiceNow (Descontinuada) no Jitterbit Studio
Aviso
O conector do ServiceNow foi descontinuado e não possui mais suporte. Em um lançamento futuro, essa atividade será removida permanentemente junto com o restante do conector. Use a atividade de Query no conector ServiceNow v2 em seu lugar.
Introdução
Uma atividade Query do ServiceNow, usando sua conexão do ServiceNow, recupera registros do ServiceNow e destina-se a ser usada como fonte para fornecer dados em uma operação.
Criar uma atividade de Query do ServiceNow
Uma instância de uma atividade Query do ServiceNow é criada a partir de uma conexão do ServiceNow 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, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.
Uma atividade Query do ServiceNow existente pode ser editada a partir desses locais:
- A tela de design (veja Menu de ações de componente em Tela de design).
- A aba Components do painel do projeto (veja Menu de ações de componente em Aba Components do painel do projeto).
Configurar uma atividade de Query do ServiceNow
Siga essas etapas para configurar uma atividade Query do ServiceNow:
-
Etapa 1: Informar um nome e selecionar um objeto
Forneça um nome para a atividade e selecione o objeto a ser consultado. -
Etapa 2: Construir a sua query
Defina condições em uma query usando os campos do objeto e aplique paginação a uma query. -
Etapa 3: Revisar os esquemas de dados
Todos os esquemas de solicitação ou resposta são exibidos.
Etapa 1: Informar um nome e selecionar um objeto
Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa está descrito abaixo.
-
Menu de endpoint: Se você tem 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, veja 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: Informe um nome para identificar a atividade. O nome deve ser único para cada atividade Query do ServiceNow e não deve conter barras
/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.
-
Pesquisa: Informe o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não faz distinção entre maiúsculas e minúsculas. Se objetos já estiverem exibidos dentro da tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint ao pesquisar, informe critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.
-
-
Atualizar: Clique no ícone de atualização 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: 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:
-
Nome: O nome do objeto do ServiceNow.
-
Tipo: O tipo de objeto, 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 ServiceNow pode não ter sido bem-sucedida. Verifique se está conectado reabrindo a conexão e testando as credenciais novamente.
-
Salvar e Sair: Se habilitado, 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 confirmação de que você deseja descartar as alterações.
Etapa 2: Construir sua consulta
Nesta etapa, construa uma instrução de consulta definindo condições para campos de objeto e aplicando paginação através do construtor de consultas ou inserindo manualmente uma instruçã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 instrução de consulta no campo Cadeia de consulta.
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 de abertura [ no campo ou clique no ícone de variável para exibir um menu listando as 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 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: Selecione as caixas de seleção dos campos que deseja incluir na consulta para adicioná-los automaticamente à instrução de consulta na Cadeia de consulta. Você também pode Selecionar Tudo dos 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 é 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 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 != Não igual 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.
-
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 Sequência de consulta.
-
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 apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos no tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.
-
Sequência de consulta: 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. Este campo é editável, ou seja, você pode inserir manualmente uma instrução de consulta ou editar a instrução preenchida automaticamente.
Nota
Os valores de qualquer variável global usada na Sequência 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 no 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 seu lugar.
-
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, as mensagens de erro relevantes são exibidas.
Nota
Durante o tempo de execução da operação, o limite de 50 registros não é aplicado a menos que seja especificado no campo Paginação (descrito anteriormente). Se você editar a Sequência de consulta manualmente, a consulta deve ser válida e validada por meio deste botão para habilitar o botão Próximo.
-
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.
-
Esquemas de dados: Esses esquemas de dados são herdados pelas transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.
O conector ServiceNow usa a API REST do ServiceNow. Para obter mais informações sobre os campos de esquema, consulte Esquemas e consulte a API REST do ServiceNow em Documentação do desenvolvedor ServiceNow, ajustando a URL da documentação selecionando a sua versão de lançamento do ServiceNow.
Nota
Os dados fornecidos em uma transformação têm precedência sobre a configuração de atividade.
Os nomes de tabelas prefixados com
sys_são renomeados para começar comsystem_para evitar nomes reservados do ServiceNow. -
Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas do endpoint do ServiceNow. Esta ação também regenera um esquema em outros locais do projeto em que 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 de 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 de datetime da atividade ServiceNow devem ter seus tipos de dados definidos como string para preservar seus dados nas transformações. Para fazer isso, espelhe o schema na transformação, edite-o e altere o tipo de dados de qualquer campo dateTime para string.
Após configurar uma atividade Query do ServiceNow, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Também é possível 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 obter detalhes, consulte Menu de ações da atividade em Noções básicas sobre conectores.
As atividades Query do ServiceNow podem ser usadas como uma fonte com estes padrões de operação:
- Padrão de transformação
- Padrão de arquivo com dois destinos (apenas como primeira fonte)
- Padrão de arquivo HTTP com dois destinos (apenas como primeira fonte)
- Padrão de duas transformações (como primeira ou segunda fonte)
Para usar a atividade com funções de script, grave 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.