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 typeWith a parent pageWithout a parent page
Displayed onDawiso homepage (if there is just one page/dashboard, the homepage won’t have any tabs), Dashboards tab in the top navigation barDashboards 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

PropertyDescriptionValuesMandatory
keyUnique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey.stringYes
nameName of the asset, used as the default EN translation.stringYes
templateVisual template of the page. Templates are built using different components, for options, see the Components Library.jsonYes
descriptionDescription of the property.stringNo
featuresArray of page features.arrayNo
iconKeyKey of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset.stringNo
locationKeyPage type and location of the page link. Must be defined together with parentKey. See locationKey values.stringNo
orderNumberOrder of the page on a main dashboard and in the list of all pages. Must be a unique value.integerNo
parentKeyKey of the parent page. Must be defined together with locationKey. See parentKey values.stringNo
stateCurrent 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).stringNo
translationsArray 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.arrayNo
urlURL address of the page. It must be unique for every dashboard/page. If no URL is provided, the name property will be used instead.stringNo

locationKey values

ValueDescription
dashboardPage displayed in the top navigation bar or on the parent page. parentKey cannot be NULL for this type.
embeddedApplicationStandalone full-screen page accessible only via /app/{url}. Not listed in the dashboard selection or on the homepage. Used with the [[slug
]] component.
homepage-tabPage displayed on the Dawiso instance homepage as a tab. If there is only one page, no tabs are shown.
top-menuPage displayed in the top navigation bar and on the Dawiso instance homepage. Position is determined by orderNumber.

parentKey values

parentKeyDisplayed onSupported locationKey
"core#dashboard_dashboards"Dashboards tab in the top navigation bardashboard
NULLDawiso instance homepage (shown as tabs if multiple dashboards exist)homepage-tab, top-menu