Ação de Gerar Relatório nos botões da Ficha de Inscrições e Matrículas Rubeus

Gerar Relatório

Como mencionado em nosso conteúdo sobre botões, uma das opções é identificada como Gerar Relatório. Este recurso permite a busca por documentos hospedados em fontes externas, como o TOTVS! É muito útil, por exemplo, para permitir o download de boletos de taxas de inscrição ou matrícula. Veja como utilizar!

||❗Dica: Recomendamos a leitura dos nossos conteúdos sobre componentes e botões para contextualizar o conteúdo abordado aqui! 😉 

Ações iniciais

Ao clicar na opção Gerar Relatório, você será encaminhado para a tela de edição Geral. Nesse momento, é possível adicionar uma descrição para o documento que será gerado e uma mensagem de erro intuitiva. O objetivo é te ajudar a identificar quaisquer erros relacionados à essa ação mais tarde!

Componente > Ações > Gerar Relatório > Geral

Configurações

Defina um nome intuitivo para identificar o relatório. Além disso, é possível definir o que será feito com o arquivo: Abrir na mesma aba? Em uma nova aba? Realizar o download? Resumidamente, você deve definir o que faz mais sentido nesse momento para a sua ficha.

Componente > Ações > Gerar Relatório > Configuração

Um relatório pode ser gerado buscando pelo arquivo no TOTVS ou via API, buscando em uma outra fonte. Os dois métodos são explicados a seguir:

TOTVS

Selecione a opção TOTVS e informe o ID do relatório, que é o identificador desse documento no seu TOTVS. Informe também o código da coligada em que esse documento se encontra. 

Componente > Ações > Gerar Relatório > Configuração

Com os dados em seus campos, clique em Buscar XMLs. Esta ação retornará as estruturas XML onde deverão ser informados os parâmetros e filtros. A inclusão de dados nessas estruturas dependerá de como o documento está configurado, portanto, se atente ao que ele espera receber e quais campos são necessários para identificar a inscrição à qual está associado.

Componente > Ações > Gerar Relatório > Configuração

Ao expandir os campos, será exibida a área destinada à inclusão do XML em ambos os casos.

Repare no botão [+ Variável], ele permite a inclusão de uma variável no código que identifica algum campo do sistema. Utilize esse recurso para referenciar os dados esperados pela ação de gerar o relatório dentro do TOTVS.

Componente > Ações > Gerar Relatório > Configuração > Variável

Logo abaixo, informe o contexto que será enviado, composto pelo código da coligada e código da filial.

Caso seja necessário, informe os campos do sistema que deverão armazenar o GUID e a Base64 do documento.

Outras fontes

Selecione a opção Outras fontes. Em seguida, no espaço para inserção de código, informe o retorno esperado da API:

Defina o tipo de requisição que será feita e o seu link:

A seguir, tal qual no método utilizando TOTVS, podem ser informados os parâmetros esperados para identificar o relatório na fonte desejada, bem como os campos do sistema responsáveis por receber o GUID e a Base64.

O último passo é definir uma lógica, caso seja necessário. E, atenção, não se esqueça de salvar as alterações após encerrar! 😉

Considerações finais

Caso tenha alguma dúvida, não deixe de compartilhá-la com algum especialista Rubeus ou em nossa Comunidade.