Workspaces release compatibility

Compatibility

When considering compatibility between a Workspaces release and a TJM release, you need to consider whether the Workspaces release is compatible with Journey Manager and Workspaces REST API from the TJM release. For example, considering Workspaces 21.11 compatibility with TJM 24.04 is equivalent to considering compatibility between Workspaces 21.11, Journey Manager 24.04, and Workspaces REST API 24.04.

Each TJM release includes compatible versions of Workspaces, Journey Manager, and the Workspaces REST API. Furthermore, unless otherwise stated below, all supported Workspaces releases are also compatible with all supported TJM releases when using Journey Manager and the Workspaces REST API from the same release.

The compatibility of Workspaces with Manager and the Workspaces REST API can be illustrated by several scenarios.

Scenario	TJM release compatibility
Workspaces, Manager, and Workspaces REST API from the same release	Compatible
Workspaces from one release, Manager and Workspaces REST API from another release	Compatible unless otherwise stated below
Workspaces from one release, Manager from a second release, Workspaces REST API from a third release	Compatibility is uncertain

The following releases have restricted compatibility with some TJM or Workspaces REST API releases.

Workspaces release	TJM release compatibility
21.11	Compatible with all supported TJM product suite releases. Compatible with Workspaces REST API 21.11 and earlier.
20.05 (EOL)	Compatible with all supported TJM product suite releases. Compatible with Workspaces REST API 21.11 and earlier.

Incompatibilities

A number of incompatibility issues have been identified that impact particular Workspaces releases. Information about these incompatibility issues is available below.

Dynamic branding

Affects: Workspaces 23.10 and later releases

Workspaces 23.10 introduced dynamic branding which allows themes to be applied based on an organization property or the user’s profile. Branding applied this way takes effect across the app including forms (if they support branding) that are rendered within the app.

The dynamic branding feature requires Journey Manager 23.10 and Workspaces REST API 23.10.

Filter/Search on job properties

Affects: Workspaces 23.04 and 23.10

Workspaces 23.04 added job properties as a data source option for List screen fields but without the ability to search or filter on these fields. This latter limitation was later addressed by an update in Journey Manager 24.04.

There are minimum TJM release requirements in order to take advantage of these features.

• Job properties as a data source: Journey Manager 23.04, Workspaces REST API 23.04
• Search or filter on job property fields: Journey Manager 24.04, Workspaces REST API 24.04

GUI config editor data persistence

Affects: Workspaces 23.04 and later releases

Workspaces 22.10 introduced the in-app configuration editor. Workspaces 23.04 enhanced this feature, allowing configuration data to be stored in and retrieved from a TJM server. The persistence of configuration data in this way requires Journey Manager 23.04 and Workspaces REST API 23.04.

Features that require Workspaces REST API 22.10

Affects: Workspaces 22.10 and later releases

The following features introduced in Workspaces 22.10 require the Workspaces REST API 22.10 or later.

• Bulk actions
• Support for invoking fluent functions

Breaking changes in TJM 21.11

Affects: Workspaces 21.11 and later when upgrading from Workspaces 19.11 and earlier

Changes to the Workspaces REST API introduced in TJM 21.11 (and retained in later releases) are incompatible with earlier Workspaces releases. Consequently, the Workspaces 19.11 application can no longer be used in a TJM 21.11 or later environment, and you must upgrade your Workspaces application to an Open UX form. For information about developing and deploying a Workspaces Open UX form, see Journey Workspaces form development and Form deployment and security.

CSRF token issue

Affects: Workspaces 20.05 and later releases

After upgrading a TJM 21.05 or earlier environment to TJM 21.11 or later, you may be presented with an HTTP 403 Forbidden status code when you attempt to access Workspaces. This may be due to a CSRF token implementation.

To fix this, you need to add the CSRFCross-site request forgery (CSRF), also known as one-click attack or session riding, is a type of malicious exploit of a website where unauthorized commands are transmitted from a user that the web application trusts. token to the following Workspaces portal pages:

• Login
• Change Password
• Forgotten Password
• Two Factor Authentication Setup

Failure to add the CSRF token to these pages prevents users with valid credentials from passing login authentication.

To add the CSRF token to a Workspaces portal page:

1. Login to Manager
2. Select Forms > Form Spaces and click Work Spaces. For more information about form spaces, see View Form Spaces.
3. Select the Pages tab, locate the page to update, and click Edit. For more information about form space pages, see View Form Space Pages.
4. Add the following code to the page's content inside the HTML <form> element.

   #if ( $csrfParamter )
       <input type="hidden" name="${csrfParamter}" value="${csrfToken}"/>
   #end

5. Click Save.

Repeat this process for each page that needs to be updated.

Compatibility

Affects: Workspaces 19.11 and earlier releases

Workspaces 19.11 and earlier releases are only compatible with Journey Manager and the Workspaces REST API included in the TJM 21.05 and earlier releases. This is due to breaking changes in the JM security model and WAR file structure introduced in TJM 21.11.

A TJM 19.11 or earlier environment upgraded to TJM 21.11 or later may be affected by the CSRF token issue mentioned above.

Open UX form

Affects: Workspaces 20.05 and later when upgrading from Workspaces 19.11 and earlier

Workspaces 20.05 replaced the Workspaces client application with an Open UX form. So, when upgrading a TJM 19.11 or earlier environment to TJM 20.05 or later, we recommend you migrate your Workspaces client application to an Open UX form. To learn more about developing and deploying a Workspaces Open UX form, see Journey Workspaces form development and Form deployment and security.

While we don't recommend a mixed-release deployment using a non-Open UX Workspaces client application in a TJM 20.05 or later environment, you can make this work if you really need to keep using a non-Open UX Workspaces client application. However, there are a few things you should know before proceeding down this path.

• To install a non-Open UX Workspaces client application, you need to download and import the Workspaces 19.11 WAR file into a TJM 20.05 or later instance.
• Importing the Workspaces 19.11 WAR file will also install the 19.11 version of the Workspaces REST API into your TJM instance, replacing any existing later version of this API.
• Consequently, you won't have access to any improvements introduced in later versions of the Workspaces REST API unless the Workspaces 19.11 WAR file is installed with a different name and context path.