Property description

The applications asset stores objects inside Dawiso. In this section of a package, you define the basic parameters of an application.

Although you can technically create multiple applications in one package, we highly advise against doing so due to:

  • Maintenance Complexity: Managing updates and changes becomes significantly harder when multiple applications share the same package.
  • Reusability: Keeping applications in separate packages allows for better modularity and reusability across different environments
  • Dependency Management: Independent application packages make it easier to track dependencies and avoid conflicts between configurations.

Minimal JSON

{
  "key": "",
  "name": "",
  "shortcut": "",
  "defaultObjectTypeKey": "",
  "colorKey": ""
}
{
  "key": "app",
  "name": "Documentation",
  "description": "The app Documentation manages and organizes documentation within the company.",
  "state": "active",
  "shortcut": "D",
  "colorKey": "app_color",
  "iconKey": "core_documentation_app",
  "defaultObjectTypeKey": "app_overview",
  "objectTypeKeys": [
    "document_set",
    "document"
  ],
  "hierarchyDefinitions": [
    {
      "hierarchyDefinitionKey": "core_object",
      "isDefault": true
    }
  ],
  "templates": {},
  "search": [
    {
      "isSearchable": true
    }
  ],
  "settings": [],
  "translations": []
}

Example taken from the core_documentation 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
shortcutShortcut of the application, used as the application’s icon. The maximum recommended length is 3 characters.stringYes
defaultObjectTypeKeyMain object type of the application that has to be created and defined before an application is installed. The content of its template is on the Application objects page.stringYes
colorKeyKey of the color used to visually represent the asset. Use predefined colors from Settings > Configuration > Colors. For more information, see colors.stringYes
actionUsed for patch packages. Specifies if the asset is added or updated.stringNo
dataIntegrationsDefines mappings that determine how ingested data is stored, specifying which object types and attributes the data will be assigned to. For more information, see Data Integrations.arrayNo
descriptionDescription of the application, visible on the Application Overview page (dashboard).stringNo
exportTemplateKeysArray of object export templates assigned to the application. Template keys can be found on the Word Templates settings page.arrayNo
hierarchyDefinitionsDefinition of hierarchies within the application. If not specified, the object type hierarchy definition will be assigned as the default. Ensure the list is unique. If the same hierarchy definition key is listed, an error will occur. For more information, see Hierarchy Definitions.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
notificationsArray of notifications. Application attribute is set manually, not here.arrayNo
objectTypeKeysKeys of object types used in the application. Either create new object types in the same package, or reference object types from previously installed packages. Ensure the list is unique. If a duplicate object type key is listed, an error will occur.arrayNo
searchArray of search objects. For more information, see Search.arrayNo
settingsSpecifies the default settings for the application such as import/export, tokenization, etc. These settings can be overridden by spaces-specific settings. Ensure the specified settings are unique. If a duplicate settings key is listed, an error will occur.arrayNo
spacesList of existing space(s) added to this application.arrayNo
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
templatesArray of components defining the visual appearance of the application’s overview page (dashboard). For available components, see the Components library.arrayNo
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