CONTEÚDO
- Visão Geral
- Premissas
- Instalação TOTVS Agro Connector Client (TCC)
- Configurações TOTVS Agro Connector Client (TCC)
- Glossário
01. VISÃO GERAL
Esta página tem a finalidade de demonstrar a instalação e configuração do TOTVS Agro Connector Client.
Além deste material, também há referências que se complementam:
TOTVS Agro Bioenergia (Pagadoria APIs) - Configuração IIS
Salesforce Integration - Guia de Referência
Integração com Salesforce - Arquitetura
02. PREMISSAS
- Instalação
- Possuir o token do cliente, disponibilizado pela equipe TOTVS (entrar em contato com o time de Atendimento/Suporte TOTVS Agro, direcionando o pedido ao time de Arquitetura/Engenharia Agro);
- Possuir uma base de dados preparada para criações/alterações de tabelas;
- Configuração
- Ter Postman devidamente instalado;
03. INSTALAÇÃO TOTVS AGRO CONNECTOR CLIENT
Com o arquivo descompactado, deve-se executar o arquivo install.bat como administrador;
Atenção
A pasta de instalação será gerada no mesmo local do instalador.
Após a execução, deve-se preencher as informações solicitadas pelo instalador;
Atenção
O banco de dados solicitado no instalador é referente o local que será criado as tabelas do TOTVS Agro Connector Client (TCC).
- Após pressionar qualquer tecla para continuar no instalador, basta verificar se o serviço foi criado e está em execução.
04. CONFIGURAÇÕES TOTVS AGRO CONNECTOR CLIENT
Para seguir com as configurações, a ferramenta Postman será utilizada como um facilitador para chamada de APIs do TOTVS Agro Connector Client (TCC).
O pacote de requisições/APIs via Postman pode ser obtido por meio deste link: TOTVS_Agro_Connector_Client_Postman.zip.
- Após feito o download e descompactado o zip, deve-se realizar a importação da Collection e do Environments no Postman:
Com os arquivos importados, deve-se configurar os parâmetros no environments no campo Current value:
Aviso
Não realizar alterações em campos não citados abaixo.
- url-tcclient: Informar o IP e a porta em que o TOTVS Agro Connector Client foi instalado
- typeDB: Informar o tipo de banco do produto [MYSQL, ORACLE12C, ORACLE11G, H2, MSSQLSERVER, POSTGRESQL]
- usernameDB: Informar o usuário para efetivar o login na base de dados do produto
- passowordDB: Informar a senha para efetivar o login na base de dados do produto
- productionVersion: Informar a versão que está inserida na tabela TCC_PRODUCT_METADATA
- jdbcURL: Informar a jdbc url da base do produto
- productName: Informar o produto que está sendo utilizado [PIMSCS, PIMSMC]
- versionSchemaDefiniton: Informar a versão do schema definition que será utilizado
Com os environments devidamente configurados, apresentam-se as requisições abaixo no TOTVS Agro Connector Client:
- [POST-001] - Cadastra o banco do produto.
- Após criar a product connection, é necessário ir na base dados e inserir o produto e versão na tabela TCC_PRODUCT_METADA. Exemplo abaixo:
INSERT INTO TCC_PRODUCT_METADATA (NAME, VERSION) VALUES('PIMSCS', '12.1.2305');
- Caso o comando "INSERT INTO" retorne uma ocorrência/mensagem de que a entrada "PIMSCS" já existe, modificar o comando para um "UPDATE" (atualização);
- Após criar a product connection, é necessário ir na base dados e inserir o produto e versão na tabela TCC_PRODUCT_METADA. Exemplo abaixo:
- [POST-002] - Tem a função de sincronizar os schemas definitions do TOTVS Agro Connector Server com TOTVS Agro Connector Client
- [GET-001] - Recupera os IDs dos schemas definitions de Fazenda, Setor e Cultura para realizar as integrações [POST-003], [POST-004] e [POST-007]
- [GET-002] - Recupera os IDs dos schemas definitions de Talhão para realizar as integrações [POST-005]
- [GET-003] - Recupera os IDs dos schemas definitions de Cultivar para realizar as integrações [POST-006]
- [GET-004] - Recupera os IDs do product connection (necessário para vínculos e exclusão)
- [POST-003] - Faz a integração (relacionamento/vínculo) do schema defintition e product connection da Fazenda (Realiza a criação da trigger)
- [POST-004] - Faz a integração (relacionamento/vínculo) do schema defintition e product connection da Setor (Realiza a criação da trigger)
- [POST-005] - Faz a integração (relacionamento/vínculo) do schema defintition e product connection da Talhão (Realiza a criação da trigger)
- [POST-006] - Faz a integração (relacionamento/vínculo) do schema defintition e product connection da Cultivar (Realiza a criação da trigger)
- [POST-007] - Faz a integração (relacionamento/vínculo) do schema defintition e product connection da Cultura (Realiza a criação da trigger)
- [GET-005] - Recupera os IDs dos vínculos entre schemas definitions e product connection de Fazenda, Setor e Talhão (necessário para as exclusões dos vínculos [DEL-001], [DEL-002] e [DEL-003], [DEL-004], [DEL-005] )
- [DEL-001] - Faz a exclusão do vinculo entre schema definition e product connection da Fazenda
- [DEL-002] - Faz a exclusão do vinculo entre schema definition e product connection da Setor
- [DEL-003] - Faz a exclusão do vinculo entre schema definition e product connection da Talhão
- [DEL-004] - Faz a exclusão do vinculo entre schema definition e product connection da Cultivar
- [DEL-005] - Faz a exclusão do vinculo entre schema definition e product connection da Cultura
- [DEL-006] - Faz a exclusão do product connection
- [POST-001] - Cadastra o banco do produto.
Atenção
Para executar as requisições de APIs via Postman, deve-se escolher a desejada e clicar em Send (enviar requisição).
06. GLOSSÁRIO
Termo | Descrição |
---|---|
TOTVS Agro Connector | TOTVS Agro Connector é responsável por monitorar os dados que serão enviados e chegar até o TOTVS Agro Conecta Dados. |
Postman | Postman é uma plataforma para realizar testes de API. |
Schema Definition | É um arquivo .json que é definido quais tabelas/campos serão monitorados ao ser criado as triggers. |
Product Connection | É a base de dados do produto, que terá a criação da trigger e monitoramento dos novos dados. |