Ir para o conteúdo

Conexão OData

Introdução

Uma conexão OData, criada usando o conector OData, estabelece acesso a OData endpoints. Depois que uma conexão for configurada, você poderá 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 destinos (para consumir dados em uma operação).

Nota

Este conector oferece suporte à política da organização Ativar reautenticação em caso de alteração. Se ativado, uma alteração no URL de metadados OData, Autenticação, Nome de usuário ou ID do cliente nesta conexão exige que os usuários digitem novamente a Senha ou Segredo do cliente (dependendo da Autenticação selecionada) para a conexão.

Criar Ou Editar uma Conexão OData

Uma nova conexão OData é criada usando o conector OData de um destes locais:

Uma conexão OData existente pode ser editada nestes locais:

Configurar uma Conexão OData

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

Configuração de conexão OData

Dica

Campos com ícone de variável Ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.

  • Nome da conexão: Insira um nome a ser usado 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 a suas atividades.

  • URL de metadados OData: Insira o endpoint OData $metadata URL.

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

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

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

      Autenticação básica de conexão OData

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

      • Senha: Digite uma senha válida.

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

      Conexão OData Autenticação OAuth

      • 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 uma Senha adicionais se Concessão de senha estiver 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: Digite um nome de usuário válido. Visível somente se Tipo de concessão estiver definido como Concessão de senha.

      • Senha: Digite uma senha válida. Visível somente se 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 Enviar como cabeçalho de autenticação básica 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), bem como quaisquer cabeçalhos personalizados específicos do endpoint. Clique no ícone adicionar í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 í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 ícone de edição ou ícone de exclusão ícone de exclusão.

    Para excluir todas as linhas, clique em Limpar tudo.

    Nota

    Os 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 em 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 Ícone de variável somente no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

  • Teste: 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 a suspensão do download da versão mais recente do conector usando a Desativar atualização automática do conector política da organização.

  • 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 solicita que você confirme 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 (consulte Dependências, exclusão e remoção de componentes). Uma mensagem solicita que você confirme que deseja excluir a conexão.

Próximos Passos

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

As ações de menu para uma conexão e seus tipos de atividade podem ser acessados no painel do projeto e na paleta de componentes de design. Para obter detalhes, consulte Menus de ações em Noções básicas do conector.

Estes tipos de atividades estão disponíveis:

  • Consulta: Consulta dados de objeto de um endpoint OData e destina-se a ser usado como fonte em uma operação.

  • Atualizar: Atualiza dados de objeto em um endpoint OData e destina-se a ser usado como destino em uma operação.

  • Inserir: Insere dados de objeto em um endpoint OData e deve ser usado como destino em uma operação.

  • Excluir: Exclui dados de objeto de um endpoint OData e deve ser usado como destino em uma operação.