Summary
- Enable custom dashboards in the advanced team administration.
- Create a first customizable dashboard.
- Configure the dashboard from the user interface from the Edit mode, adding widgets and indicating in which position they should be displayed.
- Save.
How can I enable customizable dashboards?
Athento allows the creation of multiple dashboards within a team. To activate the new dashboards you must check the "Show dashboard dynamic items" checkbox from the advanced administration in the team configuration.
How to create a customizable dashboard?
After activating the customizable dashboards in the space, a new icon will appear in the navigation bar.
Once we access this view, a button that allows us to create a dashboard will appear in the upper left corner.
After clicking on this button, a modal will appear in which a dashboard can be created indicating its label and order (this order indicates how they will appear later in the drop-down menu of the same view).
By clicking on the create button in the modal the dashboard will have been created and it will appear for us to edit it.
Note: If we want to create a dashboard when there is already an existing one in the same area, a drop-down menu will appear at the end of which the creation modal will appear.
How to create a customizable dashboard widget?
Dashboards are composed of widgets. Each of the elements we can see on the dashboard is a widget. They all have properties in common:
- dashboard: dashboard to which the widget belongs.
- position_x: The dashboard is divided into 12 columns. In this value you must indicate the column in which you want the widget to start. The value 0 is equivalent to column 1, 1 is equivalent to column 2 and so on.
- position_y: The dashboard is divided into rows, depending on the size of the "row_height" attribute of the dashboard. This value indicates the row where you want the widget to start. The value 0 equals row 1, 1 equals row 2 and so on.
- width: Width of the widget. This value would be the number of columns that the item will occupy.
- height: Height of the widget. This value would be the number of rows that the item will occupy.
Although we explain the properties of the dashboard widgets, the creation of them is done from the product interface and you will not have to worry about filling them.
You can include widgets of different types:
-
document upload widgets: They are used to quickly upload documents from the dashboard. Two parameters can be specified for these widgets:
- Space: Space in which the documents will be uploaded using the upload widget. If you specify a space, it will not be possible to modify it from the interface. Otherwise, you will be able to select it when uploading the document.
- Form: Form that will be used to upload documents using the upload widget. If you indicate a form, it will not be possible to modify it from the interface. Otherwise, you will be able to select it when uploading the document.
-
document queue or document tray widgets: There are three types of displays available for this type of widget.
- Total documents: These are used to display the number of documents that are in a previously configured tray.
- Document list: Displays the same list of documents as in the tray view with the same queue configuration selected.
- Result of a function: Shows the result of a function belonging to the tray applied on specified metadata belonging to the documents inside the queue.
For these widgets you must indicate two or three parameters, depending on the type of display you choose:
- Tray: Tray on which the information will be displayed in the widget.
- Type of visualization: Type of widget to be used among those mentioned above.
- Queue function: Function belonging to the tray, whose result after being applied to the documents in the queue will be shown in the widget. See more.
-
document listing widgets: They serve to display document listings. These widgets have several parameters:
-
query: ATQL query to be made to obtain the results to be displayed in the document table (Information on how to build them).
-
limit: (Optional) Limit of results that will be shown in the document list. If not specified, all the documents obtained through the query will be shown.
-
-
graphics widgets: They are used to display customized graphics. These widgets have only one parameter:
-
chart: chart that you want to display in the widget.
-
Dashboard editing mode
To configure these widgets, once the first dashboard has been created, we must go to the edit mode. This mode is only available to superusers and team administrators. It is activated by clicking on the button in the upper right corner of the dashboard.
In edit mode, there are mainly 2 buttons available, located on the left side of the screen.
The function of these buttons is as follows:
- Add widget: When you click it a popup window will appear where we can fill in the information corresponding to the widget we want to create. Give a name for the widget, this name will be displayed at the top of the widget. You must also indicate the type of widget. Once the widget type is selected, we will have to specify the widget settings.
-
Save: Used to save the state of the dashboard elements. All changes you make to the widgets will NOT be saved automatically, so you must save before exiting the edit mode.
Editing an already created widget
You can edit an existing widget by right-clicking on it. The menu that appears has two options:
-
Edit: to change the widget configuration.
-
Delete: to remove the widget from the dashaboard.
Reposition a widget
Additionally, we can enlarge and move the widgets to our liking.
- Position the widget: To move the widget, simply hold down the left mouse button while moving the item.
- Adjust the size: To adjust the size we must do the same but in the lower right part of a widget.
Important: Don't forget to save to keep the changes made in the dashboard.
Comments
0 comments
Please sign in to leave a comment.