Upgrading the EPIC client from a previous version
This article explains the steps to upgrade to the latest version of the EPIC client. You should upgrade to the latest version of the EPIC client to ensure that is compatible with xMatters On-Demand and that it can access the latest features that have been deployed on your system.
See EPIC client system requirements to review the system requirements for the EPIC client.
To see whether you need to update the EPIC client, compare the version of your EPIC client to the most recent version.
- To view the most recent version of the EPIC client, go to the EPIC client download page at support.xmatters.com.
- To verify the version of the EPIC client running on your system, navigate to the EPIC client installation folder and open the /log/epic.log file. The first line of this file indicates the version number of your EPIC client; for example:
... INFO - E.P.I.C. Control Client 5.5.124 r##### ...
If you are not using the most recent version of the EPIC client, proceed with these upgrade instructions.
Before you can begin to use the latest version of the EPIC client, you must have Java 8 installed on the system that hosts the EPIC client. (As part of the end-of-life for TLS v1.0 support, Java 7 is no longer supported.) If this system also hosts other tools, such as Pentaho ETL, you should ensure that they are compatible with Java 8 or move them to another system before upgrading your Java environment.
If you are running a version of the EPIC client prior to 5.5.77, you will not be able to use it after upgrading to Java 8, since older versions of the EPIC client are not compatible with Java 8. If you want to continue to be able to use the EPIC client during the upgrade process, first upgrade your EPIC client to 5.5.77 , then upgrade your system to Java 8, and finally update the EPIC client to the most recent version (5.5.124).
To install Java 8:
- Stop any active EPIC process and pause any scheduled jobs that may cause EPIC processes to start.
- Download Java 8 from http://www.oracle.com and install it according to the instructions.
- Don't forget that the location of the Java Development Kit (JDK) or Java Runtime Environment (JRE) must be defined by the JAVA_HOME system variable or included directly on the system PATH.
- Resume any paused jobs or processes.
Patching an EPIC client requires overwriting your existing EPIC client files with the new EPIC client files. The EPIC client does not include an installer.
It is recommended to complete these steps on a non-production or staging environment before upgrading your production deployment.
- Back up the current EPIC client: Create a backup copy of the existing EPIC client installation directory and store it in a safe location. You may also want to create backup copies of any scripts you use to launch the EPIC synchronization process. This ensures that you can restore the original EPIC client if you encounter complications while configuring the new one.
- Stop EPIC processes: Ensure that there are no EPIC processes currently running, and that there are no scheduled jobs that might start an EPIC process while you are applying the upgrade.
- Download and extract the EPIC client: You can download the EPIC client (epic-client-5.5.124.zip) from support.xmatters.com. Once downloaded, extract it to a new location on your system.
- Configure the settings files: Configure the new EPIC client to use the same settings as the previous version. To do this, open the following files in the original EPIC client and copy the settings to the same files in the new EPIC client:
- For all EPIC users: config/transport.properties
- For CloudSync users only: config/common.properties
- Deploy the new EPIC client: Now that the new EPIC client has been configured, you can deploy it by using one of the following methods:
- Overwrite the original EPIC client files with the new EPIC client files.
- Configure scripts to point to the new EPIC installation directory.
- Test the installation: Run any script or scheduled job that starts the EPIC synchronization process. You can then view the version of the EPIC client in the log file located in the /log/epic.log file of the EPIC installation directory.
The log message that contains the EPIC client version should look something like this:
2016-11-03 16:18:28,214 20327 [main] com.xmatters.epic.client.Main INFO - E.P.I.C. Control Client 5.5.124 r10436
- Re-enable scheduled jobs: Once you have confirmed that the EPIC client is working properly, you can re-enable any paused scheduled jobs.