WorkspacesThis topic relates to Journey Workspaces | Platform Developer | This feature was introduced in the 18.11 releaseThis feature was updated in the 22.04 release
Some of the text and images below may not match what you see in your Journey Workspaces app. This is because the features described are based on a default Journey Workspaces configuration, and your Workspaces app may be configured differently; for example, with your company's branding, with fields for other information, or with a custom layout. Nevertheless, the features described work the same way in every Workspaces app.
Promoting Workspaces between environments is achieved by exporting the Workspaces archive from one environment and importing it into another environment. This transfers the definitions, pages, properties, resources and submission forms associated with the portal.
Before importing the Workspaces archive to your environment, make sure you have already had a fresh installation of Workspaces in that environment.
There is an issue in Workspaces 18.11.3 and earlier releases that prevents you from exporting your Workspaces archive. In this case, to promote your Workspaces portal, install Workspaces in your environment then manually copy the Workspaces assets like properties, pages and resources which are to be replaced.
Starting with Workspaces 20.05, the Workspaces client application is deployed as an Open UX form in Journey Manager. To promote the Workspaces client application from a lower environment to a higher one, export the Workspaces Open UX form (which includes all Workspaces configuration details) and import it into the target environment. No further configuration is required in the target environment.
The Workspaces WAR file is installed using the Journey Manager administration console. Login to Manager then select Forms > Form Spaces and click Import WAR. For more information about importing WAR files, see Import a Form Space as a WAR archive.
The Import WAR button is disabled in multi-node Journey Manager environments. To install the WAR file, contact cloud hosting support or your infra support to manually deploy the WAR file from the Journey server.
Starting with Workspaces 20.05, the Workspaces API (form space) WAR file comes packaged with the Journey Manager installer.
To install multiple copies of Workspaces in one Journey Manager environment, you need to change the name of the Workspaces application.
For example, to change the name from Workspaces to Temenos, you would need to make the
following changes to the contents of the
Workspaces WAR file.
\WEB-INF\jboss-web.xml: Change the context root.
<jboss-web>
<context-root>temenos</context-root>
</jboss-web>\Index.htm: Change the content URL.
<html>
<head>
<meta http-equiv="Refresh" content="0;URL=/temenos/secure/index.html">
</head>
</html>\WEB-INF\classes\db-config1.xml: Change the portal name, context path and WAR file name.
<portal name="Temenos">
<context-path>http://localhost:9080/temenos/</context-path>
<description><![CDATA[Temenos Workspaces]]></description>
<version>19.5.0</version>
<war-file-name>tm-temenos.war</war-file-name>\META-INF\maven\com.avoka.tm\tm-workspaces-war\pom.xml
<artifactId>tm-temenos-war</artifactId>
<name>TM: Temenos WAR</name>
<packaging>war</packaging>
<properties>
<portal>temenos</portal>
<portal.project.name>Temenos Workspaces</portal.project.name>
<portal.project.description>Temenos Workspaces</portal.project.description>
<portal.war.file.name>tm-temenos.war</portal.war.file.name>
<project.context>temenos</project.context>
</properties>
<build>
<finalName>tm-temenos</finalName>\META-INF\maven\com.avoka.tm\tm-workspaces-war\pom.properties
groupId=com.avoka.tm
artifactId=tm-temenos-war\META-INF\MANIFEST.MF
Specification-Title: TM: Temenos WAR
Implementation-Title: TM: Temenos WARRename the WAR file as well as tm-temenos.war.
Once the above changes are done, deploy the new WAR file in the Journey Manager environment.
Yes, you can have multiple different versions of Workspaces in the same instance of Journey Manager. When setting up Workspaces 19.05/19.11, make sure you select the Workspaces WAR file compatible with your Journey Manager version.
Yes, you can have multiple Workspaces 20.05 Open UX forms in a single Journey Manager instance.
To deploy
Workspaces with a different name / version, edit the
transact-config.json file.
{
"buildDir": "build",
"domainModelFile": "transact-schema.json",
"appDef": {
"name": "WorkspacesX",
"formCode": "workspacesx",
"clientCode": "workspaces",
"transactInsights": false,
"formVersion": {
"versionNumber": "20.05"
}
}
}The 19.11 release reached end-of-life in late 2022 at which time official support for this release ended.
The short answer is "yes". However, we don't recommend this mixed-release deployment, and there are a few things you should know before proceeding down this path.
No. TJM 21.11 introduces changes to the Workspaces REST API that are incompatible with earlier Workspaces releases. To learn more, see Workspaces release compatibility > Breaking changes in TJM 21.11.
Workspaces 24.04.1 and 23.10.4 introduced security enhancements to the in-app PDF viewer that prevent potential execution of any embedded scripts. To learn about these breaking changes, see:
A page containing just the word "code" may be displayed when you click the URL link on the Form Spaces page in Journey Manager (JM). This effectively indicates that the Work Spaces form space isn't linked to a form. Most likely, this is because some default routes have not been configured as described in Getting started > Form deployment and security > Security.
Starting from Workspaces 20.05, the Workspaces WAR file contains only the Workspaces REST API, with the Workspaces client application deployed separately as an Open UX form. So, when the Workspaces module is deployed during the JM installation process, the Work Spaces form space isn't linked to a form.
To fix this issue, follow these steps.
Once the Index, Index Secure, and Logout pages have been configured, clicking the Work Spaces form space's URL on the Form Spaces page will take you to the Workspaces app's login page and then, on successful login, to the app's form.
When you upgrade a Journey Manager environment, the existing branding for the Workspaces portal is preserved by default. If the environment is old and the branding outdated (for example, Avoka branding), you can replace the old branding with new default Temenos branding.
It's recommended to only make the changes described below when upgrading an old Temenos internal environment. For any other environment, ensure you need to make the changes described below before proceeding.
To fix this issue, follow these steps.
You may want to backup the old branding code in case it needs to be restored later.
Now, you can browse to the Workspaces login screen to confirm that the new Temenos branding is applied as expected.