===============================
XMATTERS E.P.I.C. Server README
===============================

Copyright xMatters, inc. 2011

Revision Date: Apr 01, 2011

------------
Dependencies
------------
The EPIC Client must be the same version as the EPIC Server.

The machine running EPIC Server must be in a timezone supported by Oracle.
  To retrieve a list of time zones supported by Oracle issue the following
  command as the system user.
    i. SELECT unique tzname from V$TIMEZONE_NAMES order by 1;

-----
Steps
-----
Before supplying an EPIC client package, follow the steps below.

1. Create a new xMatters on demand Company, and note the File Identifier.

2. Create a new Company Admin named EPIC for the new Company.

3. Rename Default Site in the new Company to EPIC.

4. Add a new Web Service User in the new Company. 

   * Ensure that you assign the "EPIC File Upload" Permission in the Allowed
     Web Services list.
	 
5. Ensure that the File Storage Location is configured in the
   Global Configuration section of the root Admin tab in the UI.
   
6. In the File Storage Location, create a folder with the File
   Identifier as noted in step 1.
   
   For example, if: 
         File Storage Location  = /opt/share
         File Identifier        = 200080

    Then:
         mkdir /opt/share/200080

7. Copy and modify the transform files (those with the .ktr suffix) in the 
   resources/transform folder to the folder created in step 6. Refer to 
   EPIC-TransformReadme.txt for more details on the transform files.

-----------------------
Data Supported for EPIC
-----------------------

[Sites]
  - Site Name
  - Status
  - Time Zone
  - Address
  - City
  - Country
  - Region
  - Mail Code

  * Note that the following are not carried over; an xMatters Consultant will
    assist in mapping values to xMod.
    a Clusters
	b Language will be set to English

[Attributes]
  - Attribute Categories

[Custom Fields]
  - Name
  - Type
  - Mandatory
  - Min / Max
  - Custom Field list values

[Users]
  - Sites
  - Status
  - First, Last Name
  - Time Zone
  - Web Login / Password
  - Phone Login / Password
  - User ID
  - Recorded Name
  - Custom Value
  - Custom Atributes
  - Person Supervisors

* Note that the following are not carried over; an xMatters Consultant will
  assist in mapping values to xMod.
  a. if Custom Field is of type "List" then only values specified in the UI are
     carried over.
     i.e. If there is a Custom Field called "First Aid Level" of type List and
          values specified in the UI are {"Level 1", "Level 2" and "Level 3"}, 
          any users with any other values will not be carried over by EPIC.

  b. Roles, will need to be mapped to something that is xMod specific and
      interaction between roles will be need to be mapped with an xMod
      Consultant.
  
  c. LDAP logins
     1. If a Custom Field of type Password and name "xMod Password" is present,
        the Custom Field's value will be used as the login password.
     2. Otherwise, the user will be locked out indefinitely by password
        policy. The administrator has to manually unlock a user after DR
        cutover.
     3. Users with LDAP authentication will always be processed on EPIC runs,
        whereas other users are processed only if changes were made.
  
  d. Recording of names are not carried over.
  
  e. Mobile Gateway Access is not carried over.
  
  f. Language will be set to English.
	 
[Email, Voice, Text Pager and Text Phone Devices]
  - Status
  - Order
  - Delay
  - Email: Address
    Voice: Country-Area Code-Number
    Text Pager: PIN, Is Two Way
    Text Phone: Target Number [Transformation is applied, please see below.]

* Note that the following are not carried over; an xMatters Consultant will
  assist in mapping values to xMod:
  a. User Service Providers, will need to be mapped to xMod specific values.
  
  b. Device Names, will need to be mapped to xMod specific values.
  
  c. Text Phone numbers are converted to xMod format, an xMod Consultant will
     assist in their validation.

  d. Voice Devices with extensions are disabled.

  e. When added to xMod, Devices are set to a 24x7 timeframe.

  f. Updating of Device timeframes is not supported.

[Groups]
  - Name
  - Description
  - Status
  - Time Zone
  - Use Default Devices
  - Site
  - Supervisors
  - Allow Duplicates
  - Recurrent, Holiday and One-Time Coverages
    - Teams
      - Use Default Devices
      - Escalation
      - No Round Robin / Event Based Round Robin
      - Team memberships
      - Member sequence

* Note that the following are not carried over; an xMod Consultant will assist
  in mapping values to xMod:
  a. One Time coverages are not carried over
  
  b. Group Observers are not carried over
  
  c. Current rotation order is not carried over.
  
  d. Calendar based Round Robin is not carried over.
  
  e. Team eascalation string can only have 100 characters
  
  f. Coverages overlapping the DST time change will always be updated during
     EPIC runs and will lose or gain one hour in duration.

[Temporary Replacement]
  - Replacement
  - Replacement Group
  - Replacement Period
  
END OF FILE
