Linha Logix

Páginas filhas
  • Guia de implantação Logix X TPD

INTEGRAÇÃO LOGIX X TPD (TOTVS Privacidade de Dados)




Introdução

A proteção dos dados pessoais que circulam nas empresas se tornou prioridade com a criação da Lei Geral de Proteção de Dados, dessa forma a Lei define o que são dados pessoais e informa que alguns deles estão sujeitos a cuidados ainda mais específicos.

O produto Logix disponibiliza recursos que apoiam seus clientes nas demandas oriundas da  LGPD (Lei Geral de Proteção de Dados), para que assim possam entrar em conformidade com a Lei. Para tanto, o Logix precisa utilizar a ferramenta TPD (Totvs Privacidade de Dados), pois ela complementa os recursos disponibilizados nas soluções TOTVS no atendimento das demandas dos titulares de dados pessoais pelos clientes.


Sistemas Envolvidos

A integração envolve uma tríade, composta pelas tecnologias a seguir:


  • ERP Logix: Produto que mantém os dados que são do tipo pessoais/sensíveis;
  • Smart Link: Tecnologia responsável por realizar a comunicação entre o ERP e o TPD;
  • TPD: Ferramenta disponível em ambiente de Nuvem que gerencia a recuperação das informações relacionadas ao controle dos dados no ERP.




O Smart Link é executado em duas versões:

  • Versão Client que se comunica com o produto Logix (On-premise)
  • Versão Server que se comunica com o TPD, ambos disponíveis em ambiente de Nuvem (Cloud).


Pré-Requisitos

Para que seja possível integrar o TPD ao ERP Logix, é preciso cumprir as exigências a seguir:


    • Possuir acesso ao portal TPD onde se faz necessário a disponibilidade de um TENANT de acesso ao produto Logix.

            Para entender melhor o procedimento solicitado, acesse a documentação Primeiros Passos - TOTVS Privacidade de Dados e também a configuração do mesmo Configurando o produto.


    • Estar na versão do Logix que suporte a integração com o TPD.

            Pacote LOGIX 12.1.2209, que já contempla o acesso as opções: Consulta de Dados,  Anonimização de Dados  e  Registro de Tratamento de Dados.


    • Obter pacote do Smart Link Client Logix.

           Disponível no pacote de atualização do produto Logix na pasta LIBTOOLS/SMARTLINK com o nome de smart-link-client.zip



Escopo

O produto Logix se limita a dar suporte apenas para suas próprias funcionalidades.

Entretanto, as configurações do Smart Link versão Client é realizada pelo produto Logix.

Dessa forma, o suporte as ferramentas TPD (TOTVS Privacidade de Dados) e Smart Link (versão Server) estão sob a gerência de suas respectivas equipes de desenvolvimento.


O que a equipe de produto Logix FAZ?
  • Correção de toda e qualquer inconsistência encontrada em alguma funcionalidade nos programas LGPD do Logix;
  • Melhorias referentes ao LGPD no logix, serão analisadas e verificado o impacto e relevância, antes de serem implementadas;
  • Configurações de Servidor de aplicação do Logix;
  • Configurações em parâmetros nos programas do Logix;
  • Configurações no arquivo no formato YAML utilizado pela ferramenta Smart Link Client no servidor de hospedagem.
O que ela NÃO FAZ?
  • Apoio sobre assuntos relacionados à ferramenta TPD;
  • Configurações na ferramenta TPD;
  • Manutenções e melhorias na ferramenta TPD;
  • Configurações na ferramenta Smart Link Server;
  • Manutenções e melhorias na ferramenta Smart Link Server.



Guia de configurações no produto

 Tendo em vista que os pré-requisitos supracitados foram cumpridos e com base na versão de suporte do Logix, temos a seguir:


Passo 1 - Processamento de conversores e importação de atualizações Metadado

Na aplicação do pacote da versão pré-requisito, com suporte ao LGPD, automaticamente já estão inclusos os conversores necessários para criação das tabelas LOG_PRIVATE_xxx e JOB_xxx, bem como os conversores de parâmetros e os respectivos arquivos com extensão XML para atualização do metadado das tabelas e formulários envolvidos:

  • Formulários metadado relacionados diretamente ao gerenciamento de dados LGPD mantidos no Logix:
    • LOG10000 (Dados Protegidos)
    • LOG10001 (Exportação de Dados Protegidos)
    • LOG10002 (Importação de Dados Protegidos)
    • LOG10003 (Mapeamento de Campos por Vínculo do Titular)
    • LOG10004 (Mapeamento de Tabelas por Vínculo do Titular)
  • Processamento de conversores de parâmetros e de criação/alteração de tabelas no Banco de Dados.

Lista de conversores necessários:

CONVERSOR DE TABELA 

DESCRIÇÃO

frw00022.cnv 
  • Criação das tabelas lgpd_attribute e lgpd_process_attribute;
men00136.cnv
  • Renomeação das tabelas lgpd_attribute e lgpd_process_attribute para log_private_attribute e log_private_process_attribute;
  • Criação da tabela log_private_classif_attribute;
men00137.cnv
  • Alteração da tabela log_private_process_attribute;
  • Criação da tabela log_private_process_audit;
men00139.cnv
  • Alteração das tabelas log_private_attribute, log_private_classif_attribute e log_private_process_attribute;
men00141.cnv
  • Criação das tabelas log_private_allows_anonymize, log_private_mapping_attribute;
  • Alteração das tabelas log_private_classif_attribute e log_private_attribute;
men00142.cnv
  • Criação das tabelas log_private_mapping e log_private_mapping_table;
  • Exclusão das tabelas log_private_allows_anonymize e log_private_mapping_attribute;
men00144.cnv
  • Criação das tabelas log_private_data_audit e log_private_attribute_audit;
men00145.cnv
  • Alteração do tamanho da coluna val_parametro da tabela log_val_parametro para char(100) para atender o cadastramento de parâmetros LGPD na comunicação com o Smartlink Client (parâmetros com prefixo tpd_);
men00146.cnv
  • Criação das tabelas log_private_job_main, log_private_job_main_param, log_private_job_error, log_private_job_logs e log_private_data_audit;
men00147.cnv
  • Alteração da tabela log_private_process_audit;
job00003.cnv
  • Alteração das tabelas job_gatilho_tarefa, job_registro_execucao, job_gatilho_tarefa_parametros, job_execucao_parametros e job_gatilho.
frw00023.cnv
  • Criação de parâmetros relacionados a integração LGPD Logix X TPD (Totvs Privacidade de Dados).
    (informação) Localização dos parâmetros:    Administração Logix >> Controle Geral >> Smart Link - TPD
CONVERSOR DE PARÂMETRO

DESCRIÇÃO

frw00023.cnv
  • Criação de parâmetros relacionados a integração LGPD Logix X TPD (Totvs Privacidade de Dados).
    (informação) Localização dos parâmetros no LOG00086 após aplicados no Logix:    Administração Logix >> Controle Geral >> Smart Link - TPD

LEMBRETE

(seleção) Conversores de tabelas devem ser processados via LOG6000 (Gerenciador de conversores de layouts de tabelas)

(seleção) Conversores de parâmetros devem ser processados via LOG00086 (Administração de Parâmetros Logix >> Processamento Conversores)



Passo 2 - Permissão de acesso aos parâmetros

O processamento de conversores de parâmetros, no geral, já é realizado de forma automática na atualização de pacote Logix, via ferramenta de Console de Atualização Logix. 

Não conhece ainda a ferramenta Console de Atualização Logix? Acesse alguns links disponíveis no final desta página para saber mais clicando AQUI


Após processamento de conversores de parâmetros é preciso também liberar a permissão de acesso a estes parâmetros via opção de permissão de acesso no programa LOG00086 (Administração de Parâmetros Logix >> opção "Níveis de acesso").

