=====================
XMATTERS PATCH README
=====================

Patch version: PATCH-410-007
Build: 696
Revision: 45628

Document revision date: April 27, 2011

Copyright xMatters, inc. 1994-2011


-------
SUMMARY
-------
This is a cumulative patch for version @marketing_version@ issues, and should be
applied to all xMatters Application Nodes, Notification Nodes and Web Servers
(and to the DataSync Server, if applicable).

NOTE: Full release notes for this patch are available on the xMatters community
      web site: http://community.xmatters.com/community/downloads/documentation.
      It is recommended that you review the full release notes for the most
      up-to-date information about this patch.

NOTE: Language Translation Pack @marketing_version@ is included with this patch;
      you do NOT need to install it separately).

WARNINGS
********
- When applying an xMatters patch to an existing installation, the patch may
  overwrite some files that were already modified for an integration. This may
  cause the integration to stop working. If this occurs, using the integration
  documentation, re-apply the configuration changes and validate the
  integration. See also the article titled "Integration stops working after
  applying AlarmPoint patch" on the xMatters Community web site.
	 
  In particular, note that the following xMatters integrations may edit
  pre-existing xMatters Node or Web User Interface files:
	 
     - HP NNMI: Updates web.xml in webserver\webapps\axis2\WEB-INF (see
       the section "Initialize the Incident Subscription Manager" in the
       integration guide)
     - HP Service Manager (Adv): Updates classpath on node-start.conf on
       Windows and node.sh on Unix (see the section "Initialize the Web Services
       Library" in the integration guide)
     - HP Service Center (Adv):  Updates classpath on node-start.conf on
       Windows and node.sh on Unix (see the section "Initialize the Web Services
       Library" in the integration guide)

- Before applying this patch, you must upgrade to xMatters @marketing_version@.
  After upgrading, it is recommended that you apply the latest xMatters
  @marketing_version@ patch, UNLESS your upgrade path is not compatible with the
  latest patch.

----------------------
INSTALLING THIS PATCH
----------------------
Apply this patch to all xMatters Application Nodes, Notification Nodes and Web
Servers (and any DataSync installations, if applicable).

WARNING: This patch includes database changes (see next section) that may impact
         your replication mechanism; consult with your database administrator
         for further details.

Database changes
----------------
DDL:
  On all supported databases (Oracle, SQL Server, DB2):
     - Adds table DATABASECHANGELOG
     - Adds column CUS_FIELDS to table NTFN_EVS
     - Creates index IDX_DISPATCH on table LIVE_NTFN
     - Adds Procedure DISPATCH_QUERY

  On DB2 Only:
      - Adds Type NTFN_IDS BIGINT ARRAY[]

DML:
  On all supported databases (Oracle, SQL Server, DB2):
     - Updates table PROV_PROTS setting SESSION_MAX_SIZE
     - Adds Node Component: Notification Response Processor
     - If missing, re-add permission 18210 (view.menuitem.AddCustomPage) to
       function 100 (Super/Company Administrator)
     - If missing, re-add permission 18211 (view.screen.AddCustomPage) to
       function 100 (Super/Company Administrator)

Pre-Installation Steps:
-----------------------
1. Shut down all Node processes.
2. Shut down all Webserver processes.
3. Back up the xMatters Database.

Installation Steps:
-------------------

NOTE: This patch includes path names longer than 100 characters. As a result,
      you must use a GNU-compatible version of tar to extract the tar archives.

1. Back up the xMatters installation directory.

      - On Windows, default install directory is:
           C:\Program Files\AlarmPointSystems\AlarmPoint

      - On Unix, default install directory is:
           /opt/alarmpointsystems/alarmpoint

2. Save the PATCH-410-007.zip or PATCH-410-007.tar.gz file to the xMatters
   installation directory.

3. Do one of the following:
      - On Windows, extract (i.e., unzip) the PATCH-410-007.zip file to the
        installation directory and overwrite the existing files.
      - On Unix, run the following commands on the PATCH-410-007.tar.gz file
        and overwrite the existing files:
           gunzip PATCH-410-007.tar.gz
           tar -xvf PATCH-410-007.tar
	   
4. If you are applying this patch on:
     - Windows 32-bit, delete the following files from the Windows\system32
       folder (if the files are present):
          - alarmpoint_sapi_tts.dll
          - alarmpoint_mapi.dll
	  
     - Windows 64-bit, delete the following files from the
       Windows\systems32\sysWOW64 folder (if the files are present):
          - alarmpoint_sapi_tts.dll
          - alarmpoint_mapi.dll
	  
     - AIX, move the libjspAixPpc.so file from /AIX (located in the extracted
       patch directory) to <xMatters_Installation_Dir>/jre/bin
       
       Navigate to the <xMatters_Installation_Dir>/jre/bin directory and set
       the proper permissions by executing the following command line:
          chmod 755 libjspAixPpc.so

     - HP-UX Itanium, move the libjspHpxIa64.so file from /HPUX (located in
       the extracted patch directory) to <xMatters_Installation_Dir>/jre/bin
       
       Navigate to the <xMatters_Installation_Dir>/jre/bin directory and set
       the proper permissions by executing the following command line:  
          chmod 755 libjspHpxIa64.so

     - HP-UX PA-RISC, move the libjspHpxPaRisc.sl file from /HPUX (located in
       the extracted patch directory) to <xMatters_Installation_Dir>/jre/bin
       
       Navigate to the <xMatters_Installation_Dir>/jre/bin directory and set 
       the proper permissions by executing the following command line:
          chmod 755 libjspHpxPaRisc.sl
          
     - Linux 32 bit, move the libjspLux86.so file from /Linux (located in
       the extracted patch directory) to <xMatters_Installation_Dir>/jre/bin
       
       Navigate to the <xMatters_Installation_Dir>/jre/bin directory and set 
       the proper permissions by executing the following command line:
          chmod 755 libjspLux86.so
          
     - Linux AMD 64 bit, move the libjspLux86_64bit.so file from /Linux (located in
       the extracted patch directory) to <xMatters_Installation_Dir>/jre/bin
       
       Navigate to the <xMatters_Installation_Dir>/jre/bin directory and set 
       the proper permissions by executing the following command line:
          chmod 755 libjspLux86_64bit.so
      
5. Do one of the following:
      - If you have not installed the DataSync component, skip to "Post-
        Installation Steps", below.
      - If you have installed the DataSync component, complete the remaining
        steps.
	
6. Back up the xMatters DataSync installation directory. 
      - On Windows, default DataSync install directory is:
           C:\Program Files\AlarmPointSystems\AlarmPoint_DataSync
      - On Unix, default DataSync install directory is:
           /opt/alarmpointsystems/alarmpoint_datasync

7. Do one of the following:
      - Extract (i.e., unzip) the PATCH-410-007-DataSync.zip file to the
        installation directory and overwrite the existing files.
      - Run the following commands on the PATCH-410-007-DataSync.tar.gz file
        and overwrite the existing files:
           gunzip PATCH-410-007-DataSync.tar.gz
           tar -xvf PATCH-410-007-DataSync.tar

Post-Installation Steps:
------------------------
IMPORTANT: Database upgrades may take place after this patch is applied (i.e.,
           during startup of xMatters components). The first component to be
	   started will cause the database upgrades to be applied. This means
	   that the subsequent startup of web servers and nodes may be delayed
	   while they wait for the database updates to be completed. To monitor
	   the progress of the updates, see "Determining the status of database
	   updates", below.

1. Restart the Node processes.
2. Restart the Webserver processes.

Determining the status of database updates
------------------------------------------
To determine the current status of database updates, open the log file(s) 
associated with the first xMatters component being restarted (default
locations shown; only one log will include the MUTEX entries):

   Node
   ----
   <xMatters_InstallDir>/logs/AlarmPoint.txt.
	
   Web Server
   ----------
   <xMatters_InstallDir>/webserver/webapps/axis2/WEB-INF/logs/
      AlarmPoint_WebApp.log
   <xMatters_InstallDir>/webserver/webapps/cocoon/WEB-INF/logs/
      AlarmPoint_WebApp.log
   <xMatters_InstallDir>/webserver/webapps/mobilegateway/WEB-INF/logs/
      AlarmPoint_WebApp.log

During component restart, you will see log entries similar to the following:

   2009-01-21 22:07:02,251 [AlarmPoint Node-main] WARN - - Acquiring patch
      update MUTEX.
   2009-01-21 22:07:21,685 [AlarmPoint Node-main] WARN - - Acquired patch update
      MUTEX.
   2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Package 1 of 8
      (@marketing_version@/oracle/01.xml)
   2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Statement 1 of 2:
      Executing SQL Statement.
   2009-01-21 22:07:22,506 [AlarmPoint Node-main] WARN - - Statement 2 of 2:
      Executing SQL Statement.
   2009-01-21 22:07:22,516 [AlarmPoint Node-main] WARN - - Package 2 of 8
      (@marketing_version@/oracle/02.xml)
   .
   .
   .      
   2009-01-21 22:07:22,847 [AlarmPoint Node-main] WARN - - Package 8 of 8
      (@marketing_version@/oracle/finalize.sql)
   2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - The database update
      scripts have been successfully processed and deleted.
   2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - Patch update MUTEX
      released.

After the message "Patch update MUTEX released" appears in the log, the database
update has completed.

NOTE: If the log shows that the process has not proceeded from "Acquiring patch
      update MUTEX" to "Acquired patch update MUTEX" in a timely manner, ensure
      that there are no locks on the ORGS database table.

------------------------------
FILES INCLUDED WITH THIS PATCH
------------------------------
PATCH-410-007.tar.gz
PATCH-410-007.zip 

PATCH-410-007-DataSync.tar.gz
PATCH-410-007-DataSync.zip

---------------
WEBSPHERE FILES
---------------
The following archive files are available in the Product Patches area of the
xMatters Community web site (http://community.xmatters.com/community/
downloads/patches):

   PATCH-410-007-websphere.tar.gz
   PATCH-410-007-websphere.zip

These archive files contain the following WAR files for use with IBM
WebSphere 7:

  - PATCH-410-007-axis2.war: Contains xMatters Web Services files.
  
  - PATCH-410-007-cocoon-websphere6.war: Contains web user interface files.
  
  - PATCH-410-007-mobilegateway-websphere6.war: Contains xMatters mobile
                                                  access files.

If you have already deployed these files on a previous xMatters deployment,
you must uninstall the existing files and then reinstall the new files based on
the instructions in the "Advanced xMatters Administration" chapter of the
xMatters Installation and Administration Guide (available for download from the
xMatters Community web site).



END OF FILE