i-net Clear Reports

Content

The following chapters describe the various things to know when migrating from version 19.x of i-net Clear Reports to version 20.x. If you migrate from older versions of i-net Clear Reports, then you should also read the other migration information depending on the version that you migrate from.

Changes in program structure

The internal structure has changed. That is why the new plugin reporting (file: plugins/reporting.zip) is now mandatory to start i-net Clear Reports. Due to this change the previous startup scripts are no longer valid and have to be changed.

In addition, the i-net Designers plugin remotedesigner.zip has been renamed to designer.zip.

If manual changes were made to the startup scripts, they have to be updated accordingly:

  • Report Server: the startup script has to be changed from
    • From: java -cp core/ClearReports.jar com.inet.report.ClearReportsServer
    • To: java -jar core/inetcore.jar
  • i-net Designer: the startup script has to be changed from
    • From: java -jar core/designer.jar
    • To: java -jar core/inetcore.jar designer
  • Command Line Parameters: the startup has to be changed
    • From: java -jar core/ClearReports.jar -forceImportConfig …
    • To: java -cp core/inetcore.jar com.inet.config.recovery.RecoveryConfiguration -forceImportConfig …
  • Servlet Users of custom *.war or *.ear: the servlet class has to be changed
    • From: com.inet.report.ReportServlet
    • To: com.inet.http.PluginDispatcherServlet. See the reference war file for details.

Note: Developers who utilise API classes such as com.inet.report.Engine from the reporting.jar have to extract this jar file from the reporting.zip plugin now.

Behavioural changes

  • The Web API plugin has been updated with a new remote interface application which requires an additional permission. Every other previous Web API extension now requires this permission as well. Users with specific Web API permissions must be checked and reconfigured in the Users and Groups Manager.
  • com.inet.report.ReportServlet has been removed. If there were extensions from the previously deprecated API, then they have to be moved to a plugin, registering an extension now.
  • The formula functions BytesFromFile and TextFromFile now limits access to files to prevent a path traversal for normal users. The specified file must be from a valid report location, and if it is located in the file system then it must be from the same directory or subdirectory as the report itself.
  • Custom implementations of com.inet.report.PropertiesChecker can not be added to the lib directory anymore. They have to be implemented using a plugin. See <SDK>Documentation and SamplesPlugin - SamplesPropertiesChecker for an example plugin.
  • Custom implementations of javax.servlet.Filter can not be added to the lib directory anymore. They have to be implemented using a plugin. See <SDK>Documentation and SamplesPlugin - Samples SessionDatasource for an example plugin.
  • The com.inet.report.Listener class has been removed. The web server has not been started by this class since version 15.x. The web server starts with the plugin webserver.zip.
 

© Copyright 1996 - 2020, i-net software; All Rights Reserved.