Print documents
|
XML name |
core:PrintDocument |
|
Class name |
de.lobster.scm.print.PrintDocument |
|
Permission |
Administration/Designer/Print Document |
JasperReport templates are used for printing or exports in other formats (e.g. PDF).
Technically, this process generates and compiles Java classes from JasperReport configuration files (*.jrxml) using the JasperReport-Framework.
These Java classes are provided with data from which they create the printing content.
Template files can be created and configured e.g. with JasperStudio. The Export-Xml of the selected entity serves as the data source.
Which print document is used depends on the type, the mode, and the association criteria assigned to the document (see also Association criteria).
This image shows the view for editing print documents.
(1) New, Delete, Cancel, Copy, Save: Standard functions for manipulating print document objects.
(2) List: Data grid with print documents available in the context of the current session.
(3) Assign: Inspect or modify association criteria linked to the selected print document.
(4) Owner: The owner of the print document object.
(5) Name, Description: The name and description of the document.
(6) Pre Processor Profile: This is optional. The profile bearing this name is opened before printing, and the print-export-XML is transferred to it. The returned value is then used to test the JasperReport-file.
(7) Type: Print document type. Supported choices: RAW, Jasper Report.
(8) Mode: Choices for Print document mode
'Single': The print document is only applicable for a single selection (exactly one object).
'Multi': The print document is only applicable for multi selection (two or more objects).
'Single or multi': The print document expects a multi selection but is also applicable for a single selection ('multi selection with only one element').
(9) Skip original when paginations exists:
If the option is checked: The original document can only be selected, if no pagination is found.
If the option is unchecked: The original document appears as a choice next to paginations, if any.
(10) Document: This supports uploading and downloading the print template. A Zip-archive containing all necessary data for the print document is expected. When uploading, all included .jasper files are compiled (.jasper files) and added into the Zip-archive. The compiled files (.jasper files) are included in the archive upon download.
Additionally, when there are several .jrxml files, a property-file (template.properties) with the value 'masterreport' and the name of the master report has to be included for the report. For example:
masterreport=BookingConfirmation\_body.jasper
(11) Paginations: Paginations can be defined to specify how a certain output page format should be populated with instances of the original layout, e.g. by repeating an A6 template on an A4 page.
Pagination
(1) Name: The name of the pagination, to show in the context menu when a choice is required.
(2) Print types: The selection of one or more print types for which the pagination should apply (see Print type).
(3) Can modify format? This specifies if settings for (4) – (7) and (10) – (15) can be adjusted before printing.
(4) Page format: The format of the output page.
(5) Landscape? This defines page orientation (checked: landscape, unchecked: portrait).
(6) Columns: This the specifies number of columns in the output page.
(7) Rows: This specifies the number of rows in output page.
(8) Direction: This specifies the pattern for populating the output page.
(9) Can modify direction? This specifies whether the setting for direction (8) can be modified before printing.
(10) – (15) Margin/Padding width: This specifies the margins and padding in mm (millimetres).
(16) Preview: The schematic preview of the layout for the output page; clicking on a tile initializes the pattern for the first page.