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.stringYes

*Supported setting key options

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.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.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 is using Word’s built-in highlight feature. When set as true, the changed_text_color and deleted_text_color keys must be defined using text string values from the predefined enum list. [Used for Word (.docx) exports]boolean

Import and export

NameIs Single OnlyData TypeValue
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 (attributeTypesrelationTypesuserRelationTypes) only from the specified space and app.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 custom numbering pattern. The following values are supported: 1: Represents number., a: Represents lowercase letters., A: Represents uppercase letters., Any special symbol (e.g., . (dot), , (comma), - (hyphen)): Separator/delimiter. Example values: 1.1., 1-a, A.astring
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

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_spaceappNoTrue: The user will not be notified if they create an object with the same name as an existing object., False: [Default value] The user will** be notified if they create an object with the same name as an existing object.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. Supported values 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 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