...

1. O que é TOTVS Connector
   1. TOTVS Connector Server
   2. TOTVS Connector Client
      1. Requisitos Mínimos de Instalação
      2. Requisitos de Ambiente / Infraestrutura (Citar as permissões do usuário do banco de dados e as liberações whitelist das urls)
   3. 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)
2. Integração com aplicações TOTVS e de terceiros
   1. Introdução (explicar um pouco mais sobre as integrações de produtos internos e externos, pensar em um diagrama para ilustrar)
   2. Entidades (Cadastros ?)
      1. TOTVS Connector Server
         1. Client Environment 
         2. SchemaDefinition
      2. TOTVS Connector Client
         1. 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)
         2. Product Connection Schema (citar que irá criar triggers no momento desse cadastro) 
         3. Modo Standalone
         4. External Event
   3. Mensagens
      1. Fluxo das mensagens
      2. Estrutura
      3. Como enviar? (rabbit + api do External Event)
3. Integração com TOTVS Carol (Cadastros ?)
   1. Entidades (explicar um pouco mais sobre a integração com a Carol e pensar em um diagrama para ilustrar)
   2. Autenticação
   3. Entidades
      1. Client Environment
      2. CarolUser
      3. CarolConnector
      4. CarolStagingTable
      5. EventDataCarol
   4. Mensagens
      1. Fluxo
      2. Estrutura das mensagens (EventDataCarolRequest)
      3. Como enviar? (rabbit + endpoint)
4. Observações importantes
   1. Tempo de envio das mensagens (explciar que pode demorar por conta da conexão / processamento)

...

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

...

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. 

Exemplo de CarolUser:

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;

Carol Connector

Carol Staging Table

...