Update Available

Available system updates are displayed from the Chronicall System Status popup.
You also want to be sure to run a backup for your Chronicall Database just as a safety precaution.

Note: Before updating to Chronicall version 3.10 and above, please ensure that your server hosting Chronicall meets at least the necessary minimum specs for the following Chronicall modules (depending, of course, on the modules that you have purchased) Chronicall Base License, Recording Library, and Multimedia. To see if you have the appropriate server specs see this article.

Display Minor Updates

You can also configure the Chronicall System Status popup to display minor version updates via the following steps:

1. Navigate to Admin (System) > System Settings > Basic Settings.
2. Set the Notify for minor updates value to True.

3. Click Save to apply the change.

Download The Update File

Steps

1. From the Chronicall System Status popup click the Update Available link
   a. You can also visit the Chronicall Downloads page
2. Enter the Chronicall Serial Key.
   a. Found via Help > About Chronicall

3. Click Submit
4. Select the file named Chronicall Update.

🚧

Version Skipping

Do not skip major versions when updating. 

If you are on a 3.6 version, make sure you are updated to 3.6.56 before updating to 3.8.7.
If you are on a 3.8, make sure you are updated to 3.8.7 before updating to 3.12.
If you are on a 3.10 or 3.12 build, make sure you are updated to 3.12.5(by) before updating to 4.0+
You need to be on the 3.8.7 branch before updating to 3.12.5, and 3.12(by) by) before updating to 4.0+

❗️

Major Version Database Differences

You cannot easily roll back from any major version of Chronicall to the one before because the database information changes with each major release. You can only reinstall the previous version and use that previous version's database backup to restore data.

I.e., you cannot roll back from 4.0+ to 3.12, or 3.12 to 3.8 etc.

NOTE: The exception to the major version rule is 4.2.10 cannot roll back to 4.2.9 or earlier 4.2 builds as there was a database change that prevents that.

5. Select Save File, if prompted. 

📘

Important Note

The Chronicall update must be run on the server where Chronicall is installed.

App Installer

On version 3.95 and above, we have a separate app installer you will need to download and run after the first time you update to a post 3.95 build. This should also be on the downloads page next to the update and setup files. *This is applicable if you are a Recording Library or Multimedia customer, or if you would like to install a second Realtime Node on another server to assist the main Realtime Node on the main server.* This should only need to be done once, as future Chronicall updates will update all other Chronicall related services when the main server is updated. However, should an app not work after updating to a newer version due to bootstrapping issues, re-running the App Installer should restore functionality.

Run the Update

If running update on Linux see the "How to Run Apps Installer on Linux" article

❗️

Impact

Chronicall updates do not usually take more than 60 seconds to complete, but you may wish to perform them during low call volume hours in case they take longer.

During the update, your Chronicall system will be rebooted. Calls may not be properly logged or recorded during this time.

Windows

1. Save the update file to the Server running Chronicall
2. Verify you have turned off all Chronicall-related services, as specified in our guide, which can be found here: https://guide.ximasoftware.com/docs/stopping-and-starting-chronicall-services
3. Right-click the .exe file and select "Run as administrator"
4. Follow the prompts to perform the update.

🚧

Services Error

If you hit any errors, it is usually just waiting for the Chronicall service to shut down.  Wait a bit and hit retry, or manually stop the Chronicall services.

Linux - ZIP Files for versions 3.9.4 and below

1. Save the update .zip file to the Server running Chronicall
2. Verify you have turned off all Chronicall-related services, as specified in our guide, which can be found here: https://guide.ximasoftware.com/docs/stopping-and-starting-chronicall-services
3. Navigate to the update file location via command terminal.
4. Unzip the update file referencing the full file name.

unzip ipo_3_8_chronicall_update_3_8_6.zip

 
5. Navigate into the new directory using cd.

cd ipo_3_8_chronicall_update_3_8_6

6. Modify the update file to an executable.

❗️

Permission

Root sever permissions required

chmod +x update.sh

 7. Launch the executable update file

./update.sh

Linux - TAR files for versions 3.9.5 and above

TAR files for versions 3.9.5 and above

1. Save the update file to the Server running Chronicall
2. Verify you have turned off all Chronicall-related services, as specified in our guide, which can be found here: https://guide.ximasoftware.com/docs/stopping-and-starting-chronicall-services
3. Navigate to the update file location via command terminal.
4. Unzip the update file referencing the full file name.

tar -xzf Chronicall_Update_3_10_0_IP_Office_deb_64_bit.tar.gz

5. Navigate into the new directory using cd.

cd Chronicall_Update_3_10_0_IP_Office_deb_64_bit

6. Launch the executable update file.

./update.sh

Offline Updates

Chronicall can be updated in an offline environment, you simply need to get the Chronicall update file onto the server where Chronicall is installed and run it there. However, if you've purchased new licenses and need to renew your license file, follow the steps below.

How To Update Chronicall Offline

1. Send an email to Xima Support with your serial key and the reason for the offline update.
2. Xima Support will respond with a license file.
3. Download and transfer the Chronicall Update file and the license file onto your Chronicall server.
4. Copy the license file into the local Chronicall directory.
   a. Windows: C:\Program Files(x86)\Xima Software\Chronicall
   b. Linux: /var/lib/Xima\ Software/Chronicall
5. Run the update per the steps listed previously.