(old) 2.2.1 Installation and Upgrade from 2.1 or 2.0

1. Installation

1.1. Run the installer


  • Double click on Apliqo.2.2 executable file.
  • If you get the following “Windows Defender SmartScreen” window, click on “More info”:
  • Then click on “Run Anyway”
  • In the “Welcome to Apliqo UX Setup” window click Next
  • Then accept the license agreement by clicking on “I Agree”:
  •  Select the options you need: 
    • “Install Apliqo Server” option will install the core components only. 
    • “Apliqo Demo” will install a TM1 instance having demonstration examples. 
    • “Create Backup” is available if the product is already installed (e.g. in case of upgrade):
  • Choose the Install location. By default it is set to “C:\ApliqoServer\

Note: as of version 2.2 an additional TM1 instance will be created and named “ux_content_store”. This instance will be used to store the view definitions for the UX, considering that multi-instance capabilities have been introduced in this version. This will be the default instance to store the view definitions, while the data referenced in these views can be retrieved from several TM1 instances at the same time.

  • Set the port number for the application server and the maximum memory. The port number set here will be used to reach the UX applications in the address bar of the browser. 
  • Default port is set to 8880. Should this port be already in use, make sure to change it to a different one. 
  • The maximum memory for the application server is by default set to 1024 MB. If there are no memory resource constraints it is a good practice to increase this value to 4096 MB.
  • Define the Start Menu folder in which to create shortcuts and click “Install”
  • The installation procedure starts:
  • When completed, click “Next”:
  • Then “Finish”

1.2. Install license key

To license the product, copy your “Canvas.xml” file into the “Conf” sub-folder you find in the installation path:


1.3. Test the installation

  •  Now the installation is complete, in the Windows services snap-in a new service named “Apliqo Application Server” is existing and running:
  • The installation folder has the following structure:
  • In particular, under “db” sub-folder two TM1 instances have been placed, “UX_CotentStore” and “UX_Samples”
  • This subfolder is used to store the TM1 instances which were installed during the installation. Two corresponding TM1 server services should have also been created:
  • The “webapps” subfolder is used to store all the UX applications running on the server. A sub-folder named “Appliqo_Demo” has been created by the installer:
  • It is possible to copy and rename this Demo application to create new UX apps. In general, the web browser address to open one of the applications will have the following structure:
  • http://hostname:portnumber/AppName/

  • where "AppName" is the name of the new sub-folder in the webapps directory.
  • Note: Application names are case sensitive!

  • For example, it is possible to open the “Apliqo_Demo” application in the browser using an address like http://hostname:portnumber/Apliqo_Demo/
  • A predefined user in this demo instance is “demo1”, no password.

NOTE: without a valid license, a login error will be returned, even when using valid credentials.

1.4. Planning Analytics server is located on different Machine.

This section is only required in the case that the Apliqo Application Server is installed on a dedicated web-tier  where the TM1 Server is not installed in the same machine. In this case the TM1 services seen won’t be created. 

The following manual steps will then be required to create the “UX_Content_Store” instance in the target machine, where TM1 servers are running.

  • In the installation folder, open the “db” subfolder and copy both “UX_CotentStore” and “UX_Samples” to the target server, let’s say inside “C:\TM1\Instances” directory:

  • In both instances, open tm1s.cfg file and check the port numbers. Be sure that these ports are free, otherwise change them to custom ports that work for you:
  • As visible, the “UX_ContentStore” TM1 Instance comes by default using ports 32888 and 8878.
    • In the target machine, register two new TM1 services to execute these two instances, using Cognos Configuration tool. Right click on “TM1 Server”, select “New Resource” and “TM1 Server instances”:
  • Assign one name like “UX_ContentStore” to the instance, then click OK and point to the directory in which the tm1s.cfg file of that incance is:
  • Right click on the new TM1 server and start it:

1.5. Update instances.json

  • Go into the Demo instance folder (“C:\ApliqoServer\webapps\Apliqo_Demo”, on the machine where Apliqo UX has been installed). In sub-folder “WEB-INF”, open file “instances.json” using a text editor. Predefined file is like this:
  • In the restUri and TM1WebUri properties, remove the localhostpart and place the machine name or the IP address of the machines where TM1 servers and TM1Web are running. If you have changed the port numbers, set them as well. The port numbers you need to use here for each instance are the ones set as “HttpPortNumber” property in each corresponding tm1s.cfg file.
  • You can add more sections to allow UX to connect to additional tm1 instances, for example:


  • The name doesn’t have to match necessarily with the tm1 server name you are pointing to, it is just a reference using internally in UX to identify one server connections. Of course using the same name is possible and makes things simpler. But what identifies the uniquely the instance you are connecting to is the target server name tm1servername and the HttpPortNumberhttpport that you specify in the restUri property.
    • The contentStore instance is mandatory. In this one there is also a special property named loginInstances,in which you can specify which of the following instances share the same users / logins with the contentStore one. When one user logs into the content store instance at the first login screen, she/he will be also automatically logged into the instances specified here (since they share the same credential) without being asked for a new login. Multiple instance names can be separated using commas. For example:
  • loginInstances: [UX_Dev,UX_Data]
    • Every time you edit the intances.json file of one of the UX applications, it is necessary to restart the “Apliqo Application Server” service in order to apply the changes.
  • Find out more on:
  • https://code.cubewise.com/canvas-docs/parameters-in-the-instancesjson-file

1.6. Create new UX Applications

To create a new UX Applications it is possible to copy and rename the “Apliqo_Demo” folder and edit the instances.json file as seen in the previous section, to make it point to the desired content store and Data instances. Give the folder the same Application Name you will use in the browser. Then, a restart the “Apliqo Application Server” service is required.  When the restart is done, the new application will be reachable in a browser at the address


  • http://hostname:portnumber/AppName/

For example, let’s copy the “Apliqo_Demo” folder


And rename it to “NewUXApp” after stopping the “Apliqo Application Server” service: 

  • NB: Application names are case sensitive!


Then we start the service again.

And we open the new application in the browser, using the address


NB: Since we have not edited the instances.json file, this application is connecting to the same TM1 servers as the “Apliqo_Demo” one, so it will use the same content store and present the same views and data:


Add your comment

E-Mail me when someone replies to this comment