Course Content - Intermediate 2.0
Updates and Upgrades
Welcome to the online training series from 3CX. This module will take you through the procedure to update, upgrade and re-install your 3CX PBX.
By the end of this module, we will have covered the correct housekeeping of a 3CX install, which includes the backing up of 3CX. We will see the various options available within the backups, as well as the scheduling options.
We will cover the differences between Host and User data, explaining what these two types of data are, and what is considered as host and user data.
I will also share with you some neat tips which will make your job administering 3CX a breeze.
We will see the procedure required to upgrade 3CX from a previous version. This includes taking a backup, performing the final housekeeping tasks and uninstalling the old version. The new version will then need to be installed.
The next task will be to perform any maintenance updates to the PBX. These can include template updates for IP Phones, gateways and providers. New firmware for IP Phones, prompt sets and CRM integration packages can also be updated from the Management Console.
Let's start with the backup file. The backup utility of 3CX will store all the necessary information of the PBX into a single ZIP file, making it very easy to use.
The backup file can be used in a variety of scenarios:
For instance, if you need to change the hardware of the server, you can take a backup of the PBX, and install the PBX on a new host machine, restoring the backup during the installation process. This will restore all your settings to the new machine, without any cumbersome reconfiguring of the PBX from scratch.
If you want to migrate from a Windows based 3CX to the new Linux based 3CX or vice versa, you can do so by taking a backup and restoring your configuration to the other Operating System.
Currently, we are on Version 15.5 of 3CX. To upgrade from an older version, you are required to take a backup and uninstall the existing version of the PBX. Then, you will need to download and install the new version of 3CX. Please remember to download your backup file to a safe location on the server, away from the default folder of 3CX, as this will be deleted in versions older than Version 15.5 Service Pack 2, when you uninstall the PBX. I would also recommend performing all Windows Updates on the machine, if you are using Windows as your Operating System, and reboot the server before installing the new version.
They say, prevention is better than cure, and this is especially true when it comes to the administration of any mission critical machine, especially a PBX. It is recommended to take a backup of your 3CX configuration before you perform any administration tasks on the PBX. It only takes from a few seconds, to a few minutes, depending on what you are backing up. This way, if anything goes wrong along the way, you can very easily recover without any hassle.
If you are implementing a Version 15.5 failover scenario, with a standby Version 15.5 server, the information is transferred from one PBX to another via the backup file. There is no active information transfer on the fly and the backup file will be used in this case to transfer the information from one PBX to the other, on a schedule.
The Backup and Restore functionality can be found within the 3CX Management Console, in the “Backup and Restore” page, on the left hand side menu.
A backup can be created at any time, on demand. You can create as many backups as you require, in order to assist with restoring a PBX back to its previous state, before a reconfiguration is made.
A backup can also be scheduled nightly to provide you with a recent backup on a regular basis. This way if anything ever happens to your PBX, you will be able to have a recent backup to recover from. It is always a good idea to enable this, just to be on the safe side.
To enhance the security of the backup file, password protection is available, which encrypts the contents of the file, preventing any prying eyes from snooping the files within the ZIP file. As always, when dealing with passwords, please keep them safe, as losing this will render your backup useless.
The backup file will always contain the main configuration of the PBX. Therefore whatever happens, you will at least have the configuration of the PBX. This includes the extension and extension group settings.
The SIP Trunk settings, as well as the respective inbound and outbound rules will also be included.
Any configuration of system extensions, for example, queues, ring groups and digital receptionists will also be backed up.
The PBX also provides you with some optional components which can be included in your backup.
For example, the License key information, FQDN and networking information can also be backed up or not.
The Call logs, chats and conferencing data will also be backed up if the relevant option is chosen. A large amount of Call history data, will cause the backup and restore procedure to slow down significantly.
Any system prompts, including custom system prompts as well as custom music on hold audio files will also be backed up.
Custom templates as well as IP Phone firmware files, can also be backed up. Have in mind that the firmware files can increase the size of the backup file drastically, as some of these are quite large files.
Another option which will affect the size of the backup is the Voicemails option. This will backup all the voicemail files in the system, and as these are audio files, depending on the size of the PBX, will increase the backup size substantially.
Call recordings will also increase the size of the backup file of the PBX.
This is where you will be able to create a password for the backup encryption, as well.
When you backup the PBX, the file will be saved, by default, in the 3CX Program Data folder. This location can be changed to another folder, for example the documents folder of the server.
You can also download the backup file to a safe location off the server, like an FTP driver or Google Drive, to avoid losing your information if your server hardware crashes, or is rendered unusable for any reason.
The recordings can also be placed onto a different path, for example a different hard drive on the server. Please note that only local disks are supported, as well as iSCSI and SAN drives. This is due to the recording location being required to always be available to the PBX. Network drives are not supported.
Compression is available to save on precious disk space, by allowing the admin to choose to save the recordings in ADPCM, or Adaptive PCM format. This realises a disk space saving of up to 75% over the normal PCM format.
So, every minute of recordings will take up to 256 kilobytes of disk space, rather than 1 megabyte with PCM. However, you will not be able to play the adaptive PCM format recordings in all media players, especially on mobile devices and browsers. You will need to have either a Media Player, like Windows Media Player of VLC.
To enable backup scheduling, click the “Backup Schedule” button while in the “Backup and Restore” section. Then, enable the scheduled backup.
Choose your backup options, just like you would for an on demand backup. They are identical.
Set the occurrence timer. Choose whether to perform a scheduled backup daily, or weekly and choose the desired time to perform the backup. It is best to choose a time when the PBX is not being in use. If the PBX is a busy PBX, choose a time when the PBX is not too busy.
Configure a retention policy, or as it is called in the management console, the backup rotation. This will allow you to keep a certain amount of previous backup files. If for example you choose daily and a backup retention of 25, you will have the backups from the last 25 days available in your list of backups.
Not all the data, however, is backed up by 3CX. There is some data, the “Host Data” which will always be configured on the host and will not be restored from a backup.
The SIP and Tunnel ports are examples of such data and will never be carried over from one 3CX to another. This is to allow the transition from either a multi instance, or Virtual PBX as it was previously called, or from another 3CX which may be using different SIP and Tunnel ports.
As already mentioned, the following backed up information will be restored. This is called user data.
- Extensions and System Extensions.
- VoIP Provider and Gateways.
- Audio prompts and files.
- The License key, FQDN and SSL certificate.
The procedure to perform a Major Version upgrade, for example going from Version 14 to Version 15.5 is the following:
Before starting the upgrade procedure, I would recommend that the 3CX Server, is updated with the necessary OS updates, if needed, before proceeding with the upgrade.
Take a backup of 3CX as was described previously.
Remember to copy the backup to a folder outside the default 3CX Program Data folder if you are backing up a PBX older than Version 15.5 Service Pack 2.
Uninstall the existing 3CX installation.
Download the latest version from the 3CX web site. The current version is version 15.5.
Install the new version and use the backup taken to restore the 3CX configuration, during the installation phase.
After the restoration has been done in Version 15.5, you will need to go and adjust the recordings quota, as by default, the recording quota will be defined as 5GB. The quota value for the recordings will NOT be carried over from previous versions.
To change the quota, go to the “Recordings” page in the Management Console, and press the “Quota” button.
The major version upgrade path of 3CX to Version 15.5 which is available, is from the following previous versions.
If you are upgrading from Version 12.5 you need to be on V12.5 Service Pack 2. You will need to perform an extra step to convert the call history, as the call history format of Version 12.5 is not compatible with version 15.5.
Coming from Version 14 you can perform the upgrade with no extra steps necessary. Coming from a Version 14 Service Pack 3 standalone or Multi Instance 3CX is possible with the same procedure. There is no difference between the two types.
If you are coming from an older version of 3CX, it is recommended to have a look at the Version 15.5 administration manual to see more information about upgrading from previous versions.
A Minor Version Upgrade is an upgrade within the same version, but a different Service Pack.
In Version 15.5 upgrading from one Service Pack to the next can now be done automatically, if this is chosen from within the Management Console.
In the 3CX Management Console, you can see the updates which are pending at the top, or by pressing the “Updates” button to go to the updates page.
There you will see the next Service Pack which is available for download. Selecting to download the service pack will download the update and automatically start the installation process.
Please note that the PBX services will be stopped at this time while the update is installing. Please avoid performing this update during office hours, or when the PBX is in use.
You will receive a notification via email when the update is complete, and you can login to the Management Console. The services will be started automatically, and the phones will start to function as soon as the update is complete.
While on the subject of updates, you will also see some other updates, which may be available and are user experience updates.
For example, here you can find the updates for the new 3CX clients, new supported IP Phone firmware, which will be downloaded automatically, new or updated IP Phone templates and SIP trunk templates.
This will ensure that the compatibility of the PBX with its peripherals is always at its highest. These updates, will NOT interrupt the PBX services and can be done at any time.
Prompt Set audio files and new CRM integration packages or updates to existing ones will be found at the respective nodes of 3CX and can be downloaded as and when required. These will not show up in the updates page, and will not show in the number of available updates in Red in the Dashboard.
Thank you, and goodbye!