Upgrade databases, ZyDesk, and Media Server
This information is primarily for administrators and/or people who manage Zylinc solutions


-
Start Deployment Manager. If needed, enter the address, port, user name, password, and database name for ZyDB, in ZyDB Configuration
-
In the Deployment Manager menu, select Database > ZyDB > Update
-
Compare Current Database Version to Update database to version.
-
If needed, click Update
If you see an error message
If you upgrade from a version older than 5.0, and you see an error message, you can execute the stored procedure ins_app_sup_info to solve the error:
-
In Microsoft SQL Server Management Studio, click New Query
-
Copy the following SQL code and paste it in to the new query:
Copyuse zydb
exec ins_app_sup_info -
Replace the second word zydb with the name of your ZyDB.
-
Click Execute Query, or press F5.
-
You can now repeat step 4 and continue.
-

-
In the Deployment Manager menu, select Database > ZyDB > Language.
-
You can view a list of languages that you currently have installed. In Export Language, expand the list of languages. Make a note of the installed languages.
-
In Import Language, select a language to upgrade.
-
Click Compare.
-
If you see a list of old values and new values, that language may need to be upgraded:
If no custom changes have been made to ZyDesk language tokens, select all rows in the list and click Upload.
If any custom changes have been made to ZyDesk language tokens, and you previously created a backup of the customized language identifiers, select all rows in the list, then clear the selection next to the customized identifiers, according to the screenshots you previously made, and click Upload.
-
If you see the text No new or modified language tokens found, that language already has the correct version
-
If you see the text Click on Upload button to upload the new language file, the selected language isn't currently installed, and doesn’t need upgrade.
-
-
Repeat steps 3 and 4 for all installed languages

You'll need to get a new license key from Zylinc support. You'll need that key now.
-
In the Deployment Manager menu, select Database > ZyDB > License
-
Click Get License
-
In the box, delete the old license key.
-
Copy the new license key into the box, and click Save License

We recommend that you keep your existing profiles (the profiles that you can see in the Deployment Manager menu, when you select Database > ZyDB > Profile)

-
In the Deployment Manager menu, select Database > StatDB
-
If needed, enter the address, port, user name, password, and database name for ZyStatDB, in Statistics Database Settings
- Click Save Configuration
-
Compare Current Database Version with Update database to version. If needed, click Update

- In the Deployment Manager menu, select Deployment > Installation
- Compare the available ZyDesk version with the version of the one already rolled out in the organization.

If you upgrade from a version older than 6.5u2, make sure .Net Framework on computers running ZyDesk, is updated to at least version 4.7.1.


The ZyDesk.ini file contains information about the SQL server host, port, user name, password, and ZyDB database name. ZyDesk clients require this file to work, and a copy of the file must be placed in C:\Program Files (x86)\Zylinc\ZyDesk\ZyDesk.ini
To create the ZyDesk.ini file:
-
In the Deployment Manager menu, select Database > ZyDB > ZyDesk
-
Make sure that Include tunnel server address is cleared
-
Click Generate encrypted file
-
Save the ZyDesk.ini file in C:\Zylinc install\Release_6.5u4.12\Release_6.5u4.12\4_ZyDesk
If you can't, or don't want to, use the ZyDesk.ini file, you can, alternatively, click Generate registry file, and then use a third-party tool to distribute that registry key to your clients.
If you can't place the ZyDesk.ini file in the C:\Program Files (x86)\Zylinc\ZyDesk folder, or if different users of a shared computer need different ZyDesk.ini files, you can, alternatively, place copies of the file in the following folders in the user profiles for each of the users: C:\Users\%username%\AppData\Roaming\Zylinc\Zydesk\Zydesk.ini. Tip: If you need to do this, the %appdata% environment variable is useful because it takes you directly to the Roaming folder.

Send two files to people who are going to install ZyDesk on Windows client computers.
Different people may manage the installation of clients, terminal servers, or Citrix servers. Remember to send the client software to all of them.
Find the following two files in C:\Zylinc install\Release_6.5u4.12\Release_6.5u4.12\4_ZyDesk, and send them to relevant people:
-
ZyDesk_AllUserInstaller.msi
-
ZyDesk.ini
You can zip the folder and send it in an e-mail.
Tell the receivers to make sure that .Net Framework on computers running ZyDesk, is updated to at least version 4.7.1.
Then tell the receivers to first install the client software with the .msi installer, and then copy the ZyDesk.ini file to C:\Program Files (x86)\Zylinc\ZyDesk\ZyDesk.ini
If you can't, or don't want to, use the ZyDesk.ini file, you can, alternatively, click Generate registry file, and then use a third-party tool to distribute that registry key to your clients.
If you can't place the ZyDesk.ini file in the C:\Program Files (x86)\Zylinc\ZyDesk folder, or if different users of a shared computer need different ZyDesk.ini files, you can, alternatively, place copies of the file in the following folders in the user profiles for each of the users: C:\Users\%username%\AppData\Roaming\Zylinc\Zydesk\Zydesk.ini. Tip: If you need to do this, the %appdata% environment variable is useful because it takes you directly to the Roaming folder.


