Upgrade Guide

Izenda provides monthly maintenance releases with bug fixes and performance increases. At least 2 point releases should be expected each year but our goal is to release quarterly (4) point releases annually.

Upgrade Preparations

  • Determine Your Current Version: There are several ways to check your Izenda version. After the upgrade process is complete, be sure that each of your Izenda components are the same version.

    • In the Izenda platform, navigate to the “Settings” panel. The “License Information” section will contain the current Izenda version.

    • In your Izenda Configuration Database, query for the ‘Version’ field in the IzendaDBVersion Table. This will let you identify your database version.

    • In Windows Explorer, navigate to your API’s bin directory (in stand alone versions of the API, this will be located at /API/bin/). Locate a dll prefixed with “Izenda.” Right click > properties > details. This will provide you with the current API version of Izenda.

      Note

      If you are using a custom dll in your application, you will need to verify the dll is the same version as your host application. In other words, when you upgrade your version of Izenda, you will need to verify that you rebuild your dll using that same version.

  • Permissions and Tools

    • Database client GUI to connect to Izenda System Database.

      e.g. Management Studio for MS SQL Server.

    • Izenda System Database administrator account.

      e.g. a user with db_owner and db_backupoperator roles in SQL Server.

    • Izenda Web Server administrator account.

      This account needs remote desktop and IIS service permissions.

    • Maintenance notice during the upgrade process.

Retrieving Database Upgrade Scripts

The Schema Migration Assistant

If you are upgrading your environment to two or more versions newer than your current version, it is recommended that you utilize the Schema Migration Assistant to compile and download all necessary scripts for your upgrade. This tool allows you to specify your Current Version, Target Version, and Database Type. If the “Download as sql script” is checked, your compiled script will automatically be downloaded. If this option is unchecked, your compiled script will be displayed in your browser.

../_images/schema_migration_assistant.png

System Backup

Izenda System Database Backup

Note

Izenda recommends that you back up your data before upgrading to a newer version.

This is a step-by-step guide for SQL Server using Management Studio GUI.
  1. ../_images/IzendaTest_Backup.png

    Fig. 28 Backup Menu

    Log in to the server with Izenda System Database using an administrator account.

  2. Right-click the Izenda database then Tasks > Back Up…

  3. ../_images/IzendaTest_Backup_Pop-up.png

    Fig. 29 Backup

    In the pop-up, choose Backup type Full and Backup component Database.

    (Full backup option since Izenda System Database stays at a relatively small size)

  4. Give any name for the backup set.

  5. Choose to back up to Disk and click Add.

  6. ../_images/IzendaTest_Backup_Filename.png

    Fig. 30 Backup Filename

    Select File name and click … button to select a path and file name.

  7. ../_images/IzendaTest_Backup_Success.png

    Fig. 31 Backup Success

    Click OK 3 times to run the backup.

Izenda Web Backup

Remote desktop to the Web Server to perform this step.

  1. Open the Izenda deployment folder in IIS.

    A typical location is at C:\inetpub\wwwroot\Izenda…

  2. Back up Izenda Front-end and Back-end files.

    Copy the current API and App folders to a safe location.

  3. Back up configuration files to avoid being overwritten.

    Copy the following configuration files to a temporary location.

    • API\izendadb.config
    • API\Web.config if there are custom configurations

Izenda System Database Upgrade

This is a step-by-step guide for SQL Server using Management Studio GUI.

Identify the Current Izenda System Database Version

  1. Right-click the Izenda database then New Query.
  2. Run the query select Version from IzendaDBVersion.
  3. The result is the current database version.

Upgrade Izenda System Database Gradually to Latest Version

  1. Open the Izenda System Database upgrade script folder.

  2. In SQL Server Management Studio, open the script in the folder that upgrades the current version to the next.

    e.g. if current version is 0.22.4, then open the script “IzendaDBSchema.sql” in “0.22.4-0.22.5” folder.

  3. Check that the target database is correct.

  4. Run the script to upgrade database to next version.

  5. Continue to run the scripts for each next version.

    e.g. if current version is “0.22.5” and latest version is “0.22.8”, then run the scripts in folders “0.22.5-0.22.6”, “0.22.6-0.22.7” and “0.22.7-0.22.8” in that order.

  6. After all the scripts, re-run the query select Version from IzendaDBVersion to verify the version.

Izenda Web Upgrade

The following steps outline how to upgrade your front end and back end via a remote desktop connection to the Web Server.

Replace Current Front End and Back End Packages

  Please note, the configuration files should be backed up using the Izenda Web Backup section since they will be overwritten in this step.

  1. Download the Izenda Front-end and Back-end Packages to Web Server. Ensure that the version you are downloading matches your updated database version set in the section above.
    • For a Stand Alone version of Izenda, you will need to download the API and the StandaloneUI packages from the Customer Portal.
    • For Integrated versions of Izenda, you will need to download the API and the EmbeddedUI packages from the Customer Portal.
  2. Stop the web site process to avoid Izenda DLL files being used.
  3. Remove all files in your current API and App directories.
  4. Copy the files from the downloaded API and App folders to the current API and App directories, respectively.
    • For Integrated versions of Izenda, you will need to update your web application with these resources and publish it according to your company standards.

Restore the Current Configuration

  1. Back-end: copy the configuration files from temporary location in Izenda Web Backup step to overwrite default ones in API folder.
    • izendadb.config
    • Web.config if it has been backed up.
  2. Front-end: in App\izenda_config.js, update the value of WebApiUrl to the current address of back-end APIs (e.g. http://localhost:8888/api/).

Restart the Web Server

Restore Steps in case of Error

  1. Restore the database using the back up file in Izenda System Database Backup step.
  2. Empty the API and App folders then copy back the contents from the location in Izenda Web Backup step.