Structure of the UI Configuration file
Learn how the UI configuration file is structured.
The UI configuration is a JSON object with the following four top-level fields:
{
"layout": [...],
"pivoting": [...],
"profile": [...],
"properties": {...}
}
Each field defines a major UI area in your tenant:
| Field | Description |
|---|---|
| layout | Defines top-level screens shown in the left navigation pane. For example, Dashboard, Search, Data Quality dashboard. |
| pivoting | Special multi‐chart pivot dashboards. |
| profile | Configures entity profile views, tabs, layouts, and authoring forms. |
| properties | Contains global settings, validations, and scripts. |
Configuration format and file location
The UI configuration must follow valid JSON syntax and use fully qualified URIs to reference objects in your tenant configuration. All references to entity types, attribute types, relationship types, and match groups must align with your L3 metadata. Use the UI Modeler to download the file, edit it, and upload it again. For more information, see Export and Import of UI Configuration Files.
Guidelines for configuration
To keep your configuration readable and AI-friendly:
- Group screens and views logically
- Avoid repeating hardcoded values
- Use consistent naming for view id fields
- Validate the JSON after every change