-
In the Deployment Manager menu, select Deployment > Installation
-
In Installed Applications, select ZyDesk and click Uninstall Applications

-
Open the folder C:\Zylinc install\Release_6.5u4.12\Release_6.5u4.12\4_ZyDesk
-
Locate ZyDesk_AllUserInstaller.msi
-
Run the installer (it can be quick)
-
Copy ZyDesk.ini to C:\Program Files (x86)\Zylinc\ZyDesk\ZyDesk.ini


Verify Media Server image version:
-
Log in to Media Server console (AdminCLI) as admin.
-
Type the command v
-
Check that Deployed using Installer is version 7.25 or newer.
If the installer version is too old, you need to reinstall the Media Server. Skip the following and continue with If you upgrade from a version older than 6.5, reinstall Media Server

Specify the Media Server connection settings and Administration Portal location, because it allows Deployment Manager to connect to Media Server, and then view a list of deployed media server application versions. Via the list, you can also upgrade the software modules, and you can install Administration Portal.
-
In the Deployment Manager menu, select Deployment > Media Server
-
In Address, enter the hostname of Media Server, for example: MediaServer
-
In Port, enter 8080
-
In Media server connection settings > User, enter admin
-
In Media server connection settings > Password, enter the password for Tomcat instance user admin on Media Server
-
In Admin Portal connection settings > URL, enter: http://<MediaServer>:8080/zylinc-admin/
Example: http://MediaServer:8080/zylinc-admin/
-
In Admin Portal connection settings > User, enter admin
-
In Admin Portal connection settings > Password, enter the password for Tomcat instance user admin on Media Server
-
Click Save
-
Click Refresh

-
In the Deployment Manager menu, select Deployment > Media Server.
-
Click Refresh.
-
In Available Media Server Applications, check if some of the applications indicate new version in the Status column, and appear in blue color.
If so, use CTRL+click to select all the applications with status new version, and then click Deploy Applications.
If you see an error message that says Please run a rewrite config manually, you can safely ignore it, because you'll handle it later in the process.
-
Wait until all the applications have successfully been deployed.
-
Click Refresh, and if necessary repeat steps 3 and 4 until no applications indicate new version in the Status column, and appear in blue color.


