Property description
The pages asset configures pages (also called dashboards) or parts of a page. Links to the pages can be displayed in the following locations:
| Page type | With a parent page | Without a parent page |
|---|---|---|
| Displayed on | Dawiso homepage (if there is just one page/dashboard, the homepage won’t have any tabs), Dashboards tab in the top navigation bar | Dashboards tab in the top navigation bar, Their parent page |
Minimal JSON
{
"key": "",
"name": "",
"template": {}
}{
"key": "dashboard_favourites",
"name": "Favourites",
"description": "",
"state": "active",
"url": "dashboard_favourites",
"iconKey": "favourite",
"template": {
"centerArea": [
{
"componentId": "favourites",
"type": "api-card",
"api": "api/dashboard/favourites",
"headerTitle": "page.home.favourites.title.key",
"noDataText": "page.home.favourites.no_data.key",
"noDataIconKey": "favourite",
"headerRightActions": [
{
"type": "search"
}
],
"onClickOpens": "link",
"nameAttribute": "objectName",
"objectPathKey": "pathNames",
"layouts": [
{
"type": "cards"
}
]
}
]
}
}Example taken from the core package.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey. | string | Yes |
name | Name of the asset, used as the default EN translation. | string | Yes |
template | Visual template of the page. Templates are built using different components, for options, see the Components Library. | json | Yes |
description | Description of the property. | string | No |
features | Array of page features. | array | No |
iconKey | Key of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset. | string | No |
locationKey | Page type and the location of the page link. Used together with a defined parentKey. Supported values are: With a parent page: Without a parent page; dashboard: Page displayedIn the top navigation bar orOn the parent pageKeep in mind that the parentKey property cannot be NULL for the dashboard page type.: homepage-tab: Page displayed on your Dawiso instance homepage. If there is just one page/dashboard, there will be no tabs on the homepage.top-menu: Page displayed in the top navigation bar and on your Dawiso instance homepage.The page’s position in the top menu is determined by its orderNumber. | string | No |
orderNumber | Order of the page on a main dashboard and in the list of all pages. Must be a unique value. | integer | No |
parentKey | Key of the parent page (primarily used together with the is_space_dashboard, is_application_dashboard features). Supported values are: With a parent page: Without a parent page; parentKey = “core#dashboard_dashboards”: Page displayed on the Dashboards tab in the top navigation bar.: parentKey = NULL: Page displayed on the Dashboards tab on your Dawiso instance homepage. If there are more dashboards on your homepage, they will be displayed as tabs.; Supported value for locationKey is:dashboard: Supported values for locationKey are Keep in mind that the locationKey property has to be defined together with the parentKey. | string | No |
state | Current status of the asset. Supported options are: active (asset is active and visible in the environment), inactive (asset is inactive and hidden, serves as a soft delete), hidden (asset is active but hidden in the environment). | string | No |
translations | Array of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations. | array | No |
url | URL address of the page. It must be unique for every dashboard/page. If no URL is provided, the name property will be used instead. | string | No |