Pre-Upgrade

July 21, 2025

Even if you had prior upgrade experience with our product, you should thoroughly read through this revised document for any new information or procedures, before attempting the upgrade.

  • If you are new to the product line, refresh your knowledge about the installation from the Installation section.

  • You should review the following to ensure compatibility with your environment:

  • Your server should already be running AhsayCBS v7.17.2.2+ or AhsayCBS v8.x.

    If you are running AhsayOBSR v6.29 or lower, please refer to the AhsayOBS to AhsayCBS section.

  • Your server should be in good health. If you are experiencing issues and have not yet consulted with Ahsay Technical Support, it would be advisable to have your issue resolved prior to upgrade. In the event that your issue has been fixed in a newer release, our Support Team will recommend for you to continue with the upgrade.
  • You should read through the Administration section as new enhancements and new features are detailed there.
  • Hire our Ahsay Professional Services to enjoy a smooth and effortless upgrade experience. Visit the Ahsay Services page to learn more about our offered services.
  • Prior to upgrading, we recommend to temporarily disable any Antivirus, scanning checks, or system updates. This will ensure no conflicts that could cause the upgrade to fail. If it has been a while since your Host OS was rebooted, you may want to reboot the OS and check that AhsayCBS successfully started up (and login) before upgrading AhsayCBS to narrow post-upgrade troubleshooting.
  • If you are upgrading your CBS pre-v9, to v10.x for the first time, your user’s backup data destination may require up to twice free storage to convert to Deduplication optimized Blocks.

Pre-Upgrade Tasks

Before you start the upgrade of your current AhsayCBS server to the latest AhsayCBS v10 release version, please make sure you have the following four (4) items prepared:

  1. A set of the latest configuration backed up.

    • In AhsayCBS, you can back up the configuration from: System Settings > Advanced > Auto Save.

      • The Auto Save feature allows you to store your AhsayCBS server’s configuration with Ahsay Cloud. In the event of a disaster of your CBS server, you can reinstall CBS and then download your configuration.
      • Verify the date of last upload shown on Auto Save page.
      • There is a 50MB limit, any configuration package greater than 50MB will not be uploaded. You might exceed 50MB if you have more than one branding JSON for any Admin or Sub-Admin. If so, you should manually backup your configuration settings.
    • If you prefer to manually backup your configuration, you may zip the %AhsayCBS_HOME%/conf folder, and the %AhsayCBS_HOME%/system/obs/policies folder; keep your copy in separate destination.

  2. If you operate a branded AhsayCBS, export each of your production Branding JSON.

    • Branding profiles are stored in %AhsayCBS_HOME%/conf/cbs.db and %AhsayCBS_HOME%/conf/Branding/{ID}.
    • AhsayCBS will migrate existing pre-v9.5 JSON to the new format automatically.

  3. A copy of your existing (space permitting):

    • AhsayCBS installer binary matching your existing version.

    • AhsayCBS configuration and branding information found in the %AhsayCBS_HOME %/conf folder.

    • System home %AhsayCBS_HOME%/system folder.

    • AhsayOBM/AhsayACB Offline Client installers, download via CBS Web Console.

    • If you have modified your cbs.css, retain a copy from %AhsayCBS_HOME%/webapps/cbs/include/cbs.css.

    • If you have modified any Report templates, retain a copy from %AhsayCBS_HOME%/webapps/obs/jsp/report/*.*

  4. Disable the AhsayOBM/AhsayACB client auto update (AUA) for each user.

    We recommend you use the AhsayCBS Web Management Console to Disable/Enable AUA settings per user. Alternatively, temporarily to globally disable the client auto update, rename the index.xml file in %AhsayCBS_HOME%/download/liveUpdate to index.xml.disable.

Pre-requisites

For AhsayCBS v10

  1. OpenJDK 21 for Windows, Linux, FreeBSD

    • OpenJDK is bundled with installation of AhsayCBS for Windows and Linux.
    • For upgrade or installation on FreeBSD, your system administrator must manually install OpenJDK 21.
    AhsayCBS v10 only supports OpenJDK 21.

  2. GNU C Library (GLIBC) requirement for Linux and FreeBSD

    For upgrade or installation, your system administrator must verify system runs GLIBC 2.31 or greater. Otherwise, manually install GLIBC 2.31 or greater.

API Tests

As new APIs (JSON format) can be introduced in new releases of AhsayCBS, we recommend you review Release Notes and the API section for any changes. We recommend that after upgrading, you test your application to ensure compatibility.

Refer to the API section for details.

Please note that some API may have a "version 1" and a "version 2" type. Starting with the v10 API, version 1 API details are removed.

Documentation