Conector App Builder no Jitterbit App Builder
Visão geral
O conector App Builder é um recurso que permite que um aplicativo use tabelas e objetos de negócios de outro aplicativo App Builder, ou de um ambiente App Builder completamente separado, como se fizessem parte de sua própria fonte de dados, sem duplicar os dados subjacentes.
A variante que você usa depende de onde o outro aplicativo está localizado:
-
Um conector local vincula duas fontes de dados no mesmo servidor App Builder. Por exemplo, se o seu servidor hospeda tanto uma fonte de dados
Northwindsquanto umMeu Aplicativoseparado, e oMeu Aplicativoprecisa ler (e opcionalmente gravar) dados doNorthwinds, um conector local oferece aoMeu Aplicativoacesso direto às tabelas doNorthwinds, sem copiar esses dados para o banco de dados doMeu Aplicativo. Como ambos os aplicativos rodam no mesmo servidor, o App Builder trata a conexão internamente: nenhuma chamada de rede e nenhuma etapa de autenticação separada são necessárias. -
Um conector remoto vincula dois ambientes App Builder completamente separados, cada um com sua própria URL, sobre HTTP. Por exemplo, conectar o servidor App Builder da sua organização a uma instalação App Builder diferente, seja um ambiente separado, a instalação de um cliente diferente ou qualquer outra instância hospedada de forma independente. Como a conexão atravessa a rede para uma instância App Builder separada e protegida, ela autentica usando uma chave de API, da mesma forma que qualquer outro cliente REST externo faria.
Esta página aborda:
-
Conector App Builder local
Configure um conector entre duas fontes de dados no mesmo ambiente. -
Conector remoto
Configure um conector entre dois ambientes App Builder separados sobre HTTP.
Além disso, esta página também contém uma seção Limitações cobrindo restrições conhecidas a ter em mente antes de depender do conector App Builder, e uma seção Solução de problemas cobrindo erros comuns e como resolvê-los.
Aviso
Recomendamos consultar seu consultor dedicado da Jitterbit antes de configurar um conector App Builder por conta própria.
Conector App Builder local
Um conector App Builder local permite que um aplicativo no seu servidor App Builder use diretamente tabelas e objetos de negócios que vivem na fonte de dados de outro aplicativo nesse mesmo servidor, sem copiar os dados ou configurar qualquer autenticação de rede. Por exemplo, se o Meu Aplicativo precisa ler dados que vivem na fonte de dados do Northwinds, ambos hospedados no mesmo servidor, um conector local oferece ao Meu Aplicativo acesso direto às tabelas públicas do Northwinds.
Esta seção aborda:
- Etapa 1: Criar um conector App Builder local
- Etapa 2: Permitir acesso público às tabelas e objetos de negócios que você deseja usar no seu conector
- Etapa 3: Criar uma fonte de dados usando o conector App Builder local
- Etapa 4: Importar tabelas e objetos de negócios no seu conector
- Etapa 5: Adicionar seu conector App Builder local como uma fonte de dados ao seu aplicativo
- Etapa 6: Vincular sua fonte de dados do conector App Builder local e seu banco de dados relacional
Considere usar Extend Table em vez disso
Se você apenas precisa trazer uma tabela de outra fonte de dados no mesmo servidor, Extend Table é geralmente a melhor opção: diferentemente de um conector local, não requer empacotar e enviar ambos os aplicativos juntos sempre que você fizer uma liberação.
Etapa 1: Criar um conector App Builder local
Configure o servidor do conector App Builder para que o App Builder saiba rotear solicitações para esta conexão localmente em vez de sobre HTTP:
- Selecione IDE > Data Servers.
-
Clique em + Server no painel Data Servers. O diálogo Server abre. Digite os seguintes valores:

- Name: Atribua um nome à sua conexão de servidor. A Jitterbit recomenda
Local App Builder. - Type: Selecione App Builder Connector.
- App Builder Type: Selecione Local.
- Name: Atribua um nome à sua conexão de servidor. A Jitterbit recomenda
-
Clique em Save e feche o diálogo.
Etapa 2: Permitir acesso público às tabelas e objetos de negócios que você deseja usar no seu conector
Uma tabela ou regra deve estar marcada como Public antes que um conector possa utilizá-la:
- Navegue até App Workbench do aplicativo que você deseja usar.
-
Marque as tabelas ou regras que você deseja usar no seu conector como Public:
-
Para marcar uma tabela como pública:
- Acesse a aba Tables.
- Localize a tabela procurada no painel Tables e clique no ícone de edição ou clique duas vezes em sua linha. A página Table Definition dessa tabela abre.
-
No painel Table, clique em More > Edge Case. O diálogo Edge Case Settings abre:

-
No grupo de campos Public Access, marque Allow Read e/ou Allow Write conforme necessário.
-
Para marcar uma regra como pública:
- Acesse a aba Rules.
- Localize a regra procurada no painel Rules e clique no ícone de edição ou clique duas vezes em sua linha. O Rule Builder dessa regra abre.
-
No painel Rule, clique em More > Edge Case. O diálogo Edge Case Settings abre:

-
No grupo de campos Allow Public Access, marque Read para permitir a leitura dos dados da regra e/ou Write para permitir modificá-los.
-
Nota
Recomendamos fortemente não modificar uma tabela ou objeto de negócio público depois que ele foi tornado público e usado em um conector. Consulte Limitations para obter mais informações.
Etapa 3: Criar uma fonte de dados usando o conector App Builder local
Com o servidor do conector em funcionamento e seus objetos marcados como públicos, crie uma fonte de dados que aponte para o aplicativo específico cujos dados você deseja usar:
- Acesse IDE > Data Servers.
- No painel Data Servers, selecione Local App Builder.
-
Clique em + Source. Um assistente aparece para guiá-lo pelo processo:

-
Selecione um banco de dados no qual criar uma fonte de dados. A fonte de dados é criada com o mesmo nome do banco de dados. Clique em Next.
Nota
O banco de dados relacional que você procura deve ter pelo menos uma tabela ou regra pública (consulte Etapa 2); caso contrário, ele não poderá ser selecionado.
-
Na próxima etapa do assistente, escolha quais tabelas, visualizações e procedimentos armazenados importar para a fonte recém-criada, ou clique em Import All para importar tudo. Clique em Next.
- O assistente apresenta um resumo da nova fonte de dados. Clique em Done. A nova fonte de dados agora aparece listada em + Source.
-
(Recomendado) É uma prática recomendada renomear a fonte de dados seguindo a convenção
[Data Source You're Connecting to] ([Application Using the Connector]). Por exemplo, um conector local para Northwinds, conectando a um aplicativo nomeadoMy Application, seria nomeadoNorthwinds (My Application). Para renomear sua fonte de dados, siga estas etapas: -
Clique no ícone nova janela no tile da fonte de dados ou clique duas vezes no tile. O diálogo App Builder Connector abre:
{style="width: 600px"}-
Clique em Edit. O diálogo Data Storage Layer abre:

-
Clique em Edit novamente. Digite um nome apropriado no campo Data Source Name.
- Clique em Save.
-
Dica
Crie uma fonte de dados separada cada vez que quiser conectar uma aplicação a outro banco de dados relacional, em vez de reutilizar uma única fonte entre aplicações. Por exemplo, se duas aplicações precisam de uma conexão local com Northwinds, crie duas fontes de dados seguindo a convenção de nomenclatura acima: Northwinds (My Application 1) e Northwinds (My Application 2).
Etapa 4: Importar tabelas e objetos de negócios no seu conector
Se você seguiu as etapas acima em ordem, as tabelas e regras públicas foram importadas quando você criou a fonte de dados. Prossiga para Etapa 5. No entanto, se você criou a fonte de dados antes de permitir acesso público às tabelas e regras necessárias, é possível importá-las agora.
- Vá para IDE > Data Servers.
- No painel Data Servers, selecione Local App Builder.
-
No painel lateral, clique no ícone nova janela no tile da fonte de dados ou clique duas vezes no tile. O diálogo App Builder Connector abre:

-
Em Data Storage Layer, clique em Import. O diálogo Import Schema abre:

-
Para importar todas as tabelas que você marcou como públicas, clique em Import novamente em Import Capabilities.
-
Para importar apenas um subconjunto, digite primeiro um nome de tabela ou objeto de negócio no campo Import Pattern e clique em Import em Import Capabilities.
-
-
Clique em Proceed. O App Builder executa uma tarefa em segundo plano para concluir a importação.
Etapa 5: Adicionar seu conector App Builder local como uma fonte de dados ao seu aplicativo
A fonte de dados que você criou na Etapa 3 existe no servidor, mas sua aplicação não pode usá-la até que você a adicione explicitamente como uma fonte:
- Navegue até o App Workbench da aplicação que você deseja modificar.
- Vá para a aba Data Sources.
- No painel Data Sources, clique em + Source. O diálogo Add a Source to your application abre.
- Selecione Link to existing source e clique em Next.
- Localize a fonte de dados que você criou na Etapa 3 e clique em Link 1 Source.
- Revise a atualização proposta e clique em Done.
Etapa 6: Vincular sua fonte de dados do conector App Builder local e seu banco de dados relacional
Vincular fontes permite que você crie regras entre fontes de dados em qualquer direção:
-
Para criar regras com o banco de dados relacional como fonte e sua fonte de dados local do App Builder Connector como destino:
- Navegue até o App Workbench da aplicação que você deseja modificar.
- Vá para a aba Data Sources.
- Selecione o banco de dados relacional que deseja vincular. O painel lateral é preenchido com suas opções.
- No grupo de campos Business Logic Layer, clique em Link Sources. O diálogo Linked Data Sources abre.
- Clique em Create e selecione a fonte de dados local do App Builder Connector que você adicionou à sua aplicação na Etapa 5.
- Clique na marca de seleção para salvar o registro.
Após vinculação, você pode usar tabelas e objetos de negócios da fonte de dados local do App Builder em regras de negócios e regras XP CRUD criadas no banco de dados relacional, incluindo regras XP CRUD cuja fonte de dados é o banco de dados relacional e cuja fonte de dados alvo é a fonte de dados local do App Builder. Crie essas regras XP CRUD no banco de dados relacional.
-
Para criar regras na direção oposta, com o conector local do App Builder como origem e o banco de dados relacional como destino:
- Navegue até App Workbench para o app que você deseja modificar.
- Acesse a aba Data Sources.
- Selecione o conector local do App Builder que deseja vincular. O painel lateral é preenchido com suas opções.
- No grupo de campos Business Logic Layer, clique em Link Sources. A caixa de diálogo Linked Data Sources é aberta.
- Clique em Create e selecione a fonte de dados relacional que deseja conectar.
- Clique no checkmark para salvar o registro.
Após vinculação, você pode usar tabelas e objetos de negócios do banco de dados relacional em regras de negócios e regras XP CRUD criadas no conector local do App Builder, incluindo regras XP CRUD cuja fonte de dados é a fonte de dados local do App Builder e cuja fonte de dados alvo é a sua fonte de dados relacional. Crie essas regras XP CRUD no conector local do App Builder.
Conector remoto
Um conector remoto permite que um aplicativo em um ambiente App Builder use um objeto compartilhado de um ambiente App Builder completamente separado, acessível em sua própria URL, via HTTP. Diferentemente de um conector local, os dois ambientes não compartilham um servidor, portanto devem autenticar um ao outro explicitamente usando uma chave API. As etapas abaixo compartilham um objeto no ambiente de origem primeiro e depois se conectam a ele a partir do ambiente remoto.
Esta seção abrange:
- Etapa 1: Criar o objeto a compartilhar usando conector do App Builder
- Etapa 2: Ativar conexões remotas do App Builder
- Etapa 3: Confirmar que um provedor de segurança de chave API está configurado
- Etapa 4: Criar uma função para compartilhar o objeto
- Etapa 5: Criar um grupo e conceder acesso a ele
- Etapa 6: Criar um usuário, gerar uma chave API e adicioná-lo ao grupo
- Etapa 7: Configurar a conexão a partir do ambiente remoto
Etapa 1: Criar o objeto a compartilhar usando conector do App Builder
Antes que um ambiente remoto possa extrair dados deste, você precisa de algo para compartilhar. Esta etapa cria uma regra que define exatamente o que é exposto:
- Navegue até App Workbench para o app que você deseja compartilhar e acesse a aba Rules.
-
Clique em + Rule. O Rule Builder é aberto:
- Name: Atribua um nome à regra. Por exemplo:
Customer (Remote). - Purpose: Selecione Business Object.
- Target: Selecione uma tabela de destino para a regra. Por exemplo:
Customer.
- Name: Atribua um nome à regra. Por exemplo:
-
Clique em Create.
- No painel Tables, selecione as colunas que deseja compartilhar.
-
No painel Rule, acesse More > Edge Case. A caixa de diálogo Edge Case Settings é aberta:

-
Em Allow Public Access, marque Read e/ou Write conforme apropriado, para que o ambiente remoto possa acessar o objeto.
- Clique em Proceed.
Etapa 2: Ativar conexões remotas do App Builder
Compartilhar um objeto não é suficiente por si só: o aplicativo também deve ser explicitamente permitido para aceitar solicitações de conector remoto e, desde o App Builder 4.67, estar associado aos provedores permitidos para autenticá-las:
- Acesse IDE > Configurações Adicionais.
-
No painel Configurar, clique em Remote Connector. A caixa de diálogo Fontes de Dados é aberta:

-
Marque a coluna Permitir para a aplicação na qual você deseja permitir conexões remotas.
- Clique em Prosseguir ou na marca de seleção .
-
(A partir do App Builder 4.67.) Clique no botão Configurar Autenticação para a aplicação. A caixa de diálogo Provedores de Autenticação é aberta. Adicione os provedores de chave API, HTTP ou Servidor de Autorização que você deseja permitir para autenticar as solicitações do Remote Connector. Consulte Configurar um endpoint para conhecer as etapas exatas.
Nota
Esta opção não está disponível em uma aplicação lacrada. Para uma aplicação lacrada, clique no ícone na coluna Serviço Web em Aplicações, que abre essa mesma caixa de diálogo Provedores de Autenticação de fora da aplicação.
Etapa 3: Confirmar que um provedor de segurança de chave API está configurado
O ambiente remoto se autentica neste usando uma chave API, portanto, confirme que este provedor de segurança existe e está habilitado antes de gerar uma:
- Acesse IDE > Provedores de Segurança.
- Confirme que um provedor de segurança Chave API habilitado está configurado. Caso contrário, configure um (consulte Provedor de segurança - Chave API para aprender como fazê-lo).
Etapa 4: Criar uma função para compartilhar o objeto
As etapas 4 a 6 são uma prática recomendada, não um requisito: elas limitam o acesso do ambiente remoto apenas ao objeto que você está compartilhando, criando uma função, grupo e usuário dedicados, e então gerando a chave API para esse usuário. Se você as pular e gerar uma chave API para um usuário existente, e a fonte de dados desse usuário não tiver funções configuradas, a chave concede acesso a todos os objetos que você marcou como Permitir Leitura e/ou Permitir Escrita na Etapa 1, não apenas o que você está compartilhando aqui.
- Navegue até o App Workbench da aplicação e acesse a guia Funções. Se a aplicação tiver mais de uma fonte de dados, selecione aquela à qual o objeto compartilhado pertence no menu de fonte de dados no topo da página.
-
Clique em + Função (mostrado abaixo):
-
A caixa de diálogo Função é aberta. Atribua um Nome para a função. Por exemplo:
Remote Connector. -
Clique em Salvar. O painel Permissões fica disponível para interação:

-
Clique em + Permissão, selecione o objeto que você criou na Etapa 1 e marque Leitura, Inserir, Atualizar e/ou Excluir conforme necessário.
- Clique na marca de seleção para salvar.
Nota
Para obter mais informações sobre funções, consulte Funções.
Etapa 5: Criar um grupo e conceder acesso a ele
Crie um grupo dedicado para o ambiente remoto se autenticar:
-
Navegue até IDE > Gerenciamento de Usuários e selecione a guia Grupos:
-
Clique em + Grupo. A caixa de diálogo Grupo é aberta:

-
Atribua um Nome. Por exemplo:
Remote Connector. - Clique em Salvar.
- Clique em Gerenciar Privilégios. Os painéis Privilégios e Funções são abertos.
- No painel Privilégios, clique em Criar. A caixa de diálogo Privilégio é aberta:

- Tipo: Selecione Aplicação.
-
Aplicação: Selecione a aplicação que contém o objeto que você está compartilhando. Por exemplo:
Global Imports. -
Clique em Salvar.
- No painel Funções, localize e clique em Conceder para a função que você criou na Etapa 4.
Nota
O ambiente remoto também precisa da função integrada App Builder Remote Connector, referenciada em 403 forbidden error. Se ela ainda não foi concedida, localize e clique em Conceder para ela também, no mesmo painel Funções.
Etapa 6: Criar um usuário, gerar uma chave de API e adicioná-lo ao grupo
Crie um usuário dedicado para o ambiente remoto se autenticar e gere a credencial com a qual ele se conecta:
-
Selecione a aba Usuários:
-
Clique em + Usuário. O diálogo Usuário abre:

-
Atribua um Nome de Usuário. Por exemplo:
RemoteConnector. - Clique em Salvar.
- Clique em Mais > Chaves.
-
Clique em Criar. O diálogo Gerar Chave abre:

-
Selecione Chave de API como o Provedor e clique em Salvar.
-
Copie o valor da Chave gerada para sua área de transferência.
Aviso
O valor da chave gerada não pode ser recuperado novamente assim que você sair da tela Gerar Chave. Se você perdê-lo, precisará gerar uma nova.
-
Clique em + Associação, selecione o grupo que você criou na Etapa 5 e clique na marca de seleção para salvar.
Etapa 7: Configurar a conexão do ambiente remoto
Todas as etapas até agora ocorreram no ambiente que compartilha o objeto. Esta etapa final muda para o ambiente remoto e usa as credenciais que você acabou de criar para estabelecer a conexão:
- Navegue até o ambiente remoto do qual você deseja se conectar e acesse o App Workbench do aplicativo ao qual deseja se conectar, então selecione a aba Fontes de Dados.
- Clique em + Fonte. Um assistente abre para ajudá-lo.
- Na primeira tela do assistente, selecione Nova Conexão e clique em Próximo.
-
Selecione Outro como a Categoria de Conexão e procure e selecione App Builder Connector:

-
Clique em Próximo. O assistente pula a etapa Escolher Provedor para este tipo de conexão e vai direto para Criar Conexão.
-
Insira os seguintes valores:

- Nome do Servidor: Atribua um nome. Por exemplo:
Remoto. - Tipo de App Builder: Confirme se está definido como Remoto.
- URL: Digite a URL do ambiente ao qual você está se conectando. Por exemplo:
https://example.com. - Chave de API: Cole o valor da chave que você copiou na Etapa 6.
- Nome do Servidor: Atribua um nome. Por exemplo:
-
Clique em Próximo e prossiga pelas etapas restantes do assistente (Escolher Banco de Dados, Importar Esquema e Resumo) para selecionar o banco de dados, importar as tabelas, exibições e procedimentos armazenados aos quais deseja se conectar e confirme a nova conexão.
- Selecione a fonte de dados do conector remoto do App Builder e clique em Lógica.
- Clique no ícone Resultados de uma entrada para confirmar que você vê dados.
- Teste a conexão: edite um registro e salve, depois retorne ao outro ambiente e confirme se a atualização aparece lá também.
Limitações
Mantenha as seguintes limitações em mente ao trabalhar com o conector do App Builder:
- O conector App Builder não oferece suporte a Reach.
- O conector App Builder oferece suporte a Auditoria completa, mas a Auditoria completa deve estar ativada na tabela subjacente para funcionar.
- Para um conector App Builder local, ambos os bancos de dados devem ser bancos de dados relacionais e devem existir no mesmo ambiente de servidor.
- Para um conector App Builder local, se você adicionar ou modificar colunas em uma tabela pública ou objeto de negócio, deverá manter manualmente as tabelas ou objetos de negócio correspondentes em cada lado sincronizados.
Nota
Recomendamos criar objetos de negócio dedicados para uso com o conector App Builder, em vez de reutilizar os existentes. Depois de importar um objeto, altere o objeto público apenas quando necessário; se fizer uma alteração, faça a mesma alteração em sua contraparte no conector App Builder local.
Solução de problemas
Erro 403 proibido
-
Sintoma: Conectar a um ambiente App Builder remoto usando o conector App Builder retorna um erro 403 Forbidden.
-
Possível causa: A conta de usuário configurada para o conector não recebeu a função App Builder Remote Connector no ambiente App Builder de origem.
-
Resolução: Atribua a função App Builder Remote Connector a esse usuário. Consulte a Etapa 5: Criar um grupo e conceder acesso do conector remoto para ver as etapas de configuração.
Detalhes de erro completo
Response status code does not indicate success
at void Vinyl.Business.Application.Events.RemoteEventRunner.AssertSuccessStatusCode(HttpResponseMessage response, string uri, EventTableRef eventTableRef)
at async Task<EventTableRef> Vinyl.Business.Application.Events.RemoteEventRunner.Invoke(EventTableRef eventTableRef, VinylConnectorEndpoint connectorEndpoint)
at async Task<EventTableRef> Vinyl.Business.Application.Events.RemoteEventRunner.InvokeCountAsync(EventTableRef eventTableRef)
at async Task<EventTableRef> Vinyl.DataSource.VinylConnector.VinylConnectorDataSourceServerHandler.CountPublicDataSourcesAsync(EventContext eventContext)
at async Task Vinyl.DataSource.VinylConnector.VinylConnectorDataSourceServerHandler.PingAsync(EventContext eventContext, CancellationToken cancellationToken)
at async Task Vinyl.DataSource.Plugins.DataSourceManagement.PingDataSourceServer.InvokeAsync(ValidationRule validationRule, EventInputRow input)
Reason
Forbidden
Status
403
Uri
https://{{App BuilderRootURI}}/connector/v1/count
Remote DataSourceId
19b4051a-b959-4b0c-9bd4-98b7cf2be132
Remote Table Name
DataSource_Public
Remote Event Name
null
Source
Vinyl.Business
Para solução de problemas relacionada, consulte App Builder Connector: A chave de API gerada não pode ser recuperada após sair da tela no guia de solução de problemas do App Builder.


