Advanced Scroll App Settings

The advanced plugin settings allow project admins to tweak the behaviour of Scroll Versions. This article describes what settings are available, and how to change them.

Read the documentation thoroughly before applying these changes

Generally it is not advisable to change the standard settings and you should only change them with a thorough understanding of what they do.

Please read the documentation carefully before applying any changes in production.

Change advanced settings

Some advanced plugin settings can be defined on the space level, some can be activated on the global level, and some can be activated on both. Refer to the table below to see the scope of the individual advanced settings.

Confluence Administrators can configure settings on the global level at General Configuration > Scroll Runtime > Advanced Scroll App Settings > Scroll Platform.
Confluence Administrators and Space Administrators can configure settings on a space level at Space tools > Scroll Add-ons, and then pressing the ALT/Option key to make a menu entry for Advanced Scroll App Settings appear.

Please note that the global settings always overrule the space settings.

Available Settings

Key	Since	Scope	Default value	Prerequisites	Description
display.getting.started.messages	3.0.7	global	for users	Scroll Versions or Scroll Translations (or both) is activated	Uncheck the boxes to disable Scroll Versions/Translations onboarding notifications for administrators and users.
pagetree.remember.expanded.pages	3.14.0	space	true	Scroll Versions or Scroll Translations (or both) is activated	If 'true', the page tree would remember the expanded pages when navigating to other page tree nodes (the default page tree behaviour when using Versions in a space). If set to 'false', the page tree would collapse page nodes as in space without Versions or Translations enabled.
repository.propertyMapping	3.0.0	space		Scroll Versions and Scroll Viewport are activated	A JSON string that defines how versions are exposed to the Scroll Runtime, which is used to integrate Scroll Versions with other Scroll add-ons like Scroll Viewport.
repository.property.version.fullaccess.reviewers	3.7.0	space	true	Scroll Versions and Scroll Viewport are activated	If set to 'true', reviewers can see all versions when using Scroll Viewport. If set to 'false', they can only see versions that are marked accessible.
enable.support.resource	3.14.3	global & space	false	Scroll Versions or Scroll Translations (or both) is activated	Every REST resource behind the URL `http://<host>:<port>/<contextpath>/rest/scroll-versions/1.0/support/....` is locked by default and has to be enabled. Setting this property to true activates the support and maintenance REST resources.
theme-integration.json	3.0.0	global & space	unset	Scroll Versions or Scroll Translations (or both) is activated	A JSON string that defines how Scroll Versions or Scroll Translations is integrated into the theme you're using.
translations.restrict.to.spaces	3.0.9	global	no restrictions	Scroll Translations is activated	A comma-separated list of space keys where the usage of Scroll Translations is allowed. An empty list means that your space admins can decide if Scroll Translations is activated in their space.
translations.custom.locales	3.1.0	global	no custom locales	Scroll Translations is activated	A comma-separated list of custom locale keys to add to Scroll Translations. Keys must have the format `\"languageCode\"_\"countryCode\"_\"variantCode\"` (e.g. `en_EN_british`).
versions.publish.global.keep.permalink.as.pagetitle	3.5.1	global	true	Scroll Versions is activated Scroll Translations is not activated Duplicate page titles are activated	This setting influences how Confluence page titles are set when publishing pages to a different space. By default, if you have activated Scroll versions' Duplicate page titles feature, the permalink is used to set the published Confluence page title. For example, if a page's permalink is Intro Details and its Scroll page title is Introduction, then the Confluence page title (the last URL part of /`dispay/spacekey/Intro+Details`) of the published page in the target space will be Intro Details. This behavior was incorrect in 3.0.0 (see VSN-3154 for exact details). This bug was fixed in 3.3.2 – however, some users reported that they considered this behavior a feature. If you want, you can now switch back to the behavior to use the Scroll page title by configuring this setting to false.
versions.publish.space.keep.permalink.as.pagetitle	3.5.1	space	unset	Scroll Versions is activated Scroll Translations is not activated Duplicate page titles are activated	This setting overrides the setting for versions.publish.global.keep.permalink.as.pagetitle for a specific space. If the space and global settings are different, the space settings will take precedence.
versions.workflow.restartonedit	3.3.0	global	true	Scroll Versions' workflow management system must be activated	If set to 'true', then when pages with workflow status 'complete' are edited, their workflow statuses are reset to the initial state. When set to false, workflow status 'complete' remains when the page is edited.
versions.publish.flushindex	3.4.1	global	true	Scroll Versions is activated	If set to 'false', the Confluence index queue will not be flushed by Scroll Versions when publishing a space. This will reduce the time needed for a publish job and reduces the load on your system. It might lead to content that is not available in the Confluence search index right after the publish job.
versions.restrict.to.spaces	3.0.9	global	no restrictions	Scroll Versions is activated	A comma-separated list of space keys where the usage of Scroll Versions is allowed. An empty list means that your space admins can decide if Scroll Versions is activated in their space.
enable.included.content.highlighting.global enable.included.content.highlighting.space	3.16.0	global & space	unset	Scroll Versions or Scroll Translations (or both) is activated	Used to control if (Excerpt) Include+ macros are highlighted in page view. Can be defined on global level and on space level with space level setting taking precedence. Additionally, any highlighting can be disabled using user-specific Scroll Settings.
skip.macro.overrides	4.0.1	space	unset	Scroll Versions or Scroll Translations (or both) is activated	A comma-separated list of macro names which should not be overridden. These are the macros that get overridden by Scroll Versions and Scroll Translations and are thus eligible to be skipped. Please reference them by their `internal name`: Children display: `children` Content by Label: `contentbylabel` Page properties report: `detailssummary`
enable.unrecommended.feature.include-library	4.5.0	global & space	false	Scroll Versions or Scroll Translations (or both) is activated	Since Scroll Versions 4.5.0 the Include Library feature is hidden per default in any space that is not using the feature. If you want to continue using this feature in new spaces, set it to 'true'.
enable.unrecommended.feature.roles	4.5.0	global & space	false	Scroll Versions or Scroll Translations (or both) is activated	Since Scroll Versions 4.5.0 the Scroll Roles feature is hidden per default in any space that is not using the feature. If you want to continue using this feature in new spaces, set it to 'true'.
enable.unrecommended.feature.publish-to-same	4.5.0	global & space	false	Scroll Versions is activated Scroll Translations is activated	Since Scroll Versions 4.5.0 the Publish within same Space feature is hidden per default in any space that is not using the feature. If you want to continue using this feature in new spaces, set it to 'true'.