Checker Repository Maintenance Tool - BloomReach Experience - Open Source CMS
06-11-2019

Checker Repository Maintenance Tool

Introduction

Goal

Download, configure and use the Checker repository maintenance tool.

Use Cases

BloomReach provides the Checker tool to enable administrators to perform the following repository maintenance tasks:

Each of the above tasks has a dedicated documentation page containing specific details and usage instructions.

However, the same Checker tool is used for each of the above tasks and below are some technical background info on the tool, generic instructions for downloading, configuring, and using it, and some troubleshooting tips.

Checker Tool Technical Background Info

The Checker tool is designed to be configured and act as a node in an existing repository cluster.

When run, the Checker tool creates a Jackrabbit storage directory (similar to any normal repository node) and a temporary record in the REPOSITORY_LOCAL_REVISIONS database table. The temporary record is removed after the Checker tool finishes its task. 

Generic Usage Instructions

Download

Download hippo-addon-checker.jar from the Hippo Maven repository. Make sure to download the latest version.

Generic Usage

After downloading hippo-addon-checker-<version>.jar you can run it using:

java -jar hippo-addon-checker-<version>.jar <command>

Try the help command to get a list of options and a basic explanation of their usage.

The hippo-addon-checker-<version>.jar ships only with the driver for MySQL included. To run the tool against a different database you must run it using an alternative command:
java -cp "hippo-addon-checker-<version>.jar:<driver>.jar" org.onehippo.cms7.repository.checker.Main <command>

Generic Configuration

First create a generic repository configuration file by running:

java -jar hippo-addon-checker-<version>.jar config > checker-repository.xml

The generated checker-repository.xml file contains example settings for a MySQL database. Modify the contents of this file to match your environment. See Configure Bloomreach Experience Manager for your Database Server for example configurations for supported database servers.

Next create a generic checker.properties file by running:

java -jar hippo-addon-checker-<version>.jar props > checker.properties

The contents of the generated checker.properties file must be modified to match your situation.

Specify the repository configuration file to use (see above):

rep.config=checker-repository.xml

Specify the Jackrabbit file storage location, e.g.:

rep.home=checker-storage

Be careful not to use the same storage location as you used when running Bloomreach Experience Manager. The workspace.xml in there will contain settings that are not understood by the checker, particularly data sources and the search index implementation. The Checker does not need a search index so that is left out of the sample configuration.

Task-Specific Configuration and Usage

Once the Checker tool has been configured as above, proceed to the relevant task's dedicated documentation page for further instructions:

Troubleshooting

If the Checker tool crashes or is aborted before finishing its task, the temporary record in the REPOSITORY_LOCAL_REVISIONS table is not removed. Running the Checker tool again and letting it finish properly will clean this up.

If the Checker tool repeatedly crashes and/or fails to finish its task properly, it may be necessary to manually remove the Jackrabbit storage directory and/or the temporary record in the REPOSITORY_LOCAL_REVISIONS table (delete the row that mentions the checker tool).

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?