Configure the layout section - other screens

Learn how to configure the layout section

Configure a Search screen

The Search screen lets you define which entity types are searchable and whether features like map search or bulk update are enabled.

Optional fields let you enable map search, scoring, and bulk updates.

{
  "class": "Search",
  "label": "Global Search",
  "entityTypes": [
    "configuration/entityTypes/Person",
    "configuration/entityTypes/Organization"
  ],
  "bulkUpdate": true,
  "mapSearchEnabled": true,
  "options": {
    "scoreEnabled": true,
    "showSearchByOv": false
  }
}

Table 1. Required fields
Field	Description
class	Must be "Search"
label	Screen label shown to users

Table 2. Optional fields
Parameter	Description	Possible values	Example
`entityTypes`	Specifies which entity types appear in the search options.	Array of strings	`"entityTypes": ["configuration/entityTypes/HCP"]`
`bulkUpdate`	Enables bulk update actions from the search UI.	Boolean	`"bulkUpdate": false`
`canExport`	Allows exporting search results.	Boolean	`"canExport": true`
`mapSearchEnabled`	Enables map-based search.	Boolean	`"mapSearchEnabled": true`
`tabs`	Defines which columns are displayed in the search results for each entity type.	Object with keys as entity type URIs and values as arrays of attribute paths	`"tabs": { "configuration/entityTypes/HCA": [ "attributes.TypeCode", "entityId", "attributes.DeepNested.FirstLevelNestedSub1", "attributes.Name", "analyticsAttributes.IQ.score" ] }`
`options`	Additional settings for search UI behavior.	Object with fields like `showSearchByOv`, `scoreEnabled`	`"options": { "scoreEnabled": true }`
`potentialMatchesReview`	Workflow configuration to launch a potential match review process.	Object with `processType`: `"potentialMatchReview"`, `"dataChangeRequestReview"`, or `"recommendForDelete"`	`"potentialMatchesReview": { "processType": "potentialMatchReview" }`

Result

The Global Search screen is visible in the UI, with support for the configured entity types.

Validation

Search for an entity and verify that results appear as expected. Confirm that optional features like map search and scoring are active, if enabled. Here's a sample search screen in the Hub:

Configure a Segmentation screen (Intelligent 360)

The Segmentation screen supports visual segment building.

{
  "class": "Segmentation",
  "label": "Segmentation",
  "icon": "https://reltio-ui-files.s3.amazonaws.com/new-ui/Segmentation.svg",
  "isNewMode": true,
  "isNewScreen": true
}

Table 3. Required fields
Field	Description
class	Must be "Segmentation"
label	Screen name in the navigation

Result

The Segmentation screen appears with either the classic or new experience, based on configuration.

Validation

Open the screen and verify that the segment editor loads correctly. Here's a sample Segmentation screen in the Hub:

Configure a Custom Action Button

Use the custom configuration script to add a button in the navigation pane. This allows you to extend the UI with custom logic, such as calling APIs, transforming data, or redirecting to external content.

The script uses the UI.api() and UI.onApiRequest() functions to manage interactions.

{
         "items": [
            {
               "label": "Clone Profile",
               "icon": "https://reltio-ui-files.s3.amazonaws.com/new-ui/Default.svg",
               "canRead": [
                  "ROLE_DNB_CONNECTOR",
                  "ROLE_DNB_CONNECTOR_ADMIN"
               ],
               "class": "CustomAction",
               "success": "Cloned successfully. Do you want to open cloned profile?",
               "fail": "Some error occurred during cloning.",
               "action": {
                  "permissions": [
                     "/entities"
                  ],
                  "files": [
                     "https://reltio-ui-files.s3.amazonaws.com/custom-scripts/cloneAction.js"
                  ]
               }
            }

Table 4. Required fields
Field	Description
class	Must be "CustomAction"
label	Screen name
action.files	JavaScript file URLs. This is optional.
action.processApiRequest	URL patterns to intercept. This is optional.

Result

A custom action appears in the left navigation. When selected, it loads the specified JavaScript behavior.

Validation

Open the custom action and verify that the script executes correctly and API calls are intercepted as expected. Here's a screen showing the custom button Clone profile configured for the tenant.

Configure a Console App Action Button

This action button is used to launch embedded views from Reltio Console apps like Export, Workflow, or Audit Log.

{
  "class": "ConsoleAppAction",
  "label": "Export to Console",
  "consoleApp": {
    "name": "Export",
    "path": "entities",
    "query": "param=value"
  }
}

Table 5. Required fields
Field	Description
class	Must be "ConsoleAppAction"
label	Display label
consoleApp.name	Console app name
consoleApp.path	Optional app route path
consoleApp.query	Optional query string

Result

The screen launches the linked console application with the specified path and query.

Validation

Select the screen and confirm that the external app loads with the expected context. Here's a screen showing the Export option configured in the Hub navigation.

Unify and manage your data

Configure the layout section - other screens

Configure a Search screen

Configure a Segmentation screen (Intelligent 360)

Configure a Custom Action Button

Configure a Console App Action Button

Footer