Unify and manage your data

Configure the layout section - Dashboards

Learn how to configure the layout section

The layout section defines the top-level screens shown in the Reltio UI navigation menu. Each item represents a screen type such as Dashboard, Search, or Segmentation (applicable only for Intelligent 360).

Use this configuration to customize what appears in the left navigation, what each screen does, and which roles can access it.

Let's look at configuring Dashboards - both Profile Statistic and Data Quality.

Prerequisites for screen configuration

Before configuring any screen in the layout section:

  • You need access to the Reltio Console .
  • Make a backup of your existing configuration before making changes.

Common screen configuration fields

Every screen object inside the layout array supports a shared set of fields:

FieldDescriptionExample
classIdentifies the screen type (example, Dashboard, Search)"class": "Dashboard"
labelName displayed in the UI"label": "Home Dashboard"
iconURL to the screen's icon (optional)icon: "https://reltio-ui-files.s3.amazonaws.com/new-ui/Default.svg"
canReadArray of user roles allowed to view this screen (optional)"canRead":["ROLE_ADMIN"]

Screens include additional fields depending on their type. For example, Dashboard screens support views and layout. Search screens support entityTypes, options, and potentialMatchesReview.

Configure a Dashboard screen

A Dashboard screen displays one or more charts or data views. It requires two key arrays: views[] and layout[].

{
  "class": "Dashboard",
  "label": "Home Dashboard",
  "icon": "https://.../Dashboard.svg",
  "views": [
    {
      "id": "chart1",
      "component": "DashboardFacet",
      "chartType": "bar",
      "attributeUri": "configuration/entityTypes/Person/attributes/Country"
    }
  ],
  "layout": [
    { "id": "chart1", "x": 0, "y": 0, "width": 3, "height": 2 }
  ],
  "hideAddChartsButton": true
}
Table 1. Required fields
FieldDescription
viewsArray of dashboard view components
layoutGrid layout for placing views
classMust be "Dashboard"
labelName displayed in navigation
You can also configure a Dashboard in the UI Modeler application in the Console.

Result

The Dashboard screen appears in the left navigation and displays the configured charts.

Validation

Open the Reltio UI and confirm that the dashboard renders as expected. Check that charts load and layout positions match your configuration. Here's a sample dashboard in the Hub:

Configuring dashboard views

A dashboard view is a visual component displayed on a Dashboard screen. Each view presents data using a chart, entity list, or custom facet. Views are configured inside the views[] array of a Dashboard screen, and positioned using the layout[] array.

You can include multiple views per dashboard. Each view must have a unique id and specify a supported component type.

Chart views and Chart type options

When component is "DashboardFacet", you must also specify a chartType. This determines the type of chart displayed.

Chart typeDescription
barVertical or horizontal bar chart
pie / donutCircular chart with slices
lineTrend line across values
cloudWord cloud based on frequencies
bubbleCircle chart sized by metric
mapGeographic visualization using TopoJSON
tableTable with inline bar metrics
treeTree structure grouped by value
Here's a sample coniguration for a bar chart view
{
  "id": "myBarChart",
  "component": "DashboardFacet",
  "chartType": "bar",
  "attributeUri": "configuration/entityTypes/HCP/attributes/Country",
  "count": 10,
  "title": "Countries"
}
Required fields
FieldDescription
idUnique view identifier
componentThe facet or view it represents.
chartTypeChart type to render, which can be one of the types listed in the table above.
attributeUriAttribute to visualize
Optional fields include count, filters orderType, sortByLabel, showOthers, isHorizontal, and margin.

Result

The view renders a bar chart grouped by the specified attribute.

Validation

Open the dashboard and confirm the chart appears with expected values and layout. Here are a few examples of charts configured for the dashboard view:

  • Bar chart: This chart displays the number of profiles by source system.

  • Map: This map displays the global organization view.

  • Bubble: This chart displays a percentage of organization by industry type.

  • Donut: This chart displays a breakup of the quality of addresses.

You can use other view components in a dashboard to show lists, filters, or stats.

ComponentPurpose
ActivitiesViewFacetRecent activity timeline
FilteredEntitiesViewFacetList of entities filtered by criteria
FilteredSavedSearchesFacetSaved searches filtered by keyword
NotificationInboxFacetNotification center
ProfileStatsFacetAggregate profile statistics
EntitiesByTypeViewFacetEntity counts by type
FilteredSegmentsFacetList of segments matching conditions (Intelligent 360)
CustomActionViewFacetLoad external content via URL
Here's an example of a filtered entity list:
{
  "id": "filteredEntities",
  "component": "FilteredEntitiesViewFacet",
  "title": "US-Based Profiles",
  "filters": [
    {
      "filter": "equals",
      "fieldName": "attributes.Country",
      "values": ["US"]
    }
  ],
  "max": 10
}
Required fields
FieldDescription
idUnique ID for the view
componentMust be "FilteredEntitiesViewFacet"
filtersList of conditions to apply

Result

The view displays up to 10 profiles where Country = US.

Validation

View the dashboard and confirm the list shows filtered profiles. Check sorting, pagination, and field display if configured. Here are a few examples:

  • The Profile Stats facet that shows the profile activity over a period of time

  • The Notification Inbox facet

  • The Activity log facet

  • Saved searches facet

Configure the Data Quality Dashboard

You can enable charts grouped by attribute or entity level, with layout definitions per view.

{
  "class": "DQDashboard",
  "label": "Data Quality",
  "showTimeSeries": true,
  "viewsByDataLevel": {
    "attributeLevel": [
      {
        "id": "FillRateView",
        "type": "fillRate",
        "title": "Fill Rate"
      }
    ]
  }
}
Table 2. Required fields
FieldDescription
classMust be "DQDashboard"
labelDisplay label

These are the optional parameters:

ParameterDescriptionPossible valuesExample
viewsByDataLevel (optional)Specifies which charts to display, grouped by data level (attributeLevel or entityLevel).Object keyed by attributeLevel and/or entityLevel, with arrays of DQDashboardView objects"viewsByDataLevel": { "attributeLevel": [{ "id": "FillRateView", "type": "fillRate", "title": "Fill rate" }] }
layoutsByDataLevel (optional)Defines chart layout by data level. attributeLevel layouts are grouped by time context (today, timeRange). entityLevel layouts are grouped by RDM status (rdmLookupExist, rdmLookupNotExist).Object keyed by attributeLevel or entityLevel, each with layout arraysSee full example below
showTimeSeries (optional)Enables time-based chart views.Boolean"showTimeSeries": true
showOVSwitcher (optional)Displays the Search by OV checkbox.Boolean"showOVSwitcher": true
showErrorBands (optional)Enables display of error bands on charts.Boolean"showErrorBands": true
showExportButton (optional)Shows the Export button.Boolean"showExportButton": true
showNewDQDashboard (optional)Enables the new Data Quality Dashboard UI.Boolean"showNewDQDashboard": true

Result

The DQ Dashboard screen loads with attribute-level or entity-level charts.

Validation

View the dashboard and confirm that configured charts appear and reflect valid data.Here's a sample image of the DQ Dashboard on the Hub.