Histórico da Página
...
...
ABaixo demonstramos dois cenários de uso dessa integração:
Modelo de Fluxo de uso 01 - Geração de um Arquivo
...
ERP TOTVS, permitindo a integração através de dois modelos de uso: acesso através de um visualizador externo ou a geração dos relatórios para download em diversos formatos.
O Smart View possui um Visualizador de PDF usado em integrações, que pode ser acessado por diferentes navegadores integrados aos produtos. Abaixo serão listadas as versões mínimas dos principais navegadores em que o componente é suportado:
Navegador | Versão Mínima |
|---|---|
| Chrome | 4 |
| Edge | 12 |
| Safari | 16.3 |
| Firefox | 110 |
| Opera | 95 |
| IE | 11 |
Download de Arquivo
Neste modelo iremos demonstrar com o fluxo onde é solicitado a geração de um relatório para o sistema.
...
busca de relatório
...
...
...
...
...
...
...
...
...
Para seguirmos o fluxo apresentado iremos utilizar o relatório de ID: a4127383-3229-420f-bd47-c795c2af5ebd.
busca de parâmetros
...
...
...
...
...
...
Gerando um Relatório
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Com o id de geração apresentado na etapa anterior basta requisitar o download no endpoint abaixo.
...
Arquivo
Em nossa última etapa do fluxo utilizaremos o identificador da geração "3b845650-3972-49ae-9b5c-32f02423782b" da etapa anterior para requerer o download do arquivo.
Detalhes da implementação são encontrados no endpoint abaixo:
Este endpoint define o formato em que o arquivo será retornado. Os formatos disponíveis para download são:
| Formato | Descrição |
|---|---|
| Portable Document Format | |
| xls | Excel até 2012 |
| xlsx | Excel a partir de 2010 |
PDF, XLS, XLSX, RTF, DOCX, MHT, HTML, TXT, CSV, JPEG e PNG.
...
...
...
...
----------------------------------------------------------------------
As APIs publicas estão disponíveis em qualquer instalação do TReports e suas operações estão documentadas via Swagger.
| Informações |
|---|
Documentação no swagger: Api publica para integração; Para realizar testes é necessário o uso de alguma aplicação que simule requisições http; |
Geração de relatório para download
Tendo um relatório previamente cadastrado é possível fazer sua busca pelo sistema, ela pode ser feita pelo seu id, nome ou descrição do relatório ou pela pasta que ele pertence, sendo necessário apenas especificar corretamente qual tipo da busca desejada conforme mostra na documentação, também é possível fazer a procura dos parâmetros do relatório, parâmetros esses que serão necessários atribuir valor no momento da geração para se concluir com sucesso, feito isso, o download desse relatório ficará disponibilizado em diversos formatos no tempo que foi especificado.
...
...
...
Verificação de disponibilidade
...
- O retorno dessa requisição é o provider utilizado e o Issuer.
Buscando um Relatório existente
...
...
...
...
...
...
...
...
O filtro de Pastas é passado dessa forma ao final da URL:
?NavigationFolderId={ID-da-Pasta}
| Informações |
|---|
O filtro funciona assim como a própria busca via interface, ou seja, digitando no mínimo 3 caracteres já é possível buscar o nome de relatórios baseados naquilo que foi escrito. |
...
...
...
...
...
...
...
...
...
...
...
...
Buscando parâmetros cadastrados
Nessa requisição é possivel visualizar os parâmetros necessários para a execução de um relatório.
OPTIONS: /api/reports/v1/resources/{id-do-relatório}/generate
...
Hyperlinks para integração
Os links retornados na requisição de Hyperlinks são utilizados para visualização de integrações feitas com o sistema, sendo uma delas a de Visualização, dessa forma, é possível abrir o Smart View utilizando todos os seus recursos em um navegador.
O endpoint que utilizaremos para esse fluxo:
Para utilizar essa requisição vamos precisar de um ID de um relatório existente, nesse caso, utilizaremos o ID buscado na requisição de busca: cd767d3f-ec71-4c1a-8143-c6645dd8f63c
Os parâmetros de autenticação podem ser informados por meio de QueryString ou diretamente na URL retornada. Esses parâmetros de autenticação são as informações do token do usuário que irá abrir a interface da integração, essas informações são utilizadas para realizar contextualização e verificação de permissões.
Além das informações da autenticação, também devem ser enviados os parâmetros do recurso, onde serão informados os valores e a visibilidade de cada parâmetro para execução e visualização.
| Informações | |||||
|---|---|---|---|---|---|
Os parâmetros do recurso devem ser enviados em estrutura JSON codificada como BASE64.
|
...
...
...
...
...
...
...
...
...
...
...
...
Gerando um Relatório
Para fazer a geração é necessário informar o ID do Relatório, o tempo que a geração ficara disponível para consultas e seu parâmetro, caso já tenha sido previamente cadastrado.
POST: /api/reports/v1/resources/{id-do-relatório}/generate?ttl=1440
...
Com a URL configurada vamos acessar um browser para visualização da mesma, é apresentado o relatório informado e após a conclusão da geração podem ser utilizados os recursos da inteface para fazer, por exemplo, o download do relatório.
Viewer Externo com suporte a passagem de parâmetros
O endpoint de hyperlinks irá retornar os links para a integração com o visualizador, dessa forma o relatório poderá ser chamado pelo Viewer Externo.
Os parâmetros são enviados para o Viewer Externo em estrutura JSON codificada como BASE64, e devem ser informados no formato abaixo, informando o Nome, Valor e Visibilidade do Parâmetro
...
...
...
...
...
...
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
"3b845650-3972-49ae-9b5c-32f02423782b" |
Download do Relatório gerado
O download nada mais é do que uma forma de salvar o relatório gerado localmente em um formato especifico desejado, para fazer o download será preciso informar o ID da geração do relatório e o formato para download desejado.
GET: /api/reports/v1/generated/{id-da-geração}/{formato}
Formatos disponíveis: PDF, XLS, XLSX, RTF, DOCX, MHT, HTML, TXT, CSV, JPEG e PNG.
Ao fim da requisição será possível visualizar o relatório no formato escolhido e fazer o seu download.
Hyperlinks para integração com o visualizador
O Hyperlink permite que o produto integrador tenha acesso a um template de rota para acesso ao visualizador de um relatório sem utilizar o sistema como um todo.
GET: /api/reports/v1/hyperlinks
...
...
...
{
"viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={accessToken}&refresh_token={refreshToken}&scope={scope}&token_type={tokenType}&expires_in={expiresIn}&hidemenus=true"
}
Os parâmetros do template podem ser inseridos de acordo com a necessidade do produto, sendo preenchido via QueryString, dessa forma, as URLs retornadas no hyperlink já virão com os parâmetros preenchidos de acordo com as informações colocadas.
Exemplo de URL enviando QueryString:
...
| |
[
{
"name": "pAplicacao",
"value": ["TReports"],
"visibility": "Default"
},
{
"name": "pPlataforma",
"value": ["Windows"],
"visibility": "Hidden"
},
{
"name": "pVersao",
"value": ["0.0.0+0"],
"visibility": "Disabled"
}
] |
| Bloco de código | ||
|---|---|---|
| ||
WwoJewoJCSJuYW1lIjogInBBcGxpY2FjYW8iLAoJCSJ2YWx1ZSI6IFsiVFJlcG9ydHMiXSwKCQkidmlzaWJpbGl0eSI6ICJEZWZhdWx0IgoJfSwKCXsKCQkibmFtZSI6ICJwUGxhdGFmb3JtYSIsCgkJInZhbHVlIjogWyJXaW5kb3dzIl0sCgkJInZpc2liaWxpdHkiOiAiSGlkZGVuIgoJfSwKCXsKCQkibmFtZSI6ICJwVmVyc2FvIiwKCQkidmFsdWUiOiBbIjAuMC4wKzAiXSwKCQkidmlzaWJpbGl0eSI6ICJEaXNhYmxlZCIKCX0KXQ== |
Com a URL do Viewer Pdf retornada, é possível acessar o browser para visualização, onde será apresentado o relatório com os parâmetros informados, respeitando os valores e visibilidade enviados.
Abono de licenças
Para maiores detalhes sobre o como realizar o abono de licenças durante a integração, acesse a documentação no link Consumo de Licenças (página interna).
| Informações | ||
|---|---|---|
| ||
|
| Informações | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
| Informações | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
| Page Tree |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas