Histórico da Página
CONTENT
- O que é TOTVS Connector
- TOTVS Connector Server
- TOTVS Connector Client
- Requisitos Mínimos de Instalação
- Requisitos de Ambiente / Infraestrutura
- Diagrama da arquitetura do TOTVS Connector (Tentar generalizar para atender o da Carol, se não, criar 2 diagramas e colocar nos respectivos tópicos abaixo)
- Integração com aplicações TOTVS e de terceiros
- Introdução (explicar um pouco mais sobre as integrações de produtos internos e externos, pensar em um diagrama para ilustrar)
- Entidades (Cadastros ?)
- TOTVS Connector Server
- Client Environment
- SchemaDefinition
- TOTVS Connector Client
- Product Connection (citar que o usuário do banco cadastrado no product connection, precisa de permissão para inserir, alterar e deletar, criar e alterar triggers e tabelas)
- Product Connection Schema (citar que irá criar triggers no momento desse cadastro)
- Modo Standalone
- External Event
- TOTVS Connector Server
- Mensagens
- Fluxo das mensagens
- Estrutura
- Como enviar? (rabbit + api do External Event)
- Integração com TOTVS Carol (Cadastros ?)
- Entidades (explicar um pouco mais sobre a integração com a Carol e pensar em um diagrama para ilustrar)
- Autenticação
- Entidades
- Client Environment
- CarolUser
- CarolConnector
- CarolStagingTable
- EventDataCarol
- Mensagens
- Fluxo
- Estrutura das mensagens (EventDataCarolRequest)
- Como enviar? (rabbit + endpoint)
- Observações importantes
- Tempo de envio das mensagens (explciar que pode demorar por conta da conexão / processamento)
01. O que é TOTVS Connector?
O TOTVS Connector é uma ferramenta que permite a integração entre softwares, não importando a forma de distribuição do software, ou seja, integra dados entre aplicações Cloud e aplicações On Premise e vice-versa.
Como assim?
Por meio de dois componentes dispostos em ambientes diferentes, é possível uma aplicação On Premise ficar sincronizada com um aplicação em Cloud. Um desses componentes é o TOTVS Connector Client, que é instalado no ambiente On Premise / Private Cloud. O outro componente é o TOTVS Connector Server, gerenciado pela TOTVS, é responsável de receber todo fluxo de dados. Portanto, o cliente deverá instalar e configurar apenas o TOTVS Connector Client.
TOTVS Connector Client
É a parte responsável por ler os dados das aplicações On Premises, seja aplicações TOTVS ou de terceiros. Ele é instalado em uma máquina que possa se conectar com o banco de dados do produto On Premise / Private Cloud. O TOTVS Connector Client precisa de uma instância do PostgreSQL e, dependendo da configuração standalone (explicação no tópico 2. Integração com produtos TOTVS e externos), uma instância do RabbitMQ.
Requisitos Mínimos de Instalação
Caso a sua máquina não atinja os requisitos mínimos abaixo, entre em contato conosco para avaliar outras possibilidades:
Sugestão do sistema operacional: Debian ou CentOS GNU/Linux 10 (buster) ou distribuição Linux 64 bits.
Memória RAM: 4GB.
Processador: Quad Core 1.8 GHZ ou superior.
Espaço em Disco: Espaço em disco de 40GB.
Ferramentas/Recursos principais: Docker (containers Linux) e Portainer (opcional, para monitoramento/gestão de ambientes baseados em Docker/containers).
Requisitos de Ambiente / Infraestrutura
- Comunicação entre os ambientes do TOTVS Connector Client e bases de dados de outros produtos (por exemplo, TOTVS Agro Bioenergia ou TOTVS Agro Multicultivo, com compatibilidade com Oracle ou SQL Server, e PostgreSQL).
- Caso exista bloqueio/restrição na rede, baseado em whitelist, adicionar os hosts na máquina em que o TOTVS Connector Client será instalado:
TOTVS Connector Server
O TOTVS Connector Server é responsável por receber todos os dados que serão integrados, seja dados de aplicações On Premise / Private Cloud, aplicações SaaS e até aplicações de terceiros. Ele fica em um ambiente exposto na nuvem, já que todos os TOTVS Connector Client devem ser capazes de acessá-lo via requisição HTTP. A imagem a seguir representa a arquitetura do TOTVS Connector:
02. Integração com aplicações TOTVS e de terceiros
Introdução
Entidades
Este tópico irá apresentar as entidades de cadastros utilizados no TOTVS Connector Server e TOTVS Connector Client.
TOTVS Connector Server
Client Environment
A entidade Client Environment representa o ambiente no cliente e é necessário realizar seu cadastro para o funcionamento do TOTVS Connector Client e para a integração da TOTVS Carol. Ao cadastrar um ambiente (Client Environment), a entidade irá gerar um token para o ambiente. Esse token é a identificação do cliente, ou seja, todo dado trafegado deve possuir um token do cliente. Além disso, o token deve ser informado na instalação do TOTVS Connector Client, pois ele verifica se o token é válido ou não. As aplicações SaaS (Cloud) também deve enviar esse token nas mensagens para o TOTVS Connector Server.
SchemaDefitinion
TOTVS Connector Client
Product Connection
Product Connection Schema
Modo Standalone
External Event
Mensagens
Fluxo de Mensagens
Estrutura
Como enviar?
03. Integração com TOTVS Carol
Introdução
A TOTVS Carol é uma plataforma de dados com inteligência artificial, podendo aplicar todas as funcionalidades do MDM (Master Data Management, ou Gestão de Dados Mestre, em Português), como por exemplo: capacidade de receber dados de qualquer fonte, garantir a qualidade dos dados e centralizar os dados de sua aplicação. Além disso, também possui a capacidade de desenvolver aplicativos e implantá-los na plataforma e utilizar a Assistente Carol. Para saber mais sobre a plataforma, você pode acessar a sua documentação.
O TOTVS Connector possui integração com a TOTVS Carol, podendo levar seus dados de aplicações On Premise ou SaaS para dentro da plataforma, podendo aumentar a qualidade de seus dados e gerar gráficos a partir deles. Nesse tópico, será explicado como configurar o TOTVS Connector Server para enviar dados à TOTVS Carol.
Autenticação
Para enviar dados à TOTVS Carol é preciso realizar a autenticação do usuário, que pode ser feita de duas formas: pelo accessToken ou pelo connectorToken. Para o TOTVS Connector Server, a autenticação será feita pelo connectorToken. Portanto, é preciso gerar o connectorToken na plataforma. Após gerado o connectorToken, será utilizado no cadastro da entidade CarolConnector, explicado nos tópicos a seguir.
Entidades
Client Envrionment
Como já explicado no tópico 2. Integrações com aplicações TOTVS e terceiros, a entidade Client Environment representa o ambiente, e o token gerado por ele, representa a identificação do cliente. Assim, o token é utilizado para identificar as mensagens do cliente e direcionar para a TOTVS Carol.
Carol User
O CarolUser são informações de login da plataforma Carol que deve ser cadastrada no TOTVS Connector Server.
Informações | ||||
---|---|---|---|---|
| ||||
{ "organizationSubdomain": "supplytest", "password": "senha", "subdomain": "supplyassistant", "username": "usuario" } |
Atributos
O atributo "organizationSubdomain" corresponde ao atributo "orgDomain" da plataforma Carol;
O atributo "subdomain" corresponde ao atributo "subdomain" da plataforma Carol, que se refere ao ambiente (tenant) que está se autenticando;
Os atributos "username" e "password" são informações do seu login na plataforma Carol;