The Dashboard is a component that allows you to gather several pieces of information with a specific purpose into a single screen.
The purpose of a dashboard can be, for example, to summarize the state of a particular area of management. In this context, it can assume the role of Management Dashboard.
The structure of the dashboards is free and can be totally configured by the user, as long as the component is licensed for the current installation.
The parts that make up a dashboard come from a catalog that can be different for each product since these pieces are dynamic and automatically recognized by the system.
These are some examples of dashboard parts:
- Navigator – Allows you to create a set of shortcuts for menu operations or external connections outside the application;
- List – Allows you to show any list configured in the system as long as it is not setup as available for dashboards;
- Chart – Allows you to display any list configured in the system as a chart, so long as it is setup as available for Chart parts in the dashboards;
- Record – Allows you to display a single record from any list configured in the system, so long as it is setup as a list available for Record parts in the dashboards.
Dashboard parts can have associated parameters. If there are parameters, these can be connected to the dashboard parameters.
How to create a new dashboard
To create a new dashboard, the user must choose the menu option: Dashboards | Dashboard
The new dashboard opens in editing mode. The dashboard editing screen is divided into 3 main areas:
- Parameter panel – Allows you to setup parameters that the user can edit. This area is collapsed by default on the left of the editing screen;
- Dashboard construction area – This area is where the dashboard parts can be dragged to and where the user will reorganize these pieces in terms of screen layout;
- Parts catalog – This area displays the parts available to be used in a dashboard.
To build a new dashboard, users must repeat the following actions for each part they wish to include in the dashboard:
- Click and drag the part to the desired area;
- When you drop the part, a dialog box will be displayed at the center of the screen, where the user can:
- Assign a name to the part;
- Write a text describing that part;
- Choose one of the default configurations compatible with that part or specify a new configuration.
After including the desired parts and configuring them, the user can save the dashboard by choosing one of the options on the upper right corner of the screen:
- Save – Allows you to assign a name, description and a place in the menu to place the shortcut for this dashboard;
- Save and Share – The same as the previous option, but the dashboard will be shared with the selected profiles
How to add a parameter to a Dashboard?
To create a dashboard parameter, the user must follow these steps:
- Open the dashboard and choose the edit option from the upper right corner of the screen;
- Expand the parameters panel and choose the New option from the button at the bottom of the panel;
- In the 'New Dashboard Parameter' dialog box, fill in the name, the subtitle and optionally a description;
- You can choose one of the following Types:
- Fixed Value – The user edits the value according to the type of parameter data;
- List selection – The user chooses one of the values entered in the configuration;
- Search value – The user will select a record according to the entity selected in the configuration.
How can I connect a part parameter to a dashboard parameter?
Dashboard parameters are only useful if they can be connected to part parameters.
To connect a part parameter to a dashboard parameter, the user must follow these steps:
- Open the desired dashboard and use the 'Edit' option at the upper right corner to enter editing mode;
- Hover over the arrow on the target part to display the panel with the part parameters;
- In the selected parameter, click the arrow that allows you to choose the dashboard parameter and select the desired parameter;
- Save the dashboard.