Atividade de Consulta OData

Introdução

Uma atividade de Consulta OData, utilizando sua conexão OData, consulta dados de objetos de um endpoint OData e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta OData

Uma instância de uma atividade de Consulta OData é 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 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 OData existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).

Configurar uma atividade de Consulta OData

Siga estas etapas para configurar uma atividade de Consulta OData:

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

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

• Etapa 3: Defina uma string de filtro
  O Construtor de Consultas é usado para definir condições em uma consulta usando os campos do objeto e aplicar paginação a uma consulta.

• Passo 4: Revisar o esquema de dados
  Quaisquer esquemas de resposta gerados a partir do endpoint são exibidos.

Passo 1: Insira um nome e especifique as configurações

Neste passo, forneça um nome para a atividade e especifique a classe de objeto a ser consultada e quaisquer cabeçalhos HTTP necessários. Cada elemento da interface do usuário deste passo é descrito abaixo.

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

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

  • Objeto Selecionado: Após selecionar uma classe de objeto, ela é listada 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 critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar as classes de objeto do endpoint OData. Isso pode ser útil se o esquema do endpoint OData foi 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 as classes de objeto disponíveis, a conexão OData pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

• Propriedades HTTP Avançadas: Defina cabeçalhos HTTP para a consulta. O protocolo OData aceita cabeçalhos HTTP padrão definidos na Rfc 2616 (seção 14) assim como quaisquer cabeçalhos personalizados específicos do endpoint. clique no ícone de adicionar para adicionar um cabeçalho à tabela abaixo e insira um par chave-valor para cada parâmetro de solicitação.

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

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

  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 Requerem Autenticação.

  Importante

  Campos na tabela Propriedades HTTP Avançadas exibem o ícone de variável apenas 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.

  Campos na tabela Propriedades HTTP Avançadas não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

• 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: Selecionar objetos filhos

Nesta etapa, selecione as classes de objetos filhos a serem incluídas na consulta com base na classe de objeto selecionada na etapa anterior. Cada elemento da interface do usuário desta etapa é descrito abaixo.

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

  • Objetos Filhos Disponíveis: Esta coluna exibe as classes de objetos filhos a serem selecionadas.

    • Pesquisar: Insira o valor de qualquer 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 são filtrados em tempo real a cada tecla pressionada. Para recarregar as classes de objetos filhos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar para recarregar as classes de objetos filhos do endpoint OData. Isso pode ser útil se você adicionou recentemente classes de objetos filhos ao endpoint OData.

    • Adicionar 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 de adicionar para adicionar as classes selecionadas à coluna Objetos Filhos Selecionados.

  • Objetos Filhos Selecionados: Esta coluna exibe as 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 de remover para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.

• 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 pede que você confirme que deseja descartar as alterações.

Etapa 3: Definir uma string de filtro

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

A String de Filtro pode ser configurada nas abas Básica ou Avançada.

• Básica: Permite que você construa a String de Filtro com campos guiados:

  

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

    • Pesquisar: Digite qualquer parte de um nome de 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 tecla pressionada.

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

    • Selecionar Todos 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 vez.

    • Selecionar Campos: Selecione as caixas de seleção dos campos que deseja incluir na consulta para que sejam adicionados automaticamente à String de 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 consulta. 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 Skip e Top.

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

  • Pesquisa de Texto Completo: Insira termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint OData lida com a forma como a pesquisa é interpretada para uma classe de objeto.

  • Pular: Insira o número de resultados a serem pulados na resposta da consulta. Usado para paginação do lado do cliente.

  • Top: Insira o número máximo de resultados a serem recebidos na resposta da consulta. Usado para paginação do lado do cliente.

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

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

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

    • Operador: Use o dropdown para selecionar um operador apropriado:

      Comparação
      Igual
      Maior que
      Maior ou Igual
      Menor que
      Menor ou Igual

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

    • Remover: Clique para remover a condição.

    • Adicionar: Clique para adicionar uma nova condição à tabela de Cláusulas Condicionais e String de Filtro.

    • Remover Tudo: Clique para remover todas as condições da tabela de Cláusulas Condicionais e String de Filtro.

  • String de Filtro: À medida que você preenche os outros campos na aba Básico, a declaração da string de filtro nesta caixa de texto é preenchida automaticamente com os campos selecionados, condições e opções de consulta.

• Avançado: Oculta os campos guiados e permite que você modifique a String de Filtro diretamente:

  

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

    Nota

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

  • String de Filtro: Edite a declaração da string de filtro diretamente.

• Testar Consulta: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta é exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas. Se você editar a string de filtro enquanto estiver no modo Avançado, 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 pede que você confirme que deseja descartar as alterações.

Etapa 4: Revisar o esquema de dados

O esquema de resposta gerado a partir 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 o 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 a objetos (entidades)
    response	Nó representando a resposta da consulta
    item	Nó representando os itens da resposta
    Lista de Objetos	Nó representando a lista de objetos (conjunto de entidades) consultados; por exemplo, o nó Person
    _odata.nextLink	String do campo de anotação OData com uma URL usada para recuperar o próximo subconjunto de resultados da resposta da consulta solicitada
    _odata.count	String do campo de anotação OData com a contagem total de objetos retornados pela consulta
    _odata.context	String do campo de anotação OData com uma URL contendo a localização da lista de objetos consultados
    value	Nó representando a lista de objetos correspondentes da consulta
    item	Nó representando um objeto correspondente da consulta
    Campos do Objeto ...	Campos específicos da classe de objeto (tipo de entidade) dos objetos na lista de objetos; por exemplo, campos no nó item, 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 mudou
    error	Nó representando detalhes do erro da consulta
    code	String do código associado ao erro
    message	String da mensagem associada ao erro

  O conector OData utiliza a biblioteca Java Olingo OData 4.0 da Apache. 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 atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint OData. 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 para esta 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 OData, 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 do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.

Atividades de Consulta OData podem ser usadas como fonte com esses padrões de operação:

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

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.