01. DADOS GERAIS
| Produto: | TOTVS Logística Recintos Aduaneiros
|
|---|---|
| Linha de Produto: | Linha Logix |
| Segmento: | Logística |
| Módulo: | Serviço de Integração TPD - Recintos Aduaneiros |
| Função: | Serviço de Integração TPD - Recintos Aduaneiros |
| Ticket: | |
| Requisito/Story/Issue (informe o requisito relacionado) : |
02. SITUAÇÃO/REQUISITO
Para atendimento à demanda legal gerada pela Lei Geral de Proteção de Dados - LGPD - (Lei 13.709/2018), a TOTVS desenvolveu o sistema de gerenciamento de dados pessoais e sensíveis TOTVS Privacidade de Dados sobre a plataforma TOTVS Apps. Por tratar-se de um produto independente de todos os outros produtos da empresa, este opera em uma estrutura SaaS igualmente independente, não tendo nenhuma ligação direta com os demais produtos que venham a ser utilizados pelos clientes TOTVS. Portanto, para que os clientes possam realizar as operações previstas na LGPD, é necessário integrar cada um dos produtos TOTVS ao TOTVS Privacidade de Dados.
Para atendimento desta exigência, a equipe TOTVS Recintos Aduaneiros desenvolveu uma solução baseada na integração direta com o ambiente TOTVS Privacidade de Dados, a qual foi dividida em duas partes: um serviço de integração desenvolvido para a plataforma Microsoft Windows e uma Bridge API desenvolvida sobre NodeJS e distribuída através de imagem para o sistema de containerização Docker, aplicável em qualquer sistema operacional que suporte a plataforma. Tanto para uma quanto a outra, o processo de instalação é simples, não demandando nenhuma necessidade especial.
03. SOLUÇÃO
Como a solução aplicada é dividida em duas partes, sendo uma aplicação desenvolvida sobre Node.JS e distribuída em uma imagem Docker, e a outra desenvolvida como serviço para o sistema Microsoft Windows, para um perfeito processo de integração, ambas as partes devem ser implantadas e configuradas em sequência, sendo a aplicação Node.JS implantada em primeiro lugar.
Para tanto, as soluções dependem de requisitos a serem atendidos anteriormente e que podem ser vistos a seguir. É importante salientar que, para um perfeito processo de integração, todos os requisitos adiante devem ser atendidos antes da implantação, garantindo o perfeito funcionamento da solução. Os pré-requisitos são divididos em duas partes, uma para a estrutura containerizada com Docker, e outra para o serviço a ser instalado em um servidor Microsoft Windows.
Já o processo de implantação, uma vez que todos os requisitos sejam atendidos, é simples e rápido. Se seguido conforme as instruções constantes neste artigo, a possibilidade de falha no processo de integração é praticamente nula.
- Servidor físico ou virtual com sistema operacional que suporte a implantação do Docker Desktop (Linux/Microsoft Windows/Mac);
- Docker Desktop versão 4.5 ou superior (recomendada 4.7.1) e;
- 1GB de espaço em disco.
- Sistema operacional Microsoft Windows Server 2012 ou superior e;
- 25MB de espaço em disco.
Após a instalação do sistema Docker Desktop em um servidor que possa abrigá-lo, toda a estrutura para a operação do Docker estará disponível. Sendo assim, todas as operações podem ser feitas através de linhas de comando aceitas em cada sistema operacional. Para exemplificarmos a instalação, aqui, da imagem Docker da aplicação desenvolvida sobre NodeJS, demonstraremos tais comandos em ambientes Microsoft Windows, como administrador do sistema, e Linux que utilizem a aplicação sudo:
Microsoft Windows:
C:\Windows\System32> docker pull docker.totvs.io/dlogportos/sara-sgdp-app
Linux:
$ sudo docker pull docker.totvs.io/dlogportos/sara-sgdp-app
Abaixo, uma exemplificação da aquisição da imagem Docker em um sistema Microsoft Windows utilizando o Windows Power Shell.
Para a instalação do serviço de integração em um servidor Microsoft Windows você deve adquirir o aplicativo TPDService (TPDService.exe). O link para download deve ser fornecido pela equipe de atendimento ao cliente TOTVS.
Após sua aquisição, basta executá-lo para efetuar a instalação do serviço de integração. Mas, antes de começar, uma informação: o serviço de integração é compatível apenas com sistemas 64 bits.
Abaixo temos um vídeo com a operação do aplicativo instalador.
TOTVS Privacidade de Dados - Instalação do serviço de integração.mp4
Após a aquisição da imagem Docker, nenhuma configuração é necessária para que a aplicação possa ser inicializada.
Após o término da instalação do serviço de integração, quando selecionada a caixa de seleção indicando que o assistente de configuração seja executado, este será iniciado após o botão Concluir ser acionado. Sendo assim, a configuração deve seguir os passos indicados pelo assistente.
Algumas informações já vêm inicialmente preenchidas por serem valores padrão utilizados pelo ecossistema TOTVS Recintos Aduaneiros, mas outras precisam ser preenchidas manualmente. Abaixo vemos uma lista das configurações e a que se destinam.
| Categoria | Configuração | Função específica | Valor padrão | Padrão do valor a ser inserido |
|---|---|---|---|---|
| Banco de Dados | Servidor\Instância | Indicação de localização do servidor Microsoft SQL Server | Nenhum | NomeDoServidor\NomeDaInstância |
| Banco de Dados | Porta | Porta padrão de comunicação do servidor Microsoft SQL Server | 1433 | 1~65535 |
| Banco de Dados | Banco de dados | Nome do banco de dados usado pelo ecossistema TOTVS Recintos Aduaneiros | sara_db | Nenhum |
| Banco de Dados | Conjunto de caracteres | Conjunto de caracteres utilizado pelo servidor Microsoft SQL Server | SQL_Latin1_General_CP1_CI_AS | Nenhum |
| Banco de Dados | Nome de usuário | Nome do usuário de banco de dados usado pelo ecossistema TOTVS Recintos Aduaneiros | sa | Nenhum |
| Banco de Dados | Senha | Senha utilizada pelo usuário de banco de dados usado pelo ecossistema TOTVS Recintos Aduaneiros | Nenhum | Nenhum |
| Banco de Dados | Confirmação da senha | Confirmação da senha utilizada no parâmetro anterior | Nenhum | Nenhum |
| Logs | Diretório para logs | Diretório onde os logs de erro do servidor serão armazenados | C:\Temp\TOTVS\Log\Privacidade de Dados | Windows Path |
| Integração | URL de integração | URL para acesso à Bridge API obtida através da imagem Docker | Nenhum | URL |
| Integração | Intervalo | Intervalo, em horas, da execução dos processos de integração | 1 | 1~24 |
| Tenant | Tenant ID | Valor de identificação do cliente TOTVS junto à plataforma TOTVS Apps | Nenhum | UUID |
| Client | Client ID | Valor de identificação do client junto à plataforma TOTVS Apps | Nenhum | MD5 hash |
| Client | Client Secret | Valor de verificação da identidade do client junto à plataforma TOTVS Apps | Nenhum | MD5 hash |
Para exemplificação, temos abaixo um vídeo de demonstração do processo de configuração. É importante notar que as informações de configurações já foram anteriormente preenchidas, mas que o assistente só permite que se avance no processo quando a informação do passo a ser configurado obedecer o padrão esperado.
TOTVS Privacidade de Dados - Configuração do serviço de integração.mp4
A inicialização da Bridge API pode ser executada de duas maneiras: por linha de comando ou através do Docker Desktop.
Abaixo temos a inicialização através da linha de comando. Assim como na aquisição da imagem, demonstraremos os comando em Microsoft Windows e Linux e um vídeo exemplificando a inicialização em um ambiente Microsoft Windows pelo Windows Power Shell.
Microsoft Windows:
C:\Windows\System32> docker run -p 3000:3000 -d docker.totvs.io/dlogportos/sara-sgdp-app
Linux:
$ sudo docker run -p 3000:3000 -d docker.totvs.io/dlogportos/sara-sgdp-app
TOTVS Privacidade de Dados - Inicializando a imagem Docker por linha de comando.mp4
Abaixo temos a inicialização através do Docker Desktop.
TOTVS Privacidade de Dados - Inicializando a imagem Docker pelo Docker Desktop.mp4
Após concluir a instalação e inicializar a imagem Docker, chegou a hora de inicializar o serviço de integração. Para tanto, acesse o gestor de serviços do servidor Microsoft Windows, localize o serviço de integração e inicialize-o como no vídeo abaixo.
TOTVS Privacidade de Dados - Inicializando o serviço de integração.mp4
04. DEMAIS INFORMAÇÕES
Para uma perfeita integração com o sistema TOTVS Recintos Aduaneiros, este deve estar em sua versão 12.1.2205 ou superior, uma vez que esta versão está preparada para a integração com o sistema TOTVS Privacidade de Dados. Em versões anteriores a esta, a tentativa de integração ocasionará falhas no processo de integração que podem paralisar o serviço de integração e, na pior das hipóteses, paralisar o servidor onde ele esteja abrigado.
05. ASSUNTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas