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ócio 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.

Qual variante você usa depende de onde esse outro aplicativo está localizado:

• Um conector local vincula duas fontes de dados no mesmo servidor App Builder. Por exemplo, se seu servidor hospeda uma fonte de dados Northwinds e um My Application separado, e My Application precisa ler (e opcionalmente gravar) dados de Northwinds, um conector local oferece a My Application acesso direto às tabelas de Northwinds, sem copiar esses dados para o próprio banco de dados de My Application. Como ambos os aplicativos são executados no mesmo servidor, o App Builder gerencia 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, via HTTP. Por exemplo, conectar o servidor App Builder de 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 independentemente. 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 via HTTP.

Além disso, esta página também contém uma seção Limitações abordando restrições conhecidas a serem consideradas antes de depender do conector App Builder, e uma seção Solução de problemas abordando erros comuns e como resolvê-los.

Conector App Builder local

Um conector App Builder local permite que um aplicativo em seu servidor App Builder use diretamente tabelas e objetos de negócio que residem na fonte de dados de outro aplicativo nesse mesmo servidor, sem copiar os dados ou configurar nenhuma autenticação de rede. Por exemplo, se My Application precisa ler dados que residem na fonte de dados Northwinds, ambos hospedados no mesmo servidor, um conector local oferece a My Application acesso direto às tabelas públicas de 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ócio que você deseja usar em seu conector
• Etapa 3: Criar uma fonte de dados usando o conector App Builder local
• Etapa 4: Importar tabelas e objetos de negócio para 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

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 essa conexão localmente em vez de via HTTP:

1. Selecione IDE > Data Servers.

2. Clique em + Server no painel Data Servers. A caixa de diálogo Server abre. Insira 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.

3. Clique em Save e feche a caixa de diálogo.

Etapa 2: Permitir acesso público às tabelas e objetos de negócio que você deseja usar no seu conector

Uma tabela ou regra deve ser marcada como Public antes que um conector possa usá-la:

1. Navegue até o App Workbench do aplicativo que você deseja usar.

2. Marque as tabelas ou regras que você deseja usar no seu conector como Public:

   • Para marcar uma tabela como pública:

     1. Acesse a aba Tables.
     2. Localize a tabela que você está procurando 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.

     3. No painel Table, clique em More > Edge Case. A caixa de diálogo Edge Case Settings abre:

        

     4. No grupo de campos Public Access, marque Allow Read e/ou Allow Write conforme necessário.

   • Para marcar uma regra como pública:

     1. Acesse a aba Rules.
     2. Localize a regra que você está procurando no painel Rules e clique no ícone de edição ou clique duas vezes em sua linha. O Rule Builder dessa regra abre.

     3. No painel Rule, clique em More > Edge Case. A caixa de diálogo Edge Case Settings abre:

        

     4. No grupo de campos Allow Public Access, marque Read para permitir a leitura dos dados da regra e/ou Write para permitir sua modificação.

Etapa 3: Criar uma fonte de dados usando o conector local do App Builder

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:

1. Acesse IDE > Data Servers.
2. No painel Data Servers, selecione Local App Builder.

3. Clique em + Source. Um assistente aparece para guiá-lo pelo processo:

   

4. Selecione um banco de dados para 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ê está procurando deve ter pelo menos uma tabela ou regra pública (consulte Etapa 2); caso contrário, não será selecionável.

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

6. O assistente apresenta um resumo da nova fonte de dados. Clique em Done. A nova fonte de dados agora aparece listada em + Source.

7. (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 chamado My Application, seria nomeado Northwinds (My Application). Para renomear sua fonte de dados, siga estas etapas:

8. Clique no ícone de nova janela no bloco da fonte de dados ou clique duas vezes no bloco. A caixa de diálogo App Builder Connector é aberta:

   ![Caixa de diálogo App Builder Connector](/_download/images/app-builder/connect/app-builder-connector-dialog.png){style="width: 600px"}
   

   1. Clique em Edit. A caixa de diálogo Data Storage Layer é aberta:

      

   2. Clique em Edit novamente. Digite um nome apropriado no campo Data Source Name.

   3. Clique em Save.

Etapa 4: Importar tabelas e objetos de negócio para 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 a 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.

1. Acesse IDE > Data Servers.
2. No painel Data Servers, selecione Local App Builder.

3. No painel lateral, clique no ícone de nova janela no bloco da fonte de dados ou clique duas vezes no bloco. A caixa de diálogo App Builder Connector é aberta:

   

4. Em Data Storage Layer, clique em Import. A caixa de diálogo Import Schema é aberta:

   

   • Para importar todas as tabelas marcadas 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.

5. Clique em Proceed. O App Builder executa uma tarefa em segundo plano para concluir a importação.

Etapa 5: Adicionar seu conector local do App Builder como uma fonte de dados ao seu aplicativo

A fonte de dados criada na Etapa 3 existe no servidor, mas seu aplicativo não pode usá-la até que você a adicione explicitamente como uma fonte:

1. Navegue até o App Workbench do aplicativo que deseja modificar.
2. Acesse a guia Data Sources.
3. No painel Data Sources, clique em + Source. A caixa de diálogo Add a Source to your application é aberta.
4. Selecione Link to existing source e clique em Next.
5. Localize a fonte de dados criada na Etapa 3 e clique em Link 1 Source.
6. Revise a atualização proposta e clique em Done.

Etapa 6: Vincular sua fonte de dados do conector local do App Builder e seu banco de dados relacional

Vincular fontes permite criar regras entre fontes de dados em qualquer direção:

• Para criar regras com o banco de dados relacional como a fonte e sua fonte de dados do conector local do App Builder como o destino:

  1. Navegue até o App Workbench do aplicativo que deseja modificar.
  2. Acesse a guia Data Sources.
  3. Selecione o banco de dados relacional que deseja vincular. O painel lateral é preenchido com suas opções.
  4. No grupo de campos Business Logic Layer, clique em Link Sources. A caixa de diálogo Linked Data Sources é aberta.
  5. Clique em Create e selecione a fonte de dados do conector local do App Builder que você adicionou ao seu aplicativo na Etapa 5.
  6. Clique na marca de seleção para salvar o registro.

Após vinculado, você pode usar tabelas e objetos de negócio da fonte de dados local do App Builder em regras de negócio e regras XP CRUD construídas no banco de dados relacional, incluindo regras XP CRUD cuja fonte de dados é o banco de dados relacional e cuja fonte de dados de destino é sua fonte de dados local do App Builder. Construa essas regras XP CRUD no banco de dados relacional.

• Para construir regras na direção oposta, com seu conector local do App Builder como origem e o banco de dados relacional como destino:

  1. Navegue até o App Workbench do app que você deseja modificar.
  2. Acesse a aba Data Sources.
  3. Selecione o conector local do App Builder que você deseja vincular. O painel lateral é preenchido com suas opções.
  4. No grupo de campos Business Logic Layer, clique em Link Sources. A caixa de diálogo Linked Data Sources é aberta.
  5. Clique em Create e selecione a fonte de dados relacional que você deseja conectar.
  6. Clique no checkmark para salvar o registro.

  Após vinculado, você pode usar tabelas e objetos de negócio do banco de dados relacional em regras de negócio e regras XP CRUD construídas 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 de destino é sua fonte de dados relacional. Construa essas regras XP CRUD no conector local do App Builder.

Conector remoto

Um conector remoto permite que uma aplicação em um ambiente do App Builder use um objeto compartilhado de um ambiente do 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 se autenticar mutuamente de forma explícita usando uma chave de 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 aborda:

• Etapa 1: Criar o objeto a compartilhar usando o conector do App Builder
• Etapa 2: Ativar conexões remotas do App Builder
• Etapa 3: Confirmar que um provedor de segurança de chave de 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 de 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 o 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:

1. Navegue até o App Workbench do app que você deseja compartilhar e acesse a aba Rules.

2. Clique em + Rule. O Rule Builder é aberto:

   • Name: Atribua um nome para a regra. Por exemplo: Customer (Remote).
   • Purpose: Selecione Business Object.
   • Target: Selecione uma tabela de destino para a regra. Por exemplo: Customer.

3. Clique em Create.

4. No painel Tables, selecione as colunas que você deseja compartilhar.

5. No painel Rule, acesse More > Edge Case. A caixa de diálogo Edge Case Settings é aberta:

   

6. Em Allow Public Access, marque Read e/ou Write conforme apropriado, para que o ambiente remoto possa acessar o objeto.

7. Clique em Proceed.

Etapa 2: Ativar conexões remotas do App Builder

Compartilhar um objeto não é suficiente por si só: a aplicação também deve ser explicitamente autorizada a aceitar solicitações de conector remoto e, desde o App Builder 4.67, associada aos provedores permitidos para autenticá-las:

1. Acesse IDE > Configurações Adicionais.

2. No painel Configurar, clique em Remote Connector. A caixa de diálogo Fontes de Dados é aberta:

   

3. Marque a coluna Permitir para o aplicativo no qual você deseja permitir conexões remotas.

4. Clique em Prosseguir ou na marca de seleção .
5. (A partir do App Builder 4.67.) Clique no botão Configurar Autenticação do aplicativo. A caixa de diálogo Provedores de Autenticação é aberta. Adicione os provedores de chave de 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.

Etapa 3: Confirmar que um provedor de segurança de chave de API está configurado

O ambiente remoto se autentica neste usando uma chave de API, portanto, confirme se esse provedor de segurança existe e está habilitado antes de gerar uma:

1. Acesse IDE > Provedores de Segurança.
2. Confirme se um provedor de segurança Chave de API habilitado está configurado. Se não estiver, configure um (consulte Provedor de segurança - Chave de API para saber como fazer isso).

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 gerando a chave de API para esse usuário. Se você as pular e gerar uma chave de 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 ao que você está compartilhando aqui.

1. Navegue até o App Workbench do aplicativo e acesse a guia Funções. Se o aplicativo tiver mais de uma fonte de dados, selecione aquela à qual o objeto compartilhado pertence no menu de fonte de dados na parte superior da página.

2. Clique em + Função (mostrado abaixo):

   

3. A caixa de diálogo Função é aberta. Atribua um Nome à função. Por exemplo: Remote Connector.

4. Clique em Salvar. O painel Permissões fica disponível para interação:

   

5. Clique em + Permissão, selecione o objeto que você criou na Etapa 1 e marque Leitura, Inserção, Atualização e/ou Exclusão conforme necessário.

6. Clique na marca de seleção para salvar.

Etapa 5: Criar um grupo e conceder acesso a ele

Crie um grupo dedicado para o ambiente remoto se autenticar como:

1. Navegue até IDE > Gerenciamento de Usuários e selecione a guia Grupos:

   

2. Clique em + Grupo. A caixa de diálogo Grupo é aberta:

   

3. Atribua um Nome. Por exemplo: Remote Connector.

4. Clique em Salvar.
5. Clique em Gerenciar Privilégios. Os painéis Privilégios e Funções são abertos.

6. No painel Privilégios, clique em Criar. A caixa de diálogo Privilégio é aberta:

   

   • Tipo: Selecione Aplicativo.
   • Aplicativo: Selecione o aplicativo que contém o objeto que você está compartilhando. Por exemplo: Global Imports.

7. Clique em Salvar.

8. No painel Funções, localize e clique em Conceder para a função que você criou na Etapa 4.

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:

1. Selecione a aba Users:

   

2. Clique em + User. O diálogo User abre:

   

3. Atribua um User Name. Por exemplo: RemoteConnector.

4. Clique em Save.
5. Clique em More > Keys.

6. Clique em Create. O diálogo Generate Key abre:

   

7. Selecione API Key como Provider e clique em Save.

8. Copie o valor da Key gerada para sua área de transferência.

   Cuidado

   O valor da chave gerada não pode ser recuperado novamente após sair da tela Generate Key. Se perdê-lo, será necessário gerar uma nova.

9. Clique em + Membership, selecione o grupo criado em 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:

1. Navegue até o ambiente remoto do qual deseja se conectar, acesse o App Workbench do app que deseja conectar e selecione a aba Data Sources.
2. Clique em + Source. Um assistente abre para ajudá-lo.
3. Na primeira tela do assistente, selecione New Connection e clique em Next.

4. Selecione Other como Connection Category, procure e selecione App Builder Connector:

   

5. Clique em Next. O assistente pula a etapa Choose Provider para este tipo de conexão e vai direto para Create Connection.

6. Digite os seguintes valores:

   

   • Server Name: Atribua um nome. Por exemplo: Remote.
   • App Builder Type: Confirme se está definido como Remote.
   • Url: Digite a URL do ambiente ao qual está se conectando. Por exemplo: https://example.com.
   • Api Key: Cole o valor da chave copiado em Etapa 6.

7. Clique em Next e prossiga pelas etapas restantes do assistente (Choose Database, Import Schema e Summary) para selecionar o banco de dados, importar as tabelas, visualizações e procedimentos armazenados que deseja conectar e confirmar a nova conexão.

8. Selecione a fonte de dados do conector App Builder remoto e clique em Logic.
9. Clique no ícone Results de uma entrada para confirmar que você vê os dados.
10. 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

Tenha em mente as seguintes limitações ao trabalhar com o conector App Builder:

• O conector App Builder não suporta Reach.
• O conector App Builder suporta Full audit, mas o Full audit deve estar habilitado 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 adicionar ou modificar colunas em uma tabela pública ou objeto de negócio, será necessário manter manualmente as tabelas ou objetos de negócio correspondentes em cada lado sincronizados.

Solução de problemas

Erro 403 forbidden

• Sintoma: Conectar a um ambiente remoto do App Builder 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 Etapa 5: Criar um grupo e conceder acesso a ele do conector remoto para as etapas de configuração.

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 relacionados, 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.