Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

       O TReports conta com sua interface para listar, buscar, gerar e fazer o download dos relatórios produzidos, agora com a introdução às APIs de Integração, será possível que os produtos que precisarem se integrarem integrar com o sistema tenham novas formas de executar relatórios dentro do produto, tendo acesso a um visualizador e/ou ao relatório gerado em diversos formatos. Promovendo uma nova e melhor experiência para o usuário da linha de produto ao que precisar acessar suas informações por meio de relatórios.

A Baixo demonstramos dois cenários de uso dessa integração:


Geração de relatório para download 

...

No primeiro modelo iremos demonstrar com o fluxo onde é solicitado a geração de um relatório para o sistema. As premissas a serem seguidas são: É preciso pesquisar o relatorio a ser gerado, posteriormente aplicaremos um filtro nessa busca de relatórios
Tendo um relatório previamente cadastrado é possível fazer sua busca pelo sistema, ela pode ser feita pelo respectivo 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 no Swagger, 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.

Busca de Relatório 

...

A busca é utilizada para encontrar o relatório desejado, sendo possível buscar aqueles que o usuário tem permissão de acesso, sejam eles criados pelo próprio usuário, compartilhados via pasta ou via compartilhamento único. Assim como é feito na interface, a busca já pode ser realizada ao enviar no mínimo 3 caracteres para pesquisa, todos os relatórios que tiverem esses caracteres em comum serão retornados.

...

É importante lembrar que um relatório pode conter parâmetros para sua geração, caso não tenha ciência se o relatório possui um algum parâmetro, basta consultar o endpoint:

...

Neste momento temos o ID do relatório e o name do parâmetros necessários para geração (pCodEscr, pCodFatura e pNomeSocio). Podemos

Olhando a requisição anterior podemos perceber que o parâmetro "pCodEscr" é multi valorado (multiValue: true), isso significa que o parâmetro recebe uma lista de valores.

...

Nesta requisição, como mencionado anteriormente, utilizaremos todos os dados reunidos até o momentoinfomados. Cada solicitação é exclusiva de acordo com os parâmetros necessários, neste caso apresentamos a forma em que os parâmetros serão enviados no corpo (body) da requisição conforme o cenário apresentado.

...

O retorno dessa requisição é o ID de geração que nós guiara utilizaremos na proxima etapa.

Bloco de código
themeRDark
titleResponde Body
"3b845650-3972-49ae-9b5c-32f02423782b"

...

Informações

Pode acontecer situações em que o relatório ainda não tenha sido gerado e , sendo assim, a API não retornará conseguirá retornar o documento gerado, pronto e será informando um erro de 'não encontrado'. Basta refazer a requisição.

...

Depois que o cadastro de um relatório foi feito, para que ele seja disparado em alguma extensão do produto é 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, o endpoint utilizado será:.

Hyperlinks para integração

...

O endpoint que utilizaremos para esse fluxo:

Image Added

Para utilizar essa requisição vamos precisar de um ID de um relatório existente: e6d724bd-8505-4702-9fa8-a2672c3b9c94
Os demais parâmetros podem ser informados por meio de QueryString ou diretamente na URL retornada.

Exemplo de URL pronta:

Bloco de código
http://localhost:7017/reportsV2/myreports/document-view/e6d724bd-8505-4702-9fa8-a2672c3b9c94?access_token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InBKd3RQdWJsaWNLZXlGb3IyNTYifQ.eyJpc3MiOiJUT1RWUy1BRFZQTC1GV0pXVCIsInN1YiI6IkFkbWluaXN0cmFkb3IiLCJpYXQiOjE2NDMyOTExMDAsInVzZXJpZCI6IjAwMDAwMCIsImV4cCI6MTY0MzI5NDcwMCwiZW52SWQiOiJFTUFURVIifQ.dixgHfk_lQs0hgK_L-rn4iEw5n2ohOI-WLGSQxv8w_3FzJk4raExheqzkyRvAhl7dZ73nlrha2FfCoVAeticsu9wz-Eg81-snRQnZoQdV9-ogOb0j_pIH2FYAx3cnIOZmYNCpDdJuWFnsZjZ3BpxB2Acee8cna9y4tEpKMuPLjswBn5TMz68N5-gSn2MIYx--HmH1sFx6BqkZNa8URJKmAsuBzcPFNOzgUkyGEYfG2PaFJ583lBi8_9sIWAiusuDmX1mKle3s72T8yrGGDNPS01Q_PTunR4tJ6QDZUy361fhYabhMm0twN_Wt0FmMvyRCUbeExDzMelx6pV9GIzKhQ&refresh_token=gQJam9xwxyHm8SCysuAb_TZe.nQFR3_Bdv2LLuCe8pvZ0tgl3_sPSLVWwKXsMPCKH7GdRAruVsM-I8ZTyczYugcYP5Yb8hlycFKXzfaButyF1FZO3_poac04lEfdNMbN6vfBlw_svjX-sn1jgDerD4Bi9M8SMSX9r6TWLLCfxIyyk6t_uBbDersqYGlr-A_Ity4EJpTAd2TG1AUzqFMi_H_stVmfWfgEP.OUZKAm0xRSNey0_6bMubPodgVjKpmb7FHgKHoizXPM8tuCvOTrl4oJwGg28jsFOa5S8fpCNEPGxIxOKSMMfH4MJgX1wSRTbwB7VfO17h4RKkPnSTlH9x3ojohIKJs0s2iddOVjMxwtxwqbqmZic62mV_sYjPC9ZeR9xWX7NdnIAmxIIFLuhBDguydHe3CfBcDGL9ORzibWiyG1XsVF6s8G0sZdfd2ahoopzhULjgbvp5T57JTzf7wrzSUyS4nFS6lecGb5jVkXr79enzxEJUSkUryX3x9NO6dKxzhQjrLbHkn0msDcnC0gygw5DV3TI1qVqZp8WmPojtJmb3CNScpA&scope=default&token_type=Bearer&expires_in=3600&hidemenus=true


Com a URL configurada vamos acessar um browser para visualização da mesma, após a conclusão da geração do relatório que foi indicado, podem ser utilizados os recursos da inteface para fazer, por exemplo, o seu download.


[ IMAGEM ]


Informações
titleInformações


As APIs publicas estão disponíveis em qualquer instalação do TReports e suas operações estão documentadas via Swagger.

...

info

Nota

Para realizar testes é necessário o uso de alguma aplicação que simule requisições

http

HTTP.