×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Performing and Logging Scroll Health Checks

Roman Serazhiev

Roman Serazhiev Last update: Jun 18, 2018

With Scroll Versions 2.8 we introduced the Scroll Health Checks, Space Administrators are now able to perform several checks on Scroll Versions related data.

Those checks help to self-service and troubleshoot the spaces managed with Scroll Versions and provide better reports to the K15t Support team. Please only run the checks if you are having trouble with Scroll Versions or have been asked to run the checks by the K15t support team.

Available Scroll Health Checks

The following Scroll Health Checks are currently available (please note that, depending on the activated modules, the list of available checks might differ):

Shortcut Name Description If the check fails Page Revision Comment on affected pages if the check fails
L01 The Scroll Lookup Index is up to date

Checks that the values in the Scroll Lookup Index are up to date with those values stored in Confluence pages and page metadata (content properties).

This check always fixes inconsistent values immediately, because all other subsequent checks rely on the correctness of the Scroll Lookup Index.

-
S01 The Scroll configuration is valid Checks that the Scroll Configuration (activated modules, assigned roles) can be read.

Send a Confluence Support Zip to the K15t Support Team via support@k15t.com.

-
S02 All variants refer to existing attributes
(info) Only available if the Variant Management Feature is activated.

Checks that all variants refer to existing attributes.

The check creates new attributes and values for every nonexistent attribute and references the new values in the affected variants.

  • Check the new attributes and values manually
    (info) The new attributes or values are named in the pattern 'FixMe_Attribute<no>' or 'FixMeAttribute_Value<no>'.
-
S03 All preceding versions are existing

Checks that all preceding versions are existing.

The check creates a new version and saves the new version as preceding version of the affected version.

  • Check the new version manually.
    (info) The new versions are named in the pattern 'FixMe_Version<no>'.
-
S04 Required add-ons for Comala integration are enabled Checks that the required add-ons for a successful Comala integration are enabled, i.e. Comala Workflows and Scroll Integration for Comala Workflows must be enabled. Enable or install the missing add-ons (info on required add-ons)
S05 Comala Workflows is correctly setup to work with Scroll Versions Checks that Comala Workflows is activated in the space, only one workflow is activated and this workflow contains the flag "versionscompleted=true" instead of "final=true". Make sure you have followed the steps on the guide to Comala Workflows integrationIf this doesn't work, contact support at support@k15t.com and provide a support ZIP.
P01 All master pages have versioned pages

Checks that (at least) one versioned page exists for every master page.

The check converts affected masterpages into unversioned pages.

  • Check the affected pages.
Scroll Health Check: The page has been converted to an unversioned page by check ''P01''.
P02 All versioned pages are saved on their related master page

Checks that all versioned pages are saved on their related master page.

The check moves affected pages to their related master page.

  • Check the hierarchy of the affected pages.

On versioned page: Scroll Health Check: The page has been moved underneath its master page by check "P02".

On master page (if created): Scroll Health Check: The page has been created by check "P02".

P03 All versioned pages refer to existing versions

Checks that all versioned pages refer to an existing version.

The check assigns all affected pages to a new version.

  • Check the affected pages and the new version manually.
    (info) The new versions are named in the pattern 'FixMe_Version<no>'.
Scroll Health Check: The page has been assigned to the makeshift version ''<version name>'' by check ''P03''.
P04 All pages have a valid Scroll Page ID

Checks that all pages have a 32-digit Scroll Page ID.

Send a Confluence Support Zip to the K15t Support Team via support@k15t.com.

-
P05 All versioned pages are saved in the correct page naming pattern

Checks that all versioned pages are saved in the correct page naming pattern (.pageTitle v<version name>).

The check changes the affected page titles to match the page naming pattern.

  • Check the affected pages.

Scroll Health Check: The page title has been changed from <previousTitle> to <newTitle> by check ''P05''.

P06 All pages refer to existing attributes
(info) Only available if the Variant Management Feature is activated.

Checks that all pages refer to existing attributes.

The check creates new attributes and values for every nonexistent attribute and references the new values on the affected pages.

  • Check the new attributes and values manually.
    (info) The new attributes or values are named in the pattern 'FixMe_Attribute<no>' or 'FixMeAttribute_Value<no>'.

