CA Spectrum to CA eHealth Synchronization Guide

This documentation and any related computer software help programs (hereinafter referred to as the Documentation) is for the end users informational purposes only and is subject to change or withdrawal by CA at any time. This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the documentation for their own internal use, and may make one copy of the related software as reasonably required for back-up and disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the product are permitted to have access to such copies. The right to print copies of the documentation and to make a copy of the related software is limited to the period during which the applicable license for the Product remains in full force and effect. Should the license terminate for any reason, it shall be the users responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed. EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE. The use of any product referenced in the Documentation is governed by the end users applicable license agreement. The manufacturer of this Documentation is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Copyright 2009 CA. All rights reserved.

Contact Technical Support

For your convenience, CA provides one site where you can access the information you need for your Home Office, Small Business, and Enterprise CA products. At http://ca.com/support, you can access the following: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product

Provide Feedback If you have comments or questions about CA product documentation, you can send a message to techpubs@ca.com (see page iv). If you would like to provide feedback about CA product documentation, complete our short customer survey http://www.casurveys.com/wsb.dll/166/TIPO_2008_Survey.htm, which is also available on the CA support website, found at http://ca.com/support.

Change History
Documentation changes Attribute Document Name: Document Version: Version Date: Document Status: Authors: Version History Value eHealth Provisioning Automation Installation Guide 0.1 DRAFT 03 May 2011 DRAFT Mark Fergusson

Date 03 May 2011

Version 0.1

Description of Change Initial Draft of Document

Contents
Contents Chapter 1: Introduction Chapter 2: System Requirements 7 9 11

Software Components and Requirements ................................................................................. 11 Installation Preparation .......................................................................................................... 11

Chapter 3: Installation

13

Installing and Configuring the Synchronization CA Spectrum Component ...................................... 14 Pre-Installation Steps ....................................................................................................... 14 Installation on CA Spectrum Server .................................................................................... 16 Properties and Options ..................................................................................................... 16 Installing and Configuring the Synchronization CA eHealth Component ........................................ 17 Pre-Installation Steps ....................................................................................................... 17 Installation on CA eHealth Server ...................................................................................... 18 Properties and Options ..................................................................................................... 19 Validation ............................................................................................................................. 21 Troubleshooting Log Files .................................................................................................. 24

Chapter 4: Usage

25

Spectrum Synchronization ...................................................................................................... 25 Spectrum Actions ............................................................................................................. 25 eHealth Synchronization ......................................................................................................... 25 eHealth Actions ............................................................................................................... 25

Contents 7

Chapter 1: Introduction
This guide describes how to install and use the Global Delivery CA Spectrum to eHealth Synchronization software.

Chapter 1: Introduction 9

Chapter 2: System Requirements

This section contains the following topics: Software Components and Requirements Installation Preparation

Software Components and Requirements

The software components and requirements are as follows: eHealth eHealth 6.2x Spectrum Spectrum 9.x Browser Support IE 8.x

Installation Preparation
Copy the <date>-eHSSIntegration.zip file to the CA Spectrum and CA eHealth servers Note that different components of the same build package are used by CA Spectrum or CA eHealth respectively. Before you begin, verify that the environment variable SPECROOT is properly set on the system. In this instructions we will refer to $SPECROOT to refer to this environment variable. For windows systems you need to use %SPECROOT% instead.

Chapter 2: System Requirements 11

Chapter 3: Installation
This section contains the following topics: Installing and Configuring the Synchronization CA Spectrum Component Installing and Configuring the Synchronization CA eHealth Component

Chapter 3: Installation 13

Installing and Configuring the Synchronization CA Spectrum Component

Installing and Configuring the Synchronization CA Spectrum Component

This section describes how to install and configure the CA Spectrum component of the Synchronization solution.

Pre-Installation Steps
To prepare for CA Spectrum installation 1. On every Spectrum Landscape / SpectroSERVER, you will need to create a container per eHealth Server, of the type Network.

2. In this Example, we have two eHealth Servers: W2K3-EH621A W2K3-EH621B

3. Each has two discover policies:

14 Sync Guide

Installing and Configuring the Synchronization CA Spectrum Component

ServersPolicy RoutersPolicy

Chapter 3: Installation 15

Installing and Configuring the Synchronization CA Spectrum Component

Installation on CA Spectrum Server

1. Copy download the installation package to directory $SPECROOT/custom in your Spectrum system. 2. Unzip the installation package cd $SPECROOT/custom tar xvf eHSSIntegration_<release>.tar 3. Configure the eHealthServers and other default properties if needed (for more details see section Properties and Options to Modify): cd eHSSIntegration/config vi default.properties 4. Configure agent properties (host name and user name) e.g. host.name=W2k8-SS92A user.name=spectrum 5. Install the Right-Click Menu Action integration file If your currently have custom menus in your Spectrum system you need to manually migrate the contents of file: $SPECROOT/custom/eHSSIntegration/custom/console/config/custom-app-confi g.xml into your $SPECROOT/custom/console/config/custom-app-config.xml File.

Or cd $SPECROOT/custom/eHSSIntegration/custom/console/config cp custom-app-config.xml $SPECROOT/custom/console/config/custom-app-config.xml

Properties and Options

$SPECROOT/custom/eHSSIntegration/config/default.properties

Option test

Default false

Purpose If true, it tests basic functionality without connecting.

16 Sync Guide

Installing and Configuring the Synchronization CA eHealth Component

testEHealthServerURL

If test=true this server can be used as the destination for requests. http:// :8080/eHSSIntegration/services/eHSSIntegratio n W2K3-EH621A,W2K3-EH621B,W2K3-EH621D,W 2K3-EH621E Prefix to use in the url of the soap server Suffix to use in the url of the soap server Filters to just these destination eHealth Systems.

soapServerUrlPrefix soapServerUrlSuffix eHealthServers

Installing and Configuring the Synchronization CA eHealth Component

This section describes how to install and configure the CA ehealth component of the Synchronization solution.

Pre-Installation Steps

1. You must disable the out of box integration between Spectrum and eHealth by changing the OneClick server role to Passive.

Chapter 3: Installation 17

Installing and Configuring the Synchronization CA eHealth Component

Installation on CA eHealth Server

1. Copy download the installation package to directory $SPECROOT/custom in your Spectrum system. 2. Unzip the installation package cd $NH_HOME/custom tar xvf eHSSIntegration_<release>.tar

3. Configure the eHealthServers and other default properties if needed (for more details see section Properties and Options to Modify): cd eHSSIntegration/config vi default.properties 4. Configure agent properties (host name and user name) e.g. host.name=W2k8-SS92A user.name=spectrum 5. Run the installation script chmod 755 install.sh ./install.sh -install

18 Sync Guide

Installing and Configuring the Synchronization CA eHealth Component

6. If you are using a Windows sytem, restart Tomcat:

7. Start the H2 database cd $NH_HOME/custom/eHSSIntegration chmod 755 lib/h2

as the ehealth user

lib/h2 start

Properties and Options

$NH_HOME/custom/eHSSIntegration/config/default.properties

Option

Default

Purpose

Chapter 3: Installation 19

Installing and Configuring the Synchronization CA eHealth Component

test

false

If true, it tests basic functionality without connecting. Set name of the H2 database to use Set name of the H2 database to use Username of the H2 database Password of the H2 database

databaseName databaseHost databaseUser

PUBLIC localhost sa

databasePassword discoverDaemon no

Indicates is the Discover Update executable is ran periodically or only once If discoverDaemon=yes, frequency in seconds to run the Discover Update Port to be used to check if a Discover Update is running Time to delete devices from Spectrum (in seconds) when updates are not received, default 2 weeks (2*7*24*60*60) Time to keep maintenance records in H2 database (in seconds), default is 1 day (24*60*60) Days to keep files archive (used to delete files in NH_HOME\web\output\ discoverLogs folder. Only applied for files that do not have the pattern of *.log If false, maintenance cycle is not run

discoverFrequency

30

discoverRunningPort

1234

timeToDelete

1209600

timeOutOfMaintenance

86400

dayToKeepInArchive

maintenanceCycle

true

20 Sync Guide

Validation & Post Installation

retireCycle deleteCycle modelIdRequested modelNameRequested

true true 0

If false, maintenance cycle is not run if false, delete cycle is not run For testing purposes, use only this model id For testing purposes, use only this model name

Validation & Post Installation

This section describes how to verify the installation, as well as troubleshooting log files.

1. Validate H2 database is running http://<eHealth server name>:8082 Should show h2 console:

Chapter 3: Installation 21

Validation & Post Installation

Type in the JDBC URL as indicated in the image and click Test Connection. Test should be successful and you should be able to connect with the Connect button and User Name and Password as indicated above.

22 Sync Guide

Validation & Post Installation

2. Once connected, you must initialize the db. Do not skip this step. Paste the contents of the db.sql file in the $NH_HOME/custom/eHSSIntegration/misc directory into the open space below Run (Cntr+Enter), and then run.

3. Validate the web report is available

http://<eHealth server>/devicereport/

Note the web report will be blank

4. Validate the web services are available.

http://<eHealth server name>/eHSSIntegration/services

Chapter 3: Installation 23

Validation & Post Installation

Troubleshooting Log Files

eHealth Spectrum

$NH_HOME/log/device.h2.log $SPECROOT/log/ehssintegration.log

H2 database log log what devices are sent to eHealth from Spectrum. You can change the log file by going to $SPECTRUM_ROOT/cust om/eHSSIntegration/co nfig/ssToEh.log4j.prope rties and change the line : log4j.appender.R.File= <log location>

eHealth eHealth

$NH_HOME/log/discoverUpdate.log $NH_HOME/web/tomcat/logs/stdout.log or $NH_HOME/web/tomcat/logs/catalina.out

Log from discover process Tomcat log

24 Sync Guide

Spectrum Synchronization

Chapter 4: Usage
This section contains the following topics: Spectrum Synchronization eHealth Synchronization

Spectrum Synchronization
This section describes how to run CA Spectrum component of the Synchronization solution.

Spectrum Actions
1. Run the SSToEHealth script which will save the relevant devices for eHealth synchronization to the H2 database cd $SPECROOT/custom/eHSSIntegration/lib ./SSToEHealth.sh

eHealth Synchronization
This section describes how to run CA eHealth component of the Synchronization solution.

eHealth Actions
1. Run the DiscoverUpdate script which will query the H2 database and initiate a discovery of the relevant devices. cd $NH_HOME/custom/eHSSIntegration/lib ./DiscoverUpdate.sh

Chapter 4: Usage 25

eHealth Synchronization

26 Sync Guide