Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O TOTVS Connector é uma ferramenta/plataforma que possibilita a integração entre softwares e plataformas (TOTVS e não-TOTVS), independente da forma de distribuição de tal solução. Desta forma, utiliza-se o TOTVS Connector para integrar dados, por exemplo, entre aplicações OnPremise, Cloud Privada/Pública e plataforma SaaS (TOTVS Apps).

...

É o componente responsável por ler os dados das aplicações OnPremise, sejam aplicações TOTVS ou de terceiros. A instalação é realizada em uma máquina que de forma a conectaconectar-se com o banco de dados do produto OnPremise/Nuvem Privada (Private Cloud), podendo este ser Oracle, Microsoft SQL Server e PostgreSQL. O TOTVS Connector Client precisa de uma instância do PostgreSQL e, dependendo da configuração standalone, mencionado no tópico 2 (Integração com produtos TOTVS e externos), uma instância do RabbitMQ (para comunicação via mensageria AMQP).

...

  • Sugestão do sistema operacional: Debian ou CentOS GNU/Linux 10 (buster) ou distribuição Linux 64 bits;

  • Memória RAM: 4 GB RAM;

  • Processador: Quad Core 1.8 GHZ ou superior;

  • Espaço em Disco: Espaço em disco de 40 GB RAM;

  • Ferramentas/Recursos principais: Docker (containers Linux) e Portainer (opcional, para monitoramento/gestão de ambientes baseados em Docker/containers);

...

A entidade Client Environment representa o ambiente do cliente e é necessário realizar seu cadastro para o correto funcionamento do TOTVS Connector Client, assim como para a integração da TOTVS Carol. Ao cadastrar um novo ambiente (Client Environment), a entidade gerará um token para este ambiente. O token gerado representa a identificação do cliente/ambiente que será utilizado para enviar os dados. Além disso, o token deve ser informado na instalação do TOTVS Connector Client, pois a plataforma TOTVS Connector verifica se o token é válido ou não. As aplicações Cloud/SaaS também deve devem enviar esse token nas mensagens para o TOTVS Connector Server.

...

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ões com vários bancos de dados ao mesmo tempo, possibilitando que uma mesma instalação de TOTVS Connector Client monitore e integre dados a partir de múltiplos ProductConnection (por exemplo, Oracle, Microsoft SQL Server e PostgreSQL). Cada banco de dados deve possuir uma tabela chamada TCC_PRODUCT_METADATA, responsável pelo controle de nome do produto (NAME) e a versão do produto que está sendo monitorado/integrado (VERSION). Estas informações são necessárias para relacionar as entidades ProductConnection e SchemaDefinition.

...

Na representação seguinte, é apresentado o diagrama do Modo Standalone:


Image RemovedImage Added


External Event

...

Para enviar dados à TOTVS Carol, torna-se necessária a realização da autenticação do usuário, podendo esta ser feita de duas maneiras: pelo accessToken ou pelo connectorToken. Para o TOTVS Connector Server, a autenticação será feita pelo connectorToken. Portanto, gera-se o connectorToken na plataforma Carol e, após geração, o connectorToken é utilizado no cadastro da entidade CarolConnector.

Entidades

Client Envrionment

...

  • O atributo "organizationSubdomain" corresponde ao atributo "orgDomain" da TOTVS Carol;

  • O atributo "subdomain" corresponde ao atributo "subdomain" da TOTVS Carol, que se refere ao ambiente (tenant) que está se autenticando;

  • Os atributos "username" e "password" são informações do seu login na TOTVS Carol;


Informações
titleEstrutura de exemplo da entidade CarolUser
{
    "organizationSubdomain": "ambienteteste",
    "password": "senha_carol",
    "subdomain": "clienteteste",
    "username": "usuario_carol"
}

...

O Connector Token é diferente do token gerado na entidade Client Environment. O Connector Token é gerado na TOTVS Carol para um connector Connector e é utilizado na identificação do usuário na TOTVS Carol para um mesmo Connector. Diferentes Connectors possuem diferentes Connector Token para o mesmo usuário. Por fim, o token da entidade Client Environment é utilizado para identificação no TOTVS Connector.

...

  • O atributo connectorId é o id do connector na TOTVS Carol;

  • O atributo connectorToken é o identificador gerado para o connectorId na TOTVS Carol;


Informações
titleEstrutura de exmeplo da entidade CarolConnector
{
  "connectorId": "1257404c3f7c7a1547c00f0c833e357b",
  "connectorToken": "aa3ee9f21fc09602580e0357125e0d02"
}

...

O diagrama a seguir apresenta o fluxo de dados para enviar à TOTVS Carol:



Entidade EventDataCarolRequest

...

  • O atributo header é a classe TOTVSHeader, também da biblioteca TJF, que será enviada no header da mensagem;
    • O atributo type é o nome da StagingTable a ser enviada;
    • O atributo generatedOn é a data que está enviado os dados;
    • O atributo locale é a localização utilizada no cliente;
  • O Atributo content é o tipo genérico T. No nosso caso, será a entidade EventDataCarolRequest;

...