Scroll Health Check: The Scroll attribute values of the page have been changed to <attribute fixme name>=<attribute fixme value>, ... by check ''P06''.

P07 All conditional content macros refer to existing attributes
(info) Only available if the Variant Management Feature  is activated.

Checks that all conditional content macros refer to existing attributes.

Creates new attributes, values and variants and refers to them for every affected conditional content macro.

  • Check the new attributes, values and variants manually.
    (info) The new variants, attributes or values are named in the pattern 'FixMe_Variant<no>', 'FixMe_Attribute<no>' or 'FixMeAttribute_Value<no>'.

Scroll Health Check: The Scroll attribute values of the conditional content macros have been changed to <attribute fixme name>=<attribute fixme value>, ... by check ''P07''.

P11 Versioned pages do not have versioned child pages

Checks that all versioned pages do not have versioned child pages.

Moves affected pages in the hierarchy under the next possible master page.

  • Check the hierarchy of the affected pages.

On moved child pages Scroll Health Check: The page has been moved to be a child of <pageTitle> by check ''P11''.

P12 A translated page does not have translated title for the default language Checks that all pages have a single title for the default language This Check automatically removes the translated title for the original language. The translated page title ''{0}'' has been removed by check ''P12''.
P13 All pages have a correct Comala state ID Checks that all pages have a workflow state id assigned and this is equal to the Comala state. This check is only executed if the Comala integration is configured for this space. Contact support at support@k15t.com and provide a support ZIP. -
P14 All pages have a Scroll Page ID Checks that all pages have a Scroll Page ID. This check is only executed if duplicate page titles is the only Scroll Versions module activated in this space. Adds a valid Scroll Page ID to all affected pages. -
P15 Space has a valid home page Checks that the space has a valid home page

In versioned spaces, the home page must be either a masterpage or an unversioned page

In spaces where variant management is activated, the home page must exist in all variants

-
S101 FixMe attribute values should not exist

Checks that no FixMe attribute values exist.

Review all attribute values containing 'FixMeValue' manually. -
S102 FixMe attributes should not exist Checks that no FixMe attributes exist. Review all attributes containing 'FixMeAttribute' manually. -
S103 FixMe versions should not exist Checks that no FixMe versions exist. Review all versions containing 'FixMeVersion' manually. -

Running Scroll Health Checks

Open Space ToolsScroll Add-ons, click Health Checks. Once the checks have finished running, the results will be displayed. More information about each check is stored in a Scroll Health Check Log, which is automatically included in the Confluence Support ZIP.

Check results are split into four categories:

  • Manual intervention needed
  • Problems detected
  • FixMe elements found
  • Passed checks

Manual intervention needed

This category displays all failed checks that need to be further analyzed by the K15t Support Team. If you have checks displayed here, please create a Confluence Support ZIP and send it to the K15t Support Team.

Problems detected

This category displays all failed checks that can be repaired automatically. More information about these problems can be found in the Scroll Health Check Log. To repair these problems, click Repair.

FixMe elements found

This category contains all checks that need manual rework, because certain elements have been created automatically during the repair. More information about FixMe elements can be found in the Scroll Health Check Log. Please review these FixMe elements manually.

Passed checks

All successfully passed or automatically fixed checks are displayed in this category.

Scroll Health Check Log

Scroll Health Checks automatically create a new Scroll Health Check Log for every space a check has been run in (once a log file for a space is created, every further check within the same space is written in the same log file). The logs contain more information about exceptions, violations and fixes during the Scroll Health Checks.

Info

The logs are saved in the naming pattern scroll-health-check-<SPACEKEY>.log.csv. It can either be opened with a standard text editor or with CSV-compatible software (like MS Excel).

The log file is stored in the directory <confluence-home>/logs:

The log file contains information about all exceptions, violations and fixes occurred during each check and is automatically included in the Confluence Support ZIP.

The log file contains of the following types of log entries:

Type Description
REPORT Information about the configured checks
EXCEPTION a technical (unexpected) exception was thrown
VIOLATION a configured check found invalid data
FIX a check fixed invalid data

For every type the corresponding page and further details are displayed:

2xlatest
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok