Conexão OData
Introdução
Uma conexão OData, criada usando o conector OData, estabelece acesso a OData endpoints. Depois que uma conexão é configurada, você pode criar instâncias de atividades OData associadas a essa conexão para serem usadas como origens (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).
Nota
Este conector suporta a política da organização Habilitar Reautenticação na Alteração. Se habilitado, uma alteração no ** URL de metadados do OData, Autenticação, Nome de usuário ou ID do cliente nesta conexão exige que os usuários insiram novamente a Senha ou o 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:
- A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
- A página Conexões globais (consulte Criar um endpoint global em Conexões Globais).
Uma conexão OData existente pode ser editada nestes locais:
- A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
- A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
- A página Conexões globais (consulte Editar um endpoint global em Conexões Globais).
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 suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [
no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.
-
Nome da conexão: Insira um nome para usar 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 a uma conexão específica e suas atividades. -
URL de metadados OData: Insira o endpoint OData
$metadata
URL. -
Autenticação: Selecione o método de autenticação, um dos seguintes: 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 na autorização básica:
-
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:
-
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 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 somente se o Tipo de Concessão estiver definido como Concessão de Senha.
-
Senha: Insira uma senha válida. Visível somente 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 um dos seguintes: 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 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
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 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.
-
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 Desabilitar atualização automática do conector política da organização.
-
Salvar alterações: Clique para salvar e fechar a configuração de 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 (consulte Dependências, exclusão e remoção de componentes). Uma mensagem pede para você confirmar 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 são acessíveis a partir do painel do projeto e da paleta de componentes de design. Para obter detalhes, consulte Menus de ações em Noções básicas do conector.
Esses tipos de atividade estão disponíveis:
-
Consulta: Consulta dados de objeto de um endpoint OData e deve ser usado como uma fonte em uma operação.
-
Atualizar: Atualiza dados de objeto em um endpoint OData e deve ser usado como um alvo em uma operação.
-
Inserir: Insere dados de objeto em um endpoint OData e deve ser usado como um alvo em uma operação.
-
Excluir: Exclui dados de objeto de um endpoint OData e deve ser usado como um alvo em uma operação.