Report editor
A report is a compilation of one or more charts that have a common technical context.
You can, for example, assign your own titles, switch automatic updating on or off or specify the order of the charts contained.
In addition, access rights can be assigned for individual reports and variables can be made available to allow consumers to make their own adjustments.
User interface
-
Report overview
-
Configuration of a report (see Configuration of a report)
-
Preview area of the selected report
Adjust areas
The width of the individual areas can be adjusted or completely collapsed, e.g. to make hidden information visible.
Adjust the width of areas:
Collapse or expand areas:
Live Update
- What is the "Live Update" function used for?
-
Activating the Live Update ensures that changes in the chart are visible directly in the preview area.
- When should the Live Update be deactivated?
-
If comprehensive charts with many data points are to be displayed, rendering and visualizing the charts requires more capacity. Depending on your individual resources, the performance of the application may be affected.
Therefore, if you notice or expect limitations during configuration or a slow image build-up in the preview area, deactivate the live update.
Add/manage reports
| Button/icon | Description |
|---|---|
Add |
Creates a new element. |
Duplicates the selected report including all configurations and adds the copy to the list. |
|
Removes the selected element. |
|
Execute |
Creates a report based on the existing configurations. |
Save |
Saves the configurations or changes. |
Configuration of a report
Here you will find the possible settings for reports. Adjustments are possible in the following areas:
General settings
-
Naming of the report.
-
Switching the automatic reload of a report on/off.
-
The interval in seconds at which the automatic update is repeated.
If the auto-update is switched off, this setting has no function.
Layout configurator
You can determine the arrangement of the charts in the layout configurator.
The following options are available:
-
Vertical: Each chart occupies the full width and shares the height with the other charts.
See ExtJS documentation for the configuration of horizontal layouts.Example of vertical arrangement
-
Horizontal: Each chart occupies the full height and shares the width with the other charts.
See ExtJS documentation for the configuration of horizontal layouts.Example of horizontal layout
-
Column layout.
See ExtJS documentation for the configuration of column layouts.Example of column layout
-
Tab layout.
See ExtJS documentation for configuration as tabs.Example of tab layout
-
Accordion layout
See ExtJS documentation for configuration as accordion layout.Example of accordion-style layout
Selected charts
The selection of charts in the report is realized via a tabular view.
The table contains the following columns:
-
Selection of all charts created for the current module component.
-
A title can be assigned as an alternative to the chart name. This can be seen as a heading in the tab layout, for example.
-
Chart type of the selected chart, which is displayed as an icon (cannot be changed).
-
JSON field for assigning additional 'ExtJS' layout Parameters to individual components (e.g.
\{"flex" : 2}).
Varies depending on the layout type (see Layout configurator). -
Edit chart.
Opens the chart editor for editing. -
Remove chart.
Removes the selected chart from the report. -
Add chart.
Adds a new chart to the report.
Variables
Report variables can be defined in the Variable Configurator to make charts customizable for consumers.
These variables are created at report level and can be associated with charts and their underlying data set variables (see Data set variables).
Consumers can thus determine the time intervals or date periods considered themselves, for example.
-
Naming of the report variable.
The name can be changed directly in the cell by double-clicking. -
Value of the variable.
The value can be changed by clicking in the field or in Variable detail view. -
Variable type that was defined in the Variable detail view when it was created.
Should be identical to the variable type of the data record variable when linked, see Data record editor (cannot be changed). -
Activates/deactivates access to the variable for consumers.
-
Activates/deactivates the global link (see Global variables)
-
If the global link is active, you can click on a global variable can be selected by clicking.
-
Each data set variable used in the report receives exactly one report variable to which it is linked. This report variable receives the default value from the data set variable associated with it.
All changes made by the user to the report variables are reset by this action. -
Opens the Variable detail view. A window opens in which user-specific variables can be added and existing report variables can be linked (i.e. associated) with data set variables.
The detailed view also offers a preview of all existing charts with their associated data set variables.
Global variables
Global variables are already available in the BPC context, including:
| Global variable | Type | Description |
|---|---|---|
|
Text |
The logged-in user in the BPC |
|
Date |
Start value from the "Global Date Range Filter" (see Global date filter) |
|
Date |
End value from the "Global Date Range Filter" (see Global date filter) |
These variables can be bound to report variables of the same type.
This transfers the value from the global variable to the report variable.
If a global variable is not available, the value that is set on the report variable is used.
Variable detail view
The detail view is divided into two areas:
-
Listing of all report variables
-
Listing of all charts with associated data set variables
The variables are grouped by chart
The following information is also visible:
-
Name of the report variable
-
Current value of the report variable
-
Type of report variable
-
Selection of the visibility of the report variable
-
Selection of whether the report variable is globally active
-
Info on whether a global variable is active + whether a global variable is active
-
Selection for linking the data set variable with the selected report variable
-
Name of the data set variable
-
Value of the data set variable
-
Type of the data set variable
Add report variable
-
Click Add.
A window opens:
-
Enter the name and select the type.
-
Click Add.
The variable is created and appears in the overview of report variables.
Association of report variables with data set variables
The following conditions must be observed when associating variables:
-
The data set variable to be linked must have the same type as the selected report variable:
-
The data set variable to be linked must not already be linked to other report variables:
-
Select the report variable to be linked.
-
Select the data set variable whose checkbox is active (only then is a link possible):
-
Select the checkbox:
The link is now active and the value of the report variable is transferred to the data set variable.
-
If necessary, add further associations.
-
Click Save.
The detail window is closed and the variable configuration and the entire report are saved.
A report variable can be linked to any number of data set variables.
If you want to restore the previous report configuration, click Cancel.
Access rights for consumers
Here you can restrict the access rights of reports for the report consumers. The "Rights/Roles/Organizations" principle is used for this, see Mapping of organizations, roles and rights.
-
Allows consumers to enable or disable the automatic reload of the report.
-
Allows consumers to adjust the frequency of the automatic reload.
-
Enter the rights designation or (if available) select an entry from the drop-down list.
-
Enter the role name or (if available) select an entry from the drop-down list.
-
Enter the organization name or (if available) select an entry from the drop-down list.
Save the settings.
You can now continue at Catalogue editor.
