TABLE OF CONTENTS
- Overview
- Step-1: Database Upgrade
- Step-2: Upgrade VIDIZMO Web Application
- Step-3: License Activation (optional)
Overview
This document outlines steps for upgrading your VIDIZMO application to the latest version. VIDIZMO has two main components, a web application, and the databases. To upgrade your VIDIZMO application, you need to update the web application and execute database transformation scripts to transform the databases to the new version.
Step-1: Database Upgrade
VIDIZMO application has two databases, a main application database and a notifications system database. The process of database upgrade is done by running database transformation scripts on both VIDIZMO databases. We recommend you execute the upgrade scripts on the server that hosts your VIDIZMO databases (SQL server). See below requirements for executing the database transformation scripts:
- Powershell 4.0 or greater
- SQLCMD
- SQL user account with dbowner permissions on VIDIZMO databases
Database Upgrade Scripts
The upgrade scripts are executed in the following order:
- VidizmoDBScripts.zip
- NotificationDBScripts.zip
- DeploymentScripts.zip
Note: The database transformation scripts are provided to you in form of compressed (zipped) files.
Note: In this example, we extract all upgrade scripts in “C:\Scripts\”.
Note: You would need a SQL user account for use with the database transformation scripts. The SQL user account must have DB_OWNER permissions on VIDIZMO databases for a successful upgrade.
Note: Change SQL compatibility version on VIDIZMO databases to 150 for SQL 2019 which is the minimum required version.
Order of Script Executions
Below is the folder structure (under C:\Scripts in this example) and the sequence of executing the database transformation scripts to upgrade your VIDIZMO databases. You would need to execute upgrade scripts in the following order:
Note: You may use PowerShell ISE to execute PowerShell scripts.
1. Folder name: VidizmoDBScripts
- File name:BackupRestoreTransformDB.ps1
2. Folder name: NotificationDBScripts
- File name:BackupRestoreTransformDB.ps1
3. Folder name: DeploymentScripts
- File name: Import-ApplicationConfiguration.ps1
- File name: Import-ContentFormat.ps1
- File name: ImportDefaultPatterns.ps1
- File name: InsertDefaultTemplates.ps1
- File name: Import-Permissions.ps1
VIDIZMO Application Database
Execute the BackupRestoreTransformDB.ps1 for upgrading VIDIZMO application database (VidizmoDB) and enter required parameters.
- Folder name: VidizmoDBScripts
- File name:BackupRestoreTransformDB.ps1
Example:
- [System.String] $ServerName = 'Vidizmo',
- [System.String] $VidizmoDBName = 'VidizmoDB',
- [System.String] $VidizmoDBNewName = 'VidizmoDB',
- [System.String] $UserName = 'vadmin',
- [System.String] $UserPassword = '123456789',
- [System.String] $ResultFileName,
- [System.String] $BackupFolderLocation,
- [System.String] $BackupFileName,
- [System.String] $OldApplicationDomain,
- [System.String] $ApplicationDomain,
- [System.String] $VIDIZMODatabasesPath = "F:\data"
VIDIZMO Notification Database
Execute the BackupRestoreTransformDB.ps1 for upgrading VIDIZMO notification database (VidizmoNotificationSystem) and enter required parameters.
- Folder name: NotificationDBScripts
- File name: BackupRestoreTransformDB.ps1
Example:
- [System.String] $ServerName = 'Vidizmo',
- [System.String] $NotificationDBName = 'VidizmoNotificationSystem',
- [System.String] $NotificationDBNewName = 'VidizmoNotificationSystem',
- [System.String] $VidizmoDBName = 'VidizmoDB',
- [System.String] $UserName = 'vadmin',
- [System.String] $UserPassword = '123456789',
- [System.String] $ResultFileName,
- [System.String] $BackupFolderLocation,
- [System.String] $BackupFileName,
- [System.String] $VIDIZMODatabasesPath = 'F:\data'
Database – Post Upgrade Deployment Scripts
Here, you would need to update required parameters and run the script. Please see below:
Update Application Configuration:
- Folder name: DeploymentScripts
- File name: Import-ApplicationConfiguration.ps1
Parameters:
- [String] $applicationConfigurationFilePath = "C:\Scripts\DeploymentScripts\ApplicationConfiguration.csv",
- [String] $sqlserver = “<SQL Server hostname or IP Address>”,
- [String] $database = "<Main application database name>",
- [String] $user = "SQL user name",
- [String] $password = ‘SQL password’
Update Content Formats:
- Folder name: DeploymentScripts
- File name: Import-ContentFormat.ps1
Parameters:
- [String] $contentFormat = "C:\Scripts\DeploymentScripts\ContentFormats.csv",
- [String] $sqlserver = “<SQL Server hostname or IP Address>”,
- [String] $database = "<Main application database name>",
- [String] $user = "SQL user name",
- [String] $password = ‘SQL password’
Import Default Patterns:
- Folder name: DeploymentScripts
- File name: ImportDefaultPatterns.ps1
Parameters:
- [String] $patternsPath = "C:\Scripts\DeploymentScripts\DefaultPatterns.csv",
- [String] $sqlserver = “<SQL Server hostname or IP Address>”,
- [String] $database = "<Main application database name>",
- [String] $user = "SQL user name",
- [String] $password = ‘SQL password’
Insert Default Templates:
- Folder name: DeploymentScripts
- File name: InsertDefaultTemplates.ps1
Parameters:
- [String] $templatePath = "C:\Scripts\DeploymentScripts\Template\",
- [String] $sqlserver = “<SQL Server hostname or IP Address>”,
- [String] $database = "<Main application database name>",
- [String] $user = "SQL user name",
- [String] $password = ‘SQL password’
Update product permissions:
- Folder name: DeploymentScripts
- File name: Import-Permissions.ps1
Parameters:
- [String] $permissionsPath = "C:\Scripts\DeploymentScripts\Permissions",
- [String] $sqlserver = “<SQL Server hostname or IP Address>”,
- [String] $database = "<Main application database name>",
- [String] $user = "SQL user name",
- [String] $password = ‘SQL password’
Note: We strongly recommend that you backup your VIDIZMO databases prior to implementing database transformation changes.
Conclusion - Database Upgrade
All scripts should execute with valid information and by following the correct execution sequence to successfully complete VIDIZMO database upgrade.
Step-2: Upgrade Web Application and Encoder Server
To upgrade application and encoder systems, you would need to replace the existing VIDIZMO directory with the updated one provided by VIDIZMO support team. In this example, we are using two VIDIZMO servers and we will use "C:\VIDIZMO" to locate the application files on the web application server and the encoder server.
Note: VIDIZMO support team shall provide the deployment package for the application upgrade.
Upgrade package for web app and encoder servers
You will receive the upgrade package in form of “VIDIZMO.zip” compressed file. You would need to extract “VIDIZMO.zip” in order to proceed further.
Note: Make sure to Unblock the downloaded zip file before you extract it. Right click the downloaded zip file, click properties from drop down menu to open properties, and check the box that says “Unblock”. Click Apply and Ok to confirm changes and close the properties dialog box.
Application Server Upgrade Procedure
Below is the step-by-step process of upgrading your VIDIZMO web application server:
- Download and extract the application upgrade package on your VIDIZMO web application server.
- Stop all VIDIZMO services (Windows services).
- Stop IIS service (W3SVC).
- Rename the existing VIDIZMO directory e.g. “C:\VIDIZMO.old\”.
- Copy the new VIDIZMO directory in C drive e.g. “C:\VIDIZMO\".
- Start all VIDIZMO Services.
- Start IIS service (W3SVC).
Encoder Server Upgrade Procedure
Below is the step-by-step process of upgrading your VIDIZMO encoder server:
- Download and extract the application upgrade package on your VIDIZMO encoder server.
- Stop all VIDIZMO services (Windows services).
- Rename the existing VIDIZMO directory e.g. “C:\VIDIZMO.old\”.
- Copy the new VIDIZMO directory in C drive e.g. “C:\VIDIZMO\".
- Start all VIDIZMO Services.
Step-3: License Activation
In this section, we explain the process of license activation for both Application and Encoder server systems:
Follow below steps to complete license activation on both web application and encoder server systems:
Note: You should follow below steps in sequence (in step-by-step order).
- Open your license activation URL. Your license activation URL is:
- https://<Your VIDIZMO URL>/static/views/activate-license.html
- VIDIZMO team shall provide the License Keys needed to activate the web application and content processing systems.
- Activate your product package by entering the License Keys or uploading the License files provided to you by the VIDIZMO team.
- Add new license and activate it for Content Processing Server.
- Add new license and click "Activate" to activate it for web application server.
Note: Once you have activated the new licenses, you should remove the previous licenses from dbo.ServerLicense table in VidizmoDB database. You may review/screenshot the data in dbo.ServerLicense table before activating new licenses that should help remove the previous licenses later after activating the new licenses.
- You will follow the same process for adding another license that can be used to activate the encoder server.
- Once the license activation is completed, open your portal website, and login with your admin user account.
In case of issues or concerns, please contact support@vidizmo.com and our support team will get back to you.
--End of document--