Version: On prem: 15.0.2

Widgets

This section describes the available widgets, including examples. Expand each section to learn more about a certain widget:

My work Items

The MyWorkItems widget shows an overview of the active user's work items. The widget does not support any parameters.

Configuration example:

{
    name: 'MyWorkItems',
    height: 250
}

KPI widgets

The KpiTiles widget is used for displaying KPIs. It can be used to display the most important Key Figures for a given role, for example, the administrator can define a manager dashboard and use the new KpiTiles widget to present the most important Key Figures for managers. If a KPI has a threshold defined, its value will be clearly visible to the user once he or she signs into Omada Identity. The color (green, yellow or red) will indicate the status of KPI.

Available parameters

Parameter	Description
columns	The number of tiles per row.
maxItems	The total number of tiles to render (optional).
height	The height of the widget (optional).
tileHeight	The height of each tile (optional).
kpisToShow	The array of KPIs (UIds) to be presented. Can be used to display specific KPIs only (optional). The order of Uids will be enforced in the presentation.
viewAllLinkDashboardName	The name of the dashboard that the 'View all' link will redirect to.
viewId	The Id or UId of a data object view with KPI objects - only these KPIs are displayed.
expressions	The array of expression objects to further filter the loaded objects. Example: `<expressions><expression path="/SOMEREFPROP" property="NAME" operator="Equals" value="qwerty"/></expressions>`
path	The reference path from the objects in the view to the objects the expression is for.
property	The property/fixed field to filter on.
operator	The operator [`Equals`, `LessThan`, `GtThan`, `LessThanEq`, `GtThanEq`, `NotEquals`, `Like`, `In`, `NotIn`].
value	A filter value. Can be either: string, Boolean, DateTime or array of string. An array of string is valid if the property is a Set or Reference property. It can then specify int or guid IDs.

Configuration example:

{
    name: 'KpiTiles',
    title: S_COMMON_Text_MyKeyFigures,
    logo: 'Images/Dashboard/KeyFigures.png',
    height: 260,
    params: 
    {  
        viewId: '6211cec4-be92-4360-84e9-0e4db2ade601',
        columns: 3,
        maxItems: 3,
        viewAllLinkDashboardName: S_Dashboard_Title_KeyFigures,
        kpisToShow: [], // comma separated array od KPI UIds
        tileHeight: 190
     }
}

There is also the KPIList widget that shows a list of defined key performance indicators.

Available parameters

Parameter Description

viewId Type the ID or UID of a data object view with KPI objects. Only the KPIs included here are displayed.

expressions Enter various expression objects. Each expression object has the following parameters:

Path - the reference path from the objects in the view to the objects the expression is for.

property - the property/fixed field to filter on.

operator - [Equals, LessThan, GtThan, LessThanEq, GtThanEq, NotEquals, Like, In, NotIn].

value - A filter value. Can be either: string, Boolean, DateTime or array of string.

An array of string is valid if the property is a Set or Reference property. It can then specify int or guid IDs.

Parameter	Description
viewId	Type the ID or UID of a data object view with KPI objects. Only the KPIs included here are displayed.
expressions	Enter various expression objects. Each expression object has the following parameters: Path - the reference path from the objects in the view to the objects the expression is for. property - the property/fixed field to filter on. operator - [`Equals`, `LessThan`, `GtThan`, `LessThanEq`, `GtThanEq`, `NotEquals`, `Like`, `In`, `NotIn`]. value - A filter value. Can be either: string, Boolean, DateTime or array of string. An array of string is valid if the property is a Set or Reference property. It can then specify int or guid IDs.

Configuration example:

{
    name: 'KPIList',
    title: S_COMMON_Text_MyKeyFigures,
    colSpan: 1,
    height: 250,
    params: 
    {  
        viewId: '6211cec4-be92-4360-84e9-0e4db2ade601'
        // expressions: [{ property:'KPICATEGORY', operator: 'Equals', value: 'category1' }]
    }
}

KPI widget filters

The KPI widget displays a number of KPIs. Use the viewId attribute with a UId of a data object list view that filters by data objects of the Key Performance Indicators type. To further limit presented KPIs, use the attribute kpisToShow with an array of UIds of Key Performance Indicators data objects.

There are 5 default views for KPIs:

Accessible Key Performance Indicators
Accessible Key Performance Indicators (Risk & Compliance)
Accessible Key Performance Indicators (My data)
Accessible Key Performance Indicators (Master data)
Accessible Key Performance Indicators (Operations)

These views filter by KPIs which are available to the active user. The first default view shows all KPIs. The remaining KPIs filters additionally by the classification status.

You can add multiple KPI widgets filtered by different views to enable grouping KPIs per classification on the same dashboard.

The sort order of these views will impact the order of KPIs presented in dashboards. The default sort order is Priority, Name, Number.

Operations Dashboard widgets

Horizons feature enabled

With the Horizons feature enabled, the With warnings status is replaced with a Partly complete one. For more information, go to Operations Dashboard.

The Operations Dashboard comes with three widgets by default. They show different status and their counts for Imports, RoPE, and OPS.

The data in the three widgets refreshes automatically every 15 second. You can control the refresh rate using the configuration parameter: refreshRate. You can set up the status widgets independently.

Example of configuration of the RoPE status widget:

{
    name: 'RoPe', 
    title: 'Calculated identities',
    infoText: S_RoPeStatusWidget_Text_InfoText,
    refreshRate: 15,
    hideTitle: false,
    height: 440,
    isHiddenEvaluator: function() { return !appPageVars.isRoPEEnabled; }
}

ODW Dashboard Status Details

The ODWDashboardStatusDetails widget shows rows (events) from the sysssislog, which is the table that the SQL Server Integration Services uses for logging. The following are widget's parameters:

getStatusDetails - comma-separated list of the names of Data Warehouse SSIS packages (jobs) that are shown in the list.
timeout - the timeout duration in seconds for the query to the Omada Identity Data Warehouse database. The default timeout duration is 30 seconds.

Configuration example:

{
    name: 'ODWDashboardStatusDetails',
    height: 300,
    title: 'ODW SSIS job status',
    params: { getStatusDetails: 'Omada ODW Import,Omada ODW OIS Sync,Omada ODW Export', timeout: 333}
}

ODW dashboard export errors

The ODWDashboardExportErrors dashboard widget shows rows (objects) that are currently resulting in an error in the ODW Export. The Retries column shows the number of times the object has been retried.

The Timeout parameter is the timeout duration in seconds for the query to the Omada Identity Data Warehouse database. The default timeout duration is 30 seconds.

Configuration example:

{
    name: 'ODWDashboardExportErrors',
    height: 300,
    title: 'ODW export errors',
    params: {}
}

OPS

The OPS widget shows the OPS Provisioning Monitor. It supports the following parameters:

originKeys - When jobs are sent from the Role and Policy Engine, this parameter fills in information about identity and other data in the OriginId field on the job. The values are formatted as a semi-colon separated list of key/value pairs, for example:
- Identity=Christoffersen, Niels [NCAA];IdentityId=61f188a5-1878-4940-b161-e1c0be2dc927;CalculationId=11420
  
  If you use the originKey parameter, you can add columns in the monitor that extract information for the OriginId and place in the list.
ShowOriginColumn - specifies if the Origin column should be shown or not. You can set the value to True or False. The default value is False.

Configuration example:

{
    name: 'OPS',
    height: 300,
    params: { originKeys: ['Identity'] }
}

Text Panel

The TextPanel widget can show text or HTML data. The supported parameters are as follows:

Html - enables that HTML is displayed

Configuration example:

{
    name: 'TextPanel',
    hideTitle: true,
    colSpan: 1,
    params: { html: '<b>some html to be displayed</b>' }
}

Data object view

The DataObjectView widget shows a grid of any data object view. The supported parameters are as follows:

viewId - the ID or UID of the view that you want to display.

Configuration example:

{
    name: 'DataObjectView',
    title: 'All identities',
    colSpan: 2,
    height: 400,
    params: { viewId: '1da2148a-4abd-4ffd-b9ba-807e55ac31a5' }
}

Chart

The Chart widget can show different types of charts. The supported parameters are described below:

Parameter	Description
dataSource	Name of the data source (required).
dataSourceParams	"dictionary" object. Each property must correspond to a parameter name that the data source supports. This should not start with '@'.
drilldownDataSource	Name of the data source to configure a drill-down for the chart widget. Data source query is executed once before the drill-down window opens for listing the columns that will be shown. All columns from the query will be presented.
drilldownFilter	This parameter should be set to the name that is present in the data source query. The joinType supports the values 'series' and 'label', and it applies the data point value to the filter.
chartType	Type of chart to display. It must be one of the following values: ['bars', 'lines', 'points', 'spline', ‘pie’]. The default value is 'bars'.
fill	Specifies if the area below the chart should be filled. This parameter is only relevant if chartType is 'lines'. You can set it to True or False.
stack	Specifies if the chart series should be stacked. This parameter is only relevant if chartType is ‘bars’ or ‘lines’. You can set it to True or False.
seriesOptions	"Dictionary" object for series. Use this parameter to set any of the below properties on each individual series: title - specify a title for the series other than what is returned from the data source color - specify the color for the specific series. The pie chart does not support color control. actions - a collection of context menu items. It is an extension point from which you can call a JavaScript function. The following values must be set for each menu action: name - identifier for menu item (required) title - title for menu item icon - name of icon for the menu item tag - optional object that is passed to the callback function callback - function that receives an 'options' object

Configuration example:

{
    name: 'Chart',
    title: 'No. of recently created objects',
    height: 250,
    colSpan: 1,
    params: {
        dataSource: 'Recently created objects statistics', chartType: 'bars', stack: true,
        seriesOptions: {
            'User': {
                color: '#FF0000',
                actions : [
                  { name: 'newAction', title: 'New', icon: 'show', tag: {}, callback: function(options){alert('hello world')} }
                ]
            }
        }
    }
}

note

The chart widget is supported in the following browsers:

Microsoft Edge 44 and later
Google Chrome 69 and later