Conexão OData

Introdução

Uma conexão OData, criada usando o conector OData, estabelece acesso a endpoints OData. Uma vez que uma conexão é configurada, é possível criar instâncias de atividades OData associadas a essa conexão para serem usadas como fontes (para fornecer dados em uma operação) ou como alvos (para consumir dados em uma operação).

Criar ou editar uma conexão OData

Uma nova conexão OData é criada usando o conector OData a partir de uma destas localizações:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A página Endpoints Globais (veja Criar um endpoint global em Endpoints Globais).

Uma conexão OData existente pode ser editada a partir destas localizações:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A aba Componentes do painel do projeto (veja Menu de ações de componentes em Aba Componentes do painel do projeto).
• A página Endpoints Globais (veja Editar um endpoint global em Endpoints Globais).

Configurar uma conexão OData

Cada elemento da interface do usuário da tela de configuração da conexão OData é descrito abaixo.

• Nome da conexão: Insira um nome para identificar a conexão. O nome deve ser exclusivo para cada conexão OData e não deve conter barras (/) ou dois pontos (:). Este nome também é usado para identificar o endpoint OData, que se refere tanto a uma conexão específica quanto às suas atividades.

• URL de metadados OData: Insira a URL do endpoint OData $metadata.

  Nota

  Dependendo do endpoint OData escolhido, os dados necessários podem não estar acessíveis a partir da URL de metadados padrão. Por exemplo, ao conectar-se a um endpoint OData do Dynamics 365, uma cláusula de filtro (?$filter=dataAreaId eq 'usrt'&cross-company=true) deve ser anexada à URL de metadados para um escopo de consulta expandido. Usar ?cross-company=true sem uma cláusula de filtro não é suficiente.

  Consulte a documentação do seu endpoint para advertências semelhantes.

• Versão do OData: Selecione a versão do OData suportada pelo endpoint OData, seja V4 (padrão) ou V2.

• Autenticação: Selecione o método de autenticação, um dos seguintes: Sem Auth, Auth Básica ou OAuth2:

  • Sem Auth: O acesso ao endpoint OData é anônimo, sem autorização.

  • Auth Básica: Expande opções de configuração adicionais onde você especifica um nome de usuário e uma senha para usar na autorização básica:

    • Nome de usuário: Insira um nome de usuário válido.

    • Senha: Insira uma senha válida.

  • OAuth2: Expande opções adicionais para configurar OAuth 2.0:

    • Tipos de concessão: Selecione Credenciais do Cliente ou Concessão de Senha como o tipo de concessão para autenticação OAuth. Credenciais do Cliente é selecionado por padrão, mas os usuários podem especificar um Nome de Usuário e Senha adicionais se Concessão de Senha for selecionado.

    • Endpoint do token OAuth: Insira o endpoint do token OAuth.

    • ID do cliente: Insira o ID do cliente.

    • Segredo do cliente: Insira o segredo do cliente.

    • Nome de usuário: Insira um nome de usuário válido. Visível apenas se o Tipo de Concessão estiver definido como Concessão de Senha.

    • Senha: Insira uma senha válida. Visível apenas se o Tipo de Concessão estiver definido como Concessão de Senha.

    • Escopo: Insira o escopo.

    • Tipo de token: Insira o tipo de token.

    • Autenticação do cliente: Selecione o método pelo qual a autenticação do cliente é enviada na solicitação. A autenticação pode ser enviada como uma das opções Enviar como cabeçalho Basic Auth ou Enviar credenciais do cliente no corpo.

• Propriedades HTTP avançadas: Defina cabeçalhos HTTP para a conexão. O protocolo OData aceita cabeçalhos HTTP padrão definidos em Rfc 2616 (seção 14) assim como quaisquer cabeçalhos personalizados específicos para o 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 de variável 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\"};.

• Testar: Clique para verificar a conexão usando a configuração fornecida. Quando a conexão é testada, a versão mais recente do conector é baixada pelos agentes no grupo de agentes associado ao ambiente atual. Este conector suporta suspender o download da versão mais recente do conector usando a política de Desativar Atualização Automática do Conector.

• Salvar Alterações: Clique para salvar e fechar a configuração da conexão.

• Descartar Alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem pede para você confirmar que deseja descartar as alterações.

• Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (veja Dependências de componentes, exclusão e remoção). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Próximas etapas

Após uma conexão OData ser criada, você coloca um tipo de atividade na tela de design para criar instâncias de atividade a serem usadas como fontes (para fornecer dados em uma operação) ou como alvos (para consumir dados em uma operação).

As ações do menu para uma conexão e seus tipos de atividade estão acessíveis a partir do painel do projeto e da paleta de componentes de design. Para detalhes, veja Menus de ações em Noções básicas sobre conectores.

Esses tipos de atividade estão disponíveis:

• Consulta: Consulta dados de objetos de um endpoint OData e é destinado a ser usado como uma fonte em uma operação.

• Atualização: Atualiza dados de objetos em um endpoint OData e é destinado a ser usado como um alvo em uma operação.

• Inserção: Insere dados de objetos em um endpoint OData e é destinado a ser usado como um alvo em uma operação.

• Exclusão: Exclui dados de objetos de um endpoint OData e é destinado a ser usado como um alvo em uma operação.