Caso já não tenha sido processado o arquivo CNV na base, é necessário fazer o seguinte passo-a-passo:

  1. Obter o arquivo frw00023.cnv e disponibilizar o mesmo no diretório do servidor onde o programa LOG00086 consiga ter acesso aos conversores;
  2. Acessar o programa LOG00086 (Administração Parâmetros Logix);
  3. Na opção do menu Processamentos conversores informar o diretório onde está conversor frw00023.cnv;
  4. Após o arquivo ser listado na Grid, selecioná-lo e salvar;
  5. Em seguida executar o processamento através do botão PROCESSSAR;
  6. Também é necessário dar permissão de acesso para o usuário ter acesso aos novos parâmetros e neste caso deve-se acessar a opção Níveis de Acesso e pesquisar pelo usuário que terá permissão;
  7. Para ajustar a permissão pode-se optar por:
    1. Ajustar a permissão geral de Adminstração Logix de PARCIAL para TOTAL, caso seja um usuário administrador Logix;
    2. Modificar a permissão dos parâmetros da rotina "Administração Logix >> Controle Geral >> Smart Link - TPD" de PARCIAL para TOTAL. Para isso, acessar o ícone Zoom ao lado de Administração Logix, acessar novamente o zoom para opção Controle Geral, onde será apresentada a rotina Smart Link - TPD;
    3. Salvar as alterações;
  8. Verificar se a permissão foi bem sucedida acessando agora a opção de menu Manutenção Parâmetros, escolhendo na árvore a opção Administração Logix >> Controle Geral onde será apresentada a rotina Smart Link - TPD, onde constam todos os parâmetros de configuração da comunicação Logix com o serviço da ferramenta Smar Link Client.


(seleção) Caso o conversor já tenha sido processado na base basta seguir o passo 3.



Passo 3 - Registro e liberação de permissões de acesso de programas no Menu Logix

Para realizar o gerenciamento de Dados Protegidos e processamento de requisições oriundas do TPD (Totvs Privacidade de Dados), no Logix serão utilizados alguns programas descritos logo a seguir, que precisarão estar disponível a partir do menu Logix.


Para isso acesse o programa LOG00112 (Central Menu Logix), opção "Níveis de Processos" e cadastre os programas conforme passo a passo a seguir, apenas para os programas que ainda não estiverem disponíveis a partir do Menu Logix:


(aviso) ATENÇÃO: O caminho de localização dos programas no passo a passo abaixo é apenas uma sugestão, podendo ser modificado se desejar.

(seleção) DICA: Apenas será necessário cadastrar os programas abaixo, caso ainda não existam disponíveis a partir do Menu Logix.


PROGRAMA LOG10005 (CENTRAL DE DADOS PROTEGIDOS)

(informação) O programa LOG10005 centraliza a chamada de todos os demais programas que gerenciam quais são os dados protegidos no Logix e como são tratados dentro do sistema.  

1) Acionar opção Modificar

2) Expandir o item Administração Logix (área de aplicação), a partir deste expandir o item Controle Geral (Sistema Logix) e ai então pressione o botão , onde:

Transação: LGPD

Descrição: Dados Protegidos (LGPD)

Acione o botão

3) Após incluir o nível Dados Protegidos (LGPD) citado no item (2), expanda novamente o item Controle Geral caso os níveis tenham sido retraídos, selecione o nível recém cadastrado Dados Protegidos (LGPD) e pressione o botão , onde:

Transação: LOG10005

Descrição: Central de Dados Protegidos

Processo: log10005

Tipo Processo: 2 

Chave Sistema: PADRAO

Acione o botão


PROGRAMA JOB0003 (CADASTRO DE GATILHOS DE AGENDAMENTO DE TAREFAS)

(informação) O programa JOB0003 é utilizado apenas para gerenciar e executar gatilhos de agendamento de tarefas manualmente. Será utilizado, quando necessário, para gerenciar os gatilhos registrados automaticamente a partir das requisições REST oriundas do TPD.

1) Acionar opção Modificar

2) Expandir o item Administração Logix (área de aplicação), a partir deste expandir o item Controle Geral (Sistema Logix) e ai então pressione o botão , onde:

Transação: JOBSCHEDULER

Descrição: Agendamento de Tarefas

Acione o botão

3) Após incluir o nível Dados Protegidos (LGPD) citado no item (2), expanda novamente o item Controle Geral caso os níveis tenham sido retraídos, selecione o nível recém cadastrado Agendador de Tarefas e pressione o botão , onde:

Transação: JOB0003

Descrição: Agenda de tarefas (Gatilhos)

Processo: job0003

Tipo Processo: 2 

Chave Sistema: PADRAO

Acione o botão


OS PROGRAMAS JÁ FORAM REGISTRADOS NO MENU?

Após devidamente cadastrados os programas no menu, libere a permissão de acesso de usuários para executá-los a partir do LOG05050 (Central de Usuários >> opção Permissão de Acesso)


Passo 4 - Importação de Dados Protegidos pré-cadastrados

Importar o arquivo private_data.mzp disponível juntamente com o pacote de atualização Logix via LOG10005 (Central de Dados Protegidos >> opção Importação de Dados), que consiste na lista de dados protegidos já pré-cadastrados como sugestão da Totvs para o Produto Logix.


Passo 5 - Ativação da Auditoria de Dados Protegidos

A partir do LOG10005 (Central de Dados Protegidos >> opção Dados Protegidos)

  • Realizar a revisão dos dados cadastrados e inclusive registro de dados de tabelas específicas que não estão previstas na importação do arquivo anteriormente importado (sugestão Totvs);
  • Após revisão do cadastro de Dados Protegidos, é necessário ativar a auditoria dos Dados Protegidos para garantir a geração de informações utilizadas para atender a requisição de dados do TPD através da opção Registro de Tratamento de Dados.
  • Para ativar a auditoria acione o botão AUDITORIA e confirme o processamento. Esta opção irá criar gatilhos (TRIGGER) nas tabelas do banco de dados que estiverem registradas no cadastro de Dados Protegidos com a situação ATIVA.


DICA

(aviso) ATENÇÃO pois esta ação precisa ser executada quando houver permissão de acesso EXCLUSIVO no banco de dados para o registro das triggers nas tabela, ou seja, o sistema não poderá estar em uso pelos usuários.

Passo 5 - Configuração e ativação do Agendador de Tarefas

Configurar e ativar o Agendador de Tarefas Logix, para que a execução de requisições do TPD para o produto Logix sejam realizadas com sucesso utilizando os gatilhos do agendador de tarefas que são automaticamente criados no Logix no ato do recebimento de requisições pelo TPD. Através destes gatilhos, quando processados pelo agendador de tarefas, serão responsáveis por enviar a resposta dos dados solicitados para o TPD.


ATENÇÃO

IMPORTANTE! O serviço do Agendador de Tarefas sempre deverá estar em execução a partir do momento em que o TPD x LOGIX estiver em uso para que os dados das requisições oriundas do TPD sejam devidamente respondidas pelo Logix.


Não sabe como configurar e utilizar o Agendador de Tarefas? Acesse AQUI


Passo 6 - Configuração do serviço REST

Configurar o serviço REST no AppServer Logix para receber as requisições de Dados Protegidos do TPD.





No LOGIX, existem configurações a serem definidas no arquivo de configuração do TotvsAppserver (Arquivo Totvsappserver.ini) para executar e desenvolver métodos utilizando a arquitetura REST na tecnologia TotvsTec.


A seguir será apresentado um exemplo de configuração do TotvsAppserver e algumas referências para outras documentações também disponíveis a respeito do mesmo assunto.


Para mais detalhes a respeito de conceitos, configurações e testes utilizando arquitetura REST com TotvsTec clique AQUI (necessário solicitar permissão para equipe TotvsTec).



Configurações no arquivo appserver.ini


É necessário definir algumas seções no arquivo de configuração do Appserver e ajustar, quando necessário, os valores para o nome do ambiente (Chave ENVIRONMENT), porta (Chave PORT), quantidade de instâncias para execução no AppServer (Chave INSTANCES) e Chave URL para indicar o endereço em que as requisições REST serão atendidas.


[ONSTART]
REFRESHRATE=30
JOBS=HTTPJOB 

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=logix12_ora  ;*** NOME DO AMBIENTE LOGIX, pode ser modificado

[HTTPV11]
ENABLE=1
SOCKETS=HTTPREST
TIMEOUT=600 

[HTTPREST]
PORT=8580   ;*** Porta utilizada na URI, pode ser modificada
URIS=URITESTE
SECURITY=0

[URITESTE]
URL=/   ;*** Endereço base pra atender as requisições REST. Exemplo: http://localhost:8580/api/vdp/v1/clientes
INSTANCES=2,2   ;*** Número de instâncias utilizadas para atender as requisições REST (quantidade inicial e máxima de instâncias)
ONSTART=LOGIXRESTSTART
ONCONNECT=LOGIXRESTCONNECT
ONEXIT=LOGIXRESTEXIT

(aviso) ATENÇÃO! Fique atento ao utilizar o parâmetro de configuração com a chave Security=0, pois isso fará com que as integrações (APIs) não exijam autenticação e consequentemente dados do seu ambiente poderão ser consultados sem qualquer controle de autorização.

(seleção) Neste caso é indicado que ative a autenticação REST conforme orientações no item Ativando autenticação REST a seguir.


Com base na configuração acima, as requisições REST serão atendidas a partir da seguinte URL base:  http://localhost:8580/rest


Ativando autenticação REST

Para ativar o controle de autenticação nas requisições REST e passar a exigir que as requisições sejam executadas usando protocolo HTTPS, é necessário alguns procedimentos que estão descritos a seguir:


Ative a chave SECURITY na seção HTTPREST:

[HTTPREST]
PORT=8580   ;*** Porta utilizada na URI, pode ser modificada
URIS=URITESTE
SECURITY=1   ;*** Ativar a autenticação das requisições REST


Ativando a chave SECURITY=1 precisará configurar também as seguintes chaves CERTIFICATE, KEY e PASSPHRASE na seção [HTTPREST], com os dado do certificado SSL.

A partir da ativação da autenticação das requisições REST, na seção HEADER das requisições deverá constar o campo AUTHORIZATION contendo as informações de usuário e senha no formato BASE64.


Exemplo:

Supomos que para realizar a requisição de uma API REST do LOGIX seja necessário executar a URL de requisição abaixo:

Informação

Valor

MétodoGET
URLhttps://<servidor>:<porta_rest>/api/vdp/v1/states/SC 

HEADER

Authorization


Basic Auth

Username=[usuário logix] 

Password=[senha usuário Logix]


Para o exemplo acima, na seção Header da URL de requisição REST, deverá ser enviada a chave "Authorization":"BASIC XXXXXXXXXXXX", onde XXXXXXXXXXXX é a tupla usuario:senha do Logix convertidos em Base64.

Exemplo: 


Com isso a segurança na comunicação se dará principalmente pelo uso de certificados SSL que garantem a abertura da comunicação segura entre os dois pontos e também o uso da autenticação de um usuário logix válido.


Passo 7 - Configuração dos parâmetros

Configurar parâmetros relacionados a Privacidade de Dados no Logix no programa LOG00086.


ParâmetroDescriçãoSituação
Client Id

  • Código único que identificará o produto utilizando a credencial, ou seja, o produto que utiliza o Smart link para comunicação com o TPD (TOTVS Privacidade de Dados).

EM DESENVOLVIMENTO
Client Secret

  • Senha que autenticará o produto que estiver usando a credencial.

    Obs: Esta informação não deve ser compartilhada, sob o risco de terceiros terem acesso ao TOTVS Privacidade de Dados sem o seu conhecimento.

EM DESENVOLVIMENTO
URL de conexão com o Smart Link

  • Definição da URL para realizar a conexão com o Smart Link.

    Exemplo: http://meu_server:8888

    Em que:

meu_server = Host de comunicação com o Smart Link e

8888 = Porta de comunicação com o Smart Link.

ATIVO
URL do RAC

  • Deve ser informado a URL do RAC.

    É necessário informar o tipo do ambiente, após o nome do Tenant.

    O ambiente pode ser DEV, STAGING ou PROD.

    Exemplos: https://<tenant>.<environment>.totvs.app/totvs.rac/connect/token

    Em que:


tenant = nome do tenant utilizado

environment = informar o tipo de ambiente (dev ou staging)

Obs: Quando o ambiente for PROD (produção) não precisa ser informado na URL

EM DESENVOLVIMENTO
Host do protocolo GRPC
  • No Smart Link Client é utilizado o protocolo GRPC. Deve ser informado o HOST utilizado para a comunicação com o GRPC.
  • É preciso informar o tipo de ambiente, que pode ser DEV, STAGING ou PROD.

Exemplos: link.dev.totvs.app

       link.staging.totvs.app

       link.prod.totvs.app

EM DESENVOLVIMENTO
Porta do servidor para protocolo GRPC
  • Porta do servidor para utilização no protocolo GRPC.
  • Por padrão utiliza-se a porta 443.
EM DESENVOLVIMENTO
Identificador do Tenant
  • Identificador do Tenant utilizado.
  • Quando o Smart Link Client atende apenas um determinado tenant, é necessário criar e configurar um CLIENT (e SECRET).
EM DESENVOLVIMENTO
Protocolo seguro (HTTPS)?
  • Deve ser Informado se o protocolo é seguro, ou seja, se é HTTPS.
  • Por padrão é definido como 'SIM'.

Obs: O protocolo deve seguir a configuração do servidor (http ou https)

EM DESENVOLVIMENTO
Subscrição Anonimização de Dados Pessoais

  • Deve ser informado se a Anonimização de Dados Pessoais está ativa.

EM DESENVOLVIMENTO
Subscrição Consulta de Registro de Tratamento de Dados Pessoais
  • Deve ser informado se a Consulta de Registros de Tratamento de Dados Pessoais está ativa.
EM DESENVOLVIMENTO
Subscrição Consulta de Dados Pessoais
  • Deve ser informado se a Consulta de dados pessoais está ativa.
EM DESENVOLVIMENTO
Passo 8 - Instalação do Smart Link

Instalar e configurar o Smart Link Client com base nos dados do TPD e Rest Logix já disponíveis para comunicação e, realizar os testes de comunicação do Smart Link Client X TPD e Smart Link Client X Logix:


Conteúdo



01. Objetivo

Esta documentação tem a finalidade de servir como uma guia no momento da integração do produto Logix com o TOTVS Privacidade de Dados (TPD). Para mais informações sobre a ferramenta, acesse TOTVS Privacidade de Dados.

Para tanto, abaixo seguem as instruções para que a integração seja realizada corretamente.


02. Informações

O produto Logix faz uso de uma ferramenta chamada Smart Link, que é um mecanismo de troca de mensagens entre aplicações TOTVSApps e aplicações On Premises (ou remotas) onde:

  • Foi utilizada a biblioteca Smart Link Client Java, que por meio desta foi implementado o processador de troca de mensagens.
  • O processador de mensagens é uma aplicação java.

Obtenha informações sobre os valores do client, secret, name e id do seu tenant de acesso do produto Logix no portal TPD para poder realizar as configurações necessárias para a integração com o Logix nos próximos passos. 

Para mais detalhes leia Documentos de Referência do TOTVS Privacidade de Dados.


03. Instalação Smart Link Client Java

O arquivo smart-link-client.zip que, que contém a instalação/atualização da ferramenta SmartLink Client, é disponiblizado juntamente com o pacote de atualização do Logix na pasta LIBTOOLS/SMARTLINK.

Extrair os arquivos em um diretório de sua escolha, sugerimos o uso do nome do seu tenant para complementar e facilitar a organização dos artefatos. 

Exemplo:

  • O nome do tenant para exemplo é totvs-fwk e o nome da pasta extraída é smart-link-client.
    • "C:/TOTVS/totvs-fwk/smart-link-client"
  • Como resultado temos a estrutura abaixo:
    1. C:/TOTVS/totvs-fwk/smart-link-client/README.txt
    2. C:/TOTVS/totvs-fwk/smart-link-client/client/application.yml
    3. C:/TOTVS/totvs-fwk/smart-link-client/client/smart-link-client.jar
    4. C:/TOTVS/totvs-fwk/smart-link-client/client/log
    5. C:/TOTVS/totvs-fwk/smart-link-client/service/Windows/install.bat
    6. C:/TOTVS/totvs-fwk/smart-link-client/service/Windows/JavaService.exe
    7. C:/TOTVS/totvs-fwk/smart-link-client/service/Windows/uninstall.bat
    8. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/install.sh
    9. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/SmartLinkClient.service
    10. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/SmartLinkClient.sh
    11. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/start.sh
    12. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/stop.sh
    13. C:/TOTVS/totvs-fwk/smart-link-client/service/Linux/uninstall.sh



Editar o arquivo "/service/Windows/install.bat"

:default
@echo on

chcp 65001

set LINK_CLIENT=C:/TOTVS/smart-link-client/client

JavaService.exe -install "TOTVS-SMART-LINK-CLIENT" "%JAVA_HOME%/bin/server/jvm.dll" -Djava.class.path="%LINK_CLIENT%/smart-link-client.jar" -start org.springframework.boot.loader.JarLauncher -err "%LINK_CLIENT%/log/smart-link-client_err.log" -current "%LINK_CLIENT%" -manual -description "TOTVS LOGIX SMART LINK CLIENT"

@echo off

:eof

@echo .
@echo .
@echo .
PAUSE.


Nome do serviço

  • Por padrão temos o nome do serviço definido como "TOTVS-SMART-LINK-CLIENT"
  • Sugerimos o uso do nome do seu tenant para complementar e facilitar a organização do serviço.


Descrição do serviço

  • A descrição do serviço pode ser alterada por meio do parâmetro -description.

JAVA

  • Deve ser utilizado JAVA 11
  • No arquivo estamos utilizando o %JAVA_HOME% como padrão, caso necessário faça a alteração para utilizar a sua variável de ambiente já existente.

Parâmetros

  • Os parâmetros -Djava.class.path, -current e -err fazem o uso do valor informando em LINK_CLIENT (ajustar para o diretório definido nas etapas anteriores).

Instalação do serviço:

  • Executar Prompt de Comando do sistema operacional como administrador.
  • Executar o arquivo de lote /service/Windows/install.bat.

Editar o arquivo "/service/Windows/uninstall.bat"

  • Informe o nome do serviço definido na etapa anterior (Instalador de serviço para Windows)

Desinstalação do serviço:

  • Execute Prompt de Comando como administrador
  • Execute o arquivo "/service/Windows/uninstall.bat"

Para a instalação do serviço no Linux certifique-se de que os passos a seguir foram realizados:

  1. Definir a descrição do serviço:
    1. Edite o arquivo service/Linux/SmartLinkClient.service, localizado no local onde o projeto foi extraído, e informe no atributo "Description", a descrição do serviço:
    2. Por padrão temos o nome do serviço definido como "TOTVS-SMART-LINK-CLIENT"
    3. Sugerimos o uso do nome do seu tenant para complementar e facilitar a organização do serviço.
  2. Configurar o arquivo application.yml
    1. Veja a sessão 04. Configuração deste documento.
  3. Editar o arquivo "/service/Linux/install.sh" localizado onde o projeto foi extraído.
    1. Informar na variável PATH_SOURCE_SMART_LINK_CLIENT, localizado na linha 13, o local onde o projeto foi extraído.


#!/bin/bash

ERRO="A instalação do Smart Link Client encontrou problema(s). Verifique o(s) aviso(s) acima."

checkCommandError(){
        if [ $? -ne 0 ]; then
		echo ""
		echo "$ERRO"
		exit 0
        fi
}

PATH_SOURCE_SMART_LINK_CLIENT="local-onde-foi-extraido/smart-link-client"
PATH_SMART_LINK_CLIENT="/usr/local/smart-link-client"

checkCommandError

echo "Instalação do Smart Link Client"

echo 'Copiando SmartLinkClient.service para /etc/systemd/system'
sudo cp -p "$PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/SmartLinkClient.service" /etc/systemd/system/SmartLinkClient.service
checkCommandError

echo 'Copiando SmartLinkClient.sh para /usr/local/bin' 
sudo cp -p "$PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/SmartLinkClient.sh" /usr/local/bin/SmartLinkClient.sh
checkCommandError

echo 'Concedendo permissao para execucao'
sudo chmod +x /usr/local/bin/SmartLinkClient.sh
checkCommandError

sudo mkdir "$PATH_SMART_LINK_CLIENT"
checkCommandError

sudo mkdir "$PATH_SMART_LINK_CLIENT/client"
checkCommandError

echo "Copiando $PATH_SOURCE_SMART_LINK_CLIENT/client para $PATH_SMART_LINK_CLIENT" 
sudo cp -r "$PATH_SOURCE_SMART_LINK_CLIENT/client/" "$PATH_SMART_LINK_CLIENT"
checkCommandError

sudo mkdir "$PATH_SMART_LINK_CLIENT/service"
checkCommandError

echo "Copiando $PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/start.sh para $PATH_SMART_LINK_CLIENT/service" 
sudo cp -r "$PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/start.sh" "$PATH_SMART_LINK_CLIENT/service"
checkCommandError

echo "Copiando $PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/stop.sh para $PATH_SMART_LINK_CLIENT/service"
sudo cp -r "$PATH_SOURCE_SMART_LINK_CLIENT/service/Linux/stop.sh" "$PATH_SMART_LINK_CLIENT/service"
checkCommandError

echo 'Habilitando SmartLinkClient ...'
sudo systemctl enable SmartLinkClient
sudo systemctl daemon-reload

echo 'Iniciando SmartLinkClient ...'
sudo systemctl start SmartLinkClient
echo 'Fim da instalacao.'


Instalando o serviço:

  • Abra um terminal e execute o arquivo "/service/Linux/install.sh", que está localizado onde o projeto foi extraído.

  • O comando ficaria como:  sudo bash /<local-onde-projeto-foi-extraído>/smart-link-client/service/Linux/install.sh
  • O script de instalação fará a inicialização do serviço automaticamente.
  • Start e Stop manuais:
    • Caso necessite interromper ou inicial o serviço manualmente. 
    • Para iniciar o serviço, execute:   sudo bash /usr/local/smart-link-client/service/start.sh
    • Para parar o serviço, execute:   sudo bash /usr/local/smart-link-client/service/stop.sh


Atenção

O diretório no qual o projeto foi extraído não é o mesmo local onde o projeto será instalado:

  • A instalação do smart-link-client será em /usr/local/.
  • Após a instalação, o projeto extraído torna-se necessário somente para a execução do script de instalação e desinstalação, uma vez que os demais arquivos foram copiados para o destino /usr/local/smart-link-client.
  • A saída de logs do smart-link-client ocorrerá no diretório em que foi instalado, no caso, /usr/local/smart-link-client/client/log.


  • Abra uma sessão terminal e execute o arquivo /service/Linux/uninstall.sh, que está localizadon onde o projeto foi extraído.|
  • O comando ficaria como:   sudo bash /<local-onde-projeto-foi-extraido>/smart-link-client/service/Linux/uninstall.sh.
  • Ao desinstalar o serviço, a pasta /usr/local/smart-link-client será removida.


04. Configuração Smart Link Client Java

O arquivo de configuração é application.yml.

