Report Builder para Delphi: crie relatórios visualmente ou em código
O sgcReports é um report builder para Delphi e C++ Builder: seus usuários criam relatórios visualmente, e o seu código os constrói com a classe fluente TsgcReportBuilder.
O sgcReports é um report builder para Delphi e C++ Builder: seus usuários criam relatórios visualmente, e o seu código os constrói com a classe fluente TsgcReportBuilder.
Um relatório é um modelo de páginas, bandas, itens, estilos e fontes de dados. O designer e o código editam esse modelo, e uma definição em JSON o armazena.
Seus usuários criam relatórios visualmente no designer de relatórios VCL, FireMonkey ou web, e o seu código os constrói com a classe fluente TsgcReportBuilder. Ambos produzem o mesmo modelo de relatório, com bandas, grupos, mestre-detalhe e expressões, que você visualiza, imprime ou exporta para PDF, Excel, CSV e mais, no desktop ou em um serviço sem janela.
Solte um TsgcVCLReportDesigner ou um TsgcFMXReportDesigner em um formulário, ou sirva o TsgcReportHTMLDesigner no navegador. Os usuários arrastam campos para as bandas, definem propriedades em um inspetor e alternam para uma visualização ao vivo. Registered
TsgcReportBuilder descreve estilos, páginas, bandas e itens como uma única cadeia fluente. O relatório é compilado, comparado e refatorado junto com o restante do seu projeto, e funciona a partir do Delphi 7, sem exigir métodos anônimos.
Salve um relatório com sgcReportSaveToJSONFile e carregue-o em tempo de execução, de modo que um layout possa ficar em um banco de dados ou em uma pasta do cliente e mudar sem uma nova compilação. Os designers abrem e salvam os mesmos arquivos.
Um designer de relatórios para o usuário final, executado dentro do seu aplicativo, e o mesmo designer em tempo de design na IDE.
Designer de relatórios somente Registered
TsgcVCLReportDesigner é um painel com barra de ferramentas, as abas Toolbox, Outline e Data, uma superfície de design com réguas, um inspetor de propriedades e as abas Design e Preview. Solte-o em um formulário, atribua Engine, adicione as fontes de dados, e seus usuários editam o relatório, salvam-no como uma definição JSON e o visualizam com dados reais. TsgcFMXReportDesigner é o gêmeo FireMonkey, construído sobre as mesmas units do designer.
TsgcReportEngine na IDE e escolha Design report… para editar seu relatório com o mesmo designerConecte o designer ao engine e às fontes de dados quando o formulário for criado e carregue o último layout salvo:
procedure TfrmMain.FormCreate(Sender: TObject);
begin
sgcDesigner.Engine := sgcEngine;
sgcDesigner.AddDataSource(sgcOrders);
if FileExists('orders.json') then
sgcDesigner.LoadFromFile('orders.json')
else
sgcDesigner.NewReport;
end;
procedure TfrmMain.FormCloseQuery(Sender: TObject; var CanClose: Boolean);
begin
if sgcDesigner.Modified then
sgcDesigner.SaveToFile('orders.json');
end;Para editar um relatório a partir de um menu sem um formulário dedicado, sgcShowReportDesigner (VCL) ou sgcShowReportDesignerFMX (FireMonkey, Windows e macOS) exibe o designer de forma modal com os botões OK e Cancel e restaura o relatório quando o usuário cancela:
procedure TfrmMain.mnuEditReportClick(Sender: TObject);
begin
if sgcShowReportDesigner(sgcEngine) then
sgcReportSaveToJSONFile(sgcEngine.Report, 'orders.json');
end;TsgcFMXReportDesigner (Delphi XE6 e posterior) tem a mesma barra de ferramentas, as mesmas árvores, superfície, inspetor e aba de visualização, hospedando um TsgcReportPreviewFMX. ToolbarButtonSize deixa os botões fáceis de tocar em uma tela sensível ao toque. O formulário modal e as caixas de diálogo de arquivo estão disponíveis no Windows e no macOS.
TsgcReportHTMLDesigner edita a definição JSON no navegador com um canvas de bandas, um inspetor de propriedades e uma visualização ao vivo, servidos pelo mesmo endpoint HTTP do relatório final. Ele exige o sgcWebSockets Professional ou superior e o sgcHTML. Deixe DesignerEnabled desativado em endpoints de produção e coloque-o atrás da sua própria autenticação.
O sgcReports para .NET inclui designers para o usuário final em WinForms, WPF e Avalonia, os equivalentes do TsgcVCLReportDesigner, com a mesma barra de ferramentas, as mesmas árvores, o mesmo inspetor e a mesma visualização. Eles também carregam e salvam definições em JSON.
Um relatório de vendas agrupado sobre qualquer TDataSet: um cabeçalho por região, uma linha por venda, um subtotal por região e um rodapé de página, salvo como PDF e Excel.
uses
Classes, SysUtils, DB,
sgcReports_Types, sgcReports_Model, sgcReports_Data, sgcReports_Fluent;
const
CS_TOTAL = '[FormatFloat(''#,0.00'', Sum(Sales.Amount))]';
procedure ExportSalesReport(aSales: TDataSet; const aFolder: string);
var
oSales: TsgcReportDataSetSource;
oBuilder: TsgcReportBuilder;
begin
oSales := TsgcReportDataSetSource.Create(nil);
oBuilder := TsgcReportBuilder.Create;
try
// any TDataSet: FireDAC, TClientDataSet, dbExpress...
oSales.SourceName := 'Sales';
oSales.DataSet := aSales;
oBuilder.Title('Sales by region').Units(ruMillimeters)
.Style('Base').Font('Arial', 10).EndStyle
.Style('Group').Font('Arial', 11).Bold.BackColor($EEEEEE).EndStyle
.Page.Paper(rpsA4).Margins(15)
.GroupHeader('Sales.Region', 9).Style('Group')
.Text('Region: [Sales.Region]', 0, 1, 180, 7).TagRole(rtrHeading2).EndBand
.MasterData('Sales', 6).Style('Base')
.Text('[Sales.Customer]', 2, 0, 120, 6)
.Text('[Sales.Amount]', 130, 0, 50, 6).AlignRight.Format('#,0.00').EndBand
.GroupFooter(9).Style('Base')
.Text('Region total ' + CS_TOTAL, 80, 1, 100, 6).AlignRight.Bold.EndBand
.PageFooter(8).Style('Base')
.Text('Page [Page] of [TotalPages]', 0, 1, 180, 6).AlignCenter.EndBand
.EndPage.Data(oSales);
oBuilder.SaveToPDF(IncludeTrailingPathDelimiter(aFolder) + 'sales.pdf');
oBuilder.SaveToXLSX(IncludeTrailingPathDelimiter(aFolder) + 'sales.xlsx');
finally
oBuilder.Free;
oSales.Free;
end;
end;Style, Page, GroupHeader, MasterData, GroupFooter e PageFooter se leem como o layout que produzemSaveToPDF, SaveToXLSX, SaveToCSV e SaveToPNG preparam e exportam diretamente a partir do builder, e as variantes de stream, como SaveToPDFStream, atendem respostas webTsgcReport normal, disponível como Report, e o seu Engine se conecta a uma visualizaçãoUm layout em bandas de verdade, para que relatórios de negócio, como vendas por região ou faturas por cliente, não precisem de gambiarras.
Bandas e grupos
Um relatório tem as bandas de título do relatório, cabeçalho de página, cabeçalho de grupo, dados, rodapé de grupo, rodapé de página e resumo, além de cabeçalhos e rodapés de coluna. Um grupo quebra quando a sua expressão muda, imprime os próprios totais e pode iniciar uma nova página ou repetir o cabeçalho em todas as páginas. Os subrelatórios permitem que uma página inclua o layout de outra.
GroupExpression em uma banda de cabeçalho de grupo, e grupos aninhados para dois ou mais níveisStartNewPage, RepeatOnEveryPage e KeepTogether controlam o fluxo das páginasPrintOnFirstPage e PrintOnLastPage decidem onde as bandas de página aparecemExpressões
Qualquer item de texto aceita expressões entre colchetes, avaliadas pelo engine a cada linha, então um total de rodapé sempre confere com as linhas impressas acima dele. São 68 funções e 10 agregados, incluindo aritmética de datas, preenchimento e formatação, ToWords em 12 idiomas, agregados condicionais e valores acumulados que reiniciam a cada grupo.
'[Sum(Lines.Qty * Lines.Price)]'
'[FormatDateTime(''dd/mm/yyyy'', Invoices.Date)]'
'Page [Page] of [TotalPages]'Sum, FormatFloat, FormatDateTime, Upper, Round, IsNull, SumIf, CountIf, RunningSum e PreviousOnGetVariable fornece as suas próprias variáveis em tempo de execuçãoHighlights aplicam um estilo quando uma condição é verdadeira, por exemplo valores negativos em vermelho, sem scriptO relatório lê os seus dados onde eles já estão: uma consulta, um documento JSON ou os seus próprios objetos.
Mestre-detalhe
TsgcReportDataSetSource lê qualquer TDataSet, como TClientDataSet, FireDAC ou dbExpress. Uma fonte de detalhe se liga ao seu mestre por campos-chave, então cada fatura imprime as próprias linhas, e o rodapé do grupo as soma. Se estiver fechado, o dataset é aberto e fechado em torno da execução; se já estiver aberto, o seu estado e a sua posição são restaurados depois.
MasterSource, MasterFields e DetailFields ligam as fontesTsgcReportJSONSource lê uma string ou um arquivo JSON, e RecordsPath escolhe o arrayTsgcReportEventSource obtém linhas do seu código por meio de OnFirst, OnNext e OnGetValuesrcInvoices.SourceName := 'Invoices';
srcInvoices.DataSet := cdsInvoices;
srcLines.SourceName := 'Lines';
srcLines.DataSet := cdsLines;
srcLines.MasterSource := srcInvoices;
srcLines.MasterFields := 'Number';
srcLines.DetailFields := 'Invoice';
sgcEngine.AddDataSource(srcInvoices);
sgcEngine.AddDataSource(srcLines);O engine prepara as páginas uma única vez, e cada exportação parte do mesmo resultado preparado, então os números são idênticos em todos os arquivos.
Formatos de saída
A exportação para PDF grava PDF/UA-1 com tags por padrão, e PDF/A-3 para arquivamento de longo prazo. A saída XLSX mantém os números como números, para que a planilha os some sem limpeza. Toda exportação pode gravar em um arquivo ou em um stream.
FPages := sgcEngine.Prepare;
try
pdfExport.SaveToFile(FPages, OutputFolder + 'orders.pdf');
xlsxExport.SaveToFile(FPages, OutputFolder + 'orders.xlsx');
csvExport.SaveToFile(FPages, OutputFolder + 'orders.csv');
imageExport.SaveToFiles(FPages, OutputFolder + 'orders_%d.png');
finally
FPages.Free;
end;Os usuários percorrem o relatório antes de imprimi-lo ou salvá-lo, com a mesma renderização do PDF.
Visualização e impressão
TsgcReportPreviewVCL exibe as páginas preparadas com navegação, zoom e modos de ajuste, as imprime e as salva em PDF. As visualizações buscam texto com as ocorrências destacadas, mostram miniaturas de página e exportam para PDF, Excel, CSV, PNG, HTML, Word, ODT, ODS, RTF, SVG e texto simples a partir de um menu Export. TsgcReportPreviewFMX é a visualização FireMonkey no Windows, macOS, iOS e Android.
FirstPage, NextPage, PriorPage e LastPage, ZoomIn, ZoomOut, FitWidth e FitPageprocedure TfrmMain.btnPreviewClick(Sender: TObject);
begin
sgcPreview.Engine := sgcEngine;
sgcPreview.Prepare;
end;
procedure TfrmMain.btnPrintClick(Sender: TObject);
begin
sgcPreview.Print('Sales by region');
end;
Um relatório de turno com caixas de KPI, um gráfico e um código de barras.
Uma confirmação de operação com um QR code.
Um roteiro com um mapa e uma tabela de paradas.
Extratos noturnos, faturas após o checkout e exportações atrás de uma API rodam em um servidor sem janela.
O núcleo do sgcReports não tem dependência de VCL ou FireMonkey e não precisa de DLL externa nem de driver de impressora. O TsgcReportEngine prepara relatórios sem janela, em um serviço do Windows ou em um daemon Linux64.
Cada worker cria o seu próprio relatório, engine, fontes de dados e exportações, enquanto um TsgcReportFontManager somente leitura atende todas as threads. sgcReportsConfigureForServer ajusta o gerenciador de memória para muitas threads no Windows.
Uma definição salva pelo designer é um arquivo JSON normal, então um servidor a carrega com sgcReportLoadFromJSONFile e a executa sem interface gráfica. A demonstração ReportLinuxDaemon monitora uma pasta de tarefas e renderiza PDF, XLSX, CSV ou PNG com 4 threads de trabalho.
Um aplicativo que migra para o sgcReports normalmente já tem muitos relatórios. Converta-os em vez de desenhá-los de novo.
Importação de relatórios somente Registered
TsgcReportImporter converte formulários do QuickReport (.dfm com um TQuickRep) e modelos do ReportBuilder (.rtm), em texto ou binário, em definições de relatório e lista cada objeto, propriedade, expressão e script que não pôde mapear. Os designers VCL, FireMonkey, WinForms, WPF e Avalonia têm um comando Import. Você revisa a lista, adiciona as fontes de dados, corrige o restante no designer e salva o resultado como uma definição JSON.
DataSourceMap o renomeia para a sua própria fonteImportResult guarda o resultado da última importação, e os designers mostram os problemas em uma janelaoReport := TsgcReport.Create(nil);
oImporter := TsgcReportImporter.Create;
try
// the old pipeline Orders is the data source Sales here
oImporter.DataSourceMap.Values['Orders'] := 'Sales';
try
oImporter.ImportFromFile(oReport, 'orders.rtm');
sgcReportSaveToJSONFile(oReport, 'orders.json');
except
on E: ESgcReportImportError do
WriteLn('Not imported: ', E.Message);
end;
finally
oImporter.Free;
oReport.Free;
end;Vai migrar um aplicativo inteiro? O kit de migração do QuickReport mapeia bandas e controles para os equivalentes do sgcReports com passos numerados.
| Destino | O que roda | Plataformas |
|---|---|---|
| Delphi 7 a 13 | Modelo de relatório, expressões, dados, layout, engine, builder fluente e exportações | Windows, Linux64, macOS, iOS e Android |
| C++ Builder 2007 a 13 | As mesmas classes | Cabeçalhos .hpp gerados e bibliotecas estáticas |
| Designer e visualização VCL | TsgcVCLReportDesigner, TsgcReportPreviewVCL | Windows |
| Designer e visualização FireMonkey | TsgcFMXReportDesigner (Delphi XE6 e posterior), TsgcReportPreviewFMX | Visualização no Windows, macOS, iOS e Android |
O sgcReports é vendido isoladamente a partir de €199 por desenvolvedor, com código-fonte completo e 1 ano de atualizações, e está incluído no sgcUI Enterprise e no pacote All-Access. Ele grava PDF por meio do sgcPDF, que é necessário em qualquer configuração. Os designers para o usuário final, a importação de relatórios, a exportação para DOCX, ODT e RTF e o designer web estão na edição Registered; a versão de avaliação tem todos os recursos liberados.
Vincule os seus dados com um TsgcReportDataSetSource sobre um TDataSet, descreva as bandas com TsgcReportBuilder e chame SaveToPDF, como no exemplo de código acima. Se preferir desenhar o layout, solte um TsgcReport, um TsgcReportEngine e um TsgcVCLReportDesigner em um formulário, crie o relatório e salve-o como uma definição JSON. Os dois caminhos produzem o mesmo modelo de relatório.
Sim, na edição Registered. TsgcVCLReportDesigner e TsgcFMXReportDesigner são designers para o usuário final que você incorpora aos seus formulários, e sgcShowReportDesigner abre um de forma modal a partir de um menu. Para aplicativos web, TsgcReportHTMLDesigner roda no navegador. Todo designer salva definições JSON que carregam em qualquer lugar do sgcReports.
Sim, na edição Registered. TsgcReportImporter converte modelos do ReportBuilder (.rtm), em texto ou binário, e formulários do QuickReport (.dfm com um TQuickRep) em definições de relatório, e lista cada objeto, propriedade, expressão e script que não pôde mapear. Os designers têm um comando Import que faz o mesmo. Veja Traga seus modelos de relatório existentes.
Sim. SaveToPDF e SaveToXLSX no builder, ou TsgcReportPDFExport e TsgcReportXLSXExport nas páginas preparadas, gravam PDF/UA-1 com tags (PDF/A-3 sob demanda) e pastas de trabalho do Excel que mantêm os números como números. CSV, PNG, HTML, ODS, SVG e texto simples estão em todas as edições, e DOCX, ODT e RTF na edição Registered.
Atribua o engine a um TsgcReportPreviewVCL e chame Prepare. A visualização pagina, aplica zoom, busca texto e exporta, e Print imprime o documento exibido. Os aplicativos FireMonkey usam TsgcReportPreviewFMX no Windows, macOS, iOS e Android.
Sim. O núcleo não tem dependência de VCL ou FireMonkey nem DLL externa, então o TsgcReportEngine e as exportações rodam em serviços do Windows e em daemons Linux64, com um engine por thread. A demonstração ReportLinuxDaemon renderiza tarefas de uma pasta com 4 threads de trabalho.
Delphi 7 a 13 e C++ Builder 2007 a 13. TsgcReportBuilder é uma classe simples que funciona no Delphi 7, sem exigir métodos anônimos. O designer FireMonkey exige o Delphi XE6 ou posterior. As mesmas classes estão disponíveis para .NET.
Sim, sempre. O sgcReports grava PDF e desenha códigos de barras com o engine do sgcPDF, e as visualizações desenham por meio do controle de visualização de PDF do sgcPDF. O sgcUI Enterprise inclui os dois.