Global Statistics

For the most up-to-date documentation, please visit docs.brix.ch

The "Global Statistics" plugin provides an overview of all assets and the storage usage. Different users can be allocated different storages to track the consumption individually.

If you use individual (userId-based) properties, you'll want to run the Globalstatistics task after installing in order to update the usage cache. It recalculates the storage sizes for set users. Usually, this task runs at midnight.

Properties

To be configured in {home}/appserver/conf/custom.properties

globalStatistic.license

type: String, required: yes, default: -

License key (delivered by brix cross media)

globalStatistic.uiEnabled

type: boolean, required: no, default: false

This property has to be set to true to enable the global statistic plugin, otherwise the submenu-entry will not appear.

globalStatistic.storageSize.{userID}

type: long, required: no, default: -

For different users can be set how much storage size they have available. Only the users who have a configuration like this can see the plugin. This does not apply to Superusers, which always see the plugin.

globalStatistic.storageSize.default

type: long, required: no, default: -

If this property is set, superusers can see the storage usage percentage.

globalStatistic.cronExpression

type: time (seconds minutes hours days months years, separated with "space") ,required: no, default: 0 0 * ?

The Sizes for the users who have ben configured are determined on the times set in this property. As a result, the statistics display appears faster when it's called. On the other hand, the data will not be quite up-to-date.

globalStatistic.percentage

type: double, required: no, default: 0.9

if a storagesize has been set, the corresponding user is notified with an E-Mail if the percentage (set in this property) of the size is used.

globalStatistic.timeDelay

type: int, required: no, default: 7

After as many days as stated in this property the user will get a new E-Mail, if the used storage percentage still is above the limit.

globalStatistic.supportlink.default

type: string, required: no, default: -

Link to the Support Overview

globalStatistic.supportlink.{userID}

type: string, required: no, default: -

Link to the Support Overview, if different users need to see different links. Superusers will see globalStatistic.supportlink.default

globalStatistic.licenseMail

type: string, required: no, default: -

This property defines an email address to sent the information about low disk space and license violation (amount of users)

globalStatistic.sendMails

type: boolean, required: no, default: true

If this property is set to false no emails will be sent from the plugin.

globalStatistic.brixPowerusers

type: int, required: no, default: 1

The number set in this property will be subtracted from the total amount of powerusers.

globalStatistic.mailFrom

type: string, required: no, default: applicationserver.mail.from

If the emails should be sent from another address than the other mails from celum, an email address can be configured with this property.

Properties for Node-Informations

Since version 2.0 information about the selected node are shown in the sidebar.

guiPlugin.sidebar.nodeContent

type: list of string (comma separated), required: yes, default: node_generalinfo,node_metadatainfo,node_pinoverview

The nodeInformationSection needs to be added tho the list of sidebar content in this property. They will be displayed in the provided order. guiPlugin.sidebar.nodeContent=node_generalinfo,node_metadatainfo,node_pinoverview,nodeInformationSection

nodeInformation.visibleForGroups

type: list of long (comma separated), required: no, default: -

This property takes a list of group-ids which can see the informations in the sidebar. If this property isn't set all users can see the information.

nodeInformation.visibleForNodeTypes

type: list of long (comma separated) , required: no, default: -

This property takes a list of comma separated ids for nodetypes where the sidebar infos should appear. If this property isn't set, the information will be shown on all nodetypes.

Screenshots

Global Statistics Menu

Global Statistics Main

Node Informations

Troubleshooting

If the main window shows an error like:

Error: /jsp/globalStatistic.jsp (line: x, column: y) attribute value for [test] is not properly terminated

... then your Tomcat is too old (this is a known issue in older releases, but has fixed in 7.0.66, 8.0.30 and 9.0.0.M2 onwards). In that case you need update your Tomcat to the latest supported version.

Release Notes

1.0

Released 2017-07-17

Initial Version

1.1

Released 2018-01-19

The plugin now sends a warning email when the licensed number of users is reached (to the configured support mail address)

1.2

Released 2018-01-24

Some visual improvements were made. The chart now changes its color if the usage is critical.

1.3

Released 2018-03-08

Support Mail is configurable and all Mails can be disabled with new properties.

2.0

Released 2018-06-27

Node-Information are shown in the Sidebar.

2.1

Released 2019-04-11

Added support for CELUM 5.13.4 (Solr 7)

2.2

Released 2019-07-04

Added support for CELUM 6.1