Utilizando a pasta de exemplo dos passos anteriores, podemos encontrar o arquivo em /client/application.yml.

Leia com atenção o detalhamento das configurações abaixo:


# SERVER

A porta de acesso da aplicação pode ser alterada na propriedade:

# -------------------------------------------------
# SERVER
# -------------------------------------------------  
server:
  port: 8777

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.server.server.port


# SPRING

Por padrão estamos utilizando 10MB para poder trafegar metadado no formato JSON.

# -------------------------------------------------
# SPRING
# ------------------------------------------------- 
spring:
  codec:
    max-in-memory-size: 10MB

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.core.spring.codec.max-in-memory-size


# LOG

O nome do arquivo de log pode ser alterado na propriedade name abaixo:

# -------------------------------------------------
# LOG
# -------------------------------------------------    
logging:
  file:
    name: log/smart-link-client.log

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.core.logging.file.name


# SMART LINK CLIENT


# -------------------------------------------------
# SMART LINK CLIENT
# -------------------------------------------------
totvs:
  link:
    auth:
      url: INFORMAR_URL_RAC
      client: INFORMAR-CLIENT
      secret: INFORMAR-SECRET
    client:
      subscriptions:      
        - SGDPDataCommand
        - SGDPMaskCommand
		- SGDPLogsCommand
    server:
      host: INFORMAR_HOST
      port: 443
      secure: true
  tenant:
    name: INFORMAR-NOME-TENANT
    id: INFORMAR-ID-TENANT   
  product:
    name: 'Logix'
    url: 'INFORMAR_URL_LOGIX'
    username: 'INFORMAR_USUÁRIO'
    password: 'INFORMAR_SENHA'

Leia com atenção o detalhamento das configurações abaixo:

O Smart Link Client Java é uma biblioteca que facilita o desenvolvimento de um LINK Client para a plataforma Java, sendo necessária a implementação de uma aplicação que implemente um processador de mensagens (LINK Client Java Application mais abaixo).

No Smart Link Client Java utiliza o protocolo GRPC, sendo necessária a seguinte configuração:

totvs:
  link:
    server:
      host: INFORMAR_HOST
      port: 443
      secure: true
  • INFORMAR_HOST:  Utilizar o host conforme o tipo do seu ambiente:
    • DEV: api-smartlink.dev.totvs.app
    • STAGING: api-smartlink.staging.totvs.app
    • PROD: api-smartlink.totvs.app

Deve ser informada também uma lista de subscrições, onde somente mensagens com determinados types são efetivamente enviadas para o Smart Link Client. 

No Smart Link Client Java é necessária a seguinte configuração:

totvs:
  link:
    client:
      subscriptions:
        - SGDPDataCommand
        - SGDPMaskCommand
	 	- SGDPLogsCommand

O produto está preparado para processar os tipos SGDPDataCommand, SGDPMaskCommand e SGDPLogsCommand.

O produto Logix suporta apenas o single tenant, sendo necessária a seguinte configuração:

totvs:
  link:
    auth:
      url: INFORMAR_URL_RAC
      client: INFORMAR-CLIENT
      secret: INFORMAR-SECRET
  • INFORMAR_URL_RAC:  Utilizar a url conforme o tipo do seu ambiente, onde:

DEV          https://admin.rac.dev.totvs.app/totvs.rac/connect/token

STAGING  https://admin.rac.staging.totvs.app/totvs.rac/connect/token

PROD        https://admin.rac.totvs.app/totvs.rac/connect/token

  • INFORMAR-CLIENT: Substituir pelo valor do seu client.
  • INFORMAR-SECRET:  Substituir pelo valor da sua secret.

Informar os valores do seu Tenant:

totvs:
  tenant:
    name: INFORMAR-NOME-TENANT
    id: INFORMAR-ID-TENANT
  • INFORMAR-NOME-TENANT: Substituir pelo nome do seu tenant.
  • INFORMAR-ID-TENANT:  Substituir pelo valor do ID do seu tenant.

Utilize aspas simples para valores do tipo texto ao informar as configurações do produto.


A  comunicação acontece nos dois sentidos (TOTVS Privacidade de Dados >> Logix) e (Logix >> TOTVS Privacidade de Dados) por meio das configurações abaixo:

totvs:
  product:
    name: 'Logix'
    url: 'INFORMAR_URL_LOGIX'
    username: 'INFORMAR_USUÁRIO'
    password: 'INFORMAR_SENHA'
  • INFORMAR_URL_LOGIX: Substituir pelo valor do seu ambiente. Exemplo: http://localhost:8080
  • INFORMAR_USUÁRIO:  Substituir pelo valor de um usuário existente no produto. 
  • INFORMAR_SENHA:  Substituir pelo valor da senha do usuário.


CONFIGURAÇÕES OBRIGATÓRIAS


  • Adicionar a configuração tpdDisabled para desativar a comunicação do entre o Smart Link Client e o Produto Logix.
totvs:
  product:
    tpdDisabled: true


  • Caso necessário, adicionar a configuração linkClientUrl para indicar onde está o LINK Client Java Application.

A configuração recebe o valor http://SERVIDOR:PORTA, onde:

SERVIDOR:  Servidor que está executando o processador de mensagens smart-link-client.jar

PORTA: Valor da porta (server: port) da configuração #SERVER

Observação: Caso precise adicionar um valor diferente do padrão, você deverá adicionar a configuração:

totvs:
  product:
    linkClientUrl: 'INFORMAR_URL_SMART_LINK_CLIENT'

Ao informar o endereço de um ambiente com protocolo HTTPS na configuração totvs.product.url, realize a importação dos certificados do ambiente Logix na JVM que está executando o smart-link-client.jar, para importação utilize a ferramenta keytool.

totvs:
  product:
    url: 'https://meu-servidor:8080'

Ao atualizar qualquer propriedade de configuração o serviço deverá ser iniciado novamente, permitindo a leitura das configurações atualizadas.


05. Inicialização do serviço instalado

Após concluir as etapas anteriores, basta iniciar o serviço instalado e verificar no log se a aplicação foi iniciada com sucesso.


Starting Application

INFO 15788 --- [main] com.totvs.link.client.Application        : Starting Application v12.1.34-NFRW-SNAPSHOT on 00000 with PID 15788 (C:\TOTVS\smart-link-client\client\smart-link-client.jar started by 00000$ in C:\TOTVS\smart-link-client\client)
INFO 15788 --- [main] com.totvs.link.client.Application        : No active profile set, falling back to default profiles: default
INFO 15788 --- [main] com.totvs.link.client.LinkService        : *** Connecting to server (link.staging.totvs.app:443)
INFO 15788 --- [main] o.s.s.c.ThreadPoolTaskScheduler          : Initializing ExecutorService 'taskScheduler'
INFO 15788 --- [main] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 8777
INFO 15788 --- [main] com.totvs.link.client.Application        : Started Application in 4.994 seconds


Para facilitar a visualização de log foi adicionada a infomação [SMART-LINK-CLIENT] no LOG para as classes java implementadas.

INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.readyEvent]
INFO 3528 --- [main] c.t.l.c.d.ProductSyncDefaultMetadata     : [SMART-LINK-CLIENT][ProductSyncDefaultMetadata.sync]
INFO 3528 --- [main] c.t.l.client.product.ProductSendMessage  : [SMART-LINK-CLIENT][ProductSendMessage.send][REQUEST][GET] to http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.client.product.ProductSendMessage  : [SMART-LINK-CLIENT][ProductSendMessage.send][RESPONSE][GET][200] from http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.c.d.ProductSyncDefaultMetadata     : [SMART-LINK-CLIENT][ProductSyncDefaultMetadata.sync] Sending message to Smart Link Server - type: SGDPUpdateApplicationMetadata - metadado: {"header":{"type":"SGDPUpdateApplicationMetadata"},"content":{"models":{},"codes":{},"package":"Logix","productId":"Logix","readOnly":true,"smartLink":"singleTenant","localLogs":false,"applicationId":"Logix"}}
INFO 3528 --- [main] c.t.l.c.d.ProductSyncDefaultMetadata     : [SMART-LINK-CLIENT][ProductSyncDefaultMetadata.sync] Sent to Smart Link Server



