Difference between revisions of "Upgrade ACP to a new release"
(30 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | Here's how to upgrade [[Analytica Cloud Platform]] running on a server to a new release. | |
− | If you are | + | If you are doing a complete new install of ACP on a server, you need to follow the instructions [[To_install_ACP|on this page]]. |
− | + | ==Activate a new license for ACP== | |
− | + | <font color=blue>This section is not necessary if you are still have an active ACP license. You can skip to the next section.</font> | |
− | Launch Desktop Analytica... | + | *If you are just activating a new subscription license for ACP then you can skip the downloading and installing. But you need to ensure that the user running the ACP processes can use the new license. The easiest way will normally be to launch Analytica as that user in a command prompt. |
− | + | ||
+ | ===If you don't have an internet connection=== | ||
+ | Acp licenses cannot be activated manually as the Desktop Analytica licenses can. | ||
+ | If you do not have an internet connection, you will need to get a license file which has been signed from Lumina, and update with the license file from Analytica's Help > Update license dialog. Once you receive the updated license file, save it to the directory where your previous Analytica license was - usually C:\programData\Lumina\Licenses | ||
+ | |||
+ | ===Check the ACP user's license=== | ||
+ | *In a non admin command prompt cd to your Analytica install folder. | ||
+ | |||
+ | <code>CD "C:\Program Files\Lumina\Analytica 6.4"</code> | ||
+ | |||
+ | *Launch Desktop Analytica... | ||
+ | <code>.\Analytica</code> | ||
Activate your new license - you can refer to this page [[License Information dialog]] | Activate your new license - you can refer to this page [[License Information dialog]] | ||
*In the Help menu, select Update license and enter the license - Activation key you received from Lumina into the license field and press Enter. | *In the Help menu, select Update license and enter the license - Activation key you received from Lumina into the license field and press Enter. | ||
− | Now Activate this license for your | + | Now Activate this license for your user running ACP - substitute the user name on your server for ACPUser if necessary. |
*<code>RunAs /user:ACPUser .\Analytica</code> | *<code>RunAs /user:ACPUser .\Analytica</code> | ||
*When prompted, enter the password for ACPUser | *When prompted, enter the password for ACPUser | ||
Line 21: | Line 32: | ||
* Now restart and test the Suan.exe application - see the sections below | * Now restart and test the Suan.exe application - see the sections below | ||
− | ==Install/upgrade to a newer build of | + | ==Install/upgrade to a newer build of ACP== |
+ | |||
=== Download and install the Analytica installer === | === Download and install the Analytica installer === | ||
− | *Download the Analytica release appropriate for your new ACP release, currently [https://downloads.analytica.com/ | + | |
− | * Install this Analytica release build. Install to the default folder. Use your existing | + | <font color=Blue>If you are updating to build 149 from build 138, you will not need to update this installer release and you can skip to the next section</font> |
+ | |||
+ | *Download the Analytica release appropriate for your new ACP release, currently [https://downloads.analytica.com/ANA/AnaSetup6_4_8.exe https://downloads.analytica.com/ANA/AnaSetup6_4_8.exe]. | ||
+ | * Install this Analytica release build. Install to the default folder. Use your existing ACP or ACP w/optimizer license. | ||
* Now you need to ensure your database user can use the Analytica license - In a non admin CMD prompt: | * Now you need to ensure your database user can use the Analytica license - In a non admin CMD prompt: | ||
− | *::<code>CD "C:\Program Files\Lumina\Analytica 6. | + | *::<code>CD "C:\Program Files\Lumina\Analytica 6.4"</code> |
*::<code>RunAs /user:ACPUser .\Analytica</code> | *::<code>RunAs /user:ACPUser .\Analytica</code> | ||
*When prompted, enter the password for ACPUser | *When prompted, enter the password for ACPUser | ||
Line 32: | Line 47: | ||
* Test that it saves this info by exiting and restarting, again as ACPUser, and checking the Help-Update License dialog. | * Test that it saves this info by exiting and restarting, again as ACPUser, and checking the Help-Update License dialog. | ||
− | === Download files to be updated and copy | + | === Download files to be updated and copy them to your ACP installation === |
− | *Download | + | *Download the relevant Zip Archive for the UI, and extract it to a folder on your computer. |
− | + | If you are using Firebase Authentication: | |
− | + | [https://downloads.analytica.com/ana6.4/ACP_Build_149_FB.zip ACP_Build_149_FB.zip]. | |
+ | |||
+ | If you are using Apache Authentication: | ||
+ | [https://downloads.analytica.com/ana6.4/ACP_Build_149_AP.zip ACP_Build_149_AP.zip]. | ||
+ | |||
+ | ====Save files to the Analytica folder==== | ||
+ | <font color=Blue>If you are updating to build 149 from build 138, you will not need to update these files and you can skip to the next section</font> | ||
+ | |||
+ | *These files (from the archive extracted in the previous sections) need to be saved to <code>C:\Program Files\Lumina\Analytica 6.4</code> Overwrite the existing files with the same name.<br /> | ||
+ | |||
#Analytica.ini | #Analytica.ini | ||
#suan.exe | #suan.exe | ||
#libssl-3.dll | #libssl-3.dll | ||
+ | #libssl-3-x64.dll | ||
#libcrypto-3.dll | #libcrypto-3.dll | ||
+ | #libcrypto-3-x64 | ||
#SuanFirebaseAuth | #SuanFirebaseAuth | ||
+ | <font color=Blue>Again, this next step is not necessary If you are updating to build 149 from build 138</font> | ||
+ | |||
+ | '''''<font color=blue>Before proceeding with the next step, you will need to stop the current Suan.exe process in the task manager (if it is running), so that you can overwrite it with the new version</font>.''''' | ||
+ | *Save these files to <code>C:\Program Files\Lumina\Analytica 6.4</code> (When prompted click yes to replace existing files)<br /> | ||
− | * | + | ====Save files to the UI folder==== |
+ | *The rest of the files from the extracted archive, in folders assets and build, need to saved to the ACP\ui folder | ||
+ | <font color=Blue>If you are updating to build 149 from build 138, you will not need to update the assets folder since it has not changed since 149. You will only need to update the Build folder.</font> | ||
− | + | <!--<Font color = "blue">Before replacing the Assets folder, you may want to save your DB Driver info.ana file first. So that you don't have to go in and manually edit the new one with the databse credentials. This asset file has not changed for build 119 . </font>--> | |
+ | *Save these folders to <code>D:\ACP\ui\</code>. Replace the existing folders.<br />. | ||
+ | #Assets | ||
+ | #Build | ||
− | * Test this part | + | *If you did not save the previous Acp\Ui\assets\Db driver info.ana file, open the new one and enter the Database credentials before attempting to run ACP. |
− | ** In D:\Acp\ui\Assets Session.config | + | |
+ | ===Test this part=== | ||
+ | ** In the config files D:\Acp\ui\Assets Session.config and Server.config, in a text editor, temporarily set <code>DesktopUI=1</code>. Save the files. | ||
** In a non-admin CMD prompt: | ** In a non-admin CMD prompt: | ||
− | **:<code>CD "c:\program files\lumina\Analytica 6. | + | **:<code>CD "c:\program files\lumina\Analytica 6.4"</code> |
**:<code>.\Suan.exe /config:d:\Acp\ui\assets\server.config</code> | **:<code>.\Suan.exe /config:d:\Acp\ui\assets\server.config</code> | ||
**:: Expected: An Analytica desktop instance should launch with an architecture drawing. It should stick around and not vanish. | **:: Expected: An Analytica desktop instance should launch with an architecture drawing. It should stick around and not vanish. | ||
Line 61: | Line 98: | ||
===Make any updates to the database=== | ===Make any updates to the database=== | ||
− | |||
* Run: Analytica.exe "d:\Acp\ui\assets\Database alterations.ana" | * Run: Analytica.exe "d:\Acp\ui\assets\Database alterations.ana" | ||
− | * In the text input Updating from release number enter your release you are updating from eg. <code>0. | + | * In the text input Updating from release number enter your release you are updating from eg. <code>0.113</code> |
− | * In the text input Updating to release number enter your release you are updating to eg. <code>0. | + | <font color=blue>For this next step, if you are updating to the ACP 3.0 release build from an earlier beta build, you should enter 0.45.</font> |
+ | * In the text input Updating to release number enter your release you are updating to eg. <code>0.138</code> | ||
* Press the output node Required alterations | * Press the output node Required alterations | ||
* Look at the result for number of alterations to be applied. If more than 0 press the button Apply Alterations. Once you get a message the the alterations have been applied, of If no alterations need to be applied just close the model. | * Look at the result for number of alterations to be applied. If more than 0 press the button Apply Alterations. Once you get a message the the alterations have been applied, of If no alterations need to be applied just close the model. | ||
+ | |||
+ | <!-- | ||
+ | ===Add a Subscription Administrator=== | ||
+ | <font color="blue">You should be able to skip this section. So you can skip this section</font> | ||
+ | You only need to do this if your last build was ACP beta build 0.40 or earlier. For instance if you are updating from build 0.32 beta to build 3.0 (which has the same database as 0.45 beta). Starting in build 0.41, only subscription administrators can add or delete projects. See more on this page [[ACP_Group_Accounts|ACP Group accounts]]. | ||
+ | |||
+ | If you do not have at least 1 subscription administrator, perform these steps. | ||
+ | * Copy the latest version of <code>d:\acp\ui\assets\suan account admin.ana</code> to <code>d:\acp\accounts\suan account admin.ana</code> | ||
+ | |||
+ | * Copy the latest version of <code>d:\acp\ui\assets\db driver info.ana</code> to | ||
+ | <code>d:\acp\accounts\db driver info.ana</code> | ||
+ | (overwrite any existing files). | ||
+ | |||
+ | * In a command prompt <code>cd c:\"Program Files\Lumina\Analytica 6.4"</code><br /> | ||
+ | <code>.\suan.exe /config:d:\acp\ui\assets\singleinstance.config "d:\acp\accounts\suan account admin.ana"</code> | ||
+ | |||
+ | When prompted to create a subscription administrator, click '''yes'''. | ||
+ | |||
+ | * Open the module Manage existing Group subscription. | ||
+ | ** In the pulldown menu for Subscription Admin, ensure that at least one user is selected (checked) as the subscription admin. | ||
+ | ** Close the suan account admin.ana model for now. | ||
+ | '''Expected: You should have a subscription manager for the Group account on your server, the user(s) whose email address you entered.''' | ||
+ | ** Notify the Subscription Administrator that they can add or delete projects, and manage other subscription administrators by using the Subscription Administration project. See more on the ACP Group accounts page [[ACP_Group_Accounts|here]]. | ||
+ | --> | ||
=== Restart Apache === | === Restart Apache === | ||
In an elevated command prompt: <code>C:\Apache24\bin>httpd.exe -k restart</code> | In an elevated command prompt: <code>C:\Apache24\bin>httpd.exe -k restart</code> | ||
+ | |||
+ | ===Update Scheduled tasks=== | ||
+ | If this update has involved installing a newer major or minor release of Analytica. For instance 6.3 - 6.4, you will need to update the scheduled tasks in task scheduler to point to the new Suan executables. | ||
+ | |||
+ | * So for instance you would change the scheduled tasks that start the Suan processes at boot to point to the new Suan.exe at C:\Program Files\Lumina\Analytica 6.4\Suan.exe | ||
+ | * Repeat for all 3 of the scheduled tasks for suan.exe pointing to Server.*.config tasks and the DTA Publish to cloud task. | ||
=== Restart the Suan.exe === | === Restart the Suan.exe === | ||
* Launch task scheduler | * Launch task scheduler | ||
− | * Select your scheduled task to launch acp at boot | + | * Select your scheduled task to launch acp at boot (probably in the Lumina tasks directory). |
* End all instances | * End all instances | ||
* Run the task | * Run the task |
Latest revision as of 07:56, 18 October 2024
Here's how to upgrade Analytica Cloud Platform running on a server to a new release.
If you are doing a complete new install of ACP on a server, you need to follow the instructions on this page.
Activate a new license for ACP
This section is not necessary if you are still have an active ACP license. You can skip to the next section.
- If you are just activating a new subscription license for ACP then you can skip the downloading and installing. But you need to ensure that the user running the ACP processes can use the new license. The easiest way will normally be to launch Analytica as that user in a command prompt.
If you don't have an internet connection
Acp licenses cannot be activated manually as the Desktop Analytica licenses can. If you do not have an internet connection, you will need to get a license file which has been signed from Lumina, and update with the license file from Analytica's Help > Update license dialog. Once you receive the updated license file, save it to the directory where your previous Analytica license was - usually C:\programData\Lumina\Licenses
Check the ACP user's license
- In a non admin command prompt cd to your Analytica install folder.
CD "C:\Program Files\Lumina\Analytica 6.4"
- Launch Desktop Analytica...
.\Analytica
Activate your new license - you can refer to this page License Information dialog
- In the Help menu, select Update license and enter the license - Activation key you received from Lumina into the license field and press Enter.
Now Activate this license for your user running ACP - substitute the user name on your server for ACPUser if necessary.
RunAs /user:ACPUser .\Analytica
- When prompted, enter the password for ACPUser
- When Analytica launches, accept the terms and select the license in Desktop Analytica's Help->Update License dialog.
- Test that it saves this info by exiting and restarting, again as ACPUser, and checking the Help-Update License dialog.
- Now restart and test the Suan.exe application - see the sections below
Install/upgrade to a newer build of ACP
Download and install the Analytica installer
If you are updating to build 149 from build 138, you will not need to update this installer release and you can skip to the next section
- Download the Analytica release appropriate for your new ACP release, currently https://downloads.analytica.com/ANA/AnaSetup6_4_8.exe.
- Install this Analytica release build. Install to the default folder. Use your existing ACP or ACP w/optimizer license.
- Now you need to ensure your database user can use the Analytica license - In a non admin CMD prompt:
CD "C:\Program Files\Lumina\Analytica 6.4"
RunAs /user:ACPUser .\Analytica
- When prompted, enter the password for ACPUser
- When Analytica launches, accept the terms and select the license in Desktop Analytica's Help->Update License dialog
- Test that it saves this info by exiting and restarting, again as ACPUser, and checking the Help-Update License dialog.
Download files to be updated and copy them to your ACP installation
- Download the relevant Zip Archive for the UI, and extract it to a folder on your computer.
If you are using Firebase Authentication: ACP_Build_149_FB.zip.
If you are using Apache Authentication: ACP_Build_149_AP.zip.
Save files to the Analytica folder
If you are updating to build 149 from build 138, you will not need to update these files and you can skip to the next section
- These files (from the archive extracted in the previous sections) need to be saved to
C:\Program Files\Lumina\Analytica 6.4
Overwrite the existing files with the same name.
- Analytica.ini
- suan.exe
- libssl-3.dll
- libssl-3-x64.dll
- libcrypto-3.dll
- libcrypto-3-x64
- SuanFirebaseAuth
Again, this next step is not necessary If you are updating to build 149 from build 138
Before proceeding with the next step, you will need to stop the current Suan.exe process in the task manager (if it is running), so that you can overwrite it with the new version.
- Save these files to
C:\Program Files\Lumina\Analytica 6.4
(When prompted click yes to replace existing files)
Save files to the UI folder
- The rest of the files from the extracted archive, in folders assets and build, need to saved to the ACP\ui folder
If you are updating to build 149 from build 138, you will not need to update the assets folder since it has not changed since 149. You will only need to update the Build folder.
- Save these folders to
D:\ACP\ui\
. Replace the existing folders.
.
- Assets
- Build
- If you did not save the previous Acp\Ui\assets\Db driver info.ana file, open the new one and enter the Database credentials before attempting to run ACP.
Test this part
- In the config files D:\Acp\ui\Assets Session.config and Server.config, in a text editor, temporarily set
DesktopUI=1
. Save the files. - In a non-admin CMD prompt:
CD "c:\program files\lumina\Analytica 6.4"
.\Suan.exe /config:d:\Acp\ui\assets\server.config
- Expected: An Analytica desktop instance should launch with an architecture drawing. It should stick around and not vanish.
- In Chrome: http://localhost:8080
- Expected: Login page should appear
- In the config files D:\Acp\ui\Assets Session.config and Server.config, in a text editor, temporarily set
- Once this test succeeds:
- Quit all Desktop Analytica instances
- Edit both Server.config and Session.config and set:
DesktopUI=0
Make any updates to the database
- Run: Analytica.exe "d:\Acp\ui\assets\Database alterations.ana"
- In the text input Updating from release number enter your release you are updating from eg.
0.113
For this next step, if you are updating to the ACP 3.0 release build from an earlier beta build, you should enter 0.45.
- In the text input Updating to release number enter your release you are updating to eg.
0.138
- Press the output node Required alterations
- Look at the result for number of alterations to be applied. If more than 0 press the button Apply Alterations. Once you get a message the the alterations have been applied, of If no alterations need to be applied just close the model.
Restart Apache
In an elevated command prompt: C:\Apache24\bin>httpd.exe -k restart
Update Scheduled tasks
If this update has involved installing a newer major or minor release of Analytica. For instance 6.3 - 6.4, you will need to update the scheduled tasks in task scheduler to point to the new Suan executables.
- So for instance you would change the scheduled tasks that start the Suan processes at boot to point to the new Suan.exe at C:\Program Files\Lumina\Analytica 6.4\Suan.exe
- Repeat for all 3 of the scheduled tasks for suan.exe pointing to Server.*.config tasks and the DTA Publish to cloud task.
Restart the Suan.exe
- Launch task scheduler
- Select your scheduled task to launch acp at boot (probably in the Lumina tasks directory).
- End all instances
- Run the task
Now you should have suan.exe running in task manager. If not there is something wrong with the configuration.
Test
Browse to your ACP instance and check to see that you can get to the user portal and log in.
Enable comment auto-refresher