Configure UI settings for the Hierarchy tab
Learn more about the UI configuration settings used to display the Hierarchy tab in the Profile view.
The Hierarchy tab is configured in the new UI configuration format in config.json as a profile screen with class: "Hierarchy". Hierarchy is a profile tab, like Relationships, Interactions, and Activity. To display the Hierarchy tab for an entity type, add a Hierarchy screen object to the top-level profile array in the UI configuration. For more information, see Profile view tabs.
Before you configure the tab, make sure the required tenant business configuration and tenant physical configuration for hierarchy are in place.
Add the Hierarchy screen object to the top-level profile array in config.json.
{
"layout": [...],
"pivoting": [...],
"profile": [
{
"class": "Profile",
"label": "HCO Profile",
"visible": ["configuration/entityTypes/HCO"],
"entityTypes": {
"configuration/entityTypes/HCO": {
"views": [...],
"layout": [...]
}
}
},
{
"class": "Relationships",
"label": "Relationships",
"visible": ["configuration/entityTypes/HCO"]
},
{
"class": "Hierarchy",
"label": "Hierarchy",
"visible": ["configuration/entityTypes/HCO"]
}
],
"properties": {...}
}The following table describes the supported fields for the Hierarchy tab.
| Field | Required | Description | Possible values | Example |
|---|---|---|---|---|
class | Yes | Identifies the screen type. For the Hierarchy tab, this value must be Hierarchy. | String literal Hierarchy | "class": "Hierarchy" |
label | Yes | Tab label shown in the Profile UI. | Any string | "label": "Hierarchy" |
visible | No | Restricts the tab to specific entity types. If omitted, the tab is shown for all entity types. | Array of entity type URIs | "visible": ["configuration/entityTypes/HCO","configuration/entityTypes/HCP" ] |
canRead | No | Lists the roles that are allowed to see the tab. | Array of role names | "canRead": ["ROLE_ADMIN", "ROLE_USER"] |
Example for adding the Hierarchy tab
The following example adds a basic Hierarchy tab for the HCP entity type and uses the default import template behavior.
{
"class": "Hierarchy",
"label": "Hierarchy",
"visible": ["configuration/entityTypes/HCP"]
}