PRONTO! A partir deste momento já está disponível o acesso para consulta e processamento das opções do portal TPD para o Produto Logix.



Documentações auxiliares

Para o melhor entendimento e suporte aos processos disponíveis no Logix, referente aos Dados Protegidos, existem as documentações de Referências do produto.

Essas documentações fazem parte do conjunto a Ajuda do produto, que podem ser acessadas pela tecla F1 (teclado) diretamente na tela do programa, porém podem ser acessadas diretamente no conteúdo a seguir:


         Configurador de dados pessoais e sensíveis (LOG10000)

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela LOG10000
    1. Principais Campos e Parâmetros
  4. Operações

01. VISÃO GERAL

Disponibilizar uma aplicação para que seja possível manter uma lista de campos do produto que tenham relação com informações consideradas pessoais e/ou sensíveis seja de usuários do produto ou até informações pessoais de qualquer pessoa que possam estar registradas em tabelas do produto Logix.

A lista de campos protegidos é identificada por tabelas e colunas do Banco de Dados onde as informações são armazenadas e também faz referência ao nome dos programas do produto Logix que exibem e/ou atualizam tais informações. Desta forma facilita a identificação das telas do produto que fazem uso de dados sensíveis.

O usuário responsável por manter a atualização destas informações cadastrais no produto é denominado Controlador.

02. EXEMPLO DE UTILIZAÇÃO

Com a utilização da aplicação LOG10000 (Dados Protegidos), o Controlador tem acesso a registrar as seguintes informações:

    1. Indicar se um determinado campo utilizado e exibido em telas do produto é considerada pessoal e/ou sensível;
    2. Indicar se o conteúdo de um determinado campo que é exibido em telas do produto pode ou não ser anonimizado;
    3. Classificar a informação conforme seu tipo de documento (CPF, RG, e-mail);
    4. Classificar a informação quanto ao tipo de tratamento;
    5. Informar os processos que utilizam o campo;

03. TELA LOG10000





























Principais Campos e Parâmetros

CampoDescrição
Tabela

Nome da tabela do banco de dados utilizada pelo produto Logix, que faz referência a alguma coluna que possui informações sensíveis ou pessoais.

(seleção) Esta tabela obrigatoriamente precisa estar registrada no cadastro de tabelas do metadados Logix (FRM1007).

ColunaNome da coluna relacionada a tabela de banco de dados que armazena alguma informação de usuário que seja considerada pessoal ou sensível.
ProprietárioCampo informativo (não editável) que representa se o campo foi registrado e é mantido pela TOTVS (Padrão) ou se foi registrado manualmente (Específico).
Características

Permite parametrizar a informação como Pessoal, Sensível e se deve ser anonimizada.

Nota

Quando a informação é registrada como Sensível, o sistema obrigatoriamente assume que é também uma informação Pessoal.

Tipo de documento

Classifica a informação quanto ao seu tipo / origem (CPF, RG ou e-mail)

Classificações

Classifica a informação quanto a forma que será tratada no sistema, conforme lista de classificações pré-determinada:

  • Execução de contrato;
  • Obrigação Legal;
  • Consentimento;
  • Execução de políticas públicas;
  • Estudo por órgão de pesquisa;
  • Exercício regular de direito;
  • Para a proteção da vida;
  • Para tutela de saúde;
  • Interesse legítimo;
  • Proteção de crédito;
  • Outros.

É obrigatória a inclusão de pelo menos um classificador e para cada classificador deverá haver uma justificativa.

ProcessosLista dos processos (programas) do produto Logix que utilizam e exibem as informações da tabela e coluna do banco de dados informado.



04. OPERAÇÕES


NomeFunção
SituaçãoAltera a situação do campo protegido. Mais detalhes aqui

Exportar

Realiza a exportação dos campos protegidos. Mais detalhes aqui

Importar

Realiza a importação dos campos protegidos. Mais detalhes aqui
AuditoriaGera a auditoria dos campos protegidos. Mais detalhes aqui
SincronizarSincroniza os registros com o TOTVS Privacidade de Dados. Mais detalhes aqui



Situação

Responsável por alterar a situação do campo, sendo que existem dois tipos de situação: Ativo e Inativo.

  • O campo inativo será ignorado nas solicitações de consulta e anonimização dos dados (TOTVS Privacidade de dados).
  • O campo inativo será ignorado na sincronização dos dados com o TPD (TOTVS Privacidade de dados).


Exportar (LOG10001)

Nesta tela existe o campo para definição do diretório da origem do arquivo que será exportado. O nome do arquivo é definido na geração do arquivo, não sendo possível informá-lo

A funcionalidade consiste em exportar todas as informações relacionadas aos dados pessoais e sensíveis presente no banco de dados.

A representação desta tela pode ser verificada na imagem abaixo:







Aviso

É importante se atentar para o NOME do arquivo, pois ele é definido na geração do arquivo e NÃO é possível informá-lo! O padrão do nome utilizado para criação do arquivo é "private_data.mzp".

Importar (LOG10002)

Nesta tela é apresentado o campo para seleção do arquivo que será importado, ele precisa existir previamente, sendo aceito apenas arquivos no formato *.mzp exportados pelo LOG10001 ou enviados pela TOTVS.

Abaixo deste campo existe a opção para indicar se no processo de importação, serão eliminados os registros específicos que já estão presentes na base do cliente. 

A representação desta tela pode ser verificada na imagem abaixo:


Aviso

É importante se atentar para o FORMATO do arquivo, pois somente serão aceitos no formato MZP exportados pelo LOG10001 ou enviados pela TOTVS.

Atenção para as regras da importação:

  • Se a opção "Sobrescrever sugestões alteradas?" não estiver selecionada:
    • Os registros são inseridos ou atualizados de acordo com o arquivo;
    • Os registros que estão inativos, permanecem inalterados;
    • Caso o arquivo contenha um registro que no banco está Inativo, o mesmo não será 'reativado' e atualizado;
    • Os registros de processos são adicionados, caso não exista.
  • Se a opção "Sobrescrever sugestões alteradas?" estiver selecionada:
    • Os registros são inseridos ou atualizados de acordo com o arquivo;
    • As sugestões alteradas que se tornaram específicos, são sobrescritas (volta ao estado de sugestão inicial);
    • Os registros inativos, não são atualizados;
    • Caso o arquivo contenha um registro que no banco está Inativo, o mesmo não será 'reativado' e atualizado;
    • Os registros de processos são adicionados, caso não exista.


Aviso

Os registros gerados ou modificados pelo cliente nunca serão atualizados pelos arquivos enviados pela TOTVS. 

Auditoria

Responsável por criar auditoria para os campos ativos existentes no cadastro. Será criada uma auditoria para inclusão com o nome "TI_SGDP_TDP_[TABELA]", uma de exclusão com o nome "TD_SGDP_TDP_[TABELA]" e uma de atualização com o nome "TU_SGDP_TDP_[TABELA]". Assim que executada a opção as auditorias já passam a ficar ativas.

Mensagem ao executar a opção:










Para a primeira execução será criada auditoria para todos os campos, para as demais execuções será criado somente para os registros que sofreram alteração. Pois quando efetuada inativação de algum campo ou incluído novos campos esses registros ficam pendentes de criação de auditoria e somente eles serão processados.

Toda a tabela incluída no LOG10000 deve possuir "Chave primária", pois com ela que será possível efetuar o rastreamento das informações, caso não possua é emitido mensagem abaixo  em tela, porém não bloqueia a inclusão. E no momento da criação da auditoria a mesma não será criada para tal tabela. Esta tabela ficará salva com erro de auditoria.









Somente usuários administradores possuem permissão para executar esta opção.


Sincronizar

Responsável por sincronizar os dados existentes nos programas (LOG10003 e LOG10000) com o TOTVS Privacidade de Dados.

Somente usuários administradores possuem permissão para executar esta opção.


IMPORTANTE!

Melhoria disponível no pacote oficial 12.1.27 ou Framework Fix 12.1.26.FIX02.




         Mapeamento de campos por vínculo do titular (LOG10003)

CONTEÚDO


01. VISÃO GERAL

O programa Log10003 disponibiliza no produto Logix a funcionalidade de cadastro do Mapeamento de Campos Protegidos por Vínculo com o Titular do Dado que é utilizado no processamento de requisições provenientes do portal TOTVS Privacidade de Dados (TPD).

Esta funcionalidade faz parte do conjunto de atalhos que compõe o programa Central de Dados Protegidos (Log10005), para que dessa forma, todas as ações de cadastro e atualização de informações relacionadas a dados pessoais e/ou sensíveis estejam centralizados.

Vale lembrar que este cadastro não se refere a dados pessoais e sensíveis, mas sim ao cadastro que identifica a relação completa de tabelas e colunas da Base de Dados Logix que armazenam informações pessoais e/ou sensíveis, identificando também o Vínculo que a informação armazenada nas respectivas tabelas/colunas do banco de dados tem com o Titular do Dado.


ATENÇÃO

Esta tela, TEMPORARIAMENTE permite apenas consulta de dados. A opção para cadastro estará disponível em pacote Logix futuro e assim que estiver disponível esta documentação será atualizada.


02. EXEMPLO DE UTILIZAÇÃO

Para acesso ao programa é preciso executar o programa principal identificado como Central de Dados Protegidos (Log10005) e a acionar no menu lateral a opção Mapeamento de Colunas.

03. TELA MAPEAMENTO DE CAMPOS POR VÍNCULO DO TITULAR

Outras Ações / Ações relacionadas

AçãoDescrição
Vínculo do titular

Tipo de Vínculo do Titular que a consulta de dados resultante da instrução SQL informada para uma respectiva tabela do banco de dados irá refletir.

Exemplo:
     Vínculo do Titular = Funcionário

     Tabela = dados_rescisao

Neste caso a instrução SQL a ser registrada para a tabela DADOS_RESCISAO precisará retornar informações de um ou mais registros desta tabela do banco de dados que pertençam a uma pessoa física entitulada como Funcionário.

Entidade
TabelaNome e descrição de uma tabela do banco de dados que possua registro de uma ou mais colunas no Cadastro de Campos Protegidos (LOG10000).
Tipo de informação

Tipo de informação que será utilizada na instrução SQL de consulta de dados da respectiva tabela. 

Existe uma lista pré-definida de tipos e é obrigatório selecionar um deles e utilizar este mesmo Tipo de Informação no campo onde será informada a instrução SQL para consulta de dados da tabela no banco de dados, pois será com base nesse filtro que o produto Logix irá buscar as informações em cada uma das tabelas que contém informações pessoais e/ou sensíveis e enviar como resposta para o portal Totvs Privacidade de Dados.

Instrução SQL para consulta de dados da Entidade

Instrução SQL que será utilizada como base para pesquisar dados pessoais e/ou sensíveis na tabela usando o tipo de informação selecionado .

Essa instrução é sempre registrada utilizando o seguinte padrão:

{SELECT} FROM <tabela> [,<tabela2>,..,<tabelaN>] WHERE <filtro de consulta>

ATENÇÃO

É OBRIGATÓRIO que na instrução SQL registrada exista um filtro utilizando o mesmo Tipo de Informação escolhido acima e para isso o tipo de informação é registrado com o seguinte formato:


           {Tipo de Informação} 

Exemplo:

          {CPF}
          {RG}
          {E-MAIL}


Em uma instrução SQL isso ficaria da seguinte forma:


          {SELECT} FROM frt_motorista WHERE frt_motorista.cpf = {CPF}


(informação) Existem REGRAS para registro de todas instruções SQL de consulta e estas estão devidamente detalhadas AQUI. (informação)

Informações do campo para anonimização de conteúdo
Coluna da tabelaNome e descrição de uma coluna da tabela anteriormente informada, eu esteja registrada no Cadastro de Campos Protegidos (LOG10000). 
Permite anonimização?Indica se a informação do dado permite anonimização do seu conteúdo.
Classificação

Classificação da informação armazenada na tabela/coluna.

Existe uma lista pré-fixada de valores possíveis e deve ser selecionado o valor conforme a necessidade para qual está sendo feito registro.

Essa classificação é o texto usado para identificar a hipótese de tratamento do dado na integração com o TOTVS Privacidade de Dados.

Tempo de guarda

Tempo de guarda da informação com sua unidade de medida de tempo (Anos, meses ou dias).

O tempo de guarda indica por quanto tempo a informação deve ser mantida intacta na base de dados, de forma que não possa ser anonimizada ou excluída, para atender a classificação e justificativa informados.

SituaçãoSituação de uso ou não do dado protegido.
JustificativaJustificativa para que a informação deste dado seja registrado e/ou mantido como um dado protegido pelo tempo informado.
Condição SQL para permitir a anonimização

Condição SQL utilizada para indicar quando o dado pode ser anonimizado. 

Esta condição é um filtro condicional no formato de consulta de banco de dados SQL, utilizada numa condição WHERE, ou seja, esta condição, quando unida à instrução SQL de consulta anteriormente informada, caso obtenha sucesso de consulta de dados, conforme o Tipo de Informação utilizado e demais condições de filtro registradas, indicará que este dado terá permissão para ser anonimizado na base de dados. Em resumo, SE ENCONTRAR REGISTRO, permite anonimização do dado e SE NÃO ENCONTRAR REGISTRO, não será permitido anonimizar o dado por existir condição legal que ainda deva ser mantida na base de dados de forma acessível e visível.

(informação) Existem REGRAS para registro de todas condições SQL de anonimização e estas estão devidamente detalhadas AQUI. (informação)


IMPORTANTE!

Disponível a partir do pacote oficial 12.1.2205 ou Framework Fix 12.1.34.(fix01)




        Mapeamento de tabelas por vínculo do titular (LOG10004)

CONTEÚDO


01. VISÃO GERAL

O programa Log10004 disponibiliza no produto Logix a funcionalidade de mapeamento por vínculo do titular com o TOTVS Privacidade de Dados:

A funcionalidade de mapeamento faz parte do conjunto de programas atalhos que compõe o programa Central de Dados Protegidos (Log10005), para que dessa forma, as ações referente a dados pessoais e/ou sensíveis estejam centralizados.

02. EXEMPLO DE UTILIZAÇÃO

Para acesso ao programa é preciso entrar no programa Central de Dados Protegidos (Log10005) e escolher a opção Mapeamento de Tabelas, no menu lateral.

03. TELA MAPEAMENTO DE TABELAS POR VÍNCULO DO TITULAR

Outras Ações / Ações relacionadas

AçãoDescrição
Vínculo do titular

Vínculo do titular a partir de uma listagem pré estabelecida.

Entidade
TabelaNome e descrição da tabela que contém alguma coluna cadastrada como campo protegido.
Tipo de informaçãoTipo de informação que será utilizada na instrução SQL de consulta.
Instrução SQL para consulta de dados da EntidadeInstrução SQL utilizada para pesquisar dados na tabela usando o tipo de informação indicado.


IMPORTANTE!

Disponível a partir do pacote oficial 12.1.2205 ou Framework Fix 12.1.34.(fix01)




         Configurador de dados pessoais e sensíveis (LOG10000)

CONTEÚDO


01. VISÃO GERAL

O programa Central de dados protegidos (Log10005), centraliza a chamada dos programa relacionados aos Dados Protegidos Logix. 

