HP UCMDB DICG Third Party Integrations

HP Universal CMDB
Software Version: UCMDB 10.10, CP 13.00
Universal Discovery Content Guide - Third Party

Integrations
Document Release Date: November 2013
Software Release Date: November 2013

Legal Notices
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted Rights Legend

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial
license.
Copyright Notice
© Copyright 1996 - 2013 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
AMD and the AMD Arrow symbol are trademarks of Advanced Micro Devices, Inc.
Google™ and Google Maps™ are trademarks of Google Inc.
Intel®, Itanium®, Pentium®, and Intel® Xeon® are trademarks of Intel Corporation in the U.S. and other countries.
Java and Oracle are registered trademarks of Oracle Corporation and/or its affiliates.
Microsoft®, Windows®, Windows NT®, Windows® XP, and Windows Vista® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
l This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
l This product includes OpenLDAP code from OpenLDAP Foundation (http://www.openldap.org/foundation/).
l This product includes GNU code from Free Software Foundation, Inc. (http://www.fsf.org/).This product includes JiBX code from Dennis M. Sosnoski.
l This product includes the XPP3 XMLPull parser included in the distribution and used throughout JiBX, from Extreme! Lab, Indiana University.
l This product includes the Office Look and Feels License from Robert Futrell (http://sourceforge.net/projects/officelnfs).
l This product includes JEP - Java Expression Parser code from Netaphor Software, Inc. (http://www.netaphor.com/home.asp).
Documentation Updates
The title page of this document contains the following identifying information:
l Software Version number, which indicates the software version.
l Document Release Date, which changes each time the document is updated.
l Software Release Date, which indicates the release date of this version of the software.
To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html
Or click the New users - please register link on the HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.
Support
Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport
This web site provides contact information and details about the products, services, and support that HP Software offers.
HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage
your business. As a valued support customer, you can benefit by using the support web site to:
l Search for knowledge documents of interest
l Submit and track support cases and enhancement requests
l Download software patches
l Manage support contracts
l Look up HP support contacts
l Review information about available services
HP Universal CMDB (UCMDB 10.10, CP 13.00) Page 2 of 177

Universal Discovery Content Guide - Third Party Integrations
l Enter into discussions with other software customers

l Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
To find more information about access levels, go to:
http://h20230.www2.hp.com/new_access_levels.jsp
HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions to meet your
business needs, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site is
http://h20230.www2.hp.com/sc/solutions/index.jsp

Contents
Contents
Chapter 1: Aperture VISTA Integration 10

Overview 11
Supported Versions 11
Topology 11
How to Use the Aperture VISTA Integration Adapter 12
Aperture VISTA by SQL Adapter 13
Discovery Mechanism 14
Chapter 2: Atrium Integration 16

Overview 17
How to Work with the Data Push to Atrium Adapter 18
How to Work with the Population from Atrium Adapter 22
Atrium Push Job 27
Data Push into Atrium Adapter 27
Import Data from Atrium Job 29
Population from Atrium Adapter 29
Mapping Files 31
Mapping Files Overview 31
Mapping File Structure 31
Mapping File Elements 32
Troubleshooting and Limitations 35
Chapter 3: CA CMDB Integration 36

Overview 37
Integration Mechanism 37
How to Work with the CA CMDB Push Adapter 38
Integration Query 40

Contents
Chapter 4: CiscoWorks LAN Management Solution Integration 42

Overview 43
Topology 43
How to Discover CiscoWorks LMS 44
CiscoWorks LMS Database Ports Job 45
Adapter 45
Trigger Query 45
Parameters 45
Network Devices from CiscoWorks LMS Job 45
Adapter 45
Trigger Query 45
Layer 2 Topology from CiscoWorks LMS Job 46
Adapter 46
Trigger Query 46
Discovery Flow 47
CiscoWorks NetDevices Adapter 47
CiscoWorks Layer 2 Adapter 48
Chapter 5: EMC Control Center (ECC) Integration 54

Overview 55
Topology 55
How to Run the ECC/UCMDB Integration Job 56
ECC Integration Job 58
Views 61
Impact Analysis Rules 66
Reports 68
Chapter 6: IDS Scheer ARIS Integration 72

Overview 73

Contents
Topology 73
How to Run the ARIS Integration Job 74
Import CIs from ARIS Job 80
Chapter 7: Importing Data from External Sources 82

Overview 83
Comma Separated Value (CSV) Files 83
CSV Files with Column Titles in First Row 84
Databases 84
Properties Files 84
How to Import CSV Data from an External Source – Scenario 85
How to Convert Strings to Numbers 90
Custom Converters 91
External_source_import Package 91
Import from CSV File Job 92
Import from Database Job 95
Import from Properties File Job 100
External Source Mapping Files 101
Chapter 8: Import from Excel Workbook Discovery 103

Overview 104
Topology 104
How to Import Data from Excel Workbook 104
How to Set Up an Import File in Excel 106
Import from Excel Workbook Job 115
Chapter 9: Microsoft SCCM/SMS Integration 120

Overview 121
SMS Adapter 121

Contents
How to Populate the CMDB with Data from SCCM/SMS 123
How to Federate Data with SCCM/SMS 124
How to Customize the Integration Data Model in UCMDB 125
Predefined Query for Population Jobs 126
SCCM/SMS Integration Package 126
SMS Adapter Configuration Files 129
Chapter 10: NetApp SANscreen/OnCommand Insight Integration 131

Overview 132
Topology 132
How to Discover NetApp SANscreen 133
SANscreen Integration by WebServices Job 134
Adapter 134
Parameters 134
Integration Flow 134
SANscreen Adapter 135
Chapter 11: ServiceNow Integration 138

Overview 139
How to Integrate ServiceNow with UCMDB 139
Sample Integration Push Query 141
Supported CITs 142
Pushing Additional CITs 143
Chapter 12: Storage Essentials (SE) Integration 145

Overview 147
How to Perform the SE Integration 147

Contents
Storage Essentials Integration Packages 148
Adapter Parameters 148
Discovered CITs and Relationships 149
Node Details 151
SAN Topology 152
Storage Topology 153
Views 154
Storage Array Details 154
FC Switch Details 154
FC Switch Virtualization 155
Storage Pool Details 155
Host Storage Details 156
SAN External Storage 156
SAN Topology 157
FC Port to FC Port 158
FC Switch Devices to FC Switch 160
Host Devices to Host 160
Logical Volume to Logical Volume 161
Storage Array Devices to Storage Array 161
Reports 162
Storage Array Configuration 162
Host Configuration 162
Storage Array Dependency 163
Host Storage Dependency 163
Storage Pool Configuration 163
Chapter 13: Troux Integration 165

Overview 166

Contents
Integration Overview 166
Use Cases 167
How to Work with the Troux Push Adapter 167
How to Run a Troux Population Job 173
Chapter 14: UCMDB to XML Adapter 175

Overview 176
How to Export UCMDB to XML 176
Adapter 177

Chapter 1: Aperture VISTA Integration
This chapter includes:
Overview 11
Topology 11
How to Use the Aperture VISTA Integration Adapter 12
Aperture VISTA by SQL Adapter 13

Overview
Aperture VISTA is used to model datacenter information, including the exact location of a physical
server in a rack, row, space, and floor of a datacenter. VISTA also contains detailed information
about the power supply to racks and individual servers. This enables impact analysis from a power
supply point of view, and with integration it becomes possible to analyze the impact of power failure
on applications, business services and lines of business in UCMDB.
Integration is accomplished by running SQL queries on the Aperture VISTA SQL database.
Supported Versions
UCMDB supports integration with Aperture VISTA version 600. Aperture Integration Management
Software Package version 2.0 or later is required.
Topology
The following image displays datacenter topology from VISTA.

Note: For a list of discovered CITs, see "Discovered CITs" on the next page.
How to Use the Aperture VISTA Integration

Adapter
1. Prerequisite - Scripts
The following scripts should be run on the VISTA database:
n v600_VIP_DAL_DV_Devices.sql
n v600_Device_to_PDU.sql
The scripts are located in the discovery probe at

<hp>\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\VistaScript
s
2. Prerequisite - Credentials
Population is accomplished using SQL queries over JDBC. The following credentials should be
defined:
n Generic DB Protocol (SQL)
For credential information, see "Supported Protocols" in the HP Universal CMDB Discovery
and Integration Content Guide - Supported Content document.
3. Run the job

a. Run Range IPs by ICMP to discover the IP address of the SQL Server used by Aperture
VISTA.
b. Run Database TCP Ports to discover SQL Server ports on the IP addresses discovered
above.
c. Run MSSQL Connection by SQL to discover the SQL Server instance used by Aperture
VISTA.
d. Run MSSQL Topology by SQL to discover database instances in the SQL Server
instance discovered above.
e. Create a new integration point, and use the Aperture VISTA by SQL adapter to discover
datacenter and power infrastructure from VISTA.

Aperture VISTA by SQL Adapter

This section contains details about the adapter.
Input CIT
Microsoft SQL Server
Input Query
Triggered CI Data
Name Value
credentialsId ${SOURCE.credentials_id}
ip_address ${SOURCE.application_ip}
port ${PROCESS.application_port}
Used Script
Aperture_Vista_by_SQL.py
Discovered CITs
l Chassis
l Composition
l Containment
l Datacenter

l DatacenterResource
l Node
l PowerDistributionUnit
l Rack
l RemotePowerPanel
l Usage
Discovery Mechanism
Aperture VISTA uses a Microsoft SQL Server database as its data store. The Aperture Integration
Management software package (v2.0 or greater) adds some views to the VISTA database, and this
integration adapter collects information by running SQL Queries against these views.
The integration adapter in this package is triggered by SQL Server instances in UCMDB that have a
database instance with vista in their name. Out-of-the-box discovery jobs may be used to discover
these SQL Server database instances.
The adapter works as follows:
1. Datacenter and Power Infrastructure Details

It runs the following SQL query to get details on Datacenter and Power infrastructure from the
Aperture VISTA data store:
SELECT device_name, device_serial_number, device_asset_class, device_manufac

turer, device_model, device_model_info, rack_name, rack_asset_number, rack_s
erial_number, row_name, grid_location, space_name, floor, building_name, par
ent_name, parent_serial_number
FROM vista.dbo.vip_dal_dv_devices
WHERE device_asset_class='SERVER' OR device_asset_class='PDU' OR device_asse

t_class='RPP' OR device_asset_class='CHASSIS' OR device_asset_class='RACK'
GROUP BY device_name, device_serial_number, device_asset_class, device_manuf

acturer, device_model, device_model_info, rack_name, rack_asset_number, rack_
serial_number, row_name, grid_location, space_name, floor, building_name, pa
rent_name, parent_serial_number
ORDER BY device_asset_class, device_name
2. Identification of Power Supply Routing

After all the infrastructure, power, and server CIs are created, the adapter uses the following

query to identify power supply routing to servers:
SELECT downstream_device_name, downstream_device_serial_number, upstream_dev

ice_name, upstream_building_name
FROM vista.dbo.vip_dal_pwr_device_power_sources
WHERE (downstream_device_name IS NOT NULL OR downstream_device_serial_number

IS NOT NULL) AND upstream_device_name IS NOT NULL AND upstream_building_name
IS NOT NULL AND upstream_node_type='PDU'
GROUP BY downstream_device_name, downstream_device_serial_number, upstream_d

evice_name, upstream_building_name
ORDER BY downstream_device_name

Chapter 2: Atrium Integration
Overview 17
How to Work with the Data Push to Atrium Adapter 18
How to Work with the Population from Atrium Adapter 22
Atrium Push Job 27
Data Push into Atrium Adapter 27
Import Data from Atrium Job 29
Population from Atrium Adapter 29
Mapping Files 31

Overview
UCMDB-Atrium integration consists of two independent, bi-directional parts: the Data Push into
Atrium and the Population from Atrium.
l The Data Push into Atrium in UCMDB replicates CIs and relationships to Atrium and
Remedy.
The out-of-the-box integration does not transfer a specific list of CIs and relationships, but does
enable you to replicate any CI or relationship from UCMDB to Remedy or Atrium.
For examples of enabling the integration with commonly used CIs and relationships, see
"Configure synchronization queries" on page 21.
l The Population from Atrium in UCMDB pulls CIs and relationships from Atrium to UCMDB.
Supported Versions
HP Universal CMDB integrates with the following BMC products:
l BMC Remedy Service Desk (Remedy) versions 7.0, 7.1, 7.5, and 7.6
l BMC Atrium CMDB (Atrium) versions 2.0, 2.1, 7.5.x, 7.6.x and earlier, 8.1

How to Work with the Data Push to Atrium

Adapter
This task includes the following steps:
l "Prerequisite- Set up protocol credentials" below
l "Configure the Properties file" below
l "Configure the Data Flow Probe" on the next page
l "Configure synchronization queries" on page 21
l "Create XML mapping files" on page 21
l "Create an integration point" on page 21
l "Define a Job" on page 22
l "Invoke a full run of the job" on page 22
1. Prerequisite- Set up protocol credentials

Make sure that you have set up the Remedy protocol. For credential information, see
"Supported Protocols" in the HP Universal CMDB Discovery and Integration Content Guide -
Supported Content document.
2. Configure the Properties file

Configure the push.properties file: Data Flow Management > Adapter Management >
Resources > Packages > AtriumPushAdapter > Configuration Files > push.properties.
Property Description
jythonScript.name The name of the Jython script that is invoked by this push
adapter.
mappingFile.default The default XML mapping file used by mapping if a specific

XML mapping file is not defined for an integration query. At
least one default mapping file must be present in every
adapter.
DebugMode If this value is set to true, the CI and relationships being

pushed to Remedy/Atrium are also saved to XML files on the
Data Flow Probe, under the following folder:
/discoveryResource/AtriumPushAdapter/work.

Property Description
smartUpdateIgnoreFields A comma separated list of attributes (transferred from

UCMDB to Atrium) that should not be used to check whether
a CI has changed in Atrium. For example, as updateTime
always changes, you would not want to update a CI in Atrium
just because this attribute has changed.
sortCSVFields Parameter that includes the TQL results of CSV aggregated

fields that must always be sorted. When child attribute values
are mapped and aggregated as CSV, the results are not
sorted. This can trigger an update, even though nothing has
changed in Atrium. To prevent an update, add here the CSV
aggregated fields that must always be sorted.
testConnNameSpace Must be set to the BMC NameSpace being used for test
connection purposes (for example, BMC.CORE).
testConnClass Must be set to the name of a BMC class, to query for

connection test purposes (for example, BMC_
ComputerSystem).
3. Configure the Data Flow Probe

a. For Atrium 7.6.04 and earlier versions: Copy the JAR and DLL files listed in Table 1
below from the BMC server to the following directory on the Data Flow Probe server:
C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\
AtriumPushAdapter.
For Atrium 8.1: Copy the files arapi81_build001.jar and cmdbapi.jar from the BMC
server to the following directory on the Data Flow Probe server:
AtriumPushAdapter.
The directory
AtriumPushAdapter is automatically created once the AtriumPushAdapter package is
deployed on the UCMDB Server. If it is not present, ensure that the AtriumPushAdapter
package has been correctly deployed on the UCMDB Server.
For details on deploying packages, see "Package Manager" in the HP Universal CMDB
Administration Guide.

Table 1
JAR Files DLL Files
arapi75.jar arapi75.dll
arutil75.jar arencrypt75.dll
cmdbapi75.jar arjni75.dll
commons-beanutils.jar arrpc75.dll
commons-codec-1.3.jar arutiljni75.dll
commons-collections-3.2.jar arutl75.dll
commons-configuration-1.3.jar arxmlutil75.dll
commons-digester-1.7.jar cmdbapi75.dll
commons-lang-2.2.jar cmdbjni75.dll
log4j-1.2.14.jar icudt32.dll
oncrpc.jar icuinbmc32.dll
spring.jar icuucbmc32.dll
Xalan-Cbmc_1_9.dll
XalanMessagesbmc_1_9.DLL
xerces-cbmc_2_6.dll
xerces-depdombmc_2_6.dll
Note:
o The AR System Java API is forward and backward compatible with other versions
of the AR System, except Atrium version 7.6.0.4 where you must use the SDK of
the same version. For a complete compatibility matrix, refer to the "API
Compatibility" section in the BMC Remedy/Atrium Developer Reference Guide.
o The arencrypt*.dll files are only required if encryption is enabled on the Remedy
server.
b. Edit the WrapperGateway.conf file (or WrapperManager.conf if the Probe Manager and
Gateway are running in separate mode) in the following directory:
C:\hp\UCMDB\DataFlowProbe\bin.

Add the following line after the wrapper.java.library.path.2=%content_dll% line:
wrapper.java.library.path.3=%runtime%/probeManager
/discoveryResources/AtriumPushAdapter
c. For Atrium 7.6.04 and earlier versions only: Add the complete path to the Atrium DLL
files (for example,
AtriumPushAdapter) to the Windows System Path on the Data Flow Probe machine.
d. Restart the Data Flow Probe service.
4. Configure synchronization queries

The CIs and relationships to be pushed to Remedy/Atrium must be queried from UCMDB.
Create queries (of type Integration) to query the CIs and relationships that have to be pushed
to Remedy/Atrium.
An example of such a query (atrium_push_sample_query) is included with the Atrium

package. To access the query, navigate to Modeling > Modeling Studio > Root >
Integration > Atrium.
5. Create XML mapping files

For every query created in the step above, create an XML mapping file with the same name as
the integration query (the name must have the same case) in the following directory:
C:\hp\UCMDB\UCMDBServer\runtime\fcmdb\CodeBase\AtriumPushAdapter\
mappings
A sample mapping file (atrium_push_sample_query.xml) is provided out-of-the-box with the

Atrium package.
For more details, see "Mapping Files" on page 31.
6. Create an integration point

For details about creating an integration point, see "Integration Point Pane" in the HP Universal
CMDB Data Flow Management Guide.

a. In the Integration Studio, create an integration point, selecting the Data Push into Atrium
adapter. Enter the following information:
Name Description
Credentials o Select Remedy Protocol.
o Select the credentials to be used with this integration point.
For credential information, see "Supported Protocols" in the

HP Universal CMDB Discovery and Integration Content Guide -
Supported Content document.
Hostname/IP The host name or IP address of the BMC Remedy server.
Integration The name you give to the integration point.

Name
Is Select this check box to create an active integration point. You clear the
Integration check box if you want to deactivate an integration, for instance, to set up
Activated an integration point without actually connecting to a remote machine.
Port The port number of the BMC Remedy server.
Data Flow Select the Data Flow Probe that should run this integration.
Probe
b. Test the connection. If a connection is not successfully created, check the integration point
parameters and try again.
c. Save the integration point.
7. Define a Job
For details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP Universal
Select the queries that will synchronize data between UCMDB and Remedy/Atrium. Save the
job definition and the integration point.
8. Invoke a full run of the job
In the Integration Studio, on the Job Definition tool bar, click to run a full discovery job. For
details, see "Integration Jobs Pane" in the HP Universal CMDB Data Flow Management
Guide.
How to Work with the Population from Atrium

Adapter

1. Prerequisites - File preparation

a. For Atrium 7.6.04 and earlier versions: Locate the files listed in Table 2 on the Remedy
ARS and Atrium system and copy them to:
C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\AtriumI
mportAdapter
Note: All the files listed in Table 2 are required.
For Atrium 8.1: Locate the files arapi81_build001.jar and cmdbapi.jar on the Remedy
ARS and Atrium system and copy them to:
C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\AtriumI
mportAdapter

Table 2
JAR Files DLL Files
arapi75.jar arapi75.dll
arutil75.jar arencrypt75.dll
cmdbapi75.jar arjni75.dll
commons-beanutils.jar arrpc75.dll
commons-codec-1.3.jar arutiljni75.dll
commons-collections-3.2.jar arutl75.dll
commons-configuration-1.3.jar arxmlutil75.dll
commons-digester-1.7.jar cmdbapi75.dll
commons-lang-2.2.jar cmdbjni75.dll
log4j-1.2.14.jar icudt32.dll
oncrpc.jar icuinbmc32.dll
spring.jar icuucbmc32.dll
Xalan-Cbmc_1_9.dll
XalanMessagesbmc_1_9.DLL
xerces-cbmc_2_6.dll
xerces-depdombmc_2_6.dll
Note:
o The AR System Java API is forward and backward compatible with other versions
of the AR System, except Atrium version 7.6.0.4 where you must use the SDK of
the same version. For a complete compatibility matrix, refer to the "API
Compatibility" section in the BMC Remedy/Atrium Developer Reference Guide.
o The arencrypt*.dll files are only required if encryption is enabled on the Remedy
server.
b. Edit the WrapperGateway.conf file (or WrapperManager.conf if the Probe Manager and
Gateway are running in separate mode) in the following directory:
C:\hp\UCMDB\DataFlowProbe\bin.

Add the following line after the wrapper.java.library.path.2=%content_dll% line:
wrapper.java.library.path.3=%runtime%/probeManager
/discoveryResources/AtriumPushAdapter
c. For Atrium 7.6.04 and earlier versions only: Add the complete path to the Atrium DLL
files (for example, C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\
discoveryResources\AtriumImportAdapter) to the Windows System Path on the Data
Flow Probe machine.
2. Prerequisites - Set up protocol credentials

Configure a generic protocol with the ARS server's username and password.
Note: While creating the generic protocol, set the protocol description to atrium.
3. Prerequisites - Create XML mapping files

This step involves creating XML mapping files (in the
<probe>\runtime\probeManager\discoveryResources\TQLExport\Atrium\data directory).
These files map the BMC Atrium classes, attributes and relationships to their UCMDB
equivalents. To create the XML mapping files for the topology requires identification of the
topology to be imported from Atrium, and ensuring an equivalent topology exists in UCMDB.
For more details, see "Mapping Files" on page 31.
4. Run the job

In DFM, in the Integration Studio, create a new integration point.
a. Provide a name and description for the integration point.
b. Under Integration Properties > Adapter, select the Population from Atrium adapter.
c. Configure the following adapter properties:
o ARS_Server
o ARS_Port
o BMC_NameSpace
d. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe to be used for
the integration.
e. Under Adapter Properties > Trigger CI instance select:
i. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane
appears. Select the CI, or

ii. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard
appears. Complete the creation of the CI using the Wizard.
Note: For details on the Topology CI Creation Wizard, see "Topology CI

Creation Wizard" in the HP Universal CMDB Data Flow Management Guide.
f. Save the integration point.
g. Run the job.
Note: For details on running an integration job, see "Integration Studio" in the HP
Universal CMDB Data Flow Management Guide.

Atrium Push Job

Adapter
This discovery uses the adapter called Data Push into Atrium.
Integration Flow
Integration includes the following activities:
1. Querying the UCMDB for CIs and relationships. When an ad-hoc integration job is run in
the Integration Studio, the integration process:
a. Receives the names of the integration queries that are defined in the job definition for that
integration point.
b. Queries UCMDB for the results (new, updated, or deleted CIs and relationships) of these
defined queries.
c. Applies the mapping transformation according to the pre-defined XML mapping files for
every query.
d. Pushes the data to the Data Flow Probe.
2. Sending the data to BMC Remedy/Atrium. On the Data Flow Probe, the integration
process:
a. Receives the CI and relationship data sent from the UCMDB Server.
b. Connects to the BMC Remedy/Atrium server using the Java API.
c. Transfers the CIs and relationships.
Data Push into Atrium Adapter

Used Script
pushToAtrium.py

Parameters
Parameter Description
credentialsId The credentials ID to use for Atrium

connection.
host The host name or IP address of the remote

Atrium server.
port The Atrium server's connection port (if not

using portmapper).
probeName An internal setting which UCMDB

automatically replaces.

Import Data from Atrium Job

Adapter
This job uses the adapter called Population from Atrium.
Integration Flow
The integration flow has the following steps:
1. Querying the Atrium server
In this step, the integration adapter connects to the Atrium server and queries it for classes,
attributes and relationships, described in the XML mapping files. The result of this step is the
creation of intermediate XML files (in the
<probe>\runtime\probeManager\discoveryResources\TQLExport\Atrium\inter directory).
2. Mapping the data
In this step, the data collected from the previous step and stored in the intermediate XML file, is
converted into the UCMDB data format based on the mappings defined in the XML mapping
files.
3. Pushing the data to the UCMDB server
In this final step, after being mapped into the UCMDB object state holder vector format, the
data is sent to the UCMDB server.
Population from Atrium Adapter

Input CIT
The input CIT for this adapter is discoveryprobegateway. The job uses an instance of the
Discovery Probe Gateway which has access to connect to the remote BMC Atrium server.
Used Scripts
The adapter uses the following scripts:
Script Description
atrium_query.py Used to query BMC Atrium for data.
atrium_map.py Used to map the queried data into data UCMDB can use.

Script Description
atrium_to_ucmdb.py Used to push imported data into UCMDB.
Discovered CITs
This integration can discover any CIT or relationship which is (a) mapped in the integration and (b)
can be queried and converted to its UCMDB equivalent.
Parameters
Parameter Detail
ARS_Port The port for connecting to the ARS server. If portmapper is being used, this
should be left as 0. Otherwise, specify the TCP port.
ARS_Server The hostname or IP address of the BMC ARS server.
BMC_ The BMC NameSpace to use. (For example: BMC.CORE.)

NameSpace
ChunkSize The chunk size in which data should be retrieved from the remote server.
DateParsePattern Set the date pattern to parse Atrium date strings.
DebugMode Set to true to run integration in debug mode; this does not send data to
UCMDB.

Mapping Files
This section includes:
Mapping Files Overview

A mapping file is an XML file that defines which CIT or relationship in UCMDB is mapped to which
CIT or relationship in the target data store.
Mapping files:
l Control which CITs and relationships are to be pushed.
l Control the attributes for the CITs and relationships that are to be mapped.
l Map attribute values from multiple CIs to one target CI.
l Map attributes of children CIs (those having a containment or composition relationship) to the
parent CI in the target data store. For example:
n Set a Number of CPUs value for a target node CI.
n Set a Total Memory value for a target node CI.
l Map attributes of parent CIs (those having a containment or composition relationship) in the
target data store CI. For example, in the Atrium target data store, set the value of a Container
Server attribute on the Installed Software CIT by retrieving the value of the UCMDB Installed
Software CI container node.
Mapping File Structure

Every mapping file has the following skeletal structure:
<?xml version="1.0" encoding="UTF-8"?>

<integration>
<info>
<source ... ... />
<target ... ... />
</info>
<source_ci_type name="...">
<target_ci_type name="...">
<targetprimarykey>

<pkey>...</pkey>
</targetprimarykey>
<target_attribute name="..." datatype="..." >
<map type="..." />
</target_attribute>
</target_ci_type>
</source_ci_type>
</integration>
Note: An elipsis (...) signifies a configurable section.
Mapping File Elements

Main Parent Elements
l <integration>. The root element of the XML file. This element has no attributes.
l <info>. The source and target data stores being used, for example:
<info>
<source name="Atrium" versions="7.6" vendor="BMC" />
<target name="UCMDB" versions="9.0" vendor="HP" />
</info>
l <targetcis>. The element that encapsulates the mapping for all CI types.
l <targetrelations>. The element that encapsulates the mapping for all relationship types.
CI Type Mapping Elements
l <source_ci_type>. The element that defines a CI type of the source data store, for example:
<source_ci_type name="BMC_ComputerSystem" nameSpace="BMC.CORE" query="" mode="

update_else_insert">
n Attribute: name. Defines the name of the source CI type.
n Attribute: namespace. Defines the namespace in the Atrium system that the CI type is
associated with.
n Attribute: query. Allows applying an additional filter to the query result.
For example, query="'DatasetId'="BMC.ASSET" AND

'AssetLifecycleStatus'!=8".

n Attribute: mode. Defines the mode of the update in the target data store. The possible
values are: update, insert, and update_else_insert.
l <target_ci_type>. The element that defines the target CIT, for example:
<target_ci_type name="unix">
n Attribute: name. Defines the name of the target CIT.
l <targetprimarykey>. The element that defines a list of all primary keys of the target CIT, for
example:
<targetprimarykey>
<pkey>host_key</pkey>
</targetprimarykey>
l <target_attribute>. The element that defines an attribute mapping from the source CI type to
the target CI type attribute. Attribute mapping can be of the following types:
n Constant. This type enables setting a constant value on the target attribute:
<target_attribute name="data_note" datatype="string" length="127">

<map type="constant" value="ATRIUM DATA" />
</target_attribute>
n Direct. This type enables setting a direct value of a source data store attribute on the target
data store:
<target_attribute name="name" datatype="string">

<map type="direct" source_attribute="Name" />
</target_attribute>
n Compound String. This type enables the use of the above mapping types together to form
more complex values for the target attribute, for example:
<target_attribute name="Bunch_O_Data" datatype="char" length="510" option="

uppercase">
<map type="compoundstring">
<source_attribute name="name"/>
<constant value="_UNIX_Server, IP="/>
<childattr name="ip_address" source_attribute="ip_address" aggregation=
"csv"/>
<constant value=", CPU="/>
<childattr name="cpu" source_attribute="display_label" aggregation="cs
v"/>
</map>
</target_attribute>

Relationship Type Mapping Elements
l <link>. The element that defines a relationship mapping from the source data store to a target
data store, for example:
<link source_link_type="composition"
target_link_type="BMC_HostedSystemComponents"
source_ci_type_end1="unix"
source_ci_type_end2="cpu"
role1="Source"
role2="Destination "
mode="update_else_insert">
<target_ci_type_end1 name="BMC_ComputerSystem"
superclass="BMC_System" />
<target_ci_type_end2 name="BMC_Processor"
superclass="BMC_SystemComponent" />
... Relationship attribute mapping elements similar to the CI type attribu
te mapping elements ...
</link>
n Attribute: source_ci_type_end1. The End1 CI type of the source link.
n Attribute: source_ci_type_end2. The End2 CI type of the source link.
n Attribute: source_link_type. Defines the name of the source link. To specify namespace, use
the following format: "NAMESPACE:CLASSNAME". For example: BMC.J2EE:BMC_
J2EEApplicationServer. The same format applies to <antecedent> and <dependent>
elements.
n Attribute: target_link_type. Defines the name of the target link. To specify namespace, use
the following format: "NAMESPACE:CLASSNAME". For example: BMC.J2EE:BMC_
J2EEApplicationServer. The same format applies to <antecedent> and <dependent>
elements.
n <target_ci_type_end1>. Used to specific the value of the target links end1 CI type
n <target_ci_type_end2>. Used to specific the value of the target links end2 CI type

Troubleshooting and Limitations

The integration mapping file enables the mapping only of concrete CI types and relationships to the
CI types and relationships in BMC Remedy/Atrium. That is, a parent CIT cannot be used to map
children CIs. For example, if UCMDB Node is mapped to BMC_ComputerSystem, any Node CIT
of type Unix is not transferred. A mapping must be separately created for Unix to BMC_
ComputerSystem.

Chapter 3: CA CMDB Integration
Overview 37
How to Work with the CA CMDB Push Adapter 38
Integration Query 40

Overview
The UCMDB - CA CMDB integration adapter allows pushing CIs and relationships from UCMDB
into CA CMDB.
This is achieved by querying the UCMDB for CIs and Relationships based on queries defined in the
push integration adapter. The output of the queried CIs and Relationships are saved in an XML file.
GRLoader, a utility provided with CA CMDB, transfers the CIs and Relationship data stored in the
XML file into CA CMDB. An XML mapping file is used to define how the CIs and Relationships in
UCMDB are related to the CIs and Relationships in CA CMDB.
The CA CMDB integration package is bundled in CACmdbPushAdapter.zip.
Supported Versions
UCMDB supports integration with CA CMDB R12.5 and R12.0.
Integration Mechanism
This section describes the UCMDB - CA CMDB integration mechanism:
1. UCMDB is queried for CIs and Relationships

a. When an ad-hoc job is run from the defined integration point, the integration receives the
names of the integration queries that have been defined in the job definition for that
integration point.
b. The integration process queries UCMDB for the results of these queries
(new/updated/deleted CIs and Relationships), and applies the mapping transformation
according to the pre-defined XML mapping files for every query.
c. It then pushes the data to the Data Flow Probes.
2. Queried data is converted into temporary XML files on the Data Flow
Probe system
On the Data Flow Probe side, the integration process receives the CI and Relationship data
sent from the UCMDB server, and converts it into a format which can be used as input XML for
the GRLoader, a utility provided with CA CMDB used to transfer the CI and Relationship data
into CA CMDB.
3. CA CMDB GRLoader utility is invoked on the Data Flow Probe system

The integration process programmatically invokes the CA CMDB GRLoader utility on the Data
Flow Probe system with the necessary parameters (for example, CA CMDB server, port,
username, and password), using the input XML file created in the previous step to transfers the
CIs and Relationship data into CA CMDB.

How to Work with the CA CMDB Push Adapter

The CA CMDB push adapter allows replication of CIs and Relationships from UCMDB to CA
CMDB.
This task includes:
l "Prerequisite - Other" below
l "Prerequisite - Set up the CA CMDB protocol" below
l "Configure integration queries" below
l "Create the XML mapping files" on the next page
l "Create an integration point" on the next page
1. Prerequisite - Set up the CA CMDB protocol

This integration uses the CA CMDB protocol. For credential information, see "Supported
Protocols" in the HP Universal CMDB Discovery and Integration Content Guide - Supported
Content document.
2. Prerequisite - Other
Data Flow Probe System:
a. Copy all of the files in the CA CMDB system's %NX_ROOT%\java\lib directory to the
CaCmdbPushAdapter directory on the data flow probe system:
<UCMDB Installation>\DataFlowProbe\runtime\probeManager\
discoveryResources\CaCmdbPushAdapter
b. Locate the file, NX.ENV, in the CaCmdbPushAdapter directory. If the file does not exist,
create it in the CaCmdbPushAdapter directory and add the following text to it:
@NX_LOG=C:/CA/java/lib/log
c. Open <UCMDB Installation>\DataFlowProbe\runtime\

probeManager\discoveryConfigFiles\globalSettings.xml, locate the following line, and
add ",CaCmdbPushAdapter/*.*" as illustrated in bold:
db/oracle/*.*;db/mssqlserver/*.*;db/db2/*.*;db/sybase/*.*;nnm/*.*;Atrium
PushAdapter/*.*;CaCmdbPushAdapter/*.*
3. Configure integration queries

Create integration queries to query the CIs and Relationships that must be pushed from
UCMDB to CA CMDB.

For an example of such an integration query, see "Integration Query" on the next page.
4. Create the XML mapping files

For every integration query that you create, create an XML mapping file with the exact same
name as the integration query (case-sensitive). Create the XML files in the following directory:
<UCMDB Installation>\UCMDBServer\runtime\fcmdb\CodeBase\
CaCmdbPushAdapter\mappings
For more information about mapping files, see "Prepare the Mapping Files" in the HP Universal
CMDB Developer Reference Guide.
Note: A sample mapping file, Unix_SW_to_CACMDB.xml, is provided out- of-the-box

with the integration package.
5. Create an integration point

In UCMDB create an integration point. (For details, see "Integration Studio" in the HP
Universal CMDB Data Flow Management Guide.)
Include the following details:
b. Provide the following details for the CaCmdbPushAdapter adapter:
Attribute Description
Hostname/IP The host name or IP address of the CA CMDB server.
Port The port number of the CA CMDB server.
Credentials The CA CMDB credential that was created in the prerequisites

section above
Data Flow The name of the Data Flow Probe on which the integration runs.
Probe
c. Test the connection to the target CMDB server.
d. Add a job definition to the integration point, selecting the queries to use to synchronize data
between UCMDB and CA CMDB. Define a synchronization schedule, if required.
e. Invoke the ad hoc job, Full Topology Sync, for a full synchronization of the data.

Integration Query
The integration query, Unix_SW_to_CACMDB, is included with the CA CMDB integration
package. This is an example of a query that can be used to query the CIs and relationships that
must be pushed from UCMDB to CA CMDB. This query is accessible from UCMDB's Modeling
Studio, among the query resources. For details, see "Modeling Studio Page" in the HP Universal
CMDB Modeling Guide.

This section describes troubleshooting and limitations related to UCMDB - CA CMDB integration.
l Debug Mode
To create an XML dump of the CIs and links being sent to the CA CMDB server for debug
purposes, in <UCMDB installation>\DataFlowProbe\
runtime\probeManager\discoveryConfigFiles\CaCmdbPushAdapter\
push.properties, set the value of the debugMode property to true and restart the Data Flow
Probe service.
This ensures that every time the integration is invoked, a set of XML files is created in the
<UCMDB installation>\DataFlowProbe\runtime\
probeManager\discoveryResources\CaCmdbPushAdapter\work directory. These files are
time-stamped and contain the CIs and links that UCMDB is trying to push to CA CMDB. This
information can be helpful in debugging a problem with the integration:
n If data is not being sent from UCMDB, there is a problem on the UCMDB side.
n If data is not being processed by CA CMDB's GRLoader utility, there might be a

reconciliation issue or some other issue on the CA CMDB side.
l During the export of more than 4,000 CIs (this is default UCMDB configuration) the export TQL

result is divided into chunks. To make sure that chunks are created properly, you must configure
the export TQL as follows:In the container node's properties, set the Element Name field to
Root.

Chapter 4: CiscoWorks LAN Management
Solution Integration
Overview 43
Topology 43
How to Discover CiscoWorks LMS 44
CiscoWorks LMS Database Ports Job 45
Adapter 45
Trigger Query 45
Parameters 45
Network Devices from CiscoWorks LMS Job 45
Adapter 45
Trigger Query 45
Layer 2 Topology from CiscoWorks LMS Job 46
Adapter 46
Trigger Query 46
Discovery Flow 47
CiscoWorks NetDevices Adapter 47
CiscoWorks Layer 2 Adapter 48

Chapter 4: CiscoWorks LAN Management Solution Integration
Overview
CiscoWorks LAN Management Solution (LMS) is a suite of management tools that simplify the
configuration, administration, monitoring, and troubleshooting of Cisco networks.
This integration involves synchronizing devices, topology, and hierarchy of network infrastructure in
UCMDB, and also synchronizes relationships between various hardware and logical network
entities to enable end-to-end mapping of the data network infrastructure. The integration enables
change management and impact analysis across all business services mapped in UCMDB, from a
data network point of view.
Supported Versions
This integration supports CiscoWorks LAN Management Solution Version 3.x.
Topology
The following image displays the CiscoWorks LAN Management Solution topology.
Note: For a list of discovered CITs, see "Discovered CITs" on page 47.

How to Discover CiscoWorks LMS

1. Prerequisites - Set up protocol credentials
Add credentials for the Sybase database instances used by CiscoWorks LMS (RMENGDB
and ANIDB) to the Generic DB (SQL) protocol.
2. Run the discovery
a. Discover IP addresses of the Sybase databases RMENGDB and ANIDB used by

CiscoWorks LMS.
b. Run the CiscoWorks LMS Database Ports job to discover the TCP ports at which the
Sybase databases used by CiscoWorks LMS are listening.
c. Create a new integration point, and use the CiscoWorks NetDevices adapter to discover
network device information from CiscoWorks.
d. Create a new integration point, and use the CiscoWorks Layer 2 adapter to discover node
(server) information from CiscoWorks.
Steps 2a and 2b are optional (although highly recommended - see note below) since
CiscoWorks adapters are available in the Integration Studio, allowing manual creation of
the necessary IpAddress, Node and IpServiceEndpoint CIs.
Note: The CiscoWorks Layer 2 job requires additional data about CIs created by the
CiscoWorks NetDevices adapter and already in UCMDB. This information is provided by
the Input Query, which contains CI Types (NetDevice and PhysicalPort) that provide this
data in addition to CI Types required to identify the integration target
(IpServiceEndpoint).
For this reason, it is highly recommended to execute steps 2a and 2b. If steps 2a and 2b
are not executed, creating the integration target CIs (while creating an integration point
using the CiscoWorks Layer 2 adapter) requires the creation of Node and PhysicalPort
CIs.

CiscoWorks LMS Database Ports Job

Adapter
This job uses the TCP Ports Discovery adapter
Trigger Query
l Trigger CI: IpAddress
l Trigger Query:
l CI attribute conditions:
CI Attribute Value
IpAddress NOT IP Probe Name is null
Parameters
Ports: 43443, 43455
Network Devices from CiscoWorks LMS Job

Adapter
This job uses the CiscoWorks_NetDevices adapter
Trigger Query
l Trigger CI: IpServiceEndpoint
l Trigger Query: CiscoWorks RME DB Port

CI Attribute Value
IpServiceEndPoint NetworkPortNumber Equal 43455
Layer 2 Topology from CiscoWorks LMS Job

Adapter
This job uses the CiscoWorks_Layer2 adapter
Trigger Query
l Trigger CI: IpServiceEndpoint
l Trigger Query: CiscoWorks Campus DB Port

CI Attribute Value
IpServiceEndPoint NetworkPortNumber Equal 43443
IpAddress NOT IP Probe Name Is null
NetDevice NOT Name Is null
PhysicalPort NOT Name Is null AND NOT Port VLAN Is null AND NOT
PortIndex Is null AND NOT Container Is null
Discovery Flow
Add IP addresses of the Sybase databases RMENGDB and ANIDB used by CiscoWorks LMS to
a discovery probe range:
1. Range IPs by ICMP
2. CiscoWorks LMS Database Ports
3. CiscoWorks NetDevices
4. CiscoWorks Layer 2
CiscoWorks NetDevices Adapter

Input CIT
IpServiceEndpoint: the TCP port at which the RMENGDB Sybase instance is listening. (The
default is 43455.)
Used Scripts
l ciscoworks_utils.py
l CiscoWorks_NetDevices.py
Discovered CITs
l Composition
l Containment
l HardwareBoard

l Interface
l IpAddress
l IpSubnet
l Layer2Connection
l Membership
l Node
l PhysicalPort
l Realization
l Vlan
Parameters
allowDnsLookup If an IP address is not available for a node,

setting this to true enables DNS lookup using
the node name.
Default: false.
ignoreNodesWithoutIP If set to false, CIs for nodes without IPs are

created with the storage system's internal ID
as host_key. Note: this may result in duplicate
nodes.
Default: true.
rmeDbName The name of the CiscoWorks Resource

Manager Essentials database in Sybase.
Default: rmengdb.
queryChunkSize The number of network devices to query at a

time.
Default: 250.
CiscoWorks Layer 2 Adapter


Input CIT
IpServiceEndpoint: the TCP port at which the ANIDB Sybase instance is listening. (The default is
43443.)
Input Query
CiscoWorks LMS Campus DB with PhysicalPorts
Node Conditions
Node Name Condition
SOURCE (IpServiceEndPoint) NetworkPortNumber Equal 43443
IpAddress NOT IP Probe Name Is null
NetDevice NOT Name Is null
PhysicalPort NOT Name Is null AND NOT Port VLAN Is null

AND NOT PortIndex Is null AND NOT
Container Is null
Triggered CI Data
Name Value
db_port ${SOURCE.network_port_number}
ip_address ${IpAddress.ip_address}
netdevice_cmdbid ${NetDevice.global_id}
netdevice_name ${NetDevice.name}
port_cmdbid ${PhysicalPort.global_id}
port_container_cmdbid ${PhysicalPort.root_container}

Name Value
port_index ${PhysicalPort.port_index}
port_name ${PhysicalPort.name}
port_vlan ${PhysicalPort.port_vlan}
Used Scripts
l ciscoworks_utils.py
l CiscoWorks_Layer2.py
Discovered CITs
l Composition
l Containment
l HardwareBoard
l Interface
l IpAddress
l IpSubnet
l Layer2Connection
l Membership
l Node
l PhysicalPort
l Realization
l Vlan

Parameters
allowDnsLookup If an IP address is not available for a node,

setting this to true enables DNS lookup using
the node name.
Default: false.
ignoreNodesWithoutIP If set to false, CIs for nodes without IPs are

created with the storage system's internal ID
as host_key. Note: this may result in duplicate
nodes.
Default: true.
campusDbName The name of the CiscoWorks Campus

database in Sybase.
Default: anidb.
queryChunkSize The number of nodes to query at a time.
Default: 1,000.
Discovery Mechanism
The adapters in this package connect to the Sybase databases used by CiscoWorks LMS using
JDBC, and run SQL queries to retrieve information. The Sybase database instances are used as
part of the trigger for jobs in this package. This allows the jobs to be included in UCMDB's spiral
discovery schedule.
The package includes two adapters:
l CiscoWorks NetDevices, and
l CiscoWorks Layer 2.
CiscoWorks NetDevices triggers off the CiscoWorks Resource Manager Essentials database,
and retrieves network devices, VLAN and layer two infrastructure from it.
CiscoWorks Layer 2 triggers off the CiscoWorks Campus Manager database, and retrieves nodes
(servers). It associates them with VLANs and layer two infrastructure retrieved by CiscoWorks
NetDevices.
Database queries executed by this package on the CiscoWorks databases are as follows:
Note: The following query is used by the CiscoWorks NetDevices and CiscoWorks Layer 2
adapters on the RMENGDB and ANIDB database instances

Get the database name to verify that queries are run on the correct database:
SELECT db_name()
Note: The following queries are used by the CiscoWorks NetDevices adapter on the
RMENGDB database instance
Get a count of the number of network devices in the database (This is required to determine the
number of chunks to query. For details on chunking, see "Parameters" on page 48.)
SELECT COUNT(1) FROM lmsdatagrp.NETWORK_DEVICES
Get information on network devices managed by CiscoWorks LMS
SELECT netdevices.Device_Id,
deviceState.NetworkElementID, netdevices.Device_Display_Name,
netdevices.Host_Name, netdevices.Device_Category,
netdevices.Device_Model, netdevices.Management_IPAddress,
deviceState.Global_State
FROM lmsdatagrp.NETWORK_DEVICES netdevices JOIN dba.DM_Dev_State
deviceState ON netdevices.Device_Id=deviceState.DCR_ID
Get additional details on each network device.
SELECT * FROM dba.PhysicalTypeEnum
SELECT ne.ElementName, ne.ReportedHostName, ne.DNSDomainName, ne.Description, ne

.PrimaryOwnerContact, ne.ElementLocation, os.OSName, os.Version, os.ROMVersion,
pe.Manufacturer, pe.SerialNumber
FROM dba.OperatingSystem os, dba.PhysicalElement pe, dba.networkelement ne
WHERE os.NetworkElementID=<networkDeviceID> AND ne.NetworkElementID=<networkDevi
ceID> AND pe.NetworkElementID=<networkDeviceID> AND LOWER(pe.PhysicalType)=<phys
icalType> AND pe.PhysicalElementId IN (1, 2)
Get port and VLAN information for each network device.
SELECT phyPort.PhysicalPortID, phyPort.SNMPPhysicalIndex, phyPort.ParentRelPos,

port.PORT_NAME, port.PORT_DESC, port.PORT_DUPLEX_MODE, port.PORT_TYPE, port.POR
T_SPEED, port.VLAN_NAME, port.VLANID, interface.EndpointID, interface.Descriptio
n, interface.Alias, interface.MediaAccessAddress
FROM lmsdatagrp.PORT_INVENTORY port JOIN dba.PhysicalPort phyPort ON port.PORT_N
AME=phyPort.PortName JOIN dba.IFEntryEndpoint interface ON port.PORT_NAME=interf
ace.EndpointName
WHERE phyPort.NetworkElementID=<networkDeviceID> AND interface.NetworkElementID=
<networkDeviceID> AND port.DEVICE_ID=<networkDeviceID> AND phyPort.PortName=port
.PORT_NAME
Get IP Address details for each network device.
SELECT IPAddress, SubnetMask FROM dba.IPProtocolEndPoint WHERE NetworkElementId=

<networkDeviceID>
Get information on modules in each network device.

SELECT MODULE_NAME, SW_VERSION, FW_VERSION, SLOT_NUMBER FROM lmsdatagrp.MODULE_I

NVENTORY WHERE DEVICE_ID=<networkDeviceID>
Note: The following queries are used by the CiscoWorks Layer 2 adapter on the ANIDB
database instance.
Get a count of the number of nodes (servers) in the database (This is required to determine if
chunking is required. See "Parameters" on page 51.)
SELECT COUNT(1) FROM lmsdatagrp.End_Hosts
Get information on nodes managed by or known to CiscoWorks LMS.
SELECT HostName, DeviceName, Device, MACAddress, IPAddress,

SubnetMask, Port, PortName, VLAN, VlanId, associatedRouters
FROM lmsdatagrp.End_Hosts
WHERE HostName IS NOT NULL AND NOT HostName='' AND IPAddress IS NOT
NULL AND NOT IPAddress=''

If there is a database connection failure, copy the Sybase JDBC driver (jconnectnn.jar or similar
JAR file) from the Sybase system to the
<hp>\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\db\sybase
directory on the DFM probe file system.
If the database connection failure occurs after the driver is copied, it may be necessary to change
the driver classes in globalSettings.xml from:
<Sybase>com.sybase.jdbc.SybDriver</Sybase>
to
<Sybase>com.sybase.jdbc3.SybDriver</Sybase>

Chapter 5: EMC Control Center (ECC)
Integration
Overview 55
Topology 55
How to Run the ECC/UCMDB Integration Job 56
ECC Integration Job 58
Views 61
Reports 68

Chapter 5: EMC Control Center (ECC) Integration
Overview
Integration between ECC and DFM involves synchronizing devices, topology, and hierarchy of
storage infrastructure in the UCMDB database (CMDB). This enables Change Management and
Impact Analysis across all business services mapped in UCMDB from a storage point of view.
DFM initiates discovery on the ECC database. Synchronized Configuration Items (CIs) include
Storage Arrays, Fibre Channel Switches, Hosts (Servers), Storage Fabrics, Storage Zones, Logical
Volumes, Host Bus Adapters, Storage Controllers, and Fibre Channel Ports. The integration also
synchronizes physical relationships between hardware, and logical relationships between Logical
Volumes and hardware devices, to enable end-to-end mapping of the storage infrastructure.
You integrate ECC with UCMDB using Data Flow Management.
The integration includes the ECC_Integration.zip package, which contains the trigger TQL, DFM
script, adapter, and job for ECC integration.
Supported Versions
Target Platform OS Platform DFM Protocol ECC Version
EMC Control Center All Generic DB (SQL) over JDBC, 6.0 and 6.1
SSL optional
Topology
The following diagram illustrates the storage topology and shows the relationships between logical
volumes on a storage array and those on servers:

How to Run the ECC/UCMDB Integration Job

This task includes the steps to run the ECC/UCMDB integration job.
Note: For details on running an integration job, see "Integration Studio" in the HP Universal
1. Provide a name and description for the integration point.
2. Under Integration Properties > Adapter, select the EMC Control Center adapter.
3. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
4. Under Adapter Properties > Trigger CI instance select:
a. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane appears.
Select the CI or
b. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard

Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation Wizard"
in the HP Universal CMDB Data Flow Management Guide.
5. Verify the credentials for the chosen CI instance. Right-click on Trigger CI instance and
select Actions > Edit Credentials Information.
Note: For details about the credentials, see "How to Run the ECC/UCMDB Integration
Job" on the previous page
6. Save the integration point.
7. Run the job.
Tip: You can include the ECC job in the DFM schedule. For details, see "New Integration
Job/Edit Integration Job Dialog Box" in the HP Universal CMDB Data Flow Management
Guide.
To connect to the ECC Oracle database with SSL communication, see "How to Run the
ECC/UCMDB Integration Job" on the previous page.

ECC Integration Job

l "ECC Integration Mechanism" below
l "Trigger Query" on the next page
l "Adapter" on page 60
l "Discovered CITs and Relationships" on page 61
ECC Integration Mechanism

The following workflow explains how the ECC Integration by SQL job discovers the storage
topology of ECC. The job:
1. Connects to the ECC Oracle database instance using credentials from the Generic DB
Protocol (SQL). For details, see "How to Run the ECC/UCMDB Integration Job" on page 56.
2. Queries for fibre channel switches and ports on each switch and creates Fibre Channel
Switch CIs:
SELECT switch.st_id, switch.st_sn, switch.st_alias, switch.st_model, switch.

st_version, switch.st_vendor, switch.sw_managementurl, switch.sw_domain, swi
tch.sw_portcount, switch.sw_portcount_free FROM stssys.sts_switch_list switch
WHERE LOWER(switch.sw_principal) = 'true'
3. Queries for fibre channel adapters and ports on each Fibre Channel Switch and creates Fibre
Channel HBA and Fibre Channel Port CIs:
SELECT port.port_id, port.port_number, port.port_type, port.adport_alias, po

rt.port_wwn, port.port_status, port.conn_port_wwn FROM stssys.sts_switch_port
port WHERE port.st_id = switch.st_id from above query
4. Queries for storage arrays and creates Storage Array CIs:
SELECT array.st_id, array.st_sn, array.st_alias, array.st_type, array.st_mod

el, array.st_vendor, array.st_microcode, array.sy_microcode_patch, array.sy_
microcode_patchdate FROM stssys.sts_array_list array
5. Queries for Fibre Channel ports, Fibre Channel host bus adapters (HBA), and logical volumes
on each storage array, and creates Fibre Channel Port, Fibre Channel Port HBA, and
Logical Volume CIs:
SELECT port.port_id, port.port_number, port.port_type, port.adport_alias, po

rt.port_wwn, port.port_status FROM stssys.sts_array_port port WHERE port.st_
id = array.st_id from above query
SELECT hba.port_id, hba.ad_id, hba.ad_name FROM stssys.sts_array_port hba

WHERE hba.st_id = array.st_id from above query

SELECT logicalVolume.sd_id, logicalVolume.sd_name, logicalVolume.sd_alias, l
ogicalVolume.sd_size, logicalVolume.sd_type FROM stssys.sts_array_device log
icalVolume WHERE logicalVolume.st_id = array.st_id from above query
6. Queries for hosts/servers and creates appropriate Computer, Windows, or Unix CIs. Results
of this query are used to create host resource CIs, such as CPU, if this information is
available:
SELECT host.host_id, host.host_name, host.host_alias, host.host_domain, host

.host_model, host.host_ip, host.host_vendorname, host.host_cpucount, host.ho
st_installedmemory, host.host_os, host.host_osversion, host.host_oslevel, ho
st.host_osclass FROM stssys.sts_host_list host
7. Queries for Fibre Channel ports, Fibre Channel host bus adapters (HBA), and logical volumes
on each host/server and creates Fibre Channel Port, Fibre Channel Port HBA, and
Logical Volume CIs:
SELECT port.port_id, port.port_number, port.adport_alias, port.port_wwn FROM

stssys.sts_host_hba port WHERE port.host_id = host.host_id from above query
SELECT hba.ad_id, hba.ad_name, hba.fibread_nodewwn, hba.ad_vendor, hba.ad_re
vision, hba.ad_model, hba.port_id, hba.ad_driver_rev FROM stssys.sts_host_hba
hba WHERE hba.host_id = host.host_id from above query
SELECT logicalVolume.hd_id, logicalVolume.hd_name, logicalVolume.hd_type, lo
gicalVolume.hd_total FROM stssys.sts_host_device logicalVolume WHERE logical
Volume.hd_id IS NOT NULL AND logicalvolume.arrayjbod_type = 'Array' AND logi
calVolume.host_id = host.host_id from above query
8. Queries for logical volume mapping between logical volumes on hosts/servers and logical
volumes on storage arrays, and adds Dependency relationships between hosts/servers and
storage arrays:
SELECT sd_id FROM stssys.sts_host_shareddevice WHERE hd_id = logicalvolume.h

d_id from above query
9. Queries for paths between hosts/servers and storage arrays and adds Fibre Channel
Connect relationships between respective hosts/servers, switches, and storage arrays:
SELECT port.port_wwn, port.conn_port_wwn FROM stssys.sts_array_port_connecti

on port WHERE port.port_wwn IS NOT NULL AND port.conn_port_wwn IS NOT NULL
SELECT port.port_wwn, port.conn_port_wwn FROM stssys.sts_switch_port port WH
ERE port.port_wwn IS NOT NULL AND port.conn_port_wwn IS NOT NULL
Trigger Query
Trigger CI: ECC Oracle database

Adapter
The following table gives details of the adapter parameters.
allowDNSLookup If a node in the ECC database does not have an IP address but
has a DNS name, it is possible to resolve the IP address by the
DNS name.
l True: If a node does not have an IP address, an attempt is

made to resolve the IP address by DNS name (if a DNS name
is available).
Default: False
ignoreNodesWithoutIP Defines whether or not nodes in ECC without IP addresses should

be pulled into UCMDB.
l True. Nodes without IPs are ignored.
l False. A Node CI is created with an ECC ID as the node key

attribute.
Note: Setting this parameter to False may result in duplicate

CIs in the CMDB.
Default: True

Discovered CITs and Relationships
l CPU
l Containment
l Composition (link)
l Dependency (link)
l Fibre Channel Connect (link)
l Fibre Channel HBA
l Fibre Channel Port
l Fibre Channel Switch
l Node
l IpAddress
l Logical Volume
l Membership (link)
l Storage Array
l Storage Processor
l Unix
l Windows
Views
The Storage_Basic package contains views that display common storage topologies. These are
basic views that can be customized to suit the integrated ECC applications.
To access the Storage_Basic package, go to Administration > Package Manager. For details,
see "Package Manager" in the HP Universal CMDB Administration Guide.
l "Storage Array Details" on the next page
l "FC Switch Details" on page 63
l "Host Storage Details" on page 64

l "SAN Topology" on page 65
l "Storage Topology" on page 65
Storage Array Details

This view shows a Storage Array and its components including Logical Volumes, HBAs, Storage
Processors, and Fibre Channel Ports. The view shows each component under its container Storage
Array and groups Logical Volumes by CI Type.
Storage Array does not require all components in this view to be functional. Composition links
stemming from the Storage Array have a cardinality of zero-to-many. The view may show Storage
Arrays even when there are no Logical Volumes or Storage Processors.

FC Switch Details
This view shows a Fibre Channel Switch and all connected Fibre Channel Ports.
Note: Although shown in the preceding graphic, the ECC job does not discover Storage
Fabrics. The view represented by this query is populated without Storage Fabrics.

Host Storage Details

This view shows only Hosts that contain a Fibre Channel HBA or a Logical Volume. This keeps the
view storage-specific and prevents hosts discovered by other DFM jobs from being included in the
view.

SAN Topology
This view maps physical connections between Storage Arrays, Fibre Channel Switches, and
Hosts. The view shows Fibre Channel Ports below their containers. The view groups the Fibre
Channel Connect relationship CIT to prevent multiple relationships between the same nodes from
appearing in the top layer.
Storage Topology
This view maps logical dependencies between Logical Volumes on Hosts and Logical Volumes on
Storage Arrays. There is no folding in this view.

Impact Analysis Rules

The Storage_Basic package contains basic impact analysis rules to enable impact analysis and
root cause analysis in UCMDB. These impact analysis rules are templates for more complex rules
that you can define based on business needs.
All impact analysis rules fully propagate both Change and Operation events. For details on impact
analysis, see "Impact Analysis Manager Page" and "Impact Analysis Manager Overview" in the HP
Universal CMDB Modeling Guide.
To access the Storage_Basic package: Administration > Package Manager. For details, see
"Package Manager" in the HP Universal CMDB Administration Guide.
Note: Impact analysis events are not propagated to Fibre Channel Ports for performance
reasons.
l "Storage Array Devices to Storage Array" below
l "Host Devices to Host" on the next page
l "Logical Volume to Logical Volume" on the next page
l "FC Switch Devices to FC Switch" on the next page
l "FC Port to FC Port" on page 68
Storage Array Devices to Storage Array

This impact analysis rule propagates events between Logical Volumes, Storage Processors, Fibre
Channel HBAs, and Storage Arrays.

Host Devices to Host

This impact analysis rule propagates events between Fibre Channel HBAs and Hosts, and Logical
Volumes on the Host.
Logical Volume to Logical Volume

This impact analysis rule propagates events on a Logical Volume contained in a Storage Array to
the dependent Logical Volume on the Host.
FC Switch Devices to FC Switch

This impact analysis rule propagates events from a Fibre Channel Port to and from a Switch. The
event is also propagated to the associated Storage Fabric.

Fabrics. The rule represented by this query is used without Storage Fabrics.
FC Port to FC Port
This rule propagates events on a Fibre Channel Port to another connected Channel Port.
Example Scenario of HBA Crashing on a Storage Array
l The event propagates from the HBA to the Storage Array and the Logical Volumes on the Array
because of the Storage Devices to Storage Array rule.
l The impact analysis event on the Logical Volume then propagates to other dependent Logical
Volumes through the Logical Volume to Logical Volume rule.
l Hosts using those dependent Logical volumes see the event next because of the Host Devices
to Host rule.
l Depending on business needs, you define impact analysis rules to propagate events from these
hosts to applications, business services, lines of business, and so on. This enables end-to-end
mapping and impact analysis using UCMDB.
Reports
The Storage_Basic package contains basic reports that can be customized to suit the integrated
ECC applications.
In addition to the system reports, Change Monitoring and Asset Data parameters are set on each
CIT in this package, to enable Change and Asset Reports in UCMDB.
To access the Storage_Basic package: Administration > Package Manager. For details, see
"Package Manager" in the HP Universal CMDB Administration Guide.
l "Storage Array Configuration" on the next page
l "Host Configuration" on page 70
l "Storage Array Dependency" on page 70
l "Host Storage Dependency" on page 71

Storage Array Configuration

This report shows detailed information on Storage Arrays and its sub-components including Fibre
Channel Ports, Fibre Channel Arrays, and Storage Processors. The report lists Storage Arrays with
sub-components as children of the Array.

Host Configuration
This report shows detailed information on hosts that contain one or more Fibre Channel HBAs,
Fibre Channel Ports, or Logical volumes. The report lists hosts with sub-components as children of
the host.
Storage Array Dependency

This report maps dependencies on a Storage Array. The report also displays information on
switches connected to it.
Fabrics. The report represented by this query is populated without Storage Fabrics.

Host Storage Dependency

This report shows detailed information on storage infrastructure dependencies of a Host. The report
lists hosts and dependent components.
Fabrics. The report represented by this query is populated without Storage Fabrics.

Chapter 6: IDS Scheer ARIS Integration
Overview 73
Topology 73
How to Run the ARIS Integration Job 74
Import CIs from ARIS Job 80

Overview
UCMDB integration with IDS Scheer ARIS IT Architect (ARIS) involves synchronizing business
services/processes and Enterprise Architecture (EA) information from ARIS to the UCMDB
database. This enables end-to-end Change Management and Impact Analysis from the IT
infrastructure (at the data center level) to the business service/process level.
The integration involves a UCMDB initiated pull of information from an XML export generated by
ARIS. Synchronized configuration items (CIs) include Business Service, Business Process,
Business Process Step, Ownership information and Business Application (software). The
integration requires manual reconciliation of business application instances in UCMDB.
ARIS_Integration.zip, contains the views, scripts, adapters, and jobs for the IDS Scheer ARIS
Integration.
Supported Versions
This integration supports ARIS IT Architect version 7.1.
Topology
The following image is a sample topology showing relationships between the IT infrastructure (data
center layer) and Business Processes/Services.
Note: For a list of discovered CITs, see "Discovered CITs" on page 80.

How to Run the ARIS Integration Job

This task includes the steps to run the ARIS integration job, to integrate the IDS Scheer ARIS IT
Architect CIs into UCMDB.
l "Export the ARIS model to an XML file" below
l "Set up the ARIS-UCMDB mapping" below
l "Run the job" on page 79
1. Export the ARIS model to an XML file

This integration solution uses an XML output file generated by ARIS. It is recommended to
export the ARIS model to a minimal XML file for use by the UCMDB integration job.
When exporting the data:
n The output XML file should NOT be compressed.
n The language of the output file must be the same as the language used for UCMDB.
n Configure settings as follows:
o Assignments: No assignments
o Connections: n connections, with a connection level of 1
o Select to perform a minimum export
o Options to export users and groups and group structures should NOT be selected.
Note: Save the exported file to a location accessible to the Data Flow Probe.
For more details on exporting XML files in ARIS, contact your IDS Scheer support
representative or ARIS IT Architect documentation.
2. Set up the ARIS-UCMDB mapping

Data flow is initiated by UCMDB reading the XML file generated by ARIS. The integration job
reads the data in this file and creates CIs.
A user configurable mapping file (also in XML format) may be used to customize mapping of:
n ARIS Object Types to UCMDB CI types
n ARIS links to UCMDB relationships

This mapping XML file, ARIS_To_UCMDB.xml, is located in the following folder:
<UCMDB installation>\UCMDB\DataFlowProbe\runtime\ probeManager\discoveryReso

urces\TQLExport\ARIS\data
To set up the ARIS Object Type - UCMDB CI Type mapping:
Note: These mapping instructions are followed by an illustrated example.
a. For each ARIS object type that you want to map, in the exported ARIS XML file (the
source XML) locate the relevant ObjDef tag, and note the TypeNum and AttrDef.Type
values.
b. In the mapping file, ARIS_To_UCMDB.xml, locate the <targetcis> section and enter
these values into the source_CI_type namesource_attribute attributes respectively.
Example:
In the following image of the source XML file, the object, ObjDef.4hzv--y-----p--, has the
following attribute values:
o TypeNum = OT_IS_FUNC
o AttrDef.Type = AT_NAME

These values are entered in the mapping file's source_CI_type name and source_
attribute attributes, as illustrated below:

Note: The section marked as Must be present for all CI Types must exist for ALL CI
type mappings defined in the mapping file. This section populates the unique object ID
used by ARIS in the "data_externalid" attribute of the UCMDB CI type.
To set up the ARIS Link - UCMDB Relationship mapping:
Note: These mapping instructions are followed by an illustrated example.
c. For each ARIS link that you want to map, note the following values in the source XML file:
o Locate the relevant CxnDef tag and note the CxnDef.Type attribute.
o Locate the CxnDef tag's parent, ObjDef. Note the TypeNum value under this ObjDef.
o Under CxnDef, note the ToObjDef.IDRef attribute, and search for an ObjDef tag with
the identical value. Then, under this ObjDef, note the TypeNum attribute.
d. In the mapping file, ARIS_To_UCMDB.xml, locate the <targetrelations> section and

enter the source link's values as follows:
o For source_link_type, enter the CxnDef.Type attribute
o For source_ci_type_end1, enter the TypeNum value of the CxnDef tag's parent.
o For source_ci_type_end2, enter the TypeNum value of the ObjDef that is equivalent to
the ToObjDef.IDRef

Example:
In the following image of the source XML file, the link,

CxnDefn CxnDef.ID=CxnDef.mpb---1g----q--, has the following attribute values:
o CxnDef.Type = CT_CAN_SUPP_1
o CxnDef's parent's TypeNum attribute = OT_APPL_SYS_TYPE
o ToObjDef.IDRef = ObjDef.4hzv--y-----p--. The equivalent ObjDef, ObjDef.4hzv--y-----

p--, was found in line 1112, and its TypeNum attribute is OT_IS_FUNC.
These values are entered in the mapping file's <link> tag, in the source_link_type,
source_ci_type_end1, and source_ci_type_end2 attributes respectively, as illustrated
below:

3. Run the job

b. Under Integration Properties > Adapter, select the Software AG ARIS adapter.
c. Fill in the value for ARIS_XML_file. Set the value as the path to the XML file containing the
exported ARIS data. See "Export the ARIS model to an XML file" on page 74.
d. Copy the DTD file, ARIS-Export.dtd from

<ARIS server>\Program Files\ARIS7.1\aml\to the directory where you saved the
exported ARIS XML.
e. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
f. Under Adapter Properties > Trigger CI instance select:
o Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane
appears.
o Create New CI (if you need to create a new CI). The Topology CI Creation Wizard
Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation
Wizard" in the HP Universal CMDB Data Flow Management Guide.

g. Save the integration point.
h. Run the job.
Import CIs from ARIS Job

Trigger Query
l Trigger CI: Probe
l Trigger query:
Adapter
l Input query: There is no input query for this job.
Discovered CITs
The UCMDB-ARIS integration discovers the following CITs:
l BusinessApplication
l BusinessFunction
l BusinessService
l Containment
l Node
l Organization

l Ownership
l Person
Note: To view the topology, see "Topology" on page 73.

Chapter 7: Importing Data from External
Sources
Overview 83
Comma Separated Value (CSV) Files 83
CSV Files with Column Titles in First Row 84
Databases 84
Properties Files 84
How to Import CSV Data from an External Source – Scenario 85
How to Convert Strings to Numbers 90
Custom Converters 91
External_source_import Package 91
Import from CSV File Job 92
Import from Database Job 95
Import from Properties File Job 100
External Source Mapping Files 101

Chapter 7: Importing Data from External Sources
Overview
Your data is probably stored in several formats, for example, in spreadsheets, databases, XML
documents, properties files, and so on. You can import this information into HP Universal CMDB
and use the functionality to model the data and work with it. External data are mapped to CIs in the
CMDB.
The following external data sources are currently supported:
l "Comma Separated Value (CSV) Files" below
l "Databases" on the next page
l "Properties Files" on the next page
Comma Separated Value (CSV) Files

A *.csv file has a format that stores tabular data. Each row in a CSV file represents a set of values
delimited with a particular delimiter. All rows are homogeneous, that is, each row has the same
number of values. Values from all rows with the same index create a column. Values in a single
column represent the same type of data. Therefore a CSV file represents a table of data (with rows
and columns).
The default delimiter for CSV files is the comma, but any symbol can be used as a CSV delimiter,
for example, a horizontal tab.
Note: Microsoft Office Excel includes native support for the CSV format: Excel spreadsheets
can be saved to a CSV file and their data can then be imported into UCMDB. CSV files can be
opened in an Excel spreadsheet.
Example of a CSV file:

CSV Files with Column Titles in First Row

CSV files often include column headings in the first row. When data is imported from these files, the
titles are considered data and a CI is created for this row. To prevent a CI being created, you can
define which row DFM should start at when importing data from a CSV file:
1. Select Adapter Management > Resources pane > Packages > External_source_import >
Adapters > Import_CSV.
2. In the Adapter Definition tab, locate the Adapter Parameters pane.
3. Locate the rowToStartIndex parameter.
By default, the value is 1, that is, DFM retrieves data from the first row.
4. Replace 1 with the number of the row at which to start retrieving data. For example, to skip the
first row and start with the second row, replace 1 with 2.
Databases
A database is a widely used enterprise approach to storing data. Relational databases consist of
tables and relations between these tables. Data is retrieved from a database by running queries
against it.
The following databases are supported: Oracle, Microsoft SQL Server, MySQL, and DB2.
Properties Files
A properties file is a file that stores data in the key = value format. Each row in a properties file
contains one key-to-value association. In code terms, a properties file represents an associative
array and each element of this array (key) is associated with a value.
A properties file is commonly used by an application to hold its configuration. If your application
uses a configuration file, you can model the application in UCMDB.
Example of a properties file:

How to Import CSV Data from an External

Source – Scenario
The UCMDB administrator must model a vehicle catalog that is stored in a CSV file.
l "Prerequisites" below
l "Create a CIT" below
l "Create a mapping file" on the next page
l "Run the job" on page 88
l "Add the discovered Shell CI to the job" on page 89
l "Result" on page 89
1. Prerequisites
The admin opens the CSV file and analyzes the data:
The file includes the name, model, year of manufacture, and the date when the car was
purchased, that is, there are four columns of data:
1 Name string
2 Model string
3 Year of manufacture integer
4 Date of purchase date
There are three rows to the file, which means that the admin expects three CIs to be created in
UCMDB.
2. Create a CIT

The admin creates a CIT.
a. The admin creates a CIT named Car to hold the attributes that are to be mapped to the data
in the CSV file (name, model, and so on):
For details, see "Create a CI Type" in the HP Universal CMDB Modeling Guide.
b. During the creation of the CIT, the admin adds these attributes as follows:
For details, see "Attributes Page" in the HP Universal CMDB Modeling Guide.
3. Create a mapping file

The admin uses the template, mapping_template.xml, to create a mapping file that makes
the information available to the Import_CSV adapter. The mapping file is located in the
following folder: Adapter Management > Resources pane > External_source_import >
Configuration Files.
a. For each attribute, the admin adds a <map> marker:

<mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noName
spaceSchemaLocation=".\mapping_schema.xsd"
parserClassName="com.hp.ucmdb.discovery.library.

communication.downloader.cfgfiles.CiMappingConfigFile">
<ci type="car">
<map>
<attribute>name</attribute>
<column>1</column>
</map>
<map>
<attribute>model</attribute>
<column>2</column>
</map>
<map>
<attribute>year_of_manufacture</attribute>
<column>3</column>
</map>
<map>
<attribute>date_of_purchase</attribute>
<column>4</column>
</map>
</ci>
</mappings>
b. The admin then adds information about the attribute type:

<mappings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noName
spaceSchemaLocation=".\mapping_schema.xsd"
parserClassName="com.hp.ucmdb.discovery.library.
communication.downloader.cfgfiles.CiMappingConfigFile">
<ci type="">
<map>
<attribute>name</attribute>
<column>1</column>
</map>
<map>
<attribute>model</attribute>
<column>2</column>
</map>
<map>
<attribute>year_of_manufacture</attribute>
<column>3</column>
<converter module="import_converters">stringToInteger</converter>
</map>
<map>
<attribute>date_of_purchase</attribute>
<column>4</column>
<converter module="import_converters">stringToDate</converter>

</map>
</mappings>
All conversions between the values in the CSV file and the CI attributes are done by a
converter. Several converter types are included in the package by default. For details, see
"How to Convert Strings to Numbers" on page 90.
4. Run the job

How you run this job depends on the software version being used.
UCMDB 9.04 (and later), with CP10
n Provide a name and description for the integration point.
n Under Integration Properties > Adapter, select the Import from CSV adapter.
n Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
n Under Adapter Properties > Trigger CI instance select:
appears. Select the CI; or
n Save the Integration Point.
n Run the job.

UCMDB 9.03 (and earlier)
This job uses the Shell Trigger CIT to discover the CSV file on a remote machine. The
Input CIT is Shell and the discovered CIT is declared as IT Universe. However, the actual
discovered CIs depend on the mapping configuration.
The admin activates the following job: Import from CSV file.
For details on activating jobs, see "Discovery Modules Pane" in the HP Universal CMDB
Data Flow Management Guide.
5. Add the discovered Shell CI to the job
Note: This step only applies if using UCMDB 9.03 and earlier.
After activation, the admin locates the Shell CI (of the machine where the cars.csv file is
located) and adds it to the job. For details, see "Choose CIs to Add Dialog Box" in the HP
6. Result
The admin accesses the CIT Manager and searches for instances of the Car CIT. UCMDB
finds the three instances of the CIT:

How to Convert Strings to Numbers

Converters enable you to specify the way data should be converted between the external source
and a CI's attributes.
A CSV file contains records of type string. However, some of the record values need to be
handled as numbers. This is done by adding a converter element to the map element (in [your
mapping file name].xml):
<converter module="import_converters"></converter>
The import_converters.py file (Adapter Management > Resources pane > Packages>
External_source_import > Scripts) contains a set of the most commonly needed converters and
types:
l toString
l stringToInt
l stringToLong
l stringToFloat
l stringToBoolean
l stringToDate
l stringToDouble
l skipSpaces
l binaryIntToBoolean
l stringToBytesArray
l stringToZippedBytesArray
Example of a Converter
A CSV file contains the following row:
Usain, 21, Male
This row must be mapped to the Person CIT that includes name (Usain), age (21), and gender
(Male) attributes. The age attribute should be of type integer. Therefore, the string in the CSV file
must be converted to an integer in the CIT to make it compliant with the CIT attribute type, before
the Person CIs can retrieve the age values.
This is done by adding a converter element to the map element:
<map>
<attribute>age</attribute>

<column>2</column>
<converter module="import_converters">stringToInt</converter>
</map>
module="import_converters". This attribute specifies from which module the converter is to be

retrieved. A module is a Jython script file that contains a set of converter methods, in this case,
import_converters.py.
stringToInt. The name of the converter. In the import_converters.py file, the method is written
as follows:
def stringToInt(value):
if value is not None:
return int(value.strip())
else:
return 0
Custom Converters
You can write your own custom converters: Add a new method to the import_converters.py file
or create your own script and add a set of converter methods to it. Call the method with the name of
the script, for example:
<converter module="your_converter_script">[your_converter_method]
</converter>
External_source_import Package
The External_source_import package consists of three jobs and three adapters. There is one job
and one adapter for each external source (CSV file, properties file, database):
External Source Job Adapter
CSV file Import from CSV file Import_CSV
Properties file Import from Properties file Import_Properties_file
Database Import from Database Import_DB
The jobs are located under Universal Discovery > Discovery Modules/Jobs > Discovery
Modules > Others > Discovery Tools.
The adapters are located in the Integration Studio and are accessed when creating or editing an
Integration Point.

Import from CSV File Job

This section includes the following topics:
l "Job Details" below
l "Adapter Parameters" below
l "Delimiters, Quotes, and Escaping Characters" on page 94
Job Details
The job details are as follows:
l Adapter: Import from CSV
l Input CI Type: Shell
l Discovered CIs: ConfigurationItem
l Required Protocols: SSH, NTCMD, Telnet
This job has no Trigger queries associated with it. That is, this job is not triggered automatically (nor
are the Import from Properties file and the Import from Database jobs). After you activate
the job, you must manually add input CIs to the job so that it runs against a particular destination.
For details, see "Add the discovered Shell CI to the job" on page 89.
Adapter Parameters
The following parameters are included by default:
bulkSize This parameter only works if the parameter flushObjects is true, in which
case, when sending discovery results, it sets the size of chunks used to
that number of CIs.
The default is 2,000 CIs.
ciType The CIT name. This job creates and reports CIs of this type to UCMDB,
based on data in the CSV file. For example, if the CSV file contains records
for UNIX hosts, you must set the ciType parameter to unix.
csvFile The full path to the CSV file on the remote machine. The job uses the Shell
CI Type as input to reach this path on the remote machine.
delimiter The delimiter used in the CSV file. The comma (,) delimiter is the default but
other delimiters are supported. For details, see "Delimiters" on page 94.

flushObjects This parameter allows customization of the reporting mechanism.
If true, the probe divides the discovery result into chunks, and sends each
chunk to the UCMDB Server. This helps prevent out-of-memory issues
where a large amount of data is sent. The chunk size can be configured with
the bulkSize parameter.
If false (the default value), the probe sends the discovery result without
dividing it into chunks.
mappingFile For details of the mapping file, see "External Source Mapping Files" on
page 101.
mappingString The string containing mapping information used to map the CSV column
indexes and attributes to import. You define this mapping in the following
format:
l mapping elements should be separated by commas
l each mapping element should be specified in a <column

number>:<attribute name> format, for example:
The string 0:host_key,1:name defines the mapping of two attributes of a

host CI, where the host's host_key attribute is taken from the value in
the first column (0) and the name attribute is taken from the value in the
second column (1).
quoteSymbol Quoting symbol used in the CSV file.
Default symbol: "
rowToStartIndex For details on setting the row at which DFM starts collecting data, see
"CSV Files with Column Titles in First Row" on page 84.
skipEmptyValues This flag determines whether to skip empty values. If true, empty column
values are not sent.
For details on overriding an adapter parameter, see "Override Adapter Parameters" in the HP
Universal CMDB Developer Reference Guide.
Mapping Information for the Import from CSV File Job

You can specify mapping information for the Import from CSV File job with one of the following
methods:
l In an external XML file. You must specify the mappingFile parameter. For details, see
"External Source Mapping Files" on page 101.

l Directly in a job's ciType and mappingString parameters, without using an external file.
Note: When using this mapping method, you cannot specify attribute types or converters.
If the mappingFile parameter is specified, the job tries to retrieve mapping information from the
XML file. If it is not specified, the job uses the mapping information specified in the ciType and
mappingString parameters.
Delimiters, Quotes, and Escaping Characters
l Delimiters
The delimiter divides values in the same row of a CSV file. Supported delimiters are:
n Single symbol. Any symbol can be used as a delimiter, for example, the pipe sign (|), the
letter O. Delimiters are case sensitive.
n ASCII code. If an integer number is used as the value for a delimiter parameter, this value is
treated as ASCII code, and the related symbol is used as the delimiter. For example, 9 is a
valid delimiter because 9 is the ASCII code for the horizontal tab.
n Known character sequence. A sequence of characters can be used to represent special

characters. For example, \t represents the horizontal tab.
l Quotation Marks
You can use double or single quotes in values, that is, all values residing between the two
quotes are treated as a single value.
n If a delimiter symbol is used in a value, the value must be surrounded with quotation marks.
For example, the following row includes a comma inside a value, so the value must be
quoted:
Morganfield, "25 Hope Road, Kingston", Jamaica
n If a quote character is used in a value, the character must be escaped by inserting a

backslash before it:
McKinley \"Muddy Waters\" Morganfield, "April 4, 1915"
This row contains two values:
- McKinley "Muddy Waters" Morganfield
- April 4, 1915.
l Escaping Characters
The following characters must always be quoted or escaped:

n Backslash
n Single quote
n Double quote
n Delimiter, that is, the delimiter used in the same CSV file.
Import from Database Job

This job uses a database table or database query as the source of the information, maps the
information to CIs, and imports the CIs into UCMDB.
l "Job Details" below
l "Discovery Adapter Parameters" on the next page
l "Tables and Queries" on the next page
l "Database, Schema, and Table Names" on page 97
l "Importing Data with an SQL Query" on page 98
l "Column Types" on page 98
l "Importing CIs with Root Container Attribute" on page 99
Job Details
l Adapter: Import from DB
l Input CI Type: Database
l Required Protocol: SQL
This job has no trigger queries associated with it. The job tries to get the Instance name and Port
using the attributes Name and Application Listening Port Number of the Input Database CI. If
these attributes are empty, it uses the Instance Name and Port number defined in Generic
DB Protocol (SQL) credentials.

Discovery Adapter Parameters

case, when sending discovery results, it sets the size of chunks used to that
number of CIs.
ciType Name of CIT to import.
chunk to the UCMDB Server. This helps prevent out-of-memory issues where
a large amount of data is sent. The chunk size can be configured with the
bulkSize parameter.
mappingFile XML file containing the mapping from column to attribute.
mappingString The string containing mapping information used to map the Database column
names and the attributes to import. You define this mapping in the following
format:
l mapping elements should be separated by commas;
l each mapping element should be specified in a <column name>:<attribute

name> format,
Example:
A_IP_ADDRESS:ip_address, A_IP_DOMAIN:ip_domain
schemaName The name of the database schema.
sqlQuery If a SQL query is specified, mapping is performed against its result. This
parameter is ignored if tableName is defined.
tableName If a table name is specified, mapping is performed against the table's columns.
For details on overriding an adapter parameter, see "Override Adapter Parameters" in HP Universal
CMDB Developer Reference Guide.
Tables and Queries

The following use cases are supported by the Import from Database job (a single SQL query is
performed):

l Import data using the schema name and table name parameters:
The SQL query is generated from these parameters.
l Import data specifying an arbitrary SQL query as the source of the data:
The SQL query is generated from the defined query. For more details, see "Importing Data with
an SQL Query" on the next page.
Database, Schema, and Table Names

SQL naming conventions suggest a usage of a <database.schema.table> syntax for the fully
qualified name of a table. Note, however, that each vendor treats the specification in a different
way. DFM uses the following notation:
l The schemaName parameter specifies the name of a database.
l The tableName parameter specifies the name of a table.
l A schema name cannot be specified in a parameter but can be included in a SQL query.
For Oracle, the SQL query is:
SELECT * FROM <schemaName.tableName>

For Microsoft SQL Server, the SQL query is:
SELECT * FROM dbo.tableName
Note: The default dbo schema is used for Microsoft SQL Server.
Importing Data with an SQL Query

You can use arbitrarily-complex SQL query expressions, for example, joins, sub-selects and other
options, as long as the query is valid and complies with the database usage. Currently, you must
use a fully-qualified table name in the query according to the specific database.
Column Types
Types enable you to specify, in the mapping file, the type of column that exists in the external
source. For example, a database includes information about column types, and the value of this
type needs to be included in the CI's attributes. This is done by adding a type element to the map
element (in mapping_[your mapping file name].xml):
<column type="int"></column>
Supported type attributes are:
l string
l Boolean
l date
l int
l long
l double
l float
l timestamp
Note:
n You use the type attribute for database mapping only.
n If the column element does not include a type attribute, the element is mapped as a string.
Example of adding a type attribute

A database column has an integer type and can be either 0 or 1. This integer must be mapped to a
Boolean attribute of a CIT in UCMDB. Use the binaryIntToBoolean converter, as follows:
<map>
<attribute>cluster_is_active</attribute>
<column type="int">cluster_is_active</column>
<converter module="import_converters">binaryIntToBoolean</converte
r>
</map>
type="int". This attribute specifies that the value of cluster_is_active should be retrieved as
an integer, and that the value passed to the converter method should be an integer.
If the cluster_is_active attribute of the CIT is of type integer, the converter is not needed
here, and the mapping file should say:
<map>
<attribute>cluster_is_active</attribute>
<column type="int">cluster_is_active</column>
</map>
Importing CIs with Root Container Attribute

The main purpose of the Import from database job is importing CIs that do not require a root
container attribute. For example: Node, IP address, etc. However, there are many CIs that depend
on root CIs (for example: CPUs, SQL servers, etc) that cannot be deployed into UCMDB without
the Node on which they are installed. In such cases, it is better to use a different discovery
approach. For example, by importing data from Excel, you can import CIs with corresponding
relationships (including the composition relationship). You can import such CIs using the Import
from database job only if all of the following apply:
1. The root CI (for example: Node) was already populated into UCMDB.
2. It is possible to construct an SQL query to select the UCMDB ID of already imported root CIs
from an external database.
In such cases, you can map the selected UCMDB ID of the root CI to the root container attribute of
the contained CI.
Note: Validation of data (checking if the root CI already exists in UCMDB) is not supported. It
is your responsibility to correctly configure the population of the root container attribute.

Import from Properties File Job

This job imports information from a properties file, maps the information to one CI, and imports that
CI into UCMDB.
Job Details
l Adapter: Import from properties file
l Input CI Type: Shell
l Required Protocols: SSH, NTCMD, Telnet
This job has no Trigger queries associated with it.
Discovery Adapter Parameters

case, when sending discovery results, it sets the size of chunks used to that
number of CIs.
ciType The name of the CIT to import.
chunk to the UCMDB Server. This helps prevent out-of-memory issues where
a large amount of data is sent. The chunk size can be configured with the
bulkSize parameter.
mappingFile For details of the mapping file, see "External Source Mapping Files" on the
next page.

mappingString The string containing mapping information used to map the column indexes
and attributes to import. You define this mapping in the following format:
l mapping elements should be separated by commas
l each mapping element should be specified in the format:
<parameter name> :<attribute name>
For example, for CIT ip_address:
ip_address:ip_address,name:name,ip_address_type:ip_address_type
propertyFile The full path to the properties file located on a remote machine. The Input CI
runs the Shell discovery that is used to access this file on the remote machine
For details on overriding an adapter parameter, see "Override Adapter Parameters" in the HP
Keys and Values

Keys cannot contain the equals symbol (=).
Each value must be set out in a single line. Use backslash+n (\n) to specify a new line. Values can
contain anything, including \n for a new line, quotes, tabs, and so on.
Comments in Properties Files

To create a commented line in a properties file, add the pound sign (#) as the first character in a line.
The job ignores commented lines.
External Source Mapping Files

The data in the external source is mapped to a CI's attributes in UCMDB by means of a mapping
file. The mapping files are located in the Adapter Management > Resources pane > Packages >
External_source_import > Configuration Files folder:
l mapping_template.xml. A template that serves as a source for creating the mapping file.
l mapping_schema.xsd. The XML schema used to validate the XML mapping file. The XML
mapping file must be compliant with this schema.
l mapping_doc.xml. A file that contains Help on creating a mapping file, including all valid
elements.

The mapping file describes the mapping only and does not include information about how data
should be obtained. In this way, you can use one mapping file across different jobs.
All the adapter files in the External_source_import package include a mappingFile parameter, for
example:
<parameter name="mappingFile" type="string" description="Mapping file located in

"Configuration Files" folder of this package" />
name="mappingFile". The value of this parameter is the mapping XML file. The mapping file is
always located on the server and is downloaded to the Data Flow Probe machine upon job
execution.

l Problem: When CIs imported from a CSV file are displayed in the Statistics Results pane, one
more CI than expected is included in the results. This is because the first row of the CSV file
contains column headings that are considered as CIs.
Solution: For details on defining from which row DFM should read the CSV file, see "CSV Files
with Column Titles in First Row" on page 84.
l Problem: When importing large CSV or properties files on the network, there may be time-out
issues.
Solution: Make sure the files are not large.
l Limitation: When importing data from an external database, and the data includes a null value,
it is sent to UCMDB with an attribute value of None.
l Limitation: The DFM Probe breaks down the imported data into 20 KB chunks. This can cause
identification issues.

Chapter 8: Import from Excel Workbook
Discovery
Overview 104
Topology 104
How to Import Data from Excel Workbook 104
How to Set Up an Import File in Excel 106
Import from Excel Workbook Job 115

Chapter 8: Import from Excel Workbook Discovery
Overview
This chapter describes the usage and functionality of the XLS_Import discovery package
developed for importing UCMDB topology from a Microsoft Excel (*.xls, *.xlsx) file.
Supported Versions
This discovery supports
l Microsoft Excel files, versions 97, 2000, XP, and 2003 (*.xls)
l Office Open XML format for Excel 2007 (*.xlsx)
Topology
The following image displays the topology of the Import from Excel discovery.
Note: The topology discovered by the Import from Excel Workbook job relies on import file
content, so only root objects are enumerated as discovered CITs. For a list of discovered
CITs, see "Discovered CITs" on page 118.
How to Import Data from Excel Workbook

This task describes how to run the Import from Excel discovery. The Import from Excel Workbook
job imports data from the Probe's file system (or accessible network share), so no credentials are
required.
Note:
l The Import from Excel Sample job is similar to the Import from Excel Workbook job. It
differs only by reference to the sample import file.
l This integration is configured to run in remote process.

1. Prequisite- Set up the Import file in Excel

For details on setting up the import file, see " How to Set Up an Import File in Excel" on the
next page.
2. Prerequisite - Set up permissions

Give the Data Flow Probe read permissions on the location on the file system where the import
files are stored.
3. Run the discovery

b. Under Integration Properties > Adapter, select the Import topology from Excel
Workbook adapter.
c. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
d. Under Adapter Properties > Trigger CI instance select one of the following:
appears. Select the CI and click OK.
appears. Create the CI using the Wizard.
e. Save the Integration Point.
f. Run the job.

How to Set Up an Import File in Excel

This section describes how to define an import file. The following topology is created:
l Two hosts
l Two IPs contained by each host
l Network (the IPs mentioned above are members of the network)
l An application with a corresponding process running on the host
l "Prerequisite" below
l "Add a CI type" below
l "Create Comment sheets - optional" on the next page
l "Define CI key attributes " on the next page
l "Create Comment columns - optional" on page 109
l "Add CIs with containers" on page 109
l "Define relationships" on page 111
l "Add relationship attributes" on page 113
l "Convert attribute types to UCMDB attribute types" on page 114
1. Prerequisite
Open a new Excel file and name it tutorial.xls.
2. Add a CI type
Double-click the Sheet1 tab and rename it with the desired CI type. For this tutorial, use the
name node.
Note:
n Only use the CI type name, not the display name.
n Type names are case sensitive.

3. Create Comment sheets - optional

You can create Comment sheets that will not be imported into UCMDB, but that can be used to
describe the data contained in the imported document.
Double-click one of the Sheet tabs and rename it #Comment sheet.
Note: Comment sheet names must begin with the # sign.
4. Define CI key attributes

Depending on the CIT, to store a CI in UCMDB, you must specify CI key attributes or
attributes that participate in reconciliation rules. The names of the imported attributes can be
defined as the column headings.
Our node object only has one key attribute - host_key.
To import a node CI into UCMDB, you must set the host_key attribute. You may do this by one
of the following methods:
n Set host_key in the view <IP address> <Domain>. (For example: 192.168.100.100
DefaultDomain.) This is enough to import a node CI into UCMDB.
n Set host_key as the lowest MAC address of the attached network interface. This is not
enough to import a node CI into UCMDB. You must also configure the following attributes:
i. Set host_iscomplete to true.
ii. Set values for the node attributes that allow the node to be identified by the
reconciliation rule. Note: The node reconciliation rule also allows identification of the
nodes linked to this node IP address or network interface CIs. If you prefer to identify
nodes by linked CIs, you must ensure the Excel document also has the imported
IP/Network interface CIs, and the relationships between node CIs and IP/ network
interface CIs.

Note:
n The column headings must be attribute names, not display names.
n Attribute names are case sensitive.
You can show the node name and the operating system.
a. Define two nodes.
Note: Each row in the sheet (except the first one) represents a single CI.
b. Use the same procedure to define IP addresses in a second Excel sheet, for example,
Sheet2.
c. Use the same procedure to define a network CI in a third Excel sheet, for example, Sheet3.
running_software and process definitions are described in "Add CIs with containers" on the
next page

5. Create Comment columns - optional

If you want to have a Comment column with explanations of data, use the # sign before the
column heading. Any data placed in this column will not be imported into UCMDB.
6. Add CIs with containers

Objects that are contained within other objects cannot exist without them. For example,
processes and running software cannot exist without the node they are running on. To show
this relationship, a root_container attribute is needed. Because the container is in another CI,
a reference to it is needed.
Objects can be referenced in one of the following ways:
n By creating an Excel definition reference to the object.
The Excel definition referencing style is recommended because only the tab name (CI type
name) and row number (the row number of the CI defined on the tab) are needed to identify
any imported CI - the presence or absence of any key fields is not necessary, reconciliation
rules are defined in UCMDB, and so on.
Typical links appear as =node!A2, meaning that the node tab on the CI defined at row 2 is
being referenced. It does not matter which column you are referencing; only the rows
numbers are significant.
Note: Such references cannot be used if the Excel file was created from a CSV file or
using some other non-Excel format.
For more information about references, see Microsoft Excel documentation.
n By setting a composition of the desired object key fields divided by the pipe symbol
('|').
For example, to reference an IP address, the ip_address and routing_domain attributes

are needed: 192.168.100.100|MyDomain.
Note:
o The order of the key fields in the definition is important!
o Many objects have no keyed attributes and are identified with reconciliation rules.
For this reason, Excel references are preferred.

n By creating an Excel definition reference to the object.
The Excel definition referencing style is recommended because only the tab name (CI type
name) and row number (the row number of the CI defined on the tab) are needed to identify
any imported CI - the presence or absence of any key fields is not necessary, reconciliation
rules are defined in UCMDB, and so on.
Typical links appear as =node!A2, meaning that the node tab on the CI defined at row 2 is
being referenced. It does not matter which column you are referencing; only the rows
numbers are significant.
Note: Such references cannot be used if the Excel file was created from a CSV file or
using some other non-Excel format.
For more information about references, see Microsoft Excel documentation.
n By setting a composition of the desired object key fields divided by the pipe symbol
('|').
For example, to reference an IP address, the ip_address and routing_domain attributes

are needed: 192.168.100.100|MyDomain.
Note:
o The order of the key fields in the definition is important!
o Many objects have no keyed attributes and are identified with reconciliation rules.
For this reason, Excel references are preferred.
a. Create a running_software using Excel references.
Note: To define an Excel reference, type an equal sign (=) in a cell, select the desired
reference cell, and press ENTER.

b. Create a process using a composite key.
7. Define relationships
To define relationships, create a sheet called relationships.
Note: You cannot import relationship CIs.
All links (relationships) in UCMDB are directed. This means each link has a start and end point.
Also, links have names that might have some attributes similar to other CIs.
A link definition in an import file looks as follows:
Start object reference -> link name -> End object reference [-> Attributes]
Link attribute definitions are described in "Add relationship attributes" on page 113.
The first row (column headings) displays the reason for the information. On this sheet, only the
order of the parameters is important.
a. Using Excel references, add informative captions and define member links between the IP
subnet and first two IP addresses.
In this image, defined formulas are displayed (for example, =ip_address!A2). In actuality,
the values of referenced cells are shown.
b. Using key composition, define the relationships between the two IP addresses and their
routing domains as follows:
IP key fields are ip_address and routing_domain. The composite key looks like
192.168.100.100|MyDomain.
The relationship tab looks as follows:

Note:
o Any type of reference can be chosen. You can use only one reference type in a cell.
o Since the IP subnet CI has no key attributes in UCMDB 9.0x, they can be
referenced only by Excel reference.
c. Add a containment reference from node to ip_address and add a dependency reference
from running_software to process:
After importing this Excel file, the topology appears as follows:

8. Add relationship attributes
Note: This use case is not widespread, but the Import from Excel Workbook job offers
such capability.
Since many different types of links can be defined on the relationships tab in Excel, it is
impossible to name columns with attribute names. For this purpose, the following notation is
used:
<Attribute name>< relationship_attr_delimiter><Attribute value>
By default, for relationship_attr_delimiter, a pipe symbol ('|') is used.
The description definition for the link dependency from running_software to process looks like
description|The Business app depends from the Sample process.
Now the relationships tab appears as follows:
If many attributes must be added, they must be defined in additional columns in the
dependency row.

Note: On the relationships tab, no captions are needed for the attribute columns. If the
column heading is present, these columns are treated as comment columns.
9. Convert attribute types to UCMDB attribute types

At the importing stage, each attribute is converted to the type defined in the UCMDB class
model. This means that if an attribute is defined in UCMDB with a text value (for example, the
attribute port in Service Address), but in the Excel file it has an integer value (for example, 5), it
will be converted to the corresponding type.
The following UCMDB attribute types are supported:
boolean date double enumerations
float integer integer_list long
string string_list xml
Note: If the attribute cannot be converted to the type defined in UCMDB, it is skipped and
you receive a warning in the UI.
Two list types exist in UCMDB: integer_list and string_list. To import such types, the value
delimiters are intended. They are integer_list_delimiter and string_list_delimiter
respectively. The default values are separated by a comma (','), but this can be changed to a
job parameter.
If there is an attribute named some_int_list and it needs to be set using an integer list from 1 to
5, the cell in the relationships tab will look like:
some_int_list|1,2,3,4,5
n Enumerate attribute types
Enumeration data types are supported for attributes. The job assumes the enumeration has
been entered in human readable form and performs a search of the internal integer
representation used in UCMDB.
If a value is entered that is not an enumeration value, it is ignored and you receive a warning
in the log.
Because enumeration values are case sensitive in UCMDB, they are also case sensitive in
Excel.
For example, if SSN in the image below had been written in lower case letters, ssn, the job

would send an error message because it would not find the ssn string in UCMDB.
Import from Excel Workbook Job

Note: The Import from Excel Sample job is similar to the Import from Excel Workbook job. It
differs only by reference to the sample import file.
l "Discovery Mechanism" below
l "Trigger Query" on the next page
l "Job Parameters" on the next page
l "Adapter" on page 117
l "Created/Changed Entities" on page 117
l "Discovered CITs" on page 118
Discovery Mechanism
Each tab in the Excel file reflects a specific CI type. The CIT must be defined in the UCMDB data
model prior to importing file content. If only out-of-the-box CITs are imported, you do not have to
create the CITs because they already exist in UCMDB.
All attributes defined for a CIT must also already exist in UCMDB or the data will be rejected. Any
special rules for attributes—such as data type, obligation, formatting, and so on—must also be
acceptable by UCMDB for the data to be successfully imported into UCMDB.
The data type of the attribute —string, long, integer, boolean, and so on— depends on the UCMDB
data model. You do not need to set attribute types manually. You must specify the attribute name in
the document header line.
Discovery performs the following validations:
1. Verifies that the CITs on the tabs in the Excel spreadsheet exist in UCMDB.
2. Verifies that the attributes (the column names in the Excel spreadsheet) exist in UCMDB.
3. Checks the presence of key attributes on the Excel spreadsheet.

4. Processes all CITs that contain a root_container attribute after CITs that do not have this
type of attribute. This helps to ensure that the parent CI is created before a contained CI.
5. Processes the relationships tab last to create relationships between CIs that do not use the
containment (container_f) relationship.
For the relationship to be created, the keyed attributes of a CI must be used in the relationships
tab.
6. Relation attributes also must exist in the UCMDB class model.
7. Verifies that the CITs on the tabs in the Excel spreadsheet exist in UCMDB.
8. Verifies that the attributes (the column names in the Excel spreadsheet) exist in UCMDB.
9. Checks the presence of key attributes on the Excel spreadsheet.
10. Processes all CITs that contain a root_container attribute after CITs that do not have this
type of attribute. This helps to ensure that the parent CI is created before a contained CI.
11. Processes the relationships tab last to create relationships between CIs that do not use the
containment (container_f) relationship.
For the relationship to be created, the keyed attributes of a CI must be used in the relationships
tab.
12. Relation attributes also must exist in the UCMDB class model.
Trigger Query
The Import from Excel Workbook job has no trigger query. Therefore, you must manually add the
Probe that imports the data. For details, see "Probe Selection Pane" in the HP Universal CMDB
Job Parameters
file_name The import file name. An absolute path accessible from the used probe must be
used. For details on settin up this file, see " How to Set Up an Import File in
Excel" on page 106.
integer_list_ The delimiter used to handle values in the spreadsheet that are to be treated as
delimiter the UCMDB data type integer_list.
string_list_ The delimiter used to handle values in the spreadsheet which would be mapped
delimiter as the UCMDB data type string_list.

relationship_ On the Relationship tab of the source file object, the linked attributes could be
attr_ added.
delimiter
The default is attribute_name|attribute_value (a pipe symbol is used between
the attribute name and value). This should be aligned with actual data.
Adapter
l Input Query
Input CIT: discoveryprobemanager
Input query: Because the Import from Excel Workbook job's input CIT is Discovery Probe
Gateway, there is no need to supply an input TQL query.
l Scripts Used
The following scripts are used to import data from an Excel workbook.
n import_from_excel.py
n xlsutils.py
Note: The Import from Excel Workbook job may also use library scripts supplied in the Auto
Discovery content package.
Created/Changed Entities
Entity
Entity Name Type Entity Description
Import from Excel Job Main importing job

Workbook
Import from Excel Job Sample job that imports the predefined sample import
Sample file
XLS_Parser Adapter Discovery adapter
import_from_excel.py Script Main import script
xlsutils.py Script Contains utility methods for class model validation and
fetching objects from Excel worksheets

Entity
Entity Name Type Entity Description
ciimports_for9.xls Resource Sample import file
poi-3.7-beta1- Resource Java library for working with Excel 97-2003 file format
20100620.jar
poi-ooxml-3.7-beta1- Resource Java library for working with Excel 2007 file format
20100620.jar
poi-ooxml-schemas-3.7- Resource Java library with XML schemas used in Excel 2007
beta1-20100620.jar files
geronimo-stax-api_1.0_ Resource Geronimo implementation of standard XML processing

spec-1.0.jar API (used by POI)
xmlbeans-2.3.0.jar Resource Library for accessing XML by binding it to Java types

(used by POI)
Discovered CITs
l ConfigurationItem
l Managed Relationship
Note: To view the topology, see "Topology" on page 104.

l Problem: Import from Excel Workbook job compile time errors and problems working with the
Excel files.
Solution: Verify that you have performed the instructions in the Prerequisite section of the this
discovery. For details, see "Prerequisite - Set up permissions" on page 105.
l Problem: Importing a CI with the qualifier RANDOM_GENERATED_ID_CLASS, but without

defined reconciliation rules, leads to duplicating such CIs.
Solution: Currently this problem is not resolvable on the job side. This can only be resolved by
defining reconciliation rules.
l Problem: Import from Excel Workbook job date errors.

Solution: The date cannot be imported if it is represented in text format. This issue is not
resolvable because of localization. Represent the date in numerical format.
l Limitation: The DFM Probe breaks down the imported data into 20 KB chunks. This can cause
identification issues.

Chapter 9: Microsoft SCCM/SMS
Integration
Overview 121
SMS Adapter 121
How to Populate the CMDB with Data from SCCM/SMS 123
How to Federate Data with SCCM/SMS 124
How to Customize the Integration Data Model in UCMDB 125
Predefined Query for Population Jobs 126
SCCM/SMS Integration Package 126
SMS Adapter Configuration Files 129

Chapter 9: Microsoft SCCM/SMS Integration
Overview
This document includes the main concepts, tasks, and reference information for integration of
Microsoft System Center Configuration Manager (SCCM)/Systems Management Server (SMS)
with HP Universal CMDB.
Integration occurs by populating the UCMDB database with devices, topology, and hierarchy from
SCCM/SMS and by federation with SCCM/SMS supported classes and attributes.
According to UCMDB reconciliation rules, if a CI (in SCCM/SMS) is already mapped to a CI in the

CMDB, it is updated; otherwise, it is added to the CMDB.
Microsoft System Center Configuration Manager/Systems Management Server are used by IT

administrators to manage client computers and servers.
SCCM/SMS enable you to:
l Manage computers that roam from one location to another
l Track deployment and use of software assets, and use this information to plan software
procurement and licensing
l Provide IT administrators and management with access to data accumulated by SCCM/SMS
l Provide scalable hardware and software management
l Manage security on computers running Windows operating systems, with a minimal level of
administrative overhead
Supported Versions
Integration has been developed and tested on HP Universal CMDB version 8.03 or later, with
SCCM versions 2007 and 2012, and SMS version 2003.
SMS Adapter
Integration with SCCM/SMS is performed using an SMS adapter, which is based on the Generic
DB Adapter. This adapter supports full and differential population for defined CI types as well as
federation for other CI types or attributes.
The SMS Adapter supports the following features:
l Full replicating of all instances of the selected CI types.
l Identifying changes that have occurred in SCCM/SMS, to update them in the UCMDB.
l Simulating the touch mechanism capabilities:

When a CI is removed from SCCM/SMS, it is physically deleted from the database and there is
no way to report about it. The SMS Adapter supports a full synchronization interval. This means
that the adapter transfers data for which the aging mechanism has been enabled, and provides
the time interval to run a full synchronization that simulates the touch mechanism.
l Federation of selected CI types and attributes.
Out-of-the-box integration with SCCM/SMS includes population of the following classes:
l Node (some of the attributes are populated and some are federated)
l Layer2 connection
l Location that is connected to the node
l IP address
l Interface
In addition, the following classes can be defined as federated from SCCM/SMS:
l CPU
l File system
l Installed software
l Windows service
The following classes and attributes should be marked as federated by the SCCM/SMS adapter for
the proper functionality of the Actual State feature of Service Manager:
l Classes
n CPU
n Installed software
n Windows service
l Node attributes
n DiscoveredOsVendor
n DiscoveredModel
n Description
n DomainName
n NetBiosName

Note: Avoid marking the LastModifiedTime attribute as federated, as it may lead to

unexpected results.
How to Populate the CMDB with Data from

SCCM/SMS
This task describes how to install and use the SMS adapter.
l "Define the SMS integration" below
l "Define a population job (optional)" on the next page
l "Run the population job" on the next page
1. Define the SMS integration

a. In UCMDB, navigate to Data Flow Management > Integration Studio.
b. Click the New Integration Point button to open the new integration point Dialog Box.
o Click , select the Microsoft SMS adapter, and click OK.
Each out-of-the-box adapter comes predefined with the basic setup needed to perform
integration with UCMDB. For information about changing these settings, see
"Integration Studio Page" in the HP Universal CMDB Data Flow Management Guide.
o Enter the following information, and click OK:
Name Description
Credentials Allows you to set credentials for integration points. For credential
information, see "Supported Protocols" in the HP Universal
CMDB Discovery and Integration Content Guide - Supported Content
document.
Hostname/IP The host name of the machine where the database of SCCM/SMS is
running.
Integration The name you assign to the integration point.

Name

Name Description
Is Select this check box to create an active integration point. You clear
Integration the check box if you want to deactivate an integration, for instance, to
Activated set up an integration point without actually connecting to a remote
machine.
Port The port through which you access the MSSQL database.
c. Click Test connection to verify the connectivity, and click OK.
d. Click Next and verify that the following message is displayed: A connection has been
successfully created. If it does not, check the integration point parameters and try again.
2. Define a population job (optional)

The Microsoft SMS adapter comes out-of-the-box with the hostFromSMS Population job,
which runs the following predefined query: hostDataFromSMS. For details about this query,
see "Predefined Query for Population Jobs" on page 126. This job runs according to a default
schedule setting.
You can also create additional jobs. To do this, select the Population tab to define a population
job that uses the integration point you defined in "Define the SMS integration" on the previous
page. For details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP
3. Run the population job

Activate the population job in one of the following ways:
n To immediately run a full population job, click . In a full population job, all appropriate
data is transferred, without taking the last run of the population job into consideration.
n To immediately run a differential population job, click . In a differential population job,

the previous population time stamp is sent to SCCM/SMS, and SCCM/SMS returns
changes from that time stamp to the present. These changes are then entered into the
UCMDB database.
n To schedule a differential population job to run at a later time or periodically, define a

scheduled task. For details, see "Define Tasks that Are Activated on a Periodic Basis" in
the HP Universal CMDB Administration Guide.
Note: the replicated CIs are controlled by the integration TQL that is used. You can create
additional TQL queries that contain different topologies for use in other jobs.
How to Federate Data with SCCM/SMS

The following steps describe how to define the CI types that will be federated with SCCM/SMS.

1. In UCMDB, navigate to Data Flow Management > Integration Studio.
2. Select the integration point that you defined in "Define the SMS integration" on page 123.
3. Click the Federation tab. The panel shows the CI types that are supported by the SMS
adapter.
4. Select the CI types and attributes that you want to federate.
5. Click Save.
Note:
n CI types that populate UCMDB should not be selected for federation. Specifically,
avoid federating node, IP address, interface, location, and Layer2, which populate
UCMDB out-of-the-box.
n Other CI types can be used in federation only after the node data has been replicated to
CMDB by the hostDataImport query. This is because the default reconciliation rule is
based on node identification.
How to Customize the Integration Data Model in

UCMDB
Out-of-the-box CIs for SCCM/SMS integration can be extended in one of the following ways:
To add an attribute to an existing CI type:

If the attribute you want to add does not already exist in the CMDB, you need to add it. For details,
see "Add/Edit Attribute Dialog Box" in the HP Universal CMDB Modeling Guide.
1. Go to the orm.xml file as follows: Data Flow Management > Adapter Management > SMS
Adapter > Configuration Files > orm.xml.
2. Locate the generic_db_adapter.[CI type] to be changed, and add the new attribute.
3. Ensure that the TQL queries that include this CI type have the new attribute in their layouts as
follows:
a. In the Modeling Studio, right-click the node where you want to include the attribute.
b. Select Query Node Properties.
c. Click Advanced Layout Settings and select the new attribute.
For details about selecting attributes, see "Layout Settings Dialog Box" in the HP Universal
CMDB Modeling Guide. For limitations on creating this TQL query, see "Troubleshooting
and Limitations" on page 130.

To add a new CI Type to the Generic DB Adapter:
1. In UCMDB, create the CI Type that you want to add to the adapter, if it does not already exist.
For details, see "Create a CI Type" in the HP Universal CMDB Modeling Guide.
2. Go to the orm.xml file as follows: Data Flow Management > Adapter Management > SMS
Adapter > Configuration Files > orm.xml.
3. Map the new CI type by adding a new entity called generic_db_adapter.[CI type].
For more details, see "The orm.xml File" in the HP Universal CMDB Developer Reference
Guide.
4. Create queries to support the new CI types that you have added. Make sure that all mapped
attributes are selected in the Advanced Layout settings:
a. In the Modeling Studio, right-click the node where you want to include the attribute.
b. Select Query Node Properties.
c. Click Advanced layout settings and select the new attribute.
For details about selecting attributes, see "Layout Settings Dialog Box" in HP Universal
CMDB Modeling Guide. For limitations on creating this TQL query, see "Troubleshooting
and Limitations" on page 130.
6. Edit the SMS integration point to support the new CI type by selecting it either for population or
for federation.
7. If the new CI type is for population, edit the population job that you created above.
Predefined Query for Population Jobs

The following TQL query is provided out-of-the-box if you use the Microsoft SMS adapter when you
create an integration point:
l hostDataFromSMS. Imports nodes and their related data. Information also includes each
node's IP address and interface.
SCCM/SMS Integration Package

l "Transformations" on the next page
l "SCCM/SMS Plug-in " on page 128
l "Reconciliation" on page 129

Transformations
Following is the list of transformations that are applied to values when they are transferred to or
from the SCCM/SMS database:
CMDB Class Attribute Transformation
windows nt_servicepack Represents number of the Windows service pack.
SCCM/SMS DB: Service Pack 2
UCMDB: 2.0
Transformer: standard GenericEnumTransformer,

mapped in the nt.nt_servicepack.transformer.xml
file.
node host_isdesktop A Boolean value that determines whether a machine is

a desktop or a server.
SCCM/SMS DB: Workstation or Server
UCMDB: true or false
Transformer: standard GenericEnumTransformer,

mapped in the node.host_
isdesktop.transformer.xml file.
node host_os Represents the node's operation system.
SCCM/SMS DB. Microsoft Windows XP Professional
UCMDB. Windows XP
Transformer. Standard GenericEnumTransformer,

mapped in the node.discovered_os_
name.transformer.xml file.
If the SCCM/SMS operation system value is not listed

in the transformer.xml file, the original value is sent to
UCMDB.
By default, only Windows operating systems are

mapped.

CMDB Class Attribute Transformation
node host_osinstalltype Represents the Windows OS edition.
SCCM/SMS DB. Microsoft Windows XP Professional
UCMDB. Professional
Transformer. Standard GenericEnumTransformer,

mapped in the host.host_
osinstalltype.transformer.xml file.
Note: The same column in the SCCM/SMS database

is mapped to two different UCMDB attributes, using
different transformers.
disk device name Represents the partition name.
SCCM/SMS DB. C:
UCMDB. C
Transformer. standard
AdapterToCmdbRemoveSuffixTransformer that
removes the colon.
interface interface_macaddr Represents the MAC address of NIC.
SCCM/SMS DB. AB:CD:EF:01:23:45
UCMDB. ABCDEF012345
Transformer. custom SmsMacAddressTransformer

that removes the colons from the SCCM/SMS MAC
address while making it compatible with the UCMDB
MAC addresses.
SCCM/SMS Plug-in
The SmsReplicationPlugin provides enhanced functions to those found in the Generic Database
Adapter. It is called when:
l full topology is requested (getFullTopology) – this returns all the CIs that were found in the
external SCCM/SMS database.
l topology layout is requested (getLayout)
l topology of changes is requested (getChangesTopology) – this returns only the CIs that are
modified or added after a specific time. The topology of the changes is calculated as follows:
n There is a specific date (fromDate) after which all changes are requested.
n Most of the entities in the SCCM/SMS database contain a Timestamp column that contains
the date and time of the last modification. This Timestamp column is mapped to the root_

updatetime attribute of a CI. Currently, some entities do not contain any creation time
information. The entities that have a timestamp column must be listed in the replication_
config.txt file.
n In the integration TQL query, the node CI is named Root.
n Using the plug-in, the integration TQL query is dynamically modified so that each Root entity
and all entities that are listed in the replication_config.txt file have an additional condition
causing the value of the root_updatetime attribute to be greater than or equal to the
fromDate value.
n This modified TQL query is then used to obtain the data.
Reconciliation
The adapter uses the default reconciliation rule-based mapping engine.
SMS Adapter Configuration Files

The adapter includes the following configuration files:
l orm.xml. The Object Relational mapping file, which maps between SCCM/SMS database
tables and columns, and UCMDB classes and attributes. Both CIs and links are mapped.
l fixed_values.txt. Used by the Generic DB Adapter to set the ip_domain of IP Address CIs to
DefaultDomain.
l plugins.txt. Contains configuration information for the Generic DB Adapter. Also defines three
plug-ins that are used during replication: getFullTopology, getChangesTopology, and getLayout.
l transformations.txt. Contains the configuration for transformation of attribute values. For a list
of the transformations, see "Transformations" on page 127.
l node.discovered_os_name.transformer.xml. Mapping used by the transformer for the host_

isdesktop attribute.
l node.host_osinstalltype.transformer.xml. Mapping used by the transformer for the host_os

attribute.
l host.host_osinstalltype.transformer.xml. Mapping used by the transformer for the host_

osinstalltype attribute.
l nt.nt_servicepack.transformer.xml. Mapping used by the transformer for the nt_servicepack

attribute.
l replication_config.txt. Contains a comma-separated list of non-root CIs and relations types

that have a timestamp condition in the SCCM/SMS database. This status condition indicates
the last time the entity was updated.
l reconciliation_types.txt. Defines the CI types that are used for reconciliation.

For details on adapter configuration, see "Developing Generic Database Adapters" in the HP

l Queries that are used in population jobs should contain one CI type that is labeled with a Root
prefix, or one or more relations that are labeled with a Root prefix.
The root node is the main CI that is synchronized; the other nodes are the contained CIs of the
main CI. For example, when synchronizing the Node CI Type, that graph node is labeled as Root
and the resources are not labeled Root.
l The TQL graph must not have cycles.
l A query that is used to synchronize relations should have the cardinality 1...* and an OR
condition between the relations.
l The adapter does not support compound relations.
l Entities that are added in SCCM/SMS are sent as updates to UCMDB by the SMS Adapter
during differential population.
l ID conditions on the integration TQL query are not supported.
l The TQL graph should contain only CI types and relations that are supported by the SCCM/SMS
adapter.

Chapter 10: NetApp
SANscreen/OnCommand Insight
Integration
Overview 132
Topology 132
How to Discover NetApp SANscreen 133
SANscreen Integration by WebServices Job 134
Adapter 134
Parameters 134
Integration Flow 134
SANscreen Adapter 135

Chapter 10: NetApp SANscreen/OnCommand Insight Integration
Overview
Integration between NetApp SANscreen and DFM involves a UCMDB initiated integration adapter
on the SANscreen WebService API, and synchronizes devices, topology, and hierarchy of storage
infrastructure in UCMDB. This enables Change Management and Impact Analysis across all
business services mapped in UCMDB from a Storage point of view.
Supported Versions
SANscreen integration supports version 5.1.2 (275) of NetApp SANscreen and version 6.2x of the
product which has been renamed NetApp OnCommand Insight.
Topology
The following diagram illustrates the storage topology and shows the relationships between logical
volumes on a storage array and those on servers:

The following diagram illustrates the SAN Topology and shows the fiber channel paths between
storage arrays, switches, and servers:
How to Discover NetApp SANscreen

1. Prerequisite - Shell Connectivity

Ensure there is Shell connectivity to one or more nodes of the SANscreen domain.
2. Run the Discovery

a. Run the Range IPs by ICMP job in order to discover the target IPs.
b. Run the TCP Ports job in order to discover SANscreen WebService ports.
3. Define the integration point

In Data Flow Management > Integration Studio, define a new integration point:

a. Provide a name and description
b. Select the NetApp SANscreen/On Command Insight adapter and enter the required
properties as follows:
Attribute Description
ChunkSize The number of CIs to pull from SANscreen/OnCommand Insight per

query. The default is 1000.
Data Flow Select the name of the Probe on which this integration will run.
Probe
Trigger Select the IpServiceEndpoint at which the SANscreen/OnCommand

CI Instance Insight service is running.
A predefined job appears by default. Define a synchronization schedule if required. Jobs

can also be run without a schedule.
c. Save the job definition and then the integration point.
d. Run a full synchronization for each job at least once.
SANscreen Integration by WebServices Job

Adapter
This job uses the NetApp SANscreen/OnCommand integration adapter.
Parameters
ChunkSize
Default: 1000
Integration Flow
The adapter works as follows:
1. Connect to the SANscreen WebService API using credentials from the SANscreen protocol.
2. Query for storage arrays and create STORAGE ARRAY CIs.
3. Query for logical volumes, fiber channel adapters (Host Bus Adapters), and fiber channel ports
on each storage array and create LOGICAL VOLUME, HBA, and FC PORT CIs.
4. Query for fiber channel switches and create FC SWITCH CIs.

5. Query for fiber channel adapters and ports on each fiber channel switch and create HBA and
FC PORT CIs.
6. Query for hosts/servers and create appropriate COMPUTER, WINDOWS, or UNIX CIs.
7. Query for logical volumes, fiber channel adapters (Host Bus Adapters), and fiber channel ports
on each host/server and create LOGICAL VOLUME, HBA, and FC PORT CIs.
8. Query for paths between hosts/servers and storage arrays and add FCCONNECT
relationships between respective hosts/servers, switches, and storage arrays.
9. Query for logical volume mapping between logical volumes on hosts/servers and logical
volumes on storage arrays and add DEPEND relationships between respective hosts/servers
and storage arrays.
SANscreen Adapter
This section contains information about the SANscreen adapter.
Input CIT
IpServiceEndpoint
Input Query
Triggered CI Data
Name Value
ip_address ${SOURCE.bound_to_ip_address}
port ${SOURCE.network_port_number}
Used Script
SANscreen_Discovery.py
Discovered CITs
l Composition

l Containment
l Cpu
l Dependency
l FabricZoneSet
l FiberChannelZone
l Fiber Channel Connect
l Fibre Channel HBA
l Fibre Channel Port
l Fibre Channel Switch
l IpAddress
l LogicalVolume
l Membership
l Node
l Storage Array
l Storage Fabric
l Storage Processor
l Unix
l Windows
Global Configuration Files

None
Parameters
ChunkSize: The number of CIs to pull from SANscreen/OnCommand Insight per query. The default
is 1,000.


Problem: Depending on the version of NetApp SANscreen or OnCommand Insight in use,
discovery may fail with the following error message in the Probe wrapper logs:
SANscreen: Internal error. Details: java.lang.ClassCastException: com.sun.xml.m

essaging.saaj.soap.ver1_1.Message1_1Impl
Solution: In this case, replace

<DDM>\root\lib\collectors\discoveryProbe\discoveryResources\SANscreen\sanscreen_
api.jar with the corresponding file from the SANscreen server in use.

Chapter 11: ServiceNow Integration
Overview 139
How to Integrate ServiceNow with UCMDB 139
Sample Integration Push Query 141
Supported CITs 142
Pushing Additional CITs 143

Overview
This integration adapter provides the ability to push CIs and relationships from UCMDB to
ServiceNow. The adapter uses an XML mapping framework that enables users to dynamically map
CI Types between UCMDB and ServiceNow, without requiring code changes.
Supported Versions
This integration solution supports pushing CIs to ServiceNow from HP Universal CMDB version
9.02 and later.
How to Integrate ServiceNow with UCMDB

This task explains how to integrate ServiceNow with UCMDB.
1. Configure queries
The CIs and relationships to be pushed to ServiceNow have to be queried from UCMDB using
TQL queries. Create integration type queries to query the CIs and relationships that have to be
pushed to ServiceNow.
An example of such a query, ServiceNowSampleQuery, is included with this integration

package, and can be viewed in the Modeling Studio. For details on viewing queries in the
Modeling Studio, see the HP Universal CMDB Modeling Guide.
2. Create XML mapping files
For every query created in the step above, create an XML mapping file with exactly the same
name (case-sensitive) as the integration query in the following directory:
<UCMDB>\UCMDBServer\runtime\fcmdb\
CodeBase\ServiceNowPushAdapter\mappings
A sample mapping file for this integration, ServiceNowSampleMapping.xml, is provided out

of the box with the package.
For more information about mapping files, see the HP Universal CMDB Developer Reference
Guide.
3. Create the integration point
a. In Data Flow Management, in the Integration Studio, define a new integration point:
i. Provide a name and description.
ii. Ensure the Is Integration Activated option is enabled.

iii. Under Integration Properties > Adapter, select Service-Now Push.
iv. Under Adapter Properties:
Field Value
Service- Domain name used to access the ServiceNow instance. Usually

Now service-now.com.
Domain
Service- The ServiceNow instance being used. For the demonstration

Now instance, enter demo.
Instance
Port Default 443, for HTTPS.
Protocol HTTP or HTTPS.
Proxy If an HTTP(S) proxy service is used to access the Internet, enter the
Server proxy server name.
Name/IP
Proxy HTTP(S) proxy server port.

Server Port
Credentials Define the ServiceNow instance username and password in the

Generic Protocol. For the demonstration website, use
admin/admin.
For credential information, see Supported Protocols in the HP

UCMDB Discovery and Integrations Content Guide.
Data Flow Select the name of the Data Flow Probe to run this integration.
Probe
b. Test the connection to the target CMDB server. If the connection fails, verify that the
information provided is correct.
c. Save the integration point.
d. Add a new job definition to the integration point. Provide a name for the job definition and
select the queries to use to synchronize data from UCMDB to ServiceNow. Define a
synchronization schedule if required.
Note: Jobs can also be run without a schedule.
e. Save the job definition, and then the integration point.

f. Run a full synchronization for each job at least once.
The components responsible for the ServiceNow integration are bundled in the ServiceNow
Integration package, ServiceNow_Integration.zip.
The integration mechanism works as follows:
1. The Integration job queries UCMDB for CIs and relationships:
When an ad-hoc job is run from the integration point in the Integration Studio, the integration
receives the names of the integration queries defined in the job definition, for that integration
point.
It queries UCMDB for the results of these queries (new, updated and deleted CIs and
relationships) and then applies the mapping transformation according to the pre-defined XML
mapping files for every TQL query.
It then pushes the data to the Data Flow Probes.
2. The integration job sends the data to ServiceNow:
Next, on the Data Flow Probe side, the integration process receives the CI and relationship
data sent from the UCMDB server, connects to the ServiceNow server using the Direct Web
Services SOAP API, and transfers the CIs and relationships.
Since the ServiceNow coalescing (CI reconciliation) mechanism is not available for the Direct
Web Services API, a mapping of UCMDB CI IDs to ServiceNow SysIds is maintained on the
discovery Probe. This mapping is used to update and delete CIs and relationships in
ServiceNow.
Sample Integration Push Query

The following image displays a sample query to be pushed to ServiceNow:

Supported CITs
The following CIs and their relationship are supported:
l Apache Tomcat
l Apache
l DB2
l ESX Server
l Host
l IIS Web Server
l Interface
l Ip Address
l JBoss AS
l MySQL
l Net Device
l Oracle

l SQL Server
l Switch
l Unix Server
l Weblogic AS
l WebSphere AS
l Windows Server
Pushing Additional CITs

To push additional CITs, these CITs should be added to the mapping file. For details, see the HP
Pushing additional CI Types requires corresponding JAR files to be generated using the WSDL
URL for each CI Type. The WSDL URL can be generated using information from the Direct Web
Services section at:
http://wiki.service-now.com/index.php?title=SOAP_Web_Service.
The resulting JAR files should be placed in the following directory on the UCMDB Data Flow Probe
server:
<hp>\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\Service-Now\
Note: JAR files should be re-generated following CI Type updates in ServiceNow.
JAR files may be generated using WSDL2JAVA or other similar utilities. An example using this
utility is at :
http://roseindia.net/webservices/axis2/axis2-client.shtml.
For CIs containing reference fields, the target data type of the attribute being mapped to a reference
field should be set to the name of the reference table. For example, to populate the Manufacturer
field on a Windows Server CI, the data type should be the reference table name core_company
as shown below:


This section describes troubleshooting and limitations for the ServiceNow-UCMDB integration.
l Limitation: The integration mapping file only allows mapping concrete CITs and relationships to
the CITs and relationships in ServiceNow. That is, a parent CIT cannot be used to map its
children CIs.
l Limitation: Since this adapter uses the ServiceNow Direct Web Services API, which does not
support CI coalescing (reconciliation), if some CIs being pushed from UCMDB are already
present in the ServiceNow CMDB, before the integration with UCMDB is installed, and if those
CIs are (a) also in UCMDB; and (b) pushed into ServiceNow by the integration, those CIs are
duplicated. (This is because UCMDB does not know these CIs are already in the ServiceNow
CMDB.) After the adapter is installed, UCMDB keeps track of the CIs it pushes to ServiceNow,
to prevent duplication.
l Limitation: ServiceNow Web Service Import Sets are currently not supported.

Chapter 12: Storage Essentials (SE)
Integration
Overview 147
How to Perform the SE Integration 147
Storage Essentials Integration Packages 148
Adapter Parameters 148
Discovered CITs and Relationships 149
Node Details 151
SAN Topology 152
Views 154
Storage Array Details 154
FC Switch Details 154
FC Switch Virtualization 155
Storage Pool Details 155
Host Storage Details 156
SAN External Storage 156
SAN Topology 157
FC Switch Devices to FC Switch 160
Host Devices to Host 160
Logical Volume to Logical Volume 161
Storage Array Devices to Storage Array 161
Reports 162
Storage Array Configuration 162
Host Configuration 162

Chapter 12: Storage Essentials (SE) Integration
Storage Array Dependency 163
Host Storage Dependency 163
Storage Pool Configuration 163

Overview
Integration involves synchronizing devices, topology, and the hierarchy of a customer storage
infrastructure in the Universal CMDB database (CMDB). This enables Change Management and
Impact Analysis across all business services mapped in UCMDB from a storage point of view.
You integrate SE with UCMDB using Data Flow Management (DFM).
When you activate the Storage Essentials integration, DFM retrieves data from the SE Oracle
database and saves CIs to the Universal CMDB database. Users can then view SE storage
infrastructure in UCMDB.
The data includes information on storage arrays, fibre channel switches, hosts (servers), storage
fabrics, logical volumes, host bus adapters, storage controllers, and fibre channel ports. Integration
also synchronizes physical relationships between the hardware, and logical relationships between
logical volumes, storage zones, storage fabrics, and hardware devices.
Supported Versions
The integration procedure supports SE versions 6.x, 9.4, 9.41 and 9.5.
How to Perform the SE Integration

This task includes the steps to perform SE-UCMDB integration.
1. Prerequisites.
a. Add the Storage Essentials server IP address to the DFP IP ranges.
b. Define credentials for the SE database using the Generic DB Protocol.
c. Run the Range IPs by ICMP job.
d. Run the Database TCP Ports job.
e. Run the Oracle Database Connection by SQL job.
2. Create a new integration point.
For details on running integration jobs, see "Integration Studio" in the HP Universal CMDB
b. Under Integration Properties > Adapter, select the Storage Essentials adapter.
c. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.

d. Under Adapter Properties >Trigger CI instance select:
i. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane
appears. Select the CI or
ii. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard
e. Verify the credentials for the chosen CI instance. Right-click Trigger CI instance and
select Actions > Edit Credentials Information.
3. Run the HP Storage Essentials job.
Storage Essentials Integration Packages

The integration includes two UCMDB packages:
l SE_Discovery.zip. Contains the trigger query for SE discovery, discovery script, adapter, and
job.
l Storage_Basic.zip. Contains the new CI Type definitions, views, reports, and impact analysis
rules. This package is common to all Storage Management integration solutions.
Tip: You can include the SE job in the DFM schedule.
For details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP Universal
Adapter Parameters
This job runs queries against Oracle materialized views that are installed and maintained by
Storage Essentials in the Oracle database. The job uses a database CI as the trigger.
A switch or server in SE inherits from a Node CIT in UCMDB based on the following adapter
parameters:

allowDNSLookp If a node in the SE database does not have an IP address but has
a DNS name, it is possible to resolve the IP address by the DNS
name.
True: If a node does not have an IP address, an attempt is made

to resolve the IP address by DNS name (if a DNS name is
available).
Default: False
ignoreNodesWithoutIP Defines whether or not nodes in SE without IP addresses should

be pulled into UCMDB.
l True. Nodes without IPs are ignored.
l False. A Node CI is created with an SE ID as the node key

attribute.
Note: Setting this parameter to False may result in

duplicate CIs in the CMDB.
Default: True
ignorePortsWithoutWWN If set to true, the integration ignores Fiber Channel Ports that do
not have a WWN.
Default: True
Discovered CITs and Relationships

This section describes SE storage entities in UCMDB:
l Fibre Channel Connect. Represents a fibre channel connection between fibre channel ports.
l Fibre Channel HBA. Has change monitoring enabled on parameters such as state, status,
version, firmware version, driver version, WWN, and serial number. A Fibre Channel HBA
inherits from the Node Resource CIT.
l Fibre Channel Port. Has change monitoring enabled on parameters such as state, status,
WWN, and trunked state. Since a Fibre Channel Port is a physical port on a switch, it inherits
from the Physical Port CIT under the NodeElement Resource CIT.
l Fibre Channel Switch. Falls under the Node CIT because SE maintains an IP address for each
switch. Parameters such as status, state, total/free/available ports, and version are change
monitored.

This package retrieves Fibre Channel Switch details from the mvc_switchsummaryvw and
mvc_switchconfigvw views. The job retrieves detailed information about Fibre Channel Ports
on each switch from the mvc_portsummaryvw view.
l Logical Volume. Represents volumes on storage arrays and hosts with change monitoring on
availability, total/free/available space, and storage capabilities.
l Storage Array. Represents a storage array with change monitoring on details such as serial
number, version, and status. Since a storage array may not have a discoverable IP address, it
inherits from the Network Device CIT.
l NetApp Filer. This is a specialized storage array from the NetApp application.
Both Storage Array and NetApp Filer CITs retrieve details from the mvc_
storagesystemsummaryvw view. DFM retrieves detailed information on Storage Processors
and HBAs from the mvc_storageprocessorsummaryvw and mvc_cardsummaryvw tables
respectively.
The SE database may possibly not be able to obtain IP address information on storage arrays for
a variety of technical and policy related reasons.
Since Fibre Channel Ports may be present on a storage array, Storage Processor, or HBA, DFM
uses three separate queries to retrieve Fibre Channel Ports for each storage array. Detailed
information about Fibre Channel Ports on each array is retrieved from the mvc_
portsummaryvw view. Since this view uses a container ID as the key, DFM queries the view
by container ID for each storage array, each Storage Processor on a storage array, and each
HBA on a storage array.
DFM retrieves detailed information about Logical Volumes on each storage Array from the mvc_
storagevolumesummaryvw view.

Results from these queries populate a map as shown below:
l Storage Fabric. Inherits from the Network Resource CIT and represents a storage fabric. This
CIT has no change monitoring enabled.
l Storage Processor. Represents other storage devices such as SCSI controllers, and inherits
from the Host Resource CIT. A Storage Processor CIT monitors change on parameters such as
state, status, version, WWN, roles, power management, and serial number.
l Storage Pool. Storage Pool information is also collected from each storage array using the
query below.
Results from this query populate a map as shown below:
Node Details
DFM retrieves Host details from the mvc_hostsummaryvw view and detailed information on
HBAs from the mvc_cardsummaryvw view.
SE maintains information on Operating Systems, IP address, and DNS name on each host. DFM
uses this information to create Node CIs (UNIX or Windows) and IpAddress CIs.
Since UCMDB uses the IP address of a node as part of its primary key, DFM attempts to use the
IP address from SE for this purpose. If an IP address is not available, DFM then attempts to resolve

the hosts IP address using a DNS name. If neither an IP address nor a DNS name is available,
DFM ignores the host (see "Adapter Parameters" on page 148.
Similar to Storage Arrays, a node may have Fibre Channel Ports directly associated with itself or on
HBAs on the host. The DFM job uses three separate queries to retrieve Fibre Channel Ports for
each host. The job retrieves detailed information about Fibre Channel Ports on each host from the
mvc_portsummaryvw view. Since this view uses a ContainerID attribute as the key, the job
queries the view by containerID for each host, and each HBA on a host.
Finally, DFM retrieves detailed information about Logical Volumes on each host from the mvc_
hostvolumesummaryvw and mvc_hostcapacityvw views. The mvc_hostcapacityvw view
maintains capacity information for each volume over multiple instances in time, and the job uses
only the latest available information.
SAN Topology
SAN Topology consists of the Fibre Channel network topology and includes (fibre channel)
connections between Fibre Channel Switches, Hosts, and Storage Arrays. SE maintains a list of
WWNs that each Fibre Channel Port connects to, and this package uses this list of WWNs to
establish Fibre Channel Connection links.

Storage Topology
Storage topology consists of relationships between Logical Volumes on a host and Logical
Volumes on a Storage Array. DFM uses multiple tables to identify this relationship as shown in the
query below. This view is a summary of all of the above information.

Views
The SE package contains views that display common storage topologies. These are basic views
that can be customized to suit the integrated SE applications.
Storage Array Details

This view shows a Storage Array and its components including Logical Volumes, HBAs, Storage
Processors, and Fibre Channel Ports. The view shows each component under its container Storage
Array and groups Logical Volumes by CI Type.
Storage Array does not require all components in this view to be functional. Composition links
stemming from the Storage Array have a cardinality of zero-to-many. The view may show Storage
Arrays even when there are no Logical Volumes or Storage Processors.
FC Switch Details
This view shows a Fibre Channel Switch and all connected Fibre Channel Ports.

FC Switch Virtualization
FC Switch Virtualization consists of a physical switch or chassis, partitioned into multiple logical
switches. Unlike Ethernet virtualization, physical ports are not shared among multiple virtual
switches. Rather, each virtual switch is assigned one or more dedicated physical ports that are
managed independently by the logical switches.
Storage Pool Details

This view shows Storage Pools with associated Storage Arrays and Logical Volumes.

Host Storage Details

This view shows only Hosts that contain a Fibre Channel HBA or a Logical Volume. This keeps the
view storage-specific and prevents hosts discovered by other DFM jobs from being included in the
view.
SAN External Storage

External storage configuration consists of a storage array presenting a logical volume that, in
reality, belongs to another storage array. This is typically used in configurations where high-end,
more expensive, front-end arrays present volumes from back-end, cheaper, storage to servers. The

goal of this type of virtualization is to virtualize multiple disk arrays from different vendors, scattered
over the network, into a single monolithic storage device that can be managed uniformly.
SAN Topology
This view maps physical connections between Storage Arrays, Fibre Channel Switches, and
Hosts. The view shows Fibre Channel Ports below their containers. The view groups the Fibre
Channel Connect relationship CIT to prevent multiple relationships between the same nodes from
appearing in the top layer.

Storage Topology
This view maps logical dependencies between Logical Volumes on Hosts and Logical Volumes on
Storage Arrays. There is no folding in this view.
FC Port to FC Port
This rule propagates events on a Fibre Channel Port to another connected Channel Port.

Example of HBA crashing on a Storage Array:
l The event propagates from the HBA to the Storage Array and the Logical Volumes on the Array
because of the Storage Devices to Storage Array rule.
l The impact analysis event on the Logical Volume then propagates to other dependent Logical
Volumes through the Logical Volume to Logical Volume rule.
l Hosts using those dependent Logical volumes see the event next because of the Host Devices
to Host rule.
l Depending on business needs, you define impact analysis rules to propagate events from these
hosts to applications, business services, lines of business, and so on. This enables end-to-end
mapping and impact analysis using UCMDB.
Impact Analysis Rules

This package contains basic impact analysis rules to enable impact analysis and root cause
analysis in UCMDB. These impact analysis rules are templates for more complex rules that you
can define based on business needs.
All impact analysis rules fully propagate both Change and Operation events. For details on impact
analysis, see "Impact Analysis Manager Page" and "Impact Analysis Manager Overview" in the HP
Universal CMDB Modeling Guide.
Note: Impact analysis events are not propagated to Fibre Channel Ports for performance
reasons.
FC Port to FC Port
This impact analysis rule propagates events between related fiber channel ports.

FC Switch Devices to FC Switch

This impact analysis rule propagates events from a Fibre Channel Port to and from a Switch. The
event is also propagated to the associated Storage Fabric.
Host Devices to Host

This impact analysis rule propagates events between Fibre Channel HBAs and Hosts, and Logical
Volumes on the Host.

Logical Volume to Logical Volume

This impact analysis rule propagates events on a Logical Volume contained in a Storage Array to
the dependent Logical Volume on the Host.
Storage Array Devices to Storage Array

This impact analysis rule propagates events between Logical Volumes, Storage Processors, Fibre
Channel HBAs, and Storage Arrays.

Reports
The SE package contains basic reports that can be customized to suit the integrated SE
applications.
In addition to the system reports, Change Monitoring and Asset Data parameters are set on each
CIT in this package, to enable Change and Asset Reports in Universal CMDB. For details see "
Storage Array Configuration" below, " Host Configuration" below, " Storage Array Dependency" on
the next page, and " Host Storage Dependency" on the next page.
Storage Array Configuration

This report shows detailed information on Storage Arrays and its sub-components including Fibre
Channel Ports, Fibre Channel Arrays, and Storage Processors. The report lists Storage Arrays with
sub-components as children of the Array.
Host Configuration
This report shows detailed information on hosts that contain one or more Fibre Channel HBAs,
Fibre Channel Ports, or Logical volumes. The report lists hosts with sub-components as children of
the host.

Storage Array Dependency

This report maps dependencies on a Storage Array. The report also displays information on
switches connected to it.
Host Storage Dependency

This report shows detailed information on storage infrastructure dependencies of a Host. The report
lists hosts and dependent components.
Storage Pool Configuration

This report shows detailed information on Storage Pool configuration.


This section describes troubleshooting and limitations of Storage Essentials Integration.
l Problem: If the SE system has duplicate entries for nodes, switches or arrays, the job produces
the following error message: "Process validator error: multiple updates in bulk...".
Solution: This is expected behavior and does not affect population of valid CIs into UCMDB. To
prevent this error message, duplicates must be removed from the SE system.
l Error message: "Please use the SE database with SID 'REPORT' for this integration."
Solution: For integration with SE 9.4 or higher, you should configure the integration point for a
REPORT database instance (and not for an APPIQ instance as applied for SE versions up to
and including 6.3).
l Limitation: The credentials used for integration with SE should have access to the relevant
materialized view status table as detailed below:
Storage Essentials Materialized View Status Table
Version 6.03 and earlier appiq_system.mview_status
Later than Version 6.03 and earlier than appiq_system.mviewcore_status

Version 6.1
and
appiq_system.mview_status
Later than Version 6.1 and earlier than appiq_system.mview_module_status

Version 9.4
Version 9.4 and later appiq_system.mv_report_user_status
l Limitation: If the discovery does not find a valid IP address and serial number for a VMWare
ESX server in the HP Storage Essentials database, that VMware ESX server is not reported to
UCMDB.

Chapter 13: Troux Integration
Overview 166
Integration Overview 166
Use Cases 167
How to Work with the Troux Push Adapter 167
How to Run a Troux Population Job 173

Overview
Troux is a vendor in the EA (Enterprise Architecture) tools market. EA tools allow business users to
understand the gaps between business demands and initiatives. Reviewing how your fixed budget
aligns to business capabilities and how your discretionary spending is allocated across initiatives.
Future-state scenario investigation can be accomplished prior to locking down your roadmap.
Although many use cases can be achieved using EA tools, two specific use cases were chosen for
the UCMDB-Troux integration. This does not preclude additional use cases in the future.
Depending on the use case, a provider of record is determined. For example, UCMDB would be the
provider of record for inventory information such as the server operating system, server hardware,
database, and other infrastructure CIs. Troux on the other hand provides component lifecycles for
server operating system, server hardware, and database versions.
Integration Overview
UCMDB-Troux integration consists of two independent, bi-directional parts: the Troux Push
Adapter, and the Troux Population Adapter.
l The Troux Push Adapter in UCMDB replicates CIs and relationships to Troux. The Troux Push
Adapter is necessary to achieve both the Technology Standards Assessment and Business
Impact Analysis use cases discussed in the introduction above. The adapter also allows the
user to push to Troux CIs that are aged out of UCMDB or deleted.
l The Troux Population Adapter pulls CIs and relationships from Troux to UCMDB. It is necessary
only for the Business Impact Analysis use-case.
Data transfer occurs using XML files between configured directories. Mapping files are used to
apply conversion from TUX format to UCMDB and vice versa.

Supported Versions
Supported versions of the products are listed below.
Target Platform DFM Protocol UCMDB Version
Troux 9.x None 9.02 and later
Use Cases
The use cases chosen for UCMDB-Troux integration are:
l Technology Standards Assessment. The ability to look at a Lifecycle of Software Products to

determine viability within an enterprise.
l Business Impact Analysis. Definition of the definitive source of application CIs to align IT with
business. These application CIs in Troux are related to server operating system, server
hardware, database, and other CIs discovered by UCMDB. Impact Analysis can be determined
using application, business function, and organization for planned change or unplanned
disruption of service.
How to Work with the Troux Push Adapter

This adapter allows replication of CIs and links from UCMDB to Troux. This is accomplished by
definition of queries and mapping files that define the CIs to be transferred and the naming/mapping

of CIs and attributes to Troux components. This adapter also allows the user to push to Troux CIs
that are aged out of UCMDB or deleted.
Define queries
1. Create a query that defines the CIs and attributes you want to replicate to Troux. Two example
queries are supplied in the Integration > Troux folder.
For details, see "Topology Query Language" in the HP Universal CMDB Modeling Guide.
2. Define the properties of each of the CITs.
Note: This step is critical to the operation of the push adapter. You must define the
attributes that will be transferred to Troux.
For details, see "Query Node/Relationship Properties Dialog Box" in the HP Universal CMDB
Modeling Guide.
a. Define the criteria for the Query Node properties
b. Define the advanced properties for each of the attributes.
c. Select attributes to be transferred to Troux.
Example: Computers_for_Troux
In this example, the query requests UCMDB to send all computers with installed software to
Troux. You must define the mapping file with the same name as the query in order for the push
adapter to recognize the query.

Create mapping files

A mapping file is the translation template that defines the CITs and the relationships to be
converted from UCMDB to Troux. For the push adapter to create output, this mapping file must
have definitions for the attributes and CITs or relationships for export. The mapping file is located in:
UCMDB\UCMDBServer\runtime\fcmdb\CodeBase\<adapter>\mappings
where <adapter> is the name of the adapter.
The example mapping file and query (Servers_with_Software) included with the content package
sends Windows computers with installed software to Troux, as expected by Troux. If your
environment uses different CIs with Troux, make sure Troux handles those component types.
When you create the mapping file, give it exactly the same name as your query. For details about
the mapping file options, see "Prepare the Mapping Files" in the HP Universal CMDB Developer
Reference Guide. Use the example mapping files as reference examples for the mapping file
creation.
Note: The definitions in the mapping file (<adapter>.xml) must be the direct CITs and
relationships to be transferred to Troux. The mapping does not support inheritance of class
types. For example, if the query is transferring nt CITs, the mapping file must have definitions
for nt CITs, and not for general nodes or computers. That is, the definition must be an exact
match for what to transfer.


Example
Create an integration point

This section describes how to create and run the job that replicates the data from UCMDB to Troux.
2. Click the New Integration Point button to open the new integration point Dialog Box.
a. Click , select the Data Push into Troux adapter and click OK.
b. Enter the following information:
Name Description
Integration Name The name you give to the integration point.

Name Description
Is Integration Activated Select this check box to create an active integration

point. You clear the check box if you want to deactivate
an integration, for instance, to set up an integration point
without actually connecting to a remote machine.
allowedComponentstodelete The name of the component which is to be deleted and

pushed to Troux. The default is Server.
UCMDB is the system of record for servers. The default

value of Server is important to note because the Troux
system model may not allow deletion of other CITs. If
you modify this property, you must verify (a) the
mapping file is setup correctly to send the deleted CIT to
Troux, and (b) Troux is setup to handle the delete for the
CIT you specify. Deletion of Server is the only OOTB
CIT that has been verified.
Data Flow Probe The name of the Data Flow Probe.
TUX path The location of the TUX output file (created when the
integration job is run).
c. Click Test connection to verify the connectivity, and click OK. If the connection fails,
verify the provided information is correct.
Define an integration job

You use the Integration tab to define a job that uses the integration point that you just defined. For
details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP Universal CMDB Data
Flow Management Guide.
1. Select the queries that you defined in "Define queries" on page 168.
2. To enable deletion, select the Allow Deletion check box. This is a master delete on/off flag
for the job that turns on and off the capability to send deletes.
Note: Deleted CITs are pushed depending on the changes to them in UCMDB. For
example, if UCMDB discovers a computer, and that computer is deleted in UCMDB, this
indicates a change of a deleted computer. And if this computer is part of the push query for
Troux, with delete enabled, a delete is pushed to Troux the next time the push job is run.
3. Specify the job's schedule.
4. Click OK.
5. In the Integration Point pane, click Save. A full data push job will run according to schedule.

The Troux output file (TUX) is generated in the path that you specified in the Integration
Properties for the job.
Note: To run the job again, click .
How to Run a Troux Population Job

This task has the following steps:
Prerequisite - Create a mapping file

Create a mapping file that enables mapping of Troux components and relationships to UCMDB
CITs and relationships.
The top section of the file defines the object or CIT mapping from Troux to UCMDB. The lower
section defines the relationship mapping.
The out-of-the-box mapping file, Troux_to_UCMDB.xml (located in

\DataFlowProbe\runtime\probeManager\discoveryResources\
TQLExport\Troux\data\) contains the typical definitions for mapping the components and CITs
with relationships.

Run the job
Note: For details on running an integration job, see "Integration Studio" in the HP Universal
1. Provide a name and description for the integration point.
2. Under Integration Properties > Adapter, select the Population from Troux adapter.
3. Edit the TUX path field, if required; this sets the location of the TUX output file.
4. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
5. Under Adapter Properties > Trigger CI instance select:

a. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane
appears. Select the CI or
b. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard
Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation Wizard"
in the HP Universal CMDB Data Flow Management Guide.
6. Save the integration point.
7. Run the job.

Chapter 14: UCMDB to XML Adapter
Overview 176
How to Export UCMDB to XML 176
Adapter 177

Overview
By using the UCMDB to XML adapter, it is possible to export the results (CIs and relationships) of
TQL queries and convert these to XML files.
After defining an integration point with the UCMDB to XML adapter, TQL queries can be added to
the jobs of that integration point.
The adapter exports the result of the TQL queries into XML format, and creates XML files in the
Export Directory (as predefined in the integration point).
How to Export UCMDB to XML

1. Prerequisite - General
a. Create a directory on the UCMDB data flow probe system to which the adapter will write
the exported XML files.
b. In the Modeling Studio, create integration TQL queries for the data to be exported to XML.
Ensure the queries return valid results.
2. Prerequisite - Create an integration point and integration job
b. Under Integration Properties > Adapter, select UCMDB to XML adapter.
c. Under Adapter Properties > Export Directory type an absolute path of the directory on
the probe system where the adapter should export the XML files to.
d. Under Adapter Properties > Data Flow Probe Name, select the name of the Data Flow
Probe to be used.
e. Click the Test Connection button to ensure the adapter can validate the defined export
directory.
g. Under Integration Jobs add a new integration job. Edit the job to add integration queries
under the job's definition.
For details on integration points, see Integration Studio > Work with Data Push Jobs >
Create an integration point in the HP Universal CMDB Data Flow Management Guide.

h. Click OK to save the integration job.
i. Click the Save button to save the integration point.
3. Run the job
a. To run the job ad hoc, select the integration job and click the button. The job can also
be configured to run on a schedule.
b. Check the defined export directory on the probe system for the exported XML data, to
ensure the queries create valid XML files.
Note: The XML files have time stamps in the format YYMMDDHHMMSSZZZ. If the
integration query returns a large number of CIs, the export is by chunks of 1,000 CIs.
Each chunk is a separate XML file, with the file for the last chunk having the string
EOD (end of data) appended to it.
For details on running an integration job, see "Integration Studio" in the HP Universal CMDB Data
Flow Management Guide.
Adapter
This job uses the adapter UCMDB to XML (XmlPushAdapter).
Used Script
pushToXml.py
Parameters
Export Directory The absolute path (on the probe system) of the
directory where the XML files will be exported
to.
Data Flow Probe The name of the data flow probe to be used.

HP UCMDB DICG Third Party Integrations

Uploaded by

Copyright:

Available Formats

HP UCMDB DICG Third Party Integrations

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

HP UCMDB DICG Third Party Integrations

Uploaded by

Copyright:

Available Formats

HP Universal CMDB

Software Version: UCMDB 10.10, CP 13.00

Universal Discovery Content Guide - Third Party

Document Release Date: November 2013

Software Release Date: November 2013

Restricted Rights Legend

l This product includes OpenLDAP code from OpenLDAP Foundation (http://www.openldap.org/foundation/).

HP Universal CMDB (UCMDB 10.10, CP 13.00) Page 2 of 177

l Enter into discussions with other software customers

HP Universal CMDB (UCMDB 10.10, CP 13.00) Page 3 of 177

Chapter 1: Aperture VISTA Integration 10

How to Use the Aperture VISTA Integration Adapter 12

Aperture VISTA by SQL Adapter 13

Chapter 2: Atrium Integration 16

How to Work with the Data Push to Atrium Adapter 18

How to Work with the Population from Atrium Adapter 22

Atrium Push Job 27

Data Push into Atrium Adapter 27

Import Data from Atrium Job 29

Population from Atrium Adapter 29

Mapping Files Overview 31

Mapping File Structure 31

Mapping File Elements 32

Troubleshooting and Limitations 35

Chapter 3: CA CMDB Integration 36

How to Work with the CA CMDB Push Adapter 38

Troubleshooting and Limitations 40

HP Universal CMDB (UCMDB 10.10, CP 13.00) Page 4 of 177

Chapter 4: CiscoWorks LAN Management Solution Integration 42

How to Discover CiscoWorks LMS 44

CiscoWorks LMS Database Ports Job 45

Network Devices from CiscoWorks LMS Job 45

Layer 2 Topology from CiscoWorks LMS Job 46

CiscoWorks NetDevices Adapter 47

CiscoWorks Layer 2 Adapter 48

Troubleshooting and Limitations 53

Chapter 5: EMC Control Center (ECC) Integration 54

How to Run the ECC/UCMDB Integration Job 56

ECC Integration Job 58

Impact Analysis Rules 66

Chapter 6: IDS Scheer ARIS Integration 72

HP Universal CMDB (UCMDB 10.10, CP 13.00) Page 5 of 177

How to Run the ARIS Integration Job 74

Import CIs from ARIS Job 80

Chapter 7: Importing Data from External Sources 82

Comma Separated Value (CSV) Files 83

CSV Files with Column Titles in First Row 84

How to Import CSV Data from an External Source – Scenario 85

How to Convert Strings to Numbers 90

Import from CSV File Job 92

Import from Database Job 95

Import from Properties File Job 100

External Source Mapping Files 101

Troubleshooting and Limitations 102

Chapter 8: Import from Excel Workbook Discovery 103

Supported Versions 104

How to Import Data from Excel Workbook 104

How to Set Up an Import File in Excel 106

Import from Excel Workbook Job 115