The Report Designer Display

In Report Designer Display the layout of reports generated by Report Item objects can be edited.

This page is meant to provide a quick introduction to the Designer Display and it’s sections before they are put into use in the following examples.

Opening the Report Designer Display

To open the Report Designer Display, press CTRL+O or select Open  Report Designer from the menu bar. A dialog pops up where the Report Items, which are to be added to the new report, can be picked from the I/O Model - e.g. the Test Report created in the previous section.

Alternatively, right-click on the respective Report Item object in the I/O Model (e.g. the Test Report) and select Add item to…  Report Designer from the context menu. This opens the Report Designer workspace with its Properties panel opened on the right hand side.

When a Report Item object is opened in the Report Designer display for the first time, a new section called Report Design Data is added to the Report property compound of this Report Item object.

In the Report Design property, the report layout is stored in XML format.

The value of the Report Name property will be used for the ReportName variable in the reporting engine. The default value is Report.

The sections of the Report Designer Display

The Report Designer Display
Figure 1. The Report Designer Display

[1] The Toolbar

The Toolbar provides shortcuts for basic functionality (like 'Save', 'Undo' etc.) as well as for fundamental editing tools. A lot of the functionalities provided by the editing tools can also be reached through other ways, eg. in the Properties tab.

[2] The 'Elements' Bar

This bar hosts the building blocks of reports. The top five icons are element groups, which group related elements. For users who are not yet familiar with the icons, these groups are a good starting point fovradding elements to the report.

The groups are:

  • Bands - the basic structural elements of a report

  • Cross Bands - for advanced use cases

  • Components - texts, images, check boxes and tables etc.

  • Shapes - lines and rectangles

  • Infographics - elements for graphical representation of data, diagrams

All other elements are shortcuts to selected entries of the groups above. These shortcuts are for users who are already familiar with the icons.

[3] The Workspace

Here, the symbolic representation of the report layout is displayed. Elements which have been added to layout can be selected (e.g for setting properties, see below), moved, and manipulated with the mouse.

[4] The Panel Section

What is shown in this section depends on the selected tab.

[4.1] The Properties Tab

If the Properties Tab is selected, the properties of the selected element of the report can be configured in the Panel Section.

[4.2] The Dictionary Tab

The Dictionary contains all the available data items that can be added to the report. In the Data Sources table the Query Options configured in the Report Item object are represented for the report. The Reporting Engine also provides a variety of System Variable and Functions. Also custom Variables can be created.

Data Sources

Dictionary Panel - Data Sources

If the Report Item is configured correctly, a folder for its Data Set is available in the Dictionary tab, under Data Sources, - its name matching the DataSet Name property of the Report Item (ds by default). If there is no data set visible, it may be necessary to re-execute the Lua script in the Report Item.

 

Query Options in Dictionary Panel

Expand the ds data set. If you added all the Query Options examples from the previous page, the Dictionary should look similar to the screenshot shown here.

Each of the different configured Query Options (rt - Realtime, ns - Namespace, and ht - History) is represented by two tables in the Dictionary:

  • The first table contains static property data (the …​_items table for the Realtime and History Query Options, and the …​_properties table for the Namespace Query Option).

  • The second table contains dynamic property data (the …​_data table for the Realtime and History Query Options, and the …​_instances for table the Namespace Query Option).

     

To view the content of a table, right-click on it and choose View Data… from the context menu. This opens up a table dialog, showing all the data in the selected table.

View Data in Dictionary Tables
Figure 2. View Data in Dictionary Tables

Property data from any table can be added to reports by dragging and dropping into 'Bands' that are added to the display workspace (this is explained in the next section). The dynamic property data is updated from the Query Objects when the report is viewed at Run Time.

 

Variables

System Variables in the Dictionary Panel

Also available in the Dictionary Panel are the System Variables. These include various variables that are related to the report in general (for example the report name, the current time and date) without querying objects in the namespace.

 

Functions

Functions in the Dictionary Panel

Also available in the Dictionary are a series of predefined functions that can be used to display calculated data values. For example, counting the number of items in a data band or the time span between two dates.

 

[4.3] The Report Tree Tab

This tab shows the whole report as hierarchical structure, allowing quick access to elements which are on different pages of the report. Selecting an element in this tree opens the corresponding report page in the workspace and marks the element as selected there.