Upgrade Cayosoft Administrator from earlier version

Content: 

Frequent Questions

Q: Should I uninstall the previous version before installing the new version?

A: No, upgrade of Cayosoft Administrator is always an in-place upgrade. The setup program performs all necessary file changes needed to upgrade to the version being installed.

Q: Will Execution and Change History be preserved during upgrade?

A: Yes, both Execution history and Change History are preserved during upgrades.

Q: How much time is required for the typical upgrade?

A: The typical upgrade takes between 30 minutes to complete. Cayosoft recommends testing the solution to ensure that customization and settings specific to your environment are in-place and functioning as expected after the upgrade.

Q: What should I do If I want to install a new version to a different hardware?

A: If you want to install a new version to a different hardware, you can move DB, see details in Db and Maintenance article.

Performing a version upgrade after a full backup

1. Download the latest version from Cayosoft.com/download/

2. Ensure other users are not connected to either the Configuration & Automation or the Administrative Web Portal

   Note 1: you can verify the system is not performing tasks when the status light at the right end of the console toolbar is blue

3. If open, close both the Configuration & Automation or the Administrative Web Portal on the server where the upgrade is taking place

4. Using the Services Console, stop the Cayo Software Admin Service

5. Navigate to the C:\Program Files\Cayo Software\AdminAssistant folder on the local drive

6. Select all files that end with .db, right click the selected files and and choose Send to > Compressed (Zipped) folder

   Note 2: you may be prompted to send the compressed folder to the desktop – this is expected behavior
7. Double click the file downloaded in step 1 - the installation menu will appearLocate the setup link for Cayosoft Administrator then click the link - the installation wizard will appearOn the Welcome step of the wizard, click Next

8. Accept the license agreement and click Next

9. Enter a Full Name and your Organization’s name, then click Next

10. Click Run service as

11. Enter the name of the service account using the DOMAN\name format

    For example, if the service account in the ABC domain was named srvCAdmin you would enter the name like ABC\srvCAdmin

12. Enter the service account password then click the Test Credentials

    If the credentials fail, double check the name and password

13. Click Next

14. Click Install

15. Leave the Configure Cayosoft Administrator Web Portal option checked and click Finish

16. Allow the Microsoft Disem.exe tool to check system requirements

17. On the Cayosoft Administrator Web Portal Registration Tool dialog box click Update

    Note 3: if the web portal was not previously installed, a button labeled Install will be shown in place of the Update button

18. Verify that each operation resulted in a Success message being displayed

19. Click Close

20. Reboot the server and wait 5 minutes for all services to start

Performing a version upgrade with config backup only

1. Download the latest version from Cayosoft.com/download/

2. Ensure other users are not connected to either the Configuration & Automation or the Administrative Web Portal

   Note 2: you can verify the system is not performing tasks when the status light at the right end of the console toolbar is blue

3. Double click the file downloaded in step 1 - the installation menu will appear

4. Locate the setup link for Cayosoft Administrator then click the link - the installation wizard will appear

5. On the Welcome step of the wizard, click Next

6. Accept the license agreement and click Next

7. Enter a Full Name and your Organization’s name, then click Next

8. Click Run service as

9. Enter the name of the service account using the DOMAN\name format

   For example, if the service account in the ABC domain was named srvCAdmin you would enter the name like ABC\srvCAdmin

10. Enter the service account password then click the Test Credentials

    If the credentials fail, double check the name and password

11. Click Next

12. Click Install

13. Leave the Configure Cayosoft Administrator Web Portal option checked and click Finish

14. Allow the Microsoft Disem.exe tool to check system requirements

15. On the Cayosoft Administrator Web Portal Registration Tool dialog box click Update

    Note 3: if the web portal was not previously installed, a button labeled Install will be shown in place of the Update button

16. Verify that each operation resulted in a Success message being displayed

17. Click Close

18. Reboot the server and wait 5 minutes for all services to start

Performing upgrade when the replication group is configured

When replication is configured and upgrade is required, you should stop the replication temporarily and upgrade publisher and each subscriber separately.

1. To stop the replication:

   1. On each subscriber navigate to Home -> Rules -> Built-in Rules (Pre-configured)>Replication

   2. Browse for Enforce/Schedule section

   3. Uncheck Enable

2. At first, upgrade publisher service and then upgrade subscribers. For the upgrade, use one of the procedures described above. Both publisher and subscribers should have the same Cayosoft Administrator Service version after the upgrade for correct work.

3. Run Change History | Import From DB File rule on the publisher.

4. Enable the replication again: 

   1. On each subscriber navigate to Home -> Rules -> Built-in Rules (Pre-configured)>Replication

   2. Browse for Enforce/Schedule section

   3. Check Enable and configure the schedule

How to rollback the version if the upgrade didn't go well

If the upgrade of Cayosoft Administrator didn't go well for some reason, you can rollback to the previous version. For this, you should uninstall the latest version, then restore the database from the backup and install the previous version.

1. Open the Windows Control Panel and click Uninstall a program

2. Click the currently installed Cayosoft Administrator Console and then click Uninstall

3. Navigate to the C:\ProgramData\Cayo Software\AdminAssistant\Backups folder on the local drive

4. Select the backup created during running the upgrade 

5. Extract this backup to C:\Program Files\Cayo Software\AdminAssistant folder on the local drive

6. Install the previous version, using one of the ways described above.

Upgrading Web Portal Home Page Branding (Banner)

Your custom banner will be saved on the Cayosoft Web Portal home page after the upgrade if the native Cayosoft Administrator banner is not changed in the latest version, on which you are going to upgrade.

If the native Cayosoft Administrator banner is changed in the latest version, your custom banner will be replaced with it and you need to change it again.

For more information about changing the banner, please see Cayosoft Administrator Web Portal Home Page (Branding) article.

Upgrading rules

After the upgrade of the Cayosoft Administrator, you may need to upgrade the rules that were modified in the new product version. 

1. Run Cayosoft Administrator console

2. Check the Home page whether you have Rules to be upgraded message

3. Click this message - you will get to Rules to be upgraded page

   
   
   
   

4. Open each rule from the list of rules to be upgraded 

5. Click Upgrade Rule
   
   
   
   

How to keep changes in the rules on upgrade

There are situations when you need to keep changes in the rules after the upgrade. For example, when you got some script from the Cayosoft Support that added some logic to the rule to satisfy your scenario. To keep changes these changes you need to perform the following steps before the upgrade:

1. Navigate to the modified rule
2. Click Design Mode, for details please see How to enable Rule Design Mode in Cayosoft Administrator Console article
3. Check Keep manual changes on upgrade
4. Save changes

After that, when the Cayosoft Administrator is upgraded, all changes that were made in this rule will preserve, this rule won't get to the Rules to be upgraded list and you won't see Upgrade Rule link on it.