Manage Dashboards
Dashboards let you make shortcuts to frequently-required tasks. The Quick Start dashboard is displayed by default when you log in to the Admin UI. You can create additional dashboards, or add and remove widgets from the existing dashboards.
To display all configured dashboards, select Dashboards > Manage Dashboards. The following dashboards are provided by default:
- Quick Start Dashboard
Quick Start cards support one-click access to common administrative tasks:
Add Connector: Configure connections to external resources.Create Mapping: Configure mappings to synchronize objects between resources (see Mapping Data Between Resources).Manage Roles: Set up provisioning or authorization roles (see "Managed Roles").Add Device: Configure managed objects, including users, groups, roles, and devices.Configure Registration: Configure user Self-Registration. You can set up the End User UI login screen, with a link that allows new users to start a verified account registration process.Configure Password Reset: Configure user self-service Password Reset. You can configure the ability for users to reset forgotten passwords. For more information, see "Self-Service End User UI".Manage Users: Lets you manage users in the repository.Configure System Preferences: Configure the following aspects of the server:End User UI path, as described in "Change the End User UI Path".
Privacy & Consent, as described in "Configure Privacy and Consent".
- System Monitoring Dashboard
Audit Events include information on audit data, organised by date.
Last Reconciliation includes data from the most recent reconciliation between data stores.
- Resource Report
The Resources Report includes widgets that show the number of active users, configured roles, and active connectors.
The Resources widget shows all configured connectors, mappings, and managed object types.
- Business Report
The Business Report includes widgets related to login and registration activity.
Caution
If your browser uses an AdBlock extension, it might inadvertently block some UI functionality, particularly if your configuration includes strings such as ad. For example, a connection to an Active Directory server might be configured at the endpoint system/ad. To avoid problems related to blocked UI functionality, either remove the AdBlock extension, or set up a suitable safelist to ensure that none of the targeted endpoints are blocked.
You can set up additional dashboards for customized views of the Admin UI, and you can embed external dashboards such as Kibana or Grafana, or other monitoring boards.
To create a new dashboard, select Dashboards > New Dashboard. Enter a dashboard name and select whether this dashboard should be the default board that is displayed when you load the Admin UI.
For a customized view of the Admin UI, select Widgets as the Dashboard Type, then select Create Dashboard and add the widgets that you want exposed in that view.
You can also customize the view by starting with an existing dashboard. In the upper-right corner of the UI, next to the Add Widget button, click the vertical ellipses (), then select Rename or Duplicate.
Create a dashboard and Select Embedded URL as the Dashboard Type.
Enter the URL of the dashboard that you want to embed, and select Create Dashboard.
To add a widget to a dashboard, click Add Widget and select the widget type. Widgets are grouped in logical categories, so scroll down to the category that fits the widget you want to add.
To change the position of a widget on a dashboard, click and drag the move icon ().
To add a new Quick Start widget, select the vertical ellipsis () icon in the upper right corner of the widget, and click Settings.
To embed an Admin UI sub-widget in the Quick Start widget, specify the destination URL. If you are linking to a specific page in the Admin UI, the destination URL can be the part of Admin UI address. For example, to create a quick start link to the Audit configuration tab, at https://localhost:8443/admin/#settings/audit/, enter #settings/audit in the destination URL text box.
Any changes that you make to the dashboards are written to your project's conf/ui-dashboard.json file. That file has the following properties:
ui-dashboard.json| Property | Options | Description |
|---|---|---|
name | User entry | Dashboard name |
isDefault | true or false | Default dashboard; can set one default |
widgets | Different options for type | Code blocks that define a widget |
type | lastRecon, resourceList, quickStart, frame, userRelationship | Widget name |
size | x-small, small, medium, or large | Width of widget, based on a 12-column grid system, where x-small=4, small=6, medium=8, and large=12; for more information, see Bootstrap CSS |
height | Height, in units such as cm, mm, px, and in | Height; applies only to Embed Web Page widget |
frameUrl | URL | Web page to embed; applies only to Embed Web Page widget |
title | User entry | Label shown in the UI; applies only to Embed Web Page widget |
barchart | true or false | Reconciliation bar chart; applies only to Last Reconciliation widget |
The following tables display an alphabetical list of the available widgets:
| Name | Description |
|---|---|
| Audit Events | Graphical display of audit events. |
| Count Widget | A count widget provides an instant display of the number of specific objects; for example, active managed users, enabled social providers, etc. |
| Dropwizard Table With Graph | Does not appear in the list of widgets unless metrics are active. |
| Graph Widget | Provides a graphical view of a specific managed resource; for example, managed users, based on some metric. |
| Last Reconciliation | Shows statistics from the most recent reconciliation, shown on the System Monitoring dashboard. |
| New Registrations | The number of users that have self-registered that week. To display data using this widget, you must enable user self-registration. |
| Password Resets | The number of password resets that week. To display data using this widget, you must enable password reset. |
| Resources | Connectors, mappings, managed objects; shown in Administration dashboard |
| Sign-Ins | The number of managed users that have signed in to the service that week. |
| Name | Description |
|---|---|
| Daily Social Logins | Graphical display of logins through social identity providers. |
| Social Registration (year) | Graphical display of social registrations over the past year. |
| Name | Description |
|---|---|
| Cluster Node Status | Lists the instances in a cluster, with their status. |
| Name | Description |
|---|---|
| Embed Web Page | Supports embedding of external content. Web pages that you embed using this applet must support the correct x-frame-options. For example, Google has a Maps Embed API. |
| Identity Relationships | Graphical display of relationships between identities. |
| Managed Objects Relationship Diagram | Graphical diagram with connections between managed object properties; also see "View the Relationship Configuration in the UI" |
| Quick Start | Links to common tasks; shown in Administration dashboard |