Deprecations and Breaking Changes

Jedox software is updated regularly. While new features enhance the Jedox experience, they may affect existing databases and components. Below are changes that may impact your platform.

Features announced as deprecated will be removed in a future release. Until removal, these features continue to function as normal, unless otherwise indicated. During the deprecation period, Jedox users should prepare for the removal of the feature by adopting newer, alternative features, or adjusting their processes.

Breaking changes are recent changes that may impact your Jedox environment. Always back up your databases and other customized content before upgrading.

By default, the table below is sorted according to the version the deprecation occurs, from most recent to oldest. You can also sort the features by alphabetical order, by whether or not this was a breaking change, or by version the deprecation was announced for. To do this, click on the respective column headers.

This article refers only to currently supported versions of Jedox.

See also Known Issues in Jedox.

Feature Breaking Change Version affected Deprecation announced

TableView transform now throws error

TableView transform now throws an error when using a nonexistent column, which has never been allowed. Older projects may have used a nonexistent column, but since the transform never generated an error, the user would be unaware of the problem. Now an error message will be thrown.

This could be a breaking change to users who have an invalid project but were not aware of it.

350
Fall 2024 (24.2)

 

Adjusting Email notifications via SMTP in Jedox Web

The SMTP configuration section in the Jedox Web settings will be moved to the Cloud Console. Only administrators with access to the Cloud Console can configure the option. For access, contact Jedox Support. Existing settings are retained and transferred to the Console.

298
Fall 2024 (24.2) September 2024

SMTP Groovy functions

The following SMTP-related Groovy functions are obsolete and will raise a deprecation warning, starting with the 2024 Fall release (24.2).

  • setSMTPServer(String host, String port, String user, String password)
  • setSender(String sender)
  • enableTLS(boolean tls)
  • enableAuth(boolean auth)
  • trustAllServers(boolean trustAllServers)
  • getSmtpHostName()
  • getSmtpPort()
  • getSmtpAuthUser()
  • getSmtpAuthPwd()
  • getEmailMsgTxtSubType()
  • getEmailFromAddress()
  • isTls()
  • isAuth()
  • isTrustAllServers()

The function setMessage(String message, String subType) can be substituted with setHtmlMessage(String message)for text/html MIME types; note that other MIME sub-types are not supported.

299
Fall 2024 (24.2) July 2024

Order sorting options

The Order sorting options "asc" and "desc" have been renamed to "ascending" and "descending." Please note that you must update these settings for the component to function properly.

299
2024.1 February 2024

Creating a model from Integrator

This feature will no longer be available due to licensing compatibility issues.

  2024.1 May 2024

WorkerLogin modes to be deprecated

WorkerLogin modes "authentication" and "authorization" are being deprecated. These modes were used when the user logged in through SVS. Before deprecation is final, a warning will appear during startup for instances that are still using these modes.

300
2024.2 April 2024

Changes to getProperty method of variableAPI

If the getProperty method of the integrator groovy variableAPI is called, it now respects values set by external calls (for example, executing an execution with "Run with options" or Jedox Web actions). Previously, it would return the default value of the variable, from its definition.

Workaround: to maintain the previous behavior, create an additional variable that does not get overwritten by external calls, and then pass the name of this variable to getProperty instead.

300
2024.1 2024.1

Change in SVS Drillthrough

Jedox drillthrough capabilities have now become a native functionality outside of the SVS scripts. Compared to previous versions, this eliminates any potential need for maintenance after a Jedox upgrade. The new configuration offers four different modes and can only be managed by Jedox Support:

  • drilldown: drills down on cube base level
  • integrator: drills through to reveal relational data from ETL
  • automatic: drills through if ETL is available, or else drills down
  • custom: uses the same logic as older Jedox versions and performs a drillthrough according to the OnDrillThroughExt function, which is part of the SVS script. Note that we do not recommend this mode as it may require maintenance by the customer when upgrading the Jedox environment.

If enabled, the default mode for every environment is automatic.

An update to version 2023.4 will set any environment to the default drillthrough-mode automatic. Environments with customized drillthrough capabilities should adjust their processes and, if necessary, switch to custom mode.

