Conteúdo

Índice

minLevel	2

02. Informações

Leia os documentos de referência do TOTVS Privacidade de Dados.

O produto Datasul faz o uso do Smart Link, que é um mecanismo de troca de mensagens entre aplicações TOTVSApps e aplicações OnPremises (ou remotas).

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

Obtenha informações (client, secret, name e id) do seu tenant para poder realizar as configurações necessárias nos prximos passos.

03. Instalação

Extrair os arquivos do arquivo compactado

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

Abaixo um exemplo:

O nome da pasta extraida é dts-smart-link-client, e o complemento com o nome do tenant para exemplo é -totvs-fwk.
- Exemplo: C:\TOTVS\dts-smart-link-client-totvs-fwk
Como resultado temos a estrutura abaixo:
- C:\TOTVS\dts-smart-link-client-totvs-fwk\README.txt
- C:\TOTVS\dts-smart-link-client-totvs-fwk\lib\application.yml
- C:\TOTVS\dts-smart-link-client-totvs-fwk\lib\dts-smart-link-client.jar
- C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat
- C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\JavaService.exe
- C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\uninstall.bat

Instalador de serviço para Windows

Editar o arquivo "C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat"

Expandir

title	Nome do serviço

Sugerimos o uso do nome do seu tenant para complementar e facilitar a organização do serviço.
Exemplo: TOTVS-DTS-SMART-LINK-CLIENT-totvs-fwk (O nome do serviço é TOTVS-DTS-SMART-LINK-CLIENT, e o complemento é -totvs-fwk)

Expandir

title	Descrição do serviço

A descrição também pode ser alterada.

Expandir

title	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 váriavel de ambiente já existente.

Expandir

title	Parâmetros

Informe a localização do arquivo dts-smart-link-client.jar no parâmetro -Djava.class.path
- "C:\TOTVS\dts-smart-link-client-totvs-fwk\lib\dts-smart-link-client.jar"
Informe a localização da pasta onde está localizado o arquivo dts-smart-link-client.jar no parâmetro -current
- "C:\TOTVS\dts-smart-link-client-totvs-fwk\lib"
Informe o arquivo de log de erros para o parâmetro -err
- "C:/TOTVS/dts-smart-link-client-totvs-fwk/lib/log/dts-smart-link-client_err.log"

Instalação do serviço:

Execute Prompt de Comando como administrador
Acesse o o arquivo "C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat"
Serviço instalado:

04. Configuração

# SERVER

A porta de acesso da aplicação pode ser alterado na prorpriedade:

Bloco de código

theme	RDark

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

Bloco de código

theme	RDark

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

Bloco de código

theme	RDark

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

# SMART LINK CLIENT

Bloco de código

theme	RDark

# -------------------------------------------------
# SMART LINK CLIENT
# -------------------------------------------------
totvs:
  link:
    auth:
      url: https://INORMAR-NOME-TENANT.rac.INFORMAR-DEV-PROD-STAGING.totvs.app/totvs.rac/connect/token
      client: INFORMAR-CLIENT
      secret: INFORMAR-SECRET
    client:
      subscriptions:      
        - SGDPDataCommand
        - SGDPMaskCommand
    server:
      host: link.INFORMAR-DEV-PROD-STAGING.totvs.app
      port: 443
      secure: true
  tenant:
    name: INORMAR-NOME-TENANT
    id: INORMAR-ID-TENANT   
  datasul:
    url: 'INFORMAR_URL_DATASUL'
    username: 'INFORMAR_USUÁRIO_DATASUL'
    password: 'INFORMAR_SENHA_USUÁRIO'
    #linkClientUrl: 'INFORMAR_URL_SMART_LINK_CLIENT'
    companies:
      - 'INFORMAR_CÓDIGO_EMPRESA'      
    tpdDisabled: false
    jboss: false

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

Expandir

title	Smart Link Client Java

O Smart Link Client Java é uma bibloteca 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:

Bloco de código

theme	RDark

totvs:
  link:
    server:
      host: link.INFORMAR-DEV-PROD-STAGING.totvs.app
      port: 443
      secure: true

INFORMAR-DEV-PROD-STAGING: Subistituir pelo tipo do seu ambient tenant (dev, prod, staging)
Exemplo: link.staging.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:

Bloco de código

theme	RDark

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

O produto Datasul está preparado para processar os tipos SGDPDataCommand e SGDPMaskCommand, o arquivo application.yml já possui essa configuração.

Expandir

title	Smart Link Client Single Tenant

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

Bloco de código

theme	RDark

totvs:
  link:
    auth:
      url: https://INORMAR-NOME-TENANT.rac.INFORMAR-DEV-PROD-STAGING.totvs.app/totvs.rac/connect/token
      client: INFORMAR-CLIENT
      secret: INFORMAR-SECRET

INFORMAR-DEV-PROD-STAGING: Subistituir pelo tipo do seu ambient tenant (dev, prod, staging).
INFORMAR-CLIENT: Subistituir pelo valor do seu client.
INFORMAR-SECRET: Subistituir pelo valor da sua secret.

Expandir

title	Tenant

Informar os valores do seu Tenant:

Bloco de código

theme	RDark

totvs:
  tenant:
    name: INORMAR-NOME-TENANT
    id: INORMAR-ID-TENANT

INORMAR-NOME-TENANT: Subistituir pelo valor do seu tenant.
INORMAR-ID-TENANT: Subistituir pelo valor do id do seu tenant.

Expandir

title	Datasul

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

Bloco de código

theme	RDark

