IDM 7.4.1

Manage dashboards

Dashboards let you make shortcuts to frequently-required tasks. The Quick Start dashboard displays by default when you log in to the admin UI. You can create additional dashboards, or add and remove widgets from the existing dashboards.

Default dashboards

To display all configured dashboards, select Dashboards > Manage Dashboards. The following dashboards are provided by default.

System monitoring dashboard

The System Monitoring Dashboard includes information about:

Audit Events

Includes information on audit data, organized by date.

Audit Event Widget

Cluster Node Status

Includes information on cluster nodes.

Cluster Node Status Widget

System Health

Includes information on system resource usage.

System Health Widget

Last Reconciliation

Includes data from the most recent data reconciliation.

Last Recon Widget

Resource report

Show Me

Resource Report Dashboard

  • The Resource 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

Show Me

Business Report Dashboard

The Business Report includes widgets related to login and registration activity.

Custom dashboards

You can set up additional dashboards for customized views of the admin UI.

Create a new dashboard

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, click 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 overflow menu > widget, and select Rename or Duplicate.

Add and move widgets

To add a widget to a dashboard, click Add Widget and select the widget type. Widgets are grouped in categories. Scroll down to the category of the widget you want to add.

To change the position of a widget on a dashboard, click and drag the move button .

To add a new Quick Start widget, select the overflow menu > widget 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 {secureHostname}/admin/#settings/audit/, enter #settings/audit in the destination URL text box.

Any changes to the dashboards are persisted in your project’s conf/ui-dashboard.json file, which has the following properties:

admin UI Widget Properties in ui-dashboard.json
Property Values Description

name

String

Dashboard name.

isDefault

true or false

Default dashboard. You can only set one default.

widgets

Different attributes based on type

Attributes that define the widget.

type

lastRecon, resourceList, quickStart, userRelationship

Widget type.

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, refer to Bootstrap CSS.

barchart

true or false

Reconciliation bar chart; applies only to the Last Reconciliation widget.

Admin UI widgets

The following tables list the available widgets:

admin UI reporting widgets

Name Description

Audit Events

Graphical display of audit events.

Count Widget

A count widget that provides an instant display of the number of specific objects; for example, active managed users, and enabled social providers.

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.

Social widgets

Name Description

Daily Social Logins

Social Registration (year)

Graphical display of social registrations over the past year.

System status widgets

Name Description

Memory Usage (JVM Heap)

Displays the JVM memory usage. Refer to API metrics.

Memory Usage (JVM NonHeap)

Displays the JVM non-heap memory usage. Refer to API metrics.

System Health

Includes information on system resource usage.

CPU Usage

Displays the system CPU usage.

System Health

Includes information on system resource usage.

Cluster Node Status

Lists the instances in a cluster, with their status.

Utility widgets

Name Description

Quick Start

Links to common tasks; shown in the Administration dashboard.

Identity Relationships

Graphical display of relationships between identities.

Managed Objects Relationship Diagram

Graphical diagram with connections between managed object properties; also refer to View the Relationship Configuration in the UI.

Copyright © 2010-2024 ForgeRock, all rights reserved.