Settings API - Details screen layout schema table
Details screen layout (builtin:ua.screen-settings)
Configure layout for entity details page.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:ua.screen-settings |
| ua-screen |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| staticContent | - | StaticContent |
Enable/Disable static elements like Properties or Problems. | required |
| layout | - | LayoutDefinition |
Reference cards that should be shown on the screen (like chart groups or entity lists) or use the auto generated screen layout. | required |
Request body objects
The Breadcrumb object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| type | Breadcrumb Type | enum | - | required |
| entitySelectorTemplate | Entity selector template | text | An entity selector that is used to reference related entity screen For example for a process screen where you want to show the host it runs on, this might look like this: Please mind that the | required |
| entityType | Entity type | text | An entity type of entities list screen | required |
| link | Link key | text | A key of server-defined static link | required |
| displayName | Display name | text | A display name for a non-clickable or entity list breadcrumb | optional |
The CardReference object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| type | Card Type | enum | - | required |
| key | Card key | text | Unique key of the card, which is used to reference desired card configuration | required |
| entitySelectorTemplate | Entity selector template | text | An entity selector that is used to reference card from other ME type screen For example for a host screen where you want to show the processes charts this might look like this: Please mind that the | optional |
| width | Card width | enum | A value that determines how much vertical space will that card take | optional |
| collapsed | Collapse card | boolean | If true, card content will be collapsed | optional |
| displayInSidebar | Display in sidebar | boolean | If true, card will be available in sidebar and button in toolbar will appear to show it | optional |
| ribbonButton | Ribbon button key | text | Custom component key to render as ribbon button Every card has its default ribbon button. It can be overriden with that option and custom component on frontend. | optional |
| conditions | List of conditions | set | All conditions from the list need to be fulfilled for the card to be visible | required |
The HeaderType object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| description | Description | text | The description of the screen | optional |
| icon | Icon name | text | - | optional |
The StaticContent object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| showProblems | Show problems | boolean | If true, the screen show the problem card | required |
| showProperties | Show properties | boolean | If true, the screen show the properties card | required |
| showTags | Show tags | boolean | If true, entity tags will be displayed | required |
| showAddTag | Allow adding tags | boolean | If true, the "Add tag" button will be displayed | required |
| showGlobalFilter | Show filter | boolean | If true, the screen show the filter bar | required |
| showOwnership | Show ownership | boolean | If true, the screen show the ownerships card | optional |
| header | Header definition | HeaderType | - | optional |
| breadcrumbs | Breadcrumbs | list | A list of breadcrumbs leading to the screen Define breadcrumbs list in order from root page to leaf(current page would be last on that list). | required |
The LayoutDefinition object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| autoGenerate | Auto generated content | boolean | If true the screen content is auto generated. Disable to configure your own layout. | required |
| cards | Cards layout | list | A list of cards that should be shown on the screen Reference cards that should be shown on the screen. | required |