Atividade de consulta OData

Introdução

Uma atividade OData Query, usando sua conexão OData, consulta dados de objetos de um endpoint OData e se destina a ser usado como uma fonte para fornecer dados em uma operação.

Criar uma atividade de consulta OData

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

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

Uma atividade OData Consulta existente pode ser editada nestes locais:

• A quadro de design (veja menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).

Configurar uma atividade de consulta OData

Siga estas etapas para configurar uma atividade OData Consulta:

• Etapa 1: Insira um nome e especifique as configurações
  Forneça um nome para a atividade, especifique a classe de objeto a ser consultar e especifique quaisquer cabeçalhos HTTP necessários.

• Etapa 2: Selecionar objetos filho
  Selecione classes de objetos filho para consultar com base na classe de objeto selecionada na etapa anterior.

• Etapa 3: Definir uma sequência de filtros
  O Query Builder é usado para definir condições em uma consultar usando os campos de objeto e aplicar paginação a uma consultar.

• Etapa 4: Revise o esquema de dados
  Todos os esquemas de resposta gerados a partir do endpoint são exibidos.

Etapa 1: insira um nome e especifique as configurações

Nesta etapa, forneça um nome para a atividade e especifique a classe de objeto para consultar e quaisquer cabeçalhos HTTP necessários. Cada elemento de interface do usuário desta etapa é descrito abaixo.

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

• Selecionar objeto: Esta seção exibe classes de objetos disponíveis no endpoint OData.

  • Objeto selecionado: Depois que uma classe de objeto é selecionada, ela é listada aqui.

  • Pesquisar: Insira qualquer valor de 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 pressionamento de tecla. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar classes de objeto do endpoint OData. Isso pode ser útil se o esquema do ponto de extremidade OData tiver sido atualizado para suportar novos tipos de objetos. 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 uma classe de objeto. Apenas uma classe de objeto pode ser selecionada. As informações disponíveis para cada objeto são obtidas do endpoint OData:

    • Nome: O nome da classe de objeto do endpoint OData.

    • Descrição: A descrição da classe de objeto do endpoint OData.

  Dica

  Se a tabela não for preenchida com classes de objeto disponíveis, a conexão OData pode não ser bem-sucedido. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

• Propriedades HTTP avançadas: Defina cabeçalhos HTTP para a consultar. O protocolo OData aceita cabeçalhos HTTP padrão definidos em Rfc 2616 (seção 14) bem como quaisquer cabeçalhos personalizados específicos para o endpoint. Clique no ícone adicionar para adicionar um cabeçalho à tabela abaixo e inserir um par chave-valor para cada parâmetro de solicitação.

  Para salvar a linha, clique no ícone de envio na coluna mais à direita.

  Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição ou excluir ícone .

  Para excluir todas as linhas, clique em Limpar tudo.

  Nota

  Cabeçalhos personalizados devem ser configurados no endpoint para que ele os aceite como parte desta solicitação. Se você estiver usando o Microsoft Azure para gerenciar seu endpoint OData, consulte a documentação da Microsoft sobre Cabeçalhos personalizados em Acessando Endpoints que exigem autenticação.

  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 variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

• 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Selecione objetos filho

Nesta etapa, selecione as classes de objetos filho para incluir na consultar com base na classe de objeto selecionada na etapa anterior. Cada elemento de interface do usuário desta etapa é descrito abaixo.

• Selecionar objetos filho: Esta seção é usada para selecionar classes de objetos filho para consultar. Esta seção é opcional e pode ser ignorada selecionando Próximo.

  • Objetos filho disponíveis: Esta coluna exibe classes de objetos filho para seleção.

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

    • Atualizar: Clique no ícone de atualização para recarregar classes de objetos filho do endpoint OData. Isso pode ser útil se você adicionou recentemente classes de objetos filho ao endpoint OData.

    • Adicionando um Objeto Filho: Dentro da coluna, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone adicionar para adicionar classes selecionadas à coluna Objetos Filhos Selecionados:

      

  • Objetos Filhos Selecionados: Esta coluna exibe classes de objetos filhos selecionadas.

    • Removendo um Objeto Filho: Dentro da coluna, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone remover para retornar as classes selecionadas para a coluna Objetos Filhos Disponíveis:

      

• 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: Defina uma sequência de filtros

Nesta etapa, a Filter String de uma consulta é definida para uma consultar usando campos de objeto disponíveis e configurações de consultar. Cada elemento de interface de usuário desta etapa é descrito abaixo.

A Filter String pode ser configurada nas abas Basic ou Advanced.

