ReportServer 3.2.0 is now available

ReportServer 3.1.0 is now available

In the following some important features in this version:

Allow to disable SFTP server

You can now disable the SFTP server by setting the disabled property in your /etc/misc/misc.cf file:

<remoteaccess>
   <sftp disabled="true">
      <!-- Use $generated in order to generate a key on first start. -->
      <keylocation>/path/to/hostkey.pem</keylocation>
      <port>8022</port>
   </sftp>
</remoteaccess>

After a ReportServer restart, the SFTP server will not be started if disabled previously.

Report deployment analysis

Allows to create an analysis of a deployment attempt of a given report (left report) into an destination report (right report). Both reports have to exist already in ReportServer. This analysis lists all conflicts -including context- that would occur during a deployment attempt of the left report into the right report. You can create this document with this command:

deployReport analyze id:Report:75919 id:Report:64253

where the id of the left report is 75919 and the id of the right report is 64253. An example analysis is shown in the following screenshots.

The current sections in the analysis are:

  • Columns contained in left report but not in right report
  • Columns contained in both reports but which different definitions
  • Variants of right report using columns not available in left report
  • Variants of right report using columns with different definitions as in left report

Note that if an entry does not cause a conflict, e.g. if the corresponding column is not used in any variant, the entry is not listed in the analysis result.

Dynamic list filter export

The filters and pre-filters can now be exported in an analogous way as the parameters. For this, you can use the new “output_filters” report property analogously as the “output_parameters” property. For HTML and PDF export, you can use the “${filterMapSimple}” variable analogously to the “${parameterMapSimple}” variable in the /etc/dynamiclists/htmlexport.cf (/etc/dynamiclists/pdfexport.cf for pdf). An example Excel export is shown in the following screenshot.

Note that all configuration options: parameters, filters and pre-filters are being exported into the “Configuration” sheet. This allows you to completely understand the data shown in the “Dynamic list” sheet.

Export list of scheduler job recipients and owners

You can now export a list of scheduler job recipients and owners in the scheduler email. For substitution of this list of users, you can use a fluent API that allows you to configure the output exactly as you need. For a list of available methods please refer to the documentation. As an example, if you enter the following configuration:

${recipients.
      addFirstnames().
      addSpace().
      addLastnames().
      addSpace().
      addString("(").
      addUsernames().
      addString(")").
      print()
 }

will print the following:

Barry Jones (bjones)

Diane Murphy (dmurphy)

Gerard Hernandez (ghernande)

Larry Bott (lbott)

If you want to separate the users by a comma instead of a new line, you can enter use the \code{setSeparator()} method as follows:

${recipients.
      setSeparator(", ").
      addFirstnames().
      addSpace().
      addLastnames().
      addSpace().
      addString("(").
      addUsernames().
      addString(")").
      print()
 }

which will print the following data:

Barry Jones (bjones), Diane Murphy (dmurphy), Gerard Hernandez (ghernande), Larry Bott (lbott)

For printing the list of owners, you can use the “owners” variable analogously.

MySQL 8 and MariaDB 10 support

You can now create and use MySQL 8 and MariaDB 10 datasources. The old MySQL 5 and MariaDB 5 datasources are of course also supported.

Mondrian 3 support

Mondrian 3 OLAP reports are now supported alongside with Mondrian 4 OLAP reports. The Mondrian 4 features, e.g. parameter substitution, cache deletion, or variant configuration protection are also supported in Mondrian 3. For activating Mondrian 3, please select the “Mondrian 3” checkbox in the following screenshot of your Mondrian datasource.

DB driver upgrade

The following drivers were upgraded:

  • MySQL: mysql-connector-java-8.0.20.jar
  • MariaDB: mariadb-java-client-2.6.0.jar
  • Postgres: postgresql-42.2.12.jar
  • H2: h2-1.4.200.jar
  • HSQL: hsqldb-2.5.0.jar

JXLS2 streaming

For heavy JXLS2 reports, i.e. reports having a large quantity of records and columns, you can now activate the streaming option with the jxls_streaming report property as shown in the following screenshot. This should improve performance. The property can be activated per report or/and per variant and works analogously for JXLS2 reports and JXLS2 templates of the dynamic list.

Keep in mind that with jxls2 streaming activated, most Excel formulas can not be used directly, so this is best for streaming raw data. We will update our documentation for details on this.

Copy/move variants between reports

You can now copy or move variants between different reports with the “mv” or “cp” commands, respectively, as shown in the following screenshot. Details can be found in the documentation.

The complete Release Notes are available here.

Apache JServ Protocol (AJP) Security Update

On February 29th, a vulnerability affecting Apache Tomcat were publicly disclosed:

This CVE describes an issue in AJP (Apache JServ Protocol) that can be exploited to either read or write files to a Tomcat server. Tomcat uses AJP to exchange data with nearby Apache HTTPD web servers or other Tomcat instances. This connector is enabled by default on all Tomcat servers and listens on the server’s port 8009, bounded to the 0.0.0.0 IP address.

In addition, application’s configuration files could be read, and passwords or API tokens stolen creating backdoors or web shells. This attack is exploitable via network with low attack complexity and without the required privileges as well as without the need for user interaction.

More info about this issue and the exact changes at the Apache Tomcat official site.

Affected Platforms

Check the Apache Tomcat version that you are currently using. The following versions are vulnerable and allow malicious users to exploit it:

  • 7.0.0 to 7.0.99
  • 8.5.0 to 8.5.50
  • 9.0.0.M1 to 9.0.30

How To Patch It

Update Apache Tomcat version to 7.0.100, 8.5.51 or 9.0.31.

We also recommend to not expose the AJP port externally to avoid being affected by this issue.

Bitnami Packages

Both ReportServer Enterprise and Community editions Bitnami solutions were updated to include the latest version of Tomcat. Also, new cloud images we submitted to the different cloud providers to secure new users deployments in the cloud as well.

More information can be found here: https://docs.bitnami.com/general/security/security-2020-02-29/

Switching your ReportServer archive tables off

ReportServer uses Hibernate Envers (https://hibernate.org/orm/envers/) as an archiving / versioning solution for entity classes. This might result in an unexpected and unwanted growth of size of the ReportServer repository database.

A new revision is created on every single entity change, so the archive tables grow with each entity modification. Thus, these tables get larger and larger, making your DB occupy a large amount of space after some time. If you don’t need the archive tables, you can easily turn this behaviour off.

For each table in the ReportServer repository there is a shadow table which has the same as the original tables plus the suffix _A. All entity versions can be found in the these tables. The “_A” suffix stands for “archive” or “audit”. So, e.g., your User’s revisions are found in the RS_USER_A archive table, since the respective actual entity versions are located in the RS_USER table.

To stop this behaviour in your ReportServer installation, open your persistence.xml and locate the section containing the string <!– Envers –>.
Then add the following:

<property name="hibernate.integration.envers.enabled" value="false"/>

The result would be similar to:

<!-- Envers -->
<property name="org.hibernate.envers.audit_table_suffix" value="_A"/>
<property name="org.hibernate.envers.audit_table_prefix" value=""/>
<property name="hibernate.integration.envers.enabled" value="false"/>

After a ReportServer restart, you can make sure that the archive tables are switched off by opening a ReportServer terminal session and typing a rev command for a given entity, as in this example:

Making sure the archive tables are switched off

If you get the message “Service is not yet initialized”, the archive tables are correctly turned off.

Once your archive tables are switched off, you can modify your “_A” tables: you can either leave them as they are or delete the entries.

Attention:
Once the archive tables are switched off, they cannot be switched on again unproblematically.
Pls. do not confuse the archive tables with the audit log ReportServer maintains in the RS_AUDIT_* tables. These are not impacted by the operations described above.

ReportServer 3.1.1

The 3.1.1 version is now available for all users.
In the following some important features in this version:

Allow to change lost password email texts via config file

ReportServer 3.1.1 allows you to edit the text a user receives per email when the user’s password is lost. The following is a configuration file for this purpose (/etc/security/lostpassword.cf)

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
      <lostpassword>
         <email>
            <subject>Password lost</subject>
            <text>Dear user ${user.getFirstname()} ${user.getLastname()},

A password request was issued for:

   User: ${user.getUsername()}
   Password: ${password}
	    </text>
         </email>
      </lostpassword>
</configuration>

Add “config echo” command for printing out individual current configuration parameters

In order to read the current active value of a configuration parameter, you can use “config echo”, e.g. for reading the default charset in the main.cf configuration file:

config echo main/main.cf default.charset

would return you e.g. “UTF-8”. For reading an attribute in the form:

<mailaction html="false">

you can write:

config echo scheduler/scheduler.cf scheduler.mailaction[@html]

More details on the syntax can be found in the Apache Commons Configuration documentation

Allow to configure the width of the columns in the dynamic list preview

You can now set the column widths of your dynamic lists via dynamic list configuration, refer to the next screenshot for an example.

You can also set defaults for all dynamic lists in the “/etc/ui/previews.cf” configuration file (defaultColumnWidth, maxColumnWidth):

<?xml version="1.0" encoding="UTF-8"?>
<!--
 ReportServer Configuration File
 filename: ui/previews.cf

 Configures how previews are rendered
-->
<configuration>
   <pdf>
      <mode>native</mode>
   </pdf>
   <dynamicList>
      <defaultColumnWidth>200</defaultColumnWidth>
      <maxColumnWidth>800</maxColumnWidth>
   </dynamicList>
</configuration>

Allow to configure if user account existence should be shown in the lost password dialog

You can now configure if the lost password dialog should reveal if the given username is existent or if no information should be disclosed. Per default, no information is disclosed. The configuration setting (indicateWrongUsername) is found in the /etc/security/lostpassword.cf file:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
      <lostpassword indicateWrongUsername="false">
         <email>
            <subject>${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordSubject']}</subject>
            <text>${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordSalutation']} ${user.getFirstname()} ${user.getLastname()},

${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordIntro']}

   ${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordUsername']}: ${user.getUsername()}
   ${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordPassword']}: ${password}

${msgs['net.datenwerke.rs.passwordpolicy.service.locale.PasswordPolicyMessages']['lostPasswordEnd']}

	    </text>
         </email>
      </lostpassword>
</configuration>

Library Deletions and Upgrades

In ReportServer 3.1.1 we deleted 52 libraries and upgraded 8. This removes many external dependencies in ReportServer.

For a list of all changes please refer to the release notes. The upgrade guide is available in the documentation area.
Happy reporting!