Esta integração foi construída para efetuar o envio de dados entre TOTVS Agro Bioenergia (módulo de Pagadoria) para Salesforce com foco em "dados mestres" de Fazenda (Nível 1), Setor (Nível 2) e Talhão (Nível 3), quando inseridos ou atualizados via aplicação (Bioenergia/Pagadoria).
A partir destes eventos, dados mestres de Locais de Produção são compartilhados com a plataforma Salesforce, possibilitando a criação de novos contratos (no Salesforce). Desta forma, esta documentação técnica fornece detalhes arquiteturais e de tecnologia para tal integração (via TOTVS Agro Plataforma e TOTVS Agro Conecta Dados).
Salesforce Integration - Guia de Referência
TOTVS Agro Bioenergia (Pagadoria APIs) - Configuração IIS
Na representação arquitetural e dos componentes envolvidos, pode-se conhecer, em detalhes técnicos, o fluxo geral de eventos/dados, desde sua saída do (1) TOTVS Agro Bioenergia (módulo de Pagadoria) até chegar para Salesforce, passando pelo (2) TOTVS Agro Connector Client (componente/agent On-Premise que realiza captura de dados CDC - Change Data Capture) que compartilha dados com (3) TOTVS Agro Connector Server (aplicação SaaS no domínio TOTVS), que compartilha dados com (4) TOTVS Agro Plataforma (aplicação SaaS no domínio TOTVS) e, por fim, à chamada de APIs da Salesforce pelo (5) TOTVS Agro Conecta Dados (aplicação SaaS no domínio TOTVS - via "Conector Salesforce"):
O fluxo de integração e seus principais componentes são:
O TOTVS Agro Connector Client é um aplicação On-Premise, que é instalado localmente no ambiente do cliente com um TENTANT_ID que é disponibilizado pela equipe do TOTVS Agro e atualmente possui uma interface do Swagger e a sua própria base de dados.
No Swagger, cadastra-se a base de dados do produto, no caso TOTVS Agro Bioenergia.
Atualmente, o modelo de dados utiliza de Schemas Definitions, que é o mapeamento de tabelas e colunas que serão enviadas para parceira, conforme solicitação, a equipe TOTVS Agro realiza esse cadastro e será enviado os seguintes dados:
|
Após o cadastro, vincula-se a base de dados com o Schema Definition (LocalProducao1, LocalProducao2 e LocalProducao3), esses Schemas Definitions (dados que serão enviados), após efetuar esse vínculo é criado uma trigger que monitora cada insert/update que foi cadastrado conforme a tabela acima. Quando é realizado algum INSERT ou UPDATE esse dado é processado através de tabelas do TOTVS Agro Connector Client e enviado por API como JSON para o TOTVS Agro Connector Server. Em caso de perda de conexão (serviço desligado) o registro fica em uma tabela criada chamada TCC_EVENT com status de UNPROCESSED, assim que serviço é ligado novamente o dado é processado e enviado, isso para garantir que não haja perca de dados.
O TOTVS Agro Connector Server é uma aplicação que fica nos ambientes TOTVS Apps e é utilizado pela equipe TOTVS Agro para realizar os cadastros dos clientes, gerando o TENANT_ID (para os clientes conseguirem realizar instalação do TOTVS Agro Connector Client) e os cadastros dos Schemas Definitions que foram citados Anteriormente.
Também é responsável por receber os dados que o TOTVS Agro Connector Client envia. Com esse JSON recebido, ele é enviado para uma fila de mensageria da TOTVS por meio do RabbitMQ para o TOTVS Agro Plataforma.
{
"header":{
"type":"LocalProducao1",
"generatedOn":"2023-03-02T12:45:19.000688Z",
"locale":"pt_BR"
},
"content":{
"originApp":"PIMSCS",
"appVersion":"12.1.2301",
"schemaName":"LocalProducao1",
"schemaVersion":"12.1.2301",
"action":"INSERT",
"data":{
"id":{
"id":"TESTE"
},
"nome":"TESTE1",
"codigo":"TESTE",
"originId":"Q0RfVVBOSVZFTDE9VEVTVEU="
},
"createdAt":"2023-03-02T12:45:19.303637Z",
"token":"8c12da2baca8de2e6b5dd2f6999c6998cbc7b563e5c24e043fa26b72f1f406e8"
}
} |
O TOTVS Agro Plataforma está disponível nos ambientes do TOTVS Apps, porém ele não possuí uma interface gráfica. Ele é responsável por receber as mensagens do TOTVS Connector Server que foi processado na fila do RabbitMQ, então ele pega o JSON recebido, insere os dados na própria base de dados para haver controles de chaves primárias, chaves estrangeiras e garantir a integridade das tabelas e relacionamentos. Após conclusão de inserção com sucesso, novamente esse JSON é enviado para outra fila via RabbitMQ, que será processado pelo TOTVS Agro Conecta Dados.
{
"header":{
"type":"FazendaCriada",
"tenantId":"8c12da2baca8de2e6b5dd2f6999c6998cbc7b563e5c24e043fa26b72f1f406e8",
"generatedOn":"2023-03-22T14:12:21.428785Z",
"locale":"pt_BR"
},
"content":{
"originId":"Q0RfVVBOSVZFTDE9NjAwODZB",
"metadata":{
},
"codigo":"FazendaA1",
"descricao":"Fazenda Teste",
"documento":null,
"instanciaOriginId":null,
"cdMunicipio":"2308",
"cdFornecedores":"94500",
"endereco":"Fazenda Teste",
"telefone":null,
"cnpjCpf":"12345678",
"incra":null,
"inscricaoProdutorRural":"123.456.789-10",
"cep":"111111",
"tipoPessoa":"J",
"qtdAreaTotal":"24",
"qtdAreaProdutiva":"24",
"cdIntErp":null
}
} |
Para realizar as requisições é necessário passar o token recuperado, após autenticação. |
Destacam-se as tabelas disponibilizadas para nós com base na API deles, ou seja, o JSON que será inserido no body da requisição e exemplos de collections: Patch(Insert-Update)-Exemplos.postman_collection.json que pode ser importado no Postman para realizar os testes, basta inserir os dados necessários que são destacados em vermelhos na requisição após a importação.
Modelo à ser enviado: FAZENDA (Local de Produção 1) para Salesforce.
| API | Tipo | Descrição |
|---|---|---|
| IdConta__c | Texto | ID Fazenda |
| CodigodaPropriedade__c | Texto(6) (ID Externo) | Código Fazenda |
| Municipio__r.codigoMunicipio__c | Pesquisa | Código Município |
| codigoFornecedor__c | Numero(8) | Código Fornecedor |
| descricaoCompleta__c | Texto(70) | Descrição Completa |
| BillingStreet | Texto(70) | Endereço |
| Phone | Texto(70) | Telefone |
| cnpjCPF__c | Texto(18) | CNPJ ou CPF |
| numeroIncra__c | Texto(15) | N° INCRA |
| numeroInscricaoProdutorRural__c | Texto(20) | N° Insc.Produtor Rural |
| Cep__c | Texto(16) | N° CEP |
| Tipo_de_Pessoa__c | Texto(1) | |
| QtdeAreaTotalHA__c | Numero(7,2) | |
| QtdeAreaTotalProdHectares__c | Numero(7,2) | |
| codigoInternoErp__c | Texto(15) | |
| Instancia__r.CodigoInstanciaPIMS__c | Texto(5) | |
| flagAtivo__c | Lista de Opçoes |
Modelo à ser enviado: SETOR (Local de Produção 2) para Salesforce.
| API | Tipo | Descrição |
|---|---|---|
| IdBloco__c | Texto(6) (ID Externo) | Id Bloco |
| Conta__r.IdConta__c | Pesquisa(Conta) | Código Fazenda |
| codigoBloco__c | Texto(6) (ID Externo) | Código Bloco |
| Municipio__r.codigoMunicipio__c | Pesquisa | Código Município PIMS |
| Name | Name | Descrição do Bloco |
| Hectares__c | Numero(16,2) | Quantidade de Área Total em Hectares |
| AreaProdutivaHA__c | Numero(16,2) | Quantidade de Área Produtiva em Hectares |
Modelo à ser enviado: TALHÃO (Local de Produção 3) para Salesforce.
| API | Tipo | Descrição |
|---|---|---|
| IdTalhao__c | Texto | ID Talhão |
| Safra__c | Numero(5) | Código da Safra |
| Conta__r.IdConta__c | Texto(6) | Código Fazenda |
| Bloco__r.IdBloco__c | Pesquisa | Código Bloco |
| codigoTalhao__c (ID Externo) | Texto(6) | Código Talhão |
| CodigoTipoPropriedade__c | Lista de Opções | Código Tipo de Propriedade |
| DistanciaTerra__c | Numero(4,1) | Distância Terra |
| DistanciaAsfalto__c | Numero(4,1) | Distância Asfalto |
| DistanciaHidrovia__c | Numero(4,1) | Distância Hidrovia |
| CodigoSistemaColheita__c | Lista de Opções | Código de Sistema de Colheita |
| DataPlantio__c | Date | Data do Plantio |
| CodigoOcupacao__c | Lista de Opções | Código de Ocupação |
| CodigoVariedade__c | Lista de Opções | Código de Variedade |
| CodigoEstagio__c | Lista de Opções | Código de Estagio |
| CodigoEspacamento__c | Lista de Opções | Código de Espaçamento |
| CodigoSistemaPlantio__c | Lista de Opções | Código de Sistema de Plantio |
| AreaProdutivaHA__c | Numero(7,2) | Quantidade de Área Produtiva em Hectares |
| CodigoOcupacaoAnterior__c | Lista de Opções | Código de Sistema de Plantio Anterior |
| FlagTipoPlantio__c | Lista de Opções | Flag de Tipo de Plantio |
Exemplo de requisição Postman: PATCH - Setor
1. Trigger
1.1. Trigger monitora cada novo evento na tabela
1.2. Para os eventos gerados a trigger insere o registro na tabela TCC_EVENT, com os dados que foram gerados no schema definition e status unprocessed
2. TOTVS Agro Connector Client
2.1. monitora a tabela TCC_EVENT, por meio da classe EventScheduler.java
2.2. Após receber os dados é feito uma verificação e uma atualização na tabela TCC_EVENT, alterando o status para processed por meio da classe RowDataService.java
2.3. Com os dados validados, é processado para tabela OUTCOMING_DATA e enviado para o TOTVS Agro Connector Server por meio da classe EventProcessor.java
3. TOTVS Agro Connector Server
3.1. A lista de eventos recebidas pelo TOTVS Agro Connector Client é enviado na tabela própria do produto chamada CLIENT_DATA que pode ser encontrado por meio da classe CriateClientDataService.java
3.2. ClientDataScheduler.java é responsável por processar o JSON recebido para a fila do RabbitMQ no TOTVS Agro Plataforma.
4. TOTVS Agro Plataforma
4.1. Nesse momento o JSON é classificado de acordo com schema definition e inserido coluna por coluna nas tabelas com suas integridades na base de dados do TOTVS Agro Plataforma
4.1.1. Se for uma fazenda (Nível 1) (FazendaTCServerListener.java), é inserido e registrado na tabela FAZENDA, por meio da classe FazendaTCServerProcessor.java
4.1.2. Se for um setor (Nível 2) (SetorTCServerListener.java), é inserido e registrado na tabela SETOR, por meio da classe SetorTCServerProcessor.java
4.1.3. Se for um talhão (Nível 3) (TalhaoTCServerListener.java), é inserido e registrado na tabela TALHAO_LOGICO, por meio da classe TalhaoTCServerProcessor.java
4.2. Após as inserções e validações a mensagem (JSON) é novamente inserido em outra fila do Rabbit para enviar para o TOTVS Agro Conecta Dados por meio da classe EntidadePlataformaPublisher.java
5. TOTVS Agro Conecta Dados
5.1. Em uma fila única, a mensagem recebida é verificada o tipo do connector e a mesma é processada na classe AcaoConectorEntidade.java
5.2. Token
5.2.1 O token é recuperado por meio do preenchimento no front e inserido nas tabelas do TOTVS Agro Conecta Dados, a autenticação e atualização de token pode ser acompanhado na classe: AtualizarTokenSalesforceService.java
5.3. Fazenda
5.3.1. SalesforceEnvioFazendaProcessor.java é a classe responsavél por ler a mensagem, criar e tratar o JSON com a estrutura da Salesforce
5.3.2. SalesforceFazendaHttpClient.java realiza a autenticação e realiza o envio se comunicando com a API Salesforce.
5.4. Setor
5.4.1. SalesforceEnvioSetorProcessor.java é a classe responsavél por ler a mensagem, criar e tratar o JSON com a estrutura da Salesforce
5.4.2. SalesforceSetorHttpClient.java realiza a autenticação e realiza o envio se comunicando com a API Salesforce.
5.5. Talhão
5.5.1. SalesforceEnvioTalhaoProcessor.java é a classe responsavél por ler a mensagem, criar e tratar o JSON com a estrutura da Salesforce
5.5.2. SalesforceTalhaoHttpClient.java realiza a autenticação e realiza o envio se comunicando com a API Salesforce.