totvs:
  datasul:
    url: 'INFORMAR_URL_DATASUL'
    username: 'INFORMAR_USUÁRIO_DATASUL'
    password: 'INFORMAR_SENHA_USUÁRIO'
    #linkClientUrl: 'INFORMAR_URL_SMART_LINK_CLIENT'
    companies:
      - 'INFORMAR_CÓDIGO_EMPRESA'
    tpdDisabled: false
    jboss: false

INFORMAR_URL_DATASUL: Subistituir pelo valor do seu ambiente Datasul.
- Exemplo: 'http://localhost:8080'
INFORMAR_USUÁRIO_DATASUL: Subistituir pelo valor de um usuário existente no Datasul.
INFORMAR_SENHA_USUÁRIO: Subistituir pelo valor da senha do usuário.
INFORMAR_CÓDIGO_EMPRESA: Subistituir pelo valor do código da empresa
- A integração pode ser para mais de uma empresa, basta adicionar na sequencia respeitando o espaçamento do arquivo .yml
- Bloco de código
  totvs: datasul: companies: - '10' - 'TST' - 'E11'
Configuração tpdDisabled: Caso tenha a necessidade em desativar a integração altere o valor para true
Configuração jboss: Caso utilize a antiga arquitetura Jboss altere o valor para true
Configuração linkClientUrl:
- Essa configuração recebe por padrão o valor 'http://SERVIDOR:PORTA'
  - SERVIDOR: Servidor que está executando o processador de mensagens dts-smart-link-client.jar
  - PORTA: Valor da porta (server: port) da configuração #SERVER

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

05. Iniciar o serviço instalado

Após ter realizados as etapas anteriores, basta iniciar o serviço instalado e verificar se tudo ocorreu com sucesso por meio do log.

Started Application

Bloco de código

theme	RDark

INFO 3528 --- [main] com.totvs.link.client.Application : Started Application in 8.771 seconds (JVM running for 9.392)

Ao iniciar o serviço serão feitas algumas requisições, sendo elas:

Solicitação do metadado padrão quer será enviado para o TOTVS Privacidade de Dados.

Bloco de código

theme	RDark

{
  "header": {
    "type": "SGDPUpdateApplicationMetadata"
  },
  "content": {
    "models": {
      
    },
    "codes": {
      
    },
    "package": "Datasul",
    "productId": "Datasul",
    "readOnly": true,
    "smartLink": "singleTenant",
    "localLogs": false,
    "applicationId": "Datasul"
  }
}

Envio de configurações para o Datasul:

Bloco de código

theme	RDark

{
  "subscriptions": "SGDPDataCommand,SGDPMaskCommand",
  "linkClientUrl": "http://----:8777",
  "tpdDisabled": false
}

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

Bloco de código

theme	RDark

INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.readyEvent]
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration (totvs.datasul)
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration jboss: false
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration tpdDisabled: false
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration username: ----
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration url: http://----:8380/
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration password: *********
INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup   : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration companies: [10] 
INFO 3528 --- [main] c.t.l.c.d.DatasulSyncDefaultMetadata     : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadata.sync]
INFO 3528 --- [main] c.t.l.client.datasul.DatasulSendMessage  : [SMART-LINK-CLIENT][DatasulSendMessage.send][REQUEST][GET][HTTP_1_1] to http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.client.datasul.DatasulSendMessage  : [SMART-LINK-CLIENT][DatasulSendMessage.send][RESPONSE][GET][200] from http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.c.d.DatasulSyncDefaultMetadata     : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadata.sync] Sending message to Smart Link Server - type: SGDPUpdateApplicationMetadata - metadado: {"header":{"type":"SGDPUpdateApplicationMetadata"},"content":{"models":{},"codes":{},"package":"Datasul","productId":"Datasul","readOnly":true,"smartLink":"singleTenant","localLogs":false,"applicationId":"Datasul"}}
INFO 3528 --- [main] c.t.l.c.d.DatasulSyncDefaultMetadata     : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadata.sync] Sent to Smart Link Server
INFO 3528 --- [main] c.t.l.c.datasul.DatasulUpdateProperties  : [SMART-LINK-CLIENT][DatasulUpdateProperties.update]
INFO 3528 --- [main] c.t.l.c.datasul.DatasulUpdateProperties  : [SMART-LINK-CLIENT][DatasulUpdateProperties.update] {"subscriptions":"SGDPDataCommand,SGDPMaskCommand","linkClientUrl":"http://----:8777","tpdDisabled":false}
INFO 3528 --- [main] c.t.l.client.datasul.DatasulSendMessage  : [SMART-LINK-CLIENT][DatasulSendMessage.send][REQUEST][POST][HTTP_1_1] to http://----:8380/api/btb/v1/properties/integrations/totvslinkclient
INFO 3528 --- [main] c.t.l.client.datasul.DatasulSendMessage  : [SMART-LINK-CLIENT][DatasulSendMessage.send][RESPONSE][POST][200] from http://----:8380/api/btb/v1/properties/integrations/totvslinkclient
INFO 3528 --- [main] c.t.l.c.datasul.DatasulUpdateProperties  : [SMART-LINK-CLIENT][DatasulUpdateProperties.update] OK

Árvore de páginas

Versões comparadas

Versão antiga 31

Nova versão 32

Chave

Conteúdo

01. Objetivo

02. Informações

03. Instalação

04. Configuração

05. Iniciar o serviço instalado

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 31

Nova versão 32

Chave

Conteúdo

01. Objetivo

02. Informações

03. Instalação

04. Configuração

05. Iniciar o serviço instalado