homepages service allows creating and visualizing home pages or dashboards combining modules displaying counters, frames and _reports.
See the related guides for more details on how to create and manage these different types of modules (Counters guide, Frames guide, Reports guide).
To see the Home menu entry on the Portal, you need to have the
For a summary of permission names and uses related to this service, please refer to this section.
If you have the
homepages=* permission, you can have access to all the functions mentioned below.
A configuration is a home page layout, it is composed of modules. A module is a unit of display, it contains either a frame, a report or a counter.
View the home pages¶
To read all the home pages, you need to have the
homepages=read permission. Otherwise, you cannot read the data.
If your permission has parameters:
homepages=read('Home page 1', 'Home page 2'), you will only see the Home page 1 and Home page 2 pages.
When accessing the Home pages service, you will first see the dashboard.
You will be able to select one configuration from the one you have access to with the select input on the top left corner of the service.
If you see a home page’s name or a blank space instead of the select input, it means that you have only one configuration or none.
On the top left corner, if you have access to multiples home pages, you will be able to select the home page you want to see. You will always see the last home page you have visited when accessing the service.
Customize the home pages¶
To customize the home pages, you need to have the permission
To access the customization mode, you have to click on the Customize button on the top left corner of the dashboard.
All the actions you will do on a customization won’t affect the default configuration.
A module can be a report, frame or counter depending on what you have access to.
What’s a custom configuration ?
It is a home page configuration saved for the user only.
What’s a default configuration ?
It is a home page configuration saved on the server.
When you are customizing a home page, you have some action that you can do, which are:
- Add a module
- Move a module
- Remove a module
- Choose a module dimension (height and width)
- Save the configuration
- Reset configuration
- Restore to the default configuration
What’s the difference between reset and restore ?
resetcancel every unsaved modification to the last custom configuration saved or to default configuration if there is none.
restorewill get back to the default configuration.
Edit the home pages¶
To edit the home pages, you need to have the permission
To access the grid you will have to click on the Configure home pages button on the top right corner of the dashboard.
To be able to add reports, frames and counters you will need the permissions:
The home page’s name and the English description are mandatory and cannot be empty.
You can edit the home pages by changing their name, description and layout.
The edit panel is divided into two parts:
- The information about the home page
- The configuration
You have the same interaction with the configuration as for the
customization except that:
resetcancel every unsaved modification.
restoreisn’t here because you are interacting with the default configuration.
Remember that instead of the
customize part, each saves will affect the default configuration.