Velocity Version Switching
The Velocity Template engine powers Percussion templates. As new versions of the engine are made available, there may be changes to the template language that could affect Templates that had been implemented on a prior version.
The Velocity Version Switching tool, allows for customers to switch the version of the Engine that is used to render templates in the event that the version update created incompatibilities with existing code. This can allow for continuing to receive patch updates without have to need to update templates after patching. NOTE: The version switch also updates the Velocity Tools to the matching version. If you had updated Velocity Tools manually you will need to re-deploy your Velocity Tools version after the switch.
Prior to switching Velocity versions, the Percussion Service should be in a stopped state.
In Windows Server:
1. Stop the Rhythmyx Service
2. As an Administrator Start a command prompt on the server
cd <InstallDir>\rxconfig\velocity
3. Run the batch file with option for specific version of Velocity engine.
To switch to the original 1.6.2 version:
switchVelocityVersion.bat 1.6.2
To switch to the Percussion patched 2.0 version:
switchVelocityVersion.bat 2.0-patched
To switch to the 2.1 release version:
switchVelocityVersion.bat 2.1
4. Start the Rhythmyx Service.
In Linux Server:
1. Stop the Rhythmyx Service
2. As a Percussion user Start a shell session on the server:
cd <InstallDir>\rxconfig\velocity
3. Run the batch file with option for specific version of Velocity engine.
To switch to the original 1.6.2 version:
./switchVelocityVersion.sh -v 1.6.2
To switch to the Percussion patched 2.0 version:
./switchVelocityVersion.sh -v 2.0-patched
To switch to the 2.1 release version:
./switchVelocityVersion.sh -v 2.1
4. If you run Percussion as a named user and ran the above commands as a sudo user or root, make sure to reset ownership. For example:
cd <InstallDir>; chown -R rhythmyx:rhythmyx *
5. Start the Rhythmyx Service.
Note that the <InstallDir>\rxconfig\Server\velocity-precompiler.properties file settings should be turned off when running under the 1.6.2 profile. The system will update this file when switching versions.
The commands above will deploy the necessary library files, and supporting configuration files to the necessary locations under the Jetty and legacy JBOSS application server. After starting the Percussion Service the system will use the Velocity version that was selected.
More information on updating to Velocity 2.x can be found here and also here on the Apache Velocity website. The VTL changes have the most impact on templates.