Integrator > Synchronize user data with EPIC > Running EPIC in CloudSync Mode

Running EPIC in CloudSync Mode

You can run EPIC in CloudSync mode to synchronize data from an xMatters on-premise software installation to xMatters On-Demand. For information about the type of data that can be synchronized using CloudSync, see CloudSync Data Support.

The following instructions apply to EPIC CloudSync mode only. For information about running EPIC in ZipSync mode, see Running ZipSync mode.

Configure EPIC to run in CloudSync mode

To use CloudSync, install the EPIC client on a system that can access your on-premise xMatters installation. (You may be required to install EPIC on a system that is behind your company firewall.) Once EPIC is installed, edit the configuration files to include login information for both systems, and then encrypt these files. You can then run the epic command from a terminal window to import data from your on-premise system to xMatters On-Demand.

The EPIC client can be installed on Linux or Windows systems that include Java 7 or Java 8. Additionally, the system running EPIC must use the same time zone as the database server of the on-premise system.

To configure EPIC to run in CloudSync mode:
  1. Ensure that Java 7 or Java 8 (JDK or JRE) is installed on the EPIC system. If it is not installed, download it from http://www.oracle.com and set the Java PATH environment variable:
    1. Linux: $JAVA_HOME/bin
    2. Windows: %JAVA_HOME%\bin
  2. Ensure that the time zone of the EPIC system is the same as the time zone of the on-premise database server.
  3. Unzip the epic-client-5.5.124.zip file to a directory on the EPIC system.
  4. If you are running EPIC on a Linux system, change the permissions of the epic-client-5.5.124/bin/epic shell script to allow execution (for example, run chmod +x epic-client-5.5.124/bin/epic from the command line). This is not required for Windows systems.
  5. Edit the transport.properties file to include configuration information for the target xMatters On-Demand system. For more information about modifying this file, see Configure the transport.properties file.
  6. Edit the epic-client-5.5.124/conf/common.properties to include configuration details for the database hosting the production tables of the on-premise installation, as described in the following section. (Replace the values in <> with actual values).
  7. Use the APSecureClient script to encrypt common.properties and transport.properties to secure the passwords and other configuration information in these files. This step is strongly recommended but not required. For more information about encrypting these files, see Encrypt/Decrypt .properties files.

Configuration settings for common.properties

Oracle

JDBC_DRIVER_CLASS_NAME=oracle.jdbc.driver.OracleDriver

JDBC_URL=jdbc:oracle:thin:@<database ip>:<database port>:<database sid>

JDBC_USERNAME=<username>

JDBC_PASSWORD=<password>

SQL Server

JDBC_DRIVER_CLASS_NAME=net.sourceforge.jtds.jdbc.Driver

JDBC_URL=jdbc:jtds:sqlserver://<database ip>:<database port>/<database>

JDBC_USERNAME=<username>

JDBC_PASSWORD=<password>


Running EPIC in CloudSync mode

Running CloudSync serializes the production data of the source system into the remote xMatters On-Demand system. By default, the source system retains ownership of the data. In other words, objects imported into xMatters On-Demand are marked as externally owned. If you would like your xMatters On-Demand system to own the data (in other words, have the data not marked as externally owned) you can run CloudSync with the --migrate option.

If you would like to test CloudSync before you import data into your xMatters On-Demand system, you can run CloudSync in debug mode. Running CloudSync in debug mode creates a local, unencrypted dump of the production data that can be used for debugging purposes.

When objects are marked as externally owned in xMatters, they can only be deleted by using the EPIC tool and cannot be deleted by using the xMatters user interface. For more information about external object ownership, see External ownership and locking

To run EPIC in CloudSync mode:
  1. Open a shell or command prompt, navigate to the epic-client-5.5.124/bin folder.
  2. To run CloudSync in debug mode, use the following command:
    1. epic debug
  3. To import data into your xMatters On-Demand system, use the following command:
    1. epic export
  4. To run CloudSync with advanced options, append the flags defined in the following table to the end of the epic command. For example, the following command imports data into xMatters On-Demand but does not import device order and delay settings:
    1. epic export --device-order-ignore
Flag Definition
-m or --migrate Migrates the ownership of the data to xMatters On-Demand. In other words, objects are imported into xMatters On-Demand and are not marked as externally owned.
--device-order-ignore Does not import device order and delay settings into xMatters On-Demand. Use this flag to prevent overwriting device order and delay settings that have been customized by users. If you do not use this flag, users may need to reconfigure their device order and delay settings after CloudSync has been run.
--default-supervisor=<username>

Replace <username> with the ID of a user who will become the supervisor for users and groups that otherwise would not have a supervisor. This situation can occur when a group supervisor is a Company Administrator or Super Administrator, because CloudSync does not import these users into xMatters On-Demand.

This user becomes the default group supervisor if they have the Group Supervisor role, and becomes the default user supervisor if they have the User Supervisor role. You cannot set different default supervisors for users and groups.