300
2023.4 2023.3

Disabling Groovy Sandbox

Starting with Jedox 2023.4, Groovy Sandbox will be enabled in new Jedox environments. Customers will have access to the allowed libraries only. Generally, static checks are performed on all instances (independent of the runtime checks). These checks prevent, among other things, the usage of the following classes of the package java.lang: Process, ProcessBuilder, ProcessHandle, System, Runtime, SecurityManager.

The classes java.net.URL and java.lang.Thread are disallowed, even if java.net.* has been added to the custom allowed list.

For existing Cloud customers: customers must transfer their scripts to a supported platform feature by November 1, 2024. If there is no supported platform feature available, contact Jedox Support. If a new feature is necessary to accommodate the transfer, the Integrator team will support this process.

Customers migrating from On-Prem to Cloud: Groovy Sandbox will be enabled by default. If the customer has a Groovy script with a forbidden Java class or package, the Sandbox can be disabled for one year from the date of migration. If there is no native solution for forbidden scripts, the Integrator team will provide their support with alternative solutions. After the grace period of one year, the Sandbox will be enabled again.

300
Nov. 1, 2024 2023.4

Several methods in Java API

These methods are mainly used for internal API calls and have been replaced with other functionality. If any of the deprecated methods have been used, replace them with the recommended new method. See Java API for Jedox In-Memory DB (OLAP) for details.

301
2023.4 2023.1

Restricting PHP functions in Supervision Server

Some PHP functions have been disabled in SVS, as they can pose a threat when used with malicious intention. These functions are not typically required as part of a Jedox solution. The functions that will be disabled are:

chdir, dl, eval, exec, get_defined_constants, get_defined_functions, get_defined_vars, mail, passthru, phpinfo*, popen, posix_mkfifo, proc_open, putenv, shell_exec, system, unserialize

*If you are using phpinfo, you can replace it with phpversion.

If you have customized SVS scripts, please ensure that they do not include any of the stated functions. If your Jedox instance requires any of the deprecated functions, please get in touch with Jedox Support.

303
2023.3 2023.3

Passwords cannot be changed without providing the last used password (old_password)

This is a security enhancement which affects the In-Memory DB (OLAP). Add old_password in the API call. Note that Admin users (password role right W) can still change / reset passwords without providing the old password.

302
2023.3 2023.3

Some OLAP HTTP API functions

The OLAP HTTP API functions for loading and unloading server/databases/cubes/dimensions will be deprecated from the Server Browser, as they can lead to unpredictable and dangerous behavior if used fraudulently. These functions are generally not needed as part of a Jedox solution.

600
2024.1 2023.3

SFTP access to be disabled by default

This is a resource efficiency measure. All cloud instances that have not used SFTP recently must enable the option from the Connection section of the Cloud Console.

304
2023.3 2023.1

Certain PHP functions in Supervision Server

Some PHP functions have been disabled in SVS, as they can pose a threat when used with malicious intention. These functions are not typically required as part of a Jedox solution. The functions that will be disabled are:

system, exec, shell_exec, passthru, popen, proc_open, dl, eval, unserialize, putenv, posix_mkfifo, get_defined_functions, get_defined_vars, get_defined_constants

600
2023.3 2023.2

Savepoint directory in SFTP

This directory will not be available anymore. If your savepoint folder contains any files, migrate them to any of the other directories.

305
2023.3 2023.1

Upgrade to PHP 8.1 in Supervision Server

PHP 7.4 ran out of support on November 26, 2022. Supervision Server PHP Scripts need to be modified. See Migrating SVS scripts from PHP 7 to PHP 8.

306
2023.2 2023.2

Change to Integrator FileSystem location

This is a technology update. In FileSystem locations, only use paths relative to etl_data/files folder. You can also use FILE API to work with files on the local file system in Groovy scripts.

307
2023.2 2023.2

Jedox Plan & Forecast App

Following the release of the new Jedox Mobile App for iOS and Android in Qtr 4 2022, which offers improved features and performance. Migration to the new app must be done manually. All existing Jedox Plan & Forecast App users will need to download the new Jedox Mobile App to their devices and connect to their Jedox Web server. For more information on the product requirements, see Getting started with the Jedox Mobile App .

