2022.12 » Upgrade process

NOTE: IMPORTANT INFORMATION

Since this update introduces some breaking changes, please read the full upgrade instruction carefully and make sure to follow all the steps to get your application working properly.

Changes in the app | 2022.12 release

2022.12 version introduces changes in the way the cube settings are configured.

After the installation of 2022.12 version, reverting to the previous version may cause errors in the configuration of existing views. It is recommended to create a backup version of the existing contentstore.

NOTE: APACHE TOMCAT UPDATE

To get the latest version of Tomcat, when installing/upgrading Apliqo UX, make sure that you also select the option to install the Apliqo Server.

During Apliqo Server installation the settings.json file from ApliqoServer\py folder will be overwritten. Please make a backup in advance.

IMPORTANT: Versions older than UX 2021.11 FP3 will stop working on that server. It's not mandatory to upgrade Apliqo Server for the 2022.12 version.

Step	Description
1.1	Download the latest Apliqo UX installer file: Apliqo.2022.12
1.2	Stop the content store service(s) which are being upgraded
1.3	Stop Apliqo application server
1.4	Take a backup of the content store data directories
1.5	Take a backup of any TM1 content store db data which will be overwritten during the upgrade (e.g. }APQ UX AppSubType cube including DefaultJSON.) NOTE: this step is only relevant if custom widgets were created
1.6	If the Apliqo server is being updated e.g. due to the Tomcat version upgrade, take a backup of the settings.json file, as it will be overwritten during the server upgrade. File location: ..\ApliqoServer\py\settings.json

For Pulse online package migration Pulse version 6.x.x is required.

Note: that upgrades and fix pack releases of Apliqo UX ContentStore prior to July 2021 used Pulse 5.8.x migration packages. With the 2021.07 Apliqo UX release this was switched to the Pulse v6 format which is not backwards compatible with older versions of Pulse. If you are a Pulse customer still using an older version then you will need to follow the procedure for the offline package upgrade

Step	Description

Step	Description
2.1	If you have Cubewise Pulse v6.x.x installed you can use the online migration package below which will automate the entire upgrade process.
2.2	Download 2022.12 Online Loose File Package containing TM1 DB objects which need updating

Step	Description

Step	Description
3.1	Download 2022.12 Offline Loose File Package containing TM1 DB objects which need updating
3.2	Unzip the downloaded offline package and go to the 'items' folder
3.3	Select all the files and copy them to the TM1 Data\[Content Store]\Data\ folder to add/replace the required TM1 objects.
3.4	Restart the content store TM1 services
3.5	In the content store run the }APQ.UX.Server.Upgrade process
3.6	Restore any attribute values which have been overwritten by the new objects, which were backed up in step 1.5
3.7	Repeat for each content store which is being upgraded

Step	Description

Step

Description

4.1

Right-click the downloaded Apliqo UX installer file and select "Run as Administrator"

4.2

Follow the installation wizard:

4.3

Select the required options:

✅ Install Apliqo Server	➟ install the core components, required for e.g. Tomcat version upgrade
✅ Demo Applications	➟ install Apliqo Demo / reset the samples database
✅ Update Existing Applications	➟ update already existing webapp applications
✅ Create Backup During Update	➟ create copies of the webapps in ApliqoServer\Backups directory
✅ Create New Application	➟ proceed through the wizard to create new application. This is not required during existing applications update

Step	Description

Step

Description

5.1

Settings.json file in Apliqo Server (..\ApliqoServer\py\settings.json)

If the Apliqo Server has been upgraded, copy any overwritten values from the backup taken in step 1.6

5.2

Settings.json file in each webapp
Update the allowedRestPaths property - located under WEB-INF\Config.

Current allowedRestPaths available in the attached file below:

5.3

Restart Apliqo Server if any updates have been made in steps 5.1 and 5.2