Child pages
  • Automatically Sending Data Set Summary Reports
Skip to end of metadata
Go to start of metadata

Introduction

The application server can be configured to send a data set summary report to a list of e-mail recipients in regular time intervals . The report contains all new data sets registered since the last report. Selected properties can be included into the report. The data sets are grouped by the data set type.

Configuration

In order to enable this feature the following lines have to be added to openBIS-server/jetty/etc/service.properties:

openBIS-server/jetty/etc/service.properties
mail.from = openbis@<host>
mail.smtp.host = <SMTP host>
mail.smtp.user = 
mail.smtp.password = 

maintenance-plugins = data-set-report

data-set-report.class = ch.systemsx.cisd.openbis.generic.server.task.DataSetRegistrationSummaryTask
data-set-report.interval = 86400
data-set-report.start = 1:00
data-set-report.email-addresses = <address 1>, <address 2>

This means that on the 1st day of every month at 1:00 AM openBIS sends to the specified e-mail recipients a report about the data sets that have been uploaded in the previous month.

Configuration parameters

The following table explains all configuration parameters understood by DataSetRegistrationSummaryTask:

Parameter

Description

interval

Interval (in seconds) between regular checks whether to create a report or not. This value should be set to 86400 (1 day). Otherwise the same report might be sent twice or no report will be sent.

start

Time the report will be created. A good values for this parameter is some early time in the morning like in the example.

days-of-week

Comma-separated list of numbers denoting days of week (Sunday=1, Monday=2, etc.). This parameter should be used if reports should be sent weekly or more often.

days-of-month

Comma-separated list of numbers denoting days of month. Default value of this parameter is 1.

email-addresses

Comma-separated list of e-mail addresses.

shown-data-set-properties

Optional comma-separated list of data set properties to be included into the report.

data-set-types

Restrict the report to the specified data set types.

configured-content

Use the specified content as the body of the email.

A report is sent at each day which is either a specified day of week or day of month. If only weekly reports are needed the parameter days-of-month should be set to an empty string.

  • No labels