Histórico da Página

Visão Geral
Arquitetura TOTVS
1. TOTVS Connector Client
2. TOTVS Connector Server
3. TOTVS Agro Plataforma
4. TOTVS Agro Conecta Dados
5. Monitoramento TOTVS Apps

01. VISÃO GERAL

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

02. Arquitetura TOTVS

Na imagem abaixo, podemos ver com detalhes o fluxo geral, desde quando os dados saí do TOTVS Agro Bioenergia até chegar para Salesforce. O fluxo é divido em 3 etapas que serão detalhadas de acordo com decorrer do material, essas etapas são:

- On-Premise, ambiente do cliente, onde é instalado o TOTVS Agro Connector Client;
- TOTVS Apps, ambiente Web TOTVS que está localizado o TOTVS Agro Connector Server, TOTVS Agro Plataforma e TOTVS Agro Conecta Dados;
- Terceiros, API fornecida pela Salesforce para realizarmos os envios dos dados;

Resumidamente a integração segue o fluxo abaixo.

- TOTVS Agro Connector Client é instalado no cliente e cadastrado a base e vinculado com Schema Definition, logo após é criado uma trigger que fica monitorando quando é inserido ou atualizado um novo registro e para cada novos dados é enviado via JSON por API para o TOTVS Connector Server;
- TOTVS Agro Connector Server é responsável por receber esses dados e processar em uma fila de mensageria via RabbitMQ, tal fila que TOTVS Agro Plataforma irá receber;
- TOTVS Agro Plataforma irá fazer as validações dos dados recebidos na fila e inserir no banco do próprio, garantindo-se a integridade dos dados. Com os dados validado será processado para uma nova fila no RabbitMQ que o TOTVS Agro Conecta Dados irá receber;
- TOTVS Agro Conecta Dados irá receber essa mensagem com JSON, que será adaptada ao modelo repassado pela Salesforce, portanto, após a autenticação com os dados informado na interface web do TOTVS Agro Conecta Dados, fazemos uma requisição PATCH passando os novos dados tratados;
- Após a requisição PATCH é possível verificar nos logs do TOTVS Agro Conecta Dados se a mensagem foi recebida com sucesso pela Salesforce;

Após a explicação resumida acima, nas próximas seções iremos detalhas o papel de cada produto e suas funções a serem utilizadas.

2.1. TOTVS Agro Connector Client

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, cadastramos a base de dados do produto, no caso TOTVS Agro Bioenergia.

Hoje, trabalhamos com 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:

UPNIVEL1	UPNIVEL2	UPNIVEL3
CD_UPNIVEL1	CD_UPNIVEL1 + CD_UPNIVEL2	CD_SAFRA + CD_UPNIVEL1 + CD_UPNIVEL2 + CD_UPNIVEL3
CD_UPNIVEL1	CD_UPNIVEL1	CD_SAFRA
CD_MUNIC	CD_UPNIVEL2	CD_UPNIVEL1
CD_FORNEC	CD_MUNIC	CD_UPNIVEL2
DE_UPNIVEL1	DE_UPNIVEL2	CD_UPNIVEL3
DE_ENDERECO	QT_AREA_TOT	CD_TP_PROPR
NO_TELEFONE	QT_AREA_PROD	DS_TERRA
NO_CGC_CPF		DS_ASFALTO
NO_INCRA		DS_HIDROVIA
NO_INSC_PROD		CD_SIST_COLH
NO_CEP		DT_PLANTIO
FG_TP_PESS		CD_OCUP
QT_AREA_TOT		CD_VARIED
QT_AREA_PROD		CD_ESTAGIO
CD_INT_ERP		CD_ESPACAM
INSTANCIA		CD_SIST_PLAN
FG_ATIVO		QT_AREA_PROD
		CD_OCUP_ANT
		FG_TP_PLANTIO

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.

2.2. TOTVS Agro Connector Server

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.

