Árvore de páginas

Versões comparadas

Chave

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

...

A baixo demonstraremos dois modelos de uso da integração, onde o primeiro direciona para o download de um arquivo e o segundo para utilização do viewer externo.

Image Removed


Download de Arquivo

...

...

Neste modelo iremos demonstrar com o fluxo onde é solicitado a geração de um relatório para o sistema.

...

Iniciaremos o fluxo buscando pelo identificador do relatório (id) na api de busca de relatório onde seguiremos nas etapas de busca de parâmetros, solicitação de geração finalizando na api de download do arquivo gerado.

é 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 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 serão retornados. 

...

Informações

Pode acontecer situações em que o relatório ainda não tenha sido gerado, sendo assim, a API não irá retornar o documento informando um erro de 'não encontrado'. Basta refazer a requisição até que o arquivo seja disponibilizado.

...

Informações

Pode acontecer situações em que o relatório ainda não tenha sido gerado, sendo assim, a API não irá retornar o documento informando um erro de 'não encontrado'. Basta refazer a requisição até que o arquivo seja disponibilizado.




...

Viewer Externo

...

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.

...