...
Informações |
---|
Documentação no swagger: Api publica para integração |
Para iniciar o uso das funcionalidades apresentadas, primeiro é necessário fazer a instalação do TReports.
Informações |
---|
Documentação referente a instalação: Instalação TReports |
Com o TReports devidamente instalado e configurado, é necessário fazer o Login no sistema para dar prosseguimento, feito isso, basta configurar um Conector para fornecer os dados que serão utilizados no Relatório que futuramente será gerado.
Utilizamos o TReports para gerenciar recursos de maneira mais intuitiva e clara, podendo ser utilizado por qualquer nível de usuário devido sua amigável interface.
...
id | Busca |
---|
...
id | 1 |
---|---|
label | Menu Relatórios |
effectType | slide |
Os relatórios são divididos em dois contextos, sendo eles : 'Meus Relatórios' que são os relatórios criados pelo usuário que está logado no sistema e 'Relatórios Compartilhados' que são todos aqueles relatórios compartilhados por outros usuários.
...
A busca é feita no contexto que o usuário está, ou seja, caso esteja em 'Meus Relatórios', como foi explicado anteriormente, apenas os relatórios criados pelo usuário logado serão filtrados pela pesquisa feita, caso esteja em 'Relatórios Compartilhados' somente relatórios desse contexto serão retornados.
Os relatórios que estão em uma pasta podem ser visualizados através do menu Pastas.
...
id | 2 |
---|---|
label | Menu Pastas |
effectType | slide |
Assim como é feito em Relatórios, as Pastas também tem dois contextos: 'Minhas Pastas' e 'Pastas Compartilhadas', sendo possível visualizar todos os recursos vinculados a uma Pasta previamente cadastrada ou compartilhada.
...
label | Pasta |
---|
Aqui é mostrado algumas infomações como: o tipo do recurso, o nome dado a ele e a sua data de criação.
Informações |
---|
Documentação referente a Pasta: Pastas |
Informações |
---|
A pasta é um agrupador feito para Compartilhamento, não sendo possivel fazer outras ações em seu menu. |
...
label | Geração/Download |
---|---|
effectType | slide |
...
Ao utilizar a API a experiência é mais complexa porém mais rápida, o fluxo é feito em 6 requisições que podem ser encontradas em nosso Swagger, essas requisições são utilizadas para facilitar o uso de usuários que {espaço para completar}
Informações |
---|
Documentação no swagger: Api publica para integração |
...
...
O retorno dessa requisição é o provider utilizado, displayName e o Issuer.
...
...
...
...
...
...
...
...
...
Diferente da interface, na API não tem separação em contextos ('Meus Relatórios' e "Relatórios Compartilhados') então, o retorno é sempre todos os relatórios que contém no nome ou na descrição o filtro inserido.
GET: /api/reports/v1/resources
...
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. |
...
theme | RDark |
---|---|
title | Responde Body |
linenumbers | true |
...
...
...
...
...
...
...
...
...
...
Nessa requisição é possivel visualizar os parâmetros cadastrados no relatório pesquisado.
OPTIONS: /api/reports/v1/resources/{id-do-relatório}/generate
...
...
...
...
...
...
...
...
...
...
...
...
...
Geração do 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
...
Caso o relatório possua parâmetros cadastrados é necessário informar no body da requisição:
Bloco de código |
---|
{
"nome-do-parâmetro":"valor-desejado-do-parâmetro"
} |
...
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.
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
...
Exemplo de resposta:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"viewer": "http://localhost:7017/reportsV2/myreports/document-view/{reportId}?access_token={access_token}&refresh_token={refresh_token}&scope={scope}&token_type={token_type}&expires_in={expires_in}&hidemenus=true"
}
|
A querystring no TReports é utilizada para visualizar o sistema sem que mostre seus menus.
...