Configure pivoting screens
Learn how to configure pivoting screens.
Pivoting screens allow users to explore entity data across multiple dimensions. They are used for profiling distributions, performing segment-based analysis, or tracking metrics by category or geography.
Table of fields
The following table lists parameters used in pivoting screens:
| Parameter | Description | Possible Values |
|---|---|---|
attributeTypes (optional) | Defines which attributes are available for pivoting or drill-down operations. | PivotingAttribute[]. See the PivotingAttribute section following the table for more details. |
views | Specifies which charts or filtered entity facets are shown on the pivot page. | FilteredEntitiesViewConfig[]. See the FilteredEntitiesViewConfig section following the table for more details. |
layout | Determines how each view is arranged on the page, such as in rows or columns. |
-
uri(string) The primary attribute URI used for pivoting. -
children(optional, string array) List of sub-attribute URIs. Use this if the pivoting attribute is nested and you want to target specific sub-attributes. -
popup(optional, object) Configuration for the pivoting popup. Includes:-
label(string) The caption displayed on the pivoting popup. -
entityType(string) The entity type URI. Only entities of this type are shown in the popup.
-
-
canRead(optional, string array) Defines which user permissions are required to access this view. -
component(DashboardViewType) Specifies the type of dashboard view. Must be'FilteredEntitiesViewFacet'. -
filters(optional,DashboardViewFilter[]) Configuration for filters applied to the view. -
id(string) A unique identifier for the view. -
max(optional, number) Maximum number of rows to display per page. -
title(optional, string) The display title of the view.
Example - pivoting entry
{
"attributeTypes": [
{ "uri": "configuration/entityTypes/HCP/attributes/FirstName" },
{
"uri": "configuration/entityTypes/HCP/attributes/Location",
"popup": { "label": "Location Lookup", "entityType": "configuration/entityTypes/Location" }
}
],
"views": [
{
"id": "viewOne",
"component": "DashboardFacet",
"chartType": "bar",
"attributeUri": "configuration/entityTypes/HCP/attributes/FirstName"
},
{
"id": "viewTwo",
"component": "FilteredEntitiesViewFacet",
"filters": [{ "fieldName": "attributes.Status", "filter": "equals", "values": ["Active"] }]
}
],
"layout": [
{ "id": "viewOne", "x": 0, "y": 0, "width": 2, "height": 2 },
{ "id": "viewTwo", "x": 2, "y": 0, "width": 2, "height": 2 }
]
}