Ir para o conteúdo

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).

Nota

Este conector suporta a política de Habilitar Re-autenticação em Mudanças política da organização. Se habilitado, uma mudança na URL de Metadados OData, Autenticação, Nome de Usuário ou ID do Cliente nesta conexão requer que os usuários reentrem 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 a partir de uma destas localizações:

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

Configurar uma conexão OData

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

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 clicando no ícone de variável para exibir um menu com as variáveis existentes para escolher.

  • 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.

  • Autenticação: Selecione o método de autenticação, um dos 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 uma Senha adicionais se Concessão de Senha for selecionada.

      • 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 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) 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, escapar {"success": "true"}; se torna {\"success\": \"true\"};.

  • 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 pelo(s) agente(s) 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 de 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 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 a criação de uma conexão OData, 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 destinos (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.

Estes tipos de atividade estão disponíveis:

  • Consulta: Consulta dados de objeto de um endpoint OData e é destinada a ser usada como uma fonte em uma operação.

  • Atualizar: Atualiza dados de objeto em um endpoint OData e é destinada a ser usada como um destino em uma operação.

  • Inserir: Insere dados de objeto em um endpoint OData e é destinada a ser usada como um destino em uma operação.

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