Nuxeo Platform User Documentation

Managing Dashboards

Updated: October 16, 2020

This add-on is deprecated since Nuxeo Platform 6.0.

The administrators of a Nuxeo application can set up the dashboards that will be displayed to users. On a default Nuxeo instance, administrators can:

  • define the default user dashboard, which is the dashboard displayed to authenticated users by default and which they can customize;
  • add external gadgets that users will be able to display on their dashboard by customizing it .

When anonymous access to the Nuxeo Platform is enabled, administrators can define the anonymous dashboard, which is the dashboard displayed to users that are not logged in. The configuration of the anonymous dashboard works exactly like the default user dashboard.

Defining the Default User Dashboard

The user default dashboard is used to generate the user's dashboard the first time the user logs in, and when the user clicks on the "Restore default" button on his dashboard. Both administrators and power users can define this default dashboard.

The Nuxeo Platform includes a dashboard that is proposed as the default user dashboard. You can edit this default user dashboard to make it adapted to your organization and users. Editing the default user dashboard works the same way users can edit their dashboard. You can:

Managing External Gadgets

As an administrator, you can add and manage gadgets from other applications or websites so that they are available for users when they click on the "Add gadget" button.

Adding External Gadgets

To add an external gadget:

  1. On the website which provides the external gadget, copy the gadget's URL.
  2. Log in to Nuxeo.
  3. In the Admin Center, click on the Dashboards tab.
  4. Click on the External gadgets tab. The Add link is displayed. If you already added some external gadgets, the list of configured gadgets is displayed.
  5. Click on the Add link The form to add a gadget is displayed.
  6. Fill in the form (see below for gadget parameters).
  7. Click on the Create button. The new gadget and its properties is displayed in a table.
    When users click on the Add gadget button, the new gadget is available in the gadget list.

External gadget properties

Field Description
Name The technical name of the gadget, that can used by the administrator.
Label Title of the gadget displayed in its title bar when it's used on the dashboard.
Enabled Select if your gadget should be displayed in the list of gadgets.
Category Category in which the gadget will be available. You can either type the name of an existing category or type the name of a new category. Default categories are: Nuxeo, Media, Monitoring, Utilities, Collaborative.
Gadget URL Type the URL of the widget
Icon URL URL of the icon to be displayed on the gadget selection pop up if the external gadget has no icon provided by default.

Modifying an External Gadget

You can edit the external gadgets you have added at any time. Editing an gadget means changing its properties (for instance updating it).

To edit an external gadget:

  1. In the Admin Center, click on the Dashboards tab.
  2. Click on the External gadgets tab. The list of available gadgets is displayed.
  3. Click on the Modify button of the widget to edit. The gadget edit form is displayed.
  4. Modify the properties you want to change.
  5. Click on the Save button.

Deleting an External Gadget

When you delete an external gadget, it is not removed from the dashboard of the users who already added it.

To delete an external gadget:

  1. In the Admin Center, click on the Dashboards tab.
  2. Click on the External gadgets tab. The list of available gadgets is displayed.
  3. Click on the Delete button of the gadget to remove. A confirmation window pops up.
  4. Click on OK to confirm gadget deletion. The gadget is deleted and is not in the gadget list anymore. However it is still displayed on the dashboard of users who added it to their dashboard.