• Básico: Permite que você crie a String de filtro com campos guiados:

  

  • Campos de objeto: Selecione os campos a serem usados na consultar com base na classe de objeto selecionada.

    • Pesquisar: Insira qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o objeto selecionado. A pesquisa 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 Atualizar para recarregar campos do objeto do endpoint OData.

    • Selecionar tudo na classe de objeto: 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 só vez.

    • Selecionar campos: Selecione as caixas de seleção dos campos que você deseja incluir na consultar para que eles sejam adicionados automaticamente à String do filtro. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.

  • Tamanho da página: Insira o número máximo de resultados a serem recuperados para cada página na resposta da consultar. Se deixado em branco, cada página conterá 100 resultados.

    Nota

    Se a paginação do lado do cliente for necessária, use os campos Ignorar e Topo.

  • Incluir contagem: Selecione para incluir o número de resultados de uma consultar como parte da resposta. Por exemplo, se uma consultar retornar 5 resultados no total, a resposta também incluirá "_odata.count": 5.

  • Full Text Search: Insira termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint OData manipula como a pesquisa é interpretada para uma classe de objeto.

  • Ignorar: Insira o número de resultados a serem ignorados na resposta da consultar. Usado para paginação do lado do cliente.

  • Topo: Insira o número máximo de resultados a receber na resposta da consultar. Usado para paginação do lado do cliente.

  • Cláusulas condicionais: Para adicionar condicionais, use esses campos como entrada para ajudar a construir as cláusulas, que então aparecem na String de filtro.

    • Objeto: Use o menu suspenso para selecionar a classe de objeto a ser usada para o condicional.

    • Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser usado para o condicional.

    • Operador: Use o menu suspenso para selecionar um operador apropriado:

      Comparação
      É igual a
      Maior que
      Maior que ou igual a
      Menor que
      Menor ou igual a

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

    • Remover: Clique para remover o condicional.

    • Adicionar: Clique para adicionar uma nova condicional à tabela Cláusulas Condicionais e Sequência de Filtros.

    • Remover tudo: Clique para remover todos os condicionais da tabela Cláusulas condicionais e Sequência de caracteres de filtro.

  • Sequência de caracteres de filtro: Conforme você preenche os outros campos na aba Básico, a instrução da sequência de caracteres de filtro nesta caixa de texto é preenchida automaticamente com os campos, condições e opções de consultar selecionados.

• Avançado: Oculta os campos guiados e permite que você modifique a Sequência de caracteres do filtro diretamente:

  

  • Tamanho da página: Insira o número máximo de resultados a serem recuperados para cada página na resposta da consultar. Se deixado em branco, cada página conterá 100 resultados.

    Nota

    Se a paginação do lado do cliente for necessária, use o $skip e $top opções de consultar no campo Filter String.

  • Filtro de string: Edite a declaração de sequência de caracteres do filtro diretamente.

• Test Query: 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, mensagens de erro relevantes serão exibidas. Se você editar a sequência de caracteres do filtro no modo Avançado, a consultar deverá ser válida e validada por meio deste botão para habilitar o botão Avançar.

  

• 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 4: Revise o esquema de dados

O esquema de resposta gerado do endpoint é exibido. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Esquema de dados: Este esquema de dados é herdado por transformações adjacentes e é exibido novamente durante mapeamento de transformação.

  Nota

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

  • Resposta:

    Campo/Nó do Esquema de Resposta	Descrição
    queryresponse	Resposta da consulta de objetos (entidades)
    response	Nó que representa a resposta da consultar
    item	Nó que representa os itens de resposta
    Lista de objetos	Nó que representa a lista de objetos (conjunto de entidades) consultada; por exemplo, o Person nó
    _odata.nextLink	String do campo de anotação OData com uma URL usada para recuperar o próximo subconjunto de resultados da resposta da consultar solicitada
    _odata.count	String do campo de anotação OData com a contagem total de objetos retornados da consultar
    _odata.context	String do campo de anotação OData com uma URL contendo a localização da lista de objetos consultados
    value	Nó que representa a lista de objetos correspondentes da consultar
    item	Nó que representa um objeto correspondente da consultar
    Campos de objeto ...	Campos específicos para a classe de objeto (tipo de entidade) de objetos na lista de objetos; por exemplo, campos em item nó, como UserName e Concurrency
    _odata.etag	String do campo de anotação OData com um valor que pode ser usado em uma solicitação subsequente para determinar se o valor do objeto foi alterado
    error	Nó que representa detalhes do erro da consultar
    code	String do código associado ao erro
    message	String da mensagem associada ao erro

  O conector OData usa a biblioteca Apache Olingo OData 4.0 Java. Consulte a documentação da biblioteca para obter informações adicionais sobre como o protocolo OData é suportado. Informações gerais sobre o protocolo OData também estão disponíveis no site de documentação do OData.

• Atualizar: Clique no ícone de atualização ou a palavra Refresh para regenerar esquemas do endpoint OData. Esta ação também regenera um esquema em outros locais em todo o 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 pede para você confirmar que deseja descartar as alterações.

Próximos passos

Após configurar uma atividade OData Query, 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 configurações da 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 para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.

As atividades de Consulta do OData podem ser usadas como uma fonte com esses padrões de operação:

• Padrão de Transformação
• Padrão de arquivo de dois alvos (apenas como primeira fonte)
• Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
• Padrão de duas transformações (apenas como primeira 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 executar a operação e validar o comportamento verificando os logs de operação.