Histórico da Página
...
Conteúdo
- O que é TOTVS Connector
- TOTVS Connector ServerTOTVS Connector Client
- Requisitos Mínimos de Instalação
- Requisitos de Ambiente / Infraestrutura
- TOTVS Connector Server
- 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)
- TOTVS Connector ServerTOTVS Connector Client
- Integração com aplicações TOTVS e de terceirosIntroduçã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)
- Entidades (Cadastros ?)
- Integração com TOTVS Carol (Cadastros ?)Carol
- Introdução
- 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)Entidade EventDataCarolRequest
- Como enviar?(rabbit + endpoint)
- Observações importantes
- Tempo de envio das mensagens (explciar que pode demorar por conta da conexão / processamento)de dados
01. O que é TOTVS Connector?
...
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 / Nuvem Privada (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.
...
É 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 / Nuvem Privada (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.
...
O TOTVS Connector Server é responsável por receber todos os dados que serão integrados, seja dados de aplicações On Premise / Nuvem Privada (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.
Diagrama da arquitetura do TOTVS Connector
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 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 do 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 que será utilizado para enviar os dados. 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
...
ou não. As aplicações SaaS (Cloud) também deve enviar esse token nas mensagens para o TOTVS Connector Server.
SchemaDefitinion
O SchemaDefinition é uma estrutura de dados que possui as informações da tabela de origem do dado e como ele deve ser convertido para ser enviado ao TOTVS Connector Server. A gestão do SchemaDefinition é realizada apenas no TOTVS Connector Server. Uma vez publicado o SchemaDefinition, gerará uma nova versão do SchemaDefinition. Assim, todos os TOTVS Connector Client irão sincronizar os novos SchemaDefinition.
A estrutura do SchemaDefinition é representada pelo JSON abaixo:
Informações | ||
---|---|---|
| ||
|
Segue abaixo um exemplo de SchemaDefinition:
Informações | ||
---|---|---|
| ||
|
TOTVS Connector Client
Product Connection
A entidade ProductConnection representa as informações da conexão do banco de dados do produto, que será integrado. O TOTVS Connector Client suporta conexão com vários bancos de dados ao mesmo tempo, trabalhando com múltiplos ProductConnection. Cada banco de dados deve possuir uma tabela chamada TCC_PRODUCT_METADATA, onde deve existir um registro com o nome do produto (NAME) e a versão (VERSION). Essas informações serão necessárias para relacionar o ProductConnection com o SchemaDefinition.
A estrutura da tabela TCC_PRODUCT_METADATA deve possuir duas colunas de texto: NAME e VERSION.
Os bancos de dados suportados são Oracle (11G e 12C), PostgreSQL e Microsoft SQL Server.
Exemplo de ProductConnection com o banco de dados SQL Server:
Informações | ||
---|---|---|
| ||
|
Exemplo de um ProductConnection com o banco de dados Oracle 11G:
Informações | ||
---|---|---|
| ||
|
Exemplo de ProductConnection com o banco de dados PostgreSQL:
Informações | ||
---|---|---|
| ||
|
Product Connection Schema
Após a criação de um Product Connection, é necessário definir quais schemas serão integrados.
Essa definição é feita pelo Product Connection Schema, nele estaremos relacionando um Product Connection e um Schema Definition.
Outra informação importante é se esse relacionamento irá habilitar o modo standalone, onde iremos explicar no tópico Modo Standalone .
Após realizar o relacionamento, o TOTVS Connector Client irá iniciar o monitoramento das tabelas definidas no Schema Definition, e assim que houver qualquer alteração em qualquer registro, o TOTVS Connector Client será notificado e irá processar esse dado e enviar para o TOTVS Connector Server.
Modo Standalone
External Event
Mensagens
Fluxo de Mensagens
...
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.
...
A entidade EventDataCarolRequest será explicada no tópico a seguir.
Envio de dados
Fluxo
O diagrama a seguir apresenta o fluxo de dados para enviar à TOTVS Carol:
Diagrama mostrando a mensagem saindo do produto e chegando na totvs carol: produto (interno e externo) → tc-server → totvs carol
Entidade EventDataCarolRequest
...
Informações | ||
---|---|---|
| ||
{ |
04. Observações
Tempo
...
de envio de dados
Como as aplicações estão em servidores diferentes, TOTVS Connector Client no On Premise / Nuvem Privada (Private Cloud), TOTVS Connector Server na nuvem e as aplicações de terceiros podendo estar tanto na nuvem quanto On Premise, é possível acontecer atrasos e lentidões no envio dos dados, devido à conexão utilizada.