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"

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:

03. 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: 'http://mariscal:8380/'
    username: 'super'
    password: 'super@123'
    #linkClientUrl: 'http://totvsjoi-fwk06:8777'
    companies:
      - '10'      
    tpdDisabled: true
    jboss: false

Leia com atenção as 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

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.

04. Como redefinir a senha

Para redefinir a senha, utilize o serviço passwordReset existente no contexto totvs-login, seguindo as premissas:

O método de requisição é do tipo POST

Não possui autenticação na requisição.

A autorização para redefinição de senha será por meio do código de acesso.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

guid: É o código de acesso, que o usuário recebeu por e-mail;

newPassword: É a nova senha do usuário;

confirmNewPassword: É a confirmação da senha do usuário;

Exemplo:

Expandir

title	Caso não atenda os requisitos acima será retornado erro

Erros sem mensagens: Erro de sintaxe inválida, terá como retorno status 400 Bad Request. Exemplo: Corpo da requisição errada ou sem valor.

Erros com mensagens: são retornadas no formato JSON.

http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset

05. Como modificar a mensagem do e-mail

A modificação da mensagem do e-mail ocorre por meio de um programa registrado, que será responsável pela criação da mensagem do e-mail. A chave do registro do programa deve ser enviada no parâmetro keyTemplate.

http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_REGISTRO>

Expandir

title	Caso não exista registro para chave, será utilizado o e-mail padrão

Expandir

title	Exemplo de e-mail modificado, recebido pelo usuário

Desenvolvendo o programa para modificar a mensagem do e-mail.

A mensagem deve ser criada em formato HTML;

A mensagem não pode utilizar a tag <script>;

Criar programa progress para retornar a mensagem do e-mail, neste programa deve existir a procedure pi-html, tendo como parâmetro de entrada JsonObject e parâmetro de saída CHARACTER.

Expandir

title	Programa de exemplo

O parâmetro de entrada é do tipo JsonObject, será enviado com a estrutura e valores abaixo:

Bloco de código

theme	RDark

{
  "guid": "Código de acesso do usuário",
  "cod_usuario": "Código do usuário",
  "nom_usuario": "Nome do usuário"
  "url": "Servidor e porta configurados em Parâmetros Gerais, Para mais informações leia o conteúdo 02. Configuração",
}

O parâmetro de saída é do tipo CHARACTER, onde deve ser retornada a mensagem HTML.

Bloco de código

theme	RDark
title	Assinatura da Procedure

USING Progress.Json.ObjectModel.*.

{include/i-prgvrs.i EXEMPLO 2.00.00.001 }

PROCEDURE pi-html:
    DEFINE INPUT   PARAMETER jsonIn    AS JsonObject NO-UNDO.
    DEFINE OUTPUT  PARAMETER htmlOut   AS CHARACTER  NO-UNDO.
	
	//Implementar Lógica para criar o retorno HTML    
END PROCEDURE.

Programa de exemplo:

View file

name	exemplo.zip
height	250

Expandir

title	Resultado do e-mail

Como registrar um programa.

O método de requisição é do tipo POST

A requisição precisa de autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.

Não será realizada validação do programa ao registrá-lo.

Caso aconteça algum erro em tempo de execução com o programa registrado, será lançado erro no arquivo de log do servidor de aplicação Progress e será retornada mensagem padrão.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

key: Não pode passar o limite de 20 caracteres. Exemplos: fnd_access_code, app_rh_access_code.

value: Informar o programa responsável pela modificação da mensagem do e-mail.

Bloco de código

theme	RDark

{
  "key": "fnd_access_code",
  "value": "sec/exemplo.r"
}

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates

Como atualizar o registro de um programa.

O método de requisição é do tipo PUT

A requisição precisa de autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

value: Informar o programa responsável pela modificação da mensagem do e-mail.

Bloco de código

theme	RDark

{
  "value": "sec/exemplo.r"
}

Informar a chave do registro na URL.

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code

Árvore de páginas

Versões comparadas

Versão antiga 20

Nova versão 21

Chave

Conteúdo

01. Objetivo

02. Informações

03. Instalação

03. Configuração

04. Como redefinir a senha

05. Como modificar a mensagem do e-mail

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 20

Nova versão 21

Chave

Conteúdo

01. Objetivo

02. Informações

03. Instalação

03. Configuração

04. Como redefinir a senha

05. Como modificar a mensagem do e-mail