Property description

The template-settings component defines layout settings.

Example

Minimal JSON

{
  "type": "template-settings"
}
{
  "key": "parent_object_settings",
  "template": {
    "type": "template-settings",
    "rightPanelClosed": false,
    "hide": {
      "attachments": true,
      "changes": false,
      "commentSection": true,
      "concepts": true,
      "editButton": true,
      "favouriteButton": false,
      "hideEmptyAttributesButton": true,
      "shareObject": false,
      "watchingButton": true,
      "workflowStatus": true,
      "likeButton": true,
      "anchors": true,
      "updated": true,
      "created": true,
      "moveObject": true,
      "renameObject": true,
      "removeObject": true,
      "jiraSearch": true
    }
  }
}

JSON 3

{
  "componentId": "kpi#settings",
  "type": "template-settings",
  "header": {
    "fullnessAttributeTypeKey": "`core_fullness_score`",
    "layout": "default"
  },
  "hide": {
    "export": true
  },
  "layout": "default",
  "attributeLayout": "single-row"
}

Nested properties

PropertyDescriptionValuesMandatory
typetemplate-settingsstringYes
attributeLayoutLayout of attribute cards. See supported attributeLayout values.stringNo
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component’s position within the layout (template).stringNo
headerConfigures the object page header area. See supported header properties.jsonNo
hideDetermines whether each component is hidden ("component": true) or visible ("component": false). See supported hide keys.jsonNo
layoutDetermines the overall look of the object type page. See supported layout values.stringNo
rightPanelClosedDetermines whether the right panel (configured by the rightArea) is closed by default.booleanNo

Supported attributeLayout values

ValueDescription
multilineAttribute type and value are on a separate line.
single-rowDefault value. Attribute type and value are on the same line.

Supported header properties

PropertyDescription
descriptionAttributeTypeKeyIncludes a description stored in an attribute.
fullnessAttributeTypeKeyIncludes a fullness score, providing a visual metric for completeness.
layoutConfigures the icons in the object header. Supported values: default — header contains like/dislike, favorite, and watch buttons, workflow state, fullness score, etc.; documentation — removes the header for a wiki-like layout with only the object name, creation timestamp, last updated timestamp, author, and workflow state visible.
userRelationActionsAdds self-service buttons that let a user assign or unassign themselves to a user relation type. See “Supported userRelationActions properties” below.

Supported userRelationActions properties

Each entry in the userRelationActions array configures one button:

{
  "key": "acknowledge",
  "userRelationTypeKey": "core_business_owner",
  "visibleForUserRelationTypeKeys": ["core_steward"],
  "labelBefore": "object.header.acknowledge.before",
  "labelAfter": "object.header.acknowledge.after"
}
PropertyDescription
keyIdentifies the action in the API route that assigns and unassigns the user. Must be unique within the template.
userRelationTypeKeyThe user relation type the current user is assigned to and unassigned from. An unknown key fails template resolution.
visibleForUserRelationTypeKeysUser relation type keys that make the button visible. Dawiso displays the button only to a user who already holds at least one of them. An empty or missing array hides the action from every user. An unknown key fails template resolution.
labelBeforeTranslation key for the button label while the user is not assigned.
labelAfterTranslation key for the button label once the user is assigned. Can contain an expression — see Functions for .jsonValue() and .format().

Supported hide keys

KeyDescription
anchorsRemoves heading anchors.
attachmentsDisables adding attachments.
changesHides the change history section.
commentSectionDisables the comment section on the page.
conceptsRemoves the Concepts entry from the three-dot menu, and with it the option to create a concept. Applies to the object page and, when the settings are placed on an application’s overview object type, to the application overview.
createdHides the information about who created the object.
editButton[Obsolete] Removes the edit button for the whole object page.
exportHides the export button on the object page.
favouriteButtonDisables the option to mark the object as a favorite.
hideEmptyAttributesButton[Obsolete] Hides empty attributes.
jiraSearchIf Jira integration is enabled, removes the button that looks the object up in Jira.
likeButtonDisables the like/dislike button for the object.
moveObjectHides the option to move the object to a different location from the object settings.
removeObjectDisables the option to delete the object.
renameObjectDisables the ability to rename the object.
shareObjectDisables the object share option.
updatedHides the information about who last updated the object.
watchingButtonDisables the button to follow/watch changes to the object.
workflowStatusRemoves the workflow status.

Supported layout values

ValueDescription
defaultComponents are in panels with borders.
single-rowRemoves borders around panels on the page.