-
Boot the virtual server for Media Server on the ISO image.
If you're in doubt about how to do this, search the internet for Boot virtual machine from iso or similar.
-
The ISO installer will run for approximately four minutes.
-
Wait until you see the message: Press <RETURN> to reboot (do not remove your removable medium yet)
-
Use the virtual server console to eject the installation media ISO image from the virtual DVD drive.
-
Press RETURN.
-
If you see the message switch login:
Log in with user name: admin
Password: admin -
In Please enter a value for “Tomcat admin password” (): Enter the password for Tomcat instance user admin on Media Server.
-
In Please enter a value for “confirm the new tomcat password” (): enter the same password again.
- Wait until you see the message: (network main) Enter option [h for help].
Type 0, for eth0.
Type m, to set DHCP/Static mode to STATIC.
Type ip, and enter the IP4 address that you plan to use.
Type mask, and enter the subnet mask that you plan to use.
Type gw, and enter the IP4 address of the default gateway that you plan to use.
Type da, and enter the IP4 address of DNS server 1 that you plan to use.
Type da, and enter the IP4 address of DNS server 2, or skip this step if you only use one DNS server.
Type b, to return to previous menu.
Type a, to save and apply all changes
Type 0, for eth0
Type t, to toggle state from down to up
Type b, to return to previous menu.
Type a, to save and apply all changes.
Verify that eth0 is shown in green, and that is displays a MAC address and an IP4 address. If that's not the case, go through network configuration again.
Type q, to quit the (network main) Enter option [h for help] menu.
-
Enter the hostname that you plan to use.
Example of a hostname: MediaServer
We use hostnames to refer to servers, but you can also use IP4 addresses, if your network requires it.
-
Type n, to keep the selected time zone, or type y and specify another time zone.
-
Wait until you see -- (action) --> under NTP configuration: Select Action menu.
-
Type a, to save and apply all changes, and use the default time servers.
-
In Enter new UNIX password: Enter the password for Unix user admin for AdminCLI.
-
In Retype new UNIX password, enter the same password again.
- Wait until you see a menu: select(1-4):
If you use a physical server, enter 1
If you use a VMWare host, enter 2
If you use a Hyper-V host, enter 3
If you don’t use any of the above, enter 4
-
In Do you wish to disable IPv6 [y/*], type y, to disable IPv6.
-
In Choice: type 2 for ZyCall Switch Backend.
-
Wait approximately six minutes until you see a message that says:
Finished Setup.
Enter any key to continue. -
Press ENTER, to reboot Media Server.
-
Wait until you can see a text-based login prompt in the console window.

Specify the Media Server connection settings and Administration Portal location, because it allows Deployment Manager to connect to Media Server, and then view a list of deployed media server application versions. Via the list, you can also upgrade the software modules, and you can install Administration Portal.
-
In the Deployment Manager menu, select Deployment > Media Server
-
In Address, enter the hostname of Media Server, for example: MediaServer
-
In Port, enter 8080
-
In Media server connection settings > User, enter admin
-
In Media server connection settings > Password, enter the password for Tomcat instance user admin on Media Server
-
In Admin Portal connection settings > URL, enter: http://<MediaServer>:8080/zylinc-admin/
Example: http://MediaServer:8080/zylinc-admin/
-
In Admin Portal connection settings > User, enter admin
-
In Admin Portal connection settings > Password, enter the password for Tomcat instance user admin on Media Server
-
Click Save
-
Click Refresh

-
In the Deployment Manager menu, select Deployment > Media Server.
-
Click Refresh.
-
In Available Media Server Applications, check if some of the applications indicate new version in the Status column, and appear in blue color.
If so, use CTRL+click to select all the applications with status new version, and then click Deploy Applications.
If you see an error message that says Please run a rewrite config manually, you can safely ignore it, because you'll handle it later in the process.
-
Wait until all the applications have successfully been deployed.
-
Click Refresh, and if necessary repeat steps 3 and 4 until no applications indicate new version in the Status column, and appear in blue color.

-
In the Deployment Manager menu, select Deployment > Media Server
-
Click Refresh
-
In Available Media Server Application, select ZylincAdminPortal
-
Click Deploy Applications

-
In a browser, go to the Administration Portal URL that you entered in a previous step (the setting was called Admin Portal connection settings)
Example: URL: http://MediaServer:8080/zylinc-admin/
-
Click Admin
-
Log in with the user name and password you also entered in a previous step.
Username: admin
Password: Enter the password for Tomcat instance user admin on Media Server
-
Next to Host, click
If you can see a help message, your browser supports scripting, and you can continue.
If you can't see a help message, you'll need to add your Media server and Zylinc Windows application server to trusted sites in Internet Explorer, or use an alternative browser. For more information, see Set up Internet Explorer on Windows Application Server.
-
In Host, enter the hostname for the SQL server that hosts ZyDB, for example, WinAppServer
-
In Port, enter 1433
-
In Instance, leave the field blank
-
In Username, enter ZyUser
For security reasons, don’t use the sa account (user name: sa).
-
In Password, enter the password for MSSQL user ZyUser
-
In DB Name, enter ZyDB
-
Click Save
-
Click Apply
-
Click Test.
-
You should see this message: Connection successfully established to Singletenant Database: <WinAppServer> / zydb
You should also see the ZyDB Database Version. The version should not be 0.0.0.0
You're going to use Administration Portal again later, so make a note of the procedure in step 1.
Security and patching of Zylinc Media Server: The Media Server is (and always has been) an appliance/black box intended to be run on a customer's internal LAN, that is protected from the outside world by the customer's own security protocols. This black box principle is in place to ensure optimal support for the Media Server functions that this appliance delivers. To continuously update said appliance with all sorts of updates and patches would primarily be an academic exercise with (in the majority of cases) little practical impact, and it could potentially compromise the quality of support rendered.

-
In the Administration Portal menu, select INSTALL > Database Connection
-
Click Maintain, and answer OK
-
In the Administration Portal menu, select INSTALL > Portal Configuration
-
Use the screenshot you previously created, to set up the same configuration as in the screenshot
-
Make sure you also select the following features, even if they're not a part of the screenshot:
-
Wallboard
-
Voice Queues
-
Absence Templates
-
Client
-
ID Lookup
-
Switch Logs
-
Media Server
Use your browser's search in page feature to quickly locate the relevant check boxes.
-
- Click Save

-
In the Administration Portal menu, select INSTALL > Database Connection
-
Click Rewrite Config, and answer OK

- In the Deployment Manager menu, select Deployment > Installation
- In Installers, Select ZyGo and click Install Applications
- In the Deployment Manager menu, select Deployment > Windows Services
- Start the new, updated version of Windows Service ZyGo

-
In the Administration Portal menu, select INSTALL > Database Connection
-
Click Restore Audio
-
If you use ad hoc announcements: In the Administration Portal menu, select AUDIO > Ad Hoc Announcements, and check that you can see the announcements
- If you use custom announcements: In the Administration Portal menu, select AUDIO > Custom Announcements, and check that you can see the announcements
- If you can't see the announcements, use this alternative procedure to restore audio.
In the Administration Portal menu, select INSTALL > Database Connection
In Audio Backup/Restore to File, click Browse
- Select AudioBackup_CID.tgz from your backup folder and click OK
- Click Import Audio and click OK
This is help for Zylinc version 6.5. To view Zylinc unified help for other versions, go here.
© 2021 Zylinc A/S • Disclaimer
Zylinc unified help is a UK Technical Communication Awards winner
Help version: 24 February 2021 14:16:14
Share this topic: