QPR ProcessAnalyzer Dashboard Designer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
The dashboard viewer/designer is for viewing, designing and implementing dashboards by adding components from the tool palette, adjusting their sizes and positions and making settings for each component.
The dashboard viewer/designer is for viewing, designing and implementing dashboards by adding components from the tool palette, adjusting their sizes and positions and making settings for each component.


There are the following modes:
== Editing Dashboards ==
* '''Preview''': Used to view the dashboard. Made changes are not saved to the dashboard. There is no confirmations about unsaved changes when going to another dashboard.
For editing dashboards, there are the following modes available:
* '''Edit''': Used to make savable changes to the dashboard. When existing the edit mode without saving changes, there is a confirmation question.
* '''Preview''': When opening a dashboard, the Preview mode is in use by default and it's used simply to view the dashboard. Chart settings can be changed temporarily, and the changes are not saved to the dashboard. There is no confirmation message about unsaved changes when going to another dashboard.
* '''Edit''': Used for making savable changes to the dashboard. When opening the dashboard in the next time, it opens in the saved state. When existing the edit mode without saving changes, there is a confirmation question.
* '''Add component''': Used to add new charts, remove charts and move/resize charts.
* '''Add component''': Used to add new charts, remove charts and move/resize charts.


Edit mode can be activated by clicking the '''Edit''' button in the Preview mode. Note that there is no edit button, if user doesn't have permissions to edit the dashboard. The Add component mode can be activated by clicking the Plus button in the Edit mode. It's possible to go back to Edit mode from Add component mode by clicking the '''Done''' button.
Edit mode can be activated by clicking the '''Edit''' button in the Preview mode. Note that there is no Edit button, if user doesn't have permissions to edit the dashboard. The Add component mode can be activated by clicking the '''Plus''' button in the Edit mode. It's possible to go back to the Edit mode from the Add component mode by clicking the '''Done''' button.


When there are changes made in the Preview mode and the Edit mode is activated, the changes are preserved and the Edit mode enables to save them. Note that when going back to the Preview mode from the Edit mode, the changes need either to be saved or discarded.
When there are changes made in the Preview mode and the Edit mode is activated, the changes are preserved to be able to save them in the the Edit mode. Note that when going back to the Preview mode from the Edit mode, changes either need to be saved or discarded.


== Dashboard General Settings ==
== Dashboard General Settings ==

Revision as of 15:09, 3 August 2020

The dashboard viewer/designer is for viewing, designing and implementing dashboards by adding components from the tool palette, adjusting their sizes and positions and making settings for each component.

Editing Dashboards

For editing dashboards, there are the following modes available:

  • Preview: When opening a dashboard, the Preview mode is in use by default and it's used simply to view the dashboard. Chart settings can be changed temporarily, and the changes are not saved to the dashboard. There is no confirmation message about unsaved changes when going to another dashboard.
  • Edit: Used for making savable changes to the dashboard. When opening the dashboard in the next time, it opens in the saved state. When existing the edit mode without saving changes, there is a confirmation question.
  • Add component: Used to add new charts, remove charts and move/resize charts.

Edit mode can be activated by clicking the Edit button in the Preview mode. Note that there is no Edit button, if user doesn't have permissions to edit the dashboard. The Add component mode can be activated by clicking the Plus button in the Edit mode. It's possible to go back to the Edit mode from the Add component mode by clicking the Done button.

When there are changes made in the Preview mode and the Edit mode is activated, the changes are preserved to be able to save them in the the Edit mode. Note that when going back to the Preview mode from the Edit mode, changes either need to be saved or discarded.

Dashboard General Settings

  • Name: Name of the dashboard. Maximum length for the name is 100 characters.
  • Identifier: Identifier of the dashboard. The identifier is a text that must be unique in the folder where the dashboard is located. Identifiers are case sensitive, they must not contain "/" characters, and the maximum length is 2048 characters. Identifiers are used to open dashboards by using the sys:dashboardIdentifier variable.
  • Description: Additional descriptive text for the dashboard.

Dashboard Layout Settings

  • Aspect ratio flex: Decimal number determining how much the dashboard's aspect ratio (width divided by height) is allowed to vary.
    • Dashboard has a design aspect ratio which is determined by how presentation objects are arranged during the designing. Note that the whole available design area doesn't matter - only the actual presentation objects determine the shown area and the design aspect ratio.
    • Aspect ratio calculation rule: If design aspect ratio is A and aspect ratio flex is B, the aspect ratio is allowed to change between A/B and A*B. Example: If design aspect ratio is 2 and aspect ratio flex is 4, the dashboard's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
    • Contents always takes all available space horizontally. If the aspect ratio's lower limit is reached (i.e. contents is not allowed use all available space vertically), there may be empty space in the bottom. If the aspect ratio's higher limit is reached (i.e. contents doesn't fit vertically), there is a vertical scrollbar.
    • The aspect ratio flex is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
  • Chart margin: Horizontal and vertical space, in pixels, around charts in the dashboard.
  • Dashboard margin: Horizontal and vertical space, in pixels, in the outer borders of the dashboard.
  • Background color: Background color of the dashboard. It's possible to set transparent background by setting the value of the alpha channel in the rgba to 0 either by inputting the value or by using the rightmost slider.

Dashboard Size Scaling in Different Screens

Dashboards have the following scaling options based on how the aspect ratio flex value has been set:

  • Fixed height: all charts have fixed height in pixels, and the height of charts doesn't change between different screen sizes. The fixed height mode is switched on by defining dashboard Aspect ratio flex to 1.
  • Relative height: all height adjust to the available screen height in a way that the content always takes the entire screen height so the screen is never scrollable nor there is empty space in the bottom of the screen. The relative height mode is switched on by defining dashboards Aspect Ratio Flex to a high enough number, such as 100.
  • Balanced: height adjusts to some degree to the available space, but there is a certain adjustable limit for dashboards' height. The hybrid mode is used when the Aspect ratio flex is set to greater than 1 but not too big number. For example 1.2 - 2.0 might be suitable.

Dashboard Variables

Datasets