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 Available settings 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 Plugin 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 key to make a menu entry for Advanced Plugin Settings appear.

Available settings

KeySinceScopeDefault valuePrerequisitesDescription

versions.publish.global.keep.permalink.as.pagetitle

3.5.1

global

true

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, whereas the heading within the page's content will be Introduction.

This behavior was incorrect in 3.0.0 (see VSN-3154 - Getting issue details... STATUS 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

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.

theme-integration.json3.0.0global & spaceunset
  • 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.


versions.workflow.restartonedit3.3.0globaltrue

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.

display.getting.started.messages3.0.7globalfor users
  • Scroll Versions or Scroll Translations (or both) is activated
Uncheck the boxes to disable Scroll Versions/Translations onboarding notifications for administrators and users.
versions.restrict.to.spaces3.0.9globalno 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.

translations.restrict.to.spaces3.0.9globalno 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.
versions.publish.flushindex3.4.1globaltrue
  • 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.
translations.custom.locales3.1.0globalno 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).

repository.propertyMapping

3.0.0space
  • 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.reviewers3.7.0spacetrue
  • 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.

Related articles