308
2023.2 2023.1

New Canvas within Web Spreadsheet

The New Canvas option within a Web Spreadsheet will not be available anymore. See Creating a Canvas for more information on how to build a new Canvas.

Existing Canvas reports within Web Spreadsheet workbooks will continue to work, but it is recommended to migrate these reports to the new dedicated Canvas report type. You can do this using the move sheet functionality within the Web Spreadsheet. When a Canvas sheet is moved from a spreadsheet into a new Canvas report type, the links to source objects will remain intact.

600
2023.3 2023.1

Changes to width and scrolling in Canvas reports

To improve the experience of viewing Canvas reports on mobile devices. Canvas reports to be consumed on mobile devices should be reviewed. The stack groupings / stack scrolling options should be updated as required to ensure the best possible mobile experience for end users.

310
2023.1 2023.1

Changes to Macro Engine Integrator wrapper library

Removal of Integrator SOAP API in Jedox 2022.4. Protocol-specific versions of the Macro Engine Integrator wrapper library have been fully removed in 23.1. Only the standard "integrator" library is now available (using REST API of Integrator). Using either the specific REST or SOAP variant (e.g. by "require library('integrator-soap');") will result in an error.

311
2023.1 2023.1

OLAP connections require HTTPS

To prevent unencrypted communication to the server. Change existing OLAP connections to use HTTPS instead of HTTP.

309
2023.2 2022.4

SAPBIHierarchy option "Extract mode"

The "Extract mode" options "noMasterdata" and "masterWithoutText" will no longer be supported due to inconsistent results depending on very technical aspects. Since only the "masterWithText" option remains available, a special selection in the extract component is no longer required. Consequently, all new and existing SAPBIHierarchy extracts will have the "masterWithText" behavior by default.

600
2023.2 2022.4

Database encryption

Database files can be encrypted using the "crypt" configuration option. While this can be beneficial in an on-premise environment, it has the downside of not being compatible with audit functions. Additionally, database encryption becomes obsolete in our cloud environments, as the whole storage is encrypted securely (see Jedox Cloud FAQ).

If you have not used your own encryption key, no further action is required, as migration of existing encrypted databases happens automatically once this option is removed. If you are using your own encryption key, contact Jedox Support to discuss your options.

600
2023.4 2022.4

HTTP Connections to OLAP

Connections from Excel, Integrator, and Jedox Web to Jedox OLAP servers will only be possible over HTTPS. Connections over HTTP will be disabled. When trying to access OLAP over HTTP in 22.3, the connection will be redirected to HTTPS. However, in some places the connections need to be manually changed from HTTP to HTTPS to support this change.

600
2023.2 2022.4

Deprecated connection types

A Hive connection will not be available anymore due to the lack of a stable JDBC driver and missing backwards compatibility. To connect to Hadoop files, the WebHDFS location can be used in file-based connections.

Other connections being deprecated are Derby, HSQLDB, and H2. SQLite may be used as an alternative.

600
2023.2 2022.4

palo_goal_seek mode "complete"

Our API function palo_goal_seek is represented as "Reallocate" in planning assistant. There are several modes to be used for goal seeking. One of them, mode "complete" is not exposed via planning assistant and returns results that are often not comprehensive for a Jedox user due to algorithms that might seem very random to users. If you use this mode in custom scripts, please adjust it to utilize one of the other modes like "Equal" or "Relative".

600
2023.1 2022.2

Usage of Business Rule function ISNULL() in Advanced Rule Editor

The function has been replaced by the EXIST() function, which has a better performance. Deprecation affects UI Definition of Business Rules. Rewrite your existing rules that use ISNULL() by utilizing the function EXIST(). For example <<NOT(ISNULL(['Month':'Jan']))>> should change to <<EXIST(['Month':'Jan'])>> .

Note that this deprecation affects only the UI compatibility. Existing rules which contain ISNULL() will continue to work, but the Rule Editor will not allow creating or editing them via graphical controls.

600
2023.2 2022.2

Updated November 4, 2024