Dell...EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE iii Table of Contents 1 Preface vii Audience

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® Ionix™ ITO AdapterIBM Tivoli Netcool/OMNIbus

Version 2.4

Installation and Configuration GuideP/N 300-011-519

REV A01

ii VERIONS 2.4 REV A01 300-011-519

Copyright © 2010 EMC Corporation. All rights reserved.Published September, 2010

EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION INTHIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABIL-ITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.

For the most up-to-date regulatory document for your product line, go to the Technical Documentationand Advisories section on EMC Powerlink.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.All other trademarks used herein are the property of their respective owners.

Table of Contents 1Preface viiAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiOrganization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiFont conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiRelated documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Introduction 13Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Integration Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Action Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Adapter Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15ITIL Services Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Supported ITIL Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Persistence Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Database Acquisition Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Buffer Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Web Service Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Notification Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Acquisition Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Acquisition–Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Notification Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Custom Parameters for Notification or Acquisition-Event Services . . . . 26

Operations Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Process Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

About the IBM Tivoli Netcool/OMNIbus Adapter . . . . . . . . . . . . . . . . . . . . . . . . . 29Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29TEC EIF Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Supported Services 33Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Polling Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Blocking Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE iii

Terminal Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Notification WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Discovery Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Operations Web Service Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Event Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

System Configuration 41Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Recommended . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Software Installation 43Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Configuring SSL Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Recommended OMNIbus Adapter Configuration . . . . . . . . . . . . . . . . . . . . 46Installing a License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Installing the Adapter Software - Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Start the Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Installing the URL Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Installing the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Running the Adapter Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Executable Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Service Manager Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Installing Adapter Software - UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Running the Adapter UNIX Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Manual Installation Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Install the Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Framework Properties 88Properties Editor Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Starting the Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Using the Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Global Framework Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Acquisition monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Automated Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91OMNIbus Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

iv VERSION 2.4 REV A01 300-011-519

Configuring OMNIbus 95Copy the Required JAR Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Modify Script files to Identify the URL Agent Location . . . . . . . . . . . . . . . . . . . . 96Install the NCO Process Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Configure the EIF Probe Rules File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Configure the Object Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Modify the SQL Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Execute the SQL Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Disable Connect and Disconnect Event Generation . . . . . . . . . . . . . . . . . . . . . 101

Custom Configuration 103Client Acquisition Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Object Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103RESTful Client Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Calling the RESTful Client Acquisition from curl . . . . . . . . . . . . . . . . . . . . . 104SOAP Client Acquisition Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Running on another port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Adapter High Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Operations Services Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Acquisition Services Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Use the External Database for Multiple Adapters . . . . . . . . . . . . . . . . . . . 108Adapter Failover Infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Agent Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Java to Adapter Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Persistence Database Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Removing Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Reclaiming Unused Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Connecting to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Changing the Database Port Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Offloading the Acquisition Queue to an External Database . . . . . . . . . 112

Using the URL Agent 113About the Adapter URL Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Python Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113URL Agent Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Shutting Down and Starting the Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . 114Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Running the URL Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Example Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115URL Agent Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Running the Filter Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Filter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Example Filter Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE v

Ionix IT Orchestrator Configuration 121Using the ITIL Adapter Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Associated Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Using the Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Adapter API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127API Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Package Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Key Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Service Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Java Code Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Managing the Adapter 133Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Connecting to the Adapter Java Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Starting the Java Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Management Beans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

com.iwave:name=Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135com.iwave:name=AcquisitionQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136com.iwave:name=FrameworkAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Maintenance and Troubleshooting 139Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Log Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Turning on Adapter Logging (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . 139URL Agent Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Error Types and Meanings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Recoverable Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Permanent Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Global Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Re-Installing or Uninstalling the Windows Service . . . . . . . . . . . . . . . . . . . . . . 144Re-installing the Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Uninstalling the Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Starting and Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Uninstalling the Adapter Software - Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 145

IT Object Model (ITOM) 149

Index 157

vi VERSION 2.4 REV A01 300-011-519

Preface 2This manual includes instructions on installing, configuring, and troubleshooting the EMC IBM Tivoli Netcool/OMNIbus Adapter software.

Audience 2

This publication is written for the System Administrator or Engineer responsible for installing and configuring the EMC IBM Tivoli Netcool/OMNIbus Adapter software.

Organization 2

This publication consists of the following chapters:• Introduction• System Configuration• Software Installation• Framework Properties• Using the URL Agent• Custom Configuration• Orchestrator Configuration• Managing the Adapter• Maintenance and Troubleshooting• IT Object Model List (ITOM)• Index

Font conventions 2

• Bold format is used to identify dialog boxes and menu choices. For example: Start > Programs > IonixITO> adapters-2.4

• Courier fixed-width font is used for code elements (Java, HTML) as well as filenames and directories. For example:install_root refers to the directory where the Adapter software is installed, for example

EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE vii

c:/Program files/install_root/Adapters

• Web addresses are displayed as hyperlinks. For example: http://www.EMC.com

Related documents 2

For more information on EMC software products, refer to the following manuals:• EMC Ionix IT Orchestrator Introduction and Planning Guide - This

manual provides an overview of the Orchestrator architecture and associated applications. It introduces the main components of the IT Orchestrator, Design Studio, Platform and applications.

• EMC Ionix IT Orchestrator Installation and Configuration Guide - This manual provides information on installing the EMC Ionix IT Orchestrator, Design Studio, Platform and associated plugins. Provides an overview on how to install the Orchestrator Studio on Windows and Linux platforms and describes the mechanism for installing the Orchestrator Platform in your managed environment.

• EMC Ionix IT Orchestrator Administration and Operations Guide - This manual identifies the administration tasks required to configure the Ionix IT Orchestrator Platform and describes the log files available for detailed analysis of running solutions.

• EMC Ionix IT Orchestrator Developer Guide -This manual provides an introduction to the Designer Studio and Lifecycle tools that enable you to design Services and Tasks in Orchestrator Studio. The manual identifies the procedures for building Services and Tasks and describes the configuration of the associated properties.

viii VERSION 2.4 REV A01 300-011-519

1Chapter
Introduction 1
Topics covered in this chapter:• Introduction• Adapter Framework• ITIL Services Support• Supported ITIL Object Types• System Architecture• Persistence Database• Web Service Methods

Introduction 1

EMC provides two different types of ITIL Adapters:• Integration Adapters• Action Adapters

Integration Adapters

EMC provides a comprehensive library of IT Service Management (ITSM) integration Adapters. Integration Adapters enable the bi-directional exchange of Incident, Problem, Configuration, Change and Asset information between ITSM applications.

The ITSM applications include:• Service Desk Applications• Enterprise Management Systems• CMDB and Asset Management Systems• Database Management Systems

Figure 1-1 illustrates a high-level view of the end-to-end, bi-directional process. In this process, the new/modified Incident Record goes from the endpoint application to the remote vendor application.

EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE 13

INTRODUCTION

EMC provides for two-way integrations allowing this process flow to move in either direction. An Adapter is required on each endpoint as each application has a customized API. Integrations can be performed for multiple applications; integrations are not limited to two.

Figure 1-1 High-Level Integration Overview

Action Adapters

Action Adapters allow you to quickly create integration Adapters for ITSM applications without resorting to programming. EMC provides the following Action Adapters, which can be installed with other Integration Adapters:• Command Line Adapter• Reverse Proxy Adapter• SQL Proxy Adapter

Command Line Adapter

The Command Line Adapter allows remote execution of command line processes on the machine where the Adapter is installed. Commands can be executed using the Command Line Web Service.

Reverse Proxy Adapter

The Reverse Proxy Adapter can be used by customers who may need to put their service desk application on the public internet. The Reverse Proxy Adapter can be used to provide a layer of indirection between the Ionix IT Orchestrator and the service desk. The proxy can provide security (HTTPS) and authentication (HTTP Basic Authentication) without needing to set up these configurations on the service desk.

SQL Proxy Adapter

The SQL Adapter allows remote execution of SQL queries on the Adapter system. This allows the Ionix IT Orchestrator to effectively query a database that is only accessible through the public internet. The Adapter can secure the

14 VERSION 2.4 REV A01 300-011-519

ADAPTER FRAMEWORK

communication and provide the actual access to the database. To utilize the SQL Proxy Adapter, you must configure the Adapter to point to the database you wish to use.

Adapter Framework 1

The EMC Adapter Framework is a Java 6 application. The Adapter Framework manages communication between the EMC Adapter and consumers (including EMC Ionix IT Orchestrator). The EMC Adapter interfaces with the ITSM application’s API and is therefore restricted by the limitations of that API. • For some ITSM applications, the EMC Adapter must run on the same machine

as the ITSM application itself. • For other ITSM applications that support remote APIs, the Adapter may run on

a separate machine.


ITIL SERVICES SUPPORT

ITIL Services Support 1

EMC Adapters support the Information Technology Infrastructure Library (ITIL) service silos as illustrated in Figure 1-2. The ITIL is a set of best practice standards for Information Technology Service Management (ITSM) and has become the worldwide standard in service management.• Incident Management - needs configuration (CI) dependency information

and determines a correlation of incidents and creates a problem report.• Problem Management - needs all Incident reports related to a problem.

Determines the root cause and determines if an RFC needs to be created from specific CIs.

• Asset Management (Financial) - determines the following:— If a new CI needs to be added to the Configuration Management

system.— If an RFC is needed for the Change Management system.— If a Service Desk task needs to be created to provision and model the

new asset in the Configuration Management system.• Event Management - generates events and alerts.

Figure 1-2 EMC ITIL Service Silos and Objects

16 VERSION 2.4 REV A01 300-011-519

SUPPORTED ITIL OBJECT TYPES

Supported ITIL Object Types 1

Each transaction record has an associated object type. This may either be a built in object type (i.e., Incident) or it may be a custom type. When an item is added into the Acquisition Queue, a specified object type or an object class is used:• If the object type is specified, then that type is used. • If no object type is specified, the type of the object class is used.

Note: Not all Adapters support all objects.

The EMC Adapter may include the following built in object types:• Incident Object - includes the Incident object in the Incident Management

Service silo. The primary difference between an Incident object and an ITObject object lies in the schema. The Incident has a predetermined schema allowing all adapters to map information into common predetermined data elements, whereas the ‘ITObject’ is completely generic and all data is stored as native data.

• Problem Object - includes the Problem object type for Problem Management.

• Change Object - includes the Change object type for Change Management. This object is also known as a Request for Change (RFC).

• CI Object - includes the CI (Configuration Item) object type for Configuration Management. This provides configuration information from a CMDB.

• Event Object – includes the Event object type for Event Management.• IT Object – includes the generic objects correlating back to the endpoint

application forms that may not have any relationship to the ITIL processes. ITObject Services are used in cases where customers have created their own representation of the Incident via custom forms or have developed custom forms representing data needed to integrate between applications.


SYSTEM ARCHITECTURE

System Architecture 1

The EMC Adapter translates information from an Endpoint Application for input into a remote vendor application (and vice versa). The translation process includes the following Adapter software components identified in Figure 1-3: • Persistence Database• Web Service Methods:

— Operations Service— Acquisition Service

– Acquisition-Event Service— Notification Service

Figure 1-3 EMC Adapter System Architecture

EMC Ionix ITO

EMC Ionix ITOAdapter

18 VERSION 2.4 REV A01 300-011-519

PERSISTENCE DATABASE

Persistence Database 1

The Persistence Database is an open source, relational Apache Derby database that holds transactions in the order that they are received. Once data is received, it is assigned a transaction number and stored in the Acquisition Queue. This is necessary to ensure that each application in the integration has proper data synchronization.

The Acquisition Queue consists of two areas: • Database Acquisition Queue• Buffer Queue

Database Acquisition Queue

Each time an incident is created, modified, or closed in the Endpoint Application, the change is captured as a transaction. This transaction data is stored in the Database Acquisition Queue, which is periodically polled by the EMC Ionix IT Orchestrator. When polled, the transaction data is packaged into an XML document and sent to the Ionix IT Orchestrator via HTTP/HTTPS. The Ionix IT Orchestrator processes the transaction via its workflows and provides the data to the Operations Service of one or more remote Adapters to facilitate platform integration.

After the transaction is successfully processed, the Ionix IT Orchestrator acknowledges the transaction in the queue, so it can be removed. The Ionix IT Orchestrator can optionally acknowledge the transaction as errors based on workflow thresholds. Transactions acknowledged as “complete” or “errors” are no longer available when polled.

Buffer Queue

The Buffer Queue stores records on disk until there is room in the database for them. This allows the Adapter to perform more effectively with larger loads. Instead of records going into the database directly, they are stored to the file system when the number of database records exceeds the configuration option acquisition.bufferqueue.limit (default 200).

The Buffer Queue stores records waiting to be put in the database in the data/queue/buffer directory. When the buffer is active, it starts a background thread to push data into the database. Order of the records is maintained. The files in the directory should not be modified while the adapter is running.

This also provides a store-forward like capability for the Adapters similar to the agents. If the database is down, the Buffer Queue is also engaged


WEB SERVICE METHODS

Web Service Methods 1

EMC Adapters handle communication with the actual ITSM Endpoint Application. EMC Adapters provide a common set of Web Services methods:• Acquisition Service - acquire transaction information from the ITSM

applications.• Operational Service - create, update, or search and retrieve information

within the ITSM applications.

EMC Adapter Acquisition and Operational Services are consumed by processes running in the EMC Ionix IT Orchestrator.

Notification Agent

The majority of the EMC Ionix IT Orchestrator Adapters require an Agent to send notifications to the Adapter from the Endpoint Application.

The IBM OMNIbus adapter uses the URL Agent to send notifications. For more information on the URL Agent, refer to “Using the URL Agent” on page 7-113.

Figure 1-4 Adapter Web Service Methods

EMCIonix ITO

20 VERSION 2.4 REV A01 300-011-519

ACQUISITION SERVICE

Acquisition Service 1

The Acquisition Service provides access to objects that have changed in endpoint applications. All of the data is stored in a Persistence Queue. Acquisition is the process that allows the Adapter to react to the creation, modification, or closure of an incident and place that information into the Persistence Database queue. The EMC Ionix IT Orchestrator polls the transactions from the Persistence Database queue. Then the Ionix IT Orchestrator processes and sends the transactions to the target application(s).

The same Acquisition Service is used for all object types and polling can be restricted to certain object types.

Process Flow

Figure 1-5 displays a detailed architectural view and Acquisition process flow for the EMC Adapter. This process allows the EMC Ionix IT Orchestrator to receive and manage transaction data stored in the Persistence Database queue.

The process consists of the following steps:1. The Ionix IT Orchestrator sends a Transaction Management request to the

Acquisition Service.2. The Acquisition Service queries the Persistence Database queue for

transaction data.3. The Persistence Database sends the transaction back upstream to the Ionix IT

Orchestrator.Figure 1-5 Acquisitions Process Flow

EMC Ionix ITO



ACQUISITION SERVICE

Acquisition Push

The Acquisition Push mechanism provides lifecycle management of adapter queue transactions. It allows the workflow developer to write workflows to handle transactions only. The Acquisition Push mechanism handles the following functions: • Performs the polling operations. It polls in groups of 50 at a time, which it can

execute in parallel. Only one thread performs polling. • Allows a configurable number of threads to be used to process transactions. • Performs a complete operation when a workflow successfully executes. • Performs a retry if it cannot connect to Ionix IT Orchestrator or if there is an

error. Has a configurable number of retries (defaults to 60). If the retries count is exceeded, the transaction is put into a resolvable error state.

• Automatically notifies the Monitoring Server of errors that occur and logs the errors.

• Allows the workflow creator to optionally use blocking or error functionality manually. This allows for using this mechanism for simple processes but gives the full acquisition service capability where required.

• If Ionix IT Orchestrator is detected to be down (planned or otherwise), the mechanism will wait for Ionix IT Orchestrator service to return rather than continually generating errors.

Terminology

• Buckets - The acquisition push mechanism uses the concept of 'buckets' to parallelize processing. A blocking key is the unique combination of 'serviceId', 'objectType' and 'objectId'. This is used as the criteria for blocking on the acquisition queue. The push mechanism takes results of a poll and breaks it up into separate groups known as buckets. One bucket is created for each blocking key in the poll. If all records are for unique IDs in the endpoint application, then each bucket will have only one record in it. All buckets can be processed independent of other buckets.

• Side Effects - The acquisition push mechanism analyzes the 'side effects' of processing. The Acquisition Push will look at a transaction status and blocking to determine if it is safe to process other transactions in the same bucket. If it determines that is not safe, then it will not do further processing on the same bucket. Side effects are determined as follows: Safe to process in same bucket:— Complete: Will not be present on the queue. Get will fail. — Error: Will not show as 'Blocked'. Not Safe to process in same bucket: — Retry: Will show with transaction status of 'Poll'. — Resolvable Error: Will show as 'Blocked' — Blocked: Will show as 'Blocked'

22 VERSION 2.4 REV A01 300-011-519

ACQUISITION SERVICE

Performance

This mechanism has been optimized to perform handling of adapter queue data the best. • It only uses a single thread for polling. This reduces the idle time load on the

adapters. One problem with Ionix IT Orchestrator polling is having so many jobs continuously hitting the adapters with poll calls.

• Worker threads are used to perform simultaneous processing. Separate jobs do not need to fire on a repeat interval. When there is work in the queue to be done, it can keep all worker threads active.

• All adapter calls are handled internally and do not need to go over the wire (web services). Transactions are only pushed when they are to be run.

Acquisition–Event Service

The Acquisition-Event service is used for event mode Acquisition in conjunction with the Agent. This service receives an HTTP post on a specific URL.

The content of the post is in the format of the “Data” object. This data is mapped using a mapping script provided to the ITOM format and then is added to the acquisition queue.

Acquisition–Event Service Process Flow

Figure 1-6 illustrates the Acquisition–Event process flow for the Adapter. This process posts all the changed data to the Adapter.

The process consists of the following steps:1. The Endpoint Application sends record information to the Agent.2. The Agent sends the record information to the Acquisition-Event Service.3. The Acquisition-Event Service translates the record information into the IT

Object Model.4. The Object data is placed into the Persistence Database queue and is available

to the Acquisition Service.


ACQUISITION SERVICE

Figure 1-6 Acquisition-Event Process Flow


24 VERSION 2.4 REV A01 300-011-519

ACQUISITION SERVICE

Notification Service

The Notification Service is a RESTful service that notifies the Adapter when a particular object in the Endpoint Application has been added or changed. The notification happens by performing a POST to a specific URL (configured with each Adapter) typically by the Adapter Agent. The Notification system uses the Operational Service's get method to retrieve the object and put it into the Acquisition Queue. The Notification Service may also pass the object type to the Acquisition Queue.

The ITObject can support multiple object types from different forms. An optional parameter may be specified on the URL to the service that can indicate the object type. This is stored in an extra parameter in the Acquisition Queue called objectType.

For example, to specify the object type, use a URL in the following format:

http://localhost:9080/services/notification/{adapter}/itobject/{objectType}/{id}

Where:

• {adapter} = Adapter name. • {objectType} = desired object type for the parameter (i.e., event)• {id} = the incident record ID

When the Notification Service performs the request to retrieve the data for the id, it uses the Operations Service. For the ITObjectService, a table parameter is required that defines the “form”, “table”, “object class” or “object type”. This {objectType} specified on the URL is mapped to this table parameter in the service.

Process Flow

Figure 1-7 displays a detailed architectural view and Notification Service process flow for the EMC Ionix IT Orchestrator Adapter. This process informs the Adapter when incidents are changed or created on the endpoint application.

The process consists of the following steps:1. The Endpoint Application sends a new or modified Incident Record ID to the

Adapter Agent.2. In response, the Agent sends the ID to the Adapter Notification Service.3. The Notification Service forwards the ID to the Operations Service.4. The Operations Service sends the ID and a “get” request to the API Interface.5. The Endpoint Application sends the ID in a “get” method call on the Endpoint

Application API. The API Interface receives the Endpoint Application response, which contains all of the Incident Record information.

6. The translated incident transaction data is placed into the Persistence Database queue.


ACQUISITION SERVICE

Figure 1-7 Notification Services Process Flow

Custom Parameters for Notification or AcquisitionEvent Services

The following parameters can be added to the Notification or Acquisition-Event services to influence how a transaction is placed in the Acquisition Queue. Each of these can be added using the -a parameter when calling the Agent. These must be set using the string-field extended field type. • iwave.request.type - This parameter sets the

TransactionRecord.requestType to the value specified. • iwave.real.objectId - This parameter sets the

TransactionRecord.objectId to the value specified. This is used to override the default that uses the actual object's identifier. This is useful when a staging form is used for the record but blocking is needed based on the real objectId.

• iwave.overrides.objectType - This parameter sets the TransactionRecord.objectType to the value specified. This is used to override the default that uses the actual object's type. This is useful to define partner's object types.

• iwave.overrides.serviceId - This parameter sets the TransactionRecord.serviceId to the value specified. This is used to override the default that uses the actual object's service identifier. This is useful to set custom partner IDs.

• iwave.create.date - This parameter sets the TransactionRecord.createDate to the value specified. This must be in the XML date format as if the date-field is used however this must be a string-field for agent compatibility. The create date normally is set at the time the item enters the queue. This allows setting this date from the agent call.


26 VERSION 2.4 REV A01 300-011-519

OPERATIONS WEB SERVICE

Operations Web Service 1

An operation constitutes the process of pushing, getting, and finding data from a remote application. For example, when an incident is created, modified or closed in an application that is integrated with an endpoint application, the modified information is placed into the endpoint application. This operation effectively synchronizes an application’s data with its remote counterpart.

Process Flow

The process consists of the following steps:1. The Ionix IT Orchestrator calls the Operations Service methods to interact with

the Endpoint application’s API.2. Operations Service translates the record information from the IT Object Model

to the Endpoint application’s native record format. The native record information is sent to the Endpoint application through the API.

3. The API Interface inserts the data into the Endpoint application.4. The results from the API are translated back into the IT Object Model and

returned from the web service call.Figure 1-8 Operations Process Flow

EMC Ionix ITO Adapter



OPERATIONS WEB SERVICE

28 VERSION 2.4 REV A01 300-011-519

ABOUT THE IBM TIVOLI NETCOOL/OMNIBUS ADAPTER

About the IBM Tivoli Netcool/OMNIbus Adapter 1

The EMC Ionix IT Orchestrator Adapter uses the Java API for inserting events into the IBM Tivoli Netcool/OMNIbus application. To insert event information into the OMNIbus application, an EIF probe must be installed and configured to connect to the object server. The EMC Ionix IT Orchestrator Adapter includes the following functionality:• Requires a notification agent - The Adapter requires a Notification agent (i.e.,

URL Agent) to get data from the IBM Tivoli Netcool/OMNIbus application. • Includes a Notification Service - The Adapter includes a Notification Service

that will receive the event identifier from the Notification agent. • Performs SQL queries - The Adapter makes an SQL query to retrieve the event

field information. This eliminates the command line length restrictions for the Notification agents.

• Supports all standard operations such as create, update, clear, acknowledge.• Supports querying via native BMC query syntax.

Web Services

The Adapter exposes an Operations web service for inserting events into IBM Tivoli Netcool/OMNIbus and an Acquisition web service for retrieving outgoing IBM Tivoli Netcool/OMNIbus events located in the acquisition queue. The Adapter will also expose a notification service for getting alert information out of IBM Tivoli Netcool/OMNIbus.

Operation Services

The Operations web service provides the capability to create, update and insert events into IBM Tivoli Netcool/OMNIbus. There will be two options for inserting event information into IBM Tivoli Netcool/OMNIbus:• Send a synchronous response - One option is to have it wait for the

operation to complete and send a synchronous response. • Send an asynchronous response - The other option is to have it return

immediately and send the updated data in an asynchronous response.

Synchronous

To insert event data using the synchronous option, a procedure must be added in IBM Tivoli Netcool/OMNIbus to invoke the notification agent and a trigger must be added to invoke the procedure for any events that need a synchronous response.

An external application such as the Automator starts the process by submitting an event create/update request to the Operations web service. The Operations web service invokes the Java API to perform the insertion. It suspends and waits for the response event from the Agent.



After the event is created or updated in the OMNIbus server, the Agent is invoked to send the event identifier to the Notification Service. The Notification Service retrieves the data for the event and the event information is sent to the suspended operations task. When this happens, the operations task generates a response and sends it to the request originator.

Asynchronous

To insert event data using the asynchronous option, a procedure must be defined that invokes the Agent and a trigger must be added to invoke the procedure to send the event data to the Notification Service. An external application such as Automator starts the process by submitting an event create/update request to the operations web service. The web service invokes the Java API to perform the insertion. It then immediately returns a successful response to the request originator.

After the event is created/updated in OMNIbus, the rule fires that sends the event to the Notification Service. The Notification Service retrieves the event data, converts the event to an ITOM event and places the data in the acquisition queue. The external application that submitted the original request eventually polls the event data from the acquisition queue.

Acquisition Service

The Acquisition web service provides the capability to get new and updated events from OMNIbus. The Acquisition web service will be used to retrieve outgoing OMNIbus events located in the acquisition queue.

Notification Service

When an activity occurs that causes an OMNIbus trigger to fire, the Agent is invoked and sends the event identifier to the Notification Service. When the service gets the event data, it retrieves the event from the OMNIbus server, converts it to an ITOM Event object and places it in the Acquisition queue.

TEC EIF Probe

The TEC EIF probe provides a Java API for inserting events into OMNIbus. Events are inserted without any distinction between create and update operations. The probe rule that handles events must determine whether the event is new or an update to an existing event.

EIF Probe Rule File

To insert events using the EIF probe, the probe rules file must be modified to include an Adapter-specific rules file.

The Adapter probe rule provides the basic functionality of the default EIF probe rule. The basic difference between the Adapter rule and the default rule is the repeat count is handled differently. The Adapter probe will only

30 VERSION 2.4 REV A01 300-011-519


increment the repeat count if the create method is called for an event that already exists.

Figure 1-9 OMNIbus Architecture



32 VERSION 2.4 REV A01 300-011-519

2Chapter
Supported Services 2
This section identifies the supported Adapter Services:• Acquisition Service Methods• Discovery Service• Operations Service Methods

Acquisition Service 2

The following services are made available to the EMC Ionix IT Orchestrator through the EMC Adapter’s Acquisition Service:• Polling Methods• Blocking Methods• Terminal Methods• General Methods

WSDL

The Acquisition Services are used to access the Adapter acquired messages on a queue. The following is the WSDL URL for the Acquisition Service:https://localhost:9443/services/AcquisitionService?wsdl

Polling Methods

While in the Acquisition Queue, transactions are assigned a polling status:• Poll - indicates the transaction has no related transactions that are Blocking

and it is available for polling. Related transactions are defined as those with the same objectType, serviceId and objectId (see the getRelated operation).

• Pending - indicates records that have been polled and are currently being processed.

• Error - indicates records that have been polled, processed and contain errors.


ACQUISITION SERVICE

The following are the supported polling methods:• poll(objectType, maxResults) - Polls the acquisition service for

transactions with the given object type. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

• pollAny(maxResults) - Polls the acquisition service for transactions. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

• pollByService(serviceId, objectType, maxResults) - Polls the acquisition service for transactions with the given service ID and object type. The maximum number of records returned is specified. This method puts the records into the blocking state and sets their status as pending. If maxResults is not specified, one record will be returned.

Blocking Methods

A blocking transaction is a transaction that is currently being processed by an instance. A blocking transaction record prevents other related records from being polled. Blocking Methods are used to identify if the transaction is blocking (TRUE) or non -blocking (FALSE). If the transaction is blocking, the blockType is identified as either Pending or Asynchronous.• block(id, message, blockType) - Sets the transaction as Blocking

and sets the blockType. Since polling automatically sets the blocking flag as TRUE, most of the time this method will just set the blocking type.

• unblock(id, message) - Sets the transaction as non-blocking. (Blocking = false)

Terminal Methods

Terminal Methods are called to signal the end of Ionix IT Orchestrator processing on a record.

• complete(id) - Acknowledges a transaction and deletes it. This used to be called acknowledgeComplete. acknowledgeList will be removed as transactions are generally handled sequentially.

• retry(id, message) - Sets the status to Poll and unblocks the transaction. This can be used to resolve and retry errors or to retry something that was polled.

• resolvableError(id, message) - Sets the status to Error and ensures that the transaction is Blocking. This is used instead of acknowledgeError. The blocking is preserved to prevent data corruption. This block type is set to Error.

34 VERSION 2.4 REV A01 300-011-519

ACQUISITION SERVICE

• error(id, message) - Sets the status to error and unblocks. This is used for final errors that were never retried. By using this method, the user allows other related transactions to be processed. Use this method with caution.

General Methods

General Methods are called to get and return transaction and blocking results.• getBlocking(maxResults) - Gets all transactions in the Blocked state.• getBlockingFor(maxResults, blockType, seconds) - Gets all

transactions in the blocked state for a number of seconds. This can be used for auditing asynchronous transactions.

• getTransaction(id) - Gets the specified transaction.• count(id) - Returns the total count of available transactions and error

transactions in the Persistence Queue.• countErrors(id) - Gets the total number of records that are in the Error

state in the Acquisition Queue. Similar to count() but for errors.• getErrors(maxResults) - Gets all transactions with the Error Status.• getRelated(id) - Gets a list of all transactions that are related to this

transaction. Related transactions are defined as ones that have the same objectType, serviceId and objectId. This is useful to get any transactions that are related to a transaction that is blocking.


DISCOVERY SERVICE

Table 2-1 identifies the formats and descriptions of the method input variables.

Notification WSDL

For the IBM OMNIbus adapter, the following Notification URLs are used:• Event Service:

http://localhost:9080/services/notification/omnibus/eventid • Error Service:

http://localhost:9080/services/notification/omnibus/errorid

Discovery Service 2

The discovery service allows you to see what web services are deployed on the adapters framework. This will list all adapter web services, Monitoring Server services and any RESTful HTTP services. The Discovery Service information can be accessed in two different ways:• through a SOAP Web Service• through a standard HTTP GET

WSDL

The following are the WSDL locations for the Discovery Service:• For SOAP:

https://localhost:9443/services/DiscoveryService?wsdl

• For HTTP GET:https://localhost:9443/services/discovery

Table 2-1 Acquisition Service Method Input Descriptions

Inputs Format Description

blocktype string This field defines the type, category, tag or state associated with the block.

id Integer Identifies the transaction ID.

maxResults Integer Identifies the maximum number of items to poll. (Default =1)

message String Text string identifying the method message.

objectType String Case sensitive ITIL Object Type (Change, CI, Problem, and Event, Incident or ITObject).

seconds Integer Identifies the number of seconds.

serviceId String Case sensitive Service ID.

36 VERSION 2.4 REV A01 300-011-519

DISCOVERY SERVICE


DISCOVERY SERVICE

38 VERSION 2.4 REV A01 300-011-519

OPERATIONS WEB SERVICE METHODS

Operations Web Service Methods 0

The OMNIbus Adapter utilizes the Operations Event Service. The Operation Service provides the ability to insert events using the ITOM Event object type.

WSDL

The following is the WSDL URL for the OMNIbus Operations Event Service:

https://localhost:9443/services/omnibus/EventService?wsdl

Event Methods

The following Event methods are supported for the OMNIbus Adapter:• create - Creates a new OMNIbus event.

— If the synchronous model is configured, the request will block until the event is created or a timeout occurs.

— If the asynchronous model is configured, the request will immediately return with a successful response.

• update - Updates an existing OMNIbus event.— If the synchronous model is configured, the request will block until the

update completes or a timeout occurs.— If the asynchronous model is configured, the request will immediately

return with a successful response.• acknowledge - This is a specialized update method that acknowledges the

event and updates the fields specified in the event parameter.— If the synchronous model is configured, the request will block until the


return with a successful response.• clear - This is a specialized update method that closes the event and updates

the fields specified in the event parameter.— If the synchronous model is configured, the request will block until the


return with a successful response.• find - This method performs an SQL query against the alerts.status table

in the Object Server. The query string must conform to the WHERE clause of an SQL statement. The SQL statement will use the following format where the <query string> is the parameter to the find method.SELECT * FROM alerts.status WHERE <query string>;


OPERATIONS WEB SERVICE METHODS

Note: If the omnibus.sql.ConnectionsAllowed parameter is set to FALSE, thismethod throws an UnsupportedOperationException.

• get - This method performs an SQL query against the alerts.status table in the Object Server for an event with the designated identifier. The SQL statement will use the following format where <id> is the parameter to the get method.SELECT * FROM alerts.status WHERE Identifier = <id>;

40 VERSION 2.4 REV A01 300-011-519

2Chapter
System Configuration 1
This chapter identifies the requirements for configuring the EMC Adapter solution and discusses the following topics:• Supported Operating Systems• System Requirements• Supported Databases

Supported Operating Systems 1

The Adapter software can be installed on the following operating systems:• Windows - NT4, 2000, XP, 2003 Server, 2008 Server• UNIX- Solaris 10 (Sparc), HP-UX 11 (Itanium), AIX• Linux - x86, x64, Kernel 2.6 (or higher)

System Requirements 1

Before you install the Adapter software, your Adapter server must meet the following system requirements.

Recommended

The following are the recommended system requirements for installing the EMC Adapter software:• CPU: Dual Core Processor running 2GHz or higher • RAM: 2 GB • Disk Space: 5 GB free disk space • Java Runtime Environment: JRE 6.0 Update 16 (or above) is recommended.

This is bundled with the Windows installer.


SUPPORTED DATABASES

Minimum

The following are the minimum system requirements for installing the EMC Adapter software:• CPU: Pentium Class or Equivalent Processor or higher • RAM: 512 MB Free • Disk Space: 2 GB free disk space • Java Runtime Environment: JRE 6.0 Update 16 (or above) is recommended.

This is bundled with the Windows installer.

Supported Databases 1

The EMC Adapter uses a relational Apache Derby database for the Persistence Queue. In addition to the Apache Derby database, the EMC Adapter supports the following external databases:• Oracle• DB2• Microsoft SQL Server

42 VERSION 2.4 REV A01 300-011-519

3Chapter
Software Installation 4
Topics covered in this section:• Overview• Configuring SSL Communications• Installing a License File• Installing the Adapter Software - Windows• Running the Adapter Windows Service• Installing Adapter Software - UNIX• Running the Adapter UNIX Service• Manual Installation Procedures


OVERVIEW

Overview 4

Based on your EMC configuration, the following components may be installed (see Figure 3-1):• EMC ITIL Adapters – includes the Adapter software and license file.• EMC ITIL Adapter Agent (Optional) – includes the Adapter URL Agent

software or custom Agent.The Agent may be installed with the Adapter on the same server or on a separate server.

• License files – are provided by EMC Customer Support and must be installed in the appropriate directory.

• EMC Ionix IT Orchestrator (Optional) – includes the Ionix IT Orchestrator software and license file.

Figure 3-1 Installation Components

EMCIonix ITO

44 VERSION 2.4 REV A01 300-011-519

CONFIGURING SSL COMMUNICATIONS

Configuring SSL Communications 3

To configure SSL communications between the Ionix IT Orchestrator and Adapter, complete the following steps.1. From the Adapter server, obtain a copy of the Adapter SSL Certificate. 2. Verify that there is not an existing or incorrect certificate already installed in

the Ionix IT Orchestrator keystore.3. Copy the hostname.cer file to the Ionix IT Orchestrator server.4. Confirm that the JAVA_HOME is set to Java 6. Once the JAVA_HOME is verified,

execute the following command to delete the existing certificate:"%JAVA_HOME%\bin\keytool" -delete -alias iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

5. Install the certificate into the Ionix IT Orchestrator keystore.6. Confirm that the JAVA_HOME is set to Java 6. Once the JAVA_HOME is verified,

execute the following command to store the certificate:"%JAVA_HOME%\bin\keytool" -import -alias iwave -v -file iwave.cer -keypass iwave -storepass changeit -keystore "%JAVA_HOME%\lib\security\cacerts"

Figure 3-2 SSL Configuration

EMCIonix IT Orchestrator



CONFIGURING SSL COMMUNICATIONS

Recommended OMNIbus Adapter Configuration

For the OMNIbus Adapter configuration, it is recommended that the URL Agent be installed on the same machine(s) where the Object Servers are installed. If the URL Agent is installed on a different machine, transactions can be dropped during a network outage.• If a low transaction volume is expected, the OMNIbus Adapter can be installed

on an Object Server machine. • If a high transaction volume is expected, it is recommended that the OMNIbus

Adapter be installed on a separate machine.

46 VERSION 2.4 REV A01 300-011-519

INSTALLING A LICENSE FILE

Installing a License File 3

When the Adapter software is purchased, a software license file (in XML format) is provided by EMC Customer Support. The license file identifies the following information for each Adapter server included in the EMC software configuration:• the types of Adapters that can be installed on the server• the Adapter software version• the expiry date for the Adapter software• the license key

During Adapter software installation, the user identifies the location of the license file. The installer then copies the license file from the original location to the following EMC Adapter installation directory:

install_root/adapters-2.4/conf


INSTALLING THE ADAPTER SOFTWARE - WINDOWS

Installing the Adapter Software Windows 3

This section identifies the steps required for installing the EMC Adapter software.

Before You Begin

Before you install the EMC Adapter software, complete the following tasks:• Identify the location of the Adapter license file.• Close all Windows applications.• Determine the type of Agent you are installing (if any).• Determine which Adapter will be installed.• Determine on which server the Adapter and Agent software will be installed. .

Start the Installer

To install the EMC URL Agent and/or Adapter software, complete the following the steps:1. Access the location of the Adapter installer executable. Double-click the

setup-Adapter-winxx_2.4.exe file. 2. The Open File - Security Warning window displays. Click Run.3. The InstallAnywhere progress screen displays.Figure 3-3 Installer Progress Screen

48 VERSION 2.4 REV A01 300-011-519


4. The progress screen displays.Figure 3-4 Progress Screen

5. After the InstallAnywhere Wizard finishes loading, the EMC Adapters Installer Introduction screen displays. From this screen, select the Next button to continue.

Figure 3-5 Introduction Screen



6. The Choose Install Set screen displays. From this screen, select the appropriate installation option. — For instructions on installing the URL Agent, refer to “Installing the

URL Agent”. — For instructions on installing your Adapter, refer to “Installing the

Adapter”.Figure 3-6 Choose Install Set

50 VERSION 2.4 REV A01 300-011-519



Installing the URL Agent

To install the URL Agent software, complete the following steps:1. From the Choose Install Set screen, select the URL Agent and corresponding

Python 2.6.1 for Windows install Set. Click Next. Figure 3-7 Install Set - URL Agent

52 VERSION 2.4 REV A01 300-011-519

2. The Choose Install Folder screen displays. To change the install folder, click the Choose button and navigate to the appropriate installation directory. Click Next.

Figure 3-8 Choose Install Folder Screen


3. The Choose Shortcut Folder screen displays. From this screen, specify the areas where the software shortcut icons will be created. Click the Next button to continue.— In a new Program Group – creates a new program group with the

specified name and includes a shortcut in the Windows All Programs list.

— In an existing Program Group – includes a shortcut in an existing program group.

— In the Start Menu – includes the Adapter shortcut in the Start menu.— On the Desktop – creates an Adapter shortcut on the desktop.— In the Quick Launch Bar – includes the Adapter shortcut in the Quick

Launch menu bar.— Other – specify a custom directory location by selecting the Choose

button.— Don’t create icons – Select this option if you do not want to create an

Adapter shortcut.— Create Icons for All Users – Select this option to create shortcuts for

all users configured on the server. The shortcuts are only added to the Start Menu and Desktop.

54 VERSION 2.4 REV A01 300-011-519

Figure 3-9 Choose Shortcut Folder Screen


4. The Preparing to Install screen displays. Click Install.Figure 3-10 Preparing to Install

56 VERSION 2.4 REV A01 300-011-519

5. The Installing Adapters screen displays. This screen displays the progress of the URL Agent installation.

Figure 3-11 Installing the Adapter


6. If you selected to have Python installed, the Python 2.6.1 Setup screen displays. Select one of the following options and click Next.— Install for users— Install just for me (not available for Windows Vista)

Figure 3-12 Python Setup

58 VERSION 2.4 REV A01 300-011-519

7. The Select Destination Directory screen displays. Click the Up and New buttons to select a directory for the Python 2.6.1 files.The default directory is Python26. Click Next.

Figure 3-13 Select a Destination Directory


8. The Customize Python 2.6.1 screen displays. Click Next.Figure 3-14 Customize Python 2.6.1

60 VERSION 2.4 REV A01 300-011-519

9. The Install Python 2.6.1 screen displays. When the installation completes, click Next.

Figure 3-15 Install Python 2.6.1


10. The Completing Python Installer screen displays. Click Finish button to complete the Python installation.

Figure 3-16 Completing Python Installer

62 VERSION 2.4 REV A01 300-011-519

11. The Install Complete screen displays. Click Done to exit the installer.Figure 3-17 Install Complete


Installing the Adapter

1. From the Choose Install Set screen, select the IBM Tivoli Netcool/OMNIbus Adapter option. Click Next.

Figure 3-18 Choose Install Set Screen

64 VERSION 2.4 REV A01 300-011-519

2. The Choose Install Folder screen displays with the default installation folder. To change the install folder, click the Choose button and navigate to the appropriate installation directory. Click Next.

Figure 3-19 Choose Install Folder Screen


3. The Choose Shortcut Folder screen displays. From this screen, specify the areas where the software shortcut icons will be created. Click the Next button to continue.— In a new Program Group – creates a new program group with the

specified name and includes a shortcut in the Windows All Programs list.

— In an existing Program Group – includes a shortcut in an existing program group.

— In the Start Menu – includes the Adapter shortcut in the Start menu.— On the Desktop – creates an Adapter shortcut on the desktop.— In the Quick Launch Bar – includes the Adapter shortcut in the Quick

Launch menu bar.— Other – specify a custom directory location by selecting the Choose

button.— Don’t create icons – Select this option if you do not want to create an

Adapter shortcut.— Create Icons for All Users – Select this option to create shortcuts for

all users configured on the server. The shortcuts are only added to the Start Menu and Desktop.

Figure 3-20 Choose Shortcut Folder Screen

66 VERSION 2.4 REV A01 300-011-519

Note: If you choose not to create a menu shortcut, you can start the Adapterframework using the startAdapters.bat file. This file is located in theinstall_root\bin directory.

4. The Choose License File screen displays. From this screen, verify that the license file location identified in the Please Choose License File field, is correct. To change the license file location, select the Choose button and select the appropriate directory. Click Next.

Figure 3-21 Choose License File Screen


5. The Enable Security screen displays. On this screen, the Use HTTPS (port 9443) check box is selected by default. This option uses SSL for secure Web-based communications. To use standard unsecured HTTP Web-based communications, un-check this box. Click Next.

Figure 3-22 Enable Security screen

68 VERSION 2.4 REV A01 300-011-519

6. The Web Service Authentication screen displays. From this screen, enter the Username and Password you want to use for authentication. You must enter the password twice for confirmation purposes. Click Next.

Figure 3-23 Web Services Authentication


7. The Monitoring Server Configuration screen displays. Based on your Adapter configuration, determine the appropriate step to complete:— If you are monitoring the Adapter with the Monitoring Server and the

Monitoring Server is on a different host from the Adapter, select the Specify host for Monitoring Server checkbox. Identify the following information and click Next:– URL - identifies the URL location of the Monitoring Server.– Username - identifies the username for the Monitoring Server.– Password - identifies the password associated with the username.

— If you are not using a Monitoring Server or your Monitoring Server is running on the same server as the Adapter, leave the checkbox unchecked. Click Next.

Figure 3-24 Monitoring Server Configuration

70 VERSION 2.4 REV A01 300-011-519

8. The Pre-Installation Summary screen displays. Using the scroll bar, review the information before continuing the installation process.— If the information is correct, click Next.— If the information is incorrect, click Previous and change the

configurations on the previous screen. Click Next when done.Figure 3-25 Pre-Installation Summary


9. The Adapters Configuration screen displays. Click Next.Figure 3-26 Adapters Configuration

72 VERSION 2.4 REV A01 300-011-519

10. The OMNIbus Synchronous or Asynchronous screen displays. From this screen, select whether Asynchronous or Synchronous mode will be used. Click Next.— If Synchronous is selected, the Adapter will wait until the operation

completes before returning a response to the request orginator. The response will contain the new/updated event information.

— If Asynchronous is selected, the Adapter will return immediately without any event information. When the request is completed, an asynchronous transaction will be generated that will be picked up when polling for new transactations.

Figure 3-27 OMNIbus Synchronous or Asynchronous Configuration


11. The OMNIbus Common Properties screen displays. Enter the Service ID to specify when placing events into the acquisition queue. Click Next.

Figure 3-28 OMNIbus Common Properties

74 VERSION 2.4 REV A01 300-011-519

12. The OMNIbus SQL Connection Properties screen displays. Provide the following information and click Next.— Username - identifies the username that the Adapter specifies when

connecting to the Object Server for SQL queries.— Password - identifies the password that the Adapter specifies when

connecting to the Object Server for SQL queries.— URL- identifies the URL that the Adapter specifies when connecting to

the Object Server for SQL queries. When specifyig the URL, substitute <hostname> and <port> for the hostname and port used by the primary OMNIbus object server.

— Backup URL - identifies the URL of the backup object server. When specifyig the URL, substitute <hostname> and <port> for the hostname and port used by the backup OMNIbus object server. The backup object server will be used if the primary server connection fails. If there is no backup server configured, leave this field blank.

Figure 3-29 OMNIbus SQL Connection Properties


13. The OMNIbus Probe Properties screen displays. The Adapter inserts events into OMNIbus application via an EIF probe. The probe can be configured as a standalone or as a master/slave pair. — If it is configured as standalone, specify only the Master Probe

information. — If it is configured as a master/slave pair, specify the Master Probe and

Slave Probe information.From this screen, provide the following information and click Next.— Master Probe Server Location - specifies the hostname or IP address

where the master probe is installed. (Required)— Master Probe Port - specifies the port number that the master probe

is monitoring. (Required)— Slave Probe Server Location - specifies the hostname or IP address

where the slave probe is installed.— Slave Probe Port - specifies the port number that the slave probe is

monitoring.Figure 3-30 OMNIbus Probe Properties

76 VERSION 2.4 REV A01 300-011-519

14. The Preparing to Install screen displays. Click Install.Figure 3-31 Preparing to Install


15. The Installing Adapters screen displays. This screen displays the progress of the installation process. During this step, the Windows Service is installed and a keystore file is generated for SSL.

Figure 3-32 Installing the Adapter

78 VERSION 2.4 REV A01 300-011-519

16. The Start Service screen displays. From this screen, select the Start the Adapter Service checkbox if you want to start the Adapter service during the installation process.

If you do not start the Adapter Service during installation, the Adapter service can be started manually. For more information on starting and stopping the Windows Service, refer to "Running the Adapter Windows Service" on page 83. Click Next.

Figure 3-33 Start Service


17. If you selected the Start the Adapter Service option, the following screen displays.

Figure 3-34 Starting the Adapters Service

80 VERSION 2.4 REV A01 300-011-519

18. The Install Complete screen displays. Click Done to exit the installer.Figure 3-35 Install Complete


82 VERSION 2.4 REV A01 300-011-519

RUNNING THE ADAPTER WINDOWS SERVICE

Running the Adapter Windows Service 3

The Adapters Windows Service is automatically installed during the installation process and if selected, is automatically started, as well.

Shortcuts

Based on which option was selected during installation, shortcuts may be provided from the Windows Start menu for starting and stopping the Windows Service.• To start the Adapters Service, select Start>All

Programs>install_root>adapters-2.4>Start Adapters Service.• To stop the Adapters Service, select Start>All

Programs>install_root>adapters-2.4>Stop Adapters Service.

Executable Location

Two executable files are provided for interacting with the Windows Service:• adapters.exe: The main executable that launches the service.• adaptersw.exe: The executable for starting the Service Manager application.

These files are located in the installation bin directory:install_root/bin

Service Manager Application

The Service Manager application is an application that allows you to configure options of the service such as turning on debugging. The service can also be started and stopped from this console.

To start the Manager application, double-click on the adaptersw.exe file. The Adapters Properties screen displays (see Figure 3-36).


RUNNING THE ADAPTER WINDOWS SERVICE

Figure 3-36 Adapters Properties - Services Manager Console

84 VERSION 2.4 REV A01 300-011-519

INSTALLING ADAPTER SOFTWARE - UNIX

Installing Adapter Software UNIX 3

Before You Begin

Before installing the Adapters on the UNIX platform, you must complete the following tasks:• For UNIX platform:

— Install the Java Runtime Environment (JRE) 6 Update 11. — Java 6 must be installed and run on the local computer. If multiple Java

platforms are present on the local computer, make sure that %JAVA_HOME% points to Java 6 when running the Adapter.

• For both UNIX and Linux (optional):— Create an “admin” user for running the framework.

Installing the Software

To install the Adapter software on a UNIX platform, run the appropriate setup application from the Linux or UNIX prompt.• Linux Installer: setup-Adapter-linux_2.4.bin• Other UNIX Platforms: setup-Adapter-unix_2.4.bin

Running the Adapter UNIX Service 3

The bin/service.sh script starts and stops the framework as a service. A special file service.PID is created when the service is started. This is used to find the PID of the running service. Do not delete this file manually.

• Starting the service: ./service.sh start• Stopping the service: ./service.sh stop• Restarting the service: ./service.sh restart• Service Status:./service.sh status

If you wish the service to start automatically at boot time, the following is a sample init.d script you can use to call the service.sh script:

#!/bin/shIWAVE_USER=adminIWAVE_SERVICE=/usr/IonixITO/adapters-2.4/bin/service.shsu - ${IWAVE_USER} -c "$IWAVE_SERVICE" $1


MANUAL INSTALLATION PROCEDURES

Manual Installation Procedures 3

If an installation is being performed on an unsupported operating system, the EMC Adapter can be installed manually without the installer.

Before You Begin

Before manually installing the Adapter software, you must complete the following tasks:• Ensure that you are installing on either a Windows or UNIX platform.• Java 6 must be installed and run on the local computer. If multiple Java

platforms are present on the local computer, make sure that %JAVA_HOME% points to Java 6 when running the EMC Adapter.

• An Adapter license file (license.xml) must be copied to the install_root\conf directory. If you do not have a license file for your Adapter, contact your EMC Sales Representative.

Install the Files

To install the files manually on a Windows or UNIX platform, complete the appropriate steps.

For Windows:

1. Contact EMC Customer Support and request a zipped copy of the Adapter installer to be placed on the EMC FTP site.

2. From the Adapter server, download the zipped file.3. Unzip the file and place the extracted file(s) in any directory on any machine

with network access to the computer running the endpoint application.

Note: For Windows installations, there are no registry keys to edit. Thelocation of these files is referred to as %IonixITO_HOME%.

For UNIX and Linux:

1. Contact EMC Customer Support and request a tarred/zipped copy of the Adapter installer to be placed on the EMC FTP site.

2. From the Adapter server, download the tarred/zipped file in binary format. Place the .zip file in the directory where you want the software installed. For example: /opt/EMC

3. Extract the files included in the zip file. This will create an adapters directory with several sub directories.jar xfv adapter-2.4.zip

86 VERSION 2.4 REV A01 300-011-519

MANUAL INSTALLATION PROCEDURES

4. Change to the adapters/conf directory. 5. Copy your license file to the conf directory. Ensure that the license file is

named license.xml.6. Change to the adapters/endpoints directory. Access the directory for

your endpoint adapter.7. Copy the endpoint-spring.xml file to the adapters/conf directory.8. Using the propertiesEditor.bat utility, modify the following

parameters in the framework.properties file.— framework.username

— framework.password - use the -h option when setting the password.

— endpoint.datasource.jdbc.url

— endpoint.datasource.jdbc.username

— endpoint.datasource.jdbc.password

—

9. Change to the adapters/bin directory10. Run the setup.bat script.

./setup.bat

11. Install the Adapter as a service. ./service.bat install

12. Start the adapters service.13. After a few seconds, change to the adapters/log directory and view the

framework.log file. At the bottom of the file, the log should indicate that the adapter framework has started.


4Chapter
Framework Properties 1
During installation, the framework.properties file is installed in the conf directory. The framework.properties file includes configuration parameters for the Adapter Framework. Any parameters specified in this file are automatically recognized by the external (framework.xml) and internal (inside the framework jars) spring configurations. These parameters allow the base configuration to be used and only a few parameters should be changed.

The framework.properties file is in the standard Java Properties format. The file can be edited using a text editor or the properties in the file can be edited using the PropertiesEditor command.

The properties in the framework.properties file that are encrypted are shown in the format: "ENC;XXXXX" where XXXXX is the encrypted data.

Note: The Properties Editor tool is only capable of creating these propertiesand not reading them.

Properties Editor Tool 1

The Properties Editor is a tool used to edit configuration properties in the framework.properties file. This command allows encrypted parameters to be specified.

Starting the Tool

To start the Properties Editor tool, execute the following batch file or shell script from the command line:• For Windows: bin/propertiesEditor.bat

• For Unix: bin/propertiesEditor.sh


PARAMETERS

Using the Command

When entering the PropertiesEditor command, multiple options can be specified in a single invocation of the command.

Usage

PropertiesEditor [options] <target-file>

Options

-p <key>=<value> Sets a property with the key and value specified in plain text.

-e <key>=<value> Sets a property with the key and value specified in encrypted data.

-h <key>=<value> Sets a property with the key and value specified in SHA-1 Hashed format. This is used for framework passwords.

-m <file> Merges multiple properties from the file specified to the target file.

Examples

The following are examples of using the Properties Editor tool: • To set the framework username and password for authentication, enter the

following command:bin/propertiesEditor.bat -p framework.username=admin -h framework.password="Hashed String" conf/framework.properties

• To set the Adapter hostname, username and password, enter the following command:bin/propertiesEditor.bat -p adapter.host=hostname -p adapter.username=Demo -e adapter.password=password conf/framework.properties

Parameters 1

The framework.properties file includes two types of properties:• global framework properties• Adapter-specific properties

Global Framework Properties

These global framework properties are automatically configured for all Adapters.


PARAMETERS

Framework Authentication

The following properties are used for the Web Services HTTP authentication:• framework.username - Username to log into the provided web services.• framework.password - Password to log into the provided web services.• framework.admin.password - Administrator password to restart the

adapters over JMX.• framework.auth.enabled - If this is set to true, authentication will be

required. (Default: true)

Default base URLs to Exposed Services

The following properties configure the base URLs for the Adapter services:• services.url - Base URL for all adapter operations services (https://

${hostname}:9443/services).• client.url - Base URL for client acquisition service (https://

${hostname}:9443/services).• notification.url - Base URL for notifications (http://

${hostname}:9080/services/notification).• acquisitionevent.url - Base URL for acquisition events (http://

${hostname}:9080/services/acquisition-event).

DataSource Properties

The following properties can be modified to enable support for another database instead of the default (Derby) Persistence database:• datasource.jdbc.driver – identifies the database driver (i.e.,

com.microsoft.sqlserver.jdbc.SQLServerDriver). • datasource.jdbc.url – identifies URL to the database (i.e.,

jdbc:sqlserver://hostname:1433;DatabaseName=testdb). • datasource.jdbc.username - identifies the username to log into the

database.• datasource.jdbc.password – identifies the password associated with

the database username. If required, the password can be encrypted.

Database Monitoring

The following properties can be modified to enable monitoring tasks on the database. Only one Adapter per database can have this enabled.• datasource.monitor.enabled - identifies if database monitoring is

enabled. (Default: true)

90 VERSION 2.4 REV A01 300-011-519

PARAMETERS

Acquisition monitoring

The Adapters automatically send the adapter.acquisition.queuesize and adapter.acquisition.queuewait events to the Monitoring Server based on the health of the Adapter queue. The following parameters are used to configure Acquisition monitoring. • acquisition.monitor.enabled - identifies if Acquisition monitoring is

enabled. (Default: true)• acquisition.monitor.queue-threshold - identifies the number of

items allowed in the queue before the queuesize event is sent. (Default: 500)

• acquisition.monitor.queue-wait-hours- identifies the number of hours an item must be on the queue before the queuewait event is sent (Default: 24)

• acquisition.bufferqueue.limit - identifies the maximum number of items that are allowed in the buffer queue. (Default: 500)

Automated Alerts

If the Monitoring Server is on a different host from the Adapter, the following configuration are updated to include the connection settings for the Monitoring Server. These parameters identify the location to send automated alerts. If you are using a Monitoring Server and it is installed on the same server as your Adapter, leave these parameters blank.• framework.events.url - identifies the Monitoring Server URL location

to send events.• framework.events.username - identifies the Monitoring Server

username for basic authentication.• framework.events.password - identifies the password associated with

the Monitoring Server username. The password can be encrypted.


OMNIbus Parameters

The framework.properties file includes the following OMNIbus parameters:• Common Properties• SQL Connection Parameters• EIF API Master Probe Parameters• EIF API Slave Probe Parameters• Synchronous Model Properties

Common Properties

The properties identified in the section are common regardless of the failover mode. All of these properties have default values that will be good for most configurations.• omnibus.serviceId - identifies the service ID to specify when placing

events into the acquisition queue. (Default: omnibus)

SQL Connection Parameters

The following properties are used to define the connection parameters for accessing the Object Server database. • omnibus.sql.user - identifies the username that the adapter should

specify when connecting to the Object Server for SQL queries.• omnibus.sql.password - identifies the password that the adapter

should specify when connecting to the Object Server for SQL queries.• omnibus.sql.url - identifies the URL that the Aadapter specifies when

connecting to the Object Server for SQL queries.• omnibus.sql.backupUrl - identifies the URL the Adapter uses when an

SQL query attempt fails to connect to the primary server. • omnibus.sql.driver - identifies the name of the driver the Adapter

specifies when connecting to the Object Server for SQL queries.

EIF API Master Probe Parameters

The following parameters are used to configure access to the EIF API for the master probe. The parameters for the master probe must be specified regardless of the probe configuration. Parameters that have a default value specified can be omitted and the default value will be used.• omnibus.probe.master.BufferEvents - specifies whether an event

should be buffered if a connection cannot be made to the probe. (Default: NO)

• omnibus.probe.master.ConnectionMode - specifies how to connect to the API. This parameter defaults to connection_oriented causing it to connect once and leave the connection open.

92 VERSION 2.4 REV A01 300-011-519

• omnibus.probe.master.RetryInterval - specifies the time (in seconds) to wait before attempting to open a new connection after an existing connection is lost. (Default: 30 seconds).

• omnibus.probe.master.TransportList - specifies the user-supplied names of the transport mechanisms (used as a prefix in the next two parameters). (Default: tl).

• omnibus.probe.master.t1Type - specifies the transport type for the connection. (Default: SOCKET).

• omnibus.probe.master.t1Channels - specifies the user-supplied names of the channels for the transport mechanism for the next two parameters. (Default: t_ ).

• omnibus.probe.master.t_ServerLocation - specifies the hostname or IP address where the master probe is installed.

• omnibus.probe.master.t_Port - specifies the port number that the master probe is monitoring.

EIF API Slave Probe Parameters

The following parameters are used to configure access to the EIF API for the slave probe. These parameters are only specified when the EIF probe is configured in a peer-to-peer failover configuration. Parameters that have a default value specified can be omitted and the default value will be used.• omnibus.probe.slave.BufferEvents - specifies whether an event

should be buffered if a connection cannot be made to the probe. (Default: NO)

• omnibus.probe.slave.ConnectionMode - specifies how to connect to the API. This parameter defaults to connection_oriented causing it to connect once and leave the connection open.

• omnibus.probe.slave.RetryInterval - identifies the time (in seconds) to wait before attempting to open a new connection after an existing connection is lost. (Default:30 seconds)

• omnibus.probe.slave.TransportList - identifies the user-supplied names of the transport mechanisms (used as a prefix in the next two parameters). (Default: tl)

• omnibus.probe.slave.t1Type - identifies the transport type for the connection. (Default: SOCKET).

• omnibus.probe.slave.t1Channels - identifies the user-supplied names of the channels for the transport mechanism for the next two parameters. (Default: t_).

• omnibus.probe.slave.t_ServerLocation - identifies the hostname or IP address where the slave probe is installed.

• omnibus.probe.slave.t_Port - identifies the port number that the slave probe is monitoring.


Synchronous Model Properties

The following parameters are used to configure the adapter to operate in synchronous mode. These parameters are ignored if the asynchronous model is used. • omnibus.synchronousTimeout - identifies the amount of time (in

seconds) the adapter waits for a synchronous response before timing out. (Default: 60 seconds)

• omnibus.event.correlationFields - identifies the fields that are used to correlate an event to a pending request. (Default: Identifier).

• omnibus.event.altCorrelationfields - identifies additional fields that can be used to correlate an event to a pending request. Whenever the notification service looks for pending synchronous requests, it first looks at the fields specified in the omnibus.event.correlationFields parameter. If a match is not found, it looks at the fields specified in this parameter for a match. (Default: Node AlertKey AlertGroup Type Agent Manager).

Figure 4-1 Example Framework Properties file - OMNIbus

## OMNIbus Adapteromnibus.synchronousTimeout=60omnibus.serviceId=omnibusomnibus.event.correlationFields=Identifieromnibus.event.altCorrelationFields=Node AlertKey AlertGroup Type Agent Manageromnibus.sql.user=omnibus.sql.password=omnibus.sql.url=jdbc:sybase:Tds:localhost:4100?JCONNECT_VERSION=6omnibus.sql.backupUrl=omnibus.sql.driver=com.sybase.jdbc2.jdbc.SybDriveromnibus.probe.master.t_ServerLocation=localhostomnibus.probe.master.t_Port=9999

94 VERSION 2.4 REV A01 300-011-519

5Chapter
Configuring OMNIbus 1
After installation, the following configurations must be made by the administrator:• Copy the Required JAR Files• Modify Script files to Identify the URL Agent Location• Install the NCO Process Agent• Configure the EIF Probe Rules File• Configure the Object Server

Copy the Required JAR Files 1

The OMNIbus Adapter requires the following JAR files to be copied to the lib/adapters directory:• log.jar - used by the EIF probe• evd.jar - used by the EIF probe• jconn2.jar - Sybase JDBC driver file

To copy the appropriate JAR files, complete the following steps:

1. From the Adapter server, access the following directory:— For Windows:

%OMNIHOME%\probes\platform

— For UNIX:$OMNIHOME/probes/platform

Where:— platform = the actual platform name (i.e., win32).

2. Copy the log.jar and evd.jar files to the lib/adapters directory.3. Access the following URL to download the Sybase JDBC driver file:

http://downloads.sybase.com/swd/summary.do?client=support&baseprod=63

4. You will be required to create an account in order to download the driver. After you have created an account, you will need to select All from the pull-down list next to Display and "in all months" next to platforms.


MODIFY SCRIPT FILES TO IDENTIFY THE URL AGENT LOCATION

5. Click Go to get a list of drivers available for download. 6. Select jConnect for JDBC - EBF 13904: 5.5 ESD #22 and download. 7. The EBF13904.tgz file will be downloaded. This file includes the

jconnect55.zip file. The jconn2.jar file is located in this zip file in the jconnect55/jConnect-5_5/classes directory.

8. Copy the jconn2.jar file to the lib/adapters directory.

Modify Script files to Identify the URL Agent Location 1

After the URL Agent and the Adapter are installed, the following steps must be completed on each machine where the URL Agent is installed.

1. From the Adapter installation directory, access the endpoints/omnibus sub-directory.

2. Based on the Adapter OS and model (synchronous/asynchronous), copy the appropriate script files to the Agent installation directory.— For Windows:

– synchronous - iwave_send.cmd, iwave_error.cmd– asynchronous - iwave_send.cmd

— For UNIX:– synchronous - iwave_send.sh, iwave_error.sh– asynchronous - iwave_send.sh

3. Using a text editor, open each file that was copied and make the following changes:— Replace all instances of the <AGENT> placeholder with the full path

where the Agent was installed.

Note: If the full pathname contains spaces, the pathname must be enclosedin double quotes.

— Replace all instances of the <HOSTNAME> placeholder with the hostname or IP address of the machine where the OMNIbus Adapter was installed.

— Replace all instances of the <PORT> placeholder with the listen port being used by the OMNIbus Adapter. The default port for HTTP is 8080 and the default port for HTTPS is 8443.

— If the HTTPS protocol was specified when the OMNIbus Adapter was installed, change the HTTP protocol in the URL to HTTPS.

4. Save and close the file.

96 VERSION 2.4 REV A01 300-011-519

INSTALL THE NCO PROCESS AGENT

Install the NCO Process Agent 1

In order to allow the OMNIbus Adapter to invoke the URL Agent, the NCO Process Agent must be installed and running on each Object Server machine where the URL Agent is installed. Refer to the OMNIbus documentation for information on installing and running the Process Agent.

Configure the EIF Probe Rules File 1

The administrator will have to manually change the configuration of the EIF probe to set it up for accepting alerts from the OMNIbus Adapter. The existing EIF probe rules file must be modified by the administrator to include the probe rules file.

Note: If the probes are configured to operate in a master/slave pair, thesechanges will be required for each probe.

To install the new rules file, perform the following steps: 1. Shut down the EIF probe.2. Access the EIF probe installation directory.3. Make a backup copy of the existing tivoli_eif.rules file. 4. Modify the tivoli_eif.rules file as follows:

a. Insert the following statements before any other executable statements. defaultAlerts = registertarget("<PRIMARY>", "<BACKUP>", "alerts.status")iWaveAlerts = registertarget("<PRIMARY>", "<BACKUP>", "custom.iwave_status")

b. Replace <PRIMARY> with the name of the primary object server. c. Replace <BACKUP> with the name of the backup server. If a backup is not

configured, replace it with an empty string so that the backup server is "".d. In the location where the tivoli_eif_tpc.rules and

tivoli_eif_tsm.rules are included, add an include statement for the iwave_eif.rules file.

5. Save the tivoli_eif.rules file.6. Copy the iwave_eif.rules file to the EIF probe install directory 7. Make sure the tivoli_eif.props file has the Inactivity parameter

set to 0.8. Restart the EIF probe.


CONFIGURE THE EIF PROBE RULES FILE

Figure 5-1 Example tivoli_eif.props File#1. De duplicate events#2. Generic-Clear to correlate Problems/Resolutions#3. Readable alarm summaries######################################################################## Available elements:#$ClassName - Class name of the TEC event#$EventSeqNo - Event sequence number of this event#All other elements are dynamically created, based on the name/value#pairs in the event.#######################################################################defaultAlerts = registertarget("NCOMS", "", "alerts.status")iWaveAlerts = registertarget("NCOMS", "", "custom.iwave_status")

array servers;array server_info;array server_detail;

if( match( @Manager, "ProbeWatch" ) ){ switch(@Summary) { case "Running ...": @Severity = 1 @AlertGroup = "probestat" @Type = 2 case "Going Down ...": @Severity = 5 @AlertGroup = "probestat" @Type = 1 default: @Severity = 1 } @AlertKey = @Agent @Summary = @Agent + " probe on " + @Node + ": " + @Summary}else{switch($source){case "dummy case statement": ### This will prevent syntax errors in case no includes are added below.

include "tivoli_eif_tpc.rules"include "tivoli_eif_tsm.rules"include "iwave_eif.rules"

default:

@Manager = "tivoli_eif probe on " + hostname()@AlertGroup = $ClassName@Class = 6601@Agent = $source@Type = 1@Grade = "1"

if(exists($msg)){if(regmatch($msg, "^'.*'$")){$msg = extract($msg, "^'(.*)'$")

98 VERSION 2.4 REV A01 300-011-519

CONFIGURE THE OBJECT SERVER

Configure the Object Server 5

The administrator must execute the appropriate SQL command file to make the necessary configuration changes to each Object Server being integrated. Based on the model (asynchronous/synchronous), the following files are available:• For asynchronous model:

configure_iwave_adapter_async.sql

• For synchronous model:configure_iwave_adapter_sync.sql

To configure the Object Server, complete the following tasks:1. Modify the SQL command.2. Execute the SQL command.

Modify the SQL Command

Before you can execute the file, the file must be modified accordingly:1. Copy the appropriate file from the endpoints/omnibus directory in the

Adapter install directory to a machine where the Object Server is installed. 2. Using a text editor, edit the file and make the following changes:

— <AGENT> - Replace this text with the absolute path where the URL Agent is installed.

Note: For Windows installation, the Agent directory names must beseparated by two backslashes instead of one. For example, the defaultinstall path would be C:\\IonixITO\\agent.

— <HOSTNAME> - Replace this text with the hostname of where the URL Agent is installed.

— For UNIX systems, change the file name extension of the executable scripts (iwave_error, iwave_send) from.cmd to .sh.

Note: The asynchronous file contains only the iwave_error code. Thesynchronous file has both the iwave_send and iwave_error code.

Figure 5-2 Example iwave_send Code

CREATE OR REPLACE PROCEDURE iwave_send(in Serial INTEGER, in Source CHAR(64))EXECUTABLE '<AGENT>iwave_send.cmd'HOST '<HOSTNAME>'USER 0GROUP 0ARGUMENTS Serial, Source;


CONFIGURE THE OBJECT SERVER

Figure 5-3 Example iwave_error Code

3. Save the file.

Execute the SQL Command

The appropriate SQL command line utility must be used to execute the commands in the file. When entering the commands, provide the following information:• copy_directory - the directory where the

configure_iwave_mode.sql file was copied. • objserver - the Object Server hostname.• username - the username used to access the Object Server.• password - the password associated with the username.• mode - the mode for the command (sync or async).

For UNIX:

1. Execute the following command:$OMNIBUSHOME/bin/nco_sql -S objserver -U username -P password -i copy_directory/endpoints/omnibus configure_iwave_adapter_mode.sql

For Windows:

1. Execute the following command:“%OMNIBUSHOME%\bin\isql" -S objserver -U username -P password -i “copy_directory\configure_iwave_adapter_mode.sql”

CREATE OR REPLACE PROCEDURE iwave_error(in Serial INTEGER)EXECUTABLE '<AGENT>iwave_error.cmd'HOST '<HOSTNAME>'USER 0GROUP 0ARGUMENTS Serial;

100 VERSION 2.4 REV A01 300-011-519

DISABLE CONNECT AND DISCONNECT EVENT GENERATION

Disable Connect and Disconnect Event Generation 5

By default, two events are generated each time the OMNIbus Adapter retrieves the data for an event. If all events are forwarded to the OMNIbus Adapter, this will cause the number of events to grow exponentially.

To disable the generation of connect and disconnect events every time the OMNIbus Adapter accesses the Object Server database, the connection_watch_connect and connection_watch_disconnect triggers must be modified. These triggers are modified via the OMNIbus Administrator application.

Each trigger includes one line change where the else is changed to an elseif to exclude connection alerts associated with the OMNIbus Adapter.

BEFORE:

if (%signal.username = ' ') then insert into alerts.status ... else insert into alerts.status ... end if;

AFTER:

if (%signal.username = ' ') then insert into alerts.status ... elseif (%signal.process <> 'OMNIbus Adapter') then insert into alerts.status ... end if;


DISABLE CONNECT AND DISCONNECT EVENT GENERATION

102 VERSION 2.4 REV A01 300-011-519

6Chapter
Custom Configuration 1
Topics covered in this section:• Client Acquisition Service• Adapter High Availability• Java to Adapter Integration• Persistence Database Management

Client Acquisition Service 1

The Client Acquisition service allows customers to leverage the EMC Acquisition Services with their data. Customer data can be added to the existing EMC Acquisition system. Processes in Ionix IT Orchestrator can be configured to feed off of their data similar to the existing Adapter workflows. Two services are provided for getting data into the Acquisition Queue. Both provide the exact same features, but allow customers to choose the easiest integration point.

Data Format

The data must be provided in the following XML format:

<?xml version="1.0“ encoding=”UTF-8”?><client-object> </client-object>

Object Format

Schema for the client object (client-object.xsd):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="client-object" type="clientDefinedObject"/>


CLIENT ACQUISITION SERVICE

<xs:complexType name="clientDefinedObject" mixed="true"> <xs:sequence> <xs:any processContents="skip" namespace="##other" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType></xs:schema>

To provide data to the acquisition queue, customers must always specify the serviceId and objectType along with the object data.• serviceId - Unique identifier of the service that placed this data here.

This is used to differentiate between different applications that push data into the queue.

• objectType - Unique type of the object. This should not be one of the built in types (Incident, Event, CI, Change, Problem, ITObject). It can be any unique name to identify the customer's data.

The return for the service provides the ID of the transaction back to the client. This can be used to correlate the call with the transaction that appears in the queue.

RESTful Client Acquisition

For the Client Acquisition endpoint, HTTP POST to the following address:

https://localhost:9443/services/client-acquisition/{serviceId}/{objectType}:

Replace {serviceId} and {objectType} with the desired values.

• HTTP Basic Authentication is expected to authenticate the user.• If a problem occurs, and HTTP 500 (Internal Error) response code is returned,

the content of the response contains the error message. A HTTP 200 code indicates the request was processed normally. Any HTTP 4xx codes indicate some sort of client error.

Note: If you have a form with a ":" colon in it, use the ASCII Hex decimal with a"%" sign prefix to escape it in the Restful service URL.

Calling the RESTful Client Acquisition from curl

In order to call the RESTful Client Acquisition from curl, the URL Agent must be installed. Once the URL Agent is installed, complete the following tasks: 1. Create an XML file with the root node of the client-object.

<?xml version="1.0" encoding="UTF-8"?><client-object> </client-object>

2. From the command line, call the following command:

104 VERSION 2.4 REV A01 300-011-519


python agent.py -l -v -x {filename} https://iwave:password@localhost:9443/services/client-acquisition/{serviceId}/{objectType}

3. An HTTP/1.1 200 OK response is sent and the data should be in the Acquisition Queue.

SOAP Client Acquisition Web Service

The following is the location of the SOAP Client Acquisition Service WSDL:https://localhost:9443/services/ClientAcquisitionService?wsdl

If an error occurs, a web service fault is thrown matching the framework exception com.iwave.acquisition.client.AcquisitionException.This exception contains a message with the details of the problem. HTTP Basic Authentication is expected to authenticate the user.

Running on another port

To run the Client Acquisition service from another port, you must modify the client-acquisition-spring.xml file. Figure 6-1 identifies the spring configuration file for the client acquisition service. In this file, perform the following modifications:1. Replace the ${services.url} with the required URL and port number

(i.e., 9080).

Note: If you specify port 9443, you must use HTTPS in the URL.

2. If you need to disable authentication, delete the following three lines in the two places they occur.<jaxws:inInterceptors> <ref bean="securityInterceptor"/></jaxws:inInterceptors>

3. To start a second copy of the Acquisition Service, copy the modified file to the conf directory.



Figure 6-1 Spring Configuration

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:jaxws="http://cxf.apache.org/jaxws" xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:lang="http://www.springframework.org/schema/lang" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-2.0.xsd">

<bean id="clientAcquisitionService2" class="com.iwave.acquisition.client.ClientAcquisitionService"> <property name="queue" ref="acquisitionQueue"/></bean>

 <bean id="acquisitionExceptionProvider2" class="com.iwave.acquisition.client.AcquisitionExceptionMapper"/>

 <jaxws:endpoint id="clientAcquisitionServiceEndpoint2" implementor="#clientAcquisitionService2" implementorClass="com.iwave.acquisition.client.ClientAcquisitionService" address="${services.url}/ClientAcquisitionService2"> <jaxws:inInterceptors> <ref bean="securityInterceptor"/> </jaxws:inInterceptors> </jaxws:endpoint>

<jaxrs:server id="clientAcquisitionServiceRest2" address="${services.url}/client-acquisition2"> <jaxrs:inInterceptors> <ref bean="securityInterceptor"/> </jaxrs:inInterceptors> <jaxrs:serviceBeans> <ref bean="clientAcquisitionService2"/> </jaxrs:serviceBeans> <jaxrs:providers> <ref bean="acquisitionExceptionProvider2" /> </jaxrs:providers> </jaxrs:server></beans>

106 VERSION 2.4 REV A01 300-011-519

ADAPTER HIGH AVAILABILITY

Adapter High Availability 6

The EMC Ionix IT Orchestrator Adapter solution may be scaled to allow more Adapters in the network configuration. Adapter scaling may be performed for the following reasons:• to increase the number of transactions being processed• to provide high-availability (i.e., redundancy)• to handle additional simultaneous requests

Figure 6-2 provides an illustration of a network configuration with multiple Adapters utilizing an external Acquisition database.

Figure 6-2 Adapter Scaled Network Configuration

Operations Services Scaling

The Operations Web Services can be scaled easily. The operations are essentially stateless, allowing a second adapter to be installed on another system that can handle the operations. If the primary Adapter fails, workflows can be updated to switch to use a secondary Adapter’s operations services.

Acquisition Services Scaling

The Acquisition Services component of the Adapter architecture can be scaled by completing the following steps:1. Offload the Acquisition Queue to an external database.2. Use the external database with multiple Adapters.


ADAPTER HIGH AVAILABILITY

Use the External Database for Multiple Adapters

Each Acquisition Service is pulling from the same shared queue. A second adapter install can be used to handle additional acquisitions. Workflows can be updated to switch to the second adapter if the acquisition queue operations fail on the primary server.

Adapter Failover Infrastructure

Since it is difficult to add logic for Adapter failover within workflows, specific infrastructure must be implemented to handle Adapter failover. The following are options for implementing high-availability for the EMC Adapters:• Round-Robin DNS Server - A Round-Robin DNS can be used to allow a single

hostname to provide access to multiple IP addresses representing the multiple Adapter environments installed. With this configuration, if the primary Adapter server goes out-of-service, the DNS server can point users to the secondary Adapter server that is in-service.

• Highly Available HTTP Proxy Server - A highly available HTTP Proxy server can be used to forward requests between Adapters. When the primary Adapter server goes out-of-service, the HTTP proxy server should be able to forward requests to a secondary Adapter server that is in-service.

Agent Scaling

It is assumed that if the endpoint application is up and running, it should be able to invoke the Agent script running within that environment. The agent needs to only notify one acquisition adapter that is running. The reason is that the message only needs to be added to the queue once.

There are two options for this:• If the customer has a Round-Robin DNS or proxy set up that allows access to

any of the installed adapters that are running, this can be used from the agent. The agent would point to the single hostname. One of the adapters receives the request and add it only once to the queue.

• If multiple URLs are present on the agent command line, it makes the request to only one of them, the first available one. Store-forwarding is still provided but is only used if none of the services can be reached.

108 VERSION 2.4 REV A01 300-011-519

JAVA TO ADAPTER INTEGRATION

Java to Adapter Integration 6

If a Java application must be used to push information into any of the Adapter RESTful web services, specific Java code must be used. Figure 6-3 includes a Java code sample used to perform an HTTP POST or GET with the EMC Adapter.

Prerequisites

In order to use this code, you need to download the Apache Commons HTTP Client version 3.1. The Commons HTTP Client can be downloaded from the following location:

http://hc.apache.org/downloads.cgi

From the Apache Http Components Downloads page, scroll down and select to download the Commons HttpClient 3.1. To use this client, you also need the following jar files:• commons-httpclient-3.1.jar • commons-codec-1.3.jar • commons-logging-1.1.1.jar


JAVA TO ADAPTER INTEGRATION

Figure 6-3 Sample Java code

package com.iwave.net;import java.io.IOException;import org.apache.commons.httpclient.HttpClient;import org.apache.commons.httpclient.HttpException;import org.apache.commons.httpclient.HttpStatus;import org.apache.commons.httpclient.methods.GetMethod;import org.apache.commons.httpclient.methods.PostMethod;import org.apache.commons.httpclient.methods.StringRequestEntity;/** * Example of making an HTTP GET or POST in Java. * * */public class SimpleHTTPClient { public String post(String url, String xml) throws HttpException, IOException { HttpClient client = new HttpClient(); PostMethod method = new PostMethod(url); try { if (xml != null) { method.setRequestEntity(new StringRequestEntity(xml, "text/xml" , "UTF-8")); } // Execute the method. int statusCode = client.executeMethod(method); if (statusCode != HttpStatus.SC_OK) { throw new IOException("HTTP POST method failed: " + method.getStatusLine()); } return method.getResponseBodyAsString(); } finally { method.releaseConnection(); } } public String get(String url) throws HttpException, IOException { HttpClient client = new HttpClient(); GetMethod method = new GetMethod(url); try { // Execute the method. int statusCode = client.executeMethod(method); if (statusCode != HttpStatus.SC_OK) { throw new IOException("HTTP GET method failed: " + method.getStatusLine()); } return method.getResponseBodyAsString(); }

110 VERSION 2.4 REV A01 300-011-519

PERSISTENCE DATABASE MANAGEMENT

Persistence Database Management 6

This section discusses the following maintenance tasks that can be performed on the Persistence database.• Removing Transactions• Reclaiming Unused Disk Space• Connecting to the Database• Changing the Database Port Number• Offloading the Acquisition Queue to an External Database

Removing Transactions

The pruning service removes all transactions that are older than 7 days and are in the “Error” state from the Persistence database. The service runs every night at 3:00 a.m.

Reclaiming Unused Disk Space

After large amounts of data have been deleted or updated on the Derby database, a Derby table or index can contain unused space. By default, Derby does not return unused space to the operating system. However, Derby does provide a way to reclaim unused space in tables and associated indexes.

If you determine that a table and its indexes have a significant amount of unused space, use one of the following procedures to reclaim the space: • SYSCS_UTIL.SYSCS_COMPRESS_TABLE - is guaranteed to recover the

maximum amount of free space, at the cost of temporarily creating new tables and indexes before the statement in committed.

• SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE - attempts to reclaim space within the same table, but cannot guarantee it will recover all available space. This procedure uses no temporary files and moves rows around within the same table or index.

For more information, refer to the Apache Derby Administration Guide.

To reclaim space in the table and recreate the indexes, execute the following script from adapters/bin directory:

runScript.bat derbyMaint


PERSISTENCE DATABASE MANAGEMENT

Connecting to the Database

To connect to the Adapter Derby database over the network, use the Java driver derbyclient-10.4.2.0.jar. The following URL will connect to the Derby database running in the Adapter.

jdbc:derby://HOST:1528/persistence-db

Changing the Database Port Number

To change the port number of the database, modify the derby.drpa.portNumber in the system.properties file located in the conf directory.

Offloading the Acquisition Queue to an External Database

In addition to the Apache Derby database, the Acquisition Queue can be offloaded to an external database. To enable support for another database, complete the following steps:1. Download the JDBC driver for the required platform and place the file in the

lib/adapters directory in the adapter install directory.2. Modify the following properties in the Adapter framework.properties

file:— datasource.jdbc.driver: identifies the database driver name

(i.e., com.microsoft.sqlserver.jdbc.SQLServerDriver).— datasource.jdbc.url: identifies the URL to the database

(i.e., jdbc:sqlserver://hostname:1433;DatabaseName=testdb).— datasource.jdbc.username: Username— datasource.jdbc.password: Password. This can be encrypted if

desired.3. Restart the Adapter.

For the database to be highly available, database clustering technologies should be used. Refer to the appropriate database documentation for more information.

112 VERSION 2.4 REV A01 300-011-519

7Chapter
Using the URL Agent 1
The chapter discusses the following topics:• About the Adapter URL Agent• Python Requirement• URL Agent Daemon• Logging• Running the URL Agent• URL Agent Filtering

About the Adapter URL Agent 1

If an Adapter does not require a specialized Agent, an EMC Ionix IT Orchestrator Adapter URL Agent can be installed. The main function of the URL agent is to perform an HTTP GET or POST operations against the adapter. An external application could be used to perform these functions, but the URL Agent provides some capabilities that may not be readily available from another client.

The URL Agent includes the following capabilities:• Store-Forward Capability - This means that if the Adapter is not running or

there is a network outage, the transactions are stored in a local data file. These transactions are forwarded when the Adapter is available again.

• HTTPS and HTTP Basic Authentication - for secured communications and authentication.

• Retrying on Retryable Error Codes - The Adapter Framework will return an HTTP Status Code for different types of errors. The URL Agent provides retrying on retryable error codes from the Adapter.

Python Requirement 1

Python 2.6 is required for the URL Agent. During installation, if the URL Agent is selected, the Python software is automatically installed.


URL AGENT DAEMON

URL Agent Daemon 1

The Adapter URL Agent consists of two components: the agent and the agent daemon.

The URL Agent daemon is a lightweight process that runs in the background and makes requests to the Adapter(s). The URL Agent makes use of the Agent daemon background service. When started, the agent daemon provides ordered access to the adapter and to the store-forward data file. This daemon will remain running after the GET or POST operation is complete. It consumes minimal resources and allows future transactions to be executed much faster. Only one instance of the daemon is running at a time.

The agent uses TCP/IP port 50011 (by default) to communicate with the URL Agent daemon.

Shutting Down and Starting the Daemon

The Agent daemon is automatically started when the URL Agent is installed. If the daemon needs to be shutdown and restarted, enter the following commands:• To shutdown the agent daemon, enter the command:

agent.py –s

• To start the Agent daemon, enter the command:agent.py –d

Logging 1

All logging is performed by the Agent daemon. A single log file is used for all requests going out. Error messages are logged to the file in ../log/agent.log. By default, the logging is minimal. This is recommended for production usage. If there is a problem, verbose logging can be enabled by adding the -v flag on the command when the Agent daemon is started.

When enabling verbose logging, it is recommended to first shutdown the daemon and then start the daemon with verbose logging. To enable verbose logging, enter the following commands: • agent.py -s

• agent.py -d –v

If a request is made without using the agent daemon, the local option can be used. The agent daemon is not used or started when this option is used and store-forward is disabled. The following is a sample of using this option with verbose logging on.

agent.py -v -l http://localhost:9080/services/adapter

114 VERSION 2.4 REV A01 300-011-519

RUNNING THE URL AGENT

Running the URL Agent 1

The URL Agent execution parameters are as follows:

Usage:

agent.py [options] url1 [alternate-urls ...]

Options:

-h, --help Shows this help message and exits. -a key=value Specifies an attribute in key=value format. -x XML_FILE, --xml-file=XML_FILE

Specifies the XML File that contains data to POST to the url.

-f ATTRS_FILE, --attrs-file=ATTRS_FILESpecifies the file that contains a list of key=value@$ attributes.

-e, --environment-variablesEach environment variable is taken as a key/value pair to pass as data.

-u USERNAME, --username=USERNAMEUsername for HTTP Basic Authentication.

-p PASSWORD, --password=PASSWORDPassword for HTTP Basic Authentication.

-r, --resubmit Resubmit all items from the dead queue back to the store (not available with the -l option).

-c, --clear Clears all items in the dead queue. (Not available with the -l option).

-v, --verbose Enables verbose logging for the agent daemon. -l, --local Do not attempt to use the agent daemon. The log file is

not created and store-forward is disabled. -d, --daemon Starts the agent daemon in the foreground. This

command does not return. -s, --shutdownShuts down the background agent daemon. Exits

immediately after shutdown.

Example Commands

The following are example commands for using the URL Agent:• To perform an HTTP GET to the URL, use the following command:

agent.py http://localhost:9080/services/adapter


URL Agent Filtering

• To perform an HTTP GET to the adapter in a fail-over environment, enter the command with two URLs:— If the first URL is not reachable, the second is tried. — If none are reachable, the store-forward mechanism is engaged. Only

one URL is notified.agent.py http://host1:9080/services/adapter http://host2:9080/services/adapter

• To perform an HTTP POST to the URL specified with an XML payload that has the key/value pair specified, enter the following command. The XML schema is the format understood by the adapters.agent.py -a key=value http://localhost:9080/services/adapter

The XML Format used by the adapters will look like this:

<?xml version="1.0" encoding="UTF-8"?><data> <string-field name="key">value</string-field></data>

• To perform an HTTP POST to the URL specified with an XML payload with the key/value pairs retrieved from a text file, enter the following command. The XML schema is the format understood by the adapters. The text file lines must be terminated in @$ to denote the end of a line (they can span multiple lines).agent.py -f /path/to/file http://localhost:9080/services/adapter

• To perform an HTTP POST to the URL specified with an XML payload using the file specified, enter the following command with the –x option: agent.py -x /path/to/file http://localhost:9080/services/adapter

URL Agent Filtering 1

Sometimes it is beneficial or necessary to filter out changes coming out of an endpoint application before they get to the workflow. By filtering early, it reduces the load on the Adapter system. Also, some things like the request type can only be determined at the endpoints. Often the endpoint can provide access to previous values of data as well as the current. This allows status changes to be detected and can allow a request type to be sent for the record.

The Adapter supports URL Agent filtering. The URL Agent filter identifies the changes that need to be performed before reaching the endpoint application. The filter is essentially a wrapper around the URL agent that provides the filtering mechanism.

116 VERSION 2.4 REV A01 300-011-519

URL Agent Filtering

Using a filter script allows you to define configuration settings like the URL to use, basic auth parameters and logging options right within the script. This means that the command line call to the script will be very simple. This also makes it easier to run tests.

Running the Filter Script

An example URL Agent filter script (agent-filter.py) is installed with the URL Agent. The agent-filter.py file can be copied and customized for your solution. The script contains examples of options that can be changed. Modifying the filter requires minimal coding and some knowledge of Python.

To run the script, enter the following command:c:\install_root\adapters-2.2\agent\agent-filter.py

On Windows systems, you may need to use the command from an endpoint application. For example:c:\Python26\python c:\IonixITO\adapters-2.2\agent\agent-filter.py

Filter Parameters

All parameters for the URL Agent function (i.e.,. -v, -l, -s) can be used in the URL Agent filter. Attributes are included in the script to perform the specific filtering. The attributes available to the filter script are defined by the -a, -f or -e parameters to the script.

The following parameters can be added to the Notification or Acquisition-Event services to influence how this transaction is placed in the queue. Each of these can be added using the -a parameter when calling the Agent. These must be set using the string-field extended field type.

Example Filter Script

Figure 7-1 identifies the example URL Agent Filter.


URL Agent Filtering

Figure 7-1 Example URL Agent Filter Script (page 1 of 3)

#!/usr/bin/env python## Example Usage: # agent-filter.py -a REMOVE_ME=abc -a Status=InProgress -a OldStatus=Updated -a MUST_HAVE=true -a SEND=true -a Partner=abc -a ID=123

from multiprocessing import freeze_supportimport agent

class FilteredAgent(agent.FilteredAgentMixin):# Pre-configured URLs to send the requests to. # This can be comma separated in the brackets urls = ['http://localhost:9080/services/notification/remedy/%s/%s']

def init(self):### Examples of setting URL Agent options (Overrides)

# Override Basic Authentication username and password. # Uncomment these to enable#self.options.username = 'user'#self.options.password = 'pass'

# Override verbose loggingself.options.verbose = True

# Override local/background agent. True means local, # False means background and uses store-forwardself.options.local = True

# If no code is in this method you need this line#pass

def filter_attributes(self, attributes):"""should_filter_out(self)

This method call is used to filter out calls to the agent. If thismethod returns True, then the call will not be sent on. This usefulto filter out calls that do not need to be processed even though theagent is fired."""

118 VERSION 2.4 REV A01 300-011-519

URL Agent Filtering


### Examples of modifying attributes

# Example: Removing an attribute from being sentif 'REMOVE_ME' in attributes:

del attributes['REMOVE_ME']# Example: Setting override object type attributes['iwave.overrides.objectType'] = 'CustomIncident'

# Example: Setting override service ID based on Partner field(static)if 'Partner' in attributes:if attributes['Partner'] == 'ABC':attributes['iwave.overrides.serviceId'] = 'RemedyABC'# Example: Setting override service ID based on Partner field#(dynamic) This will produce a serviceId of 'Remedy{P}' when the#'Partner' field is '{P}'else:attributes['iwave.overrides.serviceId'] = 'Remedy%s' % attributes['Partner']

# Example: Setting the request Type based on a status changeif attributes['Status'] != attributes['OldStatus']:if attributes['Status'] == 'InProgress':attributes['iwave.request.type'] = 'ChangeApproved'elif attributes['Status'] == 'Cancelled':attributes['iwave.request.type'] = 'ChangeRejected'else:attributes['iwave.request.type'] = 'Unknown'

# Example: Sets the create date based on the 'date' attribute# specified using the format specified. Formatting options are# available# here: http://docs.python.org/library/time.html#time.strftimeself.create_date_from_attr('date', "%Y-%m-%d %H:%M:%S")

# Example: Sets the create date from the current time on this# system. The time is always sent as UTC.#self.create_date_from_now()

### Logging

# This piece of code will print out each attribute to the log fileself.agent.log_debug('Agent Filter Called with Attributes: %s' %attributes)

# Logging can also be done to info using:#self.agent.log_info('Some informational message')


URL Agent Filtering


### Replacing URL placeholders

# This replaces any %s placeholders in the URLs with the values# specifiedself.replace_url_placeholders(('incident', attributes["ID"]))

### Examples of filtering out calls### Returning True indicates not to send the call to the adapter### Returning False indicates to send the call to the adapter

# Example: Filters out everything that does not have theattribute "MUST_HAVE"if 'MUST_HAVE' not in attributes:self.agent.log_debug('MUST_HAVE attribute not present.Filtering out')return True

# Example: Filters out anything that does not have the "SEND"attribute # or it is not "true"if 'SEND' not in attributes or attributes['SEND'] != 'true':self.agent.log_debug('SEND attribute not present. Filteringout')return True

# Example: Filters out anything that does not have a change between the# two attributes 'Status' and 'OldStatus'. if attributes['Status'] == attributes['OldStatus']:self.agent.log_debug('Status not changed. Filtering out')return Truereturn False

if __name__ == '__main__':freeze_support()FilteredAgent().run()

120 VERSION 2.4 REV A01 300-011-519

8Chapter
Ionix IT Orchestrator Configuration 1
Topics covered in this chapter:• Using the ITIL Adapter Plugin• Adapter API

Using the ITIL Adapter Plugin 1

The ITIL Adapters plugin for Orchestrator enables the ITIL Adapters to be easily used from EMC Ionix IT Orchestrator and leverages the Adapter API.

Associated Files

The following files are utilized by the Adapters plugin:• com.iwave.ext.adapters_x.x.zip – This is the core of the Adapters plugin for

Orchestrator. This plugin provides the ‘TransactionProcessor’ for acquisition and the Tasks for operation services. It also contains the full Adapter API jar files so that they can be used within workflows.

• com.iwave.ext.adapters.httpdispatcher_x.x.zip - This archive contains the AdaptersDispatcher.war. This needs to be loaded with the container and provides an endpoint that communicates with the adapters push mechanism. Extract this zip to the root of the container and it should be unpacked in the correct directory.

• com.iwave.ext.adapters.examples_x.x.zip – (Optional) This is an Orchestrator project that should be imported into Studio. It contains some tests and examples on how to use the push mechanism. This project is not required to use this plugin but is helpful as a starting point and example.

Installation and Configuration

HTTP Dispatcher (com.iwave.ext.adapters.httpdispatcher_2.3.1)

This component is a web application that provides a Web API used by the Adapter to push to the Ionix IT Orchestrator. This is required for the


https://integratorng.trac.cvsdude.com/integratorng/wiki/AdaptersAPI

https://internal-sbs.iwavesoftware.com:8084/servlet/JiveServlet/showImage/102-1011-5-1004/client-workflow.jpg





https://prime:8444/TransactionDispatcher/ClientA

https://prime:8444/TransactionDispatcher/ClientB

USING THE ITIL ADAPTER PLUGIN

Acquisition Push feature. The web application is packaged as a single file called AdaptersDispatcher.war.

To install this component: 1. Copy the AdaptersDispatcher.war file to the conf/webapps/

directory of the container. 2. Extract the zip file to the root container directory and it will be placed in the

correct location.3. If you do not wish to use a standalone container install, there is a container

install bundled with studio. This container install is located in directory plugins/com.enigmatec.ems.platform_4.0.0.

4. Ensure that a JAAS login module is set up for the container. The default container install sets up JAAS to use conf/JaasAuth-windows.conf. This enables Windows based authentication, which will always succeed if the user is logged in.

Adapters Plugin (com.iwave.ext.adapters_2.3.1)

The com.iwave.ext.adapters plugin needs to be installed in both Studio and the container. This is installed like any other Ionix IT Orchestrator plugin. A new version of this plugin will be required for a new release of the adapters as it contains the API for a specific adapters version.

To install this plugin:1. Extract the com.iwave.ext.adapters_2.3.1.zip to the base studio

directory. This will install the plugin into the plugins directory of studio. If a previous version of the plugin exists, remove it by removing the plugins\com.iwave.ext.adapters* from the studio installation.

2. A sample container startup script called adapters-container.bat is provided with the examples project. After extracting the examples project, you can find this file in the resources directory. The following jar files from the plugin need to be on the classpath for the container. The adapters-container.bat script takes care of this for you. — plugins\com.iwave.ext.adapters_2.3.1\adapters.jar

— plugins\com.iwave.ext.adapters_2.3.1\lib\api-2.3.jar

— plugins\com.iwave.ext.adapters_2.3.1\lib\ejb3-persistence-1.0.2.GA.jar

adapters-container.bat:

set ORCH_HOME=c:\iWaveSoftware\orchestrator-studio\plugins\com.enigmatec.ems.platform_4.0.0

set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\adapters.jar;%CONTAINER_CLASSPATH%

122 VERSION 2.4 REV A01 300-011-519

https://internal-sbs.iwavesoftware.com:8084/servlet/JiveServlet/showImage/102-1011-5-1001/newservice.jpg





set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\lib\api-2.3.jar;%CONTAINER_CLASSPATH%

set CONTAINER_CLASSPATH=%ORCH_HOME%\..\com.iwave.ext.adapters_2.3.1\lib\ejb3-persistence-1.0.2.GA.jar;%CONTAINER_CLASSPATH%

%ORCH_HOME%\bin\container -r c:\iWaveSoftware\orchestrator-repository-adapters

Adapters Push Configuration

The com.iwave.ext.adapters.examples project contains samples of implementing a push handler. The sample sets up two push clients that can be accessed via the URLs https://localhost:8444/TransactionDispatcher/ClientA and https://localhost:8444/TransactionDispatcher/ClientB. These need to be specified in the adapters configuration.• Adapters - To enable the push mechanism on the adapters, the

acquisition-push-spring.xml file needs to be placed in the conf directory of the adapters. This should contain the content below. Note that multiple QueueProcessors can be included to perform pushes from multiple different objectType/serviceIds.

acquisition-push-spring.xml

<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"><bean>

<property name="threads" value="3"/><property name="objectType" value="*"/><property name="serviceId" value="*"/><property name="pusher"><bean>

<property name="url" value="https://prime:8444/AdaptersDispatcher/ClientA"/>

<property name="username" value="admin"/><property name="password" value="admin"/>

</bean></property>

</bean></beans>



Using the Plugin

This section describes how to use the adapters plugin.

Acquisition

The adapters plugin provides a special ME type to handle TransactionRecords pushed from the adapters. A service can be created to implement this ME type by creating a new Service and adding the super type TransactionProcessor.

Figure 8-1 Creating a New Service

The TransactionProcessor type requires an effector to be implemented named processTransaction. This effector provides a TransactionRecord as a parameter that has to be processed by the workflow. When the workflow successfully completes, the record will be marked as complete in the adapters.

The effector has two return fields:• transactionResponse - This field indicates if the processing of the record was

successful or not. There are three possible values for this return:

124 VERSION 2.4 REV A01 300-011-519


— com.iwave.ext.adapters.acquisition.TransactionResponse.OK - Indicates that the processing was successful. This responds to the adapters with a success code and the transaction will be completed (unless it was manually changed through the workflow.

— com.iwave.ext.adapters.acquisition.TransactionResponse.ERROR_RETRY - Indicates that there was an error processing the record. The adapters will retry this again after the usual interval. This is the default handling for errors.

— com.iwave.ext.adapters.acquisition.TransactionResponse.ERROR_NO_RETRY - Indicates that there was an error processing the record that will always fail and it should not be retried again.

• errorMessage - If an error occurred, this contains the text that is passed to the Adapters. This is useful for logging the error back into the adapters logs and to Monitoring Server.

Operations

The adapters plugin provides Services for each of the common services available in the adapters API. Theses services are available from the palette under the com.iwave.ext.adapters heading. They can be dropped onto any workflow.

Figure 8-2 Workflow



Configuration of the adapter services is done from the service organization. You need to specify the following configuration parameters to connect to the adapters web services. • wsdl - URL to the WSDL for the web service. This may be a URL to a resource or

the local file system and does not necessarily need to be the remote endpoint.• endpointUrl - The URL to the endpoint to use for the web service. If this is null

then the endpoint URL contained in the WSDL file is used. • username - The HTTP Basic Authentication username to use for

authentication to the adapters. • password - The HTTP Basic Authentication password to use for authentication

to the adapters.Figure 8-3 Client Service Organization

126 VERSION 2.4 REV A01 300-011-519

ADAPTER API

Adapter API 8

The Adapter API is a subset of the Adapter Framework that contains the common object model and services that are used for all of the ITIL adapters. All Adapter services are exposed as Web Services. This API provides a mechanism for integrating Java-based tools with the adapters. The functionality of this API is exactly the same as what can be used from the Web Services.

Note: This API cannot be used if you need to integrate a non Java-basedsystem with the adapters.

The Adapter API uses JAX-WS to connect to the API using the standard Web Services.

Software Requirements

When using this ITIL Adapter API with Ionix IT Orchestrator, the following software is required:• Java version 6 • Adapters version 2.3 (or later)

API Distribution

The API distribution zip file (i.e., api-2.4.zip) contains the following files and directories:• javadocs - JavaDoc documentation for the API. This should be used as a full

reference for the API operations. • lib/api-2.3.jar - This is the main API archive. • lib/ejb3-persistence-1.0.2.GA.jar - The API depends on the JPA

('javax.persistence') APIs. This is part of JEE but is provided as a standalone jar file.

• lib/log4j-1.2.14.jar - The API does limited logging in certain situations. The log4j logger jar file is required for this.

Package Descriptions

The following are the descriptions of the packages included in the API:• com.iwave.acquisition - Object model and services for the adapter

acquisition services. • com.iwave.adapters - Adapters Client API entry point. • com.iwave.batch - Object model and services for the adapter batch services.


ADAPTER API

• com.iwave.ims - Object model and services for the Monitoring Server services.

• com.iwave.itom - The IT Object Model and supporting helper classes. • com.iwave.operations - The Adapters operational services (IT endpoint

operations). • com.iwave.util - Various internal utilities required by the API.

Key Classes

This following are the descriptions of the key classes in the API. For complete information on the API and methods available, consult the Javadocs.• com.iwave.adapters.AdapterClient - This is a utility class for getting client

proxies to the acquisition, Monitoring Server, batch and operation services. • com.iwave.itom.support.XmlSerialization - This is a utility for serializing

and deserializing adapter object models to/from XML. • com.iwave.itom.extended.ExtendedFieldFactory - This is a utility class for

creating extended fields from k-v Map constructs or getting Maps from extended fields. This is the easiest way of working with extended fields from Java.

Service Classes

The following are the Service Classes included in the API:• Acquisition Services:

— IAcquisitionService - Acquisition Services for interacting with the adapters queue.

— IAcquisitionManagementService - Management information about the adapter queue.

• Batch Services:— IBatchService - Batch services.

• iWave Monitoring Server Services:— IIWaveEventService - Monitoring Server Service for publishing events.

• IT Operational Services:— IITObjectService - ITObject Operations service. — IITObjectAttachmentService - ITObject Operations service. This also

supports attachments and must be used for operations for adapters that support attachments.

— IIncidentService - Incident Operations service. — IIncidentAttachmentService - Incident Operations service. This also


— IChangeService - Change Operations service.

128 VERSION 2.4 REV A01 300-011-519

ADAPTER API

— IChangeAttachmentService - Change Operations service. This also supports attachments and must be used for operations for adapters that support attachments.

— IProblemService - Problem Operations service. — IProblemAttachmentService - Problem Operations service. This also


— IConfigurationService - Configuration Item Operations service.— IDeviceService - Device Operations service. — IDomainDeviceService - Device Operations service that accepts the

domain/network as an extra parameter to each call. This is required for adapters such as ITOI that has this capability.

— IEventService - Event Operations service. — IEventServiceDestination - Event Operations Service that requires the

destination/domain to be specified on each call. This is required for adapters such as SCOM that has this capability.

SSL Certificates

If the Adapter service is using a self signed certificate, JAX-WS may fail to establish an SSL connection. There are two options for dealing with this potential failure:• Install the SSL Certificate from the adapters into the trust keystore for the Java

application using the API. • Disable trust verification for SSL. This can be dangerous on the public internet

allowing for man-in-the-middle attacks but is generally not a problem where customers have a secure pipe to begin with. This is almost always the case for our customers. The 'com.iwave.ext.adapters.examples' orchestrator project contains an example of installing a trust-all security manager.


ADAPTER API

Java Code Examples

This section includes Java code examples of the Acquisition Services and Incident Services. For complete examples on how to use this API from Ionix IT Orchestrator, see the 'com.iwave.ext.adapters.examples' orchestrator project that is available with the API.

Figure 8-4 Acquisition Example

// Example using the acquisition services IAcquisitionService acquisition = AdapterClient.get(IAcquisitionService.class, "https://hostname:9443/services/AcquisitionService?wsdl", "iwave", "password"); // Example creating a service with no authentication: //IAcquisitionService acquisition = AdapterClient.newClient(IAcquisitionService.class,

// "https://hostname:9443/services/AcquisitionService?wsdl"); // Example creating a service with an alternate endpoint URL: //IAcquisitionService acquisition = AdapterClient.newClient(IAcquisitionService.class,

// "https://hostname:9443/services/AcquisitionService?wsdl", // "https://alternatehost:9443/services/AcquisitionService", // "iwave", "password"); // Calling count System.out.println("Adapter queue count: " + acquisition.count());

130 VERSION 2.4 REV A01 300-011-519

ADAPTER API

Figure 8-5 Incident Operations Example

// Example using the incident service. After this service is created, // this proxy should be cached. Creating this every time is expensive. IIncidentAttachmentService inc = AdapterClient.get(IIncidentAttachmentService.class, "https://hostname:9443/services/ionix-sm/IncidentService?wsdl", "iwave", "password"); // Retrieving an incident Incident incident = inc.get("2"); System.out.println("Incident Found: " + incident.getIdentifier()); System.out.println(" Desc: " + incident.getDescription()); // Print the entire incident content as XML System.out.println(incident); // Example accessing extended fields. // This can be used to access a single field but it is not efficient System.out.println("Field 'MODE': " + incident.getExtendedField("MODE", StringField.class).getValue()); // This should be used for easiest access to bulk fields. // This creates a map for accessing fields by key/value pairs Map<String,Object> fields = ExtendedFieldFactory.fieldsToMap(incident.getExtendedFields()); System.out.println("Field 'MODE': " + fields.get("MODE"));

// Updating an Incident Incident updateIncident = new Incident(); // ID is required for updates updateIncident.setIdentifier("2"); updateIncident.setDescription("Updated the description"); // Creating extended fields on update (Single mode)

//updateIncident.addExtendedField("MODE", "REVIEW"); // Creating many extended fields. (This will probably change to Map<String,Object>) Map<Object,Object> updateFields = new HashMap<Object,Object>(); updateFields.put("MODE", "REVIEW"); updateIncident.addExtendedFields(updateFields); // or

//updateIncident.setExtendedFields(ExtendedFieldFactory.newExtendedFields(updateFields)); // Perform the update System.out.println(updateIncident);

System.out.println(inc.update(updateIncident));


ADAPTER API

132 VERSION 2.4 REV A01 300-011-519

9Chapter
Managing the Adapter 9
In order to manage the EMC Adapters, the Java Console application may be installed on your workstation. The Java Console graphical user interface is a management tool that complies to the Java Management Extensions (JMX) specification. Java Console uses the Java Virtual Machine (Java VM) to provide information about the performance and resource consumption of the Adapters installed in your network.

This application allows you to perform the following functions:• list the names of the Adapters that are licensed and loaded• provide the status of the endpoint applications• restart all Adapters• provide a status of items in the Acquisition Queue

Note: For information on monitoring Events that are generated on the EMCAdapter and Ionix IT Orchestrator, refer to the “EMC Monitoring ServerInstallation and Configuration Guide”.


PREREQUISITES

Figure 9-1 Jconsole – List Adapters

Prerequisites 9

In order to use the Java console to manage the Adapter services, the following tasks must be completed:• The Adapter software must be installed on your computer.• The following Java Development Kit (JDK) package must be installed on your

computer:Java JDK1.6.0

Connecting to the Adapter Java Process 9

There are two ways you can connect to the Adapter Java process: • Connect to the local JMX instance. By default, JMX is not available for remote

connection. Java allows you to connect to a Java process running as the same user using the jconsole.

• JMX can be enabled in the process itself for remote access. Remote access can make use of SSL and authentication. setEnv – Enable JMX monitoring in

134 VERSION 2.4 REV A01 300-011-519

STARTING THE JAVA CONSOLE

setEnv20 identifies the Java properties that can be set to enable JMX without any security or authentication. These properties are included in the setEnv.bat/.sh file, which is located in the install_root\adapters-2.4\bin directory. The JMX monitoring properties are disabled by default. To enable JMX monitoring, delete the rem comment from the setEnv file. PORT can be replaced with any port name that is desired. — -Dcom.sun.management.jmxremote.port=PORT

-Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false

Figure 9-2 setEnv – Enable JMX monitoring in setEnv

Starting the Java Console 9

The Java Console is started by the jconsole executable. This executable can be found in the JDK_HOME/bin directory, where JDK_HOME is the directory in which the JDK software is installed. If this directory is in your system path, you can start the Java Console by typing jconsole in a command (shell) prompt. Otherwise, you have to type the full path to the executable file.

Management Beans 9

The following Adapter management beans can be used through JMX to manage the Adapter:• com.iwave:name=Adapters • com.iwave:name=AcquisitionQueue • com.iwave:name=FrameworkAdmin

com.iwave:name=Adapters

The Adapters Management bean allows the user to see which Adapters are loaded and the status of the endpoint applications.

Methods

The following Methods are supported for the Adapter Management bean:• listAdapterNames() - Gives a list of the names of the adapters that are

licensed and loaded.


MANAGEMENT BEANS

• getEndpointStatus(endpointName) - Gives the status of an adapter. The supplied parameter endpointName should be one of the values returned from listAdapterNames(). Possible values for endpoint status are: — Unknown - Indicates that this adapter does not support the status

check. Currently the only adapters that support this operation are BMC Remedy and CA-USD.

— Available - Indicates that the endpoint application is running and responds to a simple command.

• NotAvailable - Indicates that the endpoint application cannot be reached or fails to respond to a simple command.

com.iwave:name=AcquisitionQueue

The Acquisition Management bean allows the user to see the status of the Acquisition Queue without directly querying the database.

Methods

The following Methods are supported for the Acquisition Queue bean:• countErrors(serviceId, objectType) - Gives a count of the items

on the queue in the Error state. This is the same as the acquisition service countErrors() method.

• countPoll(serviceId, objectType) - Gives a count of the items on the queue in the Poll state. This is the same as the acquisition service count() method.

• countBlocked(serviceId, objectType) - Gives a count of the items on the queue in the Blocked state.

• countTotal(serviceId, objectType) - Gives a count of all of the items on the queue regardless of state.

• queueWaitingTime() - Gets the queue waiting time for the top item on the persistence queue. The date of the first transaction is returned. This can give an idea of when the last transaction was processed and if the queue processor is stalled.

Each of the count methods take parameters of the serviceId and objectType. These must be valid serviceId and objectType or part of a word. % is a valid wildcard. If no objectType and serviceId are specified, the default will be to query all.

Note: The Acquisition Management Service is also exposed as a web service.The following is the WSDL for the Acquisition Management Service:

https://localhost:9443/services/AcquisitionManagementService?wsdl

136 VERSION 2.4 REV A01 300-011-519

MANAGEMENT BEANS

com.iwave:name=FrameworkAdmin

The Framework Administration bean allows administration tasks to be performed on the Adapters.

Methods

The following Methods are supported for the Adapter Management bean:• restart(password) - Restarts the adapters. All services are shutdown,

configuration files reloaded and the services restarted. A parameter of the admin password is required.

• framework.admin.password - This is the new setting in framework.properties that contains the admin password hash. The default value for this password is adminpw. If the JMX service will be enabled, this password should be changed from the default.


MANAGEMENT BEANS

138 VERSION 2.4 REV A01 300-011-519

10Chapter
Maintenance and Troubleshooting 10
This chapter covers the following topics pertaining to the maintenance and troubleshooting of the EMC Adapter software.• Logging• Error Types and Meanings• Re-Installing or Uninstalling the Windows Service• Starting and Stopping the Adapter• Uninstalling the Adapter Software - Windows

Logging 10

Logging is provided for both the Adapter Framework and the URL Agent. Before logs can be generated, logging must be turned on and the amount of details specified.

Log Location

Based on the operating system, the EMC Adapter stores logs in following directories:• For Windows: C:\install_root\adapters\log• For UNIX: /opt/install_root/adapters/log

Turning on Adapter Logging (Windows)

To turn on Adapter Windows logging, you must edit the log4j.properties file.1. From Windows Explorer, navigate to the conf directory:

C:\install_root\Adapters\conf2. Right-click log4j.properties file and click Open on the pop-up menu. If

this is the first time you have opened the properties file, Windows displays the following dialog:


LOGGING

Figure 10-1 Windows Unknown File Type

3. Click Select the program from a list option and click OK.4. From the Open With List, select Notepad. Select Always use the selected

program to open this kind of file and click OK to open Notepad.5. In the log4jproperties file, find the Production Environment

Configuration section and the line: log4j.rootLogger=INFO,File,ErrorAppender

6. Replace the word INFO with DEBUG.7. Find the line: log4j.logger.com.iwave=INFO8. Replace the word INFO with DEBUG. The log4j.properties file should look

like the file identified in Figure 10-2.9. From the menu, select File > Save to save the changes.10. From the menu, select File > Exit to close the file.

140 VERSION 2.4 REV A01 300-011-519

LOGGING

Figure 10-2 log4j.properties File


ERROR TYPES AND MEANINGS

URL Agent Logging

When specifying logging configurations for the URL Agent, use the -v parameter with the agent.py command. This parameter specifies how much detail will be included in the log. When operating in a normal production environment, the log level will normally be set low to save processor time and disk space. • If the log level is too low, it may not provide enough information. • If an issue is suspected with URL Agent connection to the notification service,

increase the log level.

Error Types and Meanings 10

The URL Agent and EMC Adapter generate their own errors. Several types of errors can occur when several complex software applications interact. This complexity is expanded when considering that the applications may be communicating over vast distances (via the Internet) and that they are typically asynchronous.

The following types of errors that may occur when using the EMC Adapter:• Recoverable• Permanent• Global Errors

Recoverable Errors

Recoverable errors go away in time without involving any particular change to the EMC configuration or the endpoint application. For instance, if the EMC URL Agent attempts to send an event notification to the EMC Adapter and the connection is down, the Agent continues sending the notification until the connection is restored. In this case, there is an error message in the log, but no action needs to be performed to return the Adapter to service. The Adapter is returned to service automatically.

Permanent Errors

Permanent errors cannot be recovered automatically and require some form or corrective interaction. For example, if the EMC user for the endpoint application does not have a high enough privilege to open a new incident, the attempt fails. No matter how many times the EMC user attempts to open a new Incident, the action continues to fail until the user account is modified to allow the action.

142 VERSION 2.4 REV A01 300-011-519

ERROR TYPES AND MEANINGS

Global Errors

An error can thrown from either the Adapter, Ionix IT Orchestrator or Integration workflow. Some of these errors are results of errant configurations such as an incorrect workflow assumption, incorrect URL, or a bad SSL configuration. Other errors could result from an error in the software itself.

Adapter Errors

The table below indicates errors that can occur in the EMC Adapter. These errors can be generated by either the Acquisition or Operations Services.

URL Agent/Notification Service Errors

The table below indicates errors that can appear in the URL Agent logs.

Table 10-1 Adapter errors

Error Cause

AcquisitionException A problem occurred while trying to retrieve a transaction from the adapter.

ObjectNotFoundException Occurs when the object requested on a get, update, or remove operation is not found

UnsupportedOperationException The method used on the adapter is not supported by the adapter.

OperationsException Typically a recoverable error such as connectivity issues

NonRecoverableOperationsException

Permanent error condition.

Table 10-2 URL Agent / Notification Service Errors

Error Cause

HTTP-503: Service Unavailable Most likely either the Form name or Incident ID are invalid on the command line call to the URL Agent.

HTTP-50x: Internal Server Error An unexpected error occurred. Consult the log files.

HTTP-404: Not found An incorrect URL was entered or the host name is incorrect.


https://integratorng-trac.cvsdude.com/integratorng/wiki/AcquisitionException

RE-INSTALLING OR UNINSTALLING THE WINDOWS SERVICE

ReInstalling or Uninstalling the Windows Service 10

If the Windows Service needs to be re-installed or un-installed, complete the following steps:

Reinstalling the Windows Service

To re-install the Windows Service:

1. Access the bin directory:install_root/adapters-2.4/bin

2. Run the installation script.service.bat install

Uninstalling the Windows Service

To uninstall the Windows Service:

1. Access the bin directory:install_root/adapters-2.4/bin

2. Run the un-install script.service.bat uninstall

Starting and Stopping the Adapter 10

If the Windows Service has been uninstalled and the Adapter needs to be started, the startAdapters.bat file is included in the following directory:

install_root/adapters-2.4/bin/startAdapters.bat

This command starts the Adapter framework with a command window. To stop the Adapter framework, close the command window.

144 VERSION 2.4 REV A01 300-011-519

UNINSTALLING THE ADAPTER SOFTWARE - WINDOWS

Uninstalling the Adapter Software Windows 10

To uninstall the EMC Adapter software, complete the following tasks:1. From the Start menu, select the Uninstall Adapters option.2. The Uninstall EMC Adapters Introduction screen displays. From this screen,

click Uninstall.Figure 10-3 Uninstall Introduction



3. The Uninstaller begins to remove features associated with the installed Adapter. It then uninstalls the EMC Adapter files, shortcut, LaunchAnywhere features, folders, and registry.

Figure 10-4 Uninstall In Progress

146 VERSION 2.4 REV A01 300-011-519


4. The Uninstallation Complete screen displays. The files that were not installed may be displayed on the screen. These files must be removed manually. Click Done.

Figure 10-5 Uninstallation complete



148 VERSION 2.4 REV A01 300-011-519

11Chapter
IT Object Model (ITOM) 1
This chapter identifies the Event mappings for the OMNIbus Adapter.


VERSION 2.4 REV A01 300-011-519

bel) Type Notes

varchar(255)

varchar(64)

varchar(255)

int 0=Type not set, 1= Problem, 2=Resolution, 13=Information

int 0=Clear, 1=Indeterminate, 2=Warning, 3=Minor, 4=Major, 5=Critical

int

150

Table 11-1 ITOM Event Mapping for OMNIbus

Name Description Type Name (La

Base.Identifier The unique identifier for an Event xs:string Identifier

Base.Summary Summary of the Event xs:string EventId

Base.Description Detailed description of the Event xs:string Summary

Type Event type xs:string Type

Status The status of the event xs:string

Severity The severity of the event Severity

Impact The impact that this event has on the system xs:string

Urgency The urgency of the event xs:string

Priority The priority of the event xs:string

RepeatCount A count of the number of duplicate events xs:integer Tally

LastRepeatDate Date of the last duplicated event xs:datetime

—sheet 1 of 7—

151

int

rren time

st time

bel) Type Notes

EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE

Owner Owner that is responsible for resolving this event xs:string OwnerUID

CreateDate Date that this event was created xs:datetime FirstOccuce

ResolvedDate Date that this event was resolved xs:datetime

ResolvedBy User that resolved the event xs:string

LastModifiedBy User that made the last modification xs:string

LastModified Date of the last modification to this event xs:datetime InternalLa

StatusLastModified Date that the status of this event was last modified

xs:datetime

LastModifiedByNonConnector

Date that this event was last modified by a non-connector

xs:datetime

MaintenanceModeLastModified

Date of the last modification to this event while in maintenance mode

xs:datetime

MonitorEvent Flag to indicate whether this is an event generated by a monitor

xs:boolean

ExternalEventIdentifier The unique identifier for this event in the external system

xs:string

ExternalIncidentIdentifier

The unique identifier for an incident associated with this event

xs:string

Escalation Indicates information about the escalation of this event

Table 11-1 ITOM Event Mapping for OMNIbus (continued)


—sheet 2 of 7—

VERSION 2.4 REV A01 300-011-519

int 0 = Not escalated, 1 = escalated

int 6601=TEC EIF Probe

bel) Type Notes

152

Escalation.Escalated Unique identifier of the group associated with this event

xs:boolean Grade

Escalation.Server Server that escalated this event xs:string

Escalation.EscalatedBy User who escalated this event xs:string

Group Group that encompasses the components associated with this event

Group.Identifier Unique identifier of the group associated with this event

xs:string

Group.Name Name of the group associated with this event xs:string

Group.Version Version number of the group associated with this event

xs:string

Class Class of object targeted by this event

Class.Identifier Unique identifier of the class xs:string Class

Class.Name Formal name of the class xs:string

Class.DisplayName Console display name of the class xs:string

Class.Description Description of the class xs:string

Class.Container.Identifier

Unique identifier of the container where the class is defined

xs:string

Class.Container.Name Formal name of the container where the class is defined

xs:string



—sheet 3 of 7—

153

varchar(64)

varchar(64)

p varchar(64)

bel) Type Notes


Class.Container.DisplayName

Console display name of the container where the class is defined

xs:string

Class.Container.Description

Description of the container where the class is defined

xs:string

Object Object targeted by this event

Object.Identifier Unique identifier of the target object xs:string AlertKey

Object.ComputerName Name of the computer where this object is located

xs:string Location

Object.DisplayName Display name of the target object xs:string

Object.Name Formal name of the target object xs:string

Object.State State of the target object xs:string

Object.InMaintenanceMode

Flag that indicates whether the object is in maintenance mode

xs:boolean

Metric Metric that was violated to trigger the event

Metric.Category Name of the metric category that was violated xs:string AlertGrou

Metric.Subcategory Name of the metric subcategory that was violated

xs:string

Metric.KeyValues Array of key values associated with the metric xs:string

Source Notification source that generated the event



—sheet 4 of 7—

VERSION 2.4 REV A01 300-011-519

varchar(64)

varchar(64)

ial int

e varchar(64)

bel) Type Notes

154

Source.Identifier Unique identifier of the source that generated this event

xs:string

Source.Type Type of source that generated this event xs:string

Source.DisplayName Console display name of the source that generated this event

xs:string Node

Source.Name Formal name of the source that generated this event

xs:string NodeAlias

Source.Description Description of the source that generated this event

xs:string

Source.Domain Domain of the computer that generated this event

xs:string

Source.ComputerName Fully qualified name of the computer that originated this event

xs:string

Source.Container.Identifier

Unique identifier of the container that defines the source that originated this event

xs:string ServerSer

Source.Container.DisplayName

Console display name of the container that defines the source that generated this event

xs:string ServerNam

Source.Container.Name Formal name of the container that defines the source that generated this event

xs:string

Source.Container.Description

Description of the container that defines the source that generated this event

xs:string

Knowledge Knowledge entry associated with this event



—sheet 5 of 7—

155

bel) Type Notes


Knowledge.Type Type of knowledge entry xs:string

Knowledge.Summary Brief description of the knowledge entry xs:string

Knowledge.Description Description of the knowledge entry xs:string

Knowledge.DisplayName

Console display name of the knowledge entry xs:string

Knowledge.Name Formal name of the knowledge entry xs:string

Knowledge.Content Knowledge entry information in a common format. Format to be used is TBD

xs:string

Knowledge.Identifier Unique identifier of the knowledge entry xs:string

Knowledge.LanguageCode

Language used in the knowledge information xs:string

Knowledge.LastModified Date the knowledge entry was last updated xs:datetime

Knowledge.Status Status of the knowledge entry xs:string

Knowledge.dateCreated Date the knowledge entry was created xs:datetime

Log Logging Activity

Log.Identifier Log unique identifier for each instance xs:string

Log.Type Type of Log activity xs:string

Log.Summary Log Summary xs:string

Log.Source Log Source xs:string



—sheet 6 of 7—

VERSION 2.4 REV A01 300-011-519

bel) Type Notes

156

Log.Description Log Description xs:string

Log.Submitter User who submtted the log entry xs:string

Log.SubmitDate The date and time the log entry was submitted xs:datetime



—sheet 7 of 7—

Index 1

Aacknowledge 39acquisition

monitoring 91WSDL URL location 33

acquisition service 21polling methods 33process flow 21scaling 107

adapterfailover infrastructure 108management 133

Adapter configurationrecommended 46

Adapter Framework 15running as a Windows service 83starting 144stopping 144

agentscaling 108

alertsautomated 91

Apache Derby 42asynchronous 73

Bbase URLs 90blocking methods 34

Cclear 39client acquisition service

running on another port 105create 39

Ddatabase

monitoring 90databases

enabling support for another database 90external

user for multiple adapters 108supported 42

datasource properties 90discovery service 36

Eerror messages

notification service 143types 142URL Agent 143

error typespermanent 142recoverable 142

errors 143Adapter 143

event generationconnect and disconnect 101

event methods 39

Ffind 39framework HTTP authentication 90framework properties 88

for the global framework 89

Gget 40global framework properties 89

Hhigh availability 107


IInformation Technology Service Management 16install folder 65install set 50, 64installer

Linux 85starting 48Unix 85

ITIL services 16supported object types 17

ITSM 16applications 13

JJava console

starting 135Java Management Extensions 133Java to Adapter integration 109JMX 133

management beans 135

Llicense file 67

directory location 47installing 47

loglocation

for UNIX 139for Windows 139

log4j.properties file 139logging 139

turning onfor Windows 139

URL Agent daemon 114

Mmaster probe

port 76server location 76

Nnotification agent 20notification service 25

error messages 143

Oobject server

configure 99

operating systemssupported 41

operations service 27process flow 27scaling 107

operations web serviceWSDL URL location 39

Ppassword

iMS 70web service authentication 69

permanent errors 142persistence database 111

changing the port number 112connecting to 112removing transactions 111

polling methods 33properties editor 88

command 89starting 88

Pythonrequired for the URL Agent 113

Rrecoverable errors 142RESTful Client Acquisition 104

Ssecurity 68service ID 74shortcut folder 66slave probe

port 76server location 76

SOAP client acquisition service 105software

uninstallWindows 145

software installation 43for Windows 48manual 86

UNIX 86Windows 86

synchronous 73system configuration 41system requirements 41

158 VERSION 2.4 REV A01 300-011-519

Tterminal methods 34troubleshooting 139

error types and meanings 142

Uupdate 39URL

iMS 70URL Agent 113

command options 115daemon 114

logging 114shutting down 114starting 114

error messages 143logging 142modifying script files 96running 115using 113

usernameiMS 70web service authentication 69

Wweb service authentication 69Windows service

exectuable location 83manager application 83manual install or uninstall 144re-installing 144running 83uninstalling 144


160 VERSION 2.4 REV A01 300-011-519

B

EMC Corporation

Corporate Headquarters, Hopkinton, MA 01748-9103U.S.A.

Tel.:1-508-435-1000

http://www.EMC.com

EMC Ionix IT Orchestrator AdapterIBM OMNIbusInstallation and Configuration Guide

Document number: 300-011-519Product release: 2.4Document version: A01Date: September 2010

Printed in the United States of America.Copyright © 2010, EMC Corporation All Rights Reserved

B

Documents

Dell...EMC IONIX IT ORCHESTRATOR ADAPTER IBM OMNIBUS INSTALLATION AND CONFIGURATION GUIDE iii Table of Contents 1 Preface vii Audience