Histórico da Página
Conteúdo
Índice minLevel 2
01.
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.
Pré-requisitos
02. Instalação
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 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 próximos passos.
03. Instalação
Instalador de serviço para Linux
title | Procedimento |
---|
Para a instalação do serviço no Linux certifique-se de que os passos a seguir foram realizados:
- Definir a descrição do serviço:
- 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:
- 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.
- Configurar o arquivo application.yml
- Veja a sessão 04 deste documento.
- Editar o arquivo
"/service/Linux/install.sh" localizado onde o projeto foi extraído.
Informar na variável
PATH_SOURCE_SMART_LINK_CLIENT, localizado na linha 13, o local onde o projeto foi extraído.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
#!/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-extraido"/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
title | Atenção |
---|
- O diretório ao 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
03. Configuração
04. Iniciar o serviço instalado
Após concluir as etapas anteriores, basta iniciar o serviço instalado e verificar no arquivo de log se a aplicação foi iniciada com sucesso.
Bloco de código | ||||
---|---|---|---|---|
| ||||
INFO 19980 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8777 (http)
INFO 19980 --- [main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
INFO 19980 --- [main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
INFO 19980 --- [main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 2435 ms
INFO 19980 --- [main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8777 (http) with context path ''
INFO 19980 --- [scheduling-1] com.totvs.link.client.Waiter : Running...
INFO 19980 |
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 |
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.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.f.ld.cs.ds.ProductSyncDefaultMetadataSmartLinkServiceApplication : Started : [SMART-LINK-CLIENT][ProductSyncDefaultMetadata.sync] Sent to Smart Link Server INFO 3528SmartLinkServiceApplication in 6.464 seconds (JVM running for 10.737) INFO 19980 --- [maingrpc-default-executor-0] ccom.ttotvs.llink.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update]client.LinkService: Server is ON INFO 352819980 --- [maingrpc-default-executor-0] ccom.t.l.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update] {"companies":["10"],"subscriptions":["SGDPDataCommand","SGDPMaskCommand"],"linkClientUrl":"http://----:8777","tpdDisabled":false} INFO 3528totvs.link.client.LinkService: Server completed INFO 19980 --- [grpc-default-executor-0] com.totvs.link.client.LinkService: Client setup INFO 19980 --- [maingrpc-default-executor-2] ccom.ttotvs.llink.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 3528LinkService: Client setup result: true INFO 19980 --- [grpc-default-executor-2] com.totvs.link.client.LinkService: Wait for messages INFO 19980 --- [maingrpc-default-executor-1] ccom.ttotvs.llink.c.product.ProductUpdateProperties : [SMART-LINK-CLIENT][ProductUpdateProperties.update] OKclient.LinkService: Client setup completed INFO 19980 --- [grpc-default-executor-0] com.totvs.link.client.LinkService: Wait for messages |