01. VISÃO GERAL
O aplicativo TOTVS Agro Connector Client é uma instalação realizada On-Premise, portanto, existem algumas premissas e definições a serem atendidas para realizar a instalação.
Para a instalação, recomendamos um servidor/VM Linux:
- ✔️ Docker (plataforma Linux) - recomendado:
- Utilizado com o Sistema Operacional Linux (Debian ou CentOS GNU/Linux 10 (buster) ou distribuição Linux 64 bits com interface gráfica)
- Deploy automatizado e sem downtime, com performance superior ao cenário Windows
- Monitoramento de erros e envio de notificações para o time da TOTVS, que por sua vez podem atuar de maneira proativa
- 100% controlado pelo time da TOTVS (novas atualizações na plataforma de integração TOTVS Agro Connector)
- Windows Service (plataforma Windows):
- Escolher essa opção somente se não for possível realizar a instalação do TOTVS Agro Connector Client em um servidor que seja Linux (criando uma VM ou utilizando um servidor existente)
- Utilizará de Windows Service Wrapper (WSW) para configuração como serviço do Windows
- Dependência: RabbitMQ (https://www.rabbitmq.com/docs/install-windows) + Erlang for Windows (De acordo com modelo utilizado pelo cliente)
Mais informações sobre o TOTVS Agro Connector Client podem ser consultadas neste link.
> Compatibilidade de versões Linux com plataforma Docker Server: https://docs.docker.com/engine/install/
02. PREMISSAS
⚠️ Requisitos de hardware/software
- Recomendado (Equivalente ou superior): CPU Intel® Xeon® Gold 5415+ Processor (22.5M Cache, 2.90 GHz) / 2 vCPU
- Recomendado (inicial): 8 GB de RAM disponível (somente para TOTVS Agro Connector + PostgreSQL + RabbitMQ + Redis);
- Recomendado: 20 GB espaço em disco disponível (somente para TOTVS Agro Connector + PostgreSQL + RabbitMQ + Redis);
⚠️ Observações de instalação (ambiente/infraestrutura)
- Os requisitos de hardware (memória RAM e espaço em disco) podem ser superiores aos inicialmente recomendados, devido ao volume de dados monitorado/integrado entre as aplicações que estão sendo integradas por ele (para isto, será necessário monitorar e validar a necessidade de subida destes requisitos durante uma homologação);
- Na instalação, os componentes/serviços do TOTVS Agro Connector Client devem estar o mais próximo das bases de dados de produtos a serem integrados (por exemplo, Oracle/Bioenergia), reduzindo assim questões de latência e/ou instabilidade com a base de dados monitorada/sincronizada;
- Também recomendamos a separação entre ambiente/infraestrutura de TOTVS Agro Connector Client e demais aplicações (por exemplo, TOTVS Agro Bioenergia, TOTVS Agro Multicultivo e/ou TOTVS Agro Minha Borracharia) - desta forma, seguir a recomendação mencionada no quadro "Infraestrutura e ambientes" (abaixo);
- A latência (ping) entre ambiente de instalação dos componentes/serviços do TOTVS Agro Connector Client e as bases de dados deve ser inferior aos valores recomendados (em milissegundos);
- "<= 3 ms": Uso de "ping" via comando "ping HOSTNAME";
- Importante: O teste de ping não reflete diretamente na latência durante a comunicação com o banco de dados, mas sim na indicação geral da conectividade/latência entre cliente e servidor de banco de dados.
- "<= 3 ms": Uso de "tnsping" via comando "tnsping SERVICE_NAME";
- Importante: O teste com tnsping não reflete diretamente na latência durante a comunicação com o banco de dados, mas sim para testar a latência na resolução de nomes de serviço e na conexão inicial com o banco de dados Oracle.
- "<= 3 ms": Uso de "ping" via comando "ping HOSTNAME";
- A latência durante as operações de banco de dados entre ambiente de instalação dos componentes/serviços do TOTVS Agro Connector Client e as bases de dados deve ser inferior aos valores recomendados
- "<= 1 ms": Para execução de consultas simples, como exemplo:
- Oracle: "SELECT 1 FROM DUAL"
- SQL Server: "SELECT 1 AS Result;"
- "<= 1 ms": Para execução de consultas simples, como exemplo:
Demais soluções/ferramentas
As demais soluções (produtos) e/ou ferramentas, que fazem uso do TOTVS Agro Connector (e demais componentes) devem ser estimados/orientados pelos times de produto/atendimento. Esta página apresenta as recomendações/orientações em relação ao TOTVS Agro Connector, plataforma de integração e comunicação entre aplicações TOTVS Agro.
Requisitos recomendados
Esta página apresenta os requisitos recomendados para uma instalação e configuração padrões.
⚠️ Como TOTVS Agro Connector é uma plataforma de integração e comunicação entre aplicações TOTVS Agro, tais requisitos podem ser revistos e sinalizados aos clientes, a qualquer momento, pois seu uso (TOTVS Agro Connector) tem relação com volume de dados e poder computacional necessário para envio e recebimento de dados de forma performática entre demais soluções/ferramentas TOTVS Agro.
Infraestrutura e ambientes
Recomenda-se a separação entre ambiente/servidor de integração (TOTVS Agro Connector) - com seus componentes (por exemplo, PostgreSQL + RabbitMQ + Redis) e ambientes/servidores das demais soluções/ferramentas TOTVS Agro que farão uso da plataforma de integração.
Por exemplo:
- 1 ambiente/servidor para TOTVS Agro Connector + 1 ambiente/servidor para TOTVS Agro Bioenergia / TOTVS Agro Multicultivo (avaliar requisitos recomendados separados); ou
- 1 ambiente/servidor para TOTVS Agro Connector + 1 ambiente/servidor para TOTVS Agro Minha Borracharia (avaliar requisitos recomendados separados);
* Em situações específicas (desde que alinhado com time TOTVS Agro), tais ambientes/servidores podem ser unificados, desde que os requisitos separados sejam atendidos em sua totalidade. Importante mencionar que a separação física/lógica destes ambientes/servidores otimiza aspectos de análise, investigação, disponibilidade e otimização de configurações.
Requisitos de infraestrutura e ambiente
- Banco de dados (PostgreSQL, Oracle, SQL Server ou MySQL)
- Acesso à internet (com acesso liberado ao endereço https://tcserver-supplyagro.totvs.app/)
- O produto (TOTVS Agro Multicultivo ou TOTVS Agro Bioenergia) precisará acessar um serviço do TOTVS Agro Connector Client (endpoint GET /api/v1/clientMetadata), portanto, o acesso ao serviço deverá estar liberado
- Comunicação entre os ambientes do TOTVS Agro Connector Client e bases de dados de outros produtos (por exemplo, TOTVS Agro Bioenergia ou TOTVS Agro Multicultivo, com compatibilidade com Oracle, SQL Server, PostgreSQL ou MySQL);
- Caso exista bloqueio/restrição na rede, baseado em whitelist, adicionar os hosts na máquina em que o TOTVS Agro Connector Client será instalado:
Apoios para instalação (Framework)
Para solicitar a instalação de uma instância do TOTVS Agro Connector Client ou algum apoio necessário via Framework, seguir as orientações:
- Por meio do projeto DAGROFRAME no Jira, abrir uma issue do tipo APOIO com as seguintes informações:
- Preencher os campos:
> Summary: "Squad XYZ: Apoio TOTVS Agro Connector: Cliente XYZ";
> Epic Link: "Demandas Squads Inovação e Corporativo";
> Description: Descrever os dados de contato (squad/cliente), informações do ambiente e de acesso para instalação/configuração;
> Component/s: DAGROFRAME;
> Classe de Serviço: Padrão ou Prioritária;
> Produto: "PLATAFORMA";
* A issue de apoio deve ser aberta com antecedência de 5 dias, para considerar o planejamento da squad de Framework;
* Informações solicitadas para preenchimento do campo Description:
- Informações de conexão com o banco de dados para o TOTVS Agro Connector Client
- Informações de conexão com o banco de dados do produto (TOTVS Agro Bioenergia, TOTVS Agro Multicultivo, etc.)
- Dados para acessar o servidor onde será instalado (SSH, AnyDesk, etc.)
- Contato e horário de disponibilidade para o time realizar a instalação e configuração
Para o time de suporte: Ao chegar um chamado com estes dados, entrar em contato com o time de Framework.
Para instalações utilizando Windows Service
- Para realizar a instalação via Windows Service, utilizar a página TOTVS Agro Connector - Windows Service
- O endereço http://engenharia.agro.totvs.com.br:8080/ deverá estar liberado
Para instalações utilizando Linux
- O roteiro de instalação e configuração em Linux pode ser consultado neste material.
Para o time de suporte: Caso a instalação seja feita no Cloud da TOTVS(produto TOTVS Agro Multicultivo), enviar um documento com base neste template junto com o chamado (informações poderão ser obtidas junto ao time Framework).