Periscope Control module

This page is no longer maintained. The Periscope Control module is deprecated since 6.2.17, following the unbundling of the Periscope Ranking module. The latter is now available to the community on Magnolia Forge.

Edition

Incubator (services)

Git

Git

Latest

1.0

Compatible with Magnolia 6.2, 6.1.
You must also have the Periscope module version 1.2.2 installed.

Using Magnolia 6.2.17 or later?

The Periscope Result Ranker module is bundled with all versions of DX core up to and including 6.2.16.

The Periscope Control module can only be used with DX core versions that bundle the Periscope Result Ranker module.

From 6.2.17, the Periscope Result Ranker module is unbundled, and its Maven dependency would need to be added to install it, so it is no longer necessary to use the Periscope Control module with Magnolia 6.2.17 and later.

The Periscope Control module allows you to control Periscope’s result ranking through a Magnolia property.

The Periscope Result Ranker module uses neural networks to improve the search results returned by the find bar in Admincentral.

On starting up Magnolia, the Periscope Control module checks the setting of the Magnolia property magnolia.periscope.resultRanking and sets the behavior of Periscope’s result ranking.

  • If set to true (or if the property is undefined), the Periscope result ranker will be enabled.

  • If set to false, the Periscope result ranker will be disabled.

There are situations when the result ranker should not be used:

  • When running Magnolia in Docker containers that do not support the nd4j native libraries, such as Alpine (enabling the result ranker will cause an Alpine derived Docker container to crash)

  • When running Magnolia with limited memory (result ranking can consume large amounts of memory)

You could disable the result ranker by creating a simple light module that decorates the Periscope result ranker configuration; however, it can be more convenient to control the result ranker with a Magnolia property rather than a light module.

This module is at the INCUBATOR level.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.services</groupId>
  <artifactId>periscope-control</artifactId>
  <version>1.0</version>
</dependency>

Usage

The Magnolia property magnolia.periscope.resultRanking is checked when the module starts.

The Periscope result ranker will be enabled if the property is set to true or is undefined, and set to false if magnolia.periscope.resultRanking=false.

You can set magnolia.periscope.resultRanking in:

  • A loaded magnolia.properties file in your Magnolia web app (see Configuration Management).

  • As a Java system property, e.g. on the command line -Dmagnolia.periscope.resultRanking=false when starting the JVM.

Changelog

Version Notes

1.0

Initial release of the module.

Compatible with 6.2, 6.1 and Periscope v1.2.2.
Feedback