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

Versões comparadas

Chave

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

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;
  • SmartLinkSmart 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.




Nota

O SmartLink 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).
drawio

Image Added

borderfalsediagramNametriadesimpleViewertruewidthlinksautotbstyletopdiagramDisplayNamelboxtruediagramWidth211revision1

Pré-Requisitos

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

Possuir acesso ao


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.
Painel
borderColorlightgrey
borderWidth1
borderStyledashed

            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.
Painel
borderColorlightgrey
borderWidth1
borderStyledashed

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


    • Obter pacote do

SmartLink
    • Smart Link Client Logix.

Painel
borderColorlightgrey
borderWidth1
borderStyledashed

           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 SmartLink Smart Link versão Client é realizada pelo produto Logix.

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


Painel
borderColorlightgrey
titleColorgreen
borderWidth1
borderStyledashed
titleO que a integração 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ção do Configurações no arquivo no formato YAML utilizado pela ferramenta Smartlink-Smart Link Client no servidor de hospedagem.
Painel
borderColorlightgrey
titleColorred
borderWidth1
borderStyledashed
titleO que ela NÃO FAZ?
  • Apoio sobre assuntos relacionados à ferramenta TPD;
  • Configurações na ferramenta TPD;
  • Manutenção Manutenções e melhorias na ferramenta TPD;
  • Configurações na ferramenta SmartLink-Smart Link Server;
  • Manutenção Manutenções e melhorias na ferramenta SmartLink- 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:


Painel
borderColorlightgrey
borderWidth1
titleBGColor#ADD8E6
borderStyledashed
titlePasso 1 - Processamento de conversores e importação de atualizações Metadado

Na aplicação do pacote da versão pré-requisito, com

Na aplicação destes pacotes (versão de

suporte ao LGPD

)

, automaticamente já estão inclusos os conversores

de tabelas

necessários para criação das tabelas LOG_PRIVATE_xxx e JOB_xxx, bem como os

respectivos XMLs destas tabelas e também dos formulários:
    • LOG10001, log10002, log10003 e log10004;
    • assim como a atualização do  programa JOB0003 que foi ajustado para Registro de tratamento de dados;
  • 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.
    Alteração das tabelas:
    Expandir
    titleClique aqui para saber a lista de conversores necessários...

    Lista de conversores necessários:

    Expandir
    titleClique aqui para saber a lista de conversores necessários...

    Lista de conversores necessários:

    CONVERSOR

    DESCRIÇÃO

    frw00022.cnv 
    • Alteração das tabela: lgpd_attribute e lgpd_process_attribute;
    men00147.cnv
    • Alteração da tabela log_private_process_audit;
    men00146.cnv
    • Alteraçã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;
    men00145.cnv
    • Alteração do tamanho da coluna val_parametro da tabela log_val_parametro para char(100). Situação identificada ao criar parâmetros para atender LGPD na comunicação com o Smartlink Client (parâmetros com prefixo tpd_);
    men00144.cnv
    • Alteração das tabelas: log_private_data_audit e log_private_attribute_audit;
    men00142.cnv
    • Alteração da tabela log_private_mapping_table;
    men00141.cnv
    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;
    men00139
    men00142.cnv
    Alteração das tabelas: ,
    • Criação das tabelas log_private_mapping e log_private_
    attribute
    • mapping_table;
    • Exclusão das tabelas
    • log_private_
    classif
    • allows_
    attribute
    • anonymize e log_private_
    process
    • mapping_attribute;
    men00137
    men00144.cnv
    Alteração
    • Criação das tabelas
    :
    • log_private_
    process
    • data_
    attribute
    • audit e log_private_
    process
    • attribute_audit;
    men00136
    men00145.cnv
    • Alteração
    das tabelas:
    • 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_
    attribute
    • main, log_private_
    classif_attribute e
    • job_main_param, log_private_
    process_attribute
    • 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.
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    • Importar o conversor de parâmetros de Privacidade de Dados que, teoricamente, já é aplicado automaticamente na atualização de pacote Logix;
    • Será preciso também liberar a permissão de acesso a estes parâmetros via opção de permissão de acesso no programa LOG00086 (opção Níveis de acesso).
    Expandir
    titleClique aqui para saber a lista de parâmetros necessários...
    •  Caso já não tenha sido importado o arquivo CNV na base, é necessário fazer esse processo:
      1. Obter o arquivo cnv frw00023.cnv e disponibilizar o mesmo no diretório onde o programa log00086 acessa os 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, selecionar ele e salvar;
      5. Em seguida executar o processamento no Botão PROCESSSAR;
      6. Também é necessário dar permissão para que o usuário possa acessar os novos parâmetros;
      7. Acessar a opção Níveis de Acesso, pesquisar pelo usuário que terá permissão;
      8. Modificar o registro e na lista apresentada na Grip, verificar que Adminstração Logix está com Permissão PARCIAL, mudar para TOTAL;
      9. Se acessar o ícone Zoom ao lado poderá verificar que existe Controle Geral , nessa opção tem outro ZOOM , ao acessá-lo é possível ver a Rotina Smart Link - TPC;
      10. Salvar a alteração;
      11. Ir até Manutenção Parâmetros, abrir a Árvore Administração Logix - Controle Geral e será apresentada a Rotina Smart Link - TPD, dentro da rotinha estão os novos Parâmetros.
    • Caso o conversor já tenha sido processado na base basta seguir o passo 11.
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    • Importar o arquivo private_data.mzp existente no pacote de atualização Logix via LOG10005 (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.
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    • Executar o botão de auditoria do LOG10000 para ativar os gatilhos (triggers) das tabelas atuais já previstas no cadastro de dados protegidos importados.
    • Lembrando que esta ação precisa ser executada quando houver permissão de acesso no banco de dados para registro das triggers, ou seja, o sistema não poderá estar em uso pelos usuários.
    • Após isso, os registros de auditoria de dados já passarão a ser gerados para alimentar as informações necessárias para opção de registro de tratamento de dados do TPD.
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    • Configurar e ativar o Agendador de Tarefas Logix, para que na execução de requisições do TPD que sejam processadas pelo Logix utilizando os JOBs do agendador de tarefas e, estas possam ser devidamente executadas para que as requisições sejam processadas e retornadas para o TPD.
    • Lembrando que este serviço sempre deverá estar no ar a partir do momento em que o TPD x LOGIX já estiver disponível para uso.
    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
    Informações
    titleLEMBRETE

    (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)




    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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").

    Expandir
    titleClique aqui para saber o passo a passo de como liberar a permissão 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.




    • Configurar AppServer Logix REST para receber as requisições do TPD.
    • Configurar parâmetros relacionados a Privacidade de Dados no Logix no programa LOG00086.
    • 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

    • Instalar e configurar o Smartlink Client com base nos dados do TPD e Rest Logix já disponíveis para comunicação e, realizar os testes de comunicação do SmartlinkClient X TPD e SmartlinkClient X Logix:
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse aqui para ver sobre REST Logix...
    Incluir Página
    LGX - Comunicação RESTLGX - Comunicação REST
    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    Expandir
    titleClique aqui para saber a lista de parâmetros necessários...
    ParâmetroDescriçã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).

    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.

    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.

    URL do RAC
    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

    Porta do servidor para protocolo GRPC
    • Porta do servidor para utilização no protocolo GRPC.
    • Por padrão utiliza-se a porta 443.
    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).
    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)

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

    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.
    Subscrição Consulta de Dados Pessoais
    • Deve ser informado se a Consulta de dados pessoais está ativa.
    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleConfigurando Integração com o TOTVS Privacidade de Dados...
    Incluir Página
    LGX - Configurando Integração com o TOTVS Privacidade de DadosLGX - Configurando Integração com o TOTVS Privacidade de Dados

    Datasul

    Insira aqui as informações pertinentes a Datasul.

    Logix

    Insira aqui as informações pertinentes ao Logix.

    Protheus

    Insira aqui as informações pertinentes ao Protheus.

    RM

    Insira aqui as informações pertinentes ao RM.

    Instalação/Atualização

    Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:

    • Procedimentos que devem ser observados quando um dos produtos for atualizado.
    • Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
    • Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
    • Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
    • Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
    • Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
    • Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.

     

    Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.

    Datasul

    Insira aqui as informações pertinentes a Datasul.

    Logix

    Insira aqui as informações pertinentes ao Logix.

    Protheus

    Insira aqui as informações pertinentes ao Protheus.

    RM

    Insira aqui as informações pertinentes ao RM.

    Controle de Versão

    O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

    Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

    Suporte

    O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

    Observação: Este modelo de suporte está sendo revisado pela TOTVS.

    Transações/Entidades/Mensagens únicas

    Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.

    Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.

    Exemplos:

     

     Image Removed

    Image Removed

    Método

    ID

    Descrição

    Origem

    Destino

    XSD (versões podem variar)

    Cadastros

    01

    Cliente/Fornecedor

    RM

    Protheus

    CustomerVendor_1_000.xsd

    02

    Moeda

    RM

    Protheus

    Currency_1_000.xsd

    03

    Unidade de Medida

    RM

    Protheus

    UnitOfMeasure_1_000.xsd

    04

    Produto

    RM

    Protheus

    Item_?_000.xsd

    05

    Centro de Custo

    RM

    Protheus

    CostCenter_1_000.xsd

    06

    Ativos

    RM

    Protheus

    NOVA, Ativo fixo

    07

    Funcionários

    RM

    Protheus

    Employee_1_000.xsd

    08

    Projeto

    RM

    Protheus

    Project_1_000.xsd

    09

    Obra

    RM

    Protheus

    SubProject_1_000.xsd

    10

    Tarefa

    RM

    Protheus

    TaskProject_1_000.xsd

    11

    Meio de Pagamento

    RM

    Protheus

    ?????.xsd

    12

    Condições de pagamento

    RM

    Protheus

    PaymentCondition_1_000.xsd

    13

    Coligada*
    * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

    RM

    Protheus

    Company_1_000.xsd

    14

    Filial*
    * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

    RM

    Protheus

    Branch_2_000.xsd

    Processos

    15

    Solicitações (compras/armazém)

    Protheus

    RM

    Request_1_000.xsd

    16

    Cancelar movimento (solicitação, OS, etc)

    Protheus

    RM

    CancelRequest_1_000.xsd

    17

    Cancelar movimento (solicitação, OS, etc)

    RM

    Protheus

    CancelRequest_1_000.xsd

    18

    Baixa de estoque

    Protheus

    RM

    Request_1_000.xsd

    19

    Baixa de estoque

    RM

    Protheus

    Request_1_000.xsd

    20

    Consulta Saldo

    Protheus

    RM

    21

    Apropriação de custos

    Request _1_000.xsd

    22

    Geração de OS

    23

    Consulta de OS

    24

    Ampliação patrimonial

    Fluxo das Informações

     

    Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

    Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

    Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

    Cadastros

    Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

    Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

    Em seguida faça uma descrição para cada um dos fluxos para cada entidade

     

    <Transação/Entidade>

    Identificador da Mensagem: <mensagem>

    Versão: <versão>

    Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

    Módulo <marca 2>: <SIGAXXX>

    Tipo de Envio: <Assíncrona/Síncrona>

    Mensagem Padrão

    PROTHEUS

    RM

    Tabela

    Campo

    Tabela

    Campo

    Code

    CTO990

    CTO_SIMB

    GMOEDA

    SIMBOLO *

    Description

    CTO990

    CTO_DESC

    GMOEDA

    DESCRICAO

    Symbol

    CTO990

    CTO_SIMB

    GMOEDA

    SIMBOLO

    Notas:

    Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

    A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

    Limitações/Restrições

    Descreva limitações e restrições para a integração que está sendo descrita.

    Processos

    Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

    Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

    Em seguida faça uma descrição para cada um dos fluxos para cada entidade

     

    <Transação/Processo>

    Tipo de Fluxo: Protheus -> RM

    Mensagem: Request_1_000

    Versão: 1.000

    Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

    Acrescentar um diagrama do processo.

    A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

    Notas:

    Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

    Limitações/Restrições

    Descreva limitações e restrições para a integração que está sendo descrita. 

    titlePasso 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:


    Informações
    iconfalse

    (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.  

    Expandir
    titleVeja aqui o passo a passo para cadastro no menu no LOG00112

    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 Image Added, onde:

    Transação: LGPD

    Descrição: Dados Protegidos (LGPD)

    Acione o botão Image Added

    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 Image Addedonde:

    Transação: LOG10005

    Descrição: Central de Dados Protegidos

    Processo: log10005

    Tipo Processo:

    Chave Sistema: PADRAO

    Acione o botão Image Added


    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.

    Expandir
    titleVeja aqui o passo a passo para cadastro no menu no LOG00112

    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 Image Added, onde:

    Transação: JOBSCHEDULER

    Descrição: Agendamento de Tarefas

    Acione o botão Image Added

    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 Image Addedonde:

    Transação: JOB0003

    Descrição: Agenda de tarefas (Gatilhos)

    Processo: job0003

    Tipo Processo:

    Chave Sistema: PADRAO

    Acione o botão Image Added


    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)


    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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.


    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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
    titleDICA

    (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.

    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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.


    Dica
    titleATENÇÃ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


    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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.


    Expandir
    titleClique aqui para ver sobre REST Logix...

    Incluir Página
    LGX - Comunicação REST
    LGX - Comunicação REST

    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 7 - Configuração dos parâmetros

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


    Expandir
    titleClique aqui para saber a lista de parâmetros necessários...
    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
    Painel
    borderColorlightgrey
    borderWidth1
    titleBGColor#ADD8E6
    borderStyledashed
    titlePasso 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:


    Expandir
    titleConfigurando Integração com o TOTVS Privacidade de Dados...

    Incluir Página
    LGX - Configurando Integração com o TOTVS Privacidade de Dados
    LGX - Configurando Integração com o TOTVS Privacidade de Dados




    Painel
    borderColorgreen
    borderWidth3
    borderStyledashed
    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:


    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed

             Configurador de dados pessoais e sensíveis (LOG10000)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse a documentação do LOG10000...

    Incluir Página
    Configurador de dados pessoais e sensíveis (LOG10000)
    Configurador de dados pessoais e sensíveis (LOG10000)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed

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

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse a documentação do LOG10003...

    Incluir Página
    Mapeamento de campos por vínculo do titular (LOG10003)
    Mapeamento de campos por vínculo do titular (LOG10003)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed

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

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse a documentação do LOG10004...

    Incluir Página
    Mapeamento de tabelas por vínculo do titular (LOG10004)
    Mapeamento de tabelas por vínculo do titular (LOG10004)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed

             Configurador de dados pessoais e sensíveis (LOG10000)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse a documentação do LOG10005...

    Incluir Página
    Central de dados protegidos (LOG10005)
    Central de dados protegidos (LOG10005)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed

            Cadastro de agendamento de tarefas (JOB0003)

    Painel
    borderColorlightgrey
    borderWidth1
    borderStyledashed
    Expandir
    titleAcesse a documentação do JOB0003...

    Incluir Página
    Agendador de Tarefas (JOB0003)
    Agendador de Tarefas (JOB0003)

    Limitações / Restrições Gerais

    Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

    • ERP1 envia ITEM cadastrado para o ERP2

    ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

    Se o tipo de valorização do estoque for FIFO.

    • ERP2 envia PEDIDO cadastrado para o ERP1

    O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

     

    Como fazer (opcional)

    Descreva os passos que viabilizem a integração.

    Exemplo:

    Os passos para viabilizar a integração são:

    • No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
    • No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
    • No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
    • No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
    • No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
    • No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
    • No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
    • No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
    • No Protheus efetuar o faturamento do pedido de venda recebido.
    • No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
    • No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
    • No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).

     

    Situações comuns (opcional)

    Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

    Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

    Exemplo 1:

    Tratamento de erros de integração (Produto A)

    Erro

    Mensagem

    Solução

    Código do erro

    Mensagem exibida

    Ação a ser tomada para resolução do erro.

    Tratamento de erros de integração (Produto B)

    Erro

    Mensagem

    Solução

    Código do erro

    Mensagem exibida

    Ação a ser tomada para resolução do erro.

     

    Exemplo 2:

    Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

    Exemplo:

    Erro ao enviar a mensagem de Cidade via Integração

    Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

    -------------------------------------------------------------------------------

    WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

    ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

    -------------------------------------------------------------------------------

    Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

    Checklist de suporte da aplicação

    Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

    Instalação/Configuração

    Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

    Checklist de Verificações:

    Relacione itens de verificações para que o atendente possa:

    • Identificar o funcionamento da integração;
    • Identificar a ocorrências de problemas;
    • Coletar evidências do mau funcionamento relatado pelo cliente;
    • Realizar possíveis ajustes na integração quanto à configuração ou negócio.
    Anexos