Índice:
Introdução:
O Web Service Reports Fornece serviços para gerar relatórios do TOTVS Reports de forma síncrona e assíncrona. O modelo de autenticação utilizado é o Basic Authentication.
Utilizando Web Service do RM Reports no Fluig
Como Funciona:
Estão expostos no wsReport alguns serviços, onde para consumi-los, é necessário enviar através de uma requisição um envelope SOAP passando os parâmetros de cada serviço.
O serviço é exposto pelo host conforme documentação abaixo:
Como Expor os Web Services do RM através do Host
Segue abaixo o detalhamento e exemplos de utilização dos serviços em envelope SOAP:
Retorna a lista de todos os relatórios de uma determinada coligada.
Retorna a estrutura de um determinado relatório (utilizado apenas para conferencia).
Retorna as informações de filtro e parâmetros, caso o relatório possua.
O retorno é um xml de duas estruturas serializadas. Elas devem ser utilizadas separadamente ao chamar o método de geração do relatório.
Gera efetivamente o relatório e retorna o identificador a ser utilizado para fazer o download do relatório pelo método GetFileChunk.
Veja que os filtros e os parâmetros correspondem ao que o método GetReportInfo retornou e foi passado separadamente.
Os filtros e parâmetros podem ser alterados conforme destaque abaixo.
Importante
Caso esteja executando um relatório Global, o valor da Coligada para execução do relatório e das consultas presentes no relatório pode ser passado através do parâmetro Contexto, por exemplo:
<tot:contexto>CodColigada=7;CodFilial=1</tot:contexto>
Caso não seja enviado, será utilizado a Coligada do relatório.
Retorna o tamanho do relatório em bytes. Este resultado é utilizado para fazer o download parcial ou total do relatório pelo método GetFileChunk.
Retorna o relatório gerado em base 64 e no formato especificado no parâmetro filename do método GenerateReport.
Funciona da mesma forma que o GenerateReport, porém não aguarda a geração do relatório e retorna um identificador único a ser utilizado para consultar o status da geração.
Importante
Caso esteja executando um relatório Global, o valor da Coligada para execução do relatório e das consultas presentes no relatório pode ser passado através do parâmetro Contexto, por exemplo:
<tot:contexto>CodColigada=7;CodFilial=1</tot:contexto>
Caso não seja enviado, será utilizado a Coligada do relatório.
Utilizado para checar o status da geração do relatório que foi demandado a partir do método GenerateReportAsynchronous.
O retorno é um código de status, seguido de um GUID a ser utilizado para fazer o download do relatório pelo método GetFileChunk. Ex:
- 0;Wait – Indica que o relatório está sendo gerado
- 1;xxxxxxxxxxxxxxxxxxxxxxxxxxxxx - Indica que foi gerado, seguido do GUID para download
- 2;Erro xxxxxxx – Indica que ocorreu um erro, seguido da mensagem de erro
Aplicação de Teste:
Para utilizar a aplicação de testes é necessário possuir o Microsoft Visual Studio.
- Com o Visual Studio aberto: Clique nas opções FILE -> Open -> Web Site. Conforme exemplo abaixo:
- Em seguida selecione a pasta descompactada e clique em "Open" conforme abaixo:
Visão Geral
Conteúdo das Ferramentas