04. Configuração
O arquivo de configuração application.yml
está localizado na pasta lib.
Utilizando a pasta de exemplo dos passos anteriores, podemos encontrar o arquivo em: C:/TOTVS/dts-smart-link-client-totvs-fwk/lib/application.yml
Configurações do arquivo application.yml
Aviso |
---|
Leia com atenção o detalhamento das configurações abaixo: |
A porta de acesso da aplicação pode ser alterado na prorpriedade:
Bloco de código |
---|
|
# -------------------------------------------------
# SERVER
# -------------------------------------------------
server:
port: 8777 |
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.server.server.portPor padrão estamos utilizando 10MB para poder trafegar metadado no formato JSON.
Bloco de código |
---|
|
# -------------------------------------------------
# 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
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 |
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.core.logging.file.name 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
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 |
---|
| totvs:
link:
server:
host: INFORMAR_HOST
port: 443
secure: true |
- INFORMAR_HOST: Utilizar o host conforme o tipo do seu ambiente:
- DEV:
link.dev.totvs.app - STAGING:
link.staging.totvs.app - PROD:
link.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 |
---|
| 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 |
---|
| totvs:
link:
auth:
url: INFORMAR_URL_RAC
client: INFORMAR-CLIENT
secret: INFORMAR-SECRET |
- INORMAR-NOME-TENANT: Subistituir pelo nome do seu tenant.
- INFORMAR_URL_RAC: Utilizar a url conforme o tipo do seu ambiente:
- DEV:
https://INORMAR-NOME-TENANT.rac.dev.totvs.app/totvs.rac/connect/token - STAGING:
https://INORMAR-NOME-TENANT.rac.staging.totvs.app/totvs.rac/connect/token - PROD
https://INORMAR-NOME-TENANT.rac.totvs.app/totvs.rac/connect/token
- 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 |
---|
|
Informar os valores do seu Tenant: Bloco de código |
---|
| totvs:
tenant:
name: INORMAR-NOME-TENANT
id: INORMAR-ID-TENANT |
- INORMAR-NOME-TENANT: Subistituir pelo nome do seu tenant.
- INORMAR-ID-TENANT: Subistituir pelo valor do id do seu tenant.
|
Expandir |
---|
|
Aviso |
---|
Utilize aspas simples para valores do tipo texto ao informar as configurações do 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 |
---|
|
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 outras empresas respeitando o formato/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
:- A configuração está comentada (#)
- A 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
- Caso precise adicionar um valor diferente do padrão, retire o comentário # e informe o valor 'http://SERVIDOR:PORTA'
Informações |
---|
Ao informar o endereço de um ambiente Datasul com protocolo HTTPS na configuração abaixo, deve ser realizado o Procedimento HTTPS.
05. Iniciar o serviço instalado
Bloco de código |
---|
|
totvs:
datasul:
url: 'https://meu-servidor:8080' |
Expandir |
---|
|
05. Iniciar o serviço instalado
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.datasulproduct)
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: falsename: 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.DatasulSyncDefaultMetadataProductSyncDefaultMetadata : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadataProductSyncDefaultMetadata.sync]
INFO 3528 --- [main] c.t.l.client.datasulproduct.DatasulSendMessageProductSendMessage : [SMART-LINK-CLIENT][DatasulSendMessageProductSendMessage.send][REQUEST][GET] to http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.client.datasulproduct.DatasulSendMessageProductSendMessage : [SMART-LINK-CLIENT][DatasulSendMessageProductSendMessage.send][RESPONSE][GET][200] from http://----:8380/api/sec/v1/sgdp/metadata/default
INFO 3528 --- [main] c.t.l.c.d.DatasulSyncDefaultMetadataProductSyncDefaultMetadata : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadataProductSyncDefaultMetadata.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.DatasulSyncDefaultMetadataProductSyncDefaultMetadata : [SMART-LINK-CLIENT][DatasulSyncDefaultMetadataProductSyncDefaultMetadata.sync] Sent to Smart Link Server
INFO 3528 --- [main] c.t.l.c.datasulproduct.DatasulUpdatePropertiesProductUpdateProperties : [SMART-LINK-CLIENT][DatasulUpdatePropertiesProductUpdateProperties.update]
INFO 3528 --- [main] c.t.l.c.datasulproduct.DatasulUpdatePropertiesProductUpdateProperties : [SMART-LINK-CLIENT][DatasulUpdatePropertiesProductUpdateProperties.update] {"subscriptionscompanies":["SGDPDataCommand,SGDPMaskCommand10"],"companiessubscriptions":["10" SGDPDataCommand","SGDPMaskCommand"],"linkClientUrl":"http://----:8777","tpdDisabled":false}
INFO 3528 --- [main] c.t.l.client.datasulproduct.DatasulSendMessageProductSendMessage : [SMART-LINK-CLIENT][DatasulSendMessageProductSendMessage.send][REQUEST][POST] to http://----:8380/api/btb/v1/properties/integrations/totvslinkclient
INFO 3528 --- [main] c.t.l.client.datasulproduct.DatasulSendMessageProductSendMessage : [SMART-LINK-CLIENT][DatasulSendMessageProductSendMessage.send][RESPONSE][POST][200] from http://----:8380/api/btb/v1/properties/integrations/totvslinkclient
INFO 3528 --- [main] c.t.l.c.datasulproduct.DatasulUpdatePropertiesProductUpdateProperties : [SMART-LINK-CLIENT][DatasulUpdatePropertiesProductUpdateProperties.update] OK |