Reference: Supported values and field types
Learn more about the common fields and values used in the UI configuration file.
Screen classes (class field in layout[])
These values define which type of UI screen is rendered.
| Value | Description |
|---|---|
| Dashboard | Displays configurable chart-based views |
| Search | Global search screen for entity types |
| Segmentation | Segment builder and viewer |
| DQDashboard | Data quality metrics and completeness charts |
| CustomAction | Navigation button for executing JS scripts |
| ConsoleAppAction | Links to external Reltio Console apps |
Supported chart types (chartType in DashboardFacet)
| Value | Description |
|---|---|
| bar | Bar chart (vertical or horizontal) |
| pie | Pie chart |
| donut | Donut chart |
| line | Line chart showing trends |
| cloud | Word cloud by frequency |
| bubble | Bubbles scaled by metric |
| map | Map visualization using TopoJSON |
| tree | Tree diagram grouped by value |
| table | Table view with bars embedded in cells |
Profile view components (component in profile views[])
| Value | Description |
|---|---|
| Attributes | Editable panel of multiple attributes |
| AttributeTable | Repeating table of attribute rows |
| SingleAttribute | Focused single-attribute editor |
| Relations | Visual or nested relationship viewer |
| RelationsTable | Tabular relationship display |
| HierarchyPaths | Linear hierarchy path viewer |
| HierarchyTree | Tree-based hierarchy viewer |
| InteractionsList | List of interactions |
| InteractionsTable | Table of interactions |
| ImageAttribute | Renders an image attribute |
| Gauge | Numeric attribute shown in gauge format |
| Map | Renders an entity on a map |
| PotentialMatches | UI for reviewing potential matches |
| SendFeedback | Feedback widget with Zendesk link |
| Custom | Embeds a JS-driven or iframe view |
Access control fields
| Field | Description | Value Type |
|---|---|---|
| canRead | Roles allowed to view the component | string[] |
| canUpdate | Roles allowed to update the content | string[] |
| canCreate | Roles allowed to create content | string[] |
| canDelete | Roles allowed to delete content | string[] |
These fields are optional but recommended for granular role-based access.
Layout grid fields (layout[] inside Dashboard, profile, or pivoting)
| Field | Description | Type |
|---|---|---|
| id | Must match the ID of a view defined in the layout | string |
| x, y | Coordinates for grid placement (starting from 0) | number |
| width | Width of the item in grid units | number |
| height | Height of the item in grid units | number |
| isStatic | Prevents the user from dragging or resizing the item | boolean |
| minWidth, maxWidth | Minimum and maximum grid width allowed for this item | number |
| minHeight, maxHeight | Minimum and maximum grid height allowed for this item | number |
Chart ordering options
| Field | Description | Supported Values |
|---|---|---|
| orderType | Defines how chart values are sorted | reversedCount, alphabetical |
| sortByLabel | If true, sorts chart items by label instead of count | true, false |
| showOthers | If true, groups less frequent values into an “Others” slice or bar | true, false |
Field types in the properties object
| Field | Description | Type |
|---|---|---|
| checkIdle | Idle timeout in milliseconds, or use true for default timeout | number or true |
| customScripts | List of JavaScript files and matching API patterns | object[] |
| defaultRoute | Specifies which screen loads first after login | string |
| logo | URL of the logo image displayed in the top-left corner | string (URL) |
| masks.dateMask | Format mask used for date fields | string (mask) |
| masks.dateTimeMask | Format mask used for datetime fields | string (mask) |
| workflow.path | URL to the workflow server | string (URL) |
Validation configuration
| Field | Description | Accepted Values |
|---|---|---|
| levels | Specifies which types of validation messages to show in the profile | ["ERROR"], ["ERROR", "WARNING"] |
| validateReadMode | Enables validation checks when reading entities | true, false |
| validateRelations | Enables validation on entity relationships | true, false |
Supported sidePanelViews
| Value | Description |
|---|---|
| History | Displays audit history for the profile |
| Workflow | Shows associated workflow tasks |
| Discussion | Displays discussion threads (if enabled) |
| D&B | D&B enrichment status (if integrated) |