Migration to version 22

Content

The following chapters describe the various things to know when migrating from version 21.x of i-net Clear Reports to version 22.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.

Migration to version 21

Content

The following chapters describe the various things to know when migrating from version 20.x of i-net Clear Reports to version 21.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.

WAR file for Oracle Weblogic

The initialization for WebSocketEndPoint to be registerable in Oracle Weblogic was changed in version 21.10. This fixed the error `java.lang.IllegalStateException: Not in 'deploy' scope.`.

If you use an web.xml file of another WAR file you need to add the listener com.inet.http.ExpandableServletContextListener

Migration to version 20

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 Samples\Plugin - Samples\PropertiesChecker 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 Samples\Plugin - 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 is started using the plugin webserver.zip.

Migration to version 19

Content

The following chapters describe the various things to know when migrating from version 18.x of i-net Clear Reports to version 19.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

  • The MySQL Connector/J was updated to version 8.0.13. It is recommended for MySQL Server 5.5 or higher. For older MySQL Server version you could replace the MySQL Connector/J with the version of the previous i-net Clear Reports version
  • With the Server Printers plugin enabled users will not be able to use the server printer after upgrading to version 19. They will have to have group permissions assigned to regain access to server printers
  • The Data Source Manager Interface has been renewed from the ground up. Existing Data Sources in the former User/System/Temp/Session - Scopes will now be readonly from the interface but can still be added and modified using API. An new Application Scope has been added which now supports assigning user groups to restrict permissions
  • Data Sources are now handled differently for reports.
    • Data Sources with the same name may exist with different permissions in different scopes
    • The are looked up in the following order: User Session ScopeTemporary ScopeApplication Scope with permissionUser ScopeSystem Scope
    • Application Scope with permission means that there may be more than one Data Source with the same name but with different permissions. The first that is allowed for the users group will be used

Migration to version 18

Content

The following chapters describe the various things to know when migrating from version 17.x of i-net Clear Reports to version 18.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.

  • Data will be migrated by the setup into the new format of i-net Clear Reports version 18. Therefore we recommend to backup the program data.
  • The /remote context of the Remote GUI has been removed. Applications beneath this entry point have been moved up one level.
  • If you have a plugin which implements your own AuthenticationProvider then you must rewrite it. To support multiple login sources in parallel the API has changed. A sample for a such a plugin can be found in the SDK.
  • If you use the repository plugin then security settings will be migrated. After the migration it will no longer work with older versions of i-net Clear Reports. Permission patterns are not supported anymore. The administrator needs to check whether the users have the desired and expected permissions.
  • If the remote printing plugin is enabled then in the HTML viewer this is available via menu point.
  • There is a new default plugin that embeds the HTML Viewer into the remote application. That means that users of the HTML Viewer will see the configured logo, will be able to to signup/login and directly access their remote applications.
  • When having permissions or userdata for old, now unused, users, such users will appear as User Accounts in the new Users And Groups Manager. Take a look there and delete obsolete users.
  • The pattern (like "*", "vwl*.rpt", ...) in the folder permissions of the Repository Browser are no longer supported. After migration the settings will be valid for all report files in the same folder. If other patterns than "*" (all reports) were used then it is necessary to check the folder permission settings in the Repository Browser. The permission "Server Administration" is necessary for that.
  • The C# implementation based on IKVM is deprecated. It was replaced with the ProcessBridge. You can find it in the SDK (https://download.inetsoftware.de/clear-reports-sdk-latest.zip). You find the required folder structure for Visual Studio and Powershell in the readme.html of the folder "i-net Clear Reports .NET Bridge". It is necessary to reimplement your program using i-net Clear Reports API because the API is not compatible with the implementation based on IKVM.
  • In version 18 the option "Mapping Fonts" is enabled by default. If this option is activated, all characters of a logical or not embedded font will be replaced with characters of an embedded font.