Synchronize user data with EPIC
The (Export Plus Import Controller) data synchronization utility is a command-line tool that allows you to automatically synchronize user data with xMatters.
There are two primary uses of EPIC:
- Synchronize xMatters with an external system, such as an LDAP database of employee names. This enables you to manage users in an external system and have them automatically updated in xMatters.
- Migrate data from an on-premise version of xMatters such as xMatters 5.1 into our software service, xMatters On-Demand
To use EPIC, you must have the appropriate licensing. For more information about your licensing options or to get started using EPIC, contact Client Assistance.
You must run a version of the EPIC client that works with your version of xMatters. Contact your xMatters representative to learn which version of the EPIC client to use with your system.
When you replace an older version of the EPIC client with a newer one, it is recommended that you edit the new configuration files instead of copying the old ones. The new configuration files may contain additional properties or set version information differently.
You can run EPIC in two different modes:
- CloudSync is our process for synchronizing data from a live xMatters software installation with our on demand system. Clients using xMatters software in their organization can use CloudSync to push existing information from their xMatters software to xMatters On-Demand.
- ZipSync is our process for allowing you to create files from any system for the purpose of synchronizing data with our on demand system. ZipSync allows clients to export data from any system into a predefined format which is then zipped up and synchronized with xMatters On-Demand.
Each of these modes are explained in detail in the following sections.
For both ZipSync and CloudSync run modes, when there are several files queued for a given Company, only the most recent file will be processed at the time of the EPIC job batch run (the other files are ignored).
CloudSync mode: Premises xMatters data to xMatters On-Demand
CloudSync synchronizes data between existing premises installations of xMatters and xMatters On-Demand. Data is transmitted securely over an HTTPS connection.
For example, an organization may want to synchronize data between its premises installation and xMatters On-Demand so that the latter can function as a backup, failover, or BCP/DR system.
If you are using CloudSync mode, there is no need to prepare the CSV files described in this document. Those files relate to the ZipSync mode process only. After you have met the requirements described in this section, you can skip ahead to Running EPIC in CloudSync Mode.
For Oracle, the function WMSYS.WM_CONCAT is required; if it is missing, the following error is displayed:
ORA-00904: "WM_CONCAT": invalid identifier
For installation instructions, refer to the metalink article: "How do you manually install/deinstall Oracle Workspace Manager [ID 731576.1]" (you will have to search the site for it, as a direct link is unavailable). Note especially the following text from the article: "INSTALL: If you wish to reinstall Workspace Manager at a later time, you can run, as SYS:$ORACLE_HOME/rdbms/admin/
ZipSync mode: External System data to xMatters On-Demand
EPIC ZipSync mode synchronizes data from external systems with xMatters On-Demand. Data is transmitted to xMatters securely over an HTTPS connection.
For example, an organization may want to synchronize data from its HR, LDAP, Active Directory, or other corporate system. In this run mode, data synchronization is done through CSV (comma-separated value) files.
If you plan to run ZipSync mode, you must first prepare and format your data. For details, see ZipSync mode CSV File Content.
Additionally, a manifest file allows synchronization options to be configured for the type of synchronization to perform, and which Device names to ignore (for details, see The manifest.xml file).