Histórico da Página

Esse documento tem como objetivo auxiliar os desenvolvedores na migração dos códigos que utilizam o RM Reports nos seus produtos. Lembrando que a partir da versão 12.1.5 uma nova engine de execução de relatórios do RM Reports foi disponibilizada para nossos clientes.
Para isso, foi criada uma nova API de comunicação com o RM Reports para facilitar o uso e a manutenção nos produtos RM que executam diretamente relatórios construídos no RM Reports.
Ela possibilita a execução de relatórios tanto no lado cliente (actions, forms, etc) quanto no lado server, procurando isolar os componentes internos de execução dos relatórios da RM e da DevExpress, impedindo assim, que os consumidores alterem propriedades e executem métodos diretamente nesses componentes.

...

• GetReportInfo: método responsável em retornar informações do layout do relatório (ele não executa o relatório). Esse método deve ser utilizado quando houver a necessidade de recuperação de informações do layout do relatório antes de executá-lo. Ele retorna informações de parâmetros e filtros criados internamente no relatório para que os consumidores possam manipular esses dados de alguma forma.

Parâmetros de entrada:

Retorno:

RptReportInfo

...

• ExecuteReport: principal método da API. Ele executa o relatório e retorna informações da execução através do objeto RptExecutorReturn.

Parâmetros de entrada:

Retorno:

RptExecutorReturn

RptExecutorPar

...

ExecutePartialReport: Executa o relatório de forma parcial. Utilizado para execução de grandes relatórios e passando a fonte de dados externamente. Resolve o problema de estouro de memória da DevExpress.

Parâmetros de entrada:

Retorno:

RptExecutorPartialReturn

RptExecutorPartialPar

Export: Exporta um relatório em um formato especifico a partir de um binário proveniente de uma geração prévia. 

...

Utilizado em casos em que a geração é executada em um momento e a exportação do arquivo, em outro.

Parâmetros de entrada:

Retorno:

RptExecutorExportReturn

RptExecutorExportPar

Exemplos de uso (lado server):

Utilização da API na migração da ficha física financeira do RM Nucleus.

[Código antes]:

RptReport report;
DataTable reporttable = RptUtilsData.LoadDataTableReport(codColRel, IdRel);
report = RptUtilsData.LoadReport(reporttable.Rows[0]

Exemplos de uso (lado server):

Utilização da API na migração da ficha física financeira do RM Nucleus.

[Código antes]:

RptReport report;
DataTable reporttable = RptUtilsData.LoadDataTableReport(codColRel, IdRel);
report = RptUtilsData.LoadReport(reporttable.Rows[0], this.parameters.Context.CodUsuario);
string filter = string.Format("TMOV.CODCOLIGADA = {0} AND TMOV.IDMOV = {1}", CodColigada, IdMov);
report.FilterSQLExpression = filter;
report.PreviewRowCount = 0;
report.RequestParameters = false;
report.CreateDocument();
return stream.ToArray();
Código depois
//Instancia a classe RptExecutorServer reponsável em gerar o relatório do server.
IRptExecutor executorServer = RM.Lib.RMSBroker.CreateServer<IRptExecutor>("RptExecutorServer");
//Recupera as informações do report. ex: filtros do report, parametros do report.
RptReportInfo repInfo = executorServer.GetReportInfo(codColRel, IdRel, this.parameters.Context.CodUsuario);
//Recupera o objeto que representa o filtro principal do report.
//Para isso foi utlizado o Helper "RptReportInfoHelper" que possui uma série de metodos que ajuda manipular
//o objeto RptReportInfo.
RptFilterReportPar mainFilter = RptReportInfoHelper.GetMainFilter(repInfo);
//Configura o filtro necessário.
mainFilter.Value = string.Format("TMOV.string filter = string.Format("TMOV.CODCOLIGADA = {0} AND TMOV.IDMOV = {1}", CodColigada, IdMov);
//Instancia a classe de parametros do método.
RptExecutorPar parms = new RptExecutorPar();
//Adiciona o filtro para os parametros.
parms.FiltersReport.Add(mainFilter);
//Configura o tipo de exportação.
parms.GenerationType = RptReportGenerationType.File;
parms.ExportFileType = RptExportFileType.PDF;
//Executa o relatório.
RptExecutorReturn result = executorServer.ExecuteReportreport.FilterSQLExpression = filter;
report.PreviewRowCount = 0;
report.RequestParameters = false;
report.CreateDocument();
return stream.ToArray();
Código depois
//Instancia a classe RptExecutorServer reponsável em gerar o relatório do server.
IRptExecutor executorServer = RM.Lib.RMSBroker.CreateServer<IRptExecutor>("RptExecutorServer");
//Recupera as informações do report. ex: filtros do report, parametros do report.
RptReportInfo repInfo = executorServer.GetReportInfo(codColRel, IdRel, this.parameters.Context.CodUsuario, parms);
//Retorna o relatório gerado para alguma outra rotinal
return result.PrintReport;

...

//Instancia a classe RptExecutorServer reponsável em gerar o relatório do server.
IRptExecutor executorServer = RM.Lib.RMSBroker.CreateServer<IRptExecutor>("RptExecutorServer");
RptExecutorPar parms = new RptExecutorPar();
//Adiciona valor para o parametro "IdPrd" definido no relatóiro
parms.ParametersReport.Add(new RptParameterReportPar("IDPRD", 84);
//Configura o tipo de exportação.
parms.GenerationType = RptReportGenerationType.File;
parms.ExportFileType = Recupera o objeto que representa o filtro principal do report.
//Para isso foi utlizado o Helper "RptReportInfoHelper" que possui uma série de metodos que ajuda manipular
//o objeto RptReportInfo.
RptFilterReportPar mainFilter = RptReportInfoHelper.GetMainFilter(repInfo);
//Configura o filtro necessário.
mainFilter.Value = string.Format("TMOV.CODCOLIGADA = {0} AND TMOV.IDMOV = {1}", CodColigada, IdMov);
//Instancia a classe de parametros do método.
RptExecutorPar parms = new RptExecutorPar();
//Adiciona o filtro para os parametros.
parms.FiltersReport.Add(mainFilter);
//Configura o tipo de exportação.
parms.GenerationType = RptReportGenerationType.File;
parms.ExportFileType = RptExportFileType.PDF;
//Executa o relatório.
RptExecutorReturn result = executorServer.ExecuteReport(1codColRel, 287IdRel, this.parameters.Context.CodUsuario, parms);
//Retorna o relatório gerado para alguma outra rotinal
return result.PrintReport;

Execução de relatórios no "Client"

As informações abaixo auxiliam no desenvolvimento dos códigos para execução de relatórios no client":

Passo-a-passo para utilização da API no client:

Adicionar referência para as dll's "RM.Rpt.Executor.Intf.dll" e "RM.Rpt.Executor.Client.dll";

Remover as referências para as outras dlls do reports, entre elas: "RM.Rpt.Lib.dll" e "RM.Rpt.Reports.intf.dll";

Utilização da classe "RptExecutorClient" disponível na dll "RM.Rpt.Executor.Client.dll": essa classe deve ser instanciada no client (actions, forms, etc).

A classe "RptExecutorClient" possui a seguinte estrutura:

• AddParams: informa os valores dos parâmetros do relatório;

• AddParamsProvider: informa os valores dos parâmetros de provider do relatório;

• AddMainFilter: envia um filtro (no formato de string) para o "report [RptReport]" principal do relatório;

• AddDetailFilter: envia um filtro (no forma de string) para as bandas de detalhe do report;

• GetReportInfo: Retorna informações do layout do relatório através do objeto RprReportInfo conforme descrito acima;

• GetRepositoryInfo: Retorna informações do repositório (informações do relatório);

• Show: Mostra o relatório na tela passando o printReport como parâmetro. O parâmetro de showModal mostra o relatório em uma janela modal ou não.

• ExecuteReport: executa o relatório no server e retorna informações da execução para o cliente.

Parâmetros de entrada:

...

Âncora
_GoBack _GoBack

Utilização da API sem uso do método GetReportInfo:

//Instancia a classe RptExecutorServer reponsável em gerar o relatório do server.
IRptExecutor executorServer = RM.Lib.RMSBroker.CreateServer<IRptExecutor>("RptExecutorServer");
RptExecutorPar parms = new RptExecutorPar();
//Adiciona valor para o parametro "IdPrd" definido no relatóiro
parms.ParametersReport.Add(new RptParameterReportPar("IDPRD", 84);
//Configura o tipo de exportação.
parms.GenerationType = RptReportGenerationType.File;
parms.ExportFileType = RptExportFileType.PDF;
//Executa o relatório.
RptExecutorReturn result = executorServer.ExecuteReport(1, 287, this.parameters.Context.CodUsuario, parms);
//Retorna o relatório gerado para alguma outra rotinal
return result.PrintReport;

Execução de relatórios no "Client"

As informações abaixo auxiliam no desenvolvimento dos códigos para execução de relatórios no client":

Passo-a-passo para utilização da API no client:

Adicionar referência para as dll's "RM.Rpt.Executor.Intf.dll" e "RM.Rpt.Executor.Client.dll";

Remover as referências para as outras dlls do reports, entre elas: "RM.Rpt.Lib.dll" e "RM.Rpt.Reports.intf.dll";

Utilização da classe "RptExecutorClient" disponível na dll "RM.Rpt.Executor.Client.dll": essa classe deve ser instanciada no client (actions, forms, etc).

A classe "RptExecutorClient" possui a seguinte estrutura:

• AddParams: informa os valores dos parâmetros do relatório;

• AddParamsProvider: informa os valores dos parâmetros de provider do relatório;

• AddMainFilter: envia um filtro (no formato de string) para o "report [RptReport]" principal do relatório;

• AddDetailFilter: envia um filtro (no forma de string) para as bandas de detalhe do report;

• GetReportInfo: Retorna informações do layout do relatório através do objeto RprReportInfo conforme descrito acima;

• GetRepositoryInfo: Retorna informações do repositório (informações do relatório);

• Show: Mostra o relatório na tela passando o printReport como parâmetro. O parâmetro de showModal mostra o relatório em uma janela modal ou não.

• ExecuteReport: executa o relatório no server e retorna informações da execução para o cliente.

Parâmetros de entrada:

RptExecutorClientParams

Retorno:

RptExecutorClientReturn

ExportReport: Exporta um relatório em um formato especifico a partir de um binário proveniente de uma geração prévia. Utilizado em casos em que a geração é executada em um momento e a exportação do arquivo, em outro.

Parâmetros de entrada:

Retorno:

...

RptExecutorClientExportReturn

RptExecutorClientExportPar

...

Exemplos de uso (lado client):

...