Anatomy of the Upgrade Process

Here at Click Studios we occasionally get asked “What happens behind the scenes during an In-Place Automated Upgrade?” and “What’s the difference between the In-Place Automated Upgrade with Internet Connectivity and without Internet Connectivity?”.

To answer the second question first, the only difference between an In-Place Automated Upgrade with Internet Connectivity and without Internet Connectivity, is that without Internet Connectivity you’ll manually need to download the passwordstate_upgrade.zip containing the latest source files and execute a SQL statement. When performing the In-Place Automated Upgrade with Internet Connectivity the upgrade automatically reaches out to the CDN (Content Delivery Network), downloads the latest passwordstate_upgrade.zip, and updates the Build and Version numbers.

It is highly recommended that users should, wherever possible, use the In-Place Automated Upgrade with Internet Connectivity and allow Passwordstate to handle the retrieval process and magic directly.

In-Place Upgrade with Internet Connectivity

The following process applies to an In-Place Automated Upgrade of Passwordstate with Internet Connectivity. On clicking Upgrade Now from the Administration->Backups and Upgrades;

  • You will be taken to the Passwordstate Upgrade Screen. This shows your Current Build and the Latest Build Available. It will also provide you with guidance on the steps required.
  • Place your Passwordstate Instance in ‘Maintenance Mode’ by clicking on the Enable Maintenance Mode button.
  • This will take you to the Maintenance Mode Screen showing any Active Users for your Passwordstate Instance, a time period in minutes where you can specify when to Terminate other users sessions for those users and the Enable Maintenance Mode Button.
  • On clicking the Enable Maintenance Mode button you will be taken back to the Passwordstate Upgrade Screen and can click on Begin Upgrade button.
  • You will now be presented with the Step 1 – Upgrade the Web Files Screen. To continue click on the Start Upgrade button.
  • The Passwordstate and Passwordstate-Gateway Windows Services will now be gracefully stopped.
  • Passwordstate’ s Web Files will be compressed, and along with your database, be backed-up. The backup is performed using the settings specified under Administration->Backups and Upgrades->Settings. Please note the account used for the backup must have Write
    Access to the Backup Path, Passwordstate Folder, appropriate permissions to be able to Stop and Start
    both Passwordstate Windows Services. Your SQL Server Windows Service must also be configured with an account that has Write Access to the Backup Path. When making any changes to the Backup Settings it is recommended you click the Test Permissions button at the bottom of the page.
  • The upgrade will now reach out to the CDN to download the latest passwordstate_upgrade.zip, which contains the Web source files and required SQL scripts, and place it in the Upgrades folder. This is located under \inetpub\Passwordstate on the drive you installed Passwordstate on.
  • New Web Files will now be extracted from passwordstate_upgrade.zip with the new versions overwriting all corresponding files located in \inetpub\Passwordstate. Critical files such as web.config, gateway.conf, Passwordstate.pfx (if using the Browser Based Gateway), along with your SecurID folder are not touched during this process.
  • You will now be logged out of Passwordstate.
  • On logging back into Passwordstate, using the same account you commenced the upgrade with, you will be presented with the Step 2 – Upgrade the Database Screen. To continue click on the Start Upgrade button.
  • The Upgrade will update your database to the latest version. This will include any schema and data changes along with writing the Passwordstate version number to the database.
  • Once the database upgrade is complete all temporary files used during the upgrade are deleted.
  • The Passwordstate and Passwordstate-Gateway Windows Services are now restarted.
  • Upgradelog.txt located in the \inetpub\Passwordstate\upgrades folder is retained as it contains information relating to the upgrade processes.
  • You are returned to the Administration->Passwordstate Administration Screen showing the latest Build number.

In-Place Upgrade without Internet Connectivity

The following process applies to an In-Place Automated Upgrade of Passwordstate without Internet Connectivity.

  • You’ll need to manually download the latest passwordstate_upgrade.zip from the CDN https://www.clickstudios.com.au/getupgradefile.aspx or from https://www.clickstudios.com.au/downloads/passwordstate_upgrade.zip. This contains the Web source files and required SQL scripts, and needs to be placed in the folder \inetpub\Passwordstate\Upgrades on the drive you installed Passwordstate on.
  • Using Microsoft’s SQL Server Management Studio, you will need to enter the latest build number as stated on Click Studio’s home page https://www.clickstudios.com.au/. To do this you’ll need to run the following statement within SQL Server Management Studio,

    USE Passwordstate

    UPDATE [SystemSettings]

    SET NewVersionNo = ‘8.9’, NewBuildNo = ‘8951’

    Ensuring the NewVersionNo uses the first 2 digits separated by a “.” and the NewBuildNo shows the full number from Click Studio’s home page

  • Login to Passwordstate and navigate to Administration->Backups and Upgrades, click on Upgrade Now and place your Passwordstate Instance in ‘Maintenance Mode by clicking on the Enable Maintenance Mode button.
  • This will take you to the Maintenance Mode Screen showing any Active Users for your Passwordstate Instance, a time period in minutes where you can specify when to Terminate other users sessions for those users and the Enable Maintenance Mode Button.
  • On clicking the Enable Maintenance Mode button you will be taken back to the Passwordstate Upgrade Screen and can click on Begin Upgrade button.
  • You will now be presented with the Step 1 – Upgrade the Web Files Screen. To continue click on the Start Upgrade button.
  • The Passwordstate and Passwordstate-Gateway Windows Services will now be gracefully stopped.
  • Passwordstate’ s Web Files will be compressed, and along with your database, be backed-up. The backup is performed using the settings specified under Administration->Backups and Upgrades->Settings. Please note the account used for the backup must have Write
    Access to the Backup Path, Passwordstate Folder, appropriate permissions to be able to Stop and Start
    both Passwordstate Windows Services. Your SQL Server Windows Service must also be configured with an account that has Write Access to the Backup Path. When making any changes to the Backup Settings it is recommended you click the Test Permissions button at the bottom of the page.
  • The upgrade will now use the latest source files you’ve placed \inetpub\Passwordstate\Upgrades. The new Web Files will be extracted from passwordstate_upgrade.zip and the new versions will overwrite all corresponding files located in \inetpub\Passwordstate. Again, all critical files such as web.config, gateway.conf, Passwordstate.pfx (if using the Browser Based Gateway), along with your SecurID folder are not touched during this process.
  • You will now be logged out of Passwordstate.
  • On logging back into Passwordstate, using the same account you commenced the upgrade with, you will be presented with the Step 2 – Upgrade the Database Screen. To continue click on the Start Upgrade button.
  • The Upgrade will then update your database to the latest version, including any schema and data changes. Note you have already written the Version number to the database.
  • Once the database upgrade is complete all temporary files used during the upgrade are deleted.
  • The Passwordstate and Passwordstate-Gateway Windows Services are now restarted.
  • Upgradelog.txt located in the \inetpub\Passwordstate\Upgrades folder is retained as it contains information relating to the upgrade processes.
  • You are returned to the Administration->Passwordstate Administration Screen.

We’ve deliberately repeated the level of detail above even though it is quite similar. There’s nothing worse than trying to hunt down information when you need it in a hurry.

We hope the detail above helps you in understanding what is occurring during the upgrade process. As always, we welcome your feedback via support@clickstudios.com.au.

Speak Your Mind

*