Seitenhistorie
| Auszug | ||
|---|---|---|
| ||
Nuclos ReportProvider: run(OutputFormat), run(format, Map), NuclosFile, Report per Regel ausführen, Anhang, Beispiel Java. |
Sprache: Deutsch · English
ReportProvider
Reports per API ausführen – ReportProvider.run(...) liefert ein NuclosFile zum Anhängen oder Versenden.
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Auf dieser Seite
|
Was ist der ReportProvider?
Der ReportProvider ist eine API-Hilfsklasse mit allen Methoden zur programmatischen Ausführung eines Reports – z.B. aus einer serverseitigen Regel.
run(...)
Führt einen Report aus. Anzugeben ist das Ausgabeformat, das eindeutig einem Report zugeordnet ist – deshalb genügt das Format. Rückgabe ist ein NuclosFile, das z.B. als Anhang an ein BO gebunden oder per E-Mail verschickt werden kann.
| Codeblock | ||
|---|---|---|
|
Allgemein
Der ReportProvider ist eine Hilfsklasse, die alle notwendigen Methoden zur Ausführung eines Reports beinhaltet.
Funktionsumfang
...
Diese Methode ermöglicht die Ausführung eines Reports. Im Methodenaufruf muss das Ausgabeformat mit angegeben werden. Das Ausgabeformat ist immer genau einem Report zugewiesen und besitzt eine eigene Id. Aus diesem Grund genügt beim Aufruf des Reports die Angabe des Format.
Beispiel: ReportProvider.run(AuftragsReport.Report_PDF). Da das Ausgabeformat "Report_PDF" immer und nur zum Report "AuftragsReport" gehört, besitzt der ReportProvider alle notwendigen Informationen.
Der Rückgabewert der Methode ist ein NuclosFile-Objekt, das den generierten Report darstellt. Dieses Ergebnis könnte dann z.B. als Attachment an ein BusinessObject gebunden oder per Email verschickt werden.
...
public static NuclosFile run(OutputFormat format) throws BusinessException; |
...
Mit Parametern für die Abfrage:
| Codeblock | ||
|---|---|---|
| ||
public static NuclosFile run(OutputFormat format, Map<String, Object> params) throws BusinessException; |
...
Ein Beispiel finden Sie hier.
Beispiel
Beim Anlegen eines Auftrags wird automatisch der Report ausgeführt und das PDF als Anhang an das BO gebunden:
| Codeblock | ||
|---|---|---|
| ||
package org.nuclet.businessentity;
import org.nuclet.report.MeinAuftragReportRE;
import org.nuclos.api.common.NuclosFile;
import org.nuclos.api.provider.ReportProvider;
public class AuftragReportRegel implements InsertRule {
public void insert(InsertContext context) throws BusinessException {
Auftrag a = context.getBusinessObject(Auftrag.class);
NuclosFile result = ReportProvider.run(MeinAuftragReportRE.Deutsch_PDF);
a.insertAttachment(result, "Kommentar: Generierter Auftragsreport");
}
} |
Verwandte Seiten
...
Überblick
Inhalte