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:
Image Added
Este endpoint define o formato em que o arquivo será retornado. Os formatos disponíveis para download são:
Formato | Descrição |
---|
pdf | Portable Document Format |
xls | Excel até 2012 |
xlsx | Excel a partir de 2010 |
rft | Rich Text Format |
docx | Documento de processamento de texto |
mht | Armazenamento de um arquivo de página da web |
html | Linguagem de Marcação de Hipertexto |
txt | Arquivo de Texto |
csv | Comma-Separated-Values |
jpeg | Arquivo de imagem comprimido |
png | Portable Network Graphics |
Nota |
---|
Podem acontecer situações em que o relatório solicitado ainda não tenha sido gerado, sendo assim, a retornará um erro de 'não encontrado'. Basta refazer a requisição até que o arquivo esteja disponível. |
Viewer Externo
Depois que o cadastro de um relatório foi feito, para que ele seja disparado em alguma extensão do ERP TOTVS, é preciso fazer a integração para ativar a geração do mesmo, sendo assim, é preciso utilizar o hyperlink que monta os links disponíveis para integração com visualizador.
Para iniciar o fluxo precisamos ter conhecimento do id de relatório que desejamos executar, caso não saiba essa informação, utilizaremos a busca de relatório para buscar essa informação.
Busca de Relatório
A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados.
Detalhes da implementação são encontrados no endpoint abaixo:
Image Added
Abaixo temos um exemplo da lista de relatórios retornados pela API, utilizaremos o relatório com id: cd767d3f-ec71-4c1a-8143-c6645dd8f63c como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.
Bloco de código |
---|
theme | RDark |
---|
title | Response Body |
---|
|
[
{
"id": "a4127383-3229-420f-bd47-c795c2af5ebd",
"displayName": "Recibo de Fatura (JU203b) ",
"description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
"navigationFolderId": 1
},
{
"id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
"displayName": "Recibo de Fatura\"",
"description": "Recibo de Fatura\"",
"navigationFolderId": null
},
] |
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:
Image Added
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. Bloco de código |
---|
theme | RDark |
---|
title | Formato da estrutura de Parâmetros |
---|
| [
{
"name": "nome do parâmetro",
"value": "valor do parâmetro",
"visibility": "Default" | "Hidden" | "Disabled"
},
{
"name": "nome do parâmetro 2",
"value": "valor do parâmetro 2",
"visibility": "Default" | "Hidden" | "Disabled"
}
] |
|
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.
Image Added
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 |
---|
theme | RDark |
---|
title | Formato da estrutura de Parâmetros |
---|
|
[
{
"name": "nome do parâmetro",
"value": "valor do parâmetro",
"visibility": "Default" | "Hidden" | "Disabled"
},
{
"name": "nome do parâmetro 2",
"value": "valor do parâmetro 2",
"visibility": "Default" | "Hidden" | "Disabled"
}
] |
O campo Visibilidade, possui 3 opções, sendo elas:
- Default: Visibilidade padrão do parâmetro, onde o valor enviado pode ser alterado.
- Hidden: Visibilidade onde o parâmetro não é exibido para o usuário, será enviado com o Valor preenchido no parâmetro.
- Disabled: Visibilidade onde o parâmetro é exibido, mas o valor não pode ser alterado pelo usuário.
O exemplo abaixo contém o envio dos parâmetros com cada uma das visibilidades descritas:
Bloco de código |
---|
theme | RDark |
---|
title | Formato da estrutura JSON de Parâmetros |
---|
|
[
{
"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 |
---|
title | Envio de Parâmetros em Base64 |
---|
|
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.
Image Added
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 |
---|
|
As APIs publicas estão disponíveis em qualquer instalação do Smart View a partir da versão 1.4 e suas operações estão documentadas via Swagger.
|