Reporting
Description
From this window, you can print all reports belonging to a list or copy the contents of the list to the clipboard. New reports can also be created from this module.
Functionality
Reports
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Reports | |||||||||||
| : list | Information (number of objects, selected objects) is displayed for the list that is to be output to the interface. If the window remains open and changes are made to the list, the changed list is always copied. | ||||||||||
| : Reports | Overview of the reports available for the list called up. To print an existing report, select it from the list and click Print Report. To open an existing report for editing, double click on the report in the list.
| ||||||||||
| Description | Description of the selected report | ||||||||||
| : Features | Output of any existing characteristics for the report (output options). | ||||||||||
| : : characteristic | Change the value of the selected characteristic only for the next printout. To permanently change the characteristics, double-click the desired report and switch to the "Characteristics" tab. | ||||||||||
| : Output | |||||||||||
| : Report output | A file is always created when the report is created. With this setting you can define whether it is to be displayed or printed in addition. Standardised Windows functions are used for printing and displaying. If, for example, PDF is selected as the format, it must be ensured that the automatic display and printing of files in PDF format is possible on the Windows system. | ||||||||||
| Print only selected list entries | Only selected list entries are output with the report. | ||||||||||
| : : Report remains activated! | The report remains loaded after closing the report window or after printing or data transfer to BIRT. | ||||||||||
| : Paper alignment | Selection between "Portrait" and "Landscape" for formatting the output. | ||||||||||
| : Paper Format | Definition of the paper size with which the output file is to be formatted. Possible definitions are A0- A10, US Legal and US Letter. | ||||||||||
| : Report medium | Data format of the output file. The output of the report differs depending on the format. The standard reports are optimised for output in PDF format. | ||||||||||
| : Archiving | - | ||||||||||
| : : None | These options are taken from the default settings of the selected report and can then be changed. When registering, only the printing of the report itself is registered. This means that an output object is created which stores the calling user, date and time. So you can track when and who has printed a report. When archiving, a *.PDF file of the printed report is saved in addition to the registration. This file is stored either in the database or in a directory. This depends on the specification "archiving in directory" and by selecting the directory. Printing a report when Register or Archive is set displays the indication of printing in the Repeat tab. | ||||||||||
| : : Register | |||||||||||
| : : Archive | |||||||||||
Interface | |||||||||||
| : list | Information (number of objects, selected objects) is displayed for the list that is to be output to the interface. If the window remains open and changes are made to the list, the changed list is always copied. | ||||||||||
| : List entries | - | ||||||||||
| : : Output all list entries | All list entries, i.e. the entire list is copied/exported to the clipboard. | ||||||||||
| : : Output only selected list entries | Only selected list entries are copied/exported to the clipboard | ||||||||||
| : : Output column headings with | The column headings are exported as the first line. | ||||||||||
| : Row options | - | ||||||||||
| : : Single line | If a list entry has several lines, only the first line is exported. | ||||||||||
| : : Multiple lines | If a list entry has more than one line, it will be exported in multiple lines. | ||||||||||
| : Clipboard | |||||||||||
| : :Copy to clipboard | The content of the list is copied to the clipboard. The clipboard then contains the content of the list in CSV (comma-separated columns) and TXT (tab-separated columns) formats. In other applications such as MS-Excel, the contents of the clipboard can be pasted directly, e.g. via Ctrl-V, or via a menu item that is usually called "Paste" or "Paste contents...". is called. Using the latter menu in MS-Excel, the format to be pasted can also be selected. This method does not work with ObjectTree (tree) and ObjectCombobox (selection list). Icons or graphics are not transferred. This button is not available if this app is called up via a browser. | ||||||||||
| : File output | |||||||||||
| : : Excel (.xslx) | The content of the list is output directly to an Excel file with the extension (.xlsx). | ||||||||||
| : : HTML | The content of the list is output directly to an HTML file with the extension (.html). | ||||||||||
| : Diagram | |||||||||||
| : pivot | |||||||||||
| : Neural network | |||||||||||
Repeat | |||||||||||
| : List of archived documents | This displays the archived documents that were previously created by printing a report under the Register or Archive option. The "Report" column shows the report name that was printed. The "Attachment" column shows whether the printout was archived. If this is the case, you can view this PDF via the "Open" button. | ||||||||||
| Stored lists | |||||||||||
| : Lists | List of saved lists for which the user
| ||||||||||
If a report is identified by this screen, it is a 'normal' report, i.e. the structure of the list on the screen corresponds to the structure of the list in the printed report. 
This symbol means that the report has its own list format, i.e. there are commands for the
| Button | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Back | The window is closed. | ||||||||
| New report | Call the Report module to define a new report. | ||||||||
| Print report | The selected report is printed. This button is greyed out if either no report has been selected or the selected report has no BIRT report design. | ||||||||
| Display report | If the selected report has a specially defined list design, this is displayed. | ||||||||
| Reports | |||||||||
| Apply | Write value to characteristic for current report creation only. | ||||||||
| Insert column | Add columns to the current list with the access configurator without creating a new report. | ||||||||
| File output | |||||||||
| Export to file | The button starts the file output in the selected format. | ||||||||
| Draw | Create diagram with the data of the list. | ||||||||
| Pivot | Open a pivot table with the selected items. | ||||||||
| Neural network | Create a neural network with the selected data from the list. | ||||||||
| Repeat | |||||||||
| Open | Open the selected report. | ||||||||
| Saved lists | |||||||||
| ... |
| ||||||||
| Save | Save the current list in the list box | ||||||||
| Delete | Delete selected "Saved list" entries | ||||||||
| Open | Fill list with the "Saved List" entry. | ||||||||
Related topics
- Data connector editing app
- Data field editing module
- Data query wizard
- Report editing module
- Report display editing app
Technical documentation
Implementation
Classes
Quality Assurance
Reporting Module
Module name
reporting.app
Security
In addition to restricting access rights via the class and its data fields, the module can be restricted in its use via some of the received messages.
| Message | Parameters | Function | Security |
|---|---|---|---|
| COPY_TO_CLIPBOARD | |||
| PRINT_REPORT | |||
| SELECT_DEFAULT_REPORT | |||
| TEST_PRINT_REPORT |
| Message | Parameters | Function | Receiver module |
|---|---|---|---|
| ASK_ALTERNATIVE | |||
| ASK_ML_STRING | |||
| ASK_STRING | |||
| CREATE_DATA_CONNECTOR | |||
| CURRENT | |||
| DEFAULT_REPORT_SELECTED | |||
| DEPLOY_FORMAT | |||
| EDIT_DATA_CONNECTOR | |||
| EDIT_OUTPUT | |||
| EDIT_PIVOT | |||
| EDIT_REPORT | |||
| LOAD_NEURAL_NETWORK | |||
| PLOT_CHART | |||
| RELOAD_FORMAT | |||
| RESET_HIDDEN_REPORT_LIST_BOX | |||
| SELECT | |||
| SELECT_ACCESS_PATH_BY_DATA_CONNECTOR | |||
| SELECT_USER | |||
| SWITCH_HIDDEN_REPORT_LIST_BOX | |||
| UPDATE_HIDDEN_REPORT_LIST_BOX |
;){kind=link}
;){kind=link}
;){kind=link}