Histórico da Página
O objetivo desta documentação é descrever as etapas necessárias para o processo de integração entre produtos TOTVS Agro com o Smart View, anteriormente chamado de TReports.
Informações | ||
---|---|---|
| ||
Para conhecer mais sobre a integração e uso do Smart View (Relatórios Legados) com TOTVS Agro Multicultivo, consulte o conteúdo da página "Hands-On - Instalação, Configuração e Integração de Smart View com TOTVS Agro Multicultivo". |
Smart View (TReports)
Solução que permite a criação de relatórios de forma simples e rápida, independente de plataforma e linha de produto.
Requisitos para instalação
instalação do TReport
...
...
...
Configurações
TProvider
O projeto Ferramenta TProvider é uma ferramenta solução desenvolvida para prover dados para integracao integração do TReports Smart View com as bases de dados de diferentes produtos TOTVS.
Neste projeto são disponibilizadas APIs para prover a integracão e também um provedor de seguranca (Autenticacao) que é necessário para a utilizacao da nova versão do TReports.
Nova versão do TProvider
O TProvider nesta nova versão deixou de utilizar um servidor o servidor de aplicacão Tomcat a parte e passa a utilizar o servidor tomcat embutido do Spring Boot.
Desta forma, o TProvider deixou de ser compilado como um artefato WAR e passou a ser disponibilizado como um "fat jar", incluindo todas as dependências e bibliotecas necessárias para a sua execucao.
Ambiente de Desenvolvimento
O TProvider para a utilizar a JDK 11 para sua compilacao/execucao, e a IDE de desenvolvido utilizada é o Intellij.
Keycloak
O provedor de seguranca foi implementado utilizando a ferramenta keycloak, embarcada com o framework Spring Boot, e provê os mecanismos de autenticacão e autorizacao a nova versão do TReports.
Mais detalhes sobre o keycloak podem ser encontrados na documentacao oficial da ferramenta: https://www.keycloak.org/
Mais detalhes sobre o provedor de seguranca para o TReports podem ser acessados através do link https://tdn.totvs.com/pages/releaseview.action?pageId=619395492
Banco de dados
Banco de dados para o Keycloak
Os bancos de dados suportados pelo keycloak são:
- PostgreSQL
- Oracle
- MS SqlServer
Para realizar a configuracao do banco de dados em desenvolvimento, basta configurar as propriedades abaixo no arquivo application.yml
keycloak-server:
...
datasource:
driverClassName: oracle.jdbc.OracleDriver
url: jdbc:oracle:thin:@127.0.0.1:1521:ORCL
username: PIMSCS
password: PIMSCS
Configuracao
Para o funcionamento da aplicacão é necessário realizar algumas configuracões prévias no arquivo application.yml, conforme descritas a seguir, além da configuracao do banco de dados do keycloak conforme descrita anteriormente.
server:
address: 127.0.0.1
port: 8080
...
spring:
...
datasource:
driver-class-name: oracle.jdbc.OracleDriver
url: jdbc:oracle:thin:@127.0.0.1:1521:ORCL
username: PIMSCS
password: PIMSCS
...
- server.address: Endereco na qual a aplicacao ira subir
- server.port: porta da aplicacao
- spring.datasource.*: Configuracoes realacionadas ao banco de dados do produto utilizada pelo TProvider para extrair as informacoes.
Autenticacao das APIs do TProvider
O TProvider utiliza o usuário e senha de autenticacão das suas APIs que estão configuradas na tabela PRXPARAMETER da base do Produto, com os valores ID_PRXPARAMETER = 4703 (Usuário), e ID_PRXPARAMETER = 4704 (Senha).
Swagger
O acesso ao Swagger UI pode ser realizado através do endereco abaixo.
http://[IP]:[PORTA]/swagger-ui.html
Configuracao do Keycloak
Apos a instalacao do servico do TProvider é necessário realizar a configuracao inicial do Keycloak, relacionado a criacão de usuários.
URL de acesso: http://[IP]:[PORTA]/auth
Acessoar o Keycloak > Adminstration Console e realizar a autenticacao com usuário e senha de administrador. Selecionar o Realm treports e clicar no menu Users.
Para adicionar um novo usuário, clique no botão Add User, informando o nome do usuário e clicando no botão Create.
Após a criacao do usuário, acesse a aba Credentials e clique no botão Set password. Informe a senha para o usuário, confirme a senha, desabilite a opcão Temporary e clique em Save.
Configuracao do Provedor de dados com TReports
Para configurar o TProvider como provedor de seguranca de autenticação dos usuários para acesso ao TReports, basta acessar a tela de configuracão do TReports e informar os dados conforme abaixo:
- Nome do Provedor: TProvider
- Endereço de criação do token: http://[IP]:[PORTA]/auth2/token
- Endereço Jwks: http://[IP]:[PORTA]/auth2/jwks
- Endereço base da Api: http://[IP]:[PORTA]/users
Link da documentacao oficial do TReports: https://tdn.totvs.com/pages/releaseview.action?pageId=625443148
Expedicao
O novo instalador e os pacotes da aplicacao estão disponibilizados no servidor de arquivos da engenharia, através do seguinte link.
Endereco para download do instalador
http://engenharia.agro.totvs.com.br:8080/download/tprovider-installer.zip
endereco para download da aplicacao.
http://engenharia.agro.totvs.com.br:8080/download/TProvider.jar
Configuração do TProvider
Exportação de relatório
Importação de Relatórios
, assim como servir de provedor de segurança (autenticação) entre Smart View e produtos TOTVS Agro.
Esta nova versão do TProvider deixa de utilizar o servidor de aplicação Apache Tomcat e passa a fornecer um novo processo de instalação conforme descrito nos tópicos abaixo:
TProvider & Keycloak
O provedor de segurança (autenticação) foi implementado utilizando a ferramenta Keycloak e embarcada no TProvider, onde provê os mecanismos de autenticação e autorização para o Smart View.
Configuração do provedor de segurança do Smart View utilizando o TProvider
Script para habilitar menu "Relatórios (Legado)"
Configuração do TOTVS Agro Multicultivo
Aviso | ||
---|---|---|
| ||
|
...