Upgrade CCMS Web

Upgrading to IXIASOFT CCMS Web 6.7 from version 5.2 is mostly configuration updates before running the installation script.

1. Download and unzip the package:
   1. Go to the 6.7 area of the IXIASOFT Downloads site:
      https://cms.ixiasoft.com/downloads/CCMS_6.7/
   2. Click the CCMS_Web folder.
   3. Enter the user name and password given to you by IXIASOFT Sales.
   4. Click the latest .zip file of the installation package.
      IXIASOFT-CCMS-Web-[platform]-<version>.zip,
      where the platform is either windows or linux and version is the latest build version of the installation package
      For example, IXIASOFT-CCMS-Web-windows-1.2.3.zip
   5. Extract the zip file to a temporary folder on the local drive.
      Important: Do not use spaces in the path or file name.

      Important: Do not extract to a location that would result in a long path.
2. In the location where you extracted the package, open the properties.txt file in a text editor.
   Important: It is important to do all the configuration for the new parameters in properties.txt before running the installation script. Otherwise only the default values will be used.

   For existing parameters, the installation script will reuse any existing values you set in the previous version of CCMS Web. You do not need to update them unless you want to change your configuration.

3. If required, change the default configuration for the new parameters for the Apache Tomcat application:

   Parameter	Describes
   TOMCAT_XMX	Sets the maximum memory size available to the Apache Tomcat application. Default value: 8192
   TOMCAT_XMS	Sets the minimum memory size available to the Apache Tomcat application. Default value: 512

4. Configure the new parameters for IXIASOFT CCMS Output Generator as required:

   Parameter	Describes
   OUTPUTGENERATOR_HOSTNAME	Hostname of the server where IXIASOFT CCMS Output Generator is installed. Default value: HOSTNAME The hostname cannot include spaces.
   OUTPUTGENERATOR_PORT	Default value: 1500
   OUTPUTGENERATOR_SHARED_DIRECTORY	The directory where outputs are stored. This directory must be writable by CCMS Web Server. UNC paths are supported. Default value: c:\Ixiasoft\OutputGeneratorSharedDir
   OUTPUTGENERATOR_DAYS_TO_KEEP	The number of days that CCMS Web Server stores outputs generated in CCMS Web. After the set number of days, the outputs are deleted. Default value: 7

5. Add and configure the new properties for the IXIASOFT Dynamic Release Management cache system:

   Parameter	Describes
   APPSERVER_HOSTNAME	The hostname of the server where the Web Application is installed. For example: APPSERVER_HOSTNAME=<COMPANY_HOSTNAME> The hostname cannot include spaces.
   APPSERVER_SUBSCRIPTION_PORT	The port number for connecting the replication service between TEXTML Server and the Web Application Server. Default value: 3200. This value can be different if there are many Application Servers sharing a single computer.
   APPSERVER_SUBSCRIPTION_ID	This is a string describing the replication connection. Using the name of the Application Server is strongly recommended. It should also be unique for TEXTML Server if there are many docbases and many application servers. The name of a docbase cannot include spaces.

6. If you use SCCM to manage Windows updates on the server with CCMS Web, change the following Tomcat properties if required:

   Parameter	Describes
   TOMCAT_SHUTDOWN_PORT	The port that the Apache Tomcat application server uses to listen for shutdown requests. The native service can trigger a signal to Tomcat's shutdown port, and Tomcat's own code can handle the rest. Default value: 8035
   TOMCAT_AJP_PORT	The port used for AJP implementation if in use. Default value: 8039

   IXIASOFT has set new default values for Tomcat because SCCM (Microsoft's automated deployment and update tool) uses port 8005 for installing Windows updates, which was Tomcat's default shutdown port. Thus, Tomcat cannot bind to the port.

   You only need to change the default values above if you want to set different values for these ports.

7. Save and close the properties.txt file.
8. If you have configured SAML, backup your onelogin.saml.properties file.

   During the upgrade process, the Web Installer deletes the existing configuration file and creates a new unconfigured file in a new path: apache-tomcat-9.0.67/conf/ixiasoft-ccms/onelogin.saml.properties.

9. (Optional): Make a full copy of the folder for the current CCMS Web installation.
   IXIASOFT recommends having a full copy of the existing folder as it simplifies reverting the changes if required.
10. Run the installation script.
    Note: When upgrading to IXIASOFT CCMS Web 6.7, the installation script uninstalls the current versions of Java, Tomcat, and Oxygen.

    Java

    The new version of Java is a local JDK that comes with the installation package, and it runs independently of what is installed on the server. No action is required.

    Tomcat

    The re-installation resets the Tomcat configuration. If you have modified the Tomcat configuration, save those values somewhere before running the installation script so you can reconfigure Tomcat afterwards.

    Oxygen

    The installer creates a backup of the oxygenworkspace folder for the Oxygen configuration, which includes frameworks and plugins. No action is required to save values for the Oxygen configuration, but you must re-install all these additional frameworks and plugins after the update.

    • Windows: Open a command prompt using Run as administrator, navigate to the folder where you extracted the installation script, and enter:

      WindowsInstall.bat <InstallDir>

    • Linux: Run the following command as root:

      sh ./LinuxInstall.sh <InstallDir>

11. Verify that the script was successful:
    1. In the folder where you extracted the installation script, open the installation.log file in a text editor.
    2. Scroll to the end of the log and look for the message Installation successful.
       If the Installation successful message is missing, the installation failed.
12. If the installation failed, do the following:
    1. Retrieve the properties from the previous installation, which is saved in the installation source folder in the file properties.txt.automerged.
       This is the same folder where WindowsInstaller.bat is located.
    2. Clean-up the target folder if there are still files there.
    3. Do a fresh install of CCMS Web 6.7.
       For more details, see the guide: Installing IXIASOFT CCMS Web.
    4. Reinstall your Oxygen frameworks and plugins, which the Web Installer saved in the backup folder.
       The Web Installer backs them up, it but does not automatically re-install them.
    5. If you modified the Tomcat configuration for your previous CCMS Web installation, you must reconfigure Tomcat.
    6. If you configured single sign-on, you must manually copy your onelogin.saml.properties and CMSServerService.config files to the Tomcat configuration folder.
13. Verify that CCMS Web is at the correct version and is working:
    1. Navigate to the URL for CCMS Web, which uses the following pattern:
       http://[host name]:TOMCAT_HTTP_PORT/
       For example:
       http://localhost:8080/
    2. On the login page, verify that the Version indicates 6.7.
    3. Log in and verify that the first page opens as expected.
14. Reinstall your Oxygen frameworks and plugins, which the Web Installer saved in the backup folder.
    The Web Installer backs them up, but it does not automatically re-install them.