Introduction to Print Format Editor
Compiere Print Format Editor allows you to use a sleek, drag-and-drop Flash interface to design your form-based report layout exactly the way you want. Set colors, styles, relative or absolute positions and more. This feature was introduced in Compiere Release 3.6, Enterprise Edition.
Print Format Editor is only available in the Web UI of the Compiere Enterprise edition. Your role security determines which print formats are accessible to you for update. To customize a print format that Compiere delivers, please create a copy and then update it to suit your needs. Launch Print Format Editor and select the new print format to change its layout. Save your changes and run the Cache Reset Web process. Run a report using your newly updated print format to view the new layout.
The Print Format Editor contains 4 main sections.
- The Toolbar at the top is where you select the print format you want to edit along with save and undo icons for the changes that you make.
- The Navigator panel on the left shows you a tree with the print format and the print format items it includes. There is an icon adjoining each print format item representing the display type inherited from the linked column reference e.g. Search, Checkbox, Button.
- The Properties panel displays properties for the print format item you select. This is where you define print options for the print format item.
- The Layout area on the right allows you to design the form-based report layout for the currently selected print format.
Form-Based Report Design
Launch the Print Format Editor and enter the name of the print format you want to edit. You can only design layout for one print format at a time. The Navigator panel shows all the print format items for the currently selected print format. Some print format items are in black indicating they are available for dragging from the Navigator to the Layout area so that they can be added to the print format layout. Other print format items are in gray indicating that they are already included in the print format layout and are not available for dragging. You can drag and drop print format items or reposition them. To position a print format item relative to an existing item in the layout, drop the item when you see a black insert marker. To place a print format item in an absolute position, drop it anywhere in the layout ensuring you don't see a black layout marker. You can always update the Properties to achieve the exact layout.
The layout you define here is a representation of how the report will print. Depending on your setup, items will expand and wrap based on the actual data being printed.
If the user you logged in has AutoCommit turned on in User Preferences, changes will be automatically saved when you load a new print format. If AutoCommit is not turned on, you will receive a popup message asking you to save or cancel your changes.
Click on a print format item in the Navigator or the Layout area to edit its properties. The following print format item properties are available for editing or display:
Name - Enter an identifier for the print format item.
Print Text - Enter a label or prompt for the print format item here. This value is printed in the report.
Seq No - This value is automatically filled in for you. Advanced users may update it if they want.
Format Type - This is a display only value indicating the type of item - derived from a Field, Image, child Print Format, etc.
Suppress Null - Hide null values when printing.
Centrally Maintained - Uncheck this property to indicate that the Name has been overridden in the print format item properties and no longer matches the System Element. This property is automatically unchecked if you update the Name.
Image Field - Only available for editing if the print format item is of type Image. Indicates image is to be retrieved from the column associated with this print format item.
Column - Column associated with this print format item.
Image Attached - Only available for editing if the print format is of type Image and Image Field is unchecked. Indicates that the image is uploaded as an attachment to the print format item record in Compiere.
Image URL - Only available for editing if the print format is of type Image, Image Field is unchecked and no image is attached. Enter the URL for the image here.
Area - Indicates whether the print format item is to be displayed in the report header, content or footer. This value is automatically set for you.
Relative Position - If checked it indicates this print format item is to be placed relative to the print format item with the next lowest sequence. If unchecked, it indicates this print format item has an absolute position. This value is set automatically for you when you position an item in the Layout. You may update it in the Properties if you want.
Set NL Position - Indicates where data should print for following lines of information.
X Position - Specifies the print location for print format items with absolute position.
Y Position - Specifies the print location for print format items with absolute position.
Next Line - Indicates this print format item is to be printed in the next line relative to the previous print format item.
Next Page - Indicates this print format item is to the printed on the next page relative to the previous print format item.
Line Alignment - Indicates how relative print format items that share a line are to be aligned during printing.
Field Alignment - Indicates how data for this print format item should be aligned.
X Space - Indicates the relative space after the previous print format item that this print format items should be printed.
Y Space - Indicates the relative space after the previous print format item that this print format item should be printed.
Max Width - Maximum width available for printing this print format item. Does not apply to print format items of type Print Format.
Fixed Width - Indicates that print format items of type Field will be printed with a fixed width.
Included Print Format - Indicates the child print format to be included when printing this report for print format items of type Print Format.
Max Height - Maximum height available for printing this print format item. Does not apply to print format items of type Print Format.
One Line Only - Print format items of type Field are printed wrapped in multiple lines if the item has a width restriction. If this property is checked, only the first line of data is printed.
Print Color - Indicates the color to be used for printing this print format item. If no value is set, the default value from the print format is used.
Print Font - Indicates the font to be used for printing this print format item. If no value is set, the default value from the print format is used.
Barcode Type - Indicates if this print format item of type Field is to be printed as a barcode in the report.
Order By - Indicates that report data should be sorted by data values in this print format item of type Field.
Ascending Sort Order - If checked, it indicates the print format item should be sorted in ascending order.
Record Sort No. - Indicates the sorting sequence for this print format item in case multiple print format items are selected for ordering data.
Group By - Indicates that the report should be grouped by data value in this print format item.
Page Break - Indicates if there should be page break for every new group of data.
Calculate Sum - Calculate a sum for this print format item.
Running Total - Calculate a running total for this print format item.
Calculate Count - Count the number of non-empty elements for this print format item.
Running Total Lines - Page break every x lines to calculate the running total for this print format item.
Calculate Minimum - Calculate the minimum value for this print format item.
Calculate Maximum - Calculate the maximum value for this print format item.
Calculate Mean - Calculate the average of the numeric content or length for this print format item.
Calculate Variance - Calculate variance for this print format item.
Calculate Deviation - Calculate standard deviation for this print format item.