Dashboards

In this topic Hide

About this page

This page is used to create or manage dashboards depending on your level of access. A dashboard is a collection of dynamic and personalised widgets that provide at-a-glance views of different information on the RME Home page, which is the RME landing page. The Home page (WEL001) is automatically assigned to all users to allow access; it is not controlled via Page Views. Dashboards can be created for different roles using a range of widgets for various purposes (high-level access required).

Widgets: For a full list of widgets, see: Dashboard widgets.

A dashboard may be created and set as the default for one or more specific roles so it displays on the Home page after log in (high-level access required).

For more about access for dashboard management, see: Access types and available functions.

Menu path: RME  > Session menu (your username at the top right) > Manage Dashboards

 

Video: Create a dashboard

 

Create a dashboard

Prerequisites: Manage Dashboards page assigned with either the Full Access or Create-Edit Only access type.  To share the dashboard with roles (to view or modify) the Share Dashboard page action must be enabled in the Page View.

If you have been given the required access, when you open the Session menu at the top right (your username), the Manage Dashboards option will be displayed. This opens the Manage Dashboards page, with the New button on the toolbar.

If the New button does not appear in the toolbar, it means you cannot create a dashboard. You may be able to view dashboards, or edit them, depending on your access level.

If you don't see the Manage Dashboards option in your Session menu (your username), you can only change your default dashboard via the User Preferences option. See: Set your own default dashboard.

 

Steps to create a new dashboard

When you create a dashboard, you complete the basic details, choose from a list of defined widgets (most widgets have separate product keys), design the layout, and save it.

1.     From the session menu (your username), select Manage Dashboards.

2.     On the toolbar at the top, select the New button. Fields will appear or be cleared for you to enter details for the new dashboard.

3.     Complete the dashboard details, using the table below as a guide:

 

Default Field Label

(in layout order)

Description

Name

Name to clearly distinguish the new dashboard from other dashboards

Add to favourites?

Default: Yes

A favourite is a dashboard that is listed below the Home menu option for quick access. When you create a dashboard, it is saved as a favourite automatically.  If you share it with a role, it will also be set as a favourite for anyone with that role.

If you have edit access to the Manage Dashboards page, you can disable this so the dashboard is not listed under Home. See: Manage Favourites. When not saved as a favourite, users may be able to access the dashboard via the Session menu depending on your access level:

        If you have access to the Manage Dashboards page and the dashboard has been shared with you to view it, open it by selecting Go To.

        If you have lower level access, you will only be able to select it as the default dashboard from the Session menu (your username) > User Preferences. You cannot change Favourite settings.

Dashboard owner

Read only

Username of the creator of the dashboard

Allow roles to view this dashboard

 

 

Only if the Share Dashboard page action is enabled in the DAS001 Page View

Add one or more roles to allow users allocated with those roles to be able to see the dashboard via the Session menu and Home > Favourites, as follows:

        Users with access to the Manage Dashboards page will be able to view the dashboard details, and set it as their own default via the Set As Default button. Users with Read-Only access will only be able to select it as their own default via the Session menu > User Preferences if more than one dashboard is shared with their role/s.  

        For users without a previously set default and no other available dashboard for their role/s, the dashboard will be set as the default automatically and display on the Home page. See: Set a default dashboard for a role

        Dashboards are automatically added as a favourite for all users with the shared role.

        Users with Full Access in the Manage Dashboards DAS001 Page View will be able to delete the dashboard if they are defined in this field, as part of a high-level administrative function.

The Current? column in the lookup indicates whether the role is currently active or inactive. Only select active roles. If a role is inactive, the dashboard will not be shared with any user with that role.

Click the column header to sort in descending or ascending order, or you can click the option in the first row to display All roles (default), current (Yes) or non-current (No).

Allow roles to modify this dashboard

Displays if the Share Dashboard page action is enabled in the DAS001 Page View

Add roles to allow users with those roles to edit the dashboard

Users with roles defined in this field can only Delete a dashboard if they have Full Access in the Manage Dashboards DAS001 Page View. Dashboard creators can delete their own dashboards.

The Current? column in the lookup indicates whether the role is currently active or inactive. Only select active roles. If a role is inactive, the dashboard will not be shared with any user with that role.

 

4.     If you want this dashboard to display automatically on your Home page when you log in, go to the toolbar and click the Set As Default button. This only sets it as the default for you, no one else. The mechanism to set a default dashboard for a role works a little differently to this setting.

5.     Click Save. The name and details are saved.

6.     Now you can start designing your dashboard. Click the Go To button. A blank screen displays.

7.     Towards the top right of the page, select the Edit Dashboard icon at the far right Dashboard design icon at far right of the dashboard toolbar.

8.     To add one or more widgets, click the grey plus sign (+) in the dashboard. Find the widgets you want to add in the list and click the Add widget button next to each. Click Close when you are done.

9.     Now you can design the layout. Customise the size of each widget by making it wider or longer using the controls on the sides.
From the left, down the controls are:

      Along the bottom of the widget:

     On the right side of the widget:

Visual depiction of widget sizing controls as described in the text

Widget size controls walkthrough

10.  If you want to change the name of the widget or other settings, click the Settings cog icon at the top right of the widget.

11.  To add more widgets to the dashboard, complete steps 8 and 9 for each one.

12.  Adjust the layout to suit the widgets. You can rearrange widgets by dragging and dropping. If you make a widget wider than the page allowance, it will automatically move to the next line.  To remove a widget, click the cross X in the far top right.

13.  To add columns, click the Add Column button on the toolbar. To remove a column, click the x in the top right corner of the column.

14.  When you have completed your dashboard design, click Save. The dashboard displays in View mode.

 

Set a dashboard as default for a role

Prerequisites: Manage Dashboards page assigned with either the Full Access, Create-Edit Only, or Edit-Only access type and the Share Dashboard page action enabled.  If not your own dashboard, you must also have a role defined in the Allow roles to modify this dashboard field for the dashboard.

A default dashboard displays automatically on the Home page on log in. Only one dashboard can be the default. A dashboard can be set as the default automatically for a role that is defined in the Allow roles to view this dashboard field if both:

        The user has not already set a dashboard as their default (when a user sets a dashboard as the default, it will remain until they choose another one).

        There is only one dashboard available for the user's role/s.

If there is more than one dashboard for the user's role/s, or the user has more than one role for which dashboards are shared, and they don't already have a default set, a prompt will display to list the dashboards available to them and ask them which one to set as the default.

If there are no defined dashboards for any of the user's roles, no dashboard will be set as the default and no prompt will be displayed. No dashboards will be shown in the Session menu.

Note The Set As Default button in the Manage Dashboard page only sets a dashboard as the default for the user viewing the page. See: Set your own default dashboard

 

Video: Set a default dashboard for a role

 

View a dashboard

Prerequisites: To view a dashboard that is not your default dashboard shown in the Home page, you must either be the creator, or have a role defined in the Allow roles to view this dashboard field for the dashboard.

You can either:

a) Go to the main menu and select Home. Click the dashboard name from the list of dashboards marked as Favourites.

b) Go to your Session menu (your username) and select Manage Dashboards if it is displayed (available to all Access Types except No Access).
Select the dashboard from the list in the left panel, then click the Go To button in the top toolbar.

Note: To see which dashboards are viewable by a particular role, you need to view each dashboard individually.

 

Set your own default dashboard

To set your own default dashboard, open the Session menu (your username) at the right of the toolbar. The steps vary depending on your level of access, as follows:

Session menu option

Description

Manage Dashboards page, if displayed

  1. Select Manage Dashboards.

  2. Select and go to the dashboard you want to set as the default.

  3. In the toolbar of the displayed dashboard, select the Set As Default button.

  4. Click OK.

User Preferences popup

  1. Select User Preferences.

  2. In the Default Dashboard dropdown, view the current dashboard set as your default.

  3. To change the default dashboard, select the name of the dashboard from the dropdown. You can only change the default dashboard if there is more than one available for you and your role/s.

 

Note that these options only set the default dashboard for you. For more about setting default dashboards for roles, see: Set a dashboard as default for a role.

 

Edit a dashboard

Prerequisites: Manage Dashboards page assigned with either the Full Access, Create-Edit Only, or Edit-Only access type.  If not your own dashboard, you must also have a role defined in the Allow roles to modify this dashboard field for the dashboard.

1.     From the session menu (your name), select Manage Dashboards.

2.     Select the dashboard you want to edit from the left panel.

3.     Make your changes to the dashboard, using the details in Create a dashboard above as a guide. Only users with Full Access in the Manage Dashboards DAS001 Page View can delete a dashboard that is not their own.

4.     Click Save.

 

Manage favourites

Prerequisites: Manage Dashboards page assigned with either the Full Access, Create-Edit Only, or Edit-Only access type.  To edit dashboards created by others, you must also have a role defined in the Allow roles to modify this dashboard field for the dashboard.

Favourites are dashboards that are listed under Home in the RME menu on the left side. Any dashboard that you can access is automatically saved as a favourite. Only users with edit access can change the favourites listed (Full Access, Create-Edit Only or Edit-Only access to the Manage Dashboards page DAS001).

1.     From the session menu (your username), select Manage Dashboards.

2.     In the Manage Dashboards page, select the dashboard you want to change, and select Go To to open it.

3.     In the Add to favourites? slider, either slide it to Yes to display it under Home in the RME menu, or No to remove it from the list. Removed dashboards are still be accessible via the Session menu, depending on your permissions.

4.     Click Save.

 

Delete a dashboard

Prerequisites: Manage Dashboards page assigned with the Full Access or Create-Edit Only types; Full Access users can delete other dashboards provided they can view it (their role is defined in the Allow roles to view this dashboard field for the dashboard, as a minimum). Create-Edit Only users can only delete their own dashboards.

1.     From the session menu (your name), select Manage Dashboards.

2.     Select the dashboard you want to delete from the left panel.

3.     In the top toolbar, click the Delete button.

4.     Click OK.

 

   

Access types and available functions

The matrix below lists possible dashboard actions and outlines which are available per Page View Access Type for the Manage Dashboards page (DAS001).

Access to the Manage Dashboards Page View DAS001 can be set in a Role record > Role Page Views or for a specific user in a User record > User Page Views.  If the Page View is assigned in both, the Access Type set in the User Page View will override the Access Type set for Role Page Views in a user's role/s. Take care when assigning Page Views to users in both levels.

Full Access is the highest level of access. It is designed to be used by senior RME administrators.

If you need a different level of access to manage dashboards, contact your RME administrator.

Action summary

Description

Full Access

Create-Edit Only

Edit-Only

Read-Only

No Access

Access Manage Dashboard page

 

 

The user can access the Manage Dashboards page via the Session menu (username).

The user can view dashboards that they created.

The user can view other dashboards if one of their roles is defined in the Allow roles to view this dashboard field for them.

Yes

Yes

Yes

Yes
(but read only)

No

Create

The user can see and use the New button on the dashboard toolbar to create new dashboards.

Yes

Yes

No

No

No

Edit

The user can see and use the Edit Mode icon on the dashboard toolbar to edit their own dashboards.

The user can edit other dashboards if a user’s role is defined in the Allow roles to modify this dashboard field for them.

Yes

Yes

Yes

No

No

Delete own

The user can delete their own dashboards.

Yes

Yes

No

No

No

Delete others

The user can delete other dashboards that they did not create.

This is only relevant for those with Full Access. Their role needs to be defined in the Allow roles to view this dashboard field but does not need to be defined in the Allow roles to modify this dashboard field. This is by design as an administrative level of access. It allows for the deletion of "orphan" dashboards created by users who are no longer at the institution.

Note: In the rare case that an administrator with Full Access cannot view a dashboard and it needs to be deleted, you could find a user with edit access of a lesser level to it  and ask them to add an administrator role. Then it can be deleted.  

Yes

No

No

No

No

Share dashboards

 

Set default for a role

When the Share Dashboard page action is assigned in the Manage Dashboards Page View DAS001, the user can edit the Allow roles to view this dashboard and Allow roles to modify this dashboard fields. These are used to share dashboards, which can set defaults for roles (see: Set a dashboard as a default for a role).

Note: For Read-Only access, while the page action checkbox can be ticked in the Page View, this will only display the 'Allow roles ...' fields as read only.

Yes

Yes

Yes

No
(read only - see note)

No

Change own default dashboard

The user can view and change the dashboard that is currently set as their default in either Session menu > Manage Dashboard page or Session menu > User Preferences. See: Set your default dashboard.

Yes

Yes

Yes

Yes

Yes

View Favourite dashboards

The user can view and access dashboards shared with their role/s in the list under Home in the RME menu.

Note: Dashboards are automatically set as a Favourite for all users with defined shared roles, however this  may be disabled by someone with edit access to the dashboard.

Yes

Yes

Yes

Yes

Yes

Edit Favourites setting

The user can disable a dashboard as a Favourite so it no longer displays in the dashboard list under Home in the RME menu.

The user can edit the Favourites option for dashboards shared with others if one of their roles is defined in the Allow roles to modify this dashboard field.

Yes

Yes

Yes

No

No

Significant Events widget: Enable Bulk Update

The user can change the Significant Events widget settings to enable the Bulk Update function and define roles allowed to perform bulk updates.

Yes

Yes

Yes

No

No

 

Related topics

        Dashboard widgets

        Home

        User record, User Page Views

        Role record, Role Page Views

 

Product keys: Modules > Core and relevant eForm domain keys for eForm data

ID: DAS001.htm