Upgrade to 2022.06 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.

Pay special attention to the last step of the manual: Changes in the app | 2022.06 release

1. Pre-upgrade steps
Step Description
1.1  Download the latest Apliqo UX installer file: Apliqo.2022.06.00
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 relevant when 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

2. Online Upgrade Process

If you have Cubewise Pulse v6.0.x installed you can use the online migration package below which will automate the entire upgrade process and skip to step 2.

2022.06.00 Pulse Online Package

For Pulse online package migration Pulse version 6.0.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.

Note:  Upgrade your Content Store instance first. After completing the Content Store update, you can then simply use the installer and update your existing webapps to complete the upgrade process.

3. Offline Upgrade Process: Installing TM1 DB objects

Download

Follow the steps

Step Description
3.1
Download 2022.06.00 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

4. Main Apliqo UX app upgrade
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
5. Updating the Apliqo Server and webapp file properties
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
6. Changes in the app | 2022.06 release
6.1. Using % formatting in charts

In  this release the way the % format is handled in charts has changed. The old logic will no longer apply and the existing settings will be overridden on first edit.

The two options previously available options: Charts Tooltip Show Percentage and Charts Tooltip Format Value 

Will be replaced by: Charts Show Percentage 

Enabling Chart Show Percentage advanced option changes the way values are calculated and presented in charts. The format will be applied to data labels, tooltips and y- axis as shown in the example below.

Source data:

Example:

6.2. DBRW formulas no longer accept single quotes

Due to a change in the table component, DBRW functions using single quotes will no longer be supported and an error message will appear in the application. Change to double quotes is necessary. 

DBRW formulas need to be updated manually in edit mode on each screen where inserted formulas are used. However, thanks to the new Convert Single to Double Quotes option available in the table context menu quotes can be easily changed from within the app with minumal manual intervention.

6.3. Issue fix: Pipe ( | ) converted to forward slash ( / )

The default value of the enablePipeCharacterReplacement parameter has been changed from TRUE to FALSE for all new installations. This affects all string values contained within html and requests (widget titles, info text, MDX, fixed element values). 

If you are experiencing this problem within an existing webap, please make the following change in the settings.json file located in the ApliqoServer\webapps\App_Name\WEB-INF folder: 

  "cellUpdate": {   
  	"enablePipeCharacterReplacement": false  
    }
Click to copy

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.