Property description

The settings property at the asset level configures global, space, application, or space application settings.

Tip

Except for the marked options, all settings are also available for application-specific settings.

Minimal JSON

{
    "setting": {
        "key": ""
    }
}
{
    "setting": {
        "key": "excel_import_settings",
        "value": {}
    }
}

Nested properties

NameDescriptionTypeMandatory
applicationKeyKey of an application where the setting will be applied.stringNo
spacePathPath of the space where the setting will be applied. If the space has predecessors, separate them wich a slash /. E.g. Documentation/Technical Documentation.stringNo
settingSettings values. In most cases, true is the default value. See supported setting keys.stringYes

Supported setting keys

Application type

NameIs Single OnlyData TypeValue
is_application_code_tablesYesDefines the application type as code lists.boolean
is_application_data_dictionaryYesDefines the application type as data dictionary.boolean
is_application_data_lineageYesUse the front-end to determine when to store diagrams.boolean
is_application_dawiso_objectsYesDefines specific settings for core Dawiso package app.boolean
is_application_pdm_appYesDefines the application type as physical data model.boolean

Color

NameIs Single OnlyData TypeValue
changed_text_colorNoSupported values are any valid hex color code (e.g., #000000 for black). Or any color from the predefined enum list: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray. When word_diff_use_highlight is set to true, use colors only from the predefined enum list. When it’s not set, use only a hex color code.string
colorNoSets the application’s color.string
deleted_text_colorNoSupported values are any valid hex color code (e.g., #000000 for black). Or any color from the predefined enum list: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray. When word_diff_use_highlight is set to true, use colors only from the predefined enum list. When it’s not set, use only a hex color code.string
media_gray_backgroundNoAdds a gray frame to media inserted into a text editor.boolean
no_background_color_app_badgeNoHides color from the application badge.boolean
word_diff_use_highlightNoHighlights changed text using Word’s built-in highlight feature. When set to true, changed_text_color and deleted_text_color must use a color name from the predefined enum list. When it’s not set, both must use a hex color code. Used for Word (.docx) exports.boolean

Import and export

NameIs Single OnlyData TypeValue
enable_export_all_versions_between_two_datesNoEnables the option to export all Word document versions that changed within a specified date range. When enabled, the option is pre-selected in the export dialog. Exported versions are bundled into a single ZIP file. For more information, see Object export (Excel, Word, PDF).boolean
excel_export_enabledNoEnables export as an Excel file (.xlsx).boolean
excel_export_settingsNoConfigures object exports as Excel files.json
excel_import_enabledNoEnables import of an Excel file (.xlsx).boolean
excel_import_settingsNoConfigures object imports of Excel files.json
export_use_space_app_object_type_checkNoLimits the export to contain data (attributeTypes, relationTypes, userRelationTypes) only from the specified space and app.boolean
is_export_controlNoEnables export control for the application. Users outside the export control group (defined via with_export_control_group on the attribute type) are blocked from exporting objects where that attribute is true. Exported PDF and Word documents that include flagged objects receive compliance annotations. For more information, see features (attribute type) and Object export (Excel, Word, PDF).boolean
is_mip_secured_applicationNoEnables Microsoft Information Protection (MIP) encryption for Word exports from this application. When enabled, exported documents containing objects with the MIP sensitivity attribute (is_attribute_sensitive_dokument) set to true are encrypted via MIP before delivery. For more information, see features (attribute type) and Object export (Excel, Word, PDF).boolean
pdf_export_enabledNoEnables export as a PDF file. As the file is the PDF version of a Word export, make sure at least one Word template is assigned to the application using the exportTemplateKeys property in applications.boolean
word_export_enabledNoEnables export as a Word file (.docx). At least one Word template must be assigned to the application using the exportTemplateKeys property in applications.boolean

Numbering and sorting

NameIs Single OnlyData TypeValue
disable_change_of_numberingNoDisables the possibility to change numbering.boolean
disable_sort_objectsNoDisables automatic object sort.boolean
is_numbering_toggleNoAllows saving the toggle value on the app. Not available for applications settings.boolean
numbering_optionsNoAdds numbering options to the text editor. Not available for applications settings.json
object_ladder_numbering_patternNoConfigures a custom numbering pattern. Each token also sets the start value for its level: a number (e.g. 1, 15) numbers from that value; a lowercase letter (a–z) letters from that value; and an uppercase letter (A–Z) does the same in uppercase. Any special symbol (e.g. ., ,, -) is a delimiter. The pattern must end with a delimiter, and a level deeper than the pattern repeats its last token. Example values: 1.1., 1-a-, A.a., 15.0., B.1.string
order_numberNoDetermines the order of applications on the dashboard and within the Explorer API.integer
versioning_on_sort_order_enabledNoEnables versioning on sort order.boolean

Onboarding

NameIs Single OnlyData TypeValue
disable_onboarding_academyNoDisables the onboarding academy content for the whole instance. Enabled by default.boolean
disable_onboarding_checklistNoDisables the onboarding checklist and its progress pill in the navbar for the whole instance. Enabled by default. For more information, see Onboarding checklist.boolean
disable_onboarding_hintsNoDisables in-app onboarding hints for the whole instance. Enabled by default. For more information, see Onboarding hints.boolean
disable_onboarding_toursYesDisables guided tours for the whole instance: tours do not start and the Tours & guides section is hidden from the Help menu. Enabled by default. For more information, see the Tours section of Configuration.boolean
disable_onboarding_welcomeNoDisables the welcome screen shown to new users for the whole instance. Enabled by default.boolean

Tokenization

NameIs Single OnlyData TypeValue
has_token_keywordsNoConfigures the tokenization of keywords in the application, which will then be used in reference searches.boolean
has_token_textsNoConfigures the tokenization of text strings in the application, which will be used in reference searches.boolean
token_keyword_appsNoConfigures tokenization by specifying applications from which keywords should be taken. Example value: [app_key_1, app_key_2].array of strings
token_keyword_spacesNoConfigures tokenization by specifying spaces from which keywords should be taken. For example, value [1,2,3] will use keywords from spaces with IDs: 1, 2, and 3.array of integers

Other

NameIs Single OnlyData TypeValue
change_analysis_enabledNoEnables impact analysis.boolean
check_exact_matchNoEnables the comparison of object names creates relations between them when the names are the same.boolean
concept_table_templateNoConfigures the columns of tables with object concepts.json
copy_paste_as_plaintext_likeNoFilters out all HTML tags, leaving only basic ones in copy-pasted text. For more information, see the full list of preserved tags, special characters, and elements.boolean
disable_duplicate_validation_for_spaceappNoDisables duplicate name validation for the space application. When enabled, users are not notified if they create an object with the same name as an existing one. Disabled by default.boolean
exact_match_spacesNoEnables the comparison of object names in various spaces and creates relations between them when the names are the same.boolean
external_loadsNoEnables loading data from external providers.json
force_confirmation_after_object_moveNoRequires users to confirm when moving an object within the hierarchy.boolean
hide_comment_sectionYesHides comment section on object pages.boolean
lineage_parsing_optionsNoEnables lineage parsing.json
move_object_based_on_roleYesAllows moving objects to roles specified in user relation types.boolean
object_not_creatableNoPrevents the creation of objects in the application.boolean
object_workflow_space_admin_as_regular_userNoPrevents the admin from changing multiple users’ approval workflows without the approval of other users.boolean
one_global_fontYesConfigures a default font for all text editors. Text editors won’t offer different fonts. See supported one_global_font values. You can also set multiple global fonts by separating them using a semicolon ;. The first will be treated as the default, the rest of the fonts can be selectable in text editors and will be preserved when copy_paste_as_plaintext_like is used. E.g.: andale mono,times;arial,helvetica,sans-serifstring
read_only_hierarchyNoDetermines whether the object hierarchy is read-only, meaning no edits (such as moving objects) can be made to it.boolean
snapshot_enabledNoEnables snapshot taking.boolean

Supported one_global_font values

Supported values for the one_global_font property are:

  • andale mono,times
  • arial,helvetica,sans-serif
  • arial black,avant garde
  • book antiqua,palatino
  • comic sans ms,sans-serif
  • courier new,courier
  • georgia,palatino
  • helvetica
  • impact,chicago
  • inter
  • roboto
  • symbol
  • tahoma,arial,helvetica,sans-serif
  • terminal,monaco
  • times new roman,times
  • trebuchet ms,geneva
  • verdana,geneva
  • webdings
  • wingdings,zapf dingbats