Abaixo, são exibidos os detalhes de um exemplo de JSON que é enviado à do RabbitMQ (mencionado acima).

Bloco de código

theme	Confluence

{
   "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"
   }
}

2.3. TOTVS Agro Plataforma

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, foreign key 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.

Abaixo, exibiremos em detalhe um exemplo de JSON que irá para fila do rabbit mostrado acima.

Bloco de código

theme	Confluence

{
   "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
   }
}

2.4. TOTVS Agro Conecta Dados

- O TOTVS Agro Conecta Dados Front é responsável por cadastrar as informações disponibilizadas pela Salesforce e também ativar ou desabilitar integrações, tais elas como:

- O TOTVS Agro Conecta Dados Server é responsável por receber o JSON via mensageria, então ele fica observando a fila que o TOTVS Agro Plataforma enviou os dados. Com o JSON disponível o TOTVS Agro Conecta Dados fica responsável por realizar a autenticação a partir dos dados informados no front, com isso ele monta o JSON baseado no modelo enviado e processamos a requisições PATCH para Salesforce, conforme alguns exemplos abaixo:

Aviso

title	Atenção

Para realizar as requisições é necessário passar o token recuperado, após autenticação.

Abaixo será exibidos as tabelas disponibilizadas para nós com base na API deles, ou seja o que devemos passar no body da requisição como JSON e exemplos de como estamos utilizando cada uma no postman:

Modelo à ser enviado: FAZENDA (Local de Producão 1) para Salesforce.

API	Tipo	Descrição
IdConta__c	texto	Id Fazenda
CodigodaPropriedade__c	Texto(6) (ID Externo)	Cod Fazenda
Municipio__r.codigoMunicipio__c	Pesquisa	Cod Municipo PIMS
codigoFornecedor__c	Numero(8)	Cod 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 Producão 2) para Salesforce.

API	Tipo	Descrição
IdBloco__c	Texto(6) (ID Externo)	Id Bloco
Conta__r.IdConta__c	Pesquisa(Conta)	Cod Fazenda
codigoBloco__c	Texto(6) (ID Externo)	Cod Bloco
Municipio__r.codigoMunicipio__c	Pesquisa	Cod Municipo PIMS
Name	Name	Descrição do Bloco
Hectares__c	Number(16,2)	Qtde de Area Total em Hectares
AreaProdutivaHA__c	Number(16,2)	Qtde de Area Produtiva em Hectares

Modelo à ser enviado: TALHÃO (Local de Producão 3) para Salesforce.

API	Tipo	Descrição
IdTalhao__c	Texto	Id Talhão
Safra__c	Numero(5)	Codigo da Safra
Conta__r.IdConta__c	Texto(6)	Cod Fazenda
Bloco__r.IdBloco__c	Pesquisa	Cod Bloco
codigoTalhao__c (ID Externo)	Texto(6)	Cod Talhão
CodigoTipoPropriedade__c	Lista de Opções	Cod 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	Codigo de Sistema de Colheita
DataPlantio__c	Date	Data do Plantio
CodigoOcupacao__c	Lista de Opções	Codigo de Ocupação
CodigoVariedade__c	Lista de Opções	Codigo de Variedade
CodigoEstagio__c	Lista de Opções	Codigo de Estagio
CodigoEspacamento__c	Lista de Opções	Codigo de Espaçamento
CodigoSistemaPlantio__c	Lista de Opções	Codigo de Sistema de Plantio
AreaProdutivaHA__c	Number(7,2)	Qtde de Area Produtiva em Hectares
CodigoOcupacaoAnterior__c	Lista de Opções	Codigo de Sistema de Plantio Anterior
FlagTipoPlantio__c	Lista de Opções	Flag de Tipo de Plantio

- Exemplo de requisição Postman: PATCH - Fazenda

- Exemplo de requisição Postman: PATCH - Setor

- Exemplo de requisição Postman: PATCH - Talhão

Páginas filhas

Versões comparadas

Versão antiga 24

Nova versão 25

Chave