Estes atalhos promovem acessos à programas diversos para cadastro, consultas, exportação e importação de Dados Protegidos e também sincronização de dados com o portal Totvs Privacidade de Dados (TPD).

02. EXEMPLO DE UTILIZAÇÃO

Para acesso ao programa é preciso realizar o cadastro no menu Logix do programa LOG10005 e liberar o acesso de usuários para uso.

03. TELA CENTRAL DE DADOS PROTEGIDOS

Outras Ações / Ações relacionadas

AçãoDescrição
Menu

Área ondes estão os atalhos para acesso aos programas:

  • Dados Protegidos;
  • Mapeamento de Tabelas;
  • Mapeamento de Colunas;
  • Exportação de Dados;
  • Importação de Dados;
  • Sincronização de Dados.
Central de Dados ProtegidosÁrea onde é carregado o programa selecionado no menu lateral


IMPORTANTE!

Disponível a partir do pacote oficial 12.1.2205 ou Framework Fix 12.1.34.(fix01)




        Cadastro de agendamento de tarefas (JOB0003)

CONTEÚDO

01. VISÃO GERAL

Permite a integração automática dos arquivos com extensão XML, utilizando agendamento (JOB). Ou seja, há uma rotina para enviar os pedidos de compra e programações de entrega aos fornecedores e os complementos de NF-e aos clientes, assim como receber os pedidos de compra e programações de entrega dos clientes, criar os pedidos de venda e atualizar os itens destes pedidos periodicamente. Este procedimento evita que o usuário tenha que executar uma rotina adicional para enviar seu pedido de compra ao fornecedor, por exemplo.

Uma vez iniciado o serviço TOTVS Tec com o agendador de tarefas ligado, imediatamente é acionado um escalonador (scheduler) que verifica ininterruptamente se há algum gatilho a ser executado conforme período e intervalos definidos pelo usuário. Estes gatilhos são executados em uma nova linha de execução (thread), para não interferir nos gatilhos que ainda estão executando.

Os principais objetivos do agendamento são:

  • Permitir que todas as etapas de integração sejam automáticas (sem a intervenção do usuário);
  • Registrar as ações executadas no monitor de integração (SUP34204);
  • Foco na gestão e no fluxo das informações.

O gatilho cadastrado será considerado para execução no Agendador de Tarefas Logix quando o tempo definido no arquivo de configuração for atingido.

Ao efetuar a consulta de um gatilho e for exibido com a situação de “Andamento”, não será disponibilizado as opções de menu de “Modificar” e “Excluir" para esse gatilho.

Os programas (tarefas) a serem cadastradas para o gatilho devem estar previamente preparados para executar em modo background

OBS: É extremamente aconselhável criar um ambiente TOTVS Tec separado dos outros ambientes para execução do agendador de tarefa

01. TELA PRINCIPAL 


Outras Ações / Ações relacionadas

AçãoDescrição
Processar

Permite a execução individual do gatilho consultado em tela. Ao acionar esta opção, será permitido selecionar o modo de execução DEBUG para gerar um arquivo de LOG de acompanhamento de todo processamento.

Esta opção geralmente é utilizada para facilitar o processo de investigação de possíveis problemas durante a execução de gatilhos agendados.

É permitido executar inclusive gatilhos inativos ou fora do período válido de execução.

Config

Disponibiliza uma tela para ajustar o modo de execução DEBUG de um ou mais gatilhos simultaneamente, sem a necessidade de consultar e ajustar um a um.

Esta ação executa o formulário JOB00031 que apresenta apenas gatilhos ativos.

*** Disponível a partir do pacote 12.1.2403 ou FIX Framework 12.1.2311.fix01 ***


Principais Campos e Parâmetros

CampoDescrição
GatilhoCódigo incrementado automaticamente e a descrição do Gatilho criado.
ObjetivoBreve descrição do objetivo do agendamento.
ResponsávelCódigo e nome do usuário que está criando o agendamento.
E-mail responsável

E-mail do responsável que está criando o agendamento.

Ao lado do campo de e-mail existe uma lista com 3 opções:

  • Não Enviar:  Independente se houver erro ou não na execução do gatilho não será enviado e-mail para o usuário;
  • Enviar Sempre: Independente se houver erro ou não na execução do gatilho será enviado e-mail para o usuário;
  • Enviar Somente Quando Houver Erro: Somente será enviado e-mail para o usuário quando houver erro na execução do gatilho.


Especificação de Execução

CampoDescrição
Data início execuçãoData em que a execução do agendamento será iniciada.
Hora início execuçãoHorar em que a execução do agendamento será iniciada.
Data fim execuçãoData em que a execução do agendamento será finalizada.
Hora fim execuçãoHora em que a execução do agendamento será finalizada.
HoraDefinição para a hora em que o agendamento será executado.
MinutoDefinição para o minuto em que o agendamento será executado.
DiaDefinição para o dia em que o agendamento será executado.
Dia da SemanaDefinição de quais dias da semana em que o agendamento será executado.
MêsDefinição do mês em que o agendamento será executado.
Situação atual de execução

Apresenta duas opções:

  • Pendente: Esperando inicialização do agendamento;
  • Inativo: Agendamento inativado.
Modo de execução DEBUG

Apresenta quatro opções:

  • Desligado (0)
  • SQL / Debug Framework (1)
  • Profiler / Debug Framework (2)
  • Debug Framework (3)

O Debug Framework envolve mensagens de LOG para acompanhamento de comportamentos das diversas rotinas do sistema. Estas mensagens são fixadas em pontos específicos das rotinas para facilitar o processo de depuração de problemas.

*** Disponível a partir do pacote 12.1.2403 ou FIX Framework 12.1.2311.fix01 ***


Tarefas

ColunaDescrição
Sequência

Numeração incremental em que se refere a sequência da execução das tarefas do agendamento.

ProgramaNome do programa em que será executado o agendamento.
Rotina

Campo opcional.

Pode ser preenchido com uma breve característica da rotina que será executada.

Observação

Campo opcional.

Pode ser preenchido com observações sobre a rotina.

Dependentes

Só é possível ativar dependentes se houver 2 ou mais tarefas.

Exemplo:

     Sequência 1 - Pedido

     Sequência 2 - Reserva

     Sequência 2 é dependente da Sequência 1, onde ela só será executada se a Rotina 1 for executada primeiramente.

Parâmetros

Campos: Valor e Observação

Para cada parâmetro, o campo Valor deverá conter a informação que será utilizada para selecionar os pedidos.
O campo Observação é um campo livre que tem por objetivo identificar qual a utilização deste parâmetro.

Obs.: O campo Valor, agora permitirá informar palavras reservadas sendo:

  • TODAY: Retorna a data atual.
  • TIME: Retorna a hora atual.
  • USER: Retorna o usuário logado.
  • COMPANY: Retorna a empresa logada.


Dados Inclusão/Alteração Agendamento

CampoDescrição
Data inclusãoData em que o agendamento da tarefa foi criado.
Hora inclusãoHorário em que o agendamento da tarefa foi criado.
Data atualizaçãoData em que o agendamento teve manutenção/atualização.
Hora atualizaçãoHorário em que o agendamento teve manutenção/atualização.
Responsável atualizaçãoCódigo do usuário que foi responsável pela última atualização do agendamento.


Obs: Todos os dados da "Inclusão/Alteração Agendamento" são preenchidos automaticamente.


Conteúdos Relacionados



LINKS ÚTEIS 

CONSOLE DE ATUALIZAÇÃO LOGIX

Como instalar o Console de Atualização Logix

Como configurar o Console de Atualização Logix

Como utilizar o Console de Atualização Logix


PÁGINA CENTRALIZADORA LGPD LOGIX

LGPD - Lei Geral de Proteção de Dados - Linha Logix


AGENDADOR DE TAREFAS LOGIX

Guia de Configuração e uso do Agendador de Tarefas