CELUM Extensions

Here you'll find the configurable properties of our reusable CELUM Extensions .

Property format

The general property format in the docs is:

pluginName.propertyName

type: some-type, required: yes/no, default: xyz

Description and more infos about the property

Naming Scheme

We use Semantic Versioning, with the lowest compatible CELUM API version tacked on.

Our naming scheme for JAR files is pluginName-{version of the plugin}-{minimum celum api version}.jar

e.g. anura-2.8.5-6.8.1.jar means that anura has version 2.8.5 and requires at least CELUM 6.8.1 to run.

Plugin Installation / Update

1. Copy the JAR file to your celum/home/appserver/lib folder. Make sure the plugin version is compatible to your CELUM version (see naming scheme above).
2. Delete or remove any old versions of the plugin from the lib folder. This step could cause CELUM to stop working properly until it is restarted.
3. Update the celum/home/appserver/conf/custom.properties file with all the required properties (consult the individual plugin page).
4. Further customize the plugin by adding other properties to the custom.properties file (optional).
5. Restart the CELUM appserver.
6. Delete all files starting with the plugin's prefix in celum/server/app/work/Catalina/localhost/ROOT/org/apache/jsp/jsp. The folder could be named slightly different, depending on your installation. This step is only required for GUI plugin updates.
7. For GUI plugin updates it is also recommended to either clear the browser cache or press Ctrl+Shift+R after opening the plugin's GUI to reload CSS and JavaScript files.

Nova Plugin Installation / Update

1. Copy the Plugin folder to your celum/home/appserver/nova-plugins folder. Make sure the plugin version is compatible to your CELUM version. (the plugin folder is normally shipped in a zip folder by brix)
2. Update the celum/home/appserver/nova-plugins/plugins-config.json file to register the nova plugin (you can find the content you have to add in the plugin-config.json file in the zip, shipped by brix).
3. Update the celum/home/appserver/conf/custom.properties file with the property nova.app.plugins= (e.g. nova.app.plugins=file:/opt/celum/home/appserver/nova-plugins/)
4. Install the backend plugin (See Plugin Installation / Update).
5. Restart the CELUM appserver.
6. It is also recommended to either clear the browser cache or press Ctrl+Shift+R after opening the plugin's GUI to reload CSS and JavaScript files.

Logging

If you prefer to have our plugins log to their own log file, add the following to your celum/home/appserver/log4j2.xml:

in the <Appenders> section:

    <!-- brix log -->
    <RollingFile name="brixlog" fileName="${sys:synergy.home}/appserver/log/brix.log"
                 filePattern="${sys:synergy.home}/appserver/log/brix.%d{yyyy-MM-dd}.log.zip">
      <PatternLayout pattern="%d{yyyy:MM:dd HH:mm:ss} %C{1} %-5p %m%n"/>
      <Policies>
        <TimeBasedTriggeringPolicy interval="1"/>
      </Policies>
      <DefaultRolloverStrategy compressionLevel="5">
        <Delete basePath="${sys:synergy.home}/appserver/log">
          <IfFileName glob="brix.*.log.zip" />
          <IfLastModified age="30d" />
        </Delete>
      </DefaultRolloverStrategy>
    </RollingFile>

and in the <Loggers> section:

    <!-- brix log -->
    <Logger name="ch.brix" level="DEBUG" additivity="false">
      <AppenderRef ref="brixlog" />
    </Logger>

... set the level= to one of ERROR, INFO, DEBUG or TRACE as you desire, and don't leave it at verbose levels in production (or as soon as you've found the issue).

License Issues

• License file not found: Since 6.8, the environment variable synergy.home has been renamed to celum.home - supposedly this should have been backwards-compatible, but apparently it's not. Therefore we'd recommend that you have both -Dsynergy.home=... and -Dcelum.home=... pointed to the same location in order to achieve backwards-compatibility with older releases.

CELUM version vs. CELUM release

Starting with CELUM 6 (aka ContentHub), the notion of "releases" was introduced, which has nothing to do with the actual version. But sometimes this matters, so we'll stick with the version. Here's a lookup table: