Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Conteúdo
Índice minLevel 2
01. Objetivo
Esta documentação tem a finalidade de servir como uma guia no momento da integração com o TOTVS Privacidade de Dados. 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
Leia 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 On Premises (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 próximos passos.
03. Instalação
Copiar arquivo compactado
O arquivo está localizado no diretório do Foundation srcfnd/interfac/smart-link/dts-smart-link-clientsmartlink-service.zip
Extrair os arquivos do arquivo compactado
Expandir | ||
---|---|---|
| ||
Extrair os arquivos em um deretório diretório de sua escolha, sugerimos o uso do nome do seu tenant para complementar e facilitar a organização dos aterfatos. Exemplo:
|
Instalador de serviço para Windows
| ||
Expandir | ||
---|---|---|
| ||
Editar o arquivo "
Expandir | | |
|
Instalador de serviço para Windows
Expandir | ||
---|---|---|
| Descrição do serviço | |
|
Expandir | ||
---|---|---|
| ||
|
Expandir | ||
---|---|---|
| ||
|
Instalação do serviço:
- Execute Prompt de Comando como administrador
- Execute o arquivo
install.bat
- Image Removed
- Serviço instalado:
- Image Removed
Desinstalador de serviço para Windows
Expandir | ||
---|---|---|
| ||
Editar o arquivo
Desinstalação do serviço:
|
Instalador de serviço para Linux
| |||||||||||||||||||||||||||
Editar o arquivo
Instalação do serviço:
|
Desinstalador de serviço para Windows
Expandir | ||
---|---|---|
| ||
Editar o arquivo
Desinstalação do serviço:
|
Instalador de serviço para Linux
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Para a instalação do serviço no Linux certifique-se de que os passos a seguir foram realizados:
Instalando o serviço:
|
Desinstalador de serviço para Linux
Expandir | ||
---|---|---|
| ||
|
04. Configuração
Arquivo de configuração
Arquivo de configuração application.yml
.
Utilizando a pasta de exemplo dos passos anteriores, podemos encontrar o arquivo em: "/client/application.yml"
Configurações do arquivo application.yml
Aviso |
---|
Leia com atenção o detalhamento das configurações abaixo: |
# SERVER
A porta de acesso da aplicação pode ser alterado na propriedade:
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SERVER
# -------------------------------------------------
server:
port: 8777 |
# SPRING
Por padrão estamos utilizando 10MB para poder trafegar metadado no formato JSON.
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SPRING
# -------------------------------------------------
spring:
codec:
max-in-memory-size: 10MB |
# LOG
O nome do arquivo de log pode ser alterado na propriedade:
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# LOG
# -------------------------------------------------
logging:
file:
name: log/smart-link-client.log |
# SPRING ACTUATOR
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SPRING ACTUATOR
# -------------------------------------------------
management:
endpoints:
web:
exposure:
include: "*"
base-path: "/doc-hc" |
# SMART LINK CLIENT
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# 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
application:
url: 'INFORMAR_URL_DATASUL'
username: 'INFORMAR_USUÁRIO'
password: 'INFORMAR_SENHA'
messages:
- type: SGDPDataResponse
- type: SGDPMaskResponse
- type: SGDPLogsResponse
- type: SGDPUpdateTenantMetadata
audiences |
title | Procedimento |
---|
Desinstalador de serviço para Linux
title | Procedimento |
---|
04. Configuração
Arquvio de configuração
Arquivo de configuração application.yml
.
Utilizando a pasta de exemplo dos passos anteriores, podemos encontrar o arquivo em: "/client/application.yml"
Configurações do arquivo application.yml
Aviso |
---|
Leia com atenção o detalhamento das configurações abaixo: |
# SERVER
A porta de acesso da aplicação pode ser alterado na prorpriedade:
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SERVER
# -------------------------------------------------
server:
port: 8777 |
# SPRING
Por padrão estamos utilizando 10MB para poder trafegar metadado no formato JSON.
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SPRING
# -------------------------------------------------
spring:
codec:
max-in-memory-size: 10MB |
# LOG
O nome do arquivo de log pode ser alterado na propriedade:
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# LOG
# -------------------------------------------------
logging:
file:
name: log/dts-smart-link-client.log |
# SMART LINK CLIENT
Bloco de código | ||||
---|---|---|---|---|
| ||||
# -------------------------------------------------
# SMART LINK CLIENT
# -------------------------------------------------
totvs:
link:
auth:
url: INFORMAR_URL_RAC
client: INFORMAR-CLIENT
secret: INFORMAR-SECRET
client:
subscriptions:
- SGDPDataCommand
- SGDPMaskCommand
server:
host: INFORMAR_HOST
port: 443
secure: true
tenant:
name: INORMAR-NOME-TENANT
id: INORMAR-ID-TENANT
product:
name: 'Datasul'
url: 'INFORMAR_URL_DATASUL'
username: 'INFORMAR_USUÁRIO'
password: 'INFORMAR_SENHA'
companies:
- 'INFORMAR_CÓDIGO_EMPRESA' |
Aviso |
---|
Leia com atenção o detalhamento das configurações abaixo: |
Expandir | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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:
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 | | |||||||
| ||||||||
Expandir | ||||||||
| ||||||||
O produto Datasul suporta apenas o single tenant, é necessária a seguinte configuração: Bloco de código | | |||||||
|
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Informar os valores do seu Tenant:
|
route: api/sec/v1/sgdp/commands
dataSources:
- companyId: 'INFORMAR_CÓDIGO_EMPRESA'
rpw: 'INFORMAR_EMPRESA:INFORMAR_RPW'
- subscription: SGDPMaskCommand
route: api/sec/v1/sgdp/commands
dataSources:
- companyId: 'INFORMAR_CÓDIGO_EMPRESA'
rpw: 'INFORMAR_EMPRESA:INFORMAR_RPW'
- subscription: SGDPLogsCommand
route: api/sec/v1/sgdp/commands
dataSources:
- companyId: 'INFORMAR_CÓDIGO_EMPRESA'
rpw: 'INFORMAR_EMPRESA:INFORMAR_RPW' |
Aviso |
---|
Leia com atenção o detalhamento das configurações abaixo: |
Expandir | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
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: | |||||||||||||||||||||
Expandir | |||||||||||||||||||||
| |||||||||||||||||||||
A comunicação acontece nos dois sentidos (TOTVS Privacidade de Dados > Datasul) e (Datasul > TOTVS Privacidade de Dados) por meio das configurações abaixo:
INFORMAR_URL_DATASUL : Subistituir pelo valor do seu ambiente Datasul.
INFORMAR_USUÁRIO : Subistituir pelo valor de um usuário existente no Datasul. INFORMAR_SENHA : Subistituir pelo valor da senha do usuário.INFORMAR_CÓDIGO_EMPRESA : Subistituir pelo valor do código da empresaA integração pode ser para mais de uma empresa, basta adicionar outras empresas respeitando o formato/espaçamento do arquivo .yml
|
Expandir | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
O produto Datasul suporta apenas o single tenant, é necessária a seguinte configuração: Configurações que não são obrigatórias:Adicionar a configuraçãotpdDisabled para desativar a comunicação do entre o Smart Link Client e o Produto Datasul.
jboss para indicar a antiga arquitetura. Bloco de código | | |||||||||
|
url: INFORMAR_URL_RAC client: INFORMAR-CLIENT |
secret: |
INFORMAR-SECRET |
- INFORMAR_URL_RAC: Utilizar a url conforme o tipo do seu ambiente:
- 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
- DEV:
- INFORMAR-CLIENT: Substituir pelo valor do seu client.
- INFORMAR-SECRET: Substituir pelo valor da sua secret.
Expandir | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Caso necessário, adicionar a configuração linkClientUrl para indicar onde está o LINK Client Java Application .
Informar os valores do seu Tenant :
Informações |
|
Expandir | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
A comunicação acontece nos dois sentidos (TOTVS Privacidade de Dados > Datasul) e (Datasul > TOTVS Privacidade de Dados) por meio das configurações abaixo: Ao informar o endereço de um ambiente Datasul com protocolo HTTPS na configuraçãototvs.product.url , leia Procedimento HTTPS.
|
05. Iniciar o serviço instalado
|
05. Iniciar o 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
Bloco de código | ||
---|---|---|
|
Após concluir as etapas anteriores, basta iniciar o serviço instalado e verificar no log se a aplicação foi inciada com sucesso.
Starting Application
Bloco de código | ||
---|---|---|
| ||
INFO 15788 --- [main] com.totvs.link.client.Application : Starting Application v12.1.34-NFRW-SNAPSHOT on 00000 with PID 15788 (C:\TOTVS\dts-smart-link-client\client\dts-smart-link-client.jar started by 00000$ in C:\TOTVS\dts-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.ThreadPoolTaskSchedulerApplication : Starting Application : Initializing ExecutorService 'taskScheduler' INFO 15788 --- [main] o.s.b.web.embedded.netty.NettyWebServer : Netty started on port(s): 8777v12.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 : Started Application in 4.994 seconds |
Após o Started Application serão executados os processos:
Expandir | ||||
---|---|---|---|---|
| ||||
Bloco de código | | |||
| ||||
Expandir | ||||
| ||||
Bloco de código | | |||
|
Para facilitar a visualização de log foi adicionada a infomação [SMART-LINK-CLIENT] no LOG para as classes java implementadas.
Bloco de código | ||
---|---|---|
| ||
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.product) INFO 3528 --- [main] c.totvs.link.client.ApplicationStartup : [SMART-LINK-CLIENT][ApplicationStartup.showConfiguration] Configuration name: Datasul 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.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":"Datasul","productId":"Datasul","readOnly":true,"smartLink":"singleTenant","localLogs":false,"applicationId":"Datasul"}} INFO 3528 --- [main] c.t.l.c.d.ProductSyncDefaultMetadata : [SMART-LINK-CLIENT][ProductSyncDefaultMetadata.sync] Sent to Smart Link Server INFO 3528 --- [main] c.t.l.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update] INFO 3528 --- [main] c.t.l.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update] {"companies":["10"],"subscriptions":["SGDPDataCommand","SGDPMaskCommand"],"linkClientUrl":"http://----:8777","tpdDisabled":false} INFO 3528 --- [main] c.t.l.client.product.ProductSendMessage : [SMART-LINK-CLIENT][ProductSendMessage.send][REQUEST][POST] to http://----:8380/api/btb/v1/properties/integrations/totvslinkclient INFO 3528 --- [main] c.t.l.client.product.ProductSendMessage : [SMART-LINK-CLIENT][ProductSendMessage.send][RESPONSE][POST][200] from http://----:8380/api/btb/v1/properties/integrations/totvslinkclient INFO 3528 --- [main] c.t.l.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update] OK |