Conexão Jitterbit App Builder no Jitterbit Studio
Introdução
Uma conexão Jitterbit App Builder, criada usando o conector Jitterbit App Builder, estabelece acesso a uma aplicação Jitterbit App Builder publicada como uma API REST. Após configurar uma conexão, você pode criar instâncias de atividades Jitterbit App Builder 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).
Criar ou editar uma conexão Jitterbit App Builder
Uma nova conexão Jitterbit App Builder é criada usando o conector Jitterbit App Builder a partir de um destes locais:
- A guia Project endpoints and connectors (Endpoints e conectores do projeto) da paleta de componentes de design (consulte Design component palette).
- A página Global Endpoints (Endpoints globais) (consulte Criar um endpoint global em Global Endpoints).
Uma conexão Jitterbit App Builder existente pode ser editada a partir destes locais:
- A guia Project endpoints and connectors (Endpoints e conectores do projeto) da paleta de componentes de design (consulte Design component palette).
- A guia Components (Componentes) do painel de projetos (consulte Component actions menu em Project pane Components tab).
- A página Global Endpoints (Endpoints globais) (consulte Editar um endpoint global em Global Endpoints).
Configurar uma conexão Jitterbit App Builder
Cada elemento da interface do usuário da tela de configuração da conexão Jitterbit App Builder é descrito abaixo.
Dica
Os campos com um ícone de variável oferecem suporte ao uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete de abertura [ no campo ou clique no ícone de variável para exibir um menu listando as variáveis existentes para escolher.
-
Connection Name: Digite um nome para identificar a conexão. O nome deve ser único para cada conexão Jitterbit App Builder e não deve conter barras
/ou dois-pontos:. Este nome também é usado para identificar o endpoint Jitterbit App Builder, que se refere a uma conexão específica e suas atividades. -
Hostname: Digite o nome de host do seu servidor Jitterbit App Builder, sem o protocolo. Se sua instância do App Builder for servida a partir de um caminho, inclua o caminho (por exemplo,
ab.example.comouab.example.com/production). -
Authentication: Selecione o método de autenticação que o conector usa para chamar a API REST da aplicação, um destes:
-
API Key: (Padrão.) Autentica com uma chave de API. Esta opção mostra o seguinte campo:
- API Key: Digite a chave de API configurada para a aplicação Jitterbit App Builder à qual você deseja se conectar. Esta chave é enviada como o cabeçalho
X-API-KEYem cada solicitação.
- API Key: Digite a chave de API configurada para a aplicação Jitterbit App Builder à qual você deseja se conectar. Esta chave é enviada como o cabeçalho
-
OAuth 2.0 Client Credentials: Autentica como uma aplicação cliente registrada no servidor de autorização do App Builder. O conector solicita um token de acesso de
https://<hostname>/connect/tokene o envia como um bearer token em cada solicitação. Esta opção mostra os seguintes campos:- Client ID: Digite a ID do cliente da aplicação cliente registrada.
- Client Secret: Digite o segredo do cliente da aplicação cliente registrada.
- Scope: Digite o escopo a ser solicitado. O padrão é
api, que autoriza acesso a APIs REST hospedadas no App Builder.
-
-
Autenticação Básica: Autentica com autenticação HTTP básica, usando o identificador e a chave da chave de API de um usuário. Esta opção exibe os seguintes campos:
- Identificador: Digite o identificador da chave de API.
- Chave: Digite a chave.
-
Anônimo: Envia requisições sem credenciais. Use esta opção para um aplicativo cuja API REST não requer autenticação.
-
Endpoint da Aplicação: Selecione o endpoint da API REST do aplicativo Jitterbit App Builder ao qual deseja se conectar. O menu suspenso fica vazio até que você o carregue: primeiro digite o Hostname, selecione uma opção de Autenticação e complete os campos que aparecem abaixo deste menu suspenso, em seguida clique em Atualizar acima do menu suspenso. O menu suspenso lista, por nome, todos os aplicativos no seu servidor App Builder que possuem um documento OpenAPI publicado; um aplicativo sem um documento publicado não aparece. Se um valor obrigatório estiver faltando ou a lista não puder ser recuperada, um diálogo Não foi possível buscar dados descreve o problema.
-
Testar: Clique para verificar a conexão usando a configuração especificada. 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 suspender o download da versão mais recente do conector usando a política organizacional Desabilitar Atualização Automática do Conector.
Nota
Um teste com falha nem sempre significa que as credenciais estão incorretas. Testar verifica a conexão em duas etapas. Primeiro recupera o documento OpenAPI do aplicativo para confirmar o Hostname e o Endpoint da Aplicação, depois chama um dos endpoints do aplicativo para confirmar as credenciais de Autenticação. Se todos os endpoints do aplicativo exigem um identificador de item em seu caminho (por exemplo,
/customers/{id}), a segunda etapa pode falhar mesmo quando as credenciais estão corretas. -
Salvar: Clique para salvar e fechar a configuração da conexão.
-
Descartar alterações: Depois de 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.
-
Deletar: Depois de abrir uma configuração de conexão existente, clique para deletar permanentemente a conexão do projeto e fechar a configuração (veja Dependências de componentes, deleção e remoção). Uma mensagem solicita que você confirme que deseja deletar a conexão.
Próximas etapas
Depois que uma conexão Jitterbit App Builder tiver sido criada, coloque 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 de menu para uma conexão e seus tipos de atividade estão acessíveis no painel do projeto e na paleta de componentes de design. Para detalhes, veja Menus de ações em Conceitos básicos do conector.
Estes tipos de atividade estão disponíveis:
-
Ler: Recupera um ou mais itens de um objeto no aplicativo Jitterbit App Builder e é destinado a ser usado como fonte em uma operação.
-
Criar: Cria um novo item para um objeto no aplicativo Jitterbit App Builder e é destinado a ser usado como destino em uma operação.
-
Atualizar: Atualiza um item existente para um objeto no aplicativo Jitterbit App Builder e é destinado a ser usado como destino em uma operação.
-
Delete: Remove um item existente de um objeto na aplicação Jitterbit App Builder e é destinado a ser usado como um alvo em uma operação.