BMC Atrium Core 9.0.01

BMC Software Confidential. BladeLogic Confidential.
BMC Atrium Core 9.0
Home
Date:
27-Aug-2015 06:13
URL:
https://docs.bmc.com/docs/display/ac9000/Home
Home
Contents
Recently Updated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What's new . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Featured content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Where to start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Release notes and notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Known and corrected issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.0.01: Service Pack 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.0.00.001: Patch 1 for version 9.0.00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.0.00 enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Separate online documentation for installation and upgrade information . .
New CMDB Dashboard that provides key metrics about the CMDB and CIs
58
Improved performance by use of Denormalized CMDB Data Storage . . . . .
Reduced time to value due to the preconfigured integration of BMC Atrium
Discovery and Dependency Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reduced time and expense of integration with preconfigured integration of
Microsoft System Center Configuration Manager . . . . . . . . . . . . . . . . . . . .
New dataset-level permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Central management of configuration logs in a server group environment .
Configuring BMC Atrium CMDB Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction of RESTful API to simplify integrations between platforms . . .
BMC Atrium Core online documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Statement of direction for BMC Atrium Integration Engine . . . . . . . . . . . . .
40
41
42
43
44
45
47
47
55
56
57
57
58
.
Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Charateristics of BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ITIL processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
68
69
70
70
76
BMC Atrium Core 9.0
59
59
60
61
61
62
62
62
65
65
Page 2 of 2268
Home
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
User goals and features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Use case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Implementing BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Importing data to BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Managing BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Taking Your Data Into Production End to End video . . . . . . . . . . . . . . . . . 121
Best practices for BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is a CMDB? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
............................................................
Loading data into BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practices for loading data into BMC Atrium CMDB . . . . . . . . . . . . . .
Building a Service Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practices for the Common Data Model . . . . . . . . . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practices for handling Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practices for handling Normalization . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Best Practices for handling Reconciliation . . . . . . . . . . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
122
122
123
124
124
126
127
127
127
128
129
130
132
132
132
133
134
Planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deployment architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deployment scenarios and considerations . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Recommended installation environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infrastructure stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Application stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BSM installation environment recommendations . . . . . . . . . . . . . . . . . . . . . .
BSM Interoperability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mainframe integrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BSM Reference Stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
136
136
137
138
141
142
142
142
142
143
149
149
BMC Atrium Core 9.0
Page 3 of 2268
Home
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Planning a CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDB planning stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Phased implementation of a CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Challenges, critical success factors, and risks with SACM . . . . . . . . . . . .
Planning the data model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data model classes, attributes and extensibility . . . . . . . . . . . . . . . . . . . . .
Synchronizng class changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Planning to extend the data model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Planning BMC Atrium CMDB data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data stored in an ITIL CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Planning to populate BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . .
Planning to use federated data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Controlling access to data with multitenancy . . . . . . . . . . . . . . . . . . . . . . .
Sizing considerations for populating BMC Atrium CMDB . . . . . . . . . . . . .
Replicating BMC Atrium CMDB data to other servers . . . . . . . . . . . . . . . .
Planning data normalization and the Product Catalog . . . . . . . . . . . . . . . .
Planning data reconciliation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Identifying instances across datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparing datasets with the Reconciliation Engine . . . . . . . . . . . . . . . . .
Merging datasets with the Reconciliation Engine . . . . . . . . . . . . . . . . . . . .
Other reconciliation activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Combining activities as a reconciliation job . . . . . . . . . . . . . . . . . . . . . . . .
Qualification groups in reconciliation activities . . . . . . . . . . . . . . . . . . . . . .
Planning a service model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service model overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service model components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Designing a service model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Planning to upgrade BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core support for IPv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
150
150
150
151
153
153
154
155
165
166
174
174
179
191
197
200
201
201
205
206
207
207
212
212
213
213
213
215
216
222
223
Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
About BMC Remedy ITSM Suite 9.0 Deployment online documentation . . . . 224
Configuring after installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Performing health check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
To check the health of a BMC Atrium Core installation . . . . . . . . . . . . . . . 227
BMC Atrium Core 9.0
Page 4 of 2268
Home
Verifying Atrium Integrator installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

To verify Atrium Integrator installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Post-installation tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Configuring BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Configuring server queue settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Verifying RPC program numbers used by BMC Remedy products . . . . . . 229
Configuring BMC Atrium CMDB Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Configuring BMC Atrium CMDB Engine Logging . . . . . . . . . . . . . . . . . . . . 233
Configuring BMC Atrium Core Web Services . . . . . . . . . . . . . . . . . . . . . . . . . 235
Configuring and deploying web services with BMC applications . . . . . . . . 235
Configuring BMC Atrium web services registry for AR system server group . .
236
Enforcing security policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Updating the Tomcat startup script after installing BMC Atrium Core Web
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Setting up BMC Atrium Service Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Initial setup steps for BMC Atrium Service Context . . . . . . . . . . . . . . . . . . 238
Configuring BMC Remedy AR System to support BMC Atrium Service Context
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Additional configuration steps for BMC Atrium Service Context . . . . . . . . 240
Implementing Distributed BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . 240
Implementing DSO for Distributed BMC Atrium CMDB . . . . . . . . . . . . . . . 241
Setting up DSO for one-way transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Setting up DSO for two-way transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Configuring load balancing for Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . 250
Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
About BMC Remedy ITSM Suite 9.0 Deployment online documentation . . . . 253
Integrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Launching BMC Atrium Core widgets from BMC Remedy AR System applications
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
To launch a BMC Atrium Core widget from AR System applications . . . . . 256
Atrium:Explorer and Atrium:Query launch parameters from other AR System
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Embedding BMC Atrium Core widgets in BMC Remedy AR System applications
257
BMC Atrium Core 9.0
Page 5 of 2268
Home
To embed a BMC Atrium Core widget in a BMC Remedy AR System form

258
Launching BMC Atrium Core widgets from non-BMC Remedy AR System
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
To launch BMC Atrium Explorer from a browser . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB and BMC Atrium Discovery and Dependency Mapping
Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing BMC.ADDM Dataset, and Reconciliation Jobs . . . . . . . . . . . . . . .
259
260
Using . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Navigating the interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing BMC Atrium CMDB Dashboard . . . . . . . . . . . . . . . . . . . . . . . .
Accessing the BMC Atrium CMDB and BMC Atrium Core applications . . .
Accessing the Atrium Integrator console . . . . . . . . . . . . . . . . . . . . . . . . . .
Launching Atrium Integrator Spoon from Atrium Integrator . . . . . . . . . . . .
Opening and searching the Service Catalog . . . . . . . . . . . . . . . . . . . . . . .
Opening Class Manager and viewing classes . . . . . . . . . . . . . . . . . . . . . .
Summary of tasks in the Reconciliation console . . . . . . . . . . . . . . . . . . . .
Simulating the impact of changes to CIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Impact Simulator and BMC Service Impact Manager . . . . . . . . . . .
Impact states in Atrium Impact Simulator . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Impact Simulator interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running an impact simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Loading a saved impact simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparing impact simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running a report of simulation results . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running a quick impact simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opening a related change from BMC Atrium Impact Simulator . . . . . . . . .
Calbro scenario for BMC Atrium Impact Simulator . . . . . . . . . . . . . . . . . .
Finding BMC Atrium CMDB data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How queries work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Find tab in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Finding CIs using a saved query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing federated data in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . .
Building queries in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . .
Working with CIs and relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating CIs in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
264
264
264
267
290
291
292
294
298
299
300
300
301
305
306
306
307
308
310
311
311
313
317
320
323
324
346
347
BMC Atrium Core 9.0
..
260
261
Page 6 of 2268
Home
Creating relationships between CIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

Deleting CIs in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Editing CIs and relationships in BMC Atrium Explorer . . . . . . . . . . . . . . . . 357
Working with related CIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Working with CIs and relationships in a popup . . . . . . . . . . . . . . . . . . . . . 360
Viewing filtered CIs that are part of a virtual relationship in a popup . . . . . 362
Comparing CI and relationship instances in BMC Atrium Explorer . . . . . . 363
Viewing instance history in BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . 366
Instance groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
BMC Atrium Explorer views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Sandbox views and datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Promoting CIs and relationships from a Sandbox dataset . . . . . . . . . . . . . 373
BMC Atrium Explorer layout controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Creating, copying, or deleting views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Saving a view as an image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
BMC Atrium Explorer filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Using filters to restrict which instances are displayed . . . . . . . . . . . . . . . . 381
Viewing business service CI information by using BMC Atrium Service Context
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Administering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Configuring logging information in CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Configuring shared plugins logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Managing permissions in BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Configuring user access to BMC Atrium Core components . . . . . . . . . . . . 390
Groups installed with BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . 392
BMC Atrium Core permission roles within applications . . . . . . . . . . . . . . . 393
Calbro Services scenario for BMC Atrium CMDB groups, roles, and users . .
399
BMC Remedy AR System license types required for data access in BMC
Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
BMC Atrium CMDB data permissions for classes and attributes . . . . . . . . 402
Roles, instance permissions, and row-level access in BMC Atrium Core . 404
Permission scenarios when managing user access to BMC Atrium CMDB data
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Managing dataset level permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
BMC Atrium Core 9.0
Page 7 of 2268
Home
Managing the Product Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of the BMC Atrium Core Product Catalog . . . . . . . . . . . . . . . . .
Product Catalog and multitenancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Populating the Product Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product categorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Updating the Product Catalog data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Normalization and the Product Catalog overview . . . . . . . . . . . . . . . . . . .
Managing Product Catalog entries in bulk . . . . . . . . . . . . . . . . . . . . . . . . .
Exporting Product Catalog data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modeling data and impacts in BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . .
Modifying your data model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deprecating classes and attributes in your data model . . . . . . . . . . . . . . .
Administering CI impact models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modeling business entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of changes to the Common Data Model . . . . . . . . . . . . . . . . . .
Denormalized CMDB Data Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Understanding Denormalized CMDB Data Storage . . . . . . . . . . . . . . . . . .
Regular classes converted to categorization subclasses . . . . . . . . . . . . . .
Adding a categorization subclass as a child of an abstract class . . . . . . . .
Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deploying CDM denomalization package using installer wizard . . . . . . . .
Performing denormalization of Common Data Model . . . . . . . . . . . . . . . .
Administering service models and the Service Catalog . . . . . . . . . . . . . . . . .
Creating the service model in BMC Atrium Core . . . . . . . . . . . . . . . . . . . .
Defining options for the Service Catalog . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding a customer price or delivery cost to an option, service, or request
action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating new services for the Service Catalog . . . . . . . . . . . . . . . . . . . . .
Creating a service offering in the Service Catalog . . . . . . . . . . . . . . . . . . .
Creating a request action in the Service Catalog . . . . . . . . . . . . . . . . . . . .
Using a CI query to create dynamic service models . . . . . . . . . . . . . . . . .
Managing datasets in BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating datasets in the Reconciliation console . . . . . . . . . . . . . . . . . . . . .
Deleting a dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing data with Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
414
414
427
436
454
476
492
505
517
519
519
553
564
572
629
634
634
635
636
636
640
641
662
664
666
668
670
671
678
680
683
684
685
686
687
Page 8 of 2268
Home
Understanding Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688

Limitations of Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Scenario for transferring data to BMC Atrium CMDB . . . . . . . . . . . . . . . . . 707
Working with Atrium Integrator data store connections . . . . . . . . . . . . . . . 729
Creating a job in Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Editing Atrium Integrator jobs and transformations . . . . . . . . . . . . . . . . . . 764
Running an Atrium Integrator job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Monitoring jobs in Atrium Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Complex jobs in Atrium Integrator Spoon . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Upgrading and migrating Atrium Integrator jobs . . . . . . . . . . . . . . . . . . . . . 834
Migrating existing data exchanges to Atrium Integrator . . . . . . . . . . . . . . . 840
Mapping BMC Atrium Integration Engine and Atrium Integrator . . . . . . . . 862
Normalizing data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Overview of normalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Preparing for normalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Typical normalization setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Optional normalization tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Reconciling data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Overview of reconciliation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Reconciliation in a server group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Reconciliation IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Reconciliation jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Reconciliation Identify and Merge activities . . . . . . . . . . . . . . . . . . . . . . . . 974
Additional reconciliation activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
Namespaces and reconciliation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Reconciliation configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
BMC Configuration Drift Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
Understanding Drift Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
Managing Drift Management permissions . . . . . . . . . . . . . . . . . . . . . . . . 1040
Getting started with Drift Management . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
Creating snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
Creating baselines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
Creating targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066
Creating qualification sets and include and exclude sets . . . . . . . . . . . . . 1069
BMC Atrium Core 9.0
Page 9 of 2268
Home
Creating and managing comparison jobs . . . . . . . . . . . . . . . . . . . . . . . . .

Viewing Drift Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Remediating drifts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing Drift Reports from the Drift Dashboard . . . . . . . . . . . . . . . . . . . .
Using preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Comparison service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using server groups with Drift Management . . . . . . . . . . . . . . . . . . . . . .
Configuring federated data in BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . .
Opening Federation Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview of plugins and adapters for federated data . . . . . . . . . . . . . . .
Managing federated data stores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Retrieval method of federation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Launch method of federation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Managing BMC Atrium CMDB extensions . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing the Extension Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Manually creating BMC Atrium CMDB extensions . . . . . . . . . . . . . . . . . .
Installing BMC Atrium CMDB extensions . . . . . . . . . . . . . . . . . . . . . . . . .
Verifying your installed extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Migrating BMC Atrium Core data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Migrating BMC Remedy AR System support data from source servers to
target servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Migrating BMC Atrium CMDB class definitions and instances . . . . . . . . .
Migrating Product Catalog data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Migrating normalization jobs and settings . . . . . . . . . . . . . . . . . . . . . . . .
Migrating reconciliation jobs and dataset settings . . . . . . . . . . . . . . . . . .
Manual configuring federated data on your production server . . . . . . . . .
Configuring BMC Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control of the layout of class forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the cache refresh interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting the DSO option for BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . .
Changing the default CI editor in BMC Atrium Explorer . . . . . . . . . . . . . .
Configuring how layers are displayed in BMC Atrium Explorer . . . . . . . .
Notification of BMC Atrium CMDB events . . . . . . . . . . . . . . . . . . . . . . . .
Viewing CI status in context of installed applications . . . . . . . . . . . . . . . . . .
Overview of BMC Atrium Service Context . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1077
1085
1094
1101
1105
1109
1113
1116
1117
1118
1132
1133
1142
1154
1154
1155
1157
1161
1162
1163
1163
1163
1175
1179
1180
1181
1182
1182
1189
1189
1190
1191
1195
1199
1200
Page 10 of 2268
Home
Applications that interact with BMC Atrium Service Context . . . . . . . . . . 1204

Attributes that are displayed in BMC Atrium Service Context . . . . . . . . . 1204
Configuring attributes in the Service Context Administration window . . . 1207
Configuring BMC Atrium Service Context cache and data retrieval settings . .
1210
Configuring BMC Atrium Service Context for BMC Remedy ITSM applications
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212
Packaging BMC Atrium CMDB extensions . . . . . . . . . . . . . . . . . . . . . . . . . . 1219
Exporting class definitions by using cmdbdriver . . . . . . . . . . . . . . . . . . . . 1220
Creating the package.xml file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
Creating an installation activity file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
Converting the extension files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
Validating the extension file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1225
Triggering jobs to import data into BMC Atrium CMDB . . . . . . . . . . . . . . . . . 1226
To trigger jobs to import data in BMC Atrium CMDB . . . . . . . . . . . . . . . . 1227
Configuring Data Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229
Data Archiving Policy for Reconciliation Engine . . . . . . . . . . . . . . . . . . . . 1229
Data Archiving Policy for Normalization Engine . . . . . . . . . . . . . . . . . . . . 1229
Related records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
Viewing Archived records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
Archiving Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
Developing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB API architecture overview . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB Java API package . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core web services API overview . . . . . . . . . . . . . . . . . . . . .
REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operations on instance objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
API use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB C API features and components . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB C API features . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported BMC Atrium Core C API platforms . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB C API components . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting started with Atrium CMDB APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB Java API requirements and package contents . . . . .
BMC Atrium Core Web Services API components . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB API compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1231
1231
1232
1233
1234
1235
1245
1246
1246
1247
1247
1247
1248
1249
1250
Page 11 of 2268
Home
BMC Atrium CMDB C API requirements and package contents . . . . . . . 1252

Sample BMC Atrium Core API code . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
BMC Atrium CMDB API and SQL views . . . . . . . . . . . . . . . . . . . . . . . . . 1255
BMC Atrium CMDB API print.c routines . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
API version requirements for BMC Atrium CMDB client-server connections . .
1256
Comparison between BMC Atrium CMDB API programming and using the
BMC Atrium Core Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1257
Getting started with BMC Atrium Core Web Services . . . . . . . . . . . . . . . . . . 1258
BMC Atrium Core Web Services and the BMC Remedy AR System Web
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
Apache Axis2 and BMC Atrium Core Web Services . . . . . . . . . . . . . . . . 1259
Working with the BMC Atrium Core Web Services infrastructure . . . . . . 1266
BMC Atrium Core UDDI Registry Server functionality and supported features
1274
Backing Up and Restoring Data in the BMC Atrium Core UDDI Registry
Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281
Modifying BMC Atrium Web Services runtime configuration . . . . . . . . . . 1284
Modifying archive properties in main.xml . . . . . . . . . . . . . . . . . . . . . . . . . 1287
BMC Atrium Core Web Services security . . . . . . . . . . . . . . . . . . . . . . . . . 1290
Guidelines for using the BMC Atrium Core Web Services Registry and
interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1307
Accessing BMC Atrium Core Web Services . . . . . . . . . . . . . . . . . . . . . . . 1324
CMDBWS support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1325
C API data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1328
Types of BMC Atrium CMDB C API structures . . . . . . . . . . . . . . . . . . . . 1331
CMDBAttributeGetStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
CMDBAttributeLimit structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
CMDBAttributeLimitList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
CMDBAttributeNameId structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
CMDBAttributeValueList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
CMDBAttributeValueListList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
CMDBAttributeValueStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
CMDBAuditInfoStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
CMDBAuditValueList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
CMDBAuditValueListList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340
BMC Atrium Core 9.0
Page 12 of 2268
Home
CMDBClassNameId structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBClassNameIdList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBClassRelationship structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBClassTypeInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBExportItem structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBExportItemList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBExportItemStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBFederatedActivateInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBFederatedARInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetObjectList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetObjectStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetRelationList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetRelationStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphAdjacentList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphAdjacentStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkObjectList structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkObjectStruct structure . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkQueryStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkRelation structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkRelationList structure . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkResultStruct structure . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkSelectorAndFilterList structure . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkSelectorAndFilterStruct structure . . . . . . . . . . . . . . . . .
CMDBGraphWalkStateStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBImportItem structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBImportDataSummaryStruct structure . . . . . . . . . . . . . . . . . . . . . . .
CMDBImportItemStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBIndexList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBIndexStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBInstanceList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBInstanceStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBItemTypeAttribute structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBItemTypeClass structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBNestedQueryStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1340
1341
1341
1342
1342
1343
1344
1344
1345
1346
1346
1347
1347
1347
1348
1348
1349
1349
1350
1350
1351
1352
1352
1353
1353
1354
1354
1355
1356
1356
1357
1357
1358
1358
1359
1359
Page 13 of 2268
Home
CMDBQualifierStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryArithOpStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryAttributeName structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryCardinality structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryObject structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryObjectList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryObjectRelationship structure . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryObjectSelectorList structure . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryObjectSelectorStruct structure . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierAndOrStruct structure . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierSetOpStruct structure . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierSimpleOpStruct structure . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierValueSetStruct structure . . . . . . . . . . . . . . . . . . . . .
CMDBQueryQualifierValueStruct structure . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryResultGraph structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQuerySortStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQuerySortList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphQueryResult structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBStdEdgeResult structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBEdgeListList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBNodeList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBNodeListList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBRelationshipResult structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBRelationshipResultList structure . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREClassQualList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREClassQualStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREDatasetList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREDatasetPair structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREJobRunInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBREJobRunInfoList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSortList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSortStruct structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBUIComponentInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBUIComponentResult structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1359
1360
1361
1361
1362
1363
1363
1364
1364
1365
1365
1366
1367
1367
1368
1369
1370
1370
1371
1372
1372
1373
1373
1374
1374
1374
1375
1375
1375
1376
1376
1377
1377
1377
1378
1380
Page 14 of 2268
Home
CMDBUIComponentResultList structure . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBVersionInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBVersionInfoList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBWeakPropagatedAttrs structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBWeakPropagatedAttrsList structure . . . . . . . . . . . . . . . . . . . . . . . .
CMDBXMLExportItemList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBXMLImportItemList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C API functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Types of BMC Atrium CMDB C API functions . . . . . . . . . . . . . . . . . . . . .
CMDBActivateFederatedInContext function . . . . . . . . . . . . . . . . . . . . . . .
CMDBBeginBulkEntryTransaction function . . . . . . . . . . . . . . . . . . . . . . .
CMDBBeginClientManagedTransaction function . . . . . . . . . . . . . . . . . . .
CMDBCancelJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateGuid function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateMultipleAttributes function . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBCreateMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBDeleteAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBDeleteClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBDeleteInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBDeleteMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBEndBulkEntryTransaction function . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBEndClientManagedTransaction function . . . . . . . . . . . . . . . . . . . .
CMDBExpandParametersForCI function . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBExportData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBExportDef function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetCopyAuditData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetInstanceBLOB function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetListClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetListInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetMultipleAttributes function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1380
1381
1381
1382
1382
1382
1383
1383
1385
1388
1389
1390
1391
1391
1394
1396
1397
1398
1400
1401
1402
1403
1404
1405
1405
1406
1407
1408
1408
1411
1413
1414
1415
1416
1417
1419
Page 15 of 2268
Home
CMDBGetMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetCMDBUIComponents function . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetListJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetRelatedFederatedInContext function . . . . . . . . . . . . . . . . . . . .
CMDBGetServerPort function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGetVersions function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphQuery function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkBegin function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkEnd function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphWalkNext function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBImportData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBImportDef function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBInitialization function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryByPath function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBRemoveClientManagedTransaction function . . . . . . . . . . . . . . . . .
CMDBRunQualificationForCI function . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetClientManagedTransaction function . . . . . . . . . . . . . . . . . . . . .
CMDBSetInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetMultipleAttributes function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSetServerPort function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBStartJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSynchMetaData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBSystemInit function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBTermination function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C API Query functions overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBQueryByPath function overview . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graph walk query function overview . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBGraphQuery function overview . . . . . . . . . . . . . . . . . . . . . . . . . . .
cmdbdriver program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initial cmdbdriver screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running cmdbdriver from the command line . . . . . . . . . . . . . . . . . . . . . .
cmdbdriver command line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1421
1422
1423
1424
1425
1426
1426
1427
1429
1430
1430
1431
1432
1433
1433
1434
1435
1436
1437
1440
1440
1441
1443
1444
1445
1446
1446
1447
1447
1448
1453
1455
1465
1466
1467
1469
Page 16 of 2268
Home
Commands for controlling cmdbdriver . . . . . . . . . . . . . . . . . . . . . . . . . . .

cmdbdriver commands for C API functions . . . . . . . . . . . . . . . . . . . . . . .
Web Services API data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AbstractType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ActivateFederatedInContextOutput structure . . . . . . . . . . . . . . . . . . . . . .
ActivateFederatedInContext structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
AtriumBackendFault structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AtriumFault structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AtriumServiceFault structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AtriumServiceFaultType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttachmentLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attachment structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttachPoolLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeAuditType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeCreateMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeEntryMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeInfoIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeInfoOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeLimitBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AttributeValueListList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditOperationType (atrium_audit) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditOperationType (atrium_instances) . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditValueList (atrium_audit) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditValueList (atrium_instances) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditValueListList (atrium_audit) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AuditValueListList (atrium_instances) . . . . . . . . . . . . . . . . . . . . . . . . . . .
BeginGraphWalk data structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BeginGraphWalkOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOBluePrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOBluePrintSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOBusinessService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1470
1472
1479
1485
1485
1486
1487
1487
1488
1489
1489
1490
1490
1491
1491
1491
1492
1493
1493
1494
1495
1496
1497
1497
1498
1498
1499
1499
1500
1500
1501
1501
1502
1502
1503
1503
Page 17 of 2268
Home
BOContract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractAddOnLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractDeliveryROSOLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLifeCycleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLineLifeCycleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLineList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLineSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLineSelectorList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractLineType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractOfferingLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractOfferingLineSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractROLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractSelectedOptionLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractSOLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOContractType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOCost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BODeliveryRequestableOffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BODeploymentBluePrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOFinancialElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOFinancialElementSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOFunctionalBluePrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingLifeCycleStageType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingLifeCycleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOfferingWarrantyType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOptionChoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOptionChoiceSelectionModeType . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOOrganization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOPerson . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOPriceLifeCycleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1504
1505
1505
1506
1507
1508
1509
1509
1510
1510
1511
1511
1512
1512
1513
1514
1514
1515
1515
1516
1516
1517
1517
1518
1519
1519
1520
1521
1521
1522
1523
1523
1524
1525
1526
1526
Page 18 of 2268
Home
BORef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BORefList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BORequestableOffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BORequestableOfferingSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceLevelTarget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceLevelTargetClassificationType . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceLevelTargetList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceLevelTargetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceLifeCycleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceOffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceOfferingList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOServiceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOTechnicalService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BOTechnicalServiceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BusinessObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BusinessObjectBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BusinessObjectList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BusinessObjectSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BusinessObjectSelectorList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ByteArray structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ByteList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ByteListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CancelNEJobRun structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CancelREJobRun (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . .
CancelREJobRun (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cardinality structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CharacteristicMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Characteristic structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CharLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassAuditInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassAuditType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassDeleteOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassFederation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1527
1527
1528
1528
1529
1529
1530
1531
1531
1532
1532
1533
1534
1534
1535
1535
1536
1536
1537
1538
1538
1539
1539
1540
1540
1541
1541
1542
1543
1543
1544
1544
1545
1545
1546
1546
Page 19 of 2268
Home
ClassFederationRelationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassInfoIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassInfoOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassNameIdList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassNameId structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassProperties structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassQualifier (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassQualifier (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassQualifierList (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . .
ClassQualifierList (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassRegular structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassRelationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassSchemaDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassSchemaDescriptionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassSchemaReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassSchemaReferenceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassToAttributesMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassToAttributesMapEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ClassType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBfConfigurationManifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBfConfigurationParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CommonSchemaDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ComplexExtensionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ComponentType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConfigProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConfigPropertyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConfigPropertyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CoordinateList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Coordinate structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateAttribute structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateBusinessObjectOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateBusinessObject structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateClass structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateDataset structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateInstanceInfoIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateInstanceInfoInList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1547
1547
1548
1549
1549
1549
1550
1550
1551
1551
1552
1553
1553
1554
1555
1555
1556
1556
1557
1557
1558
1559
1560
1560
1561
1561
1562
1563
1564
1564
1565
1566
1566
1567
1568
1568
Page 20 of 2268
Home
CreateInstanceOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateInstance structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleBusinessObjectsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleBusinessObjects structure . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleInstancesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleInstances structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateSavedQuery structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CurrencyDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CurrencyDetailList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CurrencyLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Currency structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetAccessType (datasets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetAccessType (service impact) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetPair (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetPair (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetPairList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetPairList (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . .
DatasetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DateLimit structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DateTimeArray structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DecimalLimit structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteAttribute structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteBusinessObject structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteClass structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteDataset structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteInstanceInfoIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteInstanceInfoInList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteInstance structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMultipleBusinessObjects structure . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMultipleInstances structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeletePropertiesOutput structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteProperties structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteSavedQuery (atrium_graphquery) structure . . . . . . . . . . . . . . . . .
DeleteSavedQuery (atrium_query) structure . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1569
1569
1570
1570
1571
1571
1572
1573
1573
1574
1574
1575
1575
1576
1576
1577
1577
1578
1578
1578
1579
1579
1580
1580
1581
1582
1582
1583
1583
1584
1584
1585
1586
1586
1587
1587
Page 21 of 2268
Home
DiaryItemList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DiaryItem structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DiaryLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DiaryValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EdgeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EdgeListArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ElementDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ElementDescriptionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ElementType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ElementTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EndGraphWalk structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumerationValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumerationValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumerationValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumItemList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EnumStyle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExecuteSavedQuery structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExpirationIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExpirationOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExportNEConfigurationOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExportNEConfiguration structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExposureType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExtensionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedAccessType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedAccessTypeAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedActionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedActivateInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedActivationOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FederatedARInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FunctionalCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FunctionalCurrencyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAttributesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAttributes structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetBusinessObjectOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1588
1589
1589
1590
1590
1591
1591
1592
1592
1592
1593
1593
1594
1594
1595
1595
1596
1596
1597
1598
1598
1598
1599
1600
1600
1600
1601
1601
1602
1602
1603
1604
1604
1604
1605
1606
Page 22 of 2268
Home
GetBusinessObject structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetClassOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetClass structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetCopyAuditData (atrium_audit) structure . . . . . . . . . . . . . . . . . . . . . . .
GetCopyAuditData (atrium_instances) structure . . . . . . . . . . . . . . . . . . .
GetCopyAuditDataOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetDatasetOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetDataset structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetGraphWalkStatusOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetGraphWalkStatus structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetInstancesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetInstances structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetLastNEJobRunStatusOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetLastNEJobRunStatus structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetMultipleBusinessObjectsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetMultipleBusinessObjects structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNEJobRunStatusOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNEJobRunStatus structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByFileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByFPKey structure . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByName structure . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByPCKey structure . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetProperties (service configuration) structure . . . . . . . . . . . . . . . . . . . .
GetProperties (service utility) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetPropertiesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRun (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRun (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEventListOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEventList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEventOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEvent structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunList (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunList (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunListOutput (classic reconciliation) . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1606
1607
1607
1608
1609
1610
1610
1611
1611
1612
1612
1613
1614
1615
1615
1616
1616
1617
1617
1618
1619
1619
1620
1620
1621
1622
1622
1623
1623
1624
1624
1625
1626
1626
1627
1627
Page 23 of 2268
Home
GetREJobRunListOutput (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunOutput (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunOutput (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedFederatedInContextOutput . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedFederatedInContext structure . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedServicesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedServices structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetSavedQuery (atrium_graphquery) structure . . . . . . . . . . . . . . . . . . . .
GetSavedQuery (atrium_query) structure . . . . . . . . . . . . . . . . . . . . . . . .
GetSavedQueryOutput (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . .
GetSavedQueryOutput (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . .
GetUIComponentsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetUIComponents structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetVersionsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetVersions structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryResult (7.6.04) structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryResult data structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryResultFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQueryResult structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQuery structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkAttributeFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkObjectFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkQueryMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkRelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkRelationArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkRelationDirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkRelationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkSelectorAndFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkSelectorAndFilterArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphWalkSelectorAndFilterList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ImportNEConfigurationOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1628
1628
1629
1630
1630
1631
1631
1632
1633
1633
1634
1634
1635
1636
1636
1637
1637
1638
1639
1639
1639
1640
1640
1641
1642
1642
1643
1643
1644
1644
1645
1645
1646
1646
1646
1647
Page 24 of 2268
Home
ImportNEConfiguration structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IndexInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IndexList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
InstanceDeleteOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
InstanceInfoOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
InstanceInfoOutList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IntArray structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IntLimit structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JobRunStatusType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Keyword structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListClassesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListClasses structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListDatasetsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListDatasets structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListSavedQueries (atrium_graphquery) structure . . . . . . . . . . . . . . . . . .
ListSavedQueries (atrium_query) structure . . . . . . . . . . . . . . . . . . . . . . .
ListSavedQueriesOutput (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . .
ListSavedQueriesOutput (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . .
Location structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LoginInfo structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NameValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NameValue structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEExportOptionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEExportOptionTypeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEFileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEFileInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEImportOptionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEJobRunInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEJobRunStatusType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEMultiMatchOptionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NENameInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NENameInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEQueryInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEQueryInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEQueryResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEQueryResultCriteriaType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1648
1648
1649
1649
1650
1650
1650
1651
1651
1652
1654
1654
1655
1656
1657
1657
1658
1658
1659
1659
1660
1660
1661
1661
1661
1662
1662
1663
1664
1664
1665
1665
1666
1666
1667
1667
Page 25 of 2268
Home
NEQueryResultList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NEQueryResultListOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NestedQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NillableStringArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NillableValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NodeListArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NodeList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NormalizeInstanceList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NullType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PauseREJobRun structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropertyFileFormat structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropertyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PullGraphWalkResultsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PullGraphWalkResults structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryArithOpType (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . . . .
QueryArithOpType (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryArithOpType (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjectRefsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjectRefs structure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjectsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjects structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPathInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPathOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPath structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPathXMLInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPathXML structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryCardinality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryCardinalityType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryDateQualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryDateSpan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryExecuteOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryInput2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1668
1668
1669
1669
1670
1670
1670
1671
1671
1672
1672
1673
1673
1674
1674
1675
1675
1676
1676
1677
1678
1678
1679
1679
1680
1681
1681
1682
1682
1683
1683
1684
1684
1684
1685
1686
Page 26 of 2268
Home
QueryInput3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryInput4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryInput5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryInputBasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryItemList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryJoinType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObject (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectRegular . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectRelationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectSelectorFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryObjectSelectorList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifier (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifier (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifier (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierAndOr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierBasic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpAnd (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpAnd (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpAnd (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpAndOr (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOperation (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOperation (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOperation (atrium_querybypath) . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpNot (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpNot (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpNot (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpOr (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpOr (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierOpOr (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierSetOp (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1686
1687
1687
1688
1688
1689
1689
1690
1690
1691
1692
1692
1692
1693
1693
1694
1694
1695
1696
1696
1697
1697
1698
1698
1698
1699
1699
1700
1700
1701
1701
1702
1702
1702
1703
1703
Page 27 of 2268
Home
QueryQualifierSetOp (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierSetOp (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierSetOpOperation (atrium_graphquery) . . . . . . . . . . . . . . . .
QueryQualifierSetOpOperation (atrium_query) . . . . . . . . . . . . . . . . . . . .
QueryQualifierSetOpOperation (atrium_querybypath) . . . . . . . . . . . . . . .
QueryQualifierSimpleOp (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . .
QueryQualifierSimpleOp (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierSimpleOp (atrium_querybypath) . . . . . . . . . . . . . . . . . . . .
QueryQualifierValue (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValue (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValue (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValueSetSel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValueSetTypeQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValueSetTypeValueSet . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryQualifierValueTypeArithExpr (atrium_graphquery) . . . . . . . . . . . . .
QueryQualifierValueTypeArithExpr (atrium_query) . . . . . . . . . . . . . . . . .
QueryQualifierValueTypeArithExpr (atrium_querybypath) . . . . . . . . . . . .
QueryQualifierValueTypeAttributeName (atrium_graphquery) . . . . . . . .
QueryQualifierValueTypeAttributeName (atrium_query) . . . . . . . . . . . . .
QueryQualifierValueTypeAttributeName (atrium_querybypath) . . . . . . . .
QueryQualifierValueTypeValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryRelationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryRelationshipList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryRelEndpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultGraph (atrium_graphquery) . . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultGraph (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultGraph (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . .
QueryResultList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QuerySort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QuerySortArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QuerySortOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Query structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RealLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRun . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1703
1704
1705
1705
1705
1706
1706
1707
1707
1708
1709
1709
1710
1710
1710
1711
1711
1712
1712
1713
1713
1714
1714
1715
1715
1716
1716
1717
1717
1717
1718
1718
1719
1719
1720
1720
Page 28 of 2268
Home
REJobRunEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRunEventList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRunInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRunInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRunList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJobRunStatusType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RelationshipDirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RelationshipResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RelationshipResultArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RelationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RenewGraphWalkOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RenewGraphWalk structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ResumeNEJobRunOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ResumeNEJobRun structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ResumeREJobRun structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedGraphQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryData (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryInfo (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryInfoList (atrium_querybypath) . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryParameterOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryParameterType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryParameterValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryQualifierSimpleOp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SavedQueryRefList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SchemaRelationshipDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SchemaType structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetAttribute structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetBusinessObjectOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetBusinessObject structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetClass structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1721
1722
1723
1724
1724
1724
1725
1725
1726
1726
1727
1727
1728
1728
1729
1730
1730
1731
1731
1732
1732
1733
1733
1734
1734
1734
1735
1735
1736
1736
1737
1737
1737
1738
1739
1740
Page 29 of 2268
Home
SetDataset structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetInstanceInfoIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetInstanceInfoInList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetInstance structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetMultipleBusinessObjectsOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetMultipleBusinessObjects structure . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetMultipleInstances structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetPropertiesOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetProperties structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SimpleExtensionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SortOrderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SortOrder structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SortOrderType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartNEJobRunOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartNEJobRun structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartREJobRun (classic reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . .
StartREJobRun (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartREJobRunOutput (classic reconciliation) . . . . . . . . . . . . . . . . . . . . .
StartREJobRunOutput (reconciliation) . . . . . . . . . . . . . . . . . . . . . . . . . . .
StatusList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StatusOutput structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StatusType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StringArray structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TimeLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TimeOfDayLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UIComponentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UIComponentResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UIComponentResultList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateSavedQuery structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ValueList structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Value structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VersionInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VersionInfoList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WeakPropagatedAttrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WeakPropagatedAttrsList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1740
1741
1742
1742
1743
1743
1744
1745
1745
1746
1746
1747
1747
1747
1748
1749
1749
1750
1750
1751
1751
1752
1753
1753
1754
1754
1754
1755
1756
1756
1757
1757
1758
1759
1759
1760
Page 30 of 2268
Home
WSPolicyMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WSPolicyMapEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XmlSchemaConstraintType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web Services API functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault message function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ActivateFederatedInContext function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BeginGraphWalk function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CancelNEJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CancelREJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDBf Query function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ConfigureCMDBf function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateBusinessObject function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateBusinessObject function (deprecated) . . . . . . . . . . . . . . . . . . . . . .
CreateClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateDataset function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateSavedQuery function (query_bypath) . . . . . . . . . . . . . . . . . . . . . .
CreateSavedQuery function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleBusinessObjects function . . . . . . . . . . . . . . . . . . . . . . . . .
CreateMultipleBusinessObjects function (deprecated) . . . . . . . . . . . . . .
CreateMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteBusinessObject function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteBusinessObject function (deprecated) . . . . . . . . . . . . . . . . . . . . . .
DeleteClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteDataset function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMultipleBusinessObjects function . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteMultipleBusinessObjects function (deprecated) . . . . . . . . . . . . . . .
DeleteMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteProperties function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeleteSavedQuery function (query_bypath) . . . . . . . . . . . . . . . . . . . . . .
DeleteSavedQuery function (atrium_graphquery) . . . . . . . . . . . . . . . . . .
DeleteSavedQuery function (atrium_query) . . . . . . . . . . . . . . . . . . . . . . .
EndGraphWalk function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1760
1760
1761
1761
1765
1766
1768
1770
1771
1773
1785
1786
1788
1790
1792
1794
1795
1797
1799
1800
1802
1804
1806
1807
1809
1811
1813
1814
1816
1818
1820
1821
1823
1825
1826
1828
Page 31 of 2268
Home
ExecuteSavedQuery function (query_bypath) . . . . . . . . . . . . . . . . . . . . .

ExecuteSavedQuery function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ExportNEConfiguration function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAttributes function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetAuditData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetBusinessObject function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetBusinessObjects function (deprecated) . . . . . . . . . . . . . . . . . . . . . . .
GetClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetCMDBfConfiguration function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetCopyAuditData function (atrium_audit) . . . . . . . . . . . . . . . . . . . . . . . .
GetCopyAuditData function (atrium_instances) . . . . . . . . . . . . . . . . . . . .
GetDataset function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetGraphWalkStatus function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetLastNEJobRunStatus function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetLogAuditData function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetMultipleBusinessObjects function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetMultipleBusinessObjects function (deprecated) . . . . . . . . . . . . . . . . .
GetNEJobRunStatus function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoList function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByFPKey function . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByName function . . . . . . . . . . . . . . . . . . . . . . . . .
GetNormalizedInfoListByPCKey function . . . . . . . . . . . . . . . . . . . . . . . . .
GetProperties function (service configuration) . . . . . . . . . . . . . . . . . . . . .
GetREJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEvent function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunEventList function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetREJobRunList function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedFederatedInContext function . . . . . . . . . . . . . . . . . . . . . . . . .
GetRelatedServices function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetSavedQuery function (query_bypath) . . . . . . . . . . . . . . . . . . . . . . . . .
GetSavedQuery function (atrium_graphquery) . . . . . . . . . . . . . . . . . . . .
GetSavedQuery function (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . . .
GetUIComponents function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GetVersions function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GraphQuery function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1829
1831
1833
1835
1836
1838
1840
1842
1844
1845
1847
1849
1851
1852
1855
1856
1858
1860
1862
1864
1866
1867
1869
1871
1873
1874
1876
1878
1879
1881
1883
1885
1886
1888
1890
1892
Page 32 of 2268
Home
ImportNEConfiguration function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListClasses function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListDatasets function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ListSavedQueries function (query_bypath) . . . . . . . . . . . . . . . . . . . . . . .
ListSavedQueries function (atrium_graphquery) . . . . . . . . . . . . . . . . . . .
ListSavedQueries function (atrium_query) . . . . . . . . . . . . . . . . . . . . . . . .
LoadDefaultCMDBfConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NormalizeInstanceList function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PauseREJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PropertyFileFormat function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PullGraphWalkResults function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjects function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObject function (deprecated) . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjectRefs function . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryBusinessObjectRefs function (deprecated) . . . . . . . . . . . . . . . . . .
QueryByPath function (query_bypath) . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPath function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryByPathXML function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RenewGraphWalk function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ResumeNEJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ResumeREJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetAttribute function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetBusinessObject function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetBusinessObject function (deprecated) . . . . . . . . . . . . . . . . . . . . . . . .
SetClass function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetDataset function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetInstance function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetMultipleBusinessObjects function . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetMultipleBusinessObjects function (deprecated) . . . . . . . . . . . . . . . . .
SetMultipleInstances function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SetProperties function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartNEJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StartREJobRun function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StatusOutput function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UpdateSavedQuery function (query_bypath) . . . . . . . . . . . . . . . . . . . . . .
UpdateSavedQuery function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
1894
1895
1897
1899
1901
1903
1904
1906
1907
1909
1910
1911
1913
1915
1917
1919
1921
1922
1924
1926
1927
1929
1931
1933
1935
1937
1939
1940
1942
1944
1946
1948
1949
1951
1953
1954
Page 33 of 2268
Home
Product Catalog web service API functions . . . . . . . . . . . . . . . . . . . . . . . . .

Associate_File_To_Product_WS function . . . . . . . . . . . . . . . . . . . . . . . .
Create_File_WS function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create_Product_WS function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Get_Product_Info_From_File_WS function . . . . . . . . . . . . . . . . . . . . . . .
Get_ProductKey_QueryList_Service function . . . . . . . . . . . . . . . . . . . . .
Get_ProductKey_QueryListFields_Service function . . . . . . . . . . . . . . . .
PD_QueryList_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PD_QueryListFields_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . .
PDP_QueryList_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PDP_QueryListFields_Service function . . . . . . . . . . . . . . . . . . . . . . . . . .
SignatureProductAssociation_WS function . . . . . . . . . . . . . . . . . . . . . . .
SLI_Modify_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SLI_Query_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SLI_QueryList_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SLI_QueryListFields_Service function . . . . . . . . . . . . . . . . . . . . . . . . . . .
SLI_Submit_Service function function . . . . . . . . . . . . . . . . . . . . . . . . . . .
Suite_Product_Association_WS function . . . . . . . . . . . . . . . . . . . . . . . . .
1955
1956
1958
1960
1964
1967
1971
1975
1976
1978
1980
1983
1984
1986
1988
1989
1991
1993
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working with logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Maintenance Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AR System server logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Normalization Engine logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Service Context logging . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Impact Simulator logging . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Integrator logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Integration Engine logging and debugging . . . . . . . . . . . . .
BMC Atrium CMDB logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Console server-side logging . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Console client-side logging . . . . . . . . . . . . . . . . . . . . .
Working with error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Model error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Integrator error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Federation plug-in error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Product Catalog error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Console active link error messages . . . . . . . . . . . . . .
1996
1997
1997
2003
2004
2005
2006
2007
2010
2019
2029
2030
2031
2032
2036
2039
2041
2045
BMC Atrium Core 9.0
Page 34 of 2268
Home
BMC Atrium CMDB C API error messages . . . . . . . . . . . . . . . . . . . . . . .

Reconciliation Engine error messages . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Console filter error messages . . . . . . . . . . . . . . . . . . .
BMC Atrium Service Context error messages . . . . . . . . . . . . . . . . . . . . .
Atrium Impact Simulator error messages . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Extension loader not responding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Other common extension loader issues . . . . . . . . . . . . . . . . . . . . . . . . . .
Other common installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Common uninstallation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Integration Engine installation issues . . . . . . . . . . . . . . . . . .
Product Catalog installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web Services installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium CMDB installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Integrator installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core upgrade issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium Integrator upgrade issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Issues that might arise during the CDMChecker pre-upgrade check . . . .
Issue that might arise during the Product Catalog Pre-upgrade check . .
Other BMC Atrium Core upgrade issues . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core configuration issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CMDB client managed transaction issues . . . . . . . . . . . . . . . . . . . . . . . .
Disabled Create button in the Product Catalog . . . . . . . . . . . . . . . . . . . .
Normalization plugin not working correctly . . . . . . . . . . . . . . . . . . . . . . . .
Dataset not configured correctly during normalization . . . . . . . . . . . . . . .
Normalization Engine initialization errors . . . . . . . . . . . . . . . . . . . . . . . . .
Troubleshooting BMC Atrium Service Context . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core Console and Atrium widget issues . . . . . . . . . . . . . . . . . .
Atrium widget issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Explorer issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Atrium widgets and the mid tier issues . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core console or widget error messages . . . . . . . . . . . . . . .
BMC Atrium Core plug-in issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Plug-in Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Plug-in Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BMC Atrium Core 9.0
2047
2065
2073
2076
2078
2080
2081
2082
2084
2085
2085
2086
2087
2088
2089
2091
2091
2091
2098
2100
2102
2102
2102
2103
2103
2104
2104
2105
2108
2108
2109
2110
2111
2112
2112
2113
Page 35 of 2268
Home
Advantages of centralized configuration . . . . . . . . . . . . . . . . . . . . . . . . . 2113

Troubleshooting plug-in issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2114
Atrium Impact Simulator plug-in troubleshooting . . . . . . . . . . . . . . . . . . . 2114
Deprecation plug-in troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2117
Notification plug-in troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2119
Normalization Engine plug-in troubleshooting . . . . . . . . . . . . . . . . . . . . . 2122
Event Engine plug-in troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . 2125
Service Context plug-in troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . 2128
Unified Service Modeling plug-in troubleshooting . . . . . . . . . . . . . . . . . . 2129
Dynamic Service Modeling plug-in troubleshooting . . . . . . . . . . . . . . . . . 2131
Updating plug-in configuration settings . . . . . . . . . . . . . . . . . . . . . . . . . . 2133
BMC Atrium Core miscellaneous issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2135
Data decompression issue in cmdbdriver . . . . . . . . . . . . . . . . . . . . . . . . 2136
Data Visualization Form module issue . . . . . . . . . . . . . . . . . . . . . . . . . . . 2136
Verifying version information for BMC Atrium CMDB components . . . . . 2136
Web services startup issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2138
BMC Atrium CMDB permission issues . . . . . . . . . . . . . . . . . . . . . . . . . . . 2138
Business service CIs not available in the Service Catalog issue . . . . . . . 2139
Auditing issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2139
Class form generation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2140
Atrium Impact Simulator permissions issue . . . . . . . . . . . . . . . . . . . . . . . 2142
Federation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2142
Troubleshooting Data load or Performance Issue in Atrium Core . . . . . . 2145
Handling problems in viewing CMDB Dashboard . . . . . . . . . . . . . . . . . . 2147
BMC Atrium Integration Engine issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2147
BMC Atrium Integration Engine data exchange issues . . . . . . . . . . . . . . 2147
BMC Atrium Integration Engine data exchange errors . . . . . . . . . . . . . . . 2149
Server groups incorrectly used when triggering data exchanges . . . . . . . 2151
Troubleshooting Run Now, Verify, or Test Connection buttons not responding
2151
Troubleshooting data mapping issues in BMC Atrium Integration Engine 2152
BMC Atrium Integration Engine service issues . . . . . . . . . . . . . . . . . . . . 2153
SQL adapter not working in UNIX or Linux environment with BMC Atrium
Integration Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2155
Instance management issues in BMC Atrium Integration Engine . . . . . . 2155
Rule Helper does not populate views and tables . . . . . . . . . . . . . . . . . . . 2158
BMC Atrium Core 9.0
Page 36 of 2268
Home
BMC Atrium Integration Engine RPC port error . . . . . . . . . . . . . . . . . . . . 2159

Displaying new attributes in the Data Field Mapping in BMC Atrium Integration
Engine window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2159
Data exchanges not running correctly in BMC Atrium Integration Engine 2160
Atrium Integrator issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2160
Atrium Integrator errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2161
Atrium Integrator console issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2162
Atrium Integrator Spoon issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2167
Atrium Integrator data exchange migration issues . . . . . . . . . . . . . . . . . . 2170
Atrium Integrator migrated jobs issues . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
Data model issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2178
Verifying your data model manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2178
Verifying your data model using the cmdbdiag program . . . . . . . . . . . . . 2179
Cleaning up CMDB data by using the CI and Relationship Correction Tool
option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2181
Troubleshooting a failed data model change . . . . . . . . . . . . . . . . . . . . . . 2187
Reconciliation Engine issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2188
Reconciliation Engine startup issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2188
Reconciliation Engine configuration issues . . . . . . . . . . . . . . . . . . . . . . . 2188
Reconciliation Engine job issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2189
Reconciliation Engine unidentified instances issue . . . . . . . . . . . . . . . . . 2194
Reconciliation Engine logging issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2195
Reconciliation Engine multiple CI match issues . . . . . . . . . . . . . . . . . . . . 2198
Reconciliation Engine merge activity issues . . . . . . . . . . . . . . . . . . . . . . 2202
Reconciliation performance issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2203
Drift Management issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2205
Installation logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2205
Automatic incident creation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
Investigating CMDB Data Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2209
Symptoms which indicate a CMDB Data or Reconciliation Issue . . . . . . 2209
Tools for investigating CMDB data issues . . . . . . . . . . . . . . . . . . . . . . . . 2209
Recommended sequence to investigate CMDB data issues . . . . . . . . . . 2210
Database queries for evaluating CMDB data distribution . . . . . . . . . . . . 2210
Investigating issues with duplicate data in CMDB . . . . . . . . . . . . . . . . . . 2212
Removing duplicate computer systems from the CMDB . . . . . . . . . . . . . 2214
Modifying reconciliation identification rules to avoid duplicates . . . . . . . . 2217
BMC Atrium Core 9.0
Page 37 of 2268
Home
Using CMDB Data Analyzer to Investigate CMDB Data Issues . . . . . . . .

CMDB Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of out-of-the-box Indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Steps to add missing indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2220
2227
2227
2227
Support information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contacting Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Support status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
End of life for BMC Atrium Integration Engine . . . . . . . . . . . . . . . . . . . . . . . .
2229
2229
2229
2229
Additional resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2231
BMC Atrium Core 9.0
Page 38 of 2268
Home
This space contains information about the BMC Atrium Core 9.0 release, including service packs
and patches.
The following topics will help you begin:
What's new
Featured content
Where to start
About BMC Atrium Core
PDFs and videos |
BMC Atrium Core 9.0
Help
Page 39 of 2268
Home
Recently Updated
Known and corrected issues26 minutes ago updated by Mandaar Painarkar view change
Issues table37 minutes ago updated by Mandaar Painarkar view change
Homeabout 4 hours ago updated by Mandaar Painarkar view change
Show More
Please wait
Announcement, August 27, 2015

Service Pack 1 of BMC Atrium Core, is available
For summary of all the announcements, see Release notes and notices.
BMC Atrium Core 9.0
Page 40 of 2268
Home
What's new
BMC Atrium Core 9.0 is available with the following new features:
Implementation of BMC Atrium Core dashboard
Implementation of Denormalized CMDB Data Storage (DCDS)
Note: DCDS is also referred to as CDM Denormalization.
Preconfigured integrations for ADDM and SCCM
Implementation of RESTful APIs
Implementation of dataset configuration console to manage dataset level permissions
Managing configuration logs from a centralized location
For the details of all new features, see 9.0.00 enhancements.
The following interactive graphic summarizes enhancements made in version 9.0 of the BMC
Atrium Core CMDB. (The graphic may take a few seconds to load.)
BMC Atrium Core 9.0
Page 41 of 2268
Home
Featured content
For information about the issues in this release, see Known and corrected issues.
To plan for an installation or upgrade, see Planning.
To learn about installing or upgrading BMC Atrium Core, see BMC Remedy ITSM 9.0
Deployment
To locate content in the online documentation that was previously provided in PDF format,
see BMC Atrium Core online documentation
BMC Atrium Integration Engine is reaching its End of Life, and will not be included in BMC
Atrium Core after version 8.1. For more information, see Product announcements
BMC Atrium Core 9.0
Page 42 of 2268
Home
Where to start
End users: Using, Working with CIs and relationships, Finding BMC Atrium CMDB data, Use
case.
Administrators: Planning, Configuring, Managing Access, Configuring BMC Atrium Core
components, Importing data, Normalizing data, Reconciling data, Modeling data and impacts
, Managing datasets, Managing federated data, Managing extenstions.
Application programmers: Integrating
BMC Atrium Core 9.0
Page 43 of 2268
Home
About BMC Atrium Core

The BMC Atrium Core solution works with other BMC Atrium solutions to facilitate the alignment of
your IT organization with business priorities. BMC Atrium Core provides tight integration across
management tools used in your IT environment, saving your IT organization time and money. BMC
Atrium Core includes the following component products:
BMC Atrium Configuration Management Database (BMC Atrium CMDB), which stores
information about the configuration items (CIs) in your IT environment and the relationships
between them
BMC Atrium Integrator, which transfers data between an external datastore and BMC Atrium
CMDB
BMC Atrium Core 9.0
Page 44 of 2268
Home
Release notes and notices

This section provides information about what is new or changed in this space, including urgent
issues, documentation updates, service packs, and patches.
Tip
To stay informed of changes to this space, place a watch on this page.
Date
Title
Summary
August 27,
2015
9.0.01: Service Pack 1
With Service Pack 1, BMC Atrium Core 9.0 has been enhanced with the following
new features and changes
Updates in Service Pack 1
Downloading the installation files
Installing BMC Atrium Core 9.0.01
June 19,
2015
9.0.00.001: Patch 1 for

version 9.0.00
Patch 1 for BMC Atrium Core 9.0.00.
April 30,
9.0.00 enhancements
With 9.0, BMC Atrium Core has been enhanced with the following new features and
2015
changes.
Denormalized CMDB Data Storage (DCDS)
BMC Atrium CMDB and BMC Atrium Discovery and Dependency Mapping
tool integration
New Dataset Configuration console to configure and manage datasets
Logging configurations managed from Central Configuration System (CCS).
REST API support for BMC Atrium CMDB
BMC Atrium CMDB and Microsoft SCCM integration
Tip
Ready-made PDFs are available on the PDFs page. You can also create a custom PDF.
Click here to see the steps.
BMC Atrium Core 9.0
Page 45 of 2268
Home
1. From the Tools menu, select Export to PDF.

PDF export
The Export to PDF menu is displayed with preconfigured export settings.

Export to PDF menu
2. Perform one of the following steps:

Choose an export setting and click Start Export. (The recommended setting
for most exports is Branch (this page and its children).) You will be
prompted to download your completed PDF when the export process is
completed.
Choose Customize Settings and continue to follow these steps if you want
to perform advanced PDF customization.
BMC Atrium Core 9.0
Page 46 of 2268
Home
3. Select a template (for example, BMC Standard).

Templates with the designation (with child pages) export the current topic
and all child topics in that branch. If you are on the Home page, you will
export all topics in that space.
For best results, export using a BMC Standard template. Others are not
optimized for docs.bmc.com content.
4. If you want to customize your PDF export, choose Customize Settings.
To restrict your export to pages with a certain label, select This page and
all children with label and enter the desired labels to add (or exclude) in
the General tab.
To add a title and other information to the exported PDF, change the
settings in the PDF Properties tab.
To change how some dynamic content is exported, change the settings in
the Content Processing tab:
TOC macros includes a Table of Contents that list headings in longer
topics.
Children macros includes a list of links to child topics on some
top-level topics.
Export images as original resolution expands the images that are
shown in a small size in a topic.
To automatically generate full URLs after links (useful if you will print the
PDF), check the appropriate check boxes in the Linking tab. Note that links
containing long URLs may cause formatting issues with some tables if this
option is selected.
5. Click Start Export to begin the export process.
Your last export settings will be remembered and you will be able to create another export
with those settings without having to reconfigure your PDF.
Related topics
Known and corrected issues
Downloading installation files
in BMC Remedy ITSM Deployment documentation.
Support information

Use this section to:
Learn about the issues that are corrected in the 9.0 release and in its subsequent service
packs and patches.
BMC Atrium Core 9.0
Page 47 of 2268
Home
Look for open issues and workarounds to known problems before contacting Support.
For known and corrected issues related to installation and upgrades, see Platform (AR
System and CMDB) installation and upgrade known and corrected issues
Tip
The known and corrected issues table includes the Component, Issue, Description,
Affected versions, and Corrected in columns. If you cannot view all the columns, click
the
icon on the top-right corner of the page to open it in the full screen mode.
Alternatively, use the scroll bar at the bottom of the table.
The following issues pertain to this release of BMC Atrium Core and its patches. To locate known
and corrected issues, perform any of the following actions:
Select an option from the Corrected in list to filter the table by version number. An issue
with no version number listed here remains open. A workaround is provided, if available.
Select an option from the Category list to filter the table by a specific component, such as
Normalization Engine or Atrium Core.
Type a character string in one or more of the boxes to filter the list of defects.
Click any column heading to sort this table or change sort direction.
Component
Issue
Description
Atrium Core
UI
SW00487238
CMDB Administration link (Atrium Core > CMDB Administration on the Applications flyout menu) is not visible for users having
Datasets
SW00487862
On the Dataset Configuration Console, the dataset type for Overlay datasets is displayed as Regular.
Atrium Impact
Simulator
SW00488414
The simulation results for weighted clusters show incorrect status values.
USM Plugin
SW00488400
You cannot enable the USM plugin to send request to BMC Remedy AR System and BMC Atrium CMDB on private queue.
You can modify userDefined configuration in the pluginsvr_config.xml file. Add a private_rpc_socket item with either 390698 o
the configuration changes.
Data
Management
SW00487837
If the AR Server Submitter mode is locked and a new user tries to update Site data using ITSM Data Management tool, the da
CMDB
Engine
SW00490872
When you delete an already registered TSCO instance from BMC.CORE.CONFIG class, the following error message is displa
"No DataSet Found"
Atrium Core
CMDB
SW00490938
The CDM Denormalization utility stops working when you click the OK button on the error message window.
For more details, see Performing denormalization of Common Data Model
BMC Atrium Core 9.0
Page 48 of 2268
Home
Component
Issue
Description
CMDB
Dashboard
console
SW00482192
CMDB dashboard does not load and the following error message is displayed:
"Blocked loading mixed active content"

Workaround
This issue arises because Tomcat is running in HTTP mode only, and thus failing to send requests in HTTPS mode. Do the fo
1. Open the server.xml from the location - <AR Installation Path>\SmartReporting\appserver\conf\server.xml.
For example: C:\Program Files\BMC Software\ARSystem\SmartReporting\appserver\conf\server.xml
2. In the HTTP Connector, modify the configurations for scheme and proxyPort attributes as follows.
<Connector
port="8080"
protocol="HTTP/1.1"
connectionTimeout="20000"
proxyPort="443"
scheme="https"
disableUploadTimeout="true"/>
Atrium Impact
Simulator
SW00488414
Impact simulation for weighted clusters shows incorrect status values in the simulation results.
Normalization
Engine
SW00477462
A tab to modify the Normalization Engine plugin does not open directly when you open Plugin Server Configuration from the N
Workaround:
Refer to the steps detailed here.
Datasets
SW00476429
You are not able to modify the Accessibility field for a dataset on the Dataset Configuration console.
Workaround: Use the following procedure to modify the Accessibility field.
1. Open the BMC.CORE.CONFIG:BMC_Dataset form using the mid tier .
2. Search for the required dataset.
3. Modify the value in the Accessibility list
4. Click Save.
Datasets
SW00479602
Users with CMDB Console User Group permissions can open the Dataset Configuration UI. Ideally only Atrium Administrato
Atrium Core
CMDB
SW00486095
CMDB Server does not delete the index on the class when the attribute is deleted which is the only attribute on which index w
Workaround:
Remove the index first and then delete the attribute.
CMDB
Dashboard
console
SW00486844
The following details under the CIs by Type category are not displayed correctly on the BMC Atrium CMDB dashboard conso
The topmost and bottom-most class names cropped out.
One of the areas in the pie-chart does not display any class name and instead appears blank. This happens because C
BMC Atrium Core 9.0
Page 49 of 2268
Home
Component
Issue
Description
Atrium Core
CMDB
SW00487180
When you are using BMC Remedy AR System 9.0 and BMC Atrium Core 9.0 (with BMC Remedy ITSM not upgraded to 9.0),
displayed.
Workaround:
To access the Help for each product component, navigate to the respective product UI and click Help.
Service
Context
SW00481698
In Service Context, Data Loading Test shows Read Time Out error under HTTP Secure protocol. This might cause Service Co
Workaround:
Add an entry in the hosts file to map the host name IP of mid tier to the tenant name.
For example,
<Host name IP> <Tenant Name>
Drift
SW00485051
When you click Help link on the Drift Management console, the following error message is displayed:
Management
No items matches active link condition.
Workaround:
Use the following link to access Drift Management online help documentation:
https://docs.bmc.com/docs/display/public/ac9000/BMC+Configuration+Drift+Management
Normalization
Engine
SW00485071
Normalization engine simulation tool does not function correctly.

Workaround:
1. Locate NESIM.cmd file on the computer where you have installed BMC Atrium Core
2. Replace the JAVA_HOME and ATRIUM_HOME variables with the hard coded values given in the NESIM.CMD file
3. Validate the directory paths for Normalization Engine and CMDB
4. Run the following command:
nesim.cmd <Host Name> <Port> <user> <password> <Dataset> <chunk size>
Note: Set password as 0 if it is blank.
Atrium Core
SW00221073
When you are adding a Currency attribute to a class, you cannot specify Allowable Currency Types for it.
SW00441568
A user belonging to CMDB RE USER Group is unable to see reconciliation jobs.
CMDB
Reconciliation
Engine
Workaround: The user should belong to both the groups CMDB RE USER Group as well as CMDB RE USER.
Reconciliation
Engine
SW00431801
For the Reconciliation Engine, the standard jobs fail to execute after execution of a Rename job for the dataset for which the s
Workaround: After executing a rename dataset job, you must modify the dataset name in all job definitions where it is referen
BMC Atrium Core 9.0
Page 50 of 2268
Home
Component
Issue
Description
Service
Context
NA
Attributes on the Service Context Administration form are not visible.

Workaround: To troubleshoot:
1. From the ServiceContext.Log file, verify if the web service adapters attributes are added into the Service Context feat
2. If the attributes are not added to the Service Context feature, it indicates that the Atrium plug-in was unable to connect
3. Restart the AR System server and the BMC Remedy Mid Tier.
4. When you restart the AR System server, the Atrium Service Context plug-in is triggered to collect the attributes of the w
Service
NA
The related records of an incident request are not visible in the Summary Viewer.
Context
Workaround: To troubleshoot:
1. In the ServiceContext.Log file, search for records related to the attribute.
2. In the Tomcat Log file std_out.log file, verify errors in interaction between the webservices adapters and the Web Se
3. The Service Context plug-in collects records from the web services adapters and stores these records in a cache. This
in Summary Viewer.
Atrium
Integrator
SW00487839
BMC Atrium Integrator entry is not available on the AR System Server Group Operation Ranking form.
Workaround:
Manually add the Atrium Integrator entry for server group in AR System Server Group Operation Ranking form and then resta
Atrium
Integrator
SW00485877
Some attributes were moved from CMDB to AST:Attribute form, as part of ITSM install/upgrade process from 8.0 and beyond.
ITSM and now reside as fields in the AST:Attributes form. For a list of these fields please refer to https://docs.bmc.com/docs/d
If there are any existing AI, NE or RE jobs referring to "these specific" fields/attributes, these jobs will fail since these
Workaround:
If there are any existing Atrium Integrator, Normalization Engine, or Reconciliation Engine jobs referring to these specific fields
Model.
Drift
Management
SW00486058
Drift Management 8.1 SP1 is not compatible with BMC Atrium Core CMDB 9.0 and gives the following error:
java.lang.NoClassDefFoundError: sun/io/CharToByteConverter
Workaround:
Download the hotifix and apply the SW00486058 Hotfix.
Download the SW00486058 Hotfix and follow the instructions given in the Readme text file.
Drift
Management
SW00483056
Comparison Job with Incident template fails to execute.

Workaround:
Download the SW00483056 Hotfix and follow the instructions given in the Readme text file.
Drift
Management
SW00276393
BMC Atrium Core 9.0
When searching for all CIs in the target dataset and comparing them against the baseline, the Drift Master sees CIs drifted for
Drift Master should have access only to CIs from the target and compared with the baseline.
Page 51 of 2268
Home
Component
Issue
Description
Drift
Management
SW00276938
When creating an Incident Management Request during the running of a comparison job, if more than 1000 CIs (detected drif
database update.
Workaround:
There is no technical workaround, as BMC does not recommend you change the timeout during database update value.
Just be aware, when creating a comparison job in which you are using the Incident Management Request option, to keep the
Drift
Management
SW00463189
In Drift Management, when you select Mark As Deleted field as Yes for CIs and run the compare job, the CIs are not remove
Normalization
Engine
SW00428849
When you update Suite Rollup Rule, the Market Version field is reset to blank in the Update Suite Rollup window.
Product
Catalog
SW00305649
In the Product Catalog, the Atrium Foundation Viewer permission is not fully functional.
Product
Catalog
SW00383367
If you are displaying the Manage Products Console in the Product Catalog with the 7.1.00 or 7.5.00 versions of BMC Remedy
Details button
Product
Catalog
SW00423207
In the Product Catalog Setup form if you set the Product flags Approved to Yes for Product Company Association Records, th
Association Record.
Product
Catalog
SW00426919
When you log on to mid-tier as PCViewer user with Atrium Foundation viewer and General access permissions, on Manage P
button is disabled.
Product
Catalog
SW00426176
Delete version association with CMDB action, does not get applied to a patch.
SW00428793
Reconciliation
Engine
SW00440859
In the Precedence Set window, in the Show Classes and Attributes with Precedence field, ensure that you type the search
Reconciliation
Engine
SW00465196
In the Reconciliation Engine, when you select the Disable Progress bar option and run the job, the Reconciliation Engine UI
Atrium
Integrator
SW00463436
Atrium Integrator fails to connect to the LDAP host and displays the following error:
Error trying to connect to LDAP host.Exception : dcjnprussac1:636; socket closed.
CMDB
Engine
SW00493631
When the Always On Logging is enabled, the CPU cycle utilization is increased, which impacts the performance of CMDB Eng
Workaround
To disable the Always On Logging feature, configure the buffer size to 0 MB.
Atrium
Integrator
SW00493821
Chrome does not support default enabling of the NPAPI plugins. As a result, you cannot launch spoon from Atrium Integrator
Workaround
In order to launch spoon from Atrium Integrator Console, you should use either the combination of 32 bit Internet Explorer or M
client JRE.
BMC Atrium Core 9.0
Page 52 of 2268
Home
Component
Issue
Description
Atrium Core
CMDB
SW00491366
If a database entry is not found for that job, the carte server fails the job. Functionality of handling database failover and retry
Workaround
Restart the job.
Atrium Core
CMDB
SW00493094
Midtier 9.0 GA with Java 7 does not open Atrium Core Console of 9.0 SP1. As a result the Java files compiled with Java 1.8 w
WorkAround
Install Java 1.8
Atrium Core
CMDB
SW00492811
Following error occurs during 9.0 RTM to 9.0 SP1 upgrade

java.lang.NoClassDefFoundError:com/bmc/cmdb/domain/collection/ChunkedItemCacheCollection
Tue Jul 21 08:11:46.591 2015
at com.bmc.cmdb.cache.jboss.ChunkedItemCacheImpl.getAllCa
Tue Jul 21 08:11:46.591 2015
at com.bmc.cmdb.server.service.async.impl.ChunkedItemClea
Tue Jul 21 08:11:46.592 2015
at com.bmc.cmdb.server.service.async.impl.ChunkedItemClea
Tue Jul 21 08:11:46.592 2015
at java.util.TimerThread.mainLoop(Unknown Source)
Tue Jul 21 08:11:46.592 2015
at java.util.TimerThread.run(Unknown Source)
Tue Jul 21 08:11:46.593 2015 Caused by: java.lang.ClassNotFoundException: com.bmc.cmdb.domain
Atrium Core
SW00490271
CMDB
Tue Jul 21 08:11:46.595 2015
at org.eclipse.osgi.internal.loader.BundleLoader.findClas
Tue Jul 21 08:11:46.597 2015
Tue Jul 21 08:11:46.598 2015
Tue Jul 21 08:11:46.598 2015
at org.eclipse.osgi.internal.baseadaptor.DefaultClassLoad
Tue Jul 21 08:11:46.600 2015
at java.lang.ClassLoader.loadClass(Unknown Source
One of the cause of this issue is that the same standard job created earlier was failed and due to which orphan entries get cre
rule gets updated, the job failed with unique index violation error due to existence of previous orphan entries and UI shows err
Rules". Possible cause of Orphan Entries: 1. Due to AR timeout issue 2. Due to abnormal conditions like AR server terminatio
By default AUI logs are disabled, hence to find root cause of this issue, need to enable AUI logs from mid-tier and based on th
Atrium Core
SW00492951
Create class fails when "Attachment Pool" is created with default option being "Optional".
CMDB
Workaround
While adding new or update old attribute for the class, For data type "Attachment pool", select the "Display only" option for the
Atrium Core
CMDB
SW00493479
While DA [read Data Analyzer] UI is ON, if user deletes the "Reports" folder from its installation directory, then execution of an
Workaround
Close the Data Analyzer and re-launch it. Doing this, all the necessary directories are re-created and then job execution will b
BMC Atrium Core 9.0
Page 53 of 2268
Home
Component
Issue
Description
Atrium Core
CMDB
SW00493682
The Healthchecker.cmd file refers to the wrong path for 9.0 SP1 jars.
Workaround
1.
2.
3.
4.
Atrium Core
CMDB
SW00492583
Open healthchecker.cmd/.sh file.

Search for 001 and change it to 002.
Save the cmd/sh file.
Run the utility.
When you create an attributes of type Date, TimeOfDay and Time, CMDB Server returns the default value incorrectly.
Workaround
Create the attribute of type Date, TimeOfDay and Time through CMDB driver or API.
For example
Create attribute using CMDB Driver for Date datatype where the default value is Date Value () [YYYY-MM-DD]: 2015-06-01
The value that is returned is Default Value: (date) 2015-06-01
Atrium Core
CMDB
SW00494055
When you access CMDB Dashboard for the first time after install or upgrade, the Reporting Console main page is displayed in
Workaround
Refresh your page or re-launch Atrium Core Console.
BMC Atrium Core 9.0
Page 54 of 2268
Home
Component
Issue
Description
Atrium Core
CMDB
SW00494528
CMDB installer removes configuration parameters from the ar.cfg file during 9.0 to 9.0SP1 upgrade
Workaround
Add the following CMDB parameters in ar.cfg CMDB Parameter list:
CMDB-Cache-Refresh-Initial-Delay: 900000
CMDB-Cache-Refresh-Interval: 300000
CMDB-ChunkedItem-Allowed-Period-In-Cache: 3600000
CMDB-Log-File-Location: D:\BMCSoftware\BMCARSystem\ARServer\Db
CMDB-Log-File-Name: cmdb_eng_debug_log.log
CMDB-Impact-Weight-Default: 0
CMDB-ChunkedItem-Cleanup-Initial-Delay: 900000
CMDB-Max-Log-File-Size: 250
CMDB-Log-Per-Thread: 0
CMDB-CIViewer-Graph-Limit: 0
CMDB-Hard-Delete-Only-If-Marked-For-Delete: F
CMDB-ChunkedItem-Cleanup-Interval: 300000
Event-Channel-Enabled: F
CMDB-Logging-Level: WARN
CMDB-GQRecursion-Limit: 0
CMDB-Max-Results-Per-Query: 0
CMDB-Number-Of-Backup-Files: 10
You must restart the AR server after you add these parameters in the ar.cfg file.
Atrium Core
CMDB
SW00494425
If you are using Midtier 9.0 Sp1 with AR+Atrium 7604SP2, Midtier does not open Atrium Core Console.
Workaround
Apply the Atrium UI hotfix for 7604SP2; Users who have installed setup 7604 SP2 GA but have not applied Atrium UI hotfix af
Drift
Management
SW00491999
If you are trying to install Drift Management of 8.1 SP2 on Windows 2012 and Windows 2012 R2, the installer considers the W
Workaround:
Change the compatiblity mode to Windows XP Service Pack 2
9.0.01: Service Pack 1

This table provides information about fixes and updates in this service pack, and provides
instructions for downloading and installing the service pack.
BMC Atrium Core 9.0
Page 55 of 2268
Home
Updates in Service Pack 1
To learn about new features added to BMC Atrium Core in Service Pack 1, see Enhancements.
For information about issues corrected in this service pack, see Known and corrected issues.
Downloading the service

pack
For download instructions, see Downloading the installation files.
Installing the service pack
For information about installing the Service Pack 1, see Installing BMC Atrium Core 9.0.01.
Enhancements
Service Pack 1 provides enhancements in the following BMC Atrium Core applications and
components:
BMC Atrium CMDB prechecker updates
Introducing the CMDB data analyser tool
Normalization Failover Mechanism for Scheduled Batch Jobs
Always on Logging
Data Archiving
BMC Atrium CMDB prechecker updates

The following enhancements are made to the data model components:
The attributes list (OSType, SystemType, ProcessorFamily) is constantly updated. To
accommodate a selection type value, customers may use a custom ID value. This ID value may
conflict with the BMC defined ID value for that selection type. To prevent ID conflicts among
selection values, BMC has reserved a range of enum IDs from 0 to 10,000. New enum values must
be added using ID values starting from 10,001. A warning message is displayed if customers
choose an ID from the reserved set.
A pre-upgrade check has also been added to detect and handle customizations to the selection
type attributes. For more information on the new pre-upgrade check and how it handles duplicate
customizations, if any, see CMDB - Enum Attribute Customization Check .
Introducing the CMDB data analyser tool

You can now get statistics about certain important details related to BMC Atrium Configuration
Management Database (CMDB) data and Configuration Items (CIs) by using the newly
implemented CMDB Data Analyzer. This information will help you detect the root cause in some
cases such as the multimatch error. The CMDB Data Analyzer generates reports that inform the
state of CIs present in BMC Atrium CMDB and help you tune the CMDB better using the results
from the reports.
For more information, see Using CMDB Data Analyzer to Investigate CMDB Data Issues .
BMC Atrium Core 9.0
Page 56 of 2268
Home
Normalization Failover Mechanism for Scheduled Batch Jobs

With this implementation, now you can utilize the failover mechanism for Normalization Engine
batch Jobs. This mechanism allows ranking the Normalization Engines in a server group, where the
highest ranked Normalization Engine runs the job, and if a Normalization Engine that is running the
jobs stops functioning, the jobs are scheduled to run on the next highest ranked Normalization
Engine. Also you can schedule the jobs on any Normalization Engine in the group.
For more information, see Normalization Failover - Scheduled Batch Jobs.
Always on Logging
You can now utilize the Always On Logging feature that captures CMDB operations along with
other operations. The Always On Logging feature allows capturing the logs by saving the logs to a
file when an error occurs or by specifying AR error codes for which the logs should be captured.
For more information, see Configuring BMC Atrium CMDB Engine Logging .
Data Archiving
BMC Atrium CMDB now implements data archiving, eliminating the need to go back and search
data from historical perspective. Now the retained history can be access to perform any
investigative tasks. The data archiving runs every 24 hours where the settings are configurable.
For more information, see Configuring Data Archiving.
9.0.00.001: Patch 1 for version 9.0.00

For the latest installation information, see Installing BMC Atrium Core 9.0.00.001
For more information about issues corrected in this patch, see Known and corrected issues.
9.0.00 enhancements
Tip
For information about issues corrected in this release, see Known and corrected issues.
This section contains information about enhancements in version 9.0.00 of BMC Atrium Core
product.
Separate online documentation for installation and upgrade information
New CMDB Dashboard that provides key metrics about the CMDB and CIs
Improved performance by use of Denormalized CMDB Data Storage
Reduced time to value due to the preconfigured integration of BMC Atrium Discovery and
Dependency Mapping
BMC Atrium Core 9.0
Page 57 of 2268
Home
Reduced time and expense of integration with preconfigured integration of Microsoft System
Center Configuration Manager
New dataset-level permissions
Central management of configuration logs in a server group environment
Configuring BMC Atrium CMDB Engine
Introduction of RESTful API to simplify integrations between platforms
Version 9.0.00 is released after version 8.1.00, which is a major release that contain significant
enhancements. If you are considering an upgrade from a version prior to 9.0, or considering to
fresh install BMC Atrium CMDB to you might be interested in seeing the following enhancements:
Separate online documentation for installation and upgrade

information
Starting with the 9.0.00 release, the installation and upgrade information of BMC Atrium Core is
available through the new BMC Remedy ITSM Suite 9.0 Deployment online documentation.
The BMC Remedy ITSM Suite 9.0 Deployment online documentation contains consolidated
information of installation and upgrade procedures for all the components in the BMC Remedy IT
Service Management (ITSM) Suite. This online documentation categorizes the components as:
Platform components: BMC Remedy Action Request (AR) System components and BMC
Atrium Core components
Application components: BMC Remedy ITSM core components, BMC Service Request
Management, BMC Service Level Management, and BMC Remedy ITSM Process Designer
The installation and upgrade information for BMC Atrium Core is no longer available in the BMC
Atrium Core online documentation.
Continue to refer to the BMC Atrium Core online documentation for information about configuring
after installation.
New CMDB Dashboard that provides key metrics about the

CMDB and CIs
You can now get at-a-glance statistics about important details related to BMC Atrium Configuration
Management Database (CMDB) activity and Configuration Items (CIs) by using the newly
implemented BMC Atrium CMDB dashboard. This information will help you understand current and
historical CI data that is indicative of the health of BMC Atrium CMDB. The BMC Atrium CMDB
dashboard displays the number of CIs present in BMC Atrium CMDB and the number of CIs
created periodically, among other matrices.
For more information, see Accessing BMC Atrium CMDB Dashboard .
BMC Atrium Core 9.0
Page 58 of 2268
Home
Improved performance by use of Denormalized CMDB Data

Storage
When you use categorization subclasses, insert and update calls are reduced when you create
instances, resulting in a significant improvement in the performance of BMC Atrium CMDB.
Denormalization also improves reconciliation performance during the loading of data into BMC
Atrium CMDB.
The Common Data Model is denormalized such that the following classes and relationships are
converted to categorization subclasses:
BMC_LogicalSystemComponent class
BMC_Product
BMC_Component
In addition, you can add a categorization subclass as a child of an abstract class.
For more information, see Denormalized CMDB Data Storage.
Reduced time to value due to the preconfigured integration of

BMC Atrium Discovery and Dependency Mapping
Note
For this release, the Atrium Discovery and Dependency Mapping (ADDM) tool integration
with BMC Atrium CMDB enhancement is available only with fresh installations and not
with upgrades.
As part of a fresh installation, BMC Atrium CMDB is available with a preconfigured integration with
BMC Atrium Discovery and Dependency Mapping. The following tasks are performed automatically
with this new integration feature:
Creation of the BMC.ADDM dataset
Creation of a Reconciliation job that consists of the following activities:
Identify
Merge
Purge
For more information, see BMC Atrium CMDB and BMC Atrium Discovery and Dependency
Mapping Integration.
BMC Atrium Core 9.0
Page 59 of 2268
Home
Click here
to download the ADDM integration package for Windows and Linux operating
systems.
Reduced time and expense of integration with preconfigured

integration of Microsoft System Center Configuration Manager
BMC Atrium CMDB is available integrated with Microsoft System Center Configuration Manager (
SCCM), thereby eliminating need for manual configuration and hence the errors. SCCM integration
is available as an open source offering that enables you to quickly start using it. The integration
package gives you the flexibility to choose when to begin discovering the hardware and software
configuration information. SCCM discovered data is thus effectively copied into BMC Atrium CMDB
and is readily available for consumption to Remedy ITSM applications, BPPM Suite or any other
Atrium CMDB consuming application.
SCCM integration package is available as a separate installer. You only need to download and
install it. The integration of SCCM with BMC Atrium CMDB is done automatically. Click here
to
download the SCCM integration package for Windows and Linux operating systems.
The key highlights of this integration package are as follows:
Saves cost and time: Eliminates the need to develop customized integration that needs
about 4 to 6 weeks.
Prepackaged integration best practices eliminates errors.
Imports CIs as well as Relationship data from Microsoft SCCM.
Includes pre-defined mappings between SCCM tables and CMDB classes/relationships. You
can configure these mappings as per your requirement.
Includes pre-configured CMDB dataset, Reconciliation rules, Normalization rules. This offers
end-to-end scenario for loading data into Atrium CMDB from Microsoft SCCM, thereby
eliminating any possibilities of errors.
Notes
Before you begin SCCM integration in AR, ensure that CMDB 9.0 and Atrium
Integrator are installed.
When using this integration package for continuous job type in Normalization,
ensure that the source dataset has the values for CTI, Model, and Manufacturer
details. Also ensure that in Atrium Integrator mapping, you map the source data
with Model and Manufacturer details.
To launch SCCM 2.0 on Windows 2012 operating system, you must first change
the compatibility mode to Windows XP.
To install Drift management on Windows 2012 operating system, you must first
change the compatibility mode to Windows XP Service Pack 2.
BMC Atrium Core 9.0
Page 60 of 2268
Home
Includes BMC Atrium Integrator jobs, thereby allowing you to complete the setup promptly.
You can modify the Atrium Integrator jobs using the standard Atrium Integrator procedures.
Supports Windows Authentication and SCCM 2012 and BMC Atrium CMDB 9.0.
For more details on BMC ATrium CMDB and SCCM integration, see
this video.
New dataset-level permissions

The new dataset-level permissions ensure data security at the dataset level. These dataset-level
permissions are managed from Dataset Configuration console, which also allows you perform the
following operations:
Create a dataset and its appropriate values, allowing for easy dataset administration in a
dedicated logical area
Manage dataset-level permissions, controlling access to data and preventing inappropriate
updates of data by unauthorized users
For more information, see Managing dataset level permissions.
Central management of configuration logs in a server group

environment
Configuration logs for BMC Atrium components are moved to a Central Configuration System (CCS
), eliminating downtime when you enable logs. You can manage all CMDB configuration changes in
a server group environment from a newly implemented CMDB Configuration console. You can
perform logging configurations for the Normalization Engine and shared plug-ins from the Plugin
Server Configuration console in the BMC Remedy AR System Administration console.
Note
You no longer require file system access to edit configuration changes.

Any changes to logging configurations do not require you to restart BMC Remedy
AR System.
For more information, see Configuring logging information in CMDB.
BMC Atrium Core 9.0
Page 61 of 2268
Home

Using the CMDB Configuration console, you can configure General Settings, Cache Settings (
Applicable for server group environments only), and ChunkedItem Settings. All the logs generated
for Atrium CMDB have a unified format across the CMDB Engine and its components.
For more information, see Configuring BMC Atrium CMDB Engine .
Introduction of RESTful API to simplify integrations between

platforms
BMC Atrium CMDB now implements RESTful API, eliminating the need to use VPN solutions.
RESTful API for BMC Atrium CMDB is built on REST framework and supports the following
operations:
GET
POST
PUT
DELETE
OPTIONS
N-Level Search
You can use RESTful API for BMC Atrium CMDB to create, update, and delete configuration data
such as BMC_ComputerSystem, BMC_DiskDriver, and so on. For more information, see REST API
.
Related topics
BMC Atrium Core online documentation

To provide more accurate and usable information, the BMC Atrium Core 9.0 documentation is
available online. Online documentation provides several benefits:
Searches across all the BMC Atrium Core documentation. For more information, see
Searching.
Notifications of updated documentation available immediately to all customers. For more
information, see Notifications.
Comments, feedback, and questions to specific topics. For more information, see
Commenting.
Export to HTML, PDF, and Microsoft word. For more information, see Exporting to PDF and
other formats.
BMC Atrium Core 9.0
Page 62 of 2268
Home
For current customers, use the information in the following table to locate content in the online
documentation that was previously provided in PDF format. In many cases, the content has been
distributed among several sections in the BMC Atrium Core space, depending on the task being
performed.
Previous documents
New wiki topic
BMC Atrium Core Release

Notes
9.0.00 enhancements
BMC Atrium CMDB User Guide
Finding BMC Atrium CMDB data

Finding BMC Atrium CMDB dataSimulating the impact of changes to CIs
Simulating the impact of changes to CIsWorking with CIs and relationships
BMC Atrium CMDB

Administration Guide
Integrating
Administering
Managing permissions in BMC Atrium Core
Managing permissions in BMC Atrium CoreAdministering service models and the Service
Catalog
Configuring federated data in BMC Atrium CMDB
Managing BMC Atrium CMDB extensions
Migrating BMC Atrium Core data
Configuring BMC Atrium Explorer
Configuring BMC Atrium ExplorerPackaging BMC Atrium CMDB extensions
Packaging BMC Atrium CMDB extensions
BMC Atrium CMDB Common

Data Model Diagram
PDFs and videos
BMC Atrium CMDB Data Model

Help
PDFs and videos
BMC Atrium CMDB Data

Modeling Guide
Modeling business entities
BMC Atrium CMDB Javadoc

Help
PDFs and videos
BMC Atrium CMDB

Normalization and Reconciliation
Guide
Administering
Normalizing data
Summary of tasks in the Reconciliation console
Reconciling data
BMC Atrium CMDB Online Help
If you have access to internet, clicking the Help button from the Graphical User Interface (GUI)
of the product launches the home page of the online product documentation.
If you do not have internet access, BMC provides the offline documentation of all the products
that fall under the BMC Remedy ITSM Suite.
A separate offline documentation of each product is provided on the Electronic Product
Distribution site (EPD). To deploy the offline documentation see, Installing offline
documentation.
BMC Atrium Core: Taking Your

Data Into Production End to End
Taking Your Data Into Production End to End (video)
Atrium Integrator User Guide
BMC Atrium Core 9.0
Page 63 of 2268
Home
Previous documents
New wiki topic

Administering
Importing data with Atrium Integrator
Troubleshooting
Atrium Integrator issues
BMC Configuration Drift

Management Release Notes
Drift Management known and corrected issues

Management User Guide
Administering
BMC Configuration Drift ManagementTroubleshooting
Drift Management issues

Management Installation Guide
Installing BMC Configuration Drift Management
BMC Atrium Core Concepts and

Planning Guide
Key concepts
Planning
Key concepts
PlanningPlanning a CMDB
Planning the data model
Planning BMC Atrium CMDB data
Planning data reconciliation
Planning a service model
BMC Atrium Core Developer's

Reference Guide
Developing
BMC Atrium CMDB API architecture overview
Getting started with Atrium CMDB APIs
C API data structures
C API functions
C API Query functions overview
cmdbdriver program
BMC Atrium Core Product

Catalog and DML Guide
Administering
Managing the Product Catalog
BMC Atrium Core Installation

Guide
Planning
Deployment architecture
System requirements
Planning to upgrade BMC Atrium Core
Installing
Upgrading
Configuring after installation
Troubleshooting
BMC Atrium Core installation issues
Atrium Integrator upgrade issues
Atrium Integrator installation issues
BMC Atrium Core

Troubleshooting Guide
Troubleshooting
BMC Atrium Core Web Services

Help
BMC Atrium Core 9.0
Page 64 of 2268
Home
Previous documents
New wiki topic

Key concepts
Getting started with BMC Atrium Core Web Services
Developing
Web Services API data structures
Web Services API functions
Product Catalog web service API functions
BMC Atrium Core Master Index
Replaced by wiki search
Mapping Your Data to BMC

Atrium CMDB Classes
PDFs and videos
BMC Atrium Integration Engine

User Guide
PDFs and videos

ADK Developer's Guide
PDFs and videos
Product announcements
This topic describes changes that will occur in future releases of the product. These changes can
affect the way in which you configure or run the installed version of BMC Atrium Core.
Statement of direction for BMC Atrium Integration Engine
Statement of direction for BMC Atrium Integration Engine

This topic describes changes that will occur in future releases of the product. These changes can
affect the way in which you configure or run the installed version of BMC Atrium Core.
End of life for BMC Atrium Integration Engine

BMC Atrium Core includes BMC Atrium Integration Engine for the integration of BMC Atrium CMDB
and BMC Remedy AR System with other applications and data sources. BMC Atrium Integration
Engine enables you to transfer data between BMC Atrium CMDB classes and BMC Remedy AR
system forms to and from external systems.
Statement of direction for the end of life of BMC Atrium Integration Engine
BMC Atrium Integration Engine is being replaced with a new offering called Atrium Integrator. The
currently available BMC Atrium Core version 8.1 will be the last release that includes BMC Atrium
Integration Engine. No new versions (major or minor) of BMC Atrium Integration Engine will be
released after 8.1.
BMC Atrium Core 9.0
Page 65 of 2268
Home
Reason for the change

In order to cater to the growing need for integrations with BMC Atrium CMDB as well as BMC IT
Service Management applications, BMC introduced Atrium Integrator in January 2011 as part of the
BMC Atrium Core 7.6.04 release. Atrium Integrator is based on an industry-leading ETL platform,
and replaces BMC Atrium Integration Engine. For more information about Atrium Integrator, see
Importing data with Atrium Integrator.
In order to phase in Atrium Integrator, BMC introduced this technology in addition to the BMC
Atrium Integration Engine, and is now providing a migration path from BMC Atrium Integration
Engine in BMC Atrium Core 9.0.
Key features added to Atrium Integrator in BMC Atrium Core include:
Migration utility for moving BMC Atrium Integration Engine exchanges to Atrium Integrator
Ability to transfer information with BMC Remedy AR System forms
Server group capability for High Availability installations of Atrium Integrator
With the availability of Atrium Integrator 8.1, you now have all of the core capabilities of BMC
Atrium Integration Engine and more. Atrium Integrator is now the standard integration platform for
BMC Atrium CMDB as well as BMC IT Service Management applications.
Frequently asked questions

BMC Atrium Integration Engine support
Question
Answer
What are the end of support

timelines for BMC Atrium
Integration Engine?
BMC Atrium Integration Engine will follow the same support timelines of its corresponding BMC
Atrium Core version. See the BMC Software Product Support Policy on BMC Support Central.
Does this mean BMC Atrium

Integration Engine will be
not be available in 8.1 or
earlier versions?
No. BMC Atrium Core 9.0 will include BMC Atrium Integration Engine. However, this will be the last
release of BMC Atrium Core that does so. All prior releases will still contain respective BMC Atrium
Integration Engine versions. Please download those from the BMC support site if needed.
Will BMC Atrium Integration

Engine work properly with
any future versions of BMC
Atrium CMDB?
Beyond the 9.0 release, BMC will focus only on Atrium Integrator. BMC Atrium Integration Engine
will be in support only mode (only defect fixes as per the support policy). Therefore, BMC will stop
testing and certifying BMC Atrium Integration Engine with future (major or minor) versions of BMC
Atrium CMDB beyond version 9.0.
Will BMC provide patches

with defect fixes for BMC
Atrium Integration Engine
after the 9.0 release?
Yes. BMC will continue to fix critical defects in BMC Atrium Integration Engine while it is in full
support status.
We are expecting some

enhancements for BMC
and RFEs have been raised
through BMC Support. What
happens to them?
Atrium Integrator is the next generation integration platform which includes many key features that
BMC Atrium Integration Engine does not have. Some of the RFEs requested for BMC Atrium
Integration Engine are available as out-of-the-box features with Atrium Integrator. Existing BMC
Atrium Integration Engine RFEs will be reviewed to validate against current needs. BMC will reject
RFEs that are specific to BMC Atrium Integration Engine and which have no parallel features in
Atrium Integrator.
BMC Atrium Core 9.0
Page 66 of 2268
Home
Question
Answer
My company wants to
continue using BMC Atrium
Integration Engine. What
are my options?
BMC Atrium Integration Engine will be supported as per the standard BMC support policy. You
may continue to use BMC Atrium Integration Engine. However, please note that no new features
will be added to BMC Atrium Integration Engine. Also, newer versions of BMC Atrium CMDB are
not tested and certified to work with BMC Atrium Integration Engine.
You have the option to remain on BMC Atrium CMDB version 9.0 or earlier. With availability of the
migration utility, BMC recommends that you move away from BMC Atrium Integration Engine
sooner.
BMC Atrium Integration Engine to Atrium Integrator migration

Question
Answer
What migration services are available to

help me upgrade?
Atrium Integrator 8.1 provides a migration utility to seamlessly move BMC Atrium
Integration Engine data exchanges to Atrium Integrator. In addition, BMC Global
Services or BMC Partners can provide migration assistance as a paid for services
engagement. Service engagements are entirely optional for this migration/upgrade.
I have created multiple data exchanges

using BMC Atrium Integration Engine. What
will happen to those when I move to Atrium
Integrator? Do I will need to re-create these
integrations?
Atrium Integrator 8.1 provides a migration utility to easily move BMC Atrium
Integration Engine integrations to Atrium Integrator. Your existing investment will be
automatically migrated to Atrium Integrator with the help of this utility.
Does the migration utility move all the
Most common integrations will be moved seamlessly. However, some BMC Atrium
exchanges and associated schedules?
Integration Engine functions are not supported as part of the migration utility and
hence will require user action. For more information, see Migrating existing data
exchanges to Atrium Integrator.
We are using a BMC Partner (third-party)

adapter. What will happen to it?
If the integration was created using BMC Atrium Integration Engine, you can
choose to migrate it like any other exchange. Alternatively, check with the
respective partner for the upgrade path they may provide. In general, any BMC
Atrium Integration Engine integrations created by BMC partners are unaffected;
Customers can continue to work with those as-is.
We are using BMC Atrium Integration
These BMC product organizations have planned upgrades to Atrium Integrator
Engine integrations for BMC BladeLogic

Automation Suite, BMC BladeLogic Client
Automation or BMC IT Business
Management. What will happen to them?
based integrations. Newer versions of these products will provide Atrium Integrator
based integrations out-of-the-box in their future releases that will follow BMC Atrium
CMDB 9.0.
Atrium Integrator licensing

Question
Answer
What is the additional cost to procure an Atrium

Integrator license?
Both Atrium Integrator and BMC Atrium Integration Engine are

available as part of BMC Atrium Shared Components (BASC). Hence,
there is no additional license required for using Atrium Integrator.
Atrium Integrator uses the third-party Pentaho Data

Integration tool. Is BMC responsible for any issues with
the underlying Pentaho Data Integration software?
BMC is responsible for any issues with Pentaho when used in

conjunction with Atrium Integrator. All such issues should be routed
through BMC Support.
BMC Atrium Core 9.0
Page 67 of 2268
Home
Getting started
The following topics help you to get started with the BMC Atrium CMDB product documentation.
Orientation
Key concepts
User goals and features
Use case
If you are a system administrator and looking for information on installing or upgrading the product,
you should navigate to the BMC Remedy ITSM Deployment documentation.
Charateristics of BMC Atrium CMDB

Many databases could be considered a CMDB; however, it is important to understand the required
mechanics to deliver a true CMDB implementation. To begin with, you must be able to import data
into the CMDB so it can be represented, managed, and exposed to the processes that will
consume the data. In BMC Atrium CMDB, the Atrium Integrator extracts, transforms, and loads the
data into the CMDB data model. The BMC Atrium CMDB also provides a dataset functionality to
load data into distinct datasets, allowing you to keep your data structure organized and simplifying
working with multiple data sources.
After the data loaded is into the source dataset, it must then be normalized, especially when you
have multiple datasets. This stage of the data import allows for data to be transformed so that if you
have multiple data sources, the data is cleaned and common terminology is applied. Normalization
also allows you to set default values, such as impact values and so on, where data may be missing.
After we have our data (which is in a dataset for each source and has been normalized), we then
have common terms and values stored in the Product Catalog . The next most important thing is to
take the multiple datasets and construct a good, solid production dataset, which is where the
reconciliation process plays an important role. Reconciliation allows us to build rules that identify
data found across multiple datasets and then merge the data into our production dataset.
The result of reconciliation processing gives us our production dataset, which is referenced by the
consuming processes and is used to support those processes within the overall business.
Important
The BMC Remedy ITSM suite consumes the production dataset; the individual
source datasets are not exposed to any applications.
The data that resides in the CMDB is owned by some other applications; the CMDB
owns relationships between data.
BMC Atrium Core 9.0
Page 68 of 2268
Home
Another important factor to note about the BMC Atrium CMDB is that it has a shallow but wide data
repository. The discovery tools discover a very large amount of data from your environment;
however, all that data when brought in BMC Atrium CMDB need not contain entire details about the
discovered data. The details should include only key information that helps you to make critical
connections and maintain connectivity to your business, service, or processes.
To summarize, BMC Atrium CMDB enables you to normalize the data to common terminology, and
reconcile the data from multiple sources into a production dataset (also called the final or the
golden dataset) that conforms to a common model so data can be referenced and consumed in a
common way across processes, regardless of the source.
Orientation
Use the information in this section to understand the primary milestones for getting orientated with
the BMC Atrium Core product documentation, the table below helps you to locate the information to
effectively work with the product.
Goal
Where to go
Where do I begin?
You can begin with learning the Product overview, the key concepts. A Learning path is available for you to
get started on the product.
What are the key

components of the
The BMC Atrium Core components section gives an overview of all the components and their value.
product?
Where is the install
and upgrade
information?
The install and upgrade information resides in the Deployment documentation. The Deployment
documentation assists you with the install and upgrade tasks for all the products that are a part of the BMC
Remedy IT Service Management suite.
Below are some direct links to the Atrium CMDB specific topics from the deployment documentation.
However, it is recommended that you go through the preparing section if you are working with install or
upgrade.
Upgrading BMC Atrium Core.
Installing BMC Atrium Core
Configuration after
install
Refer to the configuration tasks section to complete the configuring tasks after the BMC Atrium Core
product is installed or upgraded.
Administer
Refer to the Administering branch to perform the following admin tasks and many more :
Manage permissions.
Modeling data.
Normalizing.
Reconciling.
Manage CMDB extensions.
Troubleshoot
BMC Atrium Core 9.0
Troubleshooting section has information on resolving errors related to Normalization, Reconciliation, and so
on.
Page 69 of 2268
Home
Key concepts
Use this section to get a high-level conceptual knowledge that helps you to use the BMC Atrium
Core product.
Product overview
ITIL processes
Architecture
Product overview
BMC Atrium Core facilitates the alignment of IT with the business. It helps you manage your
configuration items like IT hardware and software, printers, servers, air conditioners and so on,
such that you understand your environment better. BMC Atrium Core provides a CMDB coupled
with common user, programmatic, and reporting interfaces. This set of enabling technologies
provides tighter integration across management tools used in your IT environment, saving your IT
organization time and money.
The business challenge for BMC Atrium Core

ITIL standardizes the processes that IT departments use to manage IT hardware and software,
such as Problem Management, Incident Management, and Change Management. These standard
processes ensure the availability of the critical IT services that sustain a business, like banking
systems, ordering systems, and manufacturing systems. Additionally, ITIL Service Asset and
Configuration Management (SACM) needs reliable data about components in the IT environment
and needs to understand the impact to key business services when changes occur in that
environment. For a large company, maintaining and managing information about thousands of
pieces of hardware and software is difficult. Central to these ITIL processes is the configuration
management database (CMDB). The data in the CMDB feeds the applications that perform ITIL
processes.
BMC Atrium Core components
BMC Atrium CMDB, including the following components:
BMC Atrium Core 9.0
Page 70 of 2268
Home
Normalization Engine
Reconciliation Engine
BMC Atrium Explorer
BMC Atrium Impact Simulator
Common Data Model
Class Manager
Product Catalog and Definitive Media Library
Service Catalog
Atrium Integrator
Note
Atrium Integrator replaces BMC Atrium Integration Engine. You can continue using BMC
Atrium Integration Engine for existing data mappings and exchanges, but BMC
recommends that you use Atrium Integrator for all new data transfers.
BMC Atrium CMDB component of BMC Atrium Core

BMC Atrium Configuration Management Database (BMC Atrium CMDB) stores information about
the configuration items (CIs) in your IT environment and the relationships among them. BMC Atrium
CMDB should reflect your current environment how it exists now rather than what it should be.
For a detailed definition of configuration items, see Configuration items in an ITIL CMDB.
Data providers, such as discovery applications, put data into BMC Atrium CMDB, where it is
partitioned into separate datasets. This data is then brought together into a consolidated production
dataset that you use as the single source of reference for your IT environment.
Consuming applications, such as BMC Remedy IT Service Management (BMC Remedy ITSM),
BMC Asset Management, BMC Service Level Management, applications represented in Business
Service Management, and more, use the data in the production dataset.
BMC Atrium CMDB includes the following components:
BMC Atrium Explorer component of BMC Atrium CMDB
BMC Atrium Impact Simulator component of BMC Atrium CMDB
BMC Atrium Product Catalog and DML components of BMC Atrium CMDB
Class Manager component of BMC Atrium CMDB
Common Data Model component of BMC Atrium CMDB
Normalization Engine component of BMC Atrium CMDB
Reconciliation Engine component of BMC Atrium CMDB
Service Catalog component of BMC Atrium CMDB
BMC Atrium Core 9.0
Page 71 of 2268
Home
BMC Atrium Explorer component of BMC Atrium CMDB

BMC Atrium Explorer is the BMC Atrium Configuration Management Database (BMC Atrium CMDB
) data visualization tool that enables you to create and edit service models graphically in BMC
Atrium CMDB. It also enables you to see and manage configuration items (CIs) and relationships.
BMC Atrium Explorer provides the central launch point for federated and related CI information.
All instances visible in the display pane are represented in a view. You can have several views
open at once, though only one at a time is displayed. BMC Atrium Explorer can be embedded and
launched in context from any application.
In the BMC Atrium Explorer, each CI is represented by an icon that indicates the class of that
instance. You can quickly create a CI by dragging an icon into a view. When a CI is related to other
CIs, arrows connect its icon to theirs to represent the relationships. When you right-click an icon,
you can choose to either expand (show) or collapse (hide) related CIs.
For more information about using BMC Atrium Explorer, see Working with CIs and relationships
and Configuring BMC Atrium Explorer.
BMC Atrium Impact Simulator component of BMC Atrium CMDB

It is difficult to predict the potential impact of planned or unplanned changes to business services or
other critical resources. This process frequently relies on manual research results to arrive at a
best-guess impact assessment for determining the risk that a change might have on business
services. With this manual method, testing the resiliency of service models or a single point of
failure for service models is difficult.
The BMC Atrium Impact Simulator application can make this easier, enabling you to determine the
impact of a change to the availability of a configuration item (CI) on other CIs. The same impact
data is also used by the BMC Service Impact Manager (SIM) product to perform real-time analysis
of impact when events are received about real outages in your environment.
For example, you could run a simulation in BMC Atrium Impact Simulator to learn what devices and
applications in the network would be affected if you were to take a server offline. You might also
use BMC Atrium Impact Simulator to plan for disaster recovery. You can run simulations to
determine where the network is weakest, and plan accordingly. For more information about using
BMC Atrium Impact Simulator, see Simulating the impact of changes to CIs .
BMC Atrium Product Catalog and DML components of BMC Atrium CMDB
The BMC Atrium Product Catalog provides a normalized reference of software, hardware, and
other types of products and their characteristics that enhance the accuracy of BMC Discovery
products by uniquely identifying a product regardless of its installed name or location.
BMC Atrium Core 9.0
Page 72 of 2268
Home
Any application (BMC or non-BMC) can use the Product Catalog to identify a single name for a
software application and its versions, which in turn supports license compliance and provisioning.
The Product Catalog is used to normalize discovered data, both the name and categorization of
software products.
You can also use the Product Catalog to manage the products in your environment, specifying a
product version as approved, unapproved, or blacklisted. The Definitive Media Library (DML) is the
set of software in the Product Catalog that are approved for your organization to use.
The Product Catalog defines the files and suites associated with each software product, and it
enables you to specify the location of the master copies that are used to install the products. For
more information, see Managing the Product Catalog and Product Catalog web service API
functions.
Class Manager component of BMC Atrium CMDB

The Class Manager application enables you to manage the core of the data model. You can view,
modify, create, and delete configuration item (CI) and relationship classes and their attributes. With
the Class Manager, you can graphically extend and customize the BMC Atrium Configuration
Management Database (BMC Atrium CMDB) data model. Also, it includes built-in
recommendations for using the class data model. For more information about the Class Manager
application, see Opening Class Manager and viewing classes and Modeling data and impacts in
BMC Atrium CMDB.
Common Data Model component of BMC Atrium CMDB

You have many different types of configuration items (CIs), from computer systems to network
hardware to software servers. Without a data model that accurately reflects these types and the
types of relationships that can exist between them, your CMDB could store attributes that do not
pertain to their CIs, leave out necessary attributes, and make it harder to search for groups of CIs.
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) data model is object
oriented, which means that it has a hierarchical set of classes in which each class inherits attributes
from its superclass (the class above it in the hierarchy) and then adds its own attributes to create a
more specific type of object, a subclass. The benefits of an object-oriented data model include
enforcement of common attributes among similar types of CIs and the ability to search within not
just a given class of CIs, but within any branch of the hierarchy. From a base class from which all
others are derived, you can search for all CIs or all relationships.
The BMC Atrium CMDB data model is also extensible. Your infrastructure, and the technology that
comprises it, is constantly changing. That means the types of CIs and relationships in your CMDB
must also change, so you need a data model that is extensible. You can add attributes to your
classes, and even add classes. Subclasses can have their own subclasses, extending the
hierarchy to the level of detail that you want to track.
BMC Atrium Core 9.0
Page 73 of 2268
Home
The Common Data Model (CDM) is the set of CI and relationship classes that ships with BMC
Atrium CMDB. These classes are complete enough to model nearly everything in your IT
environments. All classes in the CDM reside in the BMC.CORE namespace.
For consistency with industry standards developed to track and manage this type of information,
the CDM is based on the Common Information Model (CIM) from the Distributed Management Task
Force (DMTF) and Microsoft Windows Management Instrumentation (WMI). The CDM adopted
much of the basic design of the CIM and WMI without detailing the internal workings of systems.
For a graphic of the CDM, see the BMC Atrium CMDB 8.1.00 Common Data Model Diagram .
Recommendations for modeling your environment in the CDM are available in Modeling business
entities.
Normalization Engine component of BMC Atrium CMDB

The Normalization Engine is a policy enforcement engine installed with BMC Atrium Configuration
Management Database (BMC Atrium CMDB). It enables you to centrally define data policies and
automatically enforce them throughout BMC Atrium CMDB. Data from any source is subject to
policy enforcement. This consistency in BMC Atrium CMDB data enables consuming applications to
make good decisions.
For example, BMC Asset Management can report on software license usage appropriately. In
conjunction with the Product Catalog, the Normalization Engine provides a centralized and
customizable means to normalize the following types of data:
Products and categorizations Replaces CI values of Category, Type, and Item, and
manufacturer data such as ManufacturerName and Model, with correct values from the
Product Catalog.
Impact For relationships, sets the impact attributes based on the out-of-the-box or custom
impact rules for the relationship class and the source and destination classes it relates to.
With version 7.6.03 and later, impact is represented as attributes in a relationship class. The
BMC_Impact class was deprecated.
Relation Name For relationships, replaces the existing Name value with the
BMC-recommended name based on the CI classes in the relationship.
Row-level security--Sets the row-level and attribute-level permissions on CIs as you define
them.
Version Rollup Sets the MarketVersion attribute for instances to a common value
based on default or custom rules. This provides more accurate information for managing
licenses.
Suite Rollup Allows you to define suites and their products and to identify instances as a
suite, a suite component, or a standalone application. This allows more accurate
management of suite and individual licenses.
BMC Atrium Core 9.0
Page 74 of 2268
Home
Custom Allows you to create custom rules when the out-of-the-box Normalization features
do not meet your requirements for normalizing data. You can create a custom rule for CI and
relationship classes to perform a set attribute action based on the conditions that you have
defined in a rule.
With the Normalization Engine, you can define what is normalized and when. You can select the
BMC Atrium CMDB classes to normalize and the attributes for each class. You can also choose
which datasets are normalized. For more information about normalization, see Normalizing data.
Reconciliation Engine component of BMC Atrium CMDB

The Reconciliation Engine is installed with BMC Atrium Configuration Management Database (BMC
Atrium CMDB). The main goal of the Reconciliation Engine is the creation of a production dataset
that contains accurate data from all available sources. Data in the production dataset can be used
by consuming applications. The following Reconciliation Engine activities work in direct support of
this goal:
Identifying class instances that are the same entity in two or more datasets
Merging datasets
Additionally, the Reconciliation Engine has default reconciliation rules that simplify the creation of
reconciliation jobs and a continuous or near real-time reconciliation mode to support dynamic
changes in your environment. The Reconciliation Engine provides other functionality with the
following activities:
Comparing class instances in two or more datasets
Copying instances from one dataset to another
Deleting instances from one or more datasets
Purging instances that are marked as deleted from one or more datasets
Renaming datasets
For more information about reconciliation, see Reconciling data.
Service Catalog component of BMC Atrium CMDB

The Service Catalog provides centralized management of business services across BMC products.
It enables you to define in BMC Atrium Configuration Management Database (BMC Atrium CMDB)
a common list of services that IT provides to the business. You can use BMC Atrium Explorer to
dynamically update the infrastructure configuration items (CIs) related to these services by using
queries and templates.
Relating services to infrastructure CIs in your CMDB enables an IT organization to:
Establish and set clear expectations for service delivery.
Rationalize data across IT processes based on a business context.
Provide a service-oriented approach to enable management reporting.
BMC Atrium Core 9.0
Page 75 of 2268
Home
With the Service Catalog, you can access a list of all the business services and their supporting
technical services. For more information about the Service Catalog, see Administering service
models and the Service Catalog.
Atrium Integrator component of BMC Atrium Core

The Atrium Integrator product enables you to transfer data from an external datastore to BMC
Atrium Configuration Management Database (BMC Atrium CMDB). The Atrium Integrator is ideal
for complex transfers that require data transformation, for transfers of large amounts of data, and in
instances with multiple integration points. It is also the method of choice for transferring existing
data, either discovered by a third-party discovery application or residing in flat files (CSV or XML),
because the field mapping feature enables you to map existing data to the BMC Atrium CMDB data
model.
The Atrium Integrator supports event-based, scheduled, or manually run information flow. The
graphical interface displays both external data sources and BMC Atrium CMDB classes. For more
information about Atrium Integrator, see Importing data with Atrium Integrator.
Note
In previous releases, BMC Atrium Core included the BMC Atrium Integration Engine
product as the preferred tool for data transfers. Though BMC Atrium Integration Engine is
included with BMC Atrium Core 8.0 and any integrations you have built with it continue to
work, it has been deprecated. BMC Software recommends that you use Atrium Integrator
for transferring data in any new integrations you develop. There is not currently a means
of migrating BMC Atrium Integration Engine definitions to Atrium Integrator, so if you are
already using BMC Atrium Integration Engine for any integrations you should continue to
use it until BMC provides a migration path to Atrium Integrator.
ITIL processes
IT departments face numerous challenges in providing dependable services that support a
company's business goals. Solving most of them requires a good Configuration Management
strategy: without knowing what is in your environment, you cannot hope to control it, maintain it, or
improve it.
Due to a growing interest in adopting best practices across IT departments, particularly according
to standards such as the Information Technology Infrastructure Library (ITIL), many organizations
are now deciding to implement a CMS. They realize there is a business value in having a single
source of reference for their organization's decision support that provides a logical model of the IT
infrastructure to identify, manage, and verify all configuration items (CIs) in the environment.
BMC Atrium Core 9.0
Page 76 of 2268
Home
In ITIL version 3, the process that supports data management of CIs and IT assets for information
and knowledge to enable service management decisions is referred to as Service Asset and
Configuration Management (SACM). SACM encompasses the Asset Management and
Configuration Management processes, managing service assets to support the other Service
Management processes.
Purpose of SACM
Goals of SACM
Benefits of SACM
Data is the key to SACM
Control of the Configuration Management process
Purpose of SACM
According to the ITIL Service Transition manual, the purpose of Service Asset and Configuration
Management (SACM) is to:
Identify, control, record, report, audit, and verify service assets and configuration items,
including versions, baselines, constituent components, their attributes, and relationships.
Account for, manage, and protect the integrity of service assets and configuration items (and
, where appropriate, those of its customers) through the service lifecycle by ensuring that
only authorized components are used and only authorized changes are made.
Protect the integrity of service assets and configuration items (and, where appropriate, those
of its customers) through the service lifecycle.
Ensure the integrity of the assets and configurations required to control the services and IT
infrastructure by establishing and maintaining an accurate and complete Configuration
Management System (CMS).
Goals of SACM
According to the ITIL Service Transition manual, Service Asset and Configuration Management (
SACM) pursues the following goals:
Support the business and customer's control objectives and requirements.
Support efficient and effective Service Management processes by providing accurate
configuration information to enable people to make decisions at the right time (for example,
to authorize change and releases, resolve incidents and problems faster).
Minimize the number of quality and compliance issues caused by improper configuration of
services and assets.
Optimize the service assets, IT configurations, capabilities and resources.
Benefits of SACM
Achieving the goals of Service Asset and Configuration Management (SACM) can benefit your
organization in significant, measurable ways related to control, integration, and decision support.
Control benefits of SACM
BMC Atrium Core 9.0
Page 77 of 2268
Home
Integration benefits of SACM

Decision support benefits of SACM
Control benefits of SACM

Verifying and correcting configuration records gives you a greater degree of control over your
infrastructure. For example, by controlling the versions of configuration items, you reduce the
complexity of your environment, and in turn your support costs. Items that disappear or that appear
without being paid for are noticed, helping you control assets and avoid legal issues. Exercising
greater control over your environment also means that you can increase overall security.
Integration benefits of SACM

When processes such as Incident Management, Problem Management, Change Management, and
Release and Deployment Management are based on a current record of your configuration, they
can be integrated, as shown in the following figure. This reduces administrative costs and errors.
For example, you might integrate Incident Management and Change Management processes in the
following ways:
When resolving an incident requires a change, the Incident Management application can
automatically create that change request.
An Incident or Problem Management application can use a service model to identify previous
changes that might have caused a failure.
Integrating all configuration-related IT processes can reduce the number of staff needed to
administer your environment, saving you money.
Some of the ITIL processes integrated by the CMS
BMC Atrium Core 9.0
Page 78 of 2268
Home
Decision support benefits of SACM

Your IT managers benefit from having accurate configuration information mapped to your Service
Management processes. Making decisions is easier when you have complete and accurate data,
resulting in better resource and performance estimates. You can commit to service levels more
confidently, and your risk management improves, reducing unplanned downtime.

Whatever Service Asset and Configuration Management (SACM) processes you implement, their
effectiveness depends on the data that they use.
Configuration data must be accurate, which means it must be updated frequently. Configurations
are constantly changing, so last week's correct data could be obsolete this week. This could result
in a purchase of ten servers when you need only five, or, worse, the installation of a security patch
that causes a system to fail.
BMC Atrium Core 9.0
Page 79 of 2268
Home
Configuration data must also be available to all your IT processes, because even the most accurate
data is useless if you cannot access it. For example, if the network topology data provided by your
discovery application is not accessible to your Change Management application, you cannot
intelligently plan a network redesign.
The solution that enables you to maintain accurate configuration data that is shared by multiple IT
processes is a CMDB, preferably one that is frequently updated by an automated discovery tool.
Control of the Configuration Management process

According to ITIL, you should continually assess the efficiency and effectiveness of your
Configuration Management process by using Continual Service Improvement, including regular
management reports. You should also schedule a review of the expected growth of Configuration
Management activities on a regular basis.
ITIL recommends generating the following reports, and making their results available for
interrogation and trend analysis by IT Service Management and other groups within IT services:
Results of configuration audits
Information about the number of registered configuration items (CIs), including growth and
capacity information
Details about any delays caused by Configuration Management activities
Details about hours worked by Configuration Management staff
Architecture
This section describes the BMC Atrium Core architecture, including its relationship to BMC Remedy
Action Request System server (BMC Remedy AR System server) and to the ITIL V3 Configuration
Management System (CMS).
BMC Remedy AR System foundation architecture and benefits
Architecture of the CMS
BMC Atrium Core architecture and features
BMC Atrium Core Web Services architecture
For specific information about different implementation scenarios, see the Deployment architecture.
BMC Remedy AR System foundation architecture and benefits

BMC Atrium Configuration Management Database (BMC Atrium CMDB) is built on the BMC
Remedy AR System application. The BMC Remedy AR System is a professional development
environment for creating business workflow applications.
BMC Remedy AR System architecture
Benefits of using BMC Remedy AR System
BMC Atrium Core 9.0
Page 80 of 2268
Home
BMC Remedy AR System architecture

BMC Atrium CMDB fits into the BMC Remedy AR System architecture as shown in the following
figure. To browse class instances or configure BMC Atrium CMDB from the BMC Atrium Core
Console, use a web client with the BMC Remedy Mid Tier, just as you would to access any other
BMC Remedy AR System forms.
BMC Atrium CMDB and BMC Remedy AR System infrastructure
For more information about BMC Remedy AR System applications, forms, and other concepts, see
Developing an application in the BMC Remedy Action Request System online documentation.
BMC Atrium Core 9.0
Page 81 of 2268
Home
Benefits of using BMC Remedy AR System

Running on the BMC Remedy AR System gives BMC Atrium CMDB several benefits, including:
A proven, stable platform
Compatibility with a large number of databases and operating systems
A flexible permissions model with users and groups
Ability to add customized workflow without having to code
Easy replication with the Distributed Server Option
Scalability, using server groups to distribute load
Easy integration with CMS data stores, such as incident tickets and contracts
Built-in auditing and archiving mechanisms
For more information about BMC Remedy AR System concepts and architecture, see Key concepts
in the BMC Remedy AR System online documentation.
Architecture of the CMS

ITIL V3 introduced the Configuration Management System (CMS), which stores all configuration
records and can contain multiple CMDBs. The BMC implementation divides the CMS and its
infrastructure into the following layers:
CMDB layer in the CMS
CMS Data layer
CMS Environment
The CMS Data layer contains related data and additional detail linked to or from the CMDB. The
CMS Environment layer contains applications that interact with the other two layers.
The following figure illustrates these layers.
CMS infrastructure
BMC Atrium Core 9.0
Page 82 of 2268
Home
CMDB layer in the CMS

A CMDB holds only instances that represent physical, logical, or conceptual things (called
configuration items, or CIs ) throughout your organization that you have a business need to track
and the relationships between these items that are also important enough to track. CIs and the
relationships between them are called configuration data.
Some of the attributes of these CIs can be links to the CMS Data layer. Not all available CI
attributes must be stored in the CMDB: in fact, you should store only the key attributes here and
link to the less-important attributes in other CMS data stores.
BMC Atrium Core 9.0
Page 83 of 2268
Home
Even though a CMDB does not hold all attribute data or related data, it still serves as the single
source of reference for configuration data because it links to the CMS Data layer. For example, you
might have an instance in a CMDB representing a printer, and a federated link to incident requests
about the printer in another CMS data store.
You can make all requests to a CMDB, and when the data that you need is not stored there, you
find reference links to where that data is stored and information about how that data can be
accessed. The data accessed through these links is called federated data.
CMS Data layer

The configuration management system (CMS) Data layer can include several data stores. It
includes related data and any configuration item (CI) attributes that you judge as not appropriate to
track in the configuration management database (CMDB).
For example, suppose that your discovery application discovers 100 attributes of each computer
system on your network, but only 20 of them are critical to your business. You would import the 20
attributes from your discovery database into the CMDB and leave the other 80 in the discovery
database, which is part of your CMS.
The two types of data in the CMS Data layer are linked to the CI data in the CMDB in different ways
. The "extra" CI attributes are linked from their instances in the CMDB with federation, enabling
requests made to the CMDB to reach these attributes. Federated data can include information in
another database, BMC Remedy AR System forms, or even another CMDBf-compliant CMDB. For
example, you might use multiple CMDBs in a global company to comply with government
regulations, with a different CMDB in each country or geographical region. One CMDB serves as
your single source of reference about CIs and relationships in your environment, while data in the
other CMDBs is federated.
For CMS data that is simply related to CIs, the link can be in either or both directions. For example,
a change request record could link to instances of the CIs it will change, and each CI instance
could link via federation to the change requests that affect it.
Separating this layer from the CMDB has several benefits:
The CMDB can focus its functionality on CIs and their relationships. This functionality
includes partitions for data from multiple sources, reconciliation of that separate data, and
federated data.
The overhead required to provide CMDB functionality is not wasted on data that does not
need it. For example, multiple snapshots of every change request record are unnecessary,
so making your change request records part of the CMDB would be confusing and waste
valuable storage space.
You do not have to modify the CMDB to hold related data. With the boundary drawn at CIs
and their relationships, the question of whether to store some new type of data in the CMDB
is already answered. You store it instead as part of the CMS Data layer, and save the
BMC Atrium Core 9.0
Page 84 of 2268
Home
trouble of changing the data model in the CMDB to accommodate the new type of data. You
also avoid pitfalls inherent in trimming the data model if you later decided to move data out
of the CMDB.
Transactional data can be stored in databases specifically designed to handle a high volume
of real-time requests.
Data is provided more efficiently. Instead of getting all their data from the CMDB, data
consumers can get it from individual data stores that are optimized to provide the specific
type of data being requested.
You do not need to undertake several data migrations and application integrations to move
your change requests, incident tickets, and other CI-related data into the CMDB.
Applications that use this data can continue to access it where you currently store it.
The CMDB does not become a bottleneck. With requests for related data on its own being
handled by other databases, the CMDB does not have to accommodate all such traffic in
addition to CI-related requests. You can spread the load across multiple systems.
Though your CMS Data layer can be a single data store, you do not have to store the data this way.
The different types of data in the CMS Data layer are not necessarily linked to or related to each
other. The only thing they must have in common is a link to or from the CMDB.
CMS Environment
Where the CMS Data layer contains data, the configuration management system (CMS)
Environment is devoted to the applications that provide and consume that data. These applications
can access the configuration management database (CMDB), the CMS Data, or both. For example,
an Asset Management application that views and modifies configuration item (CI) instances in the
CMDB is part of the CMDB Environment as a consumer, and a discovery application that creates
CI instances in the CMDB is part of the CMDB Environment as a provider.
These applications sometimes store their information in their own databases, but the two are still
considered to be part of different layers of the CMS infrastructure. An application is part of the CMS
Environment, whereas its configuration-related data is part of the CMS Data. Of course,
applications in the CMS Environment can also access data unrelated to CIs. This data is not part of
the CMS Data.

This section describes how the components in BMC Atrium Core integrate with each other and
other applications to form a solution. This architecture is shown in the following figure. Other
features and applications such as federation, web services, and the service oriented architecture
are also described.
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) provides the features
that you need to implement a configuration management database (CMDB) in your environment.
Any application that is integrated with BMC Atrium CMDB (for example, a data provider like BMC
Atrium Discovery and Dependency Mapping or a data consumer like BMC Asset Management) can
access the data from a centralized database.
BMC Atrium Core 9.0
Page 85 of 2268
Home
Open access to data in BMC Atrium CMDB

Data partitioning in BMC Atrium Core
Federated data model
Web services and service oriented architecture
User access to BMC Atrium CMDB
Virtualization management in BMC Atrium Core
BMC Atrium Core architecture
The following points explain the architecture:

At the center of BMC Atrium Core is BMC Atrium CMDB. BMC Atrium CMDB uses a
federated data model, featuring a centralized database linked to other data stores, to share
configuration data without the high setup and maintenance costs associated with a pure
centralized approach.
The data inside BMC Atrium CMDB consists of configuration items (CIs) and the
relationships among them. A CI is a physical, logical, or conceptual entity that is part of your
environment and has configurable attributes.
BMC Atrium Core 9.0
Page 86 of 2268
Home
Each CI or relationship is stored in a particular dataset within BMC Atrium CMDB. Data from
each source or discovery tool is organized into datasets, which are then reconciled so that
one production dataset represents your environment. A dataset can store data from a
particular provider, a snapshot of data at a particular time, or any other set you want to
create.
The Sandbox dataset is an overlay dataset for the BMC Asset dataset that allows you to
make changes in a separate partition without changing the production data and without
duplicating the entire dataset. The Sandbox functions as a control mechanism so that BMC
Atrium CMDB is not overloaded with unintended data when multiple sources update the
BMC Atrium CMDB.
When CIs and its CI Relationships are added (manually, imported, automation, etc.) into the
BMC Atrium CMDB, each entry is assigned to a particular dataset identifier. This dataset
identifier defines the specific source of information (data provider) that provided the CIs, its
attribute data, and relationship connections.
For example, CIs and its relationships discovered from BMC Atrium Discovery and
Dependency Mapping have BMC.ADDM as the dataset identifier. When the CI information of
the discovered CIs is reconciled against other dataset identifiers, it is stored into a Golden
dataset identifier of BMC.ASSET, thus allowing data consumers to access the trusted and
most accurate data.
In addition, the Sandbox dataset identifier represents an overlay dataset for the BMC.ASSET
dataset identifier, which allows CMDB managers to define comparison requirements against
the Production (BMC.ASSET) dataset identifier before the changes are incorporated into the
CI record. This allows Change Managers to be notified of changes made to a CI, thus giving
them the opportunity to ensure a Change Request was submitted and approved to support
the modification.
The Normalization Engine makes sure that data from different data providers is consistent in
BMC Atrium CMDB. After data is normalized before or after it is created in a dataset, it can
be reconciled and saved to the BMC Atrium CMDB production dataset.
Note
BMC recommends that you normalize data before reconciliation.
The Reconciliation Engine merges data from multiple import datasets into the BMC Asset
dataset. This consolidated view of your data is the production dataset that data consumers
should use and on which you should base business decisions. The Reconciliation Engine
also performs tasks such as deleting or purging records on a scheduled basis, comparing
data for reporting or for Remedy AR System workflow triggers, and copying datasets into
other datasets to protect the data.
BMC Atrium Core 9.0
Page 87 of 2268
Home
BMC Asset Management displays data from the BMC Asset dataset by default. If you
manually edit data using BMC Asset Management, you should save those changes to the
BMC.ASSET.SANDBOX dataset rather than writing them directly to the BMC Asset dataset,
thereby enabling the changes to be reconciled with those from all active import datasets.
Open access to data in BMC Atrium CMDB

Even the most accurate data is useless if you cannot access it. A wide variety of users and
applications must be able to both read and write to the CMDB. Providers create and modify data in
bulk, whereas consumers view the data and can also make modifications. The following figure
shows some providers and consumers of BMC Atrium Configuration Management Database (BMC
Atrium CMDB) data.
Data providers and consumers
Open access to data includes these features:

Programmatic access BMC Atrium CMDB provides C, Oracle Java, and web services
application programming interfaces (APIs) to view and modify its data. This includes both
instance data and the data model. For more information, see Developing.
Bulk data load BMC Atrium CMDB provides ways to import multiple instances at once, so
that discovery applications and others can rapidly populate the database: the BMC Atrium
CMDB APIs and Atrium Integrator. The latter maps and transfers data from multiple
database and file formats into BMC Atrium CMDB. For more information, see Importing data
with Atrium Integrator.
Database and platform independence BMC Atrium CMDB is compatible with multiple
operating systems and database vendors to provide flexibility in your environment.
BMC Atrium Core 9.0
Page 88 of 2268
Home
Data partitioning in BMC Atrium Core

Partitioning is dividing your configuration data into subsets, each representing a logical group of
configuration items (CIs) and relationships. In BMC Atrium Core, these partitions are called
datasets. The same real-world object or relationship can be represented by instances in more than
one dataset. For example, different discovery applications can create CI and relationship instances
in different datasets. You can later merge those instances into a single production dataset.
This is important for the goal of verifying and correcting configuration records against the
infrastructure. You can create one dataset representing your intended configuration, then use a
discovery application to create another dataset representing your actual configuration, and verify
the former against the latter.

BMC Atrium Configuration Management Database (BMC Atrium CMDB) uses a federated data
model, which means that you can keep some data in managed data repositories in lieu of
populating BMC Atrium CMDB with all your data. The most common types of federated data are
related information and detailed attributes. Related information is information about a configuration
item (CI) that does not itself qualify as a CI and therefore should not be stored in a CMDB. Detailed
attributes are attributes of CIs stored in BMC Atrium CMDB, but they are attributes that are not
important enough to track at the level of a CMDB.
Note
For information about what qualifies as a CI, see Configuration items in an ITIL CMDB.
For related information, your CI records for software instances might link to the URL of an intranet
page where the software license is posted, or each CI record might link to information necessary to
search a problem database for all problems concerning that CI.
For detailed attributes, the CMDB record for an employee might have a Skills attribute that contains
a list of the employee's skills and a Department attribute that contains the employee's department
name. It might also link to an HR database where additional attributes, like Salary, that are not
really important from a configuration perspective are stored.
Federated data might be stored in a discovery database, a Capacity Management system, an
Availability Management system, or other external data stores. You can retrieve federated data and
view it with BMC Atrium Explorer, as if it were stored in BMC Atrium CMDB. The BMC federated
data model enables you to connect to Java database connectivity (JDBC) compliant databases,
CMDBf-compliant CMDBs, and BMC Remedy AR System forms.
BMC Atrium Core 9.0
Page 89 of 2268
Home
Web services and service oriented architecture

BMC Atrium Configuration Management Database (BMC Atrium CMDB) web services application
programming interfaces (APIs) are modified based on the service oriented architecture (SOA). SOA
facilitates the loose coupling of product integrations, minimizing the cost and difficulty of upgrading
components.
Operations are grouped by related services. This grouping of operations enables services to be
versioned and extended independent of each other, which makes it easier to add new services and
operations.
With web services, integrations are more robust because services can be located anywhere and
can be started or stopped without breaking the integration. For more information about web
services and service oriented architecture, see Getting started with BMC Atrium Core Web Services
.
User access to BMC Atrium CMDB

To give someone access to BMC Atrium Configuration Management Database (BMC Atrium CMDB
), you must create a BMC Remedy AR System user on the server where BMC Atrium CMDB is
installed. You can then make that user a member of multiple groups and assign those groups to
roles that allow access to different parts of the application and its data. For detailed information
about user access, permissions, and roles, see Managing permissions in BMC Atrium Core .
Virtualization management in BMC Atrium Core

A benefit of virtualization is a dynamic IT environment in which changes can happen rapidly and
frequently. However, this can also cause service models to be out of sync just as quickly.
These BMC Atrium Core features avert issues that arise in a virtual environment:
Continuous, real-time normalization and reconciliation to rapidly update data in BMC Atrium
Configuration Management Database (BMC Atrium CMDB)
Dynamic service model updates based on queries and templates
Data models that represent virtual machine (VM) resource pools and settings
Rapid data loads

All BMC web services register with a central service registry (the Apache jUDDI Server) that makes
them available to other services and clients.
The following figure shows how web services are published and requested through the Apache
jUDDI Registry Server.
BMC web services and clients
BMC Atrium Core 9.0
Page 90 of 2268
Home
BMC Atrium Core Web Service Infrastructure runs on a modified Apache Axis2 infrastructure. Other
BMC web services run on their own application servers but publish to the Apache jUDDI Server. A
consuming client finds the available services in the Apache jUDDI Server and then invokes the
services using web interfaces.
The following figure shows the BMC Atrium Core Web Services and Apache Axis2 infrastructure in
more detail.
BMC Atrium Core Web Services and Apache Axis2 infrastructure
BMC Atrium Core 9.0
Page 91 of 2268
Home
The Apache jUDDI Registry Server depends on the database specified during the Web Services
installation as the repository for UDDI data. The database must be running before the Apache
jUDDI Registry Server is started.
The Apache jUDDI Server is implemented as a collection of web services and is deployed as a
WAR file (uddi.war ) on the web application server.
The Apache jUDDI Server utilities and sample scripts are located in $ATRIUMCORE_HOME
/wsc/wsregistryapi.
BMC Atrium Core 9.0
Page 92 of 2268
Home
The Atrium Web Service is deployed as an expanded web application archive from the $
ATRIUMCORE_HOME/wsc/atriumws90 directory.
Related topic
User goals and features

BMC Atrium Core provides conceptual, reference, task, and troubleshooting information for the
following roles.
User Role
Description
CMDB
Administrators
Installing BMC Atrium Core components

Determining how to allocate server and database resources
Topics
Configuring
after
installation
Managing BMC Atrium Core access control by assigning permissions for BMC Atrium
Core applications and their components
Maintaining BMC Atrium Core by adding and deleting users, groups, and roles; backing
Integrating
up BMC Remedy AR System servers; importing data from other systems
CMDB
Configuration
Manager
Application
Developers
CMDB
Consumers
Administering
Loading data BMC Atrium Configuration Management Database (BMC Atrium CMDB)
Dataset handling, working with normalization and reconciliation, working with bmc.asset
or the production dataset
Permissions, service catalog
Developing
Writing plug-ins and custom clients that use the BMC Atrium Core APIs
Integrating applications with BMC Atrium Core
Integrating
Using
Creating and editing configuration items (CIs)

Querying BMC Atrium CMDB
Simulating the impact of changes to CIs
Use case
This section describes the end-to-end process for setting up and using the BMC Atrium Core
product to store information about the configuration items (CIs) in your IT environment and the
relationships among them.
Implementing BMC Atrium Core
Importing data to BMC Atrium CMDB
Managing BMC Atrium Core
Taking Your Data Into Production End to End video
BMC Atrium Core 9.0
Page 93 of 2268
Home
Implementing BMC Atrium Core

This section describes the tasks necessary to implement your BMC Atrium Core solution
end-to-end, including configuring permissions, bringing data into to BMC Atrium Configuration
Management Database (BMC Atrium CMDB), and reconciling that data into the production dataset
for consuming applications.
To implement BMC Atrium Core, complete this ordered series of procedures. Each procedure is
explained in its own section, which also describes recommendations. However, the purpose of this
section is not to provide the detailed steps for each procedure, which are given in the referenced
documents. Instead, this section lays out the order of the procedures and reveals important points
for the overall process. In doing so, it uses the following diagram to focus attention on the particular
point in the context of the whole process.
Note
For a video demonstration of the core pieces of this process, see
Taking Your Data
Into Production End to End (video).
Some of these steps might not be relevant to your situation, and you can perform some in a
different order from that shown in this process.
1. Configure permissions and multitenancy for access to BMC Atrium Core components, to
classes and attributes, and to instances.
2. Configure the BMC Atrium Product Catalog and the approved software and hardware.
3. Configure the data model as needed for imported data.
4. Create datasets as needed for imported data.
5. Configure Atrium Integrator for importing data.
6. Configure normalization for system defaults and individual datasets.
7. Configure reconciliation.
8. Create the service model that contains the services IT offers the business, and the IT
infrastructure configuration items (CIs) necessary to deliver services.
9. Use discovery tools, Atrium Integrator, and manual tasks to import data into BMC Atrium
CMDB.
BMC Atrium Core 9.0
Page 94 of 2268
Home
Configuring permissions and multitenancy
To start the end-to-end process, set up permissions for users who need access to BMC Atrium
Core applications. After completing the configuration tasks, verify that the roles and permissions
have access to the data as planned. You can configure class and attribute permissions and
row-level access and instance permissions.
For more information about configuring permissions, see Managing permissions in BMC Atrium
Core.
Configuring multitenancy in BMC Atrium Core

This section describes the high-level steps to configure multitenancy. You can apply these steps to
configure multitenancy in multiple ways, including:
Using BMC Remedy ITSM, as described in the BMC Remedy IT Service Management 7.5
Guide to Multi-Tenancy.
Using the Product Catalog, as described in Managing the Product Catalog.
To configure multitenancy, complete the following high-level steps. For detailed information about
configuring multitenancy, see Configuring permissions and multitenancy.
1. Select the tenancy mode.
2. Configure companies to represent the business units of your organization.
3. Configure access for people.
Selecting the tenancy mode

The value that you select in the Tenancy Mode field on the System Settings form determines
whether the Company field on various forms defaults to a single company or whether users must
always select the appropriate company for the field. BMC Remedy ITSM is installed with the
Tenancy Mode field set to Multitenancy. If you have changed this field to single-tenancy mode, you
must change the value back to Multitenancy. For information about changing this setting, see BMC
Remedy IT Service Management 7.5 Guide to Multi-Tenancy .
Note
In BMC Atrium Configuration Management Database (BMC Atrium CMDB), the
multitenancy feature is always available. Regardless of the Tenancy Mode setting, data is
segregated by company and access to data is controlled by a user's access to a company
.
BMC Atrium Core 9.0
Page 95 of 2268
Home
Configuring companies to represent business units

To segregate products by business unit, create companies to represent the business units. For
example, in the Company form, Calbro Services enters Finance in the Company field for the
finance department. Similarly, separate "companies" are created for HR and IT.
Configuring access for people

Use the People form to grant people access to business units. Calbro Services uses the People
form to grant access as follows:
Patrick Paycheck is granted access to Finance.
Betty Benefits is granted access to HR.
Steve Server is granted access to all applications, including those used by Finance and HR.
Configuring the Product Catalog
To set up the Product Catalog, complete the following procedures. For more information about
Product Catalog concepts, see BMC Atrium Product Catalog overview.
1. Create Product Catalog entries.
To normalize CIs, you must have product entries in the Product Catalog. Import or create
these products as needed.
2. (optional ) Configure the categorizations to meet your needs .
3. Approve products, versions, and patches for your organization.
By default, the Normalization Engine does not update or allow the creation of unapproved
CIs, and all products in the Product Catalog are unapproved by default. If you allow
normalization of unapproved CIs, the Normalization Engine sets the NormalizationStatus
attribute for such CIs to Normalized Not Approved.
Configuring the data model
This section aligns with Stage 4, Step 23, "Task 2. Configure the CMDB," of the Step-by-Step
Guide to Building a CMDB.
BMC Atrium Core 9.0
Page 96 of 2268
Home
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) data model unifies the
representation of configuration data. It is designed to store data about the most common CIs such
as hardware, software, and services, to provide a complete view of all elements of an IT
environment and how they affect each other.
The Common Data Model includes classes that describe a wide variety of IT configuration items
and their relationships, and some BMC Software products install extensions that add more classes
and attributes to the data model. But there are still some IT infrastructures that do not completely
map to this model.
If the classes and attributes that you require are not defined by the BMC Atrium CMDB data model
or the extensions, modify the data model.
For detailed information about what to consider before modifying the data model, see Planning to
extend the data model.
Creating datasets for data providers and production
Creating datasets in BMC Atrium Configuration Management Database (BMC Atrium CMDB) to
store data provided by different data providers is the first step when importing data. A dataset is a
logical grouping of data. It can represent data from a particular source, a snapshot from a particular
date, or other purpose.
Make sure that each data provider has its own import dataset.
Also, note which dataset is your production, or golden, dataset so that you can plan your
normalization and reconciliation jobs. By default, the BMC.ASSET dataset is the production dataset
. In reconciliation, the production dataset is used first to identify duplicate CIs, matching attributes
for the configuration item (CI) in the production dataset with the CIs in the imported datasets.
Second, it can be the target dataset in a Merge activity so that the CIs are updated to keep the
production dataset current and accurate. Also, do not normalize the production dataset because
you should normalize CIs before identifying and merging them.
When you need to merge more than one dataset at time, you might want to create an intermediate
dataset for merging. For better performance and to minimize the impact on users of the production
dataset, BMC recommends that you merge one import or discovered dataset at a time with the
production dataset. You might want to merge multiple source datasets in separate jobs to an
intermediate dataset and then merge the intermediate dataset with the production dataset.
For more information about planning your datasets, see Grouping CIs into datasets.
For detailed instructions about creating a dataset, see Managing datasets in BMC Atrium Core .
BMC Atrium Core 9.0
Page 97 of 2268
Home
Configuring Atrium Integrator for data import
Using Atrium Integrator to import data into BMC Atrium Configuration Management Database (BMC
Atrium CMDB) from a third-party source consists of the following tasks:
1. Configure source and target connection.
2. Create a job or transformation.
3. Edit your transformation or job.
4. Verify and run your job.
For more detailed information about importing data with Atrium Integrator, see Overview of the data
transfer process.
Tip
To create an integration job, use the Integration Job Builder wizard which automatically
populates data and includes templates for typical integrations.
Recommendations
When configuring Atrium Integrator, consider the following recommendations:
Transform your data on the way in so that all sources (BMC and third-party) are normalized
for commonly used attributes like Domain and those related to memory and disk size.
For example, DriveSize for BMC_Media should be specified in GB. For more information
about attributes, see BMC Atrium CMDB Data Model Help and Class Manager.
Provide data to help reconciliation by ensuring that CI attributes used for identification have
unique values and are populated consistently.
If you need to customize the data mappings in an integration job, familiarize yourself with the
Common Data Model so that you can select the appropriate classes and attributes. You can
also verify that data types match for the data mappings and plan unique identifying fields.
Consider bringing in data by chunks and designating separate BMC Atrium Integration
Engine instances for such activity so that, if you have a large amount of data to import, you
can spread the import work across multiple instances.
Do not run more than one Atrium Integrator, Normalization Engine, or Reconciliation Engine
job at the same time because they might query or update the same data.
BMC Atrium Core 9.0
Page 98 of 2268
Home
Map the attributes that the Normalization Engine uses to normalize CIs: Name,
ManufacturerName, Model, PatchNumber, and VersionNumber. If you do not map these
attributes, then the Normalization Engine cannot normalize the CIs.
Configuring source and target connections

You must define connection parameters (such as host name, port number, user name, and
password) to your external data store and BMC Atrium CMDB. After you create a connection, you
can reuse it for multiple transformations or jobs.
For instructions about creating datastore connections, see the Working with Atrium Integrator data
store connections.
Creating jobs in BMC Atrium Integrator

Use the Integration Builder wizard to create a job or transformation.After you specify the source and
the CIs that you want to import, the wizard makes recommendations on the relationships for the
selected CIs.
For detailed instructions about creating jobs, see Creating a job in Atrium Integrator.
Editing transformations in BMC Atrium Integrator

You can add intermediate steps for cleaning up or manipulating your data before adding it to BMC
Atrium CMDB. Spoon provides support for JavaScript and a wide variety of prebuilt functions.
For detailed instructions about editing transformations, see Editing Atrium Integrator jobs and
transformations.
Configuring normalization in BMC Atrium Core
To configure normalization, complete the following procedures. For more information about
normalization, see Normalization overview in BMC Atrium Core . For detailed instructions about
these procedures, see Typical normalization setup.
1. Configure the normalization settings for datasets, including disabling any Normalization
Features (enabled by default) that should not run.
Define custom rules where needed, such as for Suite Rollup or permissions. You might need
to configure other dataset parameters according to recommendations. See
Recommendations for specific implementation scenarios.
2. If you have created custom classes, you must add and configure them for normalization.
Normalization is not supported for classes that are not derived from BMC_BaseElement.
3.
BMC Atrium Core 9.0
Page 99 of 2268
Home
3. If you know that the product or manufacturer names for CIs in your dataset do not match
those in the Product Catalog, map the incorrect names to the correct ones with the Product
Name Alias form.
4. Create categorization aliases with Catalog Mapping for the following conditions:
If the combination of the values of the Name, ManufacturerName, Model,
Category, Type, and Item attributes is not in the Product Catalog data.
If the combination of values is in the Product Catalog but is not related to the
company for whom the CI is being submitted.
5. Create a job, and specify when the job runs (continuous or batch).
Warning
Do not run more than one Atrium Integrator, Normalization Engine, or
Reconciliation Engine job at the same time. This could cause problems such as
multiple jobs querying or updating the same data.
Configuring reconciliation in BMC Atrium Core
This section aligns with Stage 4, Step 23, "Task 4. Code data import scripts and reconciliation rules
," of the Step-by-Step Guide to Building a CMDB. To configure reconciliation, complete the
following procedures. For detailed instructions, see Reconciling data.
1. Verify standard Identify rules.
Check that the attributes used for identification have unique and consistent values in
the dataset to be reconciled.
If you created custom classes, add them to the standard Identify rules.
2. Verify standard Merge rules.
Check that the dataset has the needed precedence value. By default, new datasets
have a precedence of 100.
If you created custom classes and attributes, add them to standard Merge rules.
3. Create a standard identification and merge job.
If needed, you can customize a Standard Identification & Merge job:
Include a qualification.
Change Continue on Error and Sequence for the activity.
Change identification settings for Production Dataset, Generate IDs, and Exclude
Subclasses.
BMC Atrium Core 9.0
Page 100 of 2268
Home
Change merge settings for the Source Dataset, Target Dataset, Precedence
Association Set, Include Unchanged CIs, and Merge Order.
To customize the Identify and Merge rules, see if you can modify the standard rules. If
modifying the standard rules is not possible, you can create a custom reconciliation
job with custom rules as needed.
4. Specify when the job runs, either with a schedule or by using continuous mode.
Warning
Do not run more than one Atrium Integrator, Normalization Engine, or
Reconciliation Engine job at the same time. This could cause problems such as
multiple jobs querying or updating the same data.
Recommendations
When you configure reconciliation, consider the following recommendations:
Use a Standard Identification & Merge Job if possible.
Test with a small amount of representative data by using a qualification.
Do not run during prime (heavy use) hours.
Consider indexing attributes used in Identify rules. Consult your database
administrator to determine what indexes would help you.
Create all your reconciliation definitions at the highest class level possible to take
advantage of inheritance.
After the initial data load into BMC Atrium Configuration Management Database (
BMC Atrium CMDB), perform an Identify activity on the data, selecting the option to
auto-identify the master dataset. This makes sure that your production data has an
identity the first time it is identified against another dataset.
Take advantage of Reconciliation Engine multithreading by breaking up large jobs
into smaller ones and running them concurrently, but limit your number of
concurrent threads to twice the number of CPUs in the server.
To avoid redundant processing, make all Merge activities incremental by setting
Force Attribute Merge to No.
To improve performance, define a private queue on the BMC Remedy AR System
server for use only by the Reconciliation Engine. Make sure you use RPC socket
390698 or 390699.
Reconcile discovered data into your production dataset immediately after your
discovery application loads data into BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 101 of 2268
Home
Regularly review your Identify rules to make sure that they are still appropriate for
your environment, and spot-check instances to confirm that they are being
identified correctly.
Instead of merging multiple discovery sources directly into your production dataset,
merge them into a "consolidated discovery" dataset first. You can compare this
against your production dataset and use the results to generate change requests or
exception reports for any discrepancies.
Importing data to BMC Atrium CMDB
Populating BMC Atrium Configuration Management Database (BMC Atrium CMDB) includes
activities such as importing and filtering data and verifying that each data import is successful. To
import data into BMC Atrium CMDB, complete the following procedures:
1. Create tests to validate your data population.
2. Bring data into BMC Atrium CMDB using BMC Software discovery products.
3. Import data using Atrium Integrator.
4. Add data manually.
5. Validate the results of your data imports.
6. Remove failed-import data from BMC Atrium CMDB.
7. Normalize BMC Atrium CMDB data.
8. Reconcile BMC Atrium CMDB data.
Recommendations
As you prepare to migrate data from existing sources to BMC Atrium CMDB, consider these
recommendations:
Examine your data to make sure that data exists in each category of your current
classification scheme that is being mapped to a class in BMC Atrium CMDB. Do not waste
resources attempting to migrate something that does not exist.
Freeze your current classification scheme a few weeks prior to the migration.
Test the migration with a representative subset of all the classes you plan to use. For
example, import 1,000 computer systems and 1,000 application systems.
When testing, verify both that the contents of several configuration items (CIs) were migrated
correctly and that the correct number of CIs were migrated for each class.
BMC Atrium Core 9.0
Page 102 of 2268
Home
For better performance, take advantage of the multithreaded nature of the BMC Remedy AR
System server when loading your initial data into BMC Atrium CMDB. Either use a
multithreaded process on your loading application or split the data into pieces that can be
loaded by separate instances of your application.
If your loading application will do any searching, create indexes on the fields it searches.
An easy way to load data from many sources is to create BMC Remedy AR System view
forms or vendor forms that point to those sources. You can then use workflow, such as an
escalation, to transfer the data from those forms to the BMC Atrium CMDB forms.
When importing data from a source such as a spreadsheet or comma-separated value file,
you can use a regular BMC Remedy AR System form as an intermediate storage location.
This enables you to use qualifications and workflow to verify that the data made it into the
BMC Remedy AR System, normalize the text in your data, and route it to the appropriate
BMC Atrium CMDB class.
If your source data does not include relationships or includes them only as foreign keys on
CI records, your loading application should analyze the data and create relationships
between appropriate CIs in BMC Atrium CMDB.
Your loading application is responsible for normalizing text in the data you bring into BMC
Atrium CMDB, such as enforcing capitalization and delimiting rules. Data that has not been
normalized is much harder to reconcile.
How Calbro Services discovers their IT environment and imports data

In the process of consolidating their IT departments, Calbro Services plans to populate BMC Atrium
Configuration Management Database (BMC Atrium CMDB) with the data from the various IT
departments. Some IT data resides in spreadsheets or in databases. In some cases, data must be
discovered. This disparate data from various IT departments must be moved to BMC Atrium CMDB
so that Calbro Services has a complete picture of the components in its IT department.
Calbro Services has some existing data in flat files in CSV format. The data in these files will be
transferred to BMC Atrium CMDB with Atrium Integrator.
The remaining data will be discovered with BMC discovery tools.
Calbro Services will use BMC BladeLogic Client Automation to discover hardware and
software inventory information about servers, desktops, laptops, and handheld devices.
Calbro Services will then use BMC BladeLogic Client Automation Configuration Discovery
Integration for CMDB to map the collected information and transfer the configuration items (
CIs) and their relationships to BMC Atrium CMDB.
Calbro Services will use BMC Atrium Discovery and Dependency Mapping to build a
topology of applications and infrastructure including switches, servers, operating systems,
software, configuration files and logs, business applications and dependencies. Calbro
Services will then use the CMDB Sync function of BMC Atrium Discovery and Dependency
Mapping to map the collected information and transfer the CIs and their relationships to BMC
Atrium CMDB.
BMC Atrium Core 9.0
Page 103 of 2268
Home
Creating test cases to validate data population
This section aligns with Stage 4, Step 23, "Task 1. Create use cases to validate data population," of
the Step-by-Step Guide to Building a CMDB .
As you prepare to import data into BMC Atrium Configuration Management Database (BMC Atrium
CMDB), create test cases to verify that the data is being imported successfully. Specifically, test
unidirectional and bidirectional data transfers to make sure that the synchronization and import
processes between the external data store and BMC Atrium CMDB are working correctly.
You should also test the end-to-end run time of import, normalization, and reconciliation using a
small amount of representative data. This enables you to plan your time windows so that these
activities don't overlap in either your initial bulk load or subsequent updates.
Examples of test cases that you can use include the following scenarios:
Creation of new configuration items (CIs) with related attributes and relationships
Creation of relationships for existing CIs
Modification of CI attributes and relationships
Data reconciliation and merging
Deletion of any combination of CI attributes and relationships
Bringing data into BMC Atrium CMDB using discovery tools

BMC Software discovery products, such as BMC Atrium Discovery and Dependency Mapping and
BMC BladeLogic Client Automation automatically discover the configuration items (CIs) in your IT
environment and populate that data into BMC Atrium Configuration Management Database (BMC
Atrium CMDB) datasets. If you are using these products, begin using them to bring data into BMC
Atrium CMDB.
Importing data using Atrium Integrator
This section aligns with Stage 4, Step 23, "Task 5. Perform data import," of the Step-by-Step Guide
to Building a CMDB.
You have already configured your job and transformation as described in Configuring Atrium
Integrator for data import. At this point in the end-to-end process, run your jobs and bring the
associated data into BMC Atrium Configuration Management Database (BMC Atrium CMDB).
For detailed instructions about running jobs, see Importing data with Atrium Integrator.
BMC Atrium Core 9.0
Page 104 of 2268
Home
Adding data manually
This section aligns with Stage 4, Step 23, "Task 9, Input additional data manually," of the
Step-by-Step Guide to Building a CMDB . Although you are discovering configuration items (CIs)
and their attributes automatically through discovery, you might need to manually enter additional
data in the following situations:
You want to add CIs that are not discovered. Some functions of BMC Asset Management,
such as creating a purchase requisition, create a CI, even if the CI might later be discovered.
You want to update CIs with attributes that are not discovered.
You must manually add business services that are used in the Service Catalog.
You want to create relationships that are not discovered.
You want to enter additional Asset Management information.
Do not edit CIs directly in the BMC.ASSET dataset. Instead, use BMC Atrium Explorer and the
sandbox dataset to add and modify CIs and relationships. This makes sure that edits are reconciled
and the production dataset accurately represents your environment. These changes are ultimately
used by consumers such as BMC Asset Management.
Adding CIs to BMC Atrium CMDB manually
Updating CIs with attributes
Adding relationship information that is not discovered
Adding CIs to BMC Atrium CMDB manually

Some CIs are not discovered, so plan to enter some CIs manually. Without planning, ad hoc entry
of CIs can lead to inconsistency in BMC Atrium Configuration Management Database (BMC Atrium
CMDB). If the CIs are not discovered, reconciliation with discovered CIs is not an issue.
For instructions about manually entering CIs, see Creating CIs in BMC Atrium Explorer .
Updating CIs with attributes

To maintain CI attributes that are not discovered, such as asset lifecycle dates or cost, you can also
enter them manually. You can also manually update attributes that are populated by discovery. For
example, if a video card is being repaired, you might want to change the status from Deployed to In
Repair.
If you manually update attributes that are populated by discovery, these attributes might get reset
during reconciliation, based on precedence rules. Because the BMC Asset dataset is the
production dataset, changes made to this dataset take precedence over attributes that are
discovered.
BMC Atrium Core 9.0
Page 105 of 2268
Home
For instructions about manually updating attributes on CIs, see Editing CIs and relationships in
BMC Atrium Explorer.
Adding relationship information that is not discovered

You might want to create relationships that are not discovered, such as people and support groups
responsible for an asset or relationships of business services.
For instructions about manually entering relationship information, see Creating relationships
between CIs.
Validating data import results
This section aligns with Stage 4, Step 23, "Task 6. Validating import results," of the Step-by-Step
Guide to Building a CMDB.

Follow the test cases that you created in Creating test cases to validate data population to verify
that your data has been imported correctly.
Use the Atrium Integrator job monitoring console to confirm whether a data transfer has finished
successfully. You can also check log files. By default, the generation of debug logs for Atrium
Integrator data transfers is enabled. On Microsoft Windows, the log files are stored in the <
installationDirectory>\server\data-integration\bin\error\ <jobName_TranformationName>
Error.txt file.
For more information about logging and debugging, see Atrium Integrator issues.
For more information about job monitoring, see Monitoring jobs in Atrium Integrator.
Removing failed import data from BMC Atrium CMDB
This section aligns with Stage 4, Step 23, "Task 7. Removing failed import data from the CMDB," of
the Step-by-Step Guide to Building a CMDB .
If your test cases detected a problem with a data transfer, remove the erroneous data from the
BMC.IMPORT.CONFIG dataset or the BMC.ADDM dataset.
BMC Atrium Core 9.0
Page 106 of 2268
Home
Normalizing BMC Atrium CMDB data

Before reconciliation, normalize your data to resolve the differences in naming and categories. For
more information about the Normalization Engine, see Normalization overview in BMC Atrium Core
and Normalizing data.
Reconciling BMC Atrium CMDB data

Reconcile your BMC Atrium Configuration Management Database (BMC Atrium CMDB) data to
compare expected data against discovered data, and to create one complete and correct
production dataset.
Reconciliation must begin by identifying the matching instances in all datasets. After they have
been identified, you can perform several activities on the matching instances, but the most common
are:
Comparing them and either creating a report on the differences or executing workflow
against them
Merging them into a new dataset based on precedence values that you have defined for
each source dataset
For details about reconciliation activities, see Reconciling data.
Recommendations for specific implementation scenarios

For specific scenarios, BMC recommends particular settings for Atrium Integrator, Product Catalog,
Normalization Engine, and Reconciliation Engine.
Recommendations for bulk loads
Recommendations for incremental loads
Recommendations for BMC Atrium Explorer edits
Recommendations for BMC Remedy ITSM manual edits
Recommendation for scheduling

Importing your data into BMC Atrium Configuration Management Database (BMC Atrium CMDB),
normalizing it, and reconciling it must happen separately, so do not schedule any overlap in these
processes. For example, reconciliation will result in errors for a group of related configuration items
(CIs) such as a computer system and its components if not all of the CIs and relationships in the
group have yet been imported.
Recommendations for bulk loads

When you are loading a large amount of data, such as an initial load, into BMC Atrium
Configuration Management Database (BMC Atrium CMDB), use the following guidelines. The
objective is to provide a starting point with normalized and reconciled data, using batch jobs. After a
bulk load, you can decide how to normalize changes to the data (batch, inline, or continuous
normalization).
BMC Atrium Core 9.0
Page 107 of 2268
Home
Recommendations for bulk load

Component
Tasks
Atrium
Integrator
When transferring a large amount of data, use parallel processing with a different Atrium Integrator
instance per exchange.
For an attribute that is used as a primary key or as a relationship key, create a separate index in
BMC_BaseElement.
Database/External Data Store can have an index on the column that is the Primary Key.
Check the log files and confirm that there are no errors, especially data errors.
Product
Catalog
Verify that Product Catalog data is current and accurate.
Normalization
Engine
Turn on normalization across all datasets into which you are loading bulk data.
Create a batch normalization job. Use the batch job after the data is loaded into the import dataset. Then,
use the reconciliation batch job to merge the normalized data to a different dataset.
Do not modify the default dataset configurations.
Note: Do not enable the Allow new Product Catalog entry parameter because it could result in
duplicate entries for the same product.
Do not allow an installer to start normalization jobs because the standard reconciliation Identify and Merge
rules are not sufficient to reconcile only normalized configuration items (CIs).
Reconciliation
Engine
Create a batch reconciliation job. After the import dataset has been normalized, use the batch reconciliation job to
merge the normalized data to a different dataset.

After you have loaded initial data, use the following guidelines to normalize and reconcile changes
to the data.
Component
Tasks
Atrium
Integrator
Check the log files and confirm that there are no errors, especially data errors.
Product
Catalog
Normalization
Engine
Turn on normalization across all datasets into which you are loading bulk data.
Create a continuous normalization job to normalize changes and additions to the import dataset.
Do not modify the default dataset configurations.
Note: Do not enable the Allow new Product Catalog entry parameter because it could result in
duplicate entries for the same product.
Reconciliation
Engine
Create a continuous reconciliation job. After the initial reconciliation, the continuous job identifies and merges new
and changed configuration items (CIs) in the import dataset.
BMC Atrium Core 9.0
Page 108 of 2268
Home

When modifying configuration items (CIs) in BMC Atrium Explorer, use the following guidelines.
When you promote a CI, it is reconciled using a standard Identify and Merge job.
Component
Tasks
Atrium
Integrator
Not applicable
Product
Catalog
Normalization
Engine
Verify that Catalog Mapping aliases are current and accurate.

If normalization is turned off across all datasets, do not turn on normalization.
Configure the normalization settings for the dataset where the manual edits are made:
Normalization Type: Name & CTI lookup
Inline Normalization: Enabled
Allow Unapproved CI: Disabled
Allow new Product Catalog entry: Disabled In the edit form that appears in a failed normalization,
you must know which attributes are required and what values are valid.
If the Product Catalog has no entries for hardware or other classes, disable normalization for those classes
by deleting them from the Class Configuration tab in the Configuration Editor. You can add the class later,
if needed.
Reconciliation
Engine
Create a reconciliation job for the specific user sandbox to start manually; do not create a schedule or select
Continuous for the job.

When modifying configuration items (CIs) from the BMC Remedy IT Service Management suite,
use the following guidelines.
Component
Tasks
Atrium Integrator
Not applicable
Product Catalog
Configure the normalization settings for the specific user sandbox where the manual edits are made:
Normalization Type: Name & CTI lookup
Inline Normalization: Enabled
Allow Unapproved CI: Disabled
Allow new Product Catalog entry: Disabled
Reconciliation Engine
BMC Atrium Core 9.0
You can use the existing reconciliation job for the BMC Remedy ITSM sandbox.
Page 109 of 2268
Home
Managing BMC Atrium Core

This section describes the administrative tasks that help you manage your implemented BMC
Atrium Core solution.
The following topics are provided:
Tracking changes to CIs and relationships
Deleting CIs that are no longer discovered
Custom workflow
Tracking changes to CIs and relationships

BMC Atrium Configuration Management Database (BMC Atrium CMDB) takes advantage of the
auditing feature of BMC Remedy AR System to track changes to instance data. You enable BMC
Atrium CMDB auditing on a per-class basis, and you select which attributes trigger an audit and
which are written as a result.
An audit is triggered when an instance is created or deleted or when the value of one or more
selected attributes changes as the result of an instance being modified.
Auditing versus the Compare Dataset activity
Types of auditing
Selecting which instances and attributes are included in an audit
Receiving CI change events with Event Channels
You can view audit results from the View History link on the BMC Atrium Core Console. For
instructions about viewing instance history, see Viewing instance history in BMC Atrium Explorer .
Auditing versus the Compare Dataset activity

Auditing is not the only way to track changes to configuration items (CIs) and relationships. If you
use BMC Asset Management with BMC Atrium Configuration Management Database (BMC Atrium
CMDB), you could instead track changes with the Compare Dataset reconciliation activity.
You must have the Sandbox dataset (BMC.ASSET.SANDBOX) enabled in BMC Asset
Management, so that user edits to a CI are saved to the Sandbox dataset. Then you can create a
reconciliation job with a Compare Dataset activity that compares the Sandbox to BMC Asset,
looking for the particular differences that you want to catch. You could then perform custom
workflow against instances found by the comparison.
Recommendations
Keep these considerations in mind when deciding which method to use for tracking the changes to
your CIs and relationships:
Audits give you access to information about changes to your data as soon as they happen,
whereas comparisons are usually run daily.
BMC Atrium Core 9.0
Page 110 of 2268
Home
Audits take a small amount of processor and disk time at the moment a change occurs,
slightly slowing down real-time performance for users, whereas comparisons concentrate
that performance hit during a non-peak window.
If you have auditing enabled on your production dataset, it can increase the time required for
reconciliation because Merge activities that write to the dataset trigger audits.
Audits provide a better long-term view of the history of a CI than do comparisons.
Comparisons are better when you need to track changes to multiple attributes because this
has a larger performance cost, and the cost can be absorbed during a non-peak window.
Comparisons provide flexibility in executing workflow when a change occurs.
Given these considerations, audits are usually better for keeping a history, and comparisons are
better for alerting you to changes that require investigation.
Types of auditing
You can audit by creating a copy of the instance that was created, modified, or deleted, or by
writing the changes to a log .
You cannot use Log auditing above Copy auditing in the inheritance tree. This means that if you
already have Copy auditing enabled for a class you cannot enable Log auditing for any of its
superclasses, and if you already have Log auditing enabled for a class you cannot enable Copy
auditing for any of its subclasses. This is due to the structure of audit forms.
Recommendations
Copy auditing
Log auditing
How Calbro Services uses auditing
Recommendations
Keep these considerations in mind when deciding whether to use Copy or Log auditing:
Copy audits degrade performance more than Log audits because their structure matches
that of the actual BMC Atrium Configuration Management Database (BMC Atrium CMDB)
class forms, which use database joins. Also, because those join forms must be created
when Copy auditing is enabled, there is a bigger performance cost at that time and possibly
more disruption related to your change control procedure.
Copy audits provide a more powerful search capability than Log audits because you can
search on each attribute in a separate field.
BMC Atrium Core 9.0
Page 111 of 2268
Home
Copy auditing
Copy auditing creates a copy of each audited instance. When you enable Copy auditing for a class,
each form pertaining to that class is duplicated to create audit forms that hold audited instances.
This includes forms from superclasses, because they hold data for instances of their subclasses.
The audit forms are automatically named with the suffix :AUDIT. For example, if you enable
auditing for the BMC_Person class, which is a subclass of the BMC_BaseElement class, three
audit forms are created:
Audit forms created for BMC_Person
Form type
Class form
Audit form
Regular
BMC.CORE:BMC_BaseElement
BMC.CORE:BMC_BaseElement:AUDIT
Regular
BMC.CORE:BMC_Person_
BMC.CORE:BMC_Person_:AUDIT
Join
BMC.CORE:BMC_Person
BMC.CORE:BMC_Person:AUDIT
The audit forms have the same BMC Remedy AR System permissions as the class itself. If you
make a change to a class after these forms have been created, they are automatically updated to
match. When you delete a class, its associated audit forms are also deleted.
Each audit of each instance results in an entry in the audit form, so multiple entries can be related
to a given instance.
The audit form mirrors the class form, containing a field for each attribute in the class. When an
audit occurs, values for the selected attributes are written to their respective fields, creating a new
copy of the instance.
In addition to the class attribute fields, each audit form also includes the following fields:
Audit Join Key A GUID representing the specific audit entry.
Fields Changed (multiple) A field is created for each Audit attribute and Audit and
Copy attribute to specify whether that attribute value changed in the audited instance. If such
an attribute changed value, its corresponding Fields Changed field in the audit form contains
a 1. If not, the field is empty. The name of each Fields Changed field is F_ fieldId_C, using
the field ID of the attribute on its class form.
Copy attributes and None attributes do not have Fields Changed fields in the audit form because
they cannot trigger an audit.
Audit Date The timestamp of the audit.
User The user who performed the action that triggered the audit
Action An integer representing the action that triggered the audit. The following table lists
the possible values and their meanings:
Audit actions
BMC Atrium Core 9.0
Page 112 of 2268
Home
Action field value
Instance action
Modify
Create
Delete
16
Merge
When an audit is triggered, the audited instance is copied from each class form to the
corresponding audit form.
Note
When auditing is enabled for a class, audits can be triggered by instances of either the
class or its subclasses, even if auditing is not enabled for the subclasses. This is due to
the hierarchical structure of class forms. When an audit is triggered by an instance of a
subclass, only the attributes of the audit-enabled superclass are written to the audit form.
You can avoid subclass instances triggering an audit by using an audit qualification that
matches the class ID of the superclass.
Copy auditing in BMC Atrium CMDB is implemented using BMC Remedy AR System form-style
auditing. For more information about form-style auditing, see Developing an application in the BMC
Remedy Action Request System online documentation.
Log auditing
Log auditing creates an entry in a log form that stores all attribute values from the audited instance
in one field. When you enable Log auditing for a class, you specify the name of the log form to use.
If this form does not already exist, it is created automatically. You can use the same log form with
multiple classes.
Each Log audit form includes these fields:
GUID The InstanceId of the audited instance.
Log Key1 The ClassId of the audited instance.
Log Key2 The DatasetId of the audited instance.
Fields Changed A list of the attributes with values that changed in the action that
triggered the audit, in the format name1; name2; name3. This field is not populated when the
Action is Delete.
Log A list of the attribute values written for the audit, in the following format:
name1: value1
name2: value2
[ name3: value3]
Audit Date The timestamp of the audit.
BMC Atrium Core 9.0
Page 113 of 2268
Home
User The user who performed the action that triggered the audit.
Action An integer representing the action that triggered the audit. The following table lists
the possible values and their meanings.
When an audit is triggered, an entry is created in the log form. For information about selecting
attributes to write to the Log field, see Setting the Audit option for attributes .
Log auditing in BMC Atrium CMDB is implemented using BMC Remedy AR System log-style
auditing. For more information about log-style auditing, see Developing an application in the BMC
Remedy AR System online documentation.
How Calbro Services uses auditing

The Calbro Services administrator knows that changes to the service model can be disruptive to
the customers using those services. To help identify all of the changes to business services and the
supporting technical services, the administrator decides to audit the BMC_BusinessService class
.
Copy auditing this class should not affect overall system performance because changes to the
BMC_BusinessService class should be few in number. Copy auditing also enables greater ability
to search for changes to the class. For these reasons, the administrator configures copy auditing
instead of log auditing.
Selecting which instances and attributes are included in an audit

You can restrict which instances of a given class are audited and determine which attributes can
trigger an audit and are written in an audit.
Restricting audited instances with a qualification
Setting the Audit option for attributes
Recommendations
Restricting audited instances with a qualification

You restrict which instances are audited by specifying an audit qualification for each class that has
auditing enabled. If an instance does not match the qualification, an audit cannot be triggered for it.
However, a superclass with auditing enabled can alter the effect of an audit qualification. If an
instance of an auditing-enabled class fails the audit qualification for that class but matches the audit
qualification of an auditing-enabled superclass, the attributes of the instance that are inherited from
the superclass are audited.
For example, if auditing is enabled for both BMC_System and BMC_ComputerSystem, and an
instance of BMC_ComputerSystem fails its own audit qualification but matches that of
BMC_System, the attributes of BMC_System are audited for the instance. If BMC_System did not
have auditing enabled, no part of the instance would be audited.
BMC Atrium Core 9.0
Page 114 of 2268
Home
Setting the Audit option for attributes

For each attribute in a class, you can choose one of the following Audit options:
None Changes to this attribute do not trigger an audit. NULL is written to the attribute in
the audit form in a Copy audit, and nothing is written to the Log field in a Log audit. This
option is the default.
Audit Changes to this attribute trigger an audit, and the attribute value is written to the
audit form or log form. When another attribute triggers an audit, this attribute is not written.
Copy Changes to this attribute do not trigger an audit, but the attribute value is written to
the audit form or log form when another attribute triggers an audit.
Audit and Copy Changes to this attribute trigger an audit. This attribute value is written to
the audit form or log form in any audit, regardless of whether its value changed.
Note
As long as a class has at least one attribute with the Audit, Copy, or Audit and Copy
option specified, a Create or Delete operation triggers an audit regardless of the values of
the attributes. Audit, Copy, and Audit and Copy attributes are all written during such an
audit.
The following table shows whether certain operations to a sample instance, taken in chronological
order, trigger an audit. It assumes an instance that matches the audit qualification for its class.
Audit life cycle of a sample instance

Operation
order
Operation
Attribute1 (
Audit)
Attribute2 (
Copy)
Attribute3 (Audit
and Copy)
Attribute4 (
None)
Audit
triggered?
Attributes written to
audit form
Create
NULL
Chicago
NULL
Compact
disc
Yes
Attribute1 Attribute2
Attribute3
Modify
Green
Chicago
NULL
Cassette
tape
Yes
Attribute3
Modify
Green
Dallas
NULL
8-track tape
No
None
Modify
Green
Dallas
Bicycle
8-track tape
Yes
Delete
N/A
N/A
N/A
N/A
Yes
Attribute3
In this example, Audit attribute Attribute1 and Audit and Copy attribute Attribute3 are the
only attributes that can trigger an audit. However, when the instance is created, an audit is
triggered regardless of the fact that they are both NULL.
BMC Atrium Core 9.0
Page 115 of 2268
Home
When the instance is modified in Operation 2, the value of Attribute1 changes, triggering an
audit that writes that attribute. Attribute2 and Attribute3 are also written, as they are in any
audit. Both Attribute2 and Attribute4 change value in Operation 3, but no audit is triggered.
In Operation 4, Attribute3 changes value and another audit is triggered. This time Attribute1
is not written because its value did not change. And when the instance is deleted in Operation 5, a
final audit is triggered.
Recommendations
This section gives you several recommendations for working with auditing.
Enable auditing for only up to five classes, as high on the inheritance tree as possible and
preferably no more than five join levels deep. For each of those, use only up to five Audit
attributes.
Do not audit system attributes like LastModifiedBy or ModifiedDate if you use Log
auditing. BMC Remedy AR System keeps a history of these already.
Rather than auditing a lower-level class in your data model inheritance tree, audit the
highest-level class with attributes you want to keep and then use a qualification on the
ClassId attribute to control which classes' instances are audited. This improves
performance by preventing join forms from being involved.
For example, imagine that you want to audit instances of BMC_ComputerSystem,
BMC_OperatingSystem, and BMC_ApplicationSystem ; you want to trigger an audit
only if the value of the OwnerName attribute changes; and you want to write OwnerName and
Name to the audit form or log form. Because OwnerName and Name are both inherited from
BMC_BaseElement, you would enable auditing for that class and use a qualification on
ClassId to select only the subclasses that you want.
Use a qualification on the DatasetId attribute to restrict auditing to your production dataset
. You rarely need to audit other datasets, so you will save processor time and disk space.
When a component such as a disk drive disappears from the display of its parent
configuration item (CI) such as a computer system in BMC Asset Management, it is usually
caused by the connecting relationship being unintentionally soft-deleted while the component
CI still exists. To track this behavior, enable auditing on BMC_BaseRelationship (with a
qualification on source and destination class IDs if you want), use MarkAsDeleted as an
Audit attribute, and use the source and destination instance IDs as Copy attributes.
Not every Copy attribute must also be an Audit attribute.
Receiving CI change events with Event Channels

Applications that rely on configuration item (CI) and relationship data stored in BMC Atrium
Configuration Management Database (BMC Atrium CMDB) sometimes need to know whether CIs
and relationships have been created, updated, or deleted. For example, you might provide an email
service using multiple servers. Your email service monitoring application might have the logic to
identify the potential impact to the service of changes to the servers, but to apply this logic it must
be notified of such changes.
BMC Atrium Core 9.0
Page 116 of 2268
Home
The BMC Atrium Event Channels component enables applications to subscribe to and receive
events using the BMC Atrium CMDB Java API. Events are generated when CIs and relationships
are created, updated, or deleted in your production dataset, which defaults to BMC Asset. This
means your application is notified of changes to your CMDB in near real time instead of it having to
poll for changes periodically.
Enabling and disabling Event Channels
Class configurations
Event subscriptions
Performance considerations
Interfaces to BMC Atrium Event Channels
Permission roles
Enabling and disabling Event Channels

The Event Channels feature is disabled by default. To enable it, find the following line to your ar.cfg
(Windows) or ar.conf (UNIX) configuration file and change the setting from F to T. The BMC Atrium
Core installer adds this option to the configuraiton file.
Event-Channel-Enabled:F
You must restart your BMC Remedy AR System server for the change to take effect.
For more information about the ar.cfg or ar.conf configuration file , see Configuring after
installation in the BMC Remedy Action Request System online documentation.
Warning
The Event Channels feature uses the Filter API plug-in of BMC Remedy AR System, and
occasionally this use can interfere with Reconciliation Engine processing. To avoid
reconciliation jobs hanging, if you use Event Channels then set your BMC Remedy AR
System server's Filter API RPC Timeout to 240 seconds. To make this setting, from the
Home page choose AR System Administration > AR System Administration Console
> System > General > Server Information > Timeouts .
Class configurations
You must configure a class for events before a subscription will deliver events for the class. The
following classes are preconfigured for events:
BMC_ComputerSystem
BMC_BusinessService
BMC_Application
BMC_SoftwareServer
BMC Atrium Core 9.0
Page 117 of 2268
Home
BMC_IPEndPoint
These class configurations cannot be deleted. You can configure other classes for events. For
instructions, see the BMC Atrium CMDB Javadoc Help.
Event subscriptions
When subscribed, your application receives events in near real time whenever an instance of a CI
or relationship class configured for events is created, updated, or deleted.
If an instance is deleted, events indicate that the instance was deleted. If the instance is marked for
deletion (by setting the MarkAsDeleted attribute to Yes), events indicate that the instance was
modified.
Instructions for subscribing to events are in the BMC Atrium CMDB Javadoc Help. Events include
the following information about the instance in question:
Class ID and namespace
Instance ID
Dataset ID
Event type (Create, Update, or Delete)
BMC Atrium Event Channels applies the following security checks before sending events:
Row-level check to make sure that the subscriber has the permission to view the relevant CI
class
Multitenancy check to make sure that the event is being delivered to a subscriber with the
authority to view the relevant CI class
If a subscriber application disconnects, events are queued for delivery when it reconnects. Events
that are undelivered for a day are removed, and you would then need to re-sync with BMC Atrium
CMDB using the CMDB API.
Note
Each subscribed application must have a unique BMC Remedy AR System user ID for the
Event Channels feature to work correctly. In a case where multiple instances of an
application subscribe to events, each instance must use a different user ID to receive
events independently of the other instances.
Performance considerations
The event generation rate is limited by the combined throughput of the Normalization Engine,
Reconciliation Engine, and BMC Atrium CMDB engine.
BMC Atrium Core 9.0
Page 118 of 2268
Home
When the BMC Atrium CMDB server is heavily loaded, change events might be generated faster
than the rate at which the server can send them. In such a case, the events are queued. At times of
intermittent load conditions (say for a few minutes), the queue might provide sufficient buffering, but
for a longer load period it might not. When performing a bulk load of BMC Atrium CMDB, consider
turning off event generation or event delivery to avoid overflowing the queue.
You can improve the speed at which the server delivers events by increasing the number of Alert
threads on your BMC Remedy AR System server. To set the number of threads, from the Home
page choose AR System Administration > AR System Administration Console > System >
General > Server Information > Ports and Queues . In the table row for the Alert queue, set Min
Threads to 5 and Max Threads to 10.
Interfaces to BMC Atrium Event Channels

You can configure classes, subscribe to BMC Atrium Event Channels, and turn off event generation
or event delivery through the BMC Atrium CMDB Java__ API. For information, see the BMC Atrium
CMDB Javadoc Help. You configure classes for events with the ECUtil.java class and subscribe to
events with the CMDBEventSubscription.java class.
Permission roles
To subscribe to events, you must have the CMDB Console User role. To configure classes for
events, you must have the CMDB Console Admin role.
Deleting CIs that are no longer discovered

Occasionally, your discovery application will not discover a configuration item (CI) or that it regularly
discovered before. Though you might be tempted to delete the CI from BMC Atrium Configuration
Management Database (BMC Atrium CMDB), do not do so right away. Usually such a missing CI is
only temporarily removed or unavailable, such as when a computer system is shut down while its
owner is on vacation.
Instead of deleting the instance from BMC Atrium CMDB, known as hard deleting, mark it as
deleted. This is known as soft deleting, and you perform it by setting the MarkAsDeleted attribute
to Yes. Soft deleting has two benefits:
When instances have been soft deleted, you can exclude them from searches, reconciliation
, and other activities by using the MarkAsDeleted attribute in your qualifications.
Soft deleting preserves relationships and reconciliation identity in case a CI is later
discovered again.
Establish a policy that specifies how long a CI can remain soft deleted. If it is rediscovered before
reaching the end of that interval, you can reset the MarkAsDeleted attribute to NULL. If not, you
can hard delete the CI.
The Reconciliation Engine offers a Purge activity that deletes soft-deleted instances. For more
information about this feature, see Other reconciliation activities.
BMC Atrium Core 9.0
Page 119 of 2268
Home
Custom workflow
Because BMC Atrium Configuration Management Database (BMC Atrium CMDB) is built on the
BMC Remedy AR System, you can easily add custom workflow to the class forms to accomplish
various tasks. For information about creating BMC Remedy AR System workflow, see Defining
workflow to automate processes in the BMC Remedy Action Request System online documentation
.
Calbro Services' custom workflow for viewing unreconciled CIs
Filter execution order
Recommendations
Calbro Services' custom workflow for viewing unreconciled CIs

Calbro Services has a process that involves creating computer system configuration items (CIs)
manually in the production dataset. These new CIs have no reconciliation identity, and the
administrator wants a visual cue when viewing a CI that it has not yet been reconciled with CIs
imported by using Atrium Integrator, or with data discovered by BMC BladeLogic Client Automation
or BMC Atrium Discovery and Dependency Mapping.
To satisfy this requirement, the administrator creates custom workflow that changes the label color
of the Name attribute to red when an unreconciled CI is displayed.
Filter execution order

BMC Atrium CMDB uses two BMC Remedy AR System filters that act on all class forms. Each filter
triggers processing by the BMC Atrium CMDB engine on the instance that is created, modified, or
deleted. One filter is at execution order 100, and one at execution order 600.
Execution order 100 Performs validation, sets the instance ID and class ID for new
instances, and for relationship instances also sets the reconciliation ID, dataset ID, and class
ID.
Execution order 600 Performs hard and soft deletes, pushes attribute values to subclass
forms, handles weak relationship functionality, and for new instances adds default instance
permissions.
To create a filter on a class form, choose its execution order based on these filters. In most cases,
you should choose an execution order from 101 to 599. This enables your filter to work with the
class ID and instance ID that are created at execution order 100 and to modify attribute values
before they are pushed to subclass forms.
Warning
If your workflow modifies attribute values after execution order 600, it can compromise
your data integrity.
BMC Atrium Core 9.0
Page 120 of 2268
Home
You might choose an execution order of 99 or less to create your own instance ID instead of letting
the system create it automatically.
Recommendations
When planning to add custom workflow to BMC Atrium CMDB, follow these recommendations:
First, identify the scope of your customization. Should it apply to all subclasses, all datasets,
all data inputs, or a subset of these?
Do not modify any of the existing filters attached to the class forms. They are typically
attached to many forms, and your changes could ripple to unwanted locations.
Add active links to an application that consumes BMC Atrium CMDB data instead of to BMC
Atrium CMDB itself. For example, if you have BMC Asset Management, add your active links
to the AST: forms. Add filters and escalations to the BMC Atrium CMDB class forms.
Consider the subclasses of any class you touch. For example, workflow defined on the
BMC.CORE:BMC_BaseElement form applies to all CIs unless you restrict it to particular
subclasses with a Run If qualification.
Remember the scope you identified for the customization.
Document all customizations.
Taking Your Data Into Production End to End video

From a high level, this video shows you the end-to-end steps that are required to take your data
into production with BMC Atrium Core from a third-party source to your production dataset in
BMC Atrium Configuration Management Database (BMC Atrium CMDB). The video runs
approximately 12 minutes.
Taking your Data Into Production End to End
BMC Atrium Core 9.0
Page 121 of 2268
Home
Best practices for BMC Atrium CMDB

The Atrium CMDB is a key enabler in the Business Service Management (BSM) vision as such it is
important to understand what the CMDB is, what it does, what it doesnt do and also how you can
drive value from an implementation of the tool.
Many IT Service Management (ITSM) projects within enterprises focus on the CMDB as a core part
of their implementation, however such initiatives can lead to a focus on the technical wins rather
than drive the business value. In general we do not recommend the CMDB being the initial core
focus for such an implementation. On the contrary, it should be seen as a parallel track that can
augment the other ITIL processes that are enabled by an ITSM implementation initiative.
We have compiled a collection of Best practices around CMDB implementation to help you derive
value. You can implement CMDB with a view to realize business value and enable the CMDB to
enrich and augment an ITSM implementation and deliver true business value.
If you follow the Best Practices documented in the following topics, they will demystify the CMDB,
simplify implementation, and promote a successful approach that is value driven.
What is a CMDB?
What kind of data should go in CMDB?
Loading data into BMC Atrium CMDB
Building a Service Model
Best Practices for the Common Data Model
Best Practices for handling Datasets
Best Practices for handling Normalization
Best Practices for handling Reconciliation
For additional information on Best practices, see
BMC Atrium CMDB Best Practices Video
What is a CMDB?
A CMDB is a database that holds configuration information about devices and logical constructs
within the technical environment. These devices or logical constructs also called as configuration
items could be servers, routers, switches, telephones, mobile devices, laptops, PCs, smoke alarms,
moisture detectors, or street furniture, or they could be more complex, nonphysical entities such as
clusters, virtual machines, or services. A CMDB is used to store the configuration records
throughout the life cycle of the configuration items or CIs. The CMDB stores attributes of the CIs
and their relationships with other CIs. The biggest value derived out of a CMDB is the relationship
information.
BMC Atrium Core 9.0
Page 122 of 2268
Home
The CMDB brings together data and presents it in a common way such that this data can be used
to support processes within the organization. The data can come from automated discovery tools
such as BMC Atrium Discovery and Dependency Mapping, existing data such as spreadsheets, or
data that was manually entered directly into the CMDB via the user interface.
With the information in the CMDB, ITIL processes such as Incident Management and Change
Management can be enriched to allow enhanced value from consuming data that is stored in the
CMDB.
Note
A CMDB is not required to implement Incident Management or Change Management. As
part of the value chain, these processes can be implemented in parallel with a CMDB
implementation.
The following items describe what a CMDB is not:

A place to store real-time operational information such as how much disk space is being
utilized or the current CPU utilization of a server
An inventory tied to Asset Management
A data warehouse
A reporting structure
An entity that works independently
The value of a CMDB is not in collecting configuration items (CIs) from your environment.
CMDB is a repository that should contain only business critical items that you want to track. It
should contain a record of information that allows you to answer business critical questions and
helps you to connect business processes. CMDB should contain all the items that are important for
your business or a service. CMDB gives you a complete view on how these items interact with each
other and how they are related to each other. Put simply, if you have an application that consumes
some data to achieve a business goal, then the data consumed by that application should reside in
CMDB.
Best Practice
The items stored in CMDB should have some purpose.

CMDB is NOT a data warehouse or a reporting tool. CMDB is not going to do
anything with the data after you load it in. CMDB gives you a holistic view of the
data and its relationships with the business services.
BMC Atrium Core 9.0
Page 123 of 2268
Home
CMDB does nothing on its own, it provides data model and relationships about the
discovered data for other processes or applications to consume this information
and work with that information.
Expert Speak
What should NOT go in a CMDB:
Every detail about every configuration item such as every registry setting of a
Windows station, this would be a significant performance and scalability bottleneck
to try and hold all data
High volume details not central to the configuration such as network events or traps
they are important, but not central to the configuration of the machine or its
relationships
Transient data such as current CPU utilization or transaction counts, or if the
machine CURRENTLY up or down (vs. the deployment state).
Loading data into BMC Atrium CMDB

After you have installed BMC Atrium CMDB, use the following process to load data into it. Map the
steps to the preceding image to better understand the data-flow process.
Before you begin

1. Identify the primary use cases for which you will use the data from BMC Atrium CMDB. For
example, identify whether you will use the data from BMC Atrium CMDB for Incident
Management, Change Management, or Service Management.
2. After you identify the use case, discover the data from your environment that should reside
in BMC Atrium CMDB to make your primary use cases successful. For example, identify all
the objects and their relationships to each other for the primary use case of Change
Management to be successful, and load them into BMC Atrium CMDB.
3. Perform the Normalization and Reconciliation tasks to add those objects to BMC Atrium
CMDB.
4.
BMC Atrium Core 9.0
Page 124 of 2268
Home
4. After your objects are in BMC Atrium CMDB, you can then add rules related to your
processes.
Loading data
Expert Speak
Do not rewrite everything to use BMC Atrium CMDB immediately

Use existing repositories as discovery sources for BMC Atrium CMDB
This includes any pre-existing stores/CMDBs
Many times these other repositories should remain long term
Consider migration over time as things allow (if appropriate)
If there is unique data in the store that does not belong in the CMDB or if there is
other value in the other stores, keep them long term and interact with discovery
loads and Federated links
Look at some focused area for initial implementation
A specific business service
A specific location
A specific class of things (servers, desktops, .)
Grow into the CMDB dont rush in too fast
BMC Atrium Core 9.0
Page 125 of 2268
Home
Best Practices for loading data into BMC Atrium CMDB

When you load data into BMC Atrium CMDB, you must clearly identify which objects should go into
BMC Atrium CMDB and which should be excluded. Determine the information that you want to hold
about the CIs. For example, if you load servers into BMC Atrium CMDB, you must decide how
many server-related details should go into BMC Atrium CMDB. BMC recommends that you not add
nonconsumed information, which can overload BMC Atrium CMDB. Add only the amount of
information that is useful to you for making business decisions.
The following best practices will guide you when loading data into BMC Atrium CMDB:
Limit the initial load of data for only the primary use cases identified for your environment.
For example, if you have identified your primary use cases to be Incident Management and
Change Management, identify objects or data connected to the incident management and
change management processes, and start your initial load with those objects or that data.
Do not start with your data providers; otherwise, you will include all of the data from your
environment rather than limiting the data to the business service or to process-critical data.
Rather than loading everything from your environment, start by populating the data that the
business consumes. While loading data into BMC Atrium CMDB, always consider the
perspective of the consuming application. Identify the data that the consuming application
will use and that must be monitored and managed.
Do not aim for a complete data load; start with a subset that supports the processes you
want to manage. For example, assuming your primary use case is Incident Management,
you can decide to load the subset of data related to server, software, and desktops, because
you need to monitor that data for a successful Incident Management use case. You can
choose not to load information related to patches or service packs during the initial load.
After you have loaded the initial subset of data to BMC Atrium CMDB, start adding rules and
policies revolving around your primary use cases, such as Incident Management and
Change Management. For example, you can set a rule for the payroll system to be up and
running at all times on payday.
After your primary use cases are satisfied and you have added related rules and policies,
you can then start populating the remaining objects as you start using BMC Atrium CMDB.
After the initial load is complete, BMC recommends that you load only incremental changes.
Do not repeatedly reload all data from a source, because doing so triggers re-normalization
and re-reconciliation all over again and is time-consuming.
If you are using Atrium Integrator to load data, a checksum value is created. During the
incremental data load, if the checksum value matches, the data is not loaded. If the
checksum value does not match, the data is treated as new or changed data, and the data is
loaded into a dataset. For more information about checksum, see Configuring the checksum
value for loading data into BMC Atrium CMDB .
If you are using a tool other than Atrium Integrator to load data, it is important that you have
a method to identify the delta or incremental change.
BMC Atrium Core 9.0
Page 126 of 2268
Home
Information
When setting up BMC Atrium CMDB:
Do not have a CMDB project as a standalone project. Your project will not be
successful.
Always have a project with CMDB in some context.
Never use the production dataset to reconcile data.
Building a Service Model

In order to provide additional value the BMC Atrium CMDB allows for the construction of Service
Models. Service Models allow users of the system to visualize the relationships of CI's back to
services that are consumed, either by systems or by actual users. Due to this the processes such
as Incident Management and Change Management are enriched further because Service Model
allows these participating processes to understand the impact to the consumers of those services
in a more user friendly fashion.
Constructing Service Models in the BMC Atrium CMDB is inherent in the data populated,
normalized and reconciled as part of your data population process as this includes building and
maintaining the relationships between the CI's as such when your data is refreshed so are those
relationships.
Service Modelling is not a special activity that is separate from the data population process but an
inherent part of population the BMC Atrium CMDB with data.
The main activity related to Service Model construction is ensuring that the relationships are in
place, impact attributes are set appropriately - either from the source of the data or managed via
normalization, or manually within the BMC Atrium CMDB as part of your data maintenance
processes and that Service CI's exist for your CI's to be related to in a logical fashion.
Best Practices for the Common Data Model

Before you begin
BMC Common Data Model:
BMC Atrium Core 9.0
Page 127 of 2268
Home
Best Practice
It is best not to begin working in the CDM by extending the CDM to customize the datasets
suitable to your environment.
You should first understand what exists in the CDM, look for suitable datasets from what is
provided out-of-the-box.
Only if you do not find suitable constructs, then extend the CDM.
Warning
You should not create overlays if you need to extend the CDM. BMC Atrium CMDB
does not support overlays. Ideally, all the modifications on the CDM forms must be
done using the Class Manager.
You should map your CIs in the CDM depending on the classes required by the data source
provider.
It is better plan your CDM and have a map to load CDM. Plan in advance how you will
leverage the CDM. You can use the data model to map objects to BMC recommended
mappings. For example, map a desktop to computer systems and not to an equipment.
BMC Atrium Core 9.0
Page 128 of 2268
Home
Use the CDM to map important equipment, CIs, machinery, building or a location to the right
mappings in CDM.
Here are few examples on how to map CIs or equipment in CDM
If you have a coffee machine that is important in your business you map it to the equipment
class, you are successful.
Sometimes Air Conditioners are a critical piece of equipment which need to be tracked. If an
Air Conditioner goes down the data center gets affected. In such case map Air Conditioner
to an equipment class and define a relationship.
Building --> Floor> Data Center--> AC (You can map these relationships in Atrium Explorer)
.
For modelling a cluster, use a cluster class set the relationship to the machinery, the
machinery is connected to the application.
Remember, that the CDM is a dynamically growing model. You should plan your mappings, put
information in CDM and start using it. Treat the CDM like a template, and populate it as per your
requirement. It is not essential to fill out all the classes provided out of the box in CDM.
The BMC Atrium CMDB is able to cope with multiple relationship types such as 1 to 1 relationship,
1 to many relationship , many to many relationship, and many to 1 relationship.
Expert Speak
Key characteristics of Common Data Model are:
Provides a standard for modeling configuration data
Eliminates the confusion and interaction problems between applications/solutions
that have different data layouts and interpretations
Use the elements of the CDM that are required for your business and your
environment
It is likely that not all classes and attributes provided in CDM will be used in your
environment.
Best Practices for handling Datasets

A dataset in BMC Atrium CMDB is used to capture data from different data sources. It is
recommended that each source has its own dataset. This simplifies the process of managing the
data during later processes such as Normalization and Reconciliation.
BMC Atrium Core 9.0
Page 129 of 2268
Home
Before you begin

1. Identified your data sources
2. Created a dataset for each data source that you have identified.
3. Imported your data source content into the relevant dataset.
The image below gives you an overview of the recommended dataset model
Information to consider before working with datasets

Data that comes from a particular data source is written to its own dataset, the best practice
recommends that a dataset is writable only by that data source which populates data into it.
For example, the data brought in by BMC Application Discovery and Dependency Mapping (
ADDM) is written to BMC.ADDM dataset.
BMC Atrium Core 9.0
Page 130 of 2268
Home
Though it is possible to update datasets manually, it is recommended that datasets are

updated through automation. By following the best practice of having a single source per
dataset you improve the data integrity within your CMDB. Access to the data is read-only for
everyone, you can configure to restrict the write ability only to the data source.
It is recommended not to delete datasets (either source or production). Source datasets give
you the information from where that data has been collected or discovered, this information
could prove vital in the long run. You can delete a dataset only in a situation where
immediately after creating a dataset you realize some settings are incorrect. Such a dataset
should not have any information (should be blank) and can be deleted.
Note
The dataset names are configurable and you should give them the appropriate, easily
identifiable names.
Advanced dataset handling

In an environment where you have the need to run reconciliation frequently due to a constant
turnaround in your business you can use some advance dataset handling practices. You can
improve your data integerity by using a dataset hhierarchy
This means that you start with multiple source datasets such as dataset1, dataset2, dataset3,
dataset4, and so on. These datasets are reconciled into datasets such as dataset1.a, dataset2.b,
dataset3.c, dataset4.d and so on. These datasets (1.a, 2., 3,c) are then reconciled into a
pre-production dataset. After the data is reconciled in the pre-production, depending on your
requirement you should recocile the pre-production to the production dataset.
This simplifies the merging and data management, thus improving the data integrity.
Attention
As a best practice, BMC recommends that you do not update the production
dataset directly. The production dataset is the result of the reconciliation process.
As a best practice, BMC recommends that you do not delete any dataset (
production as well as source).
For additional information on setting permissions for datasets, see Managing dataset level
permissions.
Related topics
Architecture of CMS
BMC Atrium Core 9.0
Page 131 of 2268
Home
Best Practices for handling Normalization

Information
To view the best practices video for Normalization, see
Practices
Normalization Engine Best
Before you begin

1. Ensure that you have completed the initial data load,
2. Ensure that the CIs are residing in the respective datasets.
Normalization helps you clean your data and populate the impact information. The Normalization
engine allows you to run validations and integrity check rules on your CIs and makes them more
consistent. For example, you can set Normalization rules to specify that all occurrences of Microsoft
Word, MS Word, Word should be normalized to MS Word thus resulting in data consistency.
Considerations
Ensure that you run Normalization to clean the data, default missing data (if you do not
provide a value for data, Normalization assigns a default value to it), and add impact
information for every CI.
Impact is an attribute available as one of the Normalization features, this attribute should be
populated. For example, if there is a relationship between Computer System and a software
running on it set the impact to 100% when the Computer System goes down the Software
goes down. To add impact information see, Configuring impact normalization rules. This
impact information helps you to maintain your service model as described in Service Model
topic.
BMC Atrium Core 9.0
Page 132 of 2268
Home
The biggest value derived out of the Normalization process is to default the impact
information. If you know the impact of CIs, feed it into Normalization.
It is a myth that Normalization in an inline mode is generally considered detrimental to
performance. It does take the loader longer to run, but then you do not have a stack of CIs
waiting in a batch job to run.
The Atrium CMDB normalizes CI as they arrive. If you are manually creating CIs and have
Normalization in inline mode, it does slow the performance but not to an extent that you will
notice it.The overall performance is the same, it is just a matter of where you spend time
whether to perform inline Normalization or to run a batch job for multiple CIs.
If you are performing real time normalization, best practice is to run reconciliation in real time
for which you should use the continuous mode, see Creating a continuous reconciliation job
to create a continuous reconciliation job.
When you are performing an initial load of CIs, you should not use inline Normalization mode
at dataset level. You should run a batch job. After the initial data load is complete, you can
turn to inline Normalization for the selected Dataset.
Related topics (optional)

Preparing for normalization
BMC Atrium Core 9.0
Page 133 of 2268
Home
Information
To view the best practices video for Reconciliation, see
Practices
Reconciliation Engine Best
Reconciliation identifies, merges, and compares CIs. Purpose of reconciliation is to take disparate
data sources and merge them into a unified view. There are some important best practices to follow
for the identify activity in Reconciliation. Before you start reconciling CIs ensure that you have
performed the tasks listed below.
Before you begin

Ensure that you have completed the initial data load,
Ensure that the CIs are residing in the respective datasets.
Ensure that you have Normalized datasets.
Best Practices
Always perform the identify activity against the source datasets and never against the
production datasets. Do not specify production as a dataset while performing the identify
activity because the CIs in the production dataset are already identified. The production
dataset is the result of the reconciliation activities.
Do not include the production as a source dataset in the merge operation. You should merge
sources to get the resultant production dataset. You should merge sources to get the target
or the production dataset.
Continuous reconciliation should be used only after the initial load of CIs is complete. After
the initial bulk load is complete, if at a later stage you have a changes coming in at a pace at
which you need to have the information regularly updated in Atrium CMDB, use the
continuous reconciliation option. For example, in a virtual environment where you have
frequent changes where you need the information in real time.
Use the appropriate reconciliation mode based on the behavior of the data source. For
example, something that provides continuous updates use a continuous mode, something
that provides batch updates use the batch mode.
BMC Atrium CMDB experts recommend that you use the Defer if NULL feature, this powerful
feature should be uses in conjunction with precedence rules. For a detailed conceptual
information on this feature see, Handling NULL values.
Attention
Ensure parallel reconciliation jobs are not dependent on each other to prevent data
integrity issues.
BMC Atrium Core 9.0
Page 134 of 2268
Home
Related topics
Overview of reconciliation
BMC Atrium Core 9.0
Page 135 of 2268
Home
Planning
Use the following topics to help you plan for a BMC Atrium Core installation and configuration:
Recommended installation environment
BSM installation environment recommendations
System requirements
Planning a CMDB
BMC Atrium Core support for IPv6
For your reference, you can consult the BMC Remedy IT Service Management (ITSM) 8.1
deployment architecture documentation. The BMC Remedy ITSM 9.0 deployment architecture
information will eventually be made available.
Sample deployments
Deployment scenarios and considerations
BMC Atrium Core ports
A typical deployment has BMC Atrium Core with BMC Remedy Action Request System server and
with several BMC applications:
BMC Remedy AR System server
BMC Remedy Mid Tier
BMC Remedy AR System clients
BMC Atrium Core 9.0
Page 136 of 2268
Home
BMC Atrium Core

BMC Atrium CMDB
BMC Remedy IT Service Management Suite
BMC Remedy Asset Management
BMC Remedy Change Management
BMC Remedy Service Desk
BMC Remedy Knowledge Management
BMC Service Level Management
BMC Service Request Management
Sample deployments
This topic describes sample deployments of BMC Atrium Core features.
Deployments on two computers

Example deployment on two computers
The following table depicts an example installation scenario with two computers (A, and B). Web
services features are installed on computer B to handle a heavy web services load.
BMC Atrium Core installation on two computers
BMC Atrium Core 9.0
Page 137 of 2268
Home
Computer
Features installed
Prerequisites
A
BMC Atrium CMDB
Atrium Integrator server
AR System server
BMC Remedy Mid Tier (usually deployed on a separate computer.
BMC Atrium Core Web

Services
Prerequisites as described in the documentation and compatibility

matrix.
Web Services Registry
Deployment scenarios and considerations

The optimum configuration for any given environment depends on the volume and amount of
activity you expect. The following topics provide information to help you choose the appropriate
installation configuration for your environment:
BMC Atrium Core deployment
Atrium Integrator deployment considerations
BMC Atrium Core Web Services deployment
For reference architectures and platform sizing requirements for small, medium, and large Service
Support environments, see the Reference Architecture for BMC Service Support Solutions white
paper available at BMC Support.
BMC Atrium Core deployment

Depending on your business needs, you should consider when to install BMC Atrium Core on a
single computer, on multiple servers, or in a server group.
Installation on a single computer or multiple computers
Installation in an AR System server group
Installation on a single computer or multiple computers

Installation on a single computer is recommended for use in non-production, proof of concept, or
small development environments. It does not represent a typical deployment scenario.
Single or multiple computer installation
If you expect
BMC recommends that you
To use BMC Atrium Core as a proof of concept
Install BMC Atrium Core on a single computer containing BMC Remedy Action
Request System (BMC Remedy AR System).
Heavy web service activity

Greater than 50 concurrent users with
more than minimal expected throughput
BMC Atrium Core 9.0
Install the BMC Atrium Core Web Services components together on one
computer and other BMC Atrium Core features on other computers.
Page 138 of 2268
Home
Installation in an AR System server group

An AR System server group consists of two or more AR System servers that share the same
database and are designated to be part of a server group. AR System server groups can be used
to provide scalability, load balancing, and fail-over operations.
Atrium Integrator deployment considerations
Note
Make sure that the XML and CSV files are always locally present on the computer where
Atrium Integrator server is installed. If these files are not locally present on the same
computer where Atrium Integrator server is installed, you do not get the list of files and
fields for the files while creating jobs through the Integration Job Builder wizard.
When to deploy the Atrium Integrator server

When to deploy the Atrium Integrator client
Atrium Integrator deployment scenarios
Deployment scenario
Security considerations
Single site deployment
Mid tier must have access to database ports of third-party source
Remote job designing and

monitoring
Mid tier must have access to database ports of third-party source
Remote Monitoring
No additional configuration required.
Remote Spoon Designing
To use Atrium Integrator repository, the Spoon must have access to database ports of
third-party source
When to deploy the Atrium Integrator server

To transfer data from an external datastore to BMC Atrium Configuration Management Database (
BMC Atrium CMDB), you must install the Atrium Integrator server on the BMC Remedy AR System
server. When you install the Atrium Integrator server, the Atrium Integrator console is available in
the Applications list on the AR System server home page. The Atrium Integrator console contains
the following components:
Manage Data Stores tool
Integration Job Builder wizard
For more information about installing the Atrium Integrator server on a single computer, in a server
group, or on a remote server, see Installing BMC Atrium Core
in BMC Remedy ITSM Deployment
documentation.
BMC Atrium Core 9.0
Page 139 of 2268
Home
When to deploy the Atrium Integrator client

Deploy the Atrium Integrator client, if you want to use a remote instance of BMC Atrium Integrator
Spoon to transfer data to BMC Atrium CMDB. You can use the AR System installation program to
install only BMC Atrium Integrator Spoon on a remote machine and connect to the repository on the
BMC Remedy AR System server. To use the remote instance of BMC Atrium Integrator Spoon to
transfer data to BMC Atrium CMDB, install the Atrium Integrator client on a computer other than the
one on which the Atrium Integrator server is installed.
For more information about installing the Atrium Integrator client, see Installing BMC Atrium Core
BMC Atrium Core Web Services deployment

BMC Atrium Core Web Services has different components, which give options for how you can
deploy them on one server or separate servers.
Components of BMC Atrium Core Web Services
Web Services Infrastructure on a separate server
Installation with separate BMC Remedy AR System user accounts
Related topic
Components of BMC Atrium Core Web Services

The following features related to web services are available in BMC Atrium Core:
Web Services Infrastructure a modified Apache Axis2 infrastructure
BMC Atrium Core Web Services Web services for BMC Atrium Core functionality
BMC Atrium UDDI Web Services Registry a central service registry (a modified Apache
jUDDI Server) that makes web services available to other services and clients
You can install all the web services components on one computer other than the computer on
which you have installed other BMC Atrium Core features.
Important
When you install web services components on one computer, you must point to the AR
System server on which you have installed BMC Atrium CMDB.
Web Services Infrastructure on a separate server

Install Web Services Infrastructure on its own server in the following circumstances:
You want to install Apache Axis2 components without requiring the presence of a BMC
Remedy Action Request System (BMC Remedy AR System) server or BMC Atrium
Configuration Management Database (BMC Atrium CMDB).
BMC Atrium Core 9.0
Page 140 of 2268
Home
You want to install web services components of other BMC applications that consume
Apache Axis2 components.
For more information about instructions for installing Web Services Infrastructure alone, see
Installing BMC Atrium Core Web Services components on a single computer .
Installation with separate BMC Remedy AR System user accounts

In UNIX environments, if you use one account to run BMC Remedy Action Request System (BMC
Remedy AR System) and a separate account to run the web server, you must be logged in with the
AR System account to install all BMC Atrium Core components except for BMC Atrium Web
Services.
To install BMC Atrium Web Services, you must be logged in with the web server user's account
because the AR System account does not have permission to write files to the web server.
Warning
If the installation is not performed this way and fails, the install cannot be corrected by the
root user because the installer, running as root, does not recognize the temporary files
and system variables set up by the installer with the previous account.
Related topic
BMC Atrium Core ports

This topic lists the default port numbers of BMC Atrium Core components and Atrium Integrator.
BMC Atrium Core default port numbers
Component
Default Port Number
Is the port number configurable?
Supported port number
NE Plugin port
9555
Yes
any
Atrium Plug-in port
9556
Yes
any
Tomcat HTTP Port
blank
Yes
any
Tomcat HTTPS Port
blank
Yes
any
Note
If you are using a pre-installed Tomcat server, the Tomcat HTTP Port and the Tomcat
HTTPS Port fields are populated with the default port numbers. You cannot change the
value of these fields.
BMC Atrium Core 9.0
Page 141 of 2268
Home
Atrium Integrator default port numbers

Component
Default Port Number
Is the port number configurable?
Supported port number
MS SQL Server
1433
Yes
any
Oracle server
1521
Yes
any
Recommended installation environment

The BSM Reference Stack and BSM Interoperability programs provide information about certified
environments in which you should install this product. For additional information about the
compatible versions of BMC and third-party products for this product, see the BMC Solution and
Product Availability and Compatibility Utility on the Product Availability and Compatibility page (
requires Customer Support logon credentials).
Infrastructure stack
To ensure that you install this product with compatible versions of third-party hardware and
software infrastructure, see BSM Reference Stack 2.1.00. This product was tested and certified to
work with that version of the infrastructure stack.
Application stack
To ensure that you install this product with compatible versions of other BMC applications, see
BSM Interoperability 8.5.1. This product was tested and certified to work with that version of the
application stack. In addition to a list of compatible applications, the BSM Interoperability
documentation also provides a certified installation order for those applications.
BSM installation environment

recommendations
This topic provides information about the environments in which you should install BMC Remedy
AR System 8.1 as certified by the BSM Reference Stack and BSM Interoperability programs . These
programs provide information about validated use cases involving multiple BMC products and the
third-party products that support them. BMC recommends that you install software versions that
have been validated to work together by these programs, but the stacks validated by the programs
do not represent the only possible combinations of products. For additional information about the
compatible versions of BMC and third-party products for BMC Remedy AR System, see Checking
system requirements and supported configurations.
BMC Atrium Core 9.0
Page 142 of 2268
Home
BSM Interoperability
The BSM Interoperability program helps you install compatible versions of BMC products together
by testing an application stack of specific releases and verifying that they work together to
demonstrate key use cases. BMC Remedy AR System 8.1 was certified with BSM Interoperability
8.6.1 and some earlier releases of the application stack.
This section lists the products and applications tested in BSM Interoperability 8.6.1. For more
information such as a certified installation order, see the documentation for that release.
Application stack
The BSM Interoperability 8.6.1 release is compatible with BSM Reference Stack 3.0.
This section contains products and applications have been validated in BSM Interoperability 8.6.1:
Infrastructure platform
Atrium products
Cloud Lifecycle Management products
Service Operations - Application Performance Management products
Service Operations - Data Center Automation products
Service Operations - Proactive Operations products
Service Support products
Mainframe integrations
The patch levels listed were the latest versions available at the time of testing. Patches are
cumulative and compatible except where otherwise noted in product documentation. Required
patches are available on the BMC Customer Support website at http://www.bmc.com/support.
To obtain necessary hotfix files and for more information about hotfixes, contact BMC Customer
Support.
Infrastructure platform
Product name
Version
BMC Atrium
Core:
8.0
BMC
Atrium
CMDB
BMC Atrium Core 9.0
Service
pack or
patch
Function
Provides a configuration management database (BMC Atrium CMDB) coupled with

common user, programmatic, and reporting interfaces to accelerate attainment of BSM.
BMC Atrium CMDB stores information about the configuration items (CIs) in your
IT environment and the relationships between them. Data consumers such as the
BMC Remedy Asset Management product read data from the production dataset.
Page 143 of 2268
Home
Product name
Version
Service
pack or
patch
Function
BMC
Atrium
Integrator
Product
Catalog
Service
Catalog
Atrium
Web
Services
BMC Remedy
The BMC Atrium Integration Engine (AIE) product enables you to transfer data
between an external datastore and BMC Atrium CMDB or the BMC Remedy Action
Request System product.
The Product Catalog provides a normalized reference of software, hardware, and
other types of products and their characteristics that enhance the accuracy of BMC
Discovery products by uniquely identifying a product regardless of installed name
or location.
8.0
Enables the building of powerful business workflow applications which can automatically
Action Request
System
track anything that is important to the processes in your enterprise. Companies use AR
System to track such diverse items as stock trades, benefits data, inventory assets, spare
parts, and order fulfillment. A common use of AR System is to automate the internal help
desk.
7.6.02 1
BMC Atrium
Orchestrator
SP 4
Platform
Delivers workflow-based process templates, with which customers can rapidly adapt and
deploy functional design to ensure consistent and appropriate, policy-based response
across the enterprise.
BMC Atrium
Orchestrator
Content
20.12.03
BMC Atrium
Solution or
suite
Product
name
Version
Service
pack or
patch
Function
BMC
Dashboards
and
Analytics
Suite
BMC
Analytics for
Business
Service
Management
7.6.05.002
Hotfix
Provides out-of-the-box interactive reporting and analysis that enables

technical and non-technical users to quickly examine data for trends and
details associated with how IT is supporting business services and goals.
BMC Atrium
Discovery
and
Dependency
Mapping
BMC Atrium
Discovery
and
Dependency
Mapping
8.3.2.2
BMC
Dashboards
and
Analytics
Suite
BMC
Dashboards
for Business
Service
Management
7.7
7.6.03
BMC
Remedy IT
Service
Management
BMC Service
Level
Management
8.0
BMC Atrium Core 9.0
Provides an automated method for discovering, cataloging, and

maintaining a company's configuration data.
7.6.03
Hotfix 9
Provides highly interactive, timely access to key service support metrics to

help IT management optimize decisions and accelerate the alignment of IT
with business goals.
Enables a service provider, such as an IT organization, a customer

support group, or an external service provider, to formally document the
needs of its customers or lines of business by using service level
agreements, and to provide the correct level of service to meet those
needs.
Page 144 of 2268
Home
Solution or
suite
Product
name
Version
BMC
Remedy IT
Service
Management
BMC IT
Business
Management
8.0
Service
pack or
patch
Function
Provides IT leaders visibility into costs, activities, assets, resources, and

suppliers to effectively manage the IT business and ensure business
alignment.
BMC Cloud Lifecycle Management

Solution or
suite
Product
name
Version
Service
pack or
patch
Function
BMC Cloud
Lifecycle
Management
BMC Cloud
Lifecycle
Management
3.0
SP1 +
hotfix
Provides a complete solution for establishing a cloud environment, including a

Service Catalog that defines service offerings, a self-service console for
procuring resources, and cloud management capabilities.
BMC Cloud
Lifecycle
Management
BMC Atrium
Orchestrator
Content
3.0
patch 2
Content for BMC Cloud Lifecycle Management.
BMC Cloud Lifecycle Management compatibility with BMC Atrium SSO is pending. BMC Cloud Lifecycle Management
is targeting a future release for full compatibility with BMC Atrium SSO. See SW00416103.
Service Operations - Application Performance Management

Solution or
suite
Product name
Version
BMC
ProactiveNet
BMC Transaction Management

Application Response Time,
4.1
Performance
Management
Infrastructure Edition or Service

Level Edition
Service
pack or
patch
Function
Enables you to manage the performance and reliability

of your worldwide applications to measure site health
based on end-user experience metrics, such as
availability, accuracy, and performance.
Service Operations - Data Center Automation

Solution
or suite
Product
name
Version
BMC
BladeLogic
Automation
Suite
BMC
Application
Release
Automation
Enterprise
Edition
BMC
Application
8.2.01
BMC Atrium Core 9.0
Add-on:
8.2.01
Service
pack or
patch
Function
Automates the discrete tasks needed to deploy web applications and

dramatically simplifies the process, making it easier and less expensive for
organizations to leverage web application server technology.
Page 145 of 2268
Home
Solution
or suite
Product
name
Version
Service
pack or
patch
Function
Release
Automation
- Standard
Edition
BMC
BMC
BladeLogic
Automation
BladeLogic
Client
Suite
Automation
NA
BMC
BladeLogic
Client
Automation
Discovery
8.2.01 2
Enables administrators to manage software changes, manage content changes,

configure endpoints, and collect inventory information.
8.2.02
Integrates discovered configuration data with the BMC Remedy IT Service

Management suite of products. This integration enables you to use BMC
Remedy Asset Management, BMC Remedy Change Management, BMC
Remedy Incident Management, and BMC Remedy Problem Management to
access accurate, real-time information about IT infrastructure components across
Integration
for CMDB
your enterprise.
BMC
Bladelogic
Automation
Suite
BMC
Database
Automation
8.2.00
SP 1
Provides the essential capabilities for automated database provisioning and

maintenance, thereby removing bottlenecks in the change and release processes
and freeing Database Administrators (DBAs) to make more valuable use of their
time. As part of the BMC BladeLogic Automation Suite, it provides a
cross-operating system, cross-database vendor solution for automating database
changes and maintaining compliance across your enterprise database platforms.
BMC
BMC
8.2
SP 1
Used with the BMC Database Automation solution to provide extensive reporting
Bladelogic
Automation
Decision
Support --
Suite
Database
Automation
BMC
BladeLogic
Automation
Suite
BMC
BladeLogic
Decision
Support for
Network
Automation
8.2
SP 1
A web-based reporting and analytics tool, used together with the BMC
BladeLogic Network Automation solution to provide extensive reporting
capabilities based on the network devices you manage.
BMC
BladeLogic
Automation
Suite
BMC
BladeLogic
Decision
Support for
Server
Automation
8.2
SP 1
A web-based reporting application that provides extensive report capabilities

related to your data center servers that are managed by BMC BladeLogic. BMC
Service Automation Reporting and Analytics uses rich data warehouse schema
and dimensional modeling principles to access and report on historical data
captured by BMC BladeLogic.
BMC
BladeLogic
Automation
Suite
8.2.01
BMC
BladeLogic
Integration
with Atrium
8.2
SP 1
Enables integration between BMC BladeLogic and Atrium components.
BMC
BladeLogic
Automation
Suite
8.2.01
BMC
BladeLogic
Network
Automation
8.2.02
BMC Atrium Core 9.0
capabilities based on the database devices that you manage.
Manages change, configuration and compliance of network assets.
Page 146 of 2268
Home
Solution
or suite
Product
name
Version
Service
pack or
patch
Function
BMC
BladeLogic
Automation
Suite
8.2.01
BMC
BladeLogic
Server
Automation
8.2
SP 1
Acts as a platform for the management, control and enforcement of configuration

changes in the data center.
2 8.2.00.001 is required if using BMC BladeLogic Client Automation for discovery for software license management use
cases.
Service Operations - Proactive Operations

Solution or
suite
Product name
Version
Service
Pack
Function
or
Patch
BMC
ProactiveNet
Performance
Management
BMC Capacity
Management Capacity
Optimization
9.0
Automatically analyze, forecast, and optimize performance and

capacity across all resources (IT and business) and environments
physical, virtual, and cloud.
BMC
ProactiveNet
BMC Portal,
including
2.9.10*
Provides a common web-based interface for managing and monitoring

your IT infrastructure while monitoring business services.
Performance
Management
BMC Performance
Manager Portal 2.9
BMC
ProactiveNet
Performance
Management
PATROL
Provides monitoring for the BMC ProactiveNet Performance

Management suite.
Agent, KM:
8.6 (7.5.62)
BMC
PATROL
Consoles
and
Infrastructure
7.8.12
BMC
PATROL for
Servers
9.11.00
BMC
ProactiveNet
Performance
Management
BMC ProactiveNet
Core
BMC ProactiveNet
Performance
Management
Reporting
9.0
A real-time analytics solution that detects performance abnormalities in

the IT environment, delivers early warning of degrading performance,
and reduces time from issue detection to resolution. This early warning
is delivered by Intelligent Events that result from analyzing and
correlating data across the monitored IT infrastructure, speeding the
ability to detect abnormal trends before end users and mission critical
applications are impacted. It also provides the users with views,
detailed graph displays, reports and other tools for diagnosing
performance issues.
4.1
BMC Atrium Core 9.0
Page 147 of 2268
Home
Solution or
suite
Product name
BMC
ProactiveNet
Performance
Management
BMC Transaction
Management
Application
Response Time,
either Infrastructure
Edition or Service
Level Edition
BMC
Integration for BMC
ProactiveNet
Performance
Remedy Service
Desk
Version
Service
Pack
or
Patch
Function
Enables you to manage the performance and reliability of your

worldwide applications to measure site health based on end-user
experience metrics, such as availability, accuracy, and performance.
9.0
Patch 1
Provides the integration from certain Service Assurance products to

BMC Remedy IT Service Management.
Management
Service Support
Solution or
suite
Product name
Version
BMC
Remedy IT
Service
Management
Suite
BMC Remedy IT Service

Management:
8.0
BMC
Remedy IT
BMC Remedy
Asset Management
BMC Remedy
Change
Management
BMC Remedy
Service Desk,
including:
BMC
Remedy
Incident
Management
BMC
Remedy
Problem
Management
BMC Remedy Knowledge

Management
Service
Pack
or
Patch
Function
The BMC Remedy Asset Management application lets IT

professionals track and manage enterprise CIs - and their
changing relationships - throughout the entire CI lifecycle.
BMC Remedy Change Management provides IT organizations
with the ability to manage changes by enabling them to assess
impact, risk, and resource requirements, and then create plans
and automate approval functions for implementing changes.
BMC Remedy Service Desk allows IT professionals to manage
incidents, problem investigations, known errors, and solution
database entries.
8.0
Service
Management
Allows users to author and search for solutions in a knowledge

base. It includes a comprehensive editor with extensive editing
tools and a robust search engine that allows users to search for
solutions using natural language or Boolean searches.
Suite
BMC
Remedy IT
Service
Management
Suite
BMC Service Level

Management
BMC Atrium Core 9.0
8.0
Provides a way to review, enforce, and report on the level of

service provided to ensure that adequate levels of service are
delivered in alignment with business needs at an acceptable
cost.
Page 148 of 2268
Home
Solution or
suite
Product name
Version
BMC
Remedy IT
Service
Management
Suite
BMC Service Request

Management
8.0
Service
Pack
or
Patch
Function
Allows IT to define offered services, publish those services in a

service catalog, and automate the fulfillment of those services
for their users.
Mainframe integrations
See the following documentation for information on mainframe integrations:
BMC Atrium Discovery and Dependency Mapping - Discovering Mainframe Computers
Information about using the z/OS agent and BMC Atrium Discovery and Dependency
Mapping to discover mainframe computers.
BMC Impact Integration for z/OS
Information about integration to the BEM/SIM cell architecture within BMC ProactiveNet
Performance Management.
BMC Middleware Monitoring and BMC Middleware Management Transaction Monitoring
Information about the integration of BMC ProactiveNet Performance Management and
middleware monitoring. Specifically, see the Installation Guides and Event User Guides for
these products.
BSM Reference Stack

The BSM Reference Stack program helps you install BMC products with compatible versions of
third-party infrastructure products together by testing an infrastructure stack of specific releases and
verifying that they work together to demonstrate key use cases. BMC Remedy AR System 8.1 was
certified with BSM Reference Stack 2.1.00 and some earlier releases of the infrastructure stack.
This section lists the third-party products tested in BSM Reference Stack 2.1.00. For more
information, see the documentation for that release.
Infrastructure stackThe following tables contain information about the components and products in
BSM Reference Stack.
Infrastructure stack
The infrastructure stack represents the foundational components for the BSM Reference Stack
applications. You can choose to standardize on either the Windows or the Linux stack requirements
.
These guidelines do not represent the only possible infrastructure for BSM applications. Specific
infrastructure requirements can be found in product documentation.
BMC Atrium Core 9.0
Page 149 of 2268
Home
Infrastructure Stack components

Component
Windows
Linux
OS
Windows 2008 R2 (64-bit)
Red Hat Enterprise Linux 5.5 (64-bit)
Database
MS-SQL 2008 Enterprise Edition SP 1 (64-bit)
Oracle Enterprise Edition 11g R1 (64-bit)
Application server
Tomcat 6.0.26 (64-bit)
Tomcat 6.0.26 (64-bit)
Web server
Apache 2.2 (32-bit)
Apache 2.2 (64-bit)
Reporting engine
BusinessObjects XI 3.1 SP3 or 4.0
BusinessObjects XI 3.1 SP 3 or 4.0
Java (JDK/JRE)
JDK/JRE 1.6.0_20*
JDK/JRE 1.6.0_20*
*see Oracle critical patch update notice
Oracle critical patch update

Oracle has issued a security advisory and critical patch update for multiple security vulnerabilities.
Details can be found on the Oracle site at this URL: http://www.oracle.com/us/technologies/security
/javacpujune2011-313339.html.
Application stack
BSM Interoperability 8.5.1 contains a detailed listing of the applications verified in this release, with
the exception of the following application, which is not part of the BSM Reference Stack:
BMC BladeLogic Client Automation Discovery Integration for CMDB
Related topics
System requirements
System requirements
See the topic Reviewing system requirements
from the BMC Remedy ITSM Deployment online
documentation.
Planning a CMDB
The following topics provide recommendations for planning the BMC Atrium CMDB population and
normalizing and reconciling data.
CMDB planning stages
Phased implementation of a CMDB
Challenges, critical success factors, and risks with SACM
BMC Atrium Core 9.0
Page 150 of 2268
Home
CMDB planning stages

This section provides an overview of the stages involved in structuring a CMDB project and
successfully delivering a comprehensive, effective, and useful CMDB. These stages are set forth in
the Step-by-Step Guide to Building a CMDB and are summarized here. You can request this book
from http://www.bmc.com.
The stages are further divided into discrete steps, each with specific goals and objectives that help
you meet the milestone for each stage. Some aspects of this process are described in more detail
in this document and in other BMC Software documentation, as noted in this section.
Stage 1 Assembling the project team
Stage 2: Defining requirements and creating IT service model blueprint
Stage 3: Selecting CMDB solution and tools
Stage 4: Constructing and maintaining your CMDB
Stage 5: Driving ongoing value
Stage 1 Assembling the project team

The number of team members that you choose and how many roles each plays depends on the
size and structure of your organization, but you should employ project management standards such
as including stakeholders and representatives from the user community.
The high-level steps associated with this stage are:
Step 1, Assemble project team
Step 2, Obtain CMDB knowledge
Step 3, Create and agree on CMDB goals and mission statement
Step 4, Review and define benefits
Step 5, Build a business case
Your Configuration Management team should collectively be knowledgeable in:
ITIL Service Support processes and guidelines
BMC Atrium CMDB administration, BMC recommendations, and integration methods
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) Common Data
Model (CDM)
BMC Remedy AR System development
Project management
Business management processes
Stage 2: Defining requirements and creating IT service model blueprint

Step 6, Identify and review governance requirements
BMC Atrium Core 9.0
Page 151 of 2268
Home
Step 7, Review and select supporting recommendations

Step 8, Identify requirements to address potential problems
Step 9, Identify inventory and asset requirements
Step 10, Define service catalog requirements
Step 11, Define CMDB requirements to support other processes
Step 12, Define configuration item (CI) level and IT service model
Step 13, Define CI relationships
Step 14, Define CI attributes
Step 15, Design IT service model blueprint
The result of these steps is a blueprint that models your configuration data requirements.
Based on your configuration data requirements for BMC Asset Management and other consumers,
use the Mapping Your Data to BMC Atrium CMDB Classes document to identify the configuration
item (CI) classes and attributes that you need to populate and store in BMC Atrium Configuration
Management Database (BMC Atrium CMDB).
For information about the complete structure and class details of the Common Data Model (CDM),
see the BMC Atrium CMDB Common Data Model Diagram and the BMC Atrium CMDB Data Model
Help.
Stage 3: Selecting CMDB solution and tools

Step 16, Select CMDB solution
Step 17, Plan the CMDB population
For details about this step, see Planning to populate BMC Atrium CMDB .
Step 18, Select tools to automate CMDB population
Step 19, Calculate project Return on Investment (ROI)
Stage 4: Constructing and maintaining your CMDB

Step 20, Construct your CMDB
Step 21, Create CI lifecycle management processes
Step 22, Build supporting processes
Step 23, Populate your CMDB
For details about this step, see Importing data to BMC Atrium CMDB .
Step 24, Train the CMDB team and users
Stage 5: Driving ongoing value

Step 25, Implement measures and metrics
Step 26, Create a continual service improvement program
BMC Atrium Core 9.0
Page 152 of 2268
Home
Phased implementation of a CMDB

Implementing a CMDB to manage your entire configuration at once is a daunting task, so a phased
approach to implementation is usually better. Consider the following alternatives for breaking up the
implementation:
By critical business services or critical business applications
By company department
By geographic region
By support group
By importance of CI
Regardless of which types of phases that you use, try to keep transition times short. While in
transition, you must maintain both your current and former processes, which is difficult to do for
long periods.
Your later phases will be less costly if you apply lessons learned in early phases.
Challenges, critical success factors, and risks with SACM

The ITIL Service Transition manual identifies the following challenges, critical success factors, and
risks with Service Asset and Configuration Management (SACM).
Challenges to SACM
Critical success factors for SACM
Risks to successful SACM
Related topics
Challenges to SACM
Challenges to SACM include the following items:
Persuading technical support staff to adopt a checking in/out policy, which can be perceived
as a hindrance to a fast and responsive support service. If the positives of such a system are
not conveyed adequately then staff might be inclined to try to circumvent it.
Attracting and justifying funding for SACM, since it is typically out of sight to the customer
units empowered with funding control. In practice it is typically funded as an invisible element
of Change Management and other ITSM processes with more business visibility.
An attitude of just collecting data because it is possible to do. This leads SACM into a data
overload which is impossible, or at least disproportionately expensive, to maintain.
Lack of commitment and support from management who do not understand the key role it
must play supporting other processes.
Critical success factors for SACM

SACM's success includes the following critical factors:
BMC Atrium Core 9.0
Page 153 of 2268
Home
Focusing on establishing valid justification for collecting and maintaining data at the agreed
level of detail.
Demonstrating a top-down approach that is focused on identifying service CIs and
subsequently the CIs that support those services, thereby allowing a rapid and clear
demonstration of potential points of failure for any given service.
Setting a justified level of accuracy, that is, the correlation between the logical model within
SACM and the real world.
Making use of enabling technology to automate the CMS practices and enforce SACM
policies.
Risks to successful SACM

Risks to successful SACM include the following items:
The temptation to consider it technically focused, rather than service and business focused,
since technical competence is essential to its successful delivery.
Degradation of the accuracy of configuration information over time that can cause errors and
be difficult and costly to correct.
The CMS becomes out of date due to the movement of hardware assets by non-authorized
staff. Half-yearly physical audits should be conducted with discrepancies highlighted and
investigated. Managers should be informed of inconsistencies in their areas.
Related topics
Purpose of SACM
Goals of SACM
Benefits of SACM

This section explains the purpose and structure of the BMC Atrium CMDB data model. It defines
the Common Data Model (CDM) and offers recommendations for extending the model.
Data model classes, attributes and extensibility
Synchronizng class changes
Planning to extend the data model
BMC contributors content
For additional information, you can also refer to the following webinar conducted by BMC Support.
Understanding Common Data and Modelling
BMC Atrium Core 9.0
Connect with Atrium - Best Practices
Page 154 of 2268
Home
You can also connect with other users for related discussions on the BMC Community.
Data model classes, attributes and extensibility

The data model of BMC Atrium Configuration Management Database (BMC Atrium CMDB) unifies
the representation of configuration data. It is designed to store data about the most common
configuration items such as hardware, software, and services and provide a mechanism for linking
that information to provide a complete view of all elements of an IT environment and how they
affect each other.
Attribute inheritance
Relationships in the data model
BMC Atrium CMDB data storage methods
Data model classes and attributes

The BMC Atrium CMDB data model is object oriented and extensible. It consists of classes, each
representing a type of configuration item that can be stored in the CMDB. Each class equates to a
database table or a BMC Remedy AR System form. For example, the data for the
BMC_ComputerSystem class, which represents computer system CIs, is accessible in the
BMC.CORE:BMC_ComputerSystem join form.
A class can be either a configuration item (CI) class, which defines a type of configuration item, or a
relationship class, which defines a type of relationship between CIs.

A class has one or more attributes, each of which specifies a property of the class. For example,
BMC_ComputerSystem has attributes such as HostName and Domain. Each attribute equates to
a column on a database table or a field on an BMC Remedy AR System form.
Data model extensibility

A key aspect of BMC Atrium CMDB is a data model that is extensible. Infrastructure, and the data
that different companies want to track about that infrastructure, is constantly changing. The data
model is designed so that it can easily be extended using the Class Manager or the BMC Atrium
CMDB APIs. Some BMC applications extend the data model to store data specific to their
functionality. To be extensible means that there is no usage distinction between the system-defined
and the user-defined data model.
Because the data model is object oriented, a class can have subclasses that inherit its attributes
and the ability to participate in the same relationships. Subclasses are used to further classify a
type of Configuration Item (CI) and give specific attributes to the more granular types.
BMC Atrium Core 9.0
Page 155 of 2268
Home
For example, BMC_ComputerSystem has subclasses to represent mainframes, printers, and

storage subsystems. These subclasses inherit HostName and Domain, and all the other attributes
of BMC_ComputerSystem. Inheritance of attributes continues to the end of the tree, so the
subclasses also inherit from BMC_System, the class above BMC_ComputerSystem, and from
BMC_BaseElement, the base class above BMC_System. The following figure shows some of the
attributes inherited along this part of the tree.
BMC Atrium Core 9.0
Page 156 of 2268
Home
BMC Atrium Core 9.0
Page 157 of 2268
Home
Relationships in the data model

A relationship class defines a type of relationship between two specific Configuration Item (CI)
classes. An instance of the relationship class relates an instance of the first, or source, CI class to
an instance of the second, or destination, CI class. The two CIs are considered members of the
relationship.
Relationship source and destination members
Relationship cardinality
Weak relationships
BMC Atrium Core 9.0
Page 158 of 2268
Home
Cascading delete option for relationship classes
Relationship source and destination members

The placement of a CI class as the source or destination member of a relationship is not arbitrary.
The source class provides a group, location, hosting, or other function, and the destination class is
a member of, is located in, depends on, or is hosted by it.
For example, the source member of BMC_HostedSystemComponents is BMC_System, and the
destination member is BMC_SystemComponent. For examples of the meaning of source and
destination in some relationship classes, see the following table.
Examples of source and destination relationship members

Class
Source acts as
Destination acts as
BMC_Dependency
Antecedent
Dependent. Depends on antecedent.
BMC_HostedSystemComponents
Host
Component. Hosted by host.
Relationship cardinality
Every relationship class has a cardinality that defines how many instances of the source class can
be related to each instance of the destination class and vice versa. BMC Atrium CMDB enforces
this cardinality.
One to one Each instance of the source class can have this relationship with one instance
of the destination class.
One to many Each instance of the source class can have this relationship with multiple
instances of the destination class.
Many to one Multiple instances of the source class can have this relationship with each
instance of the destination class.
Many to many Each instance of the source class can have this relationship with multiple
instances of the destination class, and vice versa.
Fulfilling a many cardinality means that multiple instances of the relationship exist.
Weak relationships
If a relationship is a weak relationship, its destination member, called the weak member, cannot
exist without its source member, called the strong member. A weak relationship creates a logical
composite object consisting of both member CIs. You can extend this composite object by adding
more weak relationships either from the source to other destinations or from the destination, acting
as a source this time, to destinations a level below.
BMC Atrium Core 9.0
Page 159 of 2268
Home
You can choose to act on these composite objects during certain reconciliation activities. For
example, BMC_HostedSystemComponents is a weak relationship commonly used to relate a
computer system to its components. If you copy instances of BMC_ComputerSystem from one
dataset to another, you can choose whether instances of BMC_Monitor and other components
related to those computer systems are copied automatically to preserve the composite objects,
even though BMC_Monitor was not specified as a class to be copied by the activity.
You can also propagate attributes from the strong side to the weak side of a weak relationship. This
means that an attribute from the source CI is mapped to an attribute from the destination CI so that
for every instance of the relationship, whenever the value changes in that attribute of the source,
that value is also written to the corresponding attribute on the destination. This enables you to
search for an instance of a destination member, such as a disk drive, and get information about the
computer system in which it is installed without having to follow the relationship and read the
computer system instance.
For instructions about propagating attributes for weak relationships, see Propagating attributes for
weak relationships.
Cascading delete option for relationship classes

Relationship classes with a cardinality of one-to-one or one-to-many have an option called
cascading delete. This causes a destination member of the relationship, and all destinations of
relationships below it, to be deleted when the source member is deleted. Marking a CI as deleted is
also cascaded down to destination CIs when this option is enabled.
This option is particularly useful with composite objects. For example, you could use it with the
BMC_HostedSystemComponents relationship class so that when you delete a computer system,
all its components, such as disk drives and memory, are also deleted.
Note
Cascading delete does not work in reverse. When you unmark a CI that was previously
marked as deleted, only the CI on which you set MarkAsDeleted to NULL or No (BMC
recommends NULL) is restored. For example, if you unmark a computer system, it is
restored, but its components, such as disk drives and memory, remain deleted. To restore
the components as well, you must unmark each of them.
Use cascading delete carefully, because it can have far-reaching effects. Deletions are cascaded
all the way down to destination CIs at the end of a relationship chain, and this happens for every
instance of a relationship class that has cascading delete enabled.
BMC Atrium CMDB data storage methods

BMC Atrium CMDB stores instance data by a method defined by the type of class containing each
instance. BMC Atrium CMDB provides the following types of classes:
BMC Atrium Core 9.0
Page 160 of 2268
Home
Regular classes
Categorization classes
Abstract classes
Abstract classes with data replication
Regular classes
A regular class stores the data for its attributes in its own BMC Remedy AR System form. If it is a
subclass, that form is a join form that joins the attributes of the superclass with the attributes unique
to the subclass.
The following figure shows the forms for a new regular class, with the lines representing a join
between the superclass and the form containing the uninherited attributes of the new class.
Regular class
By searching in the superclass form, you can find instances of both the superclass and the
subclass. This is a useful way to search when you do not know which class an instance is stored in.
However, you must then go to the subclass form to see all attributes of the instance.
An example of a regular class in the Common Data Model (CDM) is BMC_ComputerSystem.
BMC Atrium Core 9.0
Page 161 of 2268
Home
Categorization classes
A categorization class does not have its own BMC Remedy AR System regular form. Its uninherited
attributes are added to the form of its immediate concrete superclass. Instances of the superclass
leave these subclass attribute fields blank, whereas instances of the subclass use them. Because
of this, no attributes of a categorization class can be required attributes.
A categorization class does have its own join form, though this is only for the purpose of providing a
form (and SQL view) that uses the actual class name. The join form is a join of the superclass form
and a stub form with no records, and is not part of the inheritance tree. Any subclasses of the
categorization class are joined to the superclass form, and not to the join form.
The following figure shows the forms for a new categorization class. The superclass form has one
column containing an attribute from the categorization class. The instance of the superclass does
not have a value in this column, whereas the instances of the new class do.
Categorization class
This data storage method avoids adding a database join to its subclasses. A join form is still
created for the purpose of giving the categorization class a form (and therefore a database view)
that uses its name, but that form is joined to a stub form and is not used by any subclasses.
As with a regular class, you can search in the superclass form of a categorization class and find
instances of both the superclass and the subclass. But with a categorization class, you have
access to all the attributes of that subclass.
An example of a categorization class in the CDM is BMC_Memory.
BMC Atrium Core 9.0
Page 162 of 2268
Home
Abstract classes
An abstract class does not have its own BMC Remedy AR System form and cannot hold any
instances. It exists only to organize subclasses, enabling you to add a layer of organization without
a database join.
Note
Abstract classes are not commonly used. They are intended for special cases.
The following figure shows the forms for a new abstract class with two regular subclasses. The
lines represent the joins between the superclass and the forms containing the new subclasses'
attributes.
Abstract class
An example of an abstract class in the CDM is BMC_SystemComponent.
BMC Atrium Core 9.0
Page 163 of 2268
Home
Abstract classes with data replication

An abstract class with data replication avoids a database join, thus improving performance when
searching its subclasses and retrieving their instances. However, it results in slower performance
when creating and modifying subclass instances, so unless you really need to search the abstract
class, you should create it without data replication. Use abstract subclasses with data replication
only when you want the benefits of an abstract class and also need the ability to search all its
subclasses in one place.
The following figure shows the forms for a new abstract class with data replication and two
subclasses created from it. The lines without arrows represent the joins between the superclass
and the forms containing the new subclasses' attributes, and the lines with arrows represent data
being replicated up to the level of the new class.
Abstract class with data replication
BMC Atrium Core 9.0
Page 164 of 2268
Home
There are no examples of an abstract class with data replication in the CDM.
Synchronizng class changes

When you add or modify a class, it is not available to use immediately. The changes that you made
to the metadata must be translated into forms and workflow on the BMC Remedy AR System
server, a process called synchronization.
While synchronization is in progress, an icon appears on the class in the Class Manager window to
indicate that the class is in Change Pending state.
BMC Atrium Core 9.0
Page 165 of 2268
Home
To delete failed classes that have a Change Pending state

1. From a browser, open the the OBJSTR:Pending form in search mode.
2. Select View > Advanced Search Bar.
3. Delete all failed entries that have a Change Pending state.
Planning to extend the data model

The Common Data Model (CDM) includes classes that describe a wide variety of IT configuration
items and their relationships, and some BMC Software products install extensions that add more
classes and attributes to the data model. But some IT infrastructures still do not completely map to
this model. This section gives recommendations for how to extend the data model in such cases so
that you can manage your entire IT infrastructure with BMC Atrium CMDB.
Your first step in deciding whether to extend your data model should be understanding the CDM
and the extensions supplied by BMC products. Study the BMC Atrium CMDB Common Data Model
Diagram and BMC Atrium CMDB Data Model Help in PDFs and videos, and the documentation for
BMC products that you own that integrate with BMC Atrium CMDB. By reading about the classes
that you have, you might find existing classes that serve your needs or at least find the best classes
to extend.
Rank of choices for extending the data model
Guidelines for adding attributes and subclasses
How federation extends the data model
How the Category, Type, and Item attributes extend the data model
How additional attributes extend the data model
How additional subclasses extend the data model
How Calbro Services extends the data model
Naming and numbering rules for new classes and attributes
Making data model changes visible to applications
Documenting data model extensions
Rank of choices for extending the data model

For a data model with the greatest simplicity and performance, your best choices are ranked in this
order:
1. Use federation to extend the data model.
2. Use the Category, Type, and Item attributes to extend the data model.
3. Install an extension from BMC Software to extend the data model.
4. Add attributes to extend the data model.
5. Add subclasses to extend the data model.
BMC Atrium Core 9.0
Page 166 of 2268
Home
Guidelines for adding attributes and subclasses

If you decide to add attributes or subclasses, follow these guidelines:
Perform the work using the Class Manager, an API program, or the cmdbdriver command.
Modifying the BMC Atrium Configuration Management Database (BMC Atrium CMDB) data
model requires more than just editing a form, and you might break some functionality. You
can use BMC Remedy Developer Studio to modify field layout and labels.
Important
Never make those changes directly on class forms using BMC Remedy Developer
Studio.
Because a CMDB gets its value by sharing data among applications, make your extensions
as widely useful as possible, so that they can meet multiple needs. Avoid extensions that
narrowly cater to one application, even for high-volume uses.
Do not create classes more than five database join levels deep. For information about the
classes that use joins, see BMC Atrium CMDB data storage methods .
Determine whether you want to store configuration data or lifecycle data for the CI in the new
attribute. You must add a new attribute to a class to store only configuration data about a CI.
To store lifecycle data for a CI, you must add a field on the AST:Attributes form that is
installed by BMC Remedy IT Service Management version 8.0 and later.
Note
In versions prior to 8.0, BMC Remedy IT Service Management extended CI
lifecycle data as attributes in BMC Atrium CMDB. With multiple datasets, multiple
copies of the CI lifecycle data were created and stored in BMC Atrium CMDB.
However, CI lifecycle data is not discovered and does not have to be reconciled
across multiple datasets. Because of this, version 8.0 of BMC Remedy IT Service
Management moved the CI lifecycle data out of BMC Atrium CMDB and included
the data as fields in the BMC Remedy ITSM Foundational form, AST:Attributes.
When creating the Remedy Asset Management UI, the CMDB2ASSET process
joins the BMC Atrium CMDB class table and the AST:Attributes table.
The change in the process of storing the CI lifecycle data greatly improves the
performance of BMC Atrium CMDB, creates only a single instance of CI lifecycle
data, and gives control of the CI lifecycle data to the Asset Manager instead of the
Configuration Manager. For detailed information about the changes, see Changes
to the BMC Atrium CMDB for BMC Remedy ITSM
BMC Atrium Core 9.0
Page 167 of 2268
Home
How federation extends the data model

Just as important as knowing how to extend the CDM is knowing when to extend it. Some
situations are better addressed by storing data somewhere other than your CMDB or by using
existing classes and attributes.
The CMDB should hold only common CIs and their relationships. Adding classes and attributes for
unimportant CIs taxes your CMDB. Also, creating too many subclasses can leave you with classes
so narrowly defined that they hold very few instances. Balance the need for categorization with the
need to store similar CIs together.
Additional information
When to use federated data
How the Category, Type, and Item attributes extend the data model
To further categorize a configuration item (CI) class that has the specific attributes that you need,
consider using the existing Category, Type, and Item attributes instead of creating attributes or
subclasses. These attributes are part of the BMC_BaseElement class and are thus inherited by all
other CI classes. You can use them to provide levels of categorization for instances of a class
without the performance cost of a subclass.
For example, the class BMC_PointingDevice does not distinguish between a wired mouse and a
wireless mouse. To make this distinction in your data, you do not need to create subclasses called
YourModel_WiredPointingDevice and YourModel_WirelessPointingDevice. Just
populate the Item attribute with Wired or Wireless when creating instances of
BMC_PointingDevice.
Note
Because this categorization strategy uses a single class, the different categories, types,
and items cannot have relationships to different classes. To have different relationships
for each Category, Type, and Item, create subclasses for them instead of using this
strategy.
How additional attributes extend the data model

If an existing class describes your configuration item (CI) well but lacks a few pieces of information,
add attributes to the existing class to store that information and avoid the performance cost of a
subclass. To store some CIs that use these attributes and some that do not, make the entry mode
of the attributes Optional.
BMC Atrium Core 9.0
Page 168 of 2268
Home
Adding attributes works well when you have only one variation on a class to accommodate. If you
have two or more variations, each with their own set of attributes, consider creating subclasses for
them instead.
Before creating an attribute for a CI class, determine whether you want to store configuration data
or lifecycle data for the CI in the new attribute. You must create a new attribute to store only
configuration data for the CI. To store lifecycle data for the CI, you must add a field on the BMC
Remedy ITSM Foundational form, AST:Attributes.
Note
Version 8.0 of BMC Remedy IT Service Management moved the CI lifecycle data out of
BMC Atrium Configuration Management Database (BMC Atrium CMDB) and included the
data as fields in the BMC Remedy ITSM Foundational form, AST:Attributes. For detailed
information about the changes to the process of storing asset lifecycle data for a CI, see
Changes to the BMC Atrium CMDB for BMC Remedy ITSM .
If you decide to add attributes, follow the Field ID rule in Naming and numbering rules for new
classes and attributes.
Note
When you add attributes to your data model, the new attributes are not automatically
picked up by BMC Software products that use BMC Atrium Configuration Management
Database (BMC Atrium CMDB), such as BMC Impact Solutions or BMC Asset
Management. To use the new attributes with one of these applications, you must
customize the application. For more information, see Making data model changes visible
to applications.
How additional subclasses extend the data model

Before extending the data model, you should first make sure that an alternative would not work for
problematic configuration items (CIs) and relationships. Then, you should review how the different
class types extend the data model.
Considerations for extending the CDM
Regular class extentions to the data model
Categorization class extentions to the data model
Abstract class extentions to the data model
Abstract class with data replication extentions to the data model
Final class option
BMC Atrium Core 9.0
Page 169 of 2268
Home
Singleton class option
Considerations for extending the CDM

Before you add classes for configuration items (CIs) and relationships, consider the alternatives,
such as using federation, using the Category, Type, and Item attributes, installing an extension,
and adding attributes. When one of these alternatives can address your problem, it is almost
always better than adding subclasses to the common data model (CDM).
But there are situations in which none of those alternatives meets your needs, such as when you
need to take the following actions:
Refine your classification.
Add new attributes that are not general enough for existing classes.
Further restrict the types of CI classes that can participate in a given relationship or vice
versa.
For example, BMC_HostedSystemComponent is a relationship class that relates a system to a
system component, but if you needed more specific relationship types, you could create subclasses
. You could create one subclass of BMC_HostedSystemComponent that relates a computer
system to a disk drive and another that relates a computer system to a memory card.
You can create subclasses of both CI classes and relationship classes. When creating new classes
, consider using categorization and abstract classes instead of regular classes because regular
classes require more system resources, and an abundance of regular classes in your data model
can slow system performance.
If you decide to create subclasses, follow the class naming rule in Naming and numbering rules for
new classes and attributes.
Note
When you add classes to your data model, the new classes are not automatically picked
up by BMC Software products that use BMC Atrium CMDB, such as BMC Impact
Solutions or BMC Asset Management. To use the new classes with one of these
applications, you must customize the application. For more information, see Making data
model changes visible to applications.
Regular class extentions to the data model

Creating a regular class is the most straightforward way to create a subclass, but it has the
potential to affect database performance if you create too many levels of joins. The
recommendation is to go no deeper than five join levels.
BMC Atrium Core 9.0
Page 170 of 2268
Home
Use regular classes for CIs or relationships that have more than five uninherited attributes or that
have any uninherited attributes that must be populated in every instance. Use a regular class for
any class that you expect to contain at least as many instances as its superclass. If you expect the
class to contain at least 1,000 instances, regardless of how many its superclass will contain, you
might want to make it a regular class because that enables you to create indexes on it to improve
search performance.
Categorization class extentions to the data model

Use categorization classes for CIs that have five or fewer uninherited attributes--none of which are
required--and that have relationships to different classes. Use them for most of your relationship
subclasses, because those subclasses often have no uninherited attributes. Use them also when
you want to be able to access all attributes of a subclass when searching it from the form of its
superclass.
Abstract class extentions to the data model

Use abstract subclasses when you need a logical class at a particular organizational level, but only
to provide some common attributes that subclasses can inherit or to provide a common relationship
type for those subclasses. To work with any instances of the class, use an abstract class with data
replication.
The classes BMC_System and BMC_SystemComponent are examples of abstract classes created
to provide a common relationship type for their subclasses. You can create a
BMC_HostedSystemComponent relationship between instances of any subclass of BMC_System
and any subclass of BMC_SystemComponent, because these two abstract CI classes were
defined as the endpoints of that relationship class.
Abstract class with data replication extentions to the data model

An abstract class with data replication avoids a database join, thus improving performance when
searching its subclasses and retrieving their instances. However, it results in slower performance
when creating and modifying subclass instances, so unless you really need to search the abstract
class, you should create it without data replication.
Use abstract subclasses with data replication when you want the benefits of an abstract class but
also need the ability to search all its subclasses in one place.
Final class option

Use a final class when you want to prevent others from creating subclasses of a class you create.
For example, if you build a C API program that performs tasks against a particular class, or use
custom workflow with a particular class, you might mark it as Final so that your program or workflow
does not have to account for subclass data stored with the class.
BMC Atrium Core 9.0
Page 171 of 2268
Home
Singleton class option

Use a singleton class when you have a unique CI or relationship that you want to store in BMC
Atrium CMDB. For example, you might use a singleton class for your company's CEO so that you
can model the impact of particular IT resources on the CEO.
How Calbro Services extends the data model

Calbro Services wants to track the model year of several of the devices on the network, such as
servers, workstations, routers, and so on. Because the model year is a critical piece of information,
the administrator wants to include it in the data model.
Working through the preferred means of building the data model, the Calbro Services administrator
first considers federating the model year data. This data is not information related to configuration
items (CIs), such as incident requests. Neither is it non-critical detailed information about CIs, such
as service records. The model year is a critical piece of information about computer equipment
used throughout the company, so the administrator discards federation as an option.
Second, the administrator considers using the existing Category, Type, and Item attributes to
store the model year data. These attributes are used for classification, and are insufficient for
storing model year information.
Third, the administrator considers using an existing BMC Software extension to the data model, but
the model year is not included in extensions Calbro Services intends to use.
Next, the administrator considers adding a new attribute to an existing class. The model year is
important to different consumers of BMC Atrium Configuration Management Database (BMC Atrium
CMDB) data. After referring to BMC Atrium CMDB Data Model Help , the administrator learns that
the new attribute could be added to the BMC_ComputerSystem class. Because each subclass
inherits attributes from its superclass, the BMC_Mainframe and BMC_Printer classes could also
use the new attribute. The administrator would like the option of tracking the model year of
mainframes and printers, and so decides that the best approach is to extend the data model by
adding a new attribute to the existing BMC_ComputerSystem class.
Naming and numbering rules for new classes and attributes

If you create classes or attributes in your data model, use the following guidelines:
Item names like Class name, Attribute name, and Dataset name are case sensitive.
However, it depends on the case sensitivity for fields configured in the database tables.
CMDB inherits the database configuration for case sensitivity.
Consider the following
You have configured unique index for the item names in the database table
Case sensitivity configuration in the database is disabled
You have created two classes, BMC_Test and BMC_TEST, in CMDB
In such case, the database will create two class names with a unique index violation
exception warning message.
BMC Atrium Core 9.0
Page 172 of 2268
Home
Name a new class with a prefix other than BMC_ to identify it as your own, and make the
name descriptive.
Give an attribute an Attribute Name that is unique across your entire data model.
Give attributes a Field ID greater than 536870911 or leave this field blank to automatically
generate an ID.
Specifying a value greater than 536870911 enables you to create custom BMC Remedy AR
System workflow on the field and share the workflow between forms, because you can give
the same ID to a field on another form.
It is better to give attributes a Field ID that is unique across your entire data model; therefore
you should share workflow only between a BMC Atrium Configuration Management
Database (BMC Atrium CMDB) form and a form that is not part of BMC Atrium CMDB. See
the BMC Remedy Action Request System documentation for information about sharing
workflow and other benefits of specifying a Field ID.
BMC Software reserves numbers 536870911 and lower.
Making data model changes visible to applications

When you add classes and attributes to your data model, they are not automatically picked up by
BMC Software products that use BMC Atrium Configuration Management Database (BMC Atrium
CMDB), such as BMC Impact Solutions or BMC Asset Management. To use the new classes and
attributes with one of these applications, you must customize the application.
BMC Remedy AR System applications

Some BMC Remedy AR System applications, such as BMC Asset Management, maintain their own
set of join forms for viewing and modifying BMC Atrium CMDB instance data. After you add a new
class, BMC Atrium CMDB can generate these join forms for such an application and arrange the
fields according to view templates specified by the application. For information about controlling the
layout of class forms, see Control of the layout of class forms .
BMC Impact Solutions

To update BMC Impact Solutions to use new classes and attributes, you must perform tasks in both
BMC Atrium CMDB and BMC Impact Solutions. See the documentation for BMC Impact Solutions
for information about these tasks.
Documenting data model extensions

Just as you need to occasionally look up information about classes in the Common Data Model (
CDM), you will need to look up information about classes and attributes that you create. Enter
descriptions for each in the Description fields available in the Class Manager.
BMC Atrium Core 9.0
Page 173 of 2268
Home
You can generate an updated version of BMC Atrium Configuration Management Database (BMC
Atrium CMDB) Data Model Help the HTML Help system that provides information about the data
model to reflect your current data model and to include the descriptions for the classes and
attributes that you add.
For instructions on generating updated BMC Atrium CMDB Data Model Help with the cdm2html
utility, see Creating Data Model Help with the cdm2html utility .

The following topics provide information about planning to bring data into your BMC Atrium CMDB:
Data stored in an ITIL CMDB
Planning to populate BMC Atrium CMDB
Planning to use federated data
Controlling access to data with multitenancy
Sizing considerations for populating BMC Atrium CMDB
Replicating BMC Atrium CMDB data to other servers
Planning data normalization and the Product Catalog
Data stored in an ITIL CMDB

ITIL recommends that you store several types of data in the CMDB. Its main purpose is to hold
configuration items (CIs) and the relationships between them, which together form a configuration
at a particular time or state. ITIL also suggests that the CMDB can hold data related to CIs, such as
incident tickets or SLA definitions.
Remember that your CMDB deployment should be based on the needs of consuming applications.
Unless and until there is a defined use for a piece of data in your CMDB, ideally that data should
not be populated in your CMDB.
Configuration items in an ITIL CMDB
Relationships among CIs in a CMDB
Data related to CIs
Configuration items in an ITIL CMDB

Configuration items (CIs) are the focal point of a CMDB. Without a clear definition of what qualifies
as a CI, you will constantly struggle with deciding whether to put certain kinds of data into the
CMDB. Simply put, a CI is an instance of an entity that is part of your environment and has
BMC Atrium Core 9.0
Page 174 of 2268
Home
configurable attributes specific to that instance. These entities can be physical (such as a computer
system), logical (such as an installed instance of a software program), or conceptual (such as a
business service). But they must be a direct part of your environment, rather than information about
such a part.
The following sections provide guidelines for determining CIs and examples of CIs.
Examples of CIs and non-CIs
CI eligibility matrix
Calbro Services use of a CI eligibility matrix
Examples of CIs and non-CIs

The following table gives some examples to illustrate this boundary:
Example CIs and non-CIs
Configuration items
Not configuration items
A business service is part of your environment and

has configurable attributes, such as criticality to the
An incident ticket has configurable attributes but is not a

direct part of your environment. It is information about other
business and cost of interruption of service.

A computer system is part of your environment and
entities (a computer system, for example) that are part of

your environment.
has configurable attributes, such as serial number,

processor speed, and IP address.
A software package is not part of your environment only

installed instances of it are and is usually stored in the
A building is part of your environment and has

configurable attributes, such as number of rooms,
Definitive Media Library (DML).

An event does not have configurable attributes and is not part
climate control system, and alarm system.

An employee is part of your environment and has
of your environment.
configurable attributes, such as skills, hours, and

department.
A software instance installed on a computer system
is part of your environment and has configurable
attributes, such as license key, patch level, and
licenses available.
Of course, not everything that qualifies as a CI is worth tracking. For example, you probably will not
create records in the CMDB for all the office chairs in your organization.
CI eligibility matrix
Consider creating a CI eligibility matrix to help you make decisions about which items in your IT
environment should be CIs. A CI eligibility matrix lists each CI candidate, its CI type (such as
infrastructure or service), and several eligibility criteria to consider as part of your decision-making
for CI candidates. Specific eligibility criteria vary according to the needs of your business, but
consider using some of the following criteria:
Cost or value Does the CI candidate have an associated monetary cost or value to your
business?
Change considerations Would the CI candidate be impacted by IT change requests?
BMC Atrium Core 9.0
Page 175 of 2268
Home
Traceability Are you required to track changes made to the CI candidate?

Governance and compliance requirements Is the CI candidate crucial to maintaining
compliance with standards and other requirements?
Management of service commitments Is the CI candidate required to help you meet your
service commitments to the business?
Maintainability Are you required to maintain the CI candidate?
Delivery cost and quality Is there a monetary cost associated with how the CI is delivered
and maintained?
Do you, and not a third party, manage the CI candidate?
Is the CI candidate unique?
Other factors specific to your business needs.
Use the individual eligibility criteria to set your overall acceptance criteria. For example, you might
determine that if a CI candidate meets a simple majority of your eligibility criteria, it should be a CI.
You might determine that a candidate must meet each of a select few eligibility criteria to qualify as
a CI. You might determine that one eligibility criterion is more important than the rest. The final
decision is rooted in your business needs.
After you have set your overall acceptance criteria for determining how a candidate will be
evaluated, assess each CI candidate against each eligibility criterion as yes/no or true/false, with
yes or true indicating that the candidate should be a CI. After you assess all criteria for a CI
candidate, see your overall acceptance criteria to reach a final decision for that candidate.
Calbro Services use of a CI eligibility matrix

This section shows an example of a CI eligibility matrix for Calbro Services. It shows the eligibility
criteria that the CMDB implementation team identified as important for determining whether a CI
candidate should be a CI. For each CI candidate, the team reached a final decision based on the
following requirements:
The CI candidate must meet eligibility criteria D (identifiable) and E (maintainable).
The CI candidate must also meet at least one of eligibility criteria A (under change control),
B (used for impact modeling), or C (used by the Support team).
After completing the CI eligibility matrix, the Calbro Services CMDB implementation team decided
to make CIs for all CI candidates except the Person and Role candidates. Those candidates met
the first requirement by meeting both criteria D and E, but they failed the second requirement by not
meeting any of criteria A, B, or C.
Calbro Services example CI eligibility matrix
BMC Atrium Core 9.0
Page 176 of 2268
Home
Relationships among CIs in a CMDB

Configuration items (CIs) do not exist in a vacuum; they affect each other. For example, one CI
could use, depend on, be a component of, enable, be a member of, or be located in another CI.
Storing these relationships in the CMDB enables you to see how CIs interrelate and affect one
another.
Note
The use of relationships is a critical feature that makes a CMDB a powerful tool, and is a
significant difference between a CMDB and an asset store.
BMC Atrium Core 9.0
Page 177 of 2268
Home
Relationships can be simple, such as a disk drive being a component of a computer system, or
more complex, like those shown in the following figure:
Example relationships
Relationships exist not only between physical CIs, but also between logical and conceptual CIs,
such as the software instances and service instance in the following figure. Two CIs can have more
than one relationship with each other: for example, an employee might own a server and also
operate it.
Relationship data makes the CMDB a powerful decision support tool. Understanding the
dependencies and other relationships among your CIs can tell you how upgrading Processor A
would improve Server B's performance or which services would be affected if Router C failed. Most
downtime is caused by problems stemming from configuration changes. Accurate relationship
information can help you prevent those problems.
Data related to CIs

You might have information related to configuration items (CIs), such as incident tickets, change
events, contracts, service level agreements (SLAs), a Definitive Media Library (DML), and so on.
Though these things are not CIs themselves, they contain information about your CIs and are an
important part of your IT infrastructure.
Note
Some of these types of data are considered CIs by ITIL.
You can federate related data to make it available through BMC Atrium Configuration Management
Database (BMC Atrium CMDB). For more information about federating data, see Planning to use
federated data.
BMC Atrium Core 9.0
Page 178 of 2268
Home
Planning to populate BMC Atrium CMDB

If you plan to discover configuration data, you need BMC discovery products or third-party
discovery products. This documentation assumes the use of BMC discovery products. If you have
already discovered your configuration data with other tools and that data resides in a database or
flat files, use Atrium Integrator to transfer that data to BMC Atrium Configuration Management
Database (BMC Atrium CMDB). For details about how to transfer data, see Importing data with
Atrium Integrator.
Mapping CIs to the data model
Mapping CIs to discovery data sources
Assessing the configuration data source environment
Managing unqualified data
Grouping CIs into datasets
Identifying the discovery schedule sequence
Mapping CIs to the data model

Configuration items (CIs) and relationships are represented in BMC Atrium Configuration
Management Database (BMC Atrium CMDB) as instances in the data model. The data model is
structured into classes that represent the types of CIs in your IT environment, and the relationships
between those CIs.
You must plan how your CIs and relationships will be populated in the data model. See the
following resources in for planning and recommendations:
BMC Atrium CMDB Common Data Model Diagram
BMC Atrium CMDB Data Model Help
Mapping CIs to discovery data sources
This section aligns with Stage 3, Step 17, "Task 3. Map CIs to Data Sources," of the Step-by-Step
Guide to Building a CMDB. In this step, you select a discovery provider to generate the
configuration items (CIs) required by consuming applications.
Recommendations
Configuration data discovered by BMC BladeLogic Client Automation
Configuration data discovered by BMC Atrium Discovery and Dependency Mapping
Transfer existing configuration data with Atrium Integrator
How Calbro Services discovers CIs
BMC Atrium Core 9.0
Page 179 of 2268
Home
If you are implementing discovery products for the first time, select either the BMC Atrium
Discovery and Dependency Mapping product, the BMC BladeLogic Client Automation product, or a
third-party discovery tool as your discovery provider. If you want to use both BMC discovery
products, use them to discover different endpoints. In this situation, duplicate CIs are not collected
and imported to the production dataset.
To select the appropriate BMC discovery provider, consult the following topics:
If you identify multiple providers for a class or attribute, you must later identify which provider's data
will be reconciled to the production dataset.
Recommendations
Consider these suggestions when working with discovery sources:
Do not load every discovered CI into the CMDB on every transfer. Transfer only new CIs and
CIs that have been modified since the previous transfer.
You do not have to populate each possible class with every one of your data providers. Bring
into the CMDB only the data that is used by a data consumer to make key business
decisions. If no application is consuming the data, there is no value in maintaining and
managing it in the CMDB.
If you are using more than one discovery source to populate an attribute and those sources
format the attribute's value differently (for example, one uses capital letters and the other
does not), then you should not rely on those values being formatted consistently in your
production dataset. Though one discovery dataset will take precedence over the other in
reconciliation, there will be cases where the production dataset receives its value from the
lower-precedence dataset. For example, a CI might not yet have been imported into the
higher-precedence dataset or might have a NULL value for the attribute in that dataset.
Therefore, you should normalize the values of such attributes between datasets before
reconciliation. You can use the Normalization Engine to do this for certain attributes. For others you
would need to normalize before importing to BMC Atrium Configuration Management Database (
BMC Atrium CMDB).
When deciding how often to transfer data to the CMDB, ask yourself how often the data
changes and how important it is that you pick up those changes. You might want to split your
transfers into longer intervals for stable things like facilities data and shorter intervals for
volatile things like network data.
Network discovery applications are not the only type of discovery source that you can use to
update the CMDB. LDAP systems, Human Resources systems, Facilities systems,
third-party Asset Management databases, and others can serve as discovery sources.
BMC Atrium Core 9.0
Page 180 of 2268
Home

The BMC BladeLogic Client Automation product collects hardware and software inventory
information about servers, desktops, laptops, and handheld devices across major platforms within
your company. The BMC BladeLogic Client Automation Configuration Discovery Integration for
CMDB program maps the collected information and transfers those CIs and relationships to BMC
Atrium CMDB using Atrium Integrator.
For a complete list of the CIs and relationships imported into BMC Atrium CMDB, see the BMC
BladeLogic Client Automation Configuration Discovery Integration for CMDB Getting Started Guide
.

The BMC Atrium Discovery and Dependency Mapping product builds a complete topology of your
applications and infrastructure including switches, servers, operating systems, software,
configuration files and logs, business applications and dependencies. Its discovery is agentless and
uses standard management protocols such as SSH, WMI and SNMP.
Transfer existing configuration data with Atrium Integrator

Atrium Integrator enables you to transfer data between an external data store and BMC Remedy
AR System forms or BMC Atrium CMDB classes. For example, if you have existing data that has
already been discovered with a non-BMC discovery tool, you can use Atrium Integrator to transfer
that data to BMC Atrium CMDB.
Atrium Integrator can transfer data between Microsoft SQL Server, Oracle, IBM DB2 Universal
Database, XML files, flat files such as comma-separated value (CSV) files, BMC Atrium CMDB,
and BMC Remedy AR System. For more information, see Importing data with Atrium Integrator.
How Calbro Services discovers CIs

Calbro Services uses the BMC BladeLogic Client Automation product to discover the desktop and
laptop computer systems (including hardware and software), used by Calbro Services employees.
Calbro Services also uses BMC Atrium Discovery and Dependency Mapping to discover
information about the servers, software, and other devices used to deliver banking information to
Calbro Services customers.
Lastly, Calbro Services uses a third-party discovery tool to collect information about the equipment
that supports the corporate payroll services. Calbro Services uses Atrium Integrator to bring
relevant data from the payroll database into BMC Atrium CMDB.
Assessing the configuration data source environment
BMC Atrium Core 9.0
Page 181 of 2268
Home
This section aligns with Stage 3, Step 17, "Task 4. Assess Data Source Environment," of the
Step-by-Step Guide to Building a CMDB . Based on your configuration data requirements, identify
the systems (endpoints) from which you will gather the configuration data, how you will access
those systems (based on agentless or agent-based discovery), and the impact of the data
collection process on production activities and the network. Following are some questions to
consider:
Which endpoints contain the data that you need to discover?
How many endpoints need to be discovered?
Should the endpoints be discovered using agentless discovery or agent-based discovery and
will that discovery methodology be allowed in the IT environment?
What type of endpoints need to be accessed: servers, desktops, laptops, hand-held devices,
mainframes, or network devices?
Which ports are opened on the firewall?
What credentials are required to access the endpoints?
Will discovery impact production systems or the network?
For more information about planning discovery with BMC BladeLogic Client Automation, see the
BMC BladeLogic Client Automation Configuration Discovery Integration for CMDB Getting Started
Guide.
Managing unqualified data

Your discovery tools might not be able to identify a device at an endpoint they discover. The
unknown device might be a laptop computer, printer, router, server, or some other piece of
hardware. For example, your discovery application might discover an IP address, but lack the
proper credentials to access and identify the device at that IP address. Information about unknown
devices at known IP addresses is called unqualified data .
Consuming applications can use unqualified data just as they use qualified data. For example,
BMC ProactiveNet Performance Management can establish performance monitors at known IP
addresses for unqualified data. If the unqualified data becomes qualified, BMC ProactiveNet
Performance Management does not need to establish new monitors.
To configure unqualified data, create BMC_ComputerSystem configuration items (CIs) in BMC
Atrium Configuration Management Database (BMC Atrium CMDB), with the IsUnqualified
attribute set to Yes. Connect these CIs to discovered BMC_IPEndpoint CIs by
BMC_HostedAccessPoint relationships.
For example, Calbro Services discovers three IP addresses, but cannot identify the devices at
those IP addresses. The administrator creates BMC_ComputerSystem, BMC_IPEndpoint, and
BMC_HostedAccessPoint instances as shown in the following figure.
Unidentified devices at known IP addresses
BMC Atrium Core 9.0
Page 182 of 2268
Home
If Calbro Services later learns the identity of a device at an IP address, the administrator updates
BMC Atrium CMDB by completing the following tasks:
Create a new BMC_IPEndpoint* CI, a new CI for the identified device,
and the appropriate relationship instance between those CIs. Set the
{{IsUnqualified attribute to NULL.
Mark the original BMC_IPEndpoint, unqualified BMC_ComputerSystem, and
BMC_HostedAccessPoint instances for deletion.
Create a BMC_BaseRelationship instance between the unqualified
BMC_ComputerSystem CI (the source CI) and the new CI that represents the identified
device at that IP address (the destination CI). Set the Name attribute of the relationship to
CorrespondsTo. This enables you to know which qualified CIs correspond to previously
unqualified CIs. When the unqualified BMC_ComputerSystem CI is deleted, the orphaned
BMC_BaseRelationship instance is also deleted.
Extending the example started in the following figure, Calbro Services gains credentials to access
to the unknown devices, and learns that all three IP addresses are used for a single computer
system. The administrator creates new CIs and relationships for the computer system and its IP
addresses, marks the original CIs and relationships for deletion, and creates new relationships
between the old and new BMC_ComputerSystem CIs to indicate that the unqualified CIs have
been qualified as a single computer system. The following figure shows the qualified data
associated with the unqualified computer systems marked for deletion.
Qualified data associated with unqualified data
BMC Atrium Core 9.0
Page 183 of 2268
Home
Grouping CIs into datasets
This section aligns with Stage 3, Step 17, "Task 5. Group CIs into datasets," of the Step-by-Step
Guide to Building a CMDB. A dataset is a collection of configuration items (CIs) and relationships
for a given purpose. Together they form a picture of some state, time, or configuration.
The primary purpose of datasets is to partition data according to the providers of that data. Each
discovery application that you use should store the data that it discovers in a separate dataset.
Data in a separate database that you import to BMC Atrium Configuration Management Database (
BMC Atrium CMDB) through Atrium Integrator should be stored in a separate dataset.
You can also use datasets for other methods of partitioning data. For example, you could use
datasets to represent production data or obsolete data. Your datasets do not all need to contain
different versions of the same CIs and relationships. For example, you could use datasets to hold:
Subsets of your overall data, such as departments or regions
BMC Atrium Core 9.0
Page 184 of 2268
Home
Data from different companies for multitenancy

Test data
A dataset can contain only one instance of a given CI. An instance of that CI might also exist in
other datasets to represent the CI in the contexts of those datasets. Instances representing the
same CI or relationship across datasets share the same reconciliation identity, or reconciliation ID.
Each CI and relationship in BMC Atrium CMDB must reside in a dataset, meaning that they have a
DatasetId attribute that must contain a value.
This topic discusses the following:
BMC datasets in BMC Atrium CMDB
How Calbro Services partitions data into datasets
Overlay datasets in BMC Atrium CMDB
Controlling client write access to datasets
BMC datasets in BMC Atrium CMDB

This section describes the default datasets provided by BMC Atrium CMDB, BMC Asset
Management, and BMC discovery products. If you use a non-BMC discovery product, use Atrium
Integrator to import its data.
Default BMC Atrium CMDB datasets used by BMC discovery products

Dataset
created by
Dataset name
Dataset ID
Purpose
BMC Atrium
CMDB
BMC Asset
BMC.ASSET
Production dataset, which is the dataset that you treat as

your single source of reference and that you use to make
business decisions.
BMC Atrium
BMC Sample
BMC.SAMPLE
A safe place to do testing.
BMC Asset
Management
BMC.ASSET.SANDBOX
BMC.ASSET.SANDBOX
If BMC Asset Management is configured with a sandbox

dataset, CIs that you manually create or modify flow
through the sandbox dataset; otherwise, CIs go directly
into the production dataset.
BMC
BladeLogic
Client
Automation
BMC Configuration
Import
BMC.IMPORT.CONFIG
Import CIs and relationships from the BMC BladeLogic

Client Automation database for reconciliation.
BMC Atrium
CMDB
BMC.ADDM
BMC.ADDM
Stores the CIs and relationships from the BMC Atrium

Discovery and Dependency Mapping data store.
BMC Atrium
CMDB
BMC Atrium Explorer

Asset
BMC.AE.ASSET
BMC Atrium
CMDB
BMC Atrium Explorer
BMC.AE
CMDB
BMC Atrium Core 9.0
Page 185 of 2268
Home
Dataset
created by
Dataset name
Dataset ID
Purpose
Atrium Explorer - Identification and Merge reconciliation

job of this dataset is used to reconcile data from sandbox
datasets to BMC.ASSET.
BMC Atrium
CMDB
BMC.SANDBOX.DSM
BMC.SANDBOX.DSM
How Calbro Services partitions data into datasets

Calbro Services uses the BMC BladeLogic Client Automation product to discover the desktop and
laptop computer systems, (including hardware and software) used by Calbro Services employees.
This information is stored in the BMC Configuration Import dataset of BMC Atrium CMDB.
Calbro Services also uses BMC Atrium Discovery and Dependency Mapping to discover
information about the servers, software, and other devices used to deliver banking information to
Calbro Services customers. This data is stored in the BMC.ADDM dataset.
Lastly, Calbro Services uses a third-party discovery tool to collect information about the equipment
that supports the corporate payroll services. Calbro Services uses Atrium Integrator to bring
relevant data from the payroll database into BMC Atrium CMDB. The administrator creates a new
dataset named Calbro Payroll specifically for this information.
Because some of the instances in these different datasets might represent the same real-world CIs,
the administrator configures BMC Atrium CMDB reconciliation jobs to compare those datasets
against each other and put the preferred pieces of information in the production BMC Asset dataset
.
Overlay datasets in BMC Atrium CMDB

BMC Atrium CMDB offers overlay datasets, which enable you to:
Make changes in a separate partition without overwriting your production data.
See your changes in context with the unchanged portions of your data.
Avoid duplicating your entire production dataset.
Create multiple overlay datasets that reuse one set of reconciliation definitions for merging
each into the production dataset.
Warning
Overlay dataset functionality applies only to BMC Atrium CMDB API clients. If you use the
BMC Atrium Core Console or the class forms to view or modify instances in an overlay
dataset, you receive unpredictable results and can compromise data integrity.
BMC Atrium Core 9.0
Page 186 of 2268
Home
How overlays work

When you create an overlay dataset, you must specify an existing regular dataset for it to overlay.
Although an overlay dataset starts out empty like any other dataset, any request for an instance in
the overlay dataset passes through the overlay dataset and returns that instance from the
underlying dataset.
When you modify an instance in the overlay dataset the first time, it is copied there from the
underlying dataset with your modifications. You can also create instances in the overlay dataset.
The underlying dataset still holds the unmodified versions of its original instances, but it does not
hold the newly created instances. A request to the overlay dataset for a new or modified instance
returns that instance from the overlay dataset, and a request to the overlay dataset for an
unmodified instance returns it from the underlying dataset.
Note
Requests made to the underlying dataset always return instances from that dataset, never
from an overlay dataset.
The following figure illustrates queries against an overlay dataset, one for a modified instance and
one for an unmodified instance. Notice that the modified instance shares the same reconciliation ID
with its unmodified counterpart, but not the same instance ID.
Query to an overlay dataset
BMC Atrium Core 9.0
Page 187 of 2268
Home
Tip
Use an overlay dataset to make changes during a day, and then reconcile it into your
production dataset at the end of the day when the change requests for them are approved
.
BMC Atrium Core 9.0
Page 188 of 2268
Home
Result of deleting instances from an overlay dataset

If you attempt to delete from an overlay dataset an instance that actually exists there, the instance
is deleted only from the overlay dataset and remains in the underlying dataset. If you attempt to
delete from an overlay dataset an instance that exists only in the underlying dataset, the instance is
deleted from the underlying dataset.
You can mark an instance as deleted regardless of whether it already exists in the overlay dataset.
In either case, this results in an instance in the overlay dataset that is marked as deleted.
Instance ID and identity in overlay datasets

When an instance is first created in an overlay dataset as the result of a modification, it retains the
reconciliation identity of the instance in the underlying dataset, but is assigned a new instance ID.
If the underlying instance has not yet been identified when it is modified in the overlay dataset, the
instance has no reconciliation identity in either dataset. This is not a problem. When you eventually
identify and merge the two datasets, your Identify rules should be able to match these instances so
that they receive the same identity.
Warning
For each modification that you make to an instance before it is identified, an instance is
created in the overlay dataset. You should identify instances before modifying them a
second time in the overlay dataset.
If you decide to keep the changes that you modeled in an overlay dataset, you can merge them into
the underlying regular dataset.
Controlling client write access to datasets

By default, all BMC Atrium CMDB clients can create, modify, and delete instances in a dataset.
However, you can choose to restrict this write access to one or more specific clients: BMC Impact
Solutions Publishing Server, BMC Impact Model Designer, and the Reconciliation Engine. When
you do this, BMC Atrium CMDB users cannot write to the dataset with a browser. You can also set
a dataset to have no write access whatsoever.
Consider restricting write access to your production dataset. By allowing only the Reconciliation
Engine to write to your production dataset, you prevent unauthorized changes to your single source
of reference. Changes then must be made to other datasets and then reconciled to the production
dataset.
BMC Atrium Core 9.0
Page 189 of 2268
Home
Identifying the discovery schedule sequence
This section aligns with Stage 3, Step 17, "Task 6. Identify Sequence for Entry," of the
Step-by-Step Guide to Building a CMDB . The initial and ongoing population of BMC Atrium
Configuration Management Database (BMC Atrium CMDB) should be based on the following
criteria:
The requirements of the consuming application
The amount of data to be collected
The availability of the data
The demand on the production environment and other performance factors
How often the data changes and needs to be updated in the CMDB
After the initial discovery and population of BMC Atrium CMDB, the Discovery Manager and
Configuration Manager need to set a schedule for discovering changes (new, modified, or removed
configuration items (CIs)), importing the changed CIs to BMC Atrium CMDB, and merging the
changed CIs with the production configuration data. If you use non-BMC discovery solutions, you
must determine how best to schedule an ongoing discovery process.
Guidelines for scheduling and running BMC Atrium Discovery and Dependency Mapping scans
In BMC Atrium Discovery, you must first select one of the following scanning levels to use:
Sweep Scan Confirms only that there is an IP device at each endpoint in the scan range.
Full Discovery Retrieves all the default information for hosts and complete full inference.
In the Configuration Settings, you can set the number of concurrent discovery requests. As this
number gets larger, performance could be negatively impacted, especially in environments where
the network is slow to respond. The default value varies for each appliance, and is calculated to
achieve maximum performance. However, if you experience a situation where many discovery
commands are timing out, you can adjust the default value to between 30 and 150 (in increments of
30). Generally, the more discovery requests you enable to process concurrently, the more you
increase network traffic and the absolute time to discover a single host. However, you can use
different settings as part of an overall approach to improve discovery processing throughput.
For more information about configuring discovery settings and recommended performance factors,
see the BMC Atrium Discovery Deployment Guide at http://discovery.bmc.com/confluence/display/
100/Deployment+guide
BMC Atrium Core 9.0
. You can also donwload a PDF version of the guide.
Page 190 of 2268
Home
Guidelines for scheduling and running BMC BladeLogic Client Automation tasks
You can schedule the transfer of data from the BMC BladeLogic Client Automation database to
BMC Atrium CMDB by creating one or more BMC Atrium Integrator jobs. After each discovery task
completes, run a job on a scheduled day and time, at a timed interval, or when triggered by an
event (such as the firing of an active link or filter). For more information, see Importing data with
Atrium Integrator.
Planning to use federated data

Federated data is data stored outside BMC Atrium Configuration Management Database (BMC
Atrium CMDB) but linked to configuration items (CIs) so that it is accessible through BMC Atrium
CMDB. The most common types of federated data are related information and detailed attributes.
Related information is information about a CI that does not itself qualify as a CI and therefore
should not be stored in a CMDB. Detailed attributes are attributes of CIs stored in BMC Atrium
CMDB, but they are attributes that are not important enough to track at the level of a CMDB.
In BMC Atrium CMDB, not only can you view federated data, you can retrieve that data for use by a
consuming application as if it were part of BMC Atrium CMDB. This feature enables you to access
outside data from central CMDB repository and lets you use your existing data store infrastructure.
How Calbro Services uses federation
Federation methods in BMC Atrium CMDB
The following figure illustrates both types for a BMC_ComputerSystem instance named Computer
A. The instance can be linked to incident records about Computer A, which are related information,
and also linked to discovered attributes of Computer A that were not imported into BMC Atrium
CMDB.
Federated data
BMC Atrium Core 9.0
Page 191 of 2268
Home
Note
Federated data is not bidirectional. BMC Atrium CMDB can establish links only from its
own data to an external source, not from the external source to itself.

Though a CMDB is intended as the single source of reference about your environment, it should
not be the single repository of reference. Consumers should be able to use the CMDB to find all of
your configuration data, but it should federate much of that data to other data stores.
In general, you should have more federated data than you do data stored in the CMDB. The CMDB
should be the card catalog that gives you basic information about what is in your library and tells
you where to find the rest. It should not be the library. It is better to start small with the data stored
in your CMDB, and federate the rest. You can add data directly to the CMDB later if necessary. For
example, you might store computer system configuration items (CIs) in the CMDB, and federate
data about computer components. Given this general strategy, here are a few more considerations
and recommendations when deciding which data to federate:
Linking to federated data from the CMDB does not mean that you must go through the
CMDB to access that data. You can still access the data directly from its own application
when you do not need the context provided by a CI.
Federating avoids rewriting applications to get their data from the CMDB instead of their
current data stores.
BMC Atrium Core 9.0
Page 192 of 2268
Home
Federating avoids extending the CMDB data model.

You can federate data that exists on databases, CMDBf-compliant CMDBs, and BMC
Remedy AR System forms.
You might use multiple CMDBs in your company. For example, you might use a different
CMDB for each of several geographical regions. Use one CMDB as the single source of
truth about your IT environment, and federate the data on your other CMDBs.
Federate attributes that rarely ever change, or that change more than once a day. The
former are not important enough to track in your CMDB, and the latter (such as the current
load on a server) are likely to be out of date in a CMDB.
Federate attributes that will not be used to make business decisions.
Federate data such as change requests or incident records that are not CIs but are
information about CIs.
Federate definitional data such as a Definitive Media Library (DML).
How Calbro Services uses federation

Calbro Services stores service and maintenance records for their printers in a Microsoft SQL
database. Allen Allbrook, a BMC Atrium Configuration Management Database (BMC Atrium CMDB)
administrator at Calbro Services, knows that only core data for a configuration item (CI) should be
stored in BMC Atrium CMDB. Detailed and related data for those CIs should be federated to help
organize CIs and make BMC Atrium CMDB more efficient.
Allen determines that the service and maintenance database stores information that is related to
CIs in the CMDB, and makes that data available using the retrieval method of federation. The
federated data is then available for viewing from within BMC Atrium CMDB through BMC Atrium
Explorer.
Federation methods in BMC Atrium CMDB

BMC Atrium Configuration Management Database (BMC Atrium CMDB) enables you to configure
federation through retrieval and launch methods.
The retrieval method enables you to view federated data as if it were stored in BMC Atrium
CMDB.
The launch method enables you to view federated data through another application, such as
a BMC Remedy AR System form.
These methods enable you to retrieve data in the context of a configuration item (CI). That is, you
want data that is relevant to a particular CI, not every piece of data an external source has to offer.
Retrieval method of federation

With the retrieval method of federation, you create BMC Atrium CMDB classes to represent data
that is stored outside of BMC Atrium CMDB. You also create federated relationship classes that join
classes that are already part of the BMC Atrium CMDB data model to the new federated data
classes. This enables you to view the relationships between federated data and BMC Atrium CMDB
data through such tools as BMC Atrium Explorer and BMC Atrium Impact Simulator.
BMC Atrium Core 9.0
Page 193 of 2268
Home
Federation objects for the retrieval method
The federated data class represents a set of information on the external source of data (such as a
table on a database), so that data can be viewed within the context of the data model. As part of
the process of creating a federated data class, BMC Atrium CMDB creates attributes to represent
the fields from the external repository. Federated data classes that you create are subclasses of the
BMC_FederatedBaseElement class.
The federated relationship class establishes a relationship between CIs stored in BMC Atrium
CMDB and external data. Federated relationship classes that you create are added to the data
model as subclasses of the BMC_FederatedBaseRelationship class. The source class of the
relationship must be in the BMC_BaseElement hierarchy of classes, and the destination class of
the relationship must be a federated data class.
Launch method of federation

With the launch method of federation, you define the method of viewing the data (such as opening
the data on a BMC Remedy AR System form), and create a link between that data and CIs in BMC
Atrium CMDB. For example, you could use the URL method to access any database to which you
allow browser access, and you could use the BMC Remedy AR System query method to access
data from a BMC Remedy AR System form.
BMC Atrium CMDB uses several types of objects to implement federation. The following figure
illustrates these objects, each of which is represented by a class in the BMC Atrium CMDB
metadata.
Federation objects for the launch method
BMC Atrium Core 9.0
Page 194 of 2268
Home
A CI class or instance has a launch link relationship to a launch interface, which defines the
information necessary to access a particular piece of federated data.
The launch interface has a federated product link relationship from a federated data store, which
names an external source of data. Because an external source of data might offer several types of
federated data, each federated data store can be linked to multiple launch interfaces.
If foreign key substitution is used, the federated data store also has one or more federated key link
relationships to CIs. This relationship carries the key value that identifies the federated data for the
CI.
BMC Atrium CMDB offers attribute substitution and foreign key substitution as ways to implement
the launch method of federation.
Attribute substitution and federated data

Attribute substitution is the more straightforward method of federating data in context. The
information in a launch interface can include placeholders representing attributes from the linked
class. The values for those attributes are substituted when a user or application launches the link,
which enables it to access a different set of federated data for each instance of the class.
The following figure shows an example of this. The value of the Name attribute is substituted in the
launch interface, so that the access string for Computer A queries for incident records where
Machine = "Computer A" and the access string for Computer B queries for incident records where
Machine = "Computer B."
Attribute substitution
BMC Atrium Core 9.0
Page 195 of 2268
Home
Foreign key substitution and federated data

Some external sources of data do not have data that also exists as attributes of CIs in BMC Atrium
CMDB, which means that you cannot use attribute substitution to match a CI to pieces of federated
data. You can still federate this data in context by using a foreign key, a unique identifier in the data
store that maps to a specific CI.
BMC Atrium Core 9.0
Page 196 of 2268
Home
For example, you might have maintenance contracts for your office equipment, where the contracts
do not see individual pieces of equipment. If you have no single piece of data to link the contract to
a CI, you can create a foreign key link that enables you to identify the contract that is associated
with a particular CI.
In addition to the relationship between the CI (or its class) and a launch interface that is required for
any federation, using a foreign key also requires a relationship between the CI and the external
source of data, containing the key. This relationship enables the key to be substituted in to the
information in a launch interface whenever a link to that interface is launched from that CI.
Note
You can get the same functionality by adding an attribute to classes in the Common Data
Model and storing the key there, or by adding an attribute in your federated data store and
storing the instance ID or reconciliation ID of CIs there, which enables you to use attribute
substitution instead. This provides faster performance when accessing federated data and
eliminates the management of federated key relationships. Add an attribute in BMC
Atrium CMDB only if the attribute will be populated for most instances of the class.
Controlling access to data with multitenancy

BMC Atrium Configuration Management Database (BMC Atrium CMDB) offers a flexible
permissions model that lets you grant role-based permission to areas of BMC Atrium CMDB
functionality and grant row-level read and write permission to instance data.
This row-level security enables BMC Atrium CMDB to support multitenancy. Multitenancy means
that one CMDB holds data about multiple parties' IT environments, usually in the case of an IT
service provider, and each party can access only their own data. Each party whose data is
represented in the CMDB is considered an account.
BMC Atrium CMDB multitenancy permission model
Calbro Services' access implementation
Overview of multitenancy in BMC Atrium Core

Multitenancy has long been a feature in the BMC Remedy IT Service Management (BMC Remedy
ITSM) product suite that enables you to control which records and configuration data are exposed
to a user, based on the user's membership in a company, business unit, or other group.
Although multitenancy is primarily used by consuming applications such as BMC Remedy ITSM
and Service Impact Manager, BMC Atrium CMDB provides the mechanisms for a multitenancy
permission model. BMC Atrium CMDB also defines a base implementation for a multitenancy
permission model. You can extend this base implementation or develop a new implementation that
is consistent with the base implementation. The Product Catalog component also leverages
BMC Atrium Core 9.0
Page 197 of 2268
Home
multitenancy. If you have not installed BMC Remedy ITSM, you can set up multitenancy by using
the Product Catalog and the AccountID default instance permissions in BMC Atrium CMDB. If you
do this, make sure that the AccountID values match the company values in the Company form.
AccountID is used to control BMC Atrium CMDB multitenancy, while the company field is used to
control multitenancy in the Product Catalog and BMC Remedy ITSM applications.
You can use multitenancy to control access in a hosted environment. For example, in a service
provider environment, a single BMC Atrium CMDB application might be used by multiple companies
, with the data for each company hidden from the other companies using the application. You can
also use multitenancy to control access in a single company, with the data for each business unit
hidden from other business units.
Multitenancy is used to segregate data and restrict access by the Company field, in BMC Remedy
ITSM, or the Company form in BMC Remedy Action Request System. Access restrictions can be
created so that a user with access to only one company cannot see data for another company. To
segregate data by business unit, you must record each business unit as a separate company. In
this scenario, a user with access to only one business unit cannot see incidents for another
business unit.
Note
You can use BMC Remedy ITSM to set up multitenancy. However, if you have not
installed BMC Remedy ITSM, you can set up multitenancy by using the Product Catalog
component of BMC Atrium Core. For more information, see Multitenancy support in the
Product Catalog.
BMC Atrium CMDB multitenancy permission model

The DefaultAccountPermissions class enables you to define default permissions based on
AccountID. From the account ID, you can assign default permissions when you create
configuration items (CIs). Default instance permissions enable you to specify
CMDBRowLevelSecurity and CMDBWriteSecurity values for an entire class instead of
specifying them every time you create an instance of the class. You can give these permissions to
a different group for each account ID, which supports multitenancy by enabling you to grant users
access to only the instances for their account. For more information about default instance
permissions, as well as roles and other permissions, see Managing permissions in BMC Atrium
Core.
The Product Catalog supports defining approved products for different organizations. Multitenancy
enables you to have a single Product Catalog shared among multiple organizations and track the
approved products for each organization.
BMC Atrium Core 9.0
Page 198 of 2268
Home
You can define the approved items for the version and patch levels, not just the product name. All
the other options in the Product Catalog are separated for each products by organization as well.
For more information, see Multitenancy support in the Product Catalog and Product Catalog and
multitenancy.
Calbro Services' access implementation

Calbro Services has several different business units. Although each business unit is part of the
overall company, the various business units need access to different applications and data. For
example, all employees of Calbro Services can install Microsoft Word, but only certain members of
Finance should install and work with the payroll application. HR has a similar restriction on the job
posting and recruitment application used by that business unit. Members of IT should have access
to all applications.
Calbro Services must set up product access and restrictions in the Product Catalog for Finance and
HR. IT will have access to all possible products. The following figure illustrates the access in this
scenario, in which some people have access to Finance products, some people have access to HR
products, and others have unrestricted access to all products.
Access to applications in business units
This scenario includes the following groups:

Finance People in this group can access products used only by Finance.
HR People in this group can access products used only by HR.
IT People in this group can access all products, including those used by HR and Finance.
Allen Allbrook, the Calbro Services administrator, creates Operating Company entries for Finance,
HR, and IT in the Product Catalog. This automatically creates BMC Remedy Action Request
System (BMC Remedy AR System) regular groups for these Operating Companies.
BMC Atrium Core 9.0
Page 199 of 2268
Home
Next, Allen assigns individual employees to these BMC Remedy AR System groups. For example,
Allen adds Patrick Paycheck to the Finance group, Betty Benefits to the HR group, and himself to
the IT group.
Allen can then configure the Product Catalog entries for application access according to the
Operating Company. Allen allows the Global company (everyone at Calbro Services) access to
Microsoft Word, the Finance company access to the payroll application, the HR company access to
the job posting and recruitment application, and the IT company access to all applications.
Note
Membership in a business unit is not the same as access to a business unit.
Product Catalog entries do not restrict employee access to applications, but Allen can run discovery
reports about the applications installed on employee computers, and then uninstall applications that
are not approved for use according to the Product Catalog.
Additionally, people in Finance need to see employee information stored in the BMC_Person form,
while people in HR need access to change information on that form. To accomplish this, Allen
establishes instance permissions to data on the BMC_Person form. He first makes sure that the
Finance and HR groups have access to the CMDB Data View role. Next, Allen adds the Finance
and HR groups to the CMDBRowLevelSecurity attribute value for BMC_Person entries those
employees should see. Allen then adds the HR group to the CMDBWriteSecurity attribute value
for entries that HR employees should have access to modify.
For more information about how permissions and multitenancy are related to products used by a
company, see Product Catalog and multitenancy. For information about setting permissions, see
Managing permissions in BMC Atrium Core .
Sizing considerations for populating BMC Atrium CMDB

When planning for BMC Atrium Configuration Management Database (BMC Atrium CMDB)
population, you should consider sizing factors, scalability, and hardware recommendations for the
BMC Remedy AR System environment. This includes the BMC Remedy Action Request System (
BMC Remedy AR System) server, server tier components such as Approval Server and the
Assignment Engine, BMC Atrium CMDB components, and the BMC Remedy Mid Tier. The same
consideration should be given to the discovery applications that you choose.
For detailed information about sizing, see the white paper titled Reference Architecture for BMC
Service Support Solutions on BMC support website.
BMC Atrium Core 9.0
Page 200 of 2268
Home
Replicating BMC Atrium CMDB data to other servers

You might want to replicate all or part of your CMDB to other servers for a number of reasons,
including disaster recovery, accessibility, or regional or departmental use. This is perfectly
acceptable, and can be accomplished with the Distributed Server Option of BMC Remedy Action
Request System (BMC Remedy AR System) or with database replication.
However, do not split your primary CMDB. Turning a CMDB into a distributed database defeats its
purpose of being a single shared access point for all the configuration data about an organization.
Planning data normalization and the Product Catalog

The following topics explain the purpose of data normalization and describes the Product Catalog
component of BMC Atrium Configuration Management Database (BMC Atrium CMDB):
Overview of normalization and the Product Catalog
Normalization overview in BMC Atrium Core
BMC Atrium Product Catalog overview
How Calbro Services planned normalization and Product Catalog implementation
Overview of normalization and the Product Catalog

The Normalization Engine and the Product Catalog are separate components but are described
together because of their close interaction. In the context of BMC Atrium Core, normalization refers
to modifying configuration items (CIs) and relationships to conform to consistent standards.
Primarily, this involves ensuring that product names and categorizations are consistent across
different datasets and from different data providers. Data of the same type follows the same
formatting conventions. In that role, the Normalization Engine typically relies on the Product
Catalog.
For example, a product that might have different names representing the same product is Microsoft
Office Word. Different discovery tools might record this product's name as Microsoft Office Word,
MS Word, Word 2003, and so on. Each of these names might seem to represent a different product
. The Normalization Engine can determine that these different names represent the same product,
and alters each instance to use the approved name.
The benefit of normalization is that you get accurate results when searching or running reports for
your data. For example, you can use the License Engine component of BMC Asset Management
determine whether your environment has more installed copies of something than your license
allows.
BMC Atrium Core 9.0
Page 201 of 2268
Home
The following figure shows a simplified flow of data from either discovery or transfer of existing data
with Atrium Integrator. Data from each source or discovery tool is organized into datasets, which
are then reconciled so that one production dataset represents your environment. You can also
create datasets to group data; however, the datasets represented in the following figure depict the
initial datasets that are part of the discovery or transfer process.
Data flow
Normalization overview in BMC Atrium Core

You can choose to normalize data before or after it is written to a dataset in BMC Atrium
Normalization batch (scheduled) mode, enabled by default, can be scheduled or started
manually from the Normalization Console.
Inline normalization mode normalizes configuration items (CIs) before they are written to
BMC Atrium CMDB datasets.
Continuous normalization mode allows CIs to be written to a dataset before they are
normalized.
BMC Atrium Core 9.0
Page 202 of 2268
Home
Recommendations
When you initially load CIs from your data providers into BMC Atrium CMDB, BMC recommends
that you use the batch mode rather than inline or continuous normalization. Batch mode runs a
Normalization Engine job on un-normalized data on demand or on schedule that meets your needs.
If you are implementing BMC Atrium CMDB for the first time, your current data will not be
normalized. After the initial loading of CIs, you can use the inline or continuous mode to update CIs
that exist in BMC Atrium CMDB but are not normalized.
To make sure that data is normalized initially and kept normalized, use continuous mode to make
sure that your dataset remains normalized.
Inline mode is used mainly for integrations when a data source is writing to BMC Atrium CMDB,
and you might need to take action during the data population process if an error occurs.
For more information about normalization, see Normalizing data.
BMC Atrium Product Catalog overview

The Product Catalog is a BMC Remedy Action Request System (BMC Remedy AR System)
application that includes several components to manage products for companies and organizations.
It is a library of all the products available to an organization, defining each product and its attributes,
such as name, manufacturer, version, and so on. The Product Catalog contains characteristics of
products that enhance the accuracy of BMC Discovery products by uniquely identifying a package
regardless of installed name or location.
Purpose of the Product Catalog
Entries in the Product Catalog
Components of the Product Catalog
Categorizations in the Product Catalog and BMC Atrium CMDB
Multitenancy and the Product Catalog
Purpose of the Product Catalog

The main purpose of the Product Catalog is to enable you to manage the products in your
organization:
By providing identifying characteristics of products
By providing a single name for each product and its versions
By providing data for normalization and discovery, including storage of product signatures
By recording whether a product is approved for use in your organization
By tracking and managing products by categorization, life cycle, development status,
approval status, and other attributes
By managing products by companies and organizations (multitenancy)
By providing data for license management, compliance, and usage tracking
For more information about the Product Catalog, see Managing the Product Catalog.
BMC Atrium Core 9.0
Page 203 of 2268
Home
Entries in the Product Catalog

A Product Catalog entry is not a configuration item (CI) but specifies the normalized attributes for
CIs. Thus, a CI is an instance of a product defined in the Product Catalog. For example, a dataset
includes a BMC_Product CI named Microsoft Office Excel 2007. The Product Catalog has a
product entry named Microsoft Office Excel 2007.
Each Product Catalog entry must be unique. A Product Catalog entry is considered unique based
on the manufacturer name, product name, and product categorization tier 1, tier 2, and tier 3 values
. These values correspond to the ManufacturerName, Model, Category, Type, and Item (CTI)
attributes in a CI.
Components of the Product Catalog

The Definitive Media Library (DML) is a subset, or filter, of the Product Catalog that represents
software products that are marked as approved for use in an organization. In previous releases of
ITIL, the DML was called the Definitive Software Library.
The Definitive Hardware Library (DHL) is a subset, or filter, of the Product Catalog that represents
hardware products that are marked as approved for use in an organization.
Categorizations in the Product Catalog and BMC Atrium CMDB

Product categorization divides CIs into groups. Using the tiered structure of product categorization,
you can create successively smaller, more tightly defined groups. You can create groups of CIs in
Tier 1. In Tier 2, you can define smaller groups of each of those groups. In Tier 3, you can create
even smaller groups within these groups.
For example, you might use Tier 1 to divide CIs into hardware and software groups. Within the
hardware group, you might define Tier 2 groups for disk device, peripheral, processing unit, and
virtual system. Within the processing unit group, you might define Tier 3 groups for desktop, laptop,
mainframe, personal digital assistant, and server.
CIs in BMC Atrium Configuration Management Database (BMC Atrium CMDB) store Product
Catalog categorizations in the Category (Tier 1), Type (Tier 2), and Item (Tier 3) attributes of the
BMC_BaseElement CDM class.
Multitenancy and the Product Catalog

enables you to share a single Product Catalog among multiple organizations but track the approved
products for each organization from the same Product Catalog data.
BMC Atrium Core 9.0
Page 204 of 2268
Home
How Calbro Services planned normalization and Product Catalog implementation

Because Calbro Services is populating BMC Atrium Configuration Management Database (BMC
Atrium CMDB) for the first time, the administrator uses the default batch mode to normalize data.
This makes sure that all of the existing configuration items (CIs) are normalized by a single
Normalization Engine run. After the initial normalization, the administrator sets up the continuous
normalization mode to make sure that the data remains normalized.
The Normalization Engine evaluates CIs with information it retrieves from the Product Catalog and
normalizes the following attributes for Calbro Services' hardware and software products:
Name
Product categorization attributes: Category, Type, and Item
ManufacturerName
Model
MarketVersion (applicable to software)
PatchNumber (applicable to software)
Other attributes as defined by each class
For example, software CIs named Microsoft Visio and Visio 2007 are normalized to the approved
name Microsoft Office Visio 2007. Printer CIs are normalized to the approved Category, Type,
and Item values of Hardware, Printer/Multifunction, and System--Printer, respectively.

This section describes how to plan for the reconciliation of data from source datasets to a
production dataset. With multiple data providers loading data into multiple datasets of BMC Atrium
Configuration Management Database (BMC Atrium CMDB), you need a reconciliation process to
compare expected data against discovered data and create one complete and correct production
dataset. The BMC Atrium CMDB Reconciliation Engine performs the main reconciliation tasks of
identifying, merging, and comparing datasets and also gives you other tools for working with
datasets.
Identifying instances across datasets
Comparing datasets with the Reconciliation Engine
Merging datasets with the Reconciliation Engine
Other reconciliation activities
Combining activities as a reconciliation job
Qualification groups in reconciliation activities
BMC Atrium Core 9.0
Page 205 of 2268
Home
Identifying instances across datasets

Before you can compare or merge different versions of an entity, you must determine that they
indeed represent the same entity. You must identify each instance.
The Identify activity accomplishes this matching by applying rules that you specify against instances
of the same class in different datasets. For example, a rule to identify computer system instances
might specify that the IP addresses of the instances be equal.
When the rules find a match, both instances are tagged with the same reconciliation identity, an
extra attribute that shows that they each represent the same item in their respective datasets.
You can also manually identify instances that were not identified by rules in an Identify activity.
To identify instances, you must create an Identify group for each participating dataset. In this group
you must create Identify rules that attempt to match instances of a particular class in that dataset
against instances in all other participating datasets. For example, to compare datasets A, B, and C
you need the following groups: one each to match A against B and C, B against A and C, and C
against A and B.
To identify data in different classes based on different criteria, you must create more Identify groups
. Because the subclasses of the specified class inherit the groups, if your data is sufficiently
normalized, you could specify groups only for the base class BMC_BaseElement.
You then create an Identify activity and associate the Identify groups to it. Designate one of the
participating datasets as the master dataset, meaning that the reconciliation identity of its instances
is applied to matching instances in the other datasets, which are known as auto-identify datasets. If
the instance in the master dataset does not have an identity, one is automatically generated.
Tip
If you identify a class between datasets that are poorly normalized and you cannot find
attributes of the class itself on which to match, you can match on an attribute of a source
CI if a weak relationship exists and has any propagated attributes. For example, if you
always give a disk drive a BMC_HostedSystemComponent relationship to the computer
system where it is installed, you can match two disk drives because their source computer
systems have the same name, because BMC_HostedSystemComponent propagates the
Name attribute from system to component.
For more information about identifying, see Matching instances across datasets by using a
reconciliation Identify activity.
BMC Atrium Core 9.0
Page 206 of 2268
Home
Comparing datasets with the Reconciliation Engine

The Compare activity operates against instances in two datasets and either produces a report or
executes workflow based on the Compare results. The report shows those instances that appear in
only one of the datasets and details the differences between instances that appear in both.
Compare lets you compare an expected configuration against an actual one, which you could use
for more than one purpose. You might use Compare to alert you that something has changed in a
configuration that you expected to remain static. Alternatively, if you have a change request in
progress, you might use Compare to verify that the configuration reaches its expected new state.
Only instances that have been given a reconciliation identity can be compared, and they are
compared only against other instances with the same identity. If you choose to execute workflow as
a result of the comparison instead of creating a report, that workflow can execute against instances
from either dataset but not both.
To compare instances, you must create a Compare activity and specify the two datasets that you
want to compare. From that activity you can choose to exclude particular attributes from the
comparison by creating Exclusion rules for them.
To execute workflow as a result of the comparison, you must also create a Workflow Execution
group to associate with the Compare activity and from that group, create a Workflow Execution rule
for each qualification that, if true, causes workflow to execute. The qualification can evaluate
attributes from both datasets.
You also must create one or more BMC Remedy Action Request System (BMC Remedy AR
System) filters to perform the workflow for each Workflow Execution rule.
For more information about comparing, see Comparing datasets by using the Reconciliation Engine
.
Merging datasets with the Reconciliation Engine

Merging takes data from multiple source datasets and creates a composite by copying that data to
a single target dataset according to precedence values that you specify.
Using a single Merge activity
Using independent Merge activities
Merging is essential to produce a single, valid configuration when different discovery applications
provide overlapping data about the same items, or when you need to commit changes that were
made in an overlay dataset. Only instances that have been given an identity can participate in a
Merge. To take advantage of the areas of strength in each dataset, you create precedence values
that favor those strengths. Merging the highest-precedence attribute values gives you one
configuration item (CI) instance with the best of all discovered data.
BMC Atrium Core 9.0
Page 207 of 2268
Home
An overall precedence value is given to each dataset, with the ability to override it for particular
classes and attributes in each dataset. Whichever dataset has the highest precedence value for a
given attribute has its value for that attribute placed in the target dataset. A precedence value
specified for a class also applies to its subclasses unless they override it with precedence values of
their own.
You can merge data from multiple source datasets either by creating one Merge activity that
includes all the source datasets or by creating independent Merge activities that each merge only
the data from one source dataset.
Tip
No matter which of these strategies you choose, you can shorten the run time of a Merge
activity by setting Force Attribute Merge to No. This causes the activity to perform an
incremental merge, processing only the attribute values that have been modified since the
activity was last run. If an attribute value has not changed, there is no need to merge it
again.
Using a single Merge activity

When you use one Merge activity, the precedence values of all source datasets are compared to
each other at once, and the data from the dataset with the highest precedence value is written to
the target dataset. The following figure provides an example of precedence values being applied
when two datasets are merged with a single Merge activity.
Single Merge activity with two source datasets
BMC Atrium Core 9.0
Page 208 of 2268
Home
In this example, source Datasets A and B are merged into target Dataset C. Though Dataset A has
a higher precedence value (500) than Dataset B (300), Dataset A has class and attribute
precedence values for Application System and the IPAddress attribute of Computer
System (both 200) that are lower than Dataset B. Dataset C has a precedence value (100) lower
than either source, and as a result, none of the data it contained in step 1 survives the merge.
In the Merge activity represented by step 2, Dataset C receives the Monitor and the SystemType
attribute of the Computer System from Dataset A, with a precedence value that trumps Dataset
B's. But because the Application System and the IPAddress attribute of the Computer
System have lower precedence values in Dataset A, Dataset C receives these from Dataset B.
BMC Atrium Core 9.0
Page 209 of 2268
Home
Using independent Merge activities

Using independent Merge activities is the recommended method of merging datasets, using only
one source dataset per Merge activity. After each Merge activity runs, the target dataset retains
for each attribute that was merged the precedence value of the dataset that supplied the data for
that attribute. When you use independent Merge activities, each activity compares the precedence
values of its source dataset to the precedence values of those last victorious datasets.
Because the source dataset in any merge is always compared against the highest precedence
value from previous merges, it is as though precedence values from all source datasets are
compared in each merge. This frees you from having to design a Merge activity for every
combination of source datasets that might be merged together, and enables you to add new source
datasets in the future without reworking all your Merge activities. The following figure provides an
example of precedence values being applied when two datasets are merged with independent
Merge activities.
Independent Merge activities, each with one source dataset
BMC Atrium Core 9.0
Page 210 of 2268
Home
This example uses the same source and target datasets as the example in Single Merge activity
with two source datasets, and achieves the same end result. Step 1 again shows the data in the
target dataset before the merge.
In the Merge activity represented by step 2, Dataset A is merged into Dataset C. Dataset A's
precedence values at every level are higher than Dataset C's, so after this step Dataset C contains
all the data from Dataset A. You can also see that though Dataset C's precedence value is still 100,
the precedence values of the data in it have been adopted from Dataset A.
In the Merge activity represented by step 3, Dataset B is merged into Dataset C. Dataset B's
precedence value of 300 is enough to beat the precedence values stored for all attributes of the
Application System and the IPAddress attribute of the Computer System, so its data
BMC Atrium Core 9.0
Page 211 of 2268
Home
replaces the data written from Dataset A in step 1. But Dataset B's data for all attributes of the
Monitor and the SystemType attribute of the Computer System is not written to the target
because the data placed there from Dataset A has higher precedence values.
For more information about merging, see Merging datasets into a reconciled target dataset .
Other reconciliation activities

The Reconciliation Engine offers the following additional activities:
Rename Dataset Renames a dataset. It does not change the DatasetId, so all
reconciliation definitions that include the dataset still work with the new name.
Copy Dataset Copies instances from one dataset to another. You can set options to
determine which relationships and related configuration items (CIs) are copied along with the
selected instances.
Delete Dataset Deletes instances from one or more datasets. It does not delete the
dataset itself.
Purge Dataset Deletes instances that have been marked as deleted from one or more
datasets. You can opt to have it verify that each instance has also been marked as deleted
in another dataset before deleting it. This option is useful when you are purging data from a
discovery dataset but want to purge only instances that are marked as deleted in your
production dataset.
Execute Job Executes a reconciliation job.
For more information, see Additional reconciliation activities.
Combining activities as a reconciliation job

You can create and execute reconciliation activities only as part of a job, which can contain multiple
activities and performs them in the sequence that you specify. When you remove an activity from a
job, it is deleted and cannot be used in other jobs. You can run a job:
With schedules defined for the job
Manually
From another job
From a BMC Atrium Configuration Management Database (BMC Atrium CMDB) API
program
From BMC Remedy Action Request System (BMC Remedy AR System) workflow
When you use BMC Remedy AR System workflow or a BMC Atrium CMDB API program to execute
a job, you can dynamically specify datasets and qualifications for the job to operate against,
replacing those defined for the job. This enables you to reuse reconciliation definitions with multiple
overlay datasets and with subsets of data.
For more information, see Starting and stopping a reconciliation job .
BMC Atrium Core 9.0
Page 212 of 2268
Home
Qualification groups in reconciliation activities

Most reconciliation activities enable you to specify a Qualification group to restrict the instances that
participate in an activity. Qualification groups, which are reusable between activities, are sets of
qualification rules that each select certain attribute values. Any instance that matches at least one
Qualification in a group can participate in an activity that specifies the group.
For example, if your company just opened a Frankfurt office and you are reconciling its discovered
configuration items (CIs) for the first time, you might create a Qualification group that selects
instances that were discovered within the last 24 hours and have the domain Frankfurt.
For more information on qualifications, see Using Qualification Sets in reconciliation activities .

The following topics provide information about designing, developing, and maintaining service
models that enable you to manage your IT resources from the perspective of the business services
that they provide:
Service model overview
Service model components
Designing a service model

A service model defines the various resources that deliver business services, models their
behaviors and functional relationships, and manages the delivery of the resulting services.
Designing and building a robust service model enables you to view and change the relationships
between the different components in the model, as well as add new components to the model.
Relationships between service components
Adding CIs and relationships to service models using BMC Atrium CMDB
Relationships between service components

A physical or logical resource represented in the model is known as a service component instance
or component instance. The functional relationship between two resources (component instances)
is called a service component relationship or a relationship. These concepts are illustrated in the
following figure.
Service model objects
BMC Atrium Core 9.0
Page 213 of 2268
Home
For example, Calbro Services uses an online banking application that supports its customers' ability
to access accounts and complete transactions. The relationship between these two items (the
online banking application and the actual banking service) is part of the service model.
A service model that relates business services to IT enables IT to pinpoint root causes and
prioritize business-critical problems. Understanding what a service is and how it delivers value to
the business is the foundation for Service Transition, an ITIL process. In ITIL version 3, IT
processes are part of the service lifecycle and IT services are viewed as business assets. The
online store depicted in the following figure illustrates that IT is a business asset because the online
checkout is only as good as the physical server on which the checkout software resides, or the
software itself. If either the hardware or software fails, the user cannot complete his purchase.
Adding CIs and relationships to service models using BMC Atrium CMDB
BMC Atrium Configuration Management Database (BMC Atrium CMDB) is a possible source for
service model objects that are used by BMC Service Impact Manager (BMC SIM) and other BSM
applications. Understanding service models in general can help you as you plan, populate, and
work in BMC Atrium CMDB. Typically, objects used by BMC SIM are discovered using discovery
tools. They are reconciled by the BMC Atrium CMDB Reconciliation Engine, and then automatically
published to the BMC Impact Manager by using BMC Impact Publishing Server.
You can also use BMC Atrium Explorer to create relationships between CIs for special cases, such
as when you have two configuration items (CIs) that were created manually through BMC Atrium
Explorer. You can use this method for creating business assets like business service objects and
organization objects.
BMC Atrium Core 9.0
Page 214 of 2268
Home
You can use BMC Atrium Impact Simulator whether you use BMC SIM in your environment or not.
The Atrium Impact Simulator predicts the impact on CIs by using the impact relationships that you
configure within BMC Atrium CMDB. Atrium Impact Simulator can also use the impact relationships
configured with BMC Service Impact Manager.
For more information about service models as used in BMC Service Impact Manager, see the BMC
Impact Solutions: Service Model Administrator's Guide . For more information about Atrium Impact
Simulator, see Simulating the impact of changes to CIs .

To support a service model that complies with ITIL v3, BMC Atrium Configuration Management
Database (BMC Atrium CMDB) includes several components that combine the utility (what a
service does) and warranty (how the service is delivered). The following figure shows a high-level
view of these components.
BMC Atrium Core 9.0
Page 215 of 2268
Home
Service Describes functionality that an organization provides. In BMC Atrium Core, the
service is a container that includes service and requestable offerings and service level
targets.
Business service Services available to customers that show the consumer view of
services, such as email or an online store.
Technical service Supporting IT and infrastructure resources required to support
business services that are not visible to customers, such as servers, applications, and
network configuration items (CIs). These technical services can be associated in BMC
Atrium Explorer with CI queries.
Service offering Defines what service an organization provides and how it is provided. A
service offering defines a level of service for a price; it combines the service (utility) and a
service level target (warranty), and add-on options to bring value to the customer. All
technical and business services must have at least one service offering. However, a service
can have more than one service offering. You can also associate a service offering with a
technical service.
Requestable offering Defines what service an organization provides and how it is
provided. However, unlike service offering, end users can see and select a requestable
offering. The requestable offerings provide options for how IT implements the service
offering. Each requestable offering defines a level of service for a price: it combines the
service (utility), a service level target (warranty), and add-on options.
Service level target Describes measurements for the performance of a service or offering.
Options Describes discrete choices that customers can select. for a service, requestable
offering, and transactional offering. Each option has one or more choices, each of which has
cost and price information. These options and their choices are available for users to select.
They are managed separately from offerings because they do not rely on a specific offering,
making the options reusable.
Designing a service model

Building a service model can be a daunting task. When you begin the process, it might be helpful to
select one critical business process or service, decompose it to identify all aspects of the service,
and build a complete service model for that part of your enterprise.
Understanding how the various components of one business service interact helps you construct
other pieces of your service model, and helps you understand how services themselves affect each
other. For example, you might discover that your payroll service depends on a technical service
that provides access to information through the corporate intranet.
Defining business goals for the service model
Decomposing a business service
Defining the service model
The following figure shows an example of a service model with business users, services, and IT
structure layers. The lines between the component instances represent impact relationships.
BMC Atrium Core 9.0
Page 216 of 2268
Home
Example of a service model
Consider the following factors in determining how to design a service model:

The diversity of IT resources and how they are monitored
The location of resources and how the management responsibilities for them are distributed
within and among IT groups
The relative importance of various resources in the delivery of business services
The need for Change Management
The maintainability of the service model over time
The service modeling process involves:
BMC Atrium Core 9.0
Page 217 of 2268
Home
Defining business goals

Recommendations
When designing a service model, consider the following recommendations:
Agree on a model blueprint that applies to all service models. The model blueprint acts as a
template to the construction of the different service models, and should define a hierarchical
organization and the types of configuration items (CIs) that relate to each other. The
blueprint should allow some flexibility.
Define terms and concepts beforehand. To your organization, what is a business process or
an IT component? What are your severity and priority levels and what is the meaning of
each? You don't necessarily have to use the ITIL definitions for all these things, but you
should have definitions that can guide you and help settle disputes while you design service
models.
Defining business goals for the service model

The most basic step involved in defining a service model is defining the specific business goals that
you hope to achieve with the model.
To do so, the IT group must engage the business managers in defining short-term, mid-term, and
long-term goals for the enterprise. These goals guide the design and development of deliverables
for all service model development phases and define the amount of time and effort required for
development and implementation.
Some possible goals are:
Business continuity and service availability This type of implementation is driven from the
top and makes sure that IT is delivering their services as agreed. It consists of a
business-centric model in which business processes, services, and service level agreements
(SLAs) rely on a small number of vital IT components that measure the pulse of the
underlying environment.
Business-focused operational efficiency This type of implementation is likely to involve
various populations and centers of management in the enterprise. It consists of a balanced
representation of the operational environment, encompassing the IT components, such as
systems and applications, and the logical components, such as services, and other business
objects.
BMC Atrium Core 9.0
Page 218 of 2268
Home
Operational efficiency This type of implementation is run by and for the IT group. It
consists of a thin layer of logical groups on top of a large number of IT resources, ranging
from applications and systems to hard disks and other hardware components. Services are
logical groupings that provide a convenient way of classifying the technical resources. For
example, you might use an email service to classify all of the servers and software required
to enable people to send and receive email.

The purpose of decomposing a business service is to identify and document business processes,
identify the IT (technical) services that support them, and identify IT components and assets that
provide the technical services. Business processes are determined at a high level and can include
other processes, such as Marketing and Sales. This document focuses on how business services
are impacted and supported by IT.
For example, the online banking division of Calbro Services might identify a business service as the
ability of customers to transfer funds, a common service for an online banking company. A
technical service that supports this service is the maintenance of the network on which the servers
that facilitate the fund transfer communicate. The supporting IT assets are the servers, databases,
and related hardware and software systems that facilitate the fund-transfer service.
Recommendations
Identifying business services
Identifying technical services
The following figure depicts a scenario in which the application server resides on a virtual machine (
VM), which, in turn is running on a server capable of hosting several VMs. The system is set up so
that, if one VM fails, another VM resumes the process without interruption. The fund-transfer
business service depends on everything in the gray box, which IT provides and supports.
Example of a business service and the supporting IT assets
BMC Atrium Core 9.0
Page 219 of 2268
Home
The fund-transfer service is only one business service provided by Calbro Services. The service
model created by Calbro Services is a collection of service components, each of which represents
a business service. Each component can contain several functional applications, each of which can
have multiple IT components. A service model shows how the components are interconnected and
shows how component failures can impact other services. See Example of a service model.
Recommendations
When decomposing a business service, consider the following recommendations:
To find IT services and the components that support them, look at service level agreements
and operational level agreements.
Determine the entry point to each service model, the highest object in the model. The entry
point depends on who is consuming the model. Working from here down to the bottom of a
service model makes sure that you operate from the perspective of the business.
BMC Atrium Core 9.0
Page 220 of 2268
Home
Identifying business services

To identify business services, start by gathering information from such sources as business unit
managers, business process managers, and staff personnel knowledgeable about the business
services. Company organization charts might be helpful in identifying the relevant people.
The process involves interviewing the managers and identifying the following information:
Business processes Identify key business processes such as Market Research, Product
Planning, Response Management, or Case Management. There can be multiple levels of
business processes, starting with higher level core competencies and business functions, to
specific sub-business processes.
Functional applications Identify the business applications that support the business
processes. Map the business processes to the functional applications.
Map functional applications to service components to create the business service models.
See the following figure for an example of functional applications mapped to a business
service.
Identifying technical services

To identify technical services, consult IT managers and staff. Disaster recovery plans, help desk
documents, and purchase orders might be useful in identifying IT components and the business
processes that they support.
The process involves identifying the list of IT assets (components). Interview the IT management
and staff, or use an asset database or CMDB as resources:
Create a list of technical services and discover what technical services are offered to
business units through use of IT assets. Examples of technical services include customer
support and customer call monitoring.
Note
The Service Catalog component of the BMC Atrium Core Console depicts IT
services as Technical Services.
For each technical service, identify the IT components that support the service.
Identify the interdependencies among IT components and formulate a topology map.
Consider the relationships and dependencies between IT components.
As you build your model, use whatever tools you have to depict the dependencies between
business services and technical services. Use graphical and spreadsheet software if you do not
have a solution such as BMC Impact Solutions. The following table shows a portion of a
spreadsheet depicting a few business services and their relationships.
BMC Atrium Core 9.0
Page 221 of 2268
Home
Portion of a sample business service model spreadsheet

Business
Business
Business
service
functions
processes
24/7 online
banking
Transfer
funds
Operational
efficiency
Technical services
IT component
Administrative
software and
Software applications, application servers, virtual

machines, databases
hardware
Pay bills
Discount
equity services
Execute
trades
Manage
customer
Front office
sales
Response
management
Incident tracking
software
Application server
Customer
Support
FTP
Server: FTP
support
service
requests
Sprint
Server: Walrus
Sales Logix
Database: SALLOG Applications: Sales Logix User group:
relations
Tech Support dept Servers: Antelope

Defining the service model involves establishing a list of all the IT resources that should be
represented in the service model. This information should include the following items:
Each resource's name or component identification pattern
Its location or site
Use this information later in the design phase and when creating service model components.
The first step in developing a service model is to design its logical architecture. To do this, you must
analyze the IT environment to:
Identify the resources that make up the service model.
Determine the functional relationships and dependencies between various resources that
can affect services.
For information about using the Service Catalog in the BMC Atrium Core Console, see
Administering service models and the Service Catalog .
For information about how to create configuration items (CIs), see the Creating CIs in BMC Atrium
Explorer.

For information about installation or upgrade of BMC Atrium Core, see the following topics from the
BMC Remedy ITSM Deployment
BMC Atrium Core 9.0
online documentation:
Page 222 of 2268
Home
For installation, see Installing
For upgrade paths and upgrade process, see Upgrading
BMC Atrium Core support for IPv6

BMC Atrium Core supports Internet Protocol version 6 (IPv6) network addresses. You can deploy
BMC Remedy AR System servers in an IPv6 configured network and make them accessible to
clients on IPv4, IPv6, or both IPv4 and IPv6 (dual stack) configured hosts.
IPv6 is an internet protocol that replaces IPv4. It expands the IP address space from 32-bit to 128bit to significantly increase the number of available IP addresses. To comply with a United States of
America federal mandate, the software products of government vendors must support operation on
IPv6 networks.
BMC Atrium Core supports the same operating systems and databases for IPv6 as BMC Remedy
AR System, as described in Support for IPv6 in the BMC Remedy AR System 8.1 online
documentation. In addition, BMC Atrium Core has the following IPv6 considerations.
Except for BMC Atrium Integration Engine, all BMC Atrium Core components support IPv6:
BMC Atrium CMDB, BMC Atrium Core Web Services, BMC Atrium Core Web Services
Registry, and Atrium Integrator.
For Microsoft Windows platforms, BMC Atrium Core requires Java SE 7_u55 or later on an
IPv6 server. If you are upgrading BMC Remedy AR System and BMC Atrium Core, you can
upgrade to Java SE 7 update 55 after upgrading to BMC Remedy AR System version 9.0.00
or later. For more information, see Updating Java paths after upgrading.
You can upgrade to or install BMC Atrium Core version 9.0 on a server with an IPv4 address
and then change to an IPv6 address. After you change to the IPv6 address, you must
complete additional configurations. For more information, see Updating configuration after
changing from IPv4 to IPv6
BMC Atrium Core 9.0
Page 223 of 2268
Home
Installing
For the latest installation information, see BMC Remedy ITSM 9.0 Deployment online
documentation.
About BMC Remedy ITSM Suite 9.0

Deployment online documentation
The following graphic illustrates scope and the contents of this online documentation.
The following table describes the contents of the different branches in this online documentation.
Branch
Description
Planning the
deployment
This section describes the deployment scenarios for the following new components:
Click here for a list of topics in this section
Planning BMC Remedy Smart Reporting deployment
Planning BMC Remedy shared service architecture
Preparing
This section provides information about the preparation you must do before installing or upgrading any
component of the BMC Remedy ITSM Suite.
Click here for the list of topics in this section
Reviewing system requirements
Obtaining BMC Remedy license keys
Preparing your database
Preparing the base platform
Preupgrade checks and configuration checks
Completing the planning spreadsheet
BMC Atrium Core 9.0
Page 224 of 2268
Home
Installing
This section provides information about the steps for performing a fresh installation.
Installing the platform components
Installing the application components
Installing offline documentation
Deploying BMC Remedy shared services
Upgrading
This section provides information about the steps for performing an upgrade.
Interactive end-to-end steps depending on the base version:
Upgrading from version 8.1 and later
Upgrading from a version 7.6.04 or 8.0.xx
Upgrading from a version earlier than 7.6.04
Upgrading information the individual components in the BMC Remedy ITSM Suite
Upgrading the platform
Upgrading the applications
Detailed information of different stages within the upgrade process:
Restrictions after restoring the database on the upgrade server
Setting up upgrade servers
Capturing a snapshot of your current environment
Creating overlays
Adjusting customizations when upgrading
Reconciling AR customizations
Migrating customizations
Setting up a staging server
Updating hard-coded server hostname references
Migrating delta data
Update to the multi-tenancy model
Post-upgrade activities
Upgrading secondary servers
User acceptance testing
Cutover activities
Go live activities
Troubleshooting
This section provides information about troubleshooting the issues specific to install or upgrade.
Working with logs
Troubleshooting data and workflow import issues
Troubleshooting driver issues
Troubleshooting information for individual components in the BMC Remedy ITSM Suite
Troubleshooting BMC Remedy AR System issues
Troubleshooting BMC Atrium Core issues
Troubleshooting BMC Remedy ITSM issues
Troubleshooting Process Designer issues
Troubleshooting BMC Service Request Management issues
Troubleshooting BMC Service Level Management issues
Troubleshooting the multi-tenancy update
BMC Atrium Core 9.0
Page 225 of 2268
Home
Configuring after installation

This section contains information about activities that you must perform after you install BMC
Atrium Core.
Performing health check
Verifying Atrium Integrator installation
Post-installation tasks
Configuring BMC Atrium CMDB
Configuring BMC Atrium Core Web Services
Setting up BMC Atrium Service Context
Implementing Distributed BMC Atrium CMDB
Configuring load balancing for Atrium Integrator
Performing health check

BMC recommends that you do a health check as an automated test of installed product features
after installing, before installing, or when troubleshooting a feature which does not work. The BMC
Atrium Core Maintenance Tool gives you access to the Health Check utility. The Health Check
utility automatically detects the installed components and validates if they are installed successfully.
Health checks verifies if the:
Test Product Catalog data is imported successfully. This data is deleted after successful
installation.
BMC Atrium CMDB is up and and running.
CDM is deployed correctly.
UDDI registry is running.
The Maintenance Tool resides in the installation directory under
BMCAtriumCoreInstallationDirectory\atriumcore.
BMC Atrium Core 9.0
Page 226 of 2268
Home
To check the health of a BMC Atrium Core installation

1. Open the BMC Atrium Core Maintenance Tool.
On Windows, go to your installation directory and execute
AtriumCoreMaintenanceTool.cmd.
On UNIX, go to your installation directory and execute ./
AtriumCoreMaintenanceTool.sh.
2. In the BMC Atrium Core Maintenance Tool, click the Health Check tab.
3. Click Next to start the health check.
4. Provide the same AR System server application service password that you set when you
installed the AR System.
5. Click Next to connect to the AR System server.
6. (optional) Click View Log to view the details of the health check.
The log file is displayed in a new a window. The tab name on this window reflects the date and time
the installer was run.
In each log, error entries are highlighted in red, and warning entries are highlighted in yellow.
Note
If you are running a Telnet session, you must open a new Telnet window to view logs.
Verifying Atrium Integrator installation

This topic provides instructions for verifying Atrium Integrator installation.
To verify Atrium Integrator installation

1. From the AR System Administration Console, open the SHARE:Application_Properties form.
2. Search for a property with the value of BMC Atrium Integrator.
3. Make sure that the version associated with this property is 9.0.00.
Note
If you upgraded from version 7.6.04 SP2 to 9.0, there should be only one property
with the name BMC Atrium Integrator.
4.
BMC Atrium Core 9.0
Page 227 of 2268
Home
4. From your Temp folder, open the atriumintegrator_Install_log.txt file and search for issues
related to installation. If the installation of Atrium Integrator is successful, the following
message is saved to the log file:
BMC Atrium Integrator 9.0.00 install succeeded.
5. From the data-integration directory residing at C:\Program Files\BMC Software\
ARSystem\diserver, make sure that all the files contained in the ngie and NGIE-Sample
folders are deployed.
Verify if the following files are present in the bin folder:
6. Login to the Atrium Integrator console and verify if all the sample jobs are populated in the
jobs list.
Post-installation tasks
Perform the tasks in this topic to configure and tune your environment following a successful
installation of BMC Atrium Core features.
1. If you upgraded, review post-upgrade procedures. See, Post-upgrade procedures
in BMC
Remedy ITSM Deployment documentation.

2. Read the log file to find out if any errors occurred and to see where any of your existing data
and metadata were moved. See, Troubleshooting.
3. Apply applicable patches.
4. Restart your JSP engine and web server, if present. After installing BMC Atrium CMDB, you
must restart the JSP engine (such as JBoss or Tomcat) and web server to allow the BMC
Atrium Core console to function.
5. Perform post-installation tasks, if necessary, for the features that you installed.
Post-installation procedures
6. Restart your applications in the correct sequence.

7. Access the BMC Atrium Core console. Accessing the BMC Atrium CMDB and BMC Atrium
Core applications.
BMC Atrium Core 9.0
Page 228 of 2268
Home
Configuring BMC Atrium CMDB

After you install BMC Atrium CMDB, perform the following tasks to optimize performance:
Configuring server queue settings
Verifying RPC program numbers used by BMC Remedy products
Configuring BMC Atrium CMDB Engine Logging
Note
After installing BMC Atrium Core, you can remove the threads that you set on port 390621
while configuring the AR System server thread setting.
Configuring server queue settings

By correctly configuring the BMC Remedy AR System server where BMC Atrium CMDB is installed
you can prevent data bottlenecks.
To set the minimum and maximum number of server threads

1. Set the minimum number of Fast and List server threads to match the number of CPU cores
on this computer.
2. Set the maximum number of Fast server threads at three times the number of CPU cores,
but do not exceed 32.
3. Set the maximum number of List server threads at five times the number of CPU cores, but
do not exceed 32.
For example, if the AR System server computer has four CPU cores, you should make the
settings shown in the following table.
.
Server Queue settings for a four-CPU computer
Type
RPC Program Number
Min Threads
Max Threads
Fast
390620
12
List
390635
20
Verifying RPC program numbers used by BMC Remedy

products
RPC program numbers used by BMC Remedy products
Verifying private queues
BMC Atrium Core 9.0
Page 229 of 2268
Home

To avoid collisions or interference with BMC Remedy products, do not set an RPC program number
on your computer with any of the values listed in the following table.
RPC program number
Queue
type
Additional information
390600
Admin
390600 - 390619 are reserved by BMC
390601
Alert
390602
Full Text
Indexing
390603
Escalation
390619
Dashboards
390620
Fast
390635
List
390621-390634, 390636390669, 390670-390679

390680-390694
Private
Reserved by BMC
390695
Plug-in
server
The AR System server reports an error if you try to use this RPC program
number.
390696
CMDB API
calls
By default, all BMC Atrium CMDB API calls use this program number.
390697
CMDB calls
Admin thread only
390698, 390699
Extra
CMDB
queues
Other BMC Atrium Core products (for example, Reconciliation Engine and Atrium
Integrator ) use these RPC program numbers as their private queues to the BMC
Atrium CMDB.
Verifying private queues

To avoid collisions with BMC Remedy products, you can use the following methods to examine the
private queues on your computer:
Inspect the ar.conf (UNIX) or ar.cfg (Windows) files for RPC program numbers in use.
For example, 390626 is used by the Plugin-Loopback-RPC-Socket (with the Report
Creator plug-in). For more information, see BMC Remedy Approval Server configuration file
settings in the BMC Remedy Action Request System online documentation.
Use the AR_SERVER_INFO_PS_RPC_SOCKET (87) ARGetServerInfo API call.
For more information, see ARGetServerInfo in the BMC Remedy Action Request System
online documentation. For more information about queues and threads function in the AR
System server, see AR System server architecture and scalability in the BMC Remedy
Action Request System online documentation.
BMC Atrium Core 9.0
Page 230 of 2268
Home

You can perform all the Atrium CMDB configurations through the Centralized Configuration System
(CCS). Using the Atrium CMDB Configuration console, you can configure the General Settings,
Cache Settings (Applicable for Server Group Environments only), and Advanced Settings. All the
logs generated for Atrium CMDB have a unified format across the CMDB Engine and its
components.
To access the CMDB Configuration console, on the AR System Home page, select Atrium Core >
CMDB Administration .
CMDB Configuration
The tables below describe each configuration tab, which allows you to configure the CMDB Engine
as per your requirement.
If you are in a server group environment, click the drop-down list t o select the required AR server.
If you have a standalone environment, the required server name is automatically populated.
Configuration settings
1. Make the required changes using the Configuration tab.
Configuration: General Settings
Field
Name in the AR Configuration (ar.cfg or

ar.conf) file
Description
GQ Recursion
Limit
CMDB-GQRecursion-Limit
Sets the limit for number of levels of recursion for

CMDB graph query.
CI Viewer
Graph Limit
CMDB-CIViewer-Graph-Limit
Sets the CI viewer graph limit.
Impact Weight
CMDB-Impact-Weight-Default
Specifies the default weight attached to impact
Default
relationship. This value is used in Atrium Impact

Simulation.
Maximum
Results Per
Query
CMDB-Max-Results-Per-Query
Specifies the maximum number of results that are

returned per query. If this value is 0 it means that the
maximum results per query are unlimited.
Enable Inline
CMDB-Inline-Normalization
Normalizes the CI as soon as it is created, updated,
Normalization
or modified.
Enable Event
Channel
Event-Channel-Enabled
Enables the subscriber to receive the event as soon

as a CI is created, updated, or modified.
Hard Delete
Only Marked for
CMDB-Hard-Delete-Only-If-Marked-For-Delete
Specifies that, if a CI is to be hard deleted, it should

be first marked for deletion. This setting does not
Delete CIs
apply to the CIs of classes from

BMC.CORE.CONFIG namespace.
Configuration: Cache Settings (Applicable for Server Group Environments only)
BMC Atrium Core 9.0
Page 231 of 2268
Home
Field
Name in the AR Configuration (

ar.cfg or ar.conf) file
Description
Cache
Refresh
Interval
CMDB-Cache-Refresh-Interval
Specifies the time interval in milliseconds after which the CMDB

refreshes its cache in the background. To disable this parameter set
this value to minus -. For example, -1.
Default value : 300000
Note : If the value of this parameter is not greater than 60000
milliseconds (60 seconds), the default value is taken.
Cache
Refresh
Initial
Delay
CMDB-Cache-Refresh-Initial-Delay
Specifies the time interval in milliseconds after which the CMDB

refreshes its cache in the background.
Note : If the value defined for this parameter is less than 60000
milliseconds (60 seconds), the default value is taken.
2. Click Apply, then click Close.
Important
For any change to take effect you should restart the BMC Remedy AR System server.
To configure logging information for BMC Atrium CMDB engine, see Configuring BMC Atrium
CMDB Engine Logging.
Configuring CMDB Advanced Settings

1. Make the required changes using the Advanced Settings tab.
Advanced settings: ChunkedItem Settings
Field

ar.conf) file
Description
ChunkedItem
Cleanup
Interval
CMDB-ChunkedItem-Cleanup-Interval
Specifies the time interval in milliseconds at which the

CMDB server should perform the orphan data checks.
To disable this parameter set a value to minus -. For
example, -1.
Note : The value for this parameter should be greater
than 60000 milliseconds (60 seconds) , if it is not then
the default value is taken.
ChunkedItem
Cleanup Initial
Delay
CMDB-ChunkedItem-Cleanup-Initial-Delay
Specifies the time interval in milliseconds to start

checking for the orphan data after CMDB server has
started.
ChunkedItem
Allowed Period
in Cache
BMC Atrium Core 9.0
CMDB-ChunkedItem-Allowed-Period-In-Cache
Specifies the time interval in milliseconds after which

the data will be treated as orphaned and the memory
can be reclaimed by server.
Page 232 of 2268
Home
Field

ar.conf) file
Description

2. Click Apply, then click Close .
Important
For any change to take effect you should restart the BMC Remedy AR System server.
Related Topics

This topic explains how to configure logging information for the BMC Atrium CMDB engine using
the CMDB Administration console. The CMDB engine dynamically updates the logging
configuration changes you make and you do not require to restart the AR server for any change to
take effect. Centralized Configuration System avoids file system access for making the logging
related changes. For more information, see Centralized Configuration.
To access the CMDB Administration console, on the AR System Home page, select Atrium Core >
CMDB Administration.
To configure logging information for BMC Atrium CMDB engine

1. Make the required changes using the Logging tab.
Logging: Log Settings
Field
Name in the AR Configuration

( ar.cfg or ar.conf) file
Description
Logging
Level
CMDB-Logging-Level
Specifies the CMDB log level . For more information about log levels, see
Understanding Log Levels.
Log File
Name
CMDB-Log-File-Name
Specifies the name of the CMDB log file.
Log File
Location
CMDB-Log-File-Location
Specifies the path on the server where the log file is saved.
Maximum
Log File
Size (MB
)
CMDB-Max-Log-File-Size
Specifies the maximum size of the log file.
BMC Atrium Core 9.0
Page 233 of 2268
Home
When the log file reaches the file size limit, it is renamed and a new log
file is created. The older files are not automatically deleted. For example,
if the log file is named neJob.BMC.ASSET.0001.log, the older files are
named neJob.BMC.ASSET.0001.log.1 and neJob.BMC.ASSET.0001.
log.2.
Number
of
Backup
Files
CMDB-Number-Of-Backup-Files
Log Per
CMDB-Log-Per-Thread
Specifies the number of backup CMDB log files to be maintained.

Default value : 10
Creates separate log file for each thread of API/SQL/Filter Logs.
Thread
2. Click Apply, then click Close.
Important
For any change to logging configurations to take effect you do not need to restart the
BMC Remedy AR System server.
CMDB Always on logging

The CMDB logs generated using the Always On Logging (AOL) feature are available starting from
Service Pack 1 and later. In addition to the CMDB Engine logging, the AOL feature implemented at
the AR level, captures all the logs including the CMDB operations in the alwayson.log file. The
logs related to API, SQL, filter, and CMDB Engine are all captured in this single file.
You can generate the logs using the following method.
On Demand - If an error occurs while using some functionality, you can generate the logs
and save them to a log file by clicking Save to File.
On Error codes - You can specify the AR error codes, for which you want to collect logs.
When a particular AR error occurs, the related logs are captured in the alwayson.log file.
For example, if you add the AR error code 92 in the Always On Logging tab which is a
timeout error code, whenever the timeout event occurs, the logs are generated in the
alwayson.log file.
The following plugin server logs are also generated using the Always On Logging feature in the
below listed files
Normalization Engine Plugin Server - pluginsvr_<Server_Name>_alwayson.log
Shared Plugin Server - pluginsvr_<Server_Name>_alwayson.log
For more information on setting the Always on Logging option for plugin server, seeSetting plugin
server configuration options
BMC Atrium Core 9.0
Page 234 of 2268
Home
Related Topics
Configuring BMC Atrium Core Web Services

After you install BMC Atrium Core Web Services, perform the following tasks to optimize
performance and to avoid issues:
Configuring and deploying web services with BMC applications
Configuring BMC Atrium web services registry for AR system server group
Enforcing security policy
Updating the Tomcat startup script after installing BMC Atrium Core Web Services
Configuring and deploying web services with BMC applications

You must configure the BMC Remedy ITSM, BMC Service Request Management, and BMC
Knowledge Management web services so that the respective wsdl are generated in the BMC
Remedy AR System server. To do this, modify the web services from BMC Remedy Developer
Studio and then configure the web services with your BMC Remedy Mid Tier or AR System server
information.
You must configure the following web services with your BMC Remedy Mid Tier or AR System
server information.
Web services
Web service name
Application
CHG_ChangeRelationshipInterface_WS
BMC Remedy ITSM
BMC Atrium Core 9.0
Page 235 of 2268
Home
Web service name
Application
HPD_IncidentRelationshipInterface_WS
BMC Remedy ITSM
RMS_ReleaseRelationshipInterface_WS
BMC Remedy ITSM
PBM_KnownErrorRelationshipInterface_WS
BMC Remedy ITSM
PBM_ProblemRelationshipInterface_WS
BMC Remedy ITSM
WOI_WorkOrderRelationshipInterface_WS
RKM_KnowledgeInterface_WS
BMC Knowledge Management
To configure the web services for all applications

1. Open the web service in BMC Remedy Developer Studio.
2. Make sure that the wsdl location is in the following format:
http://<midtier_server>/arsys/WSDL/public/<servername>/<web_service_name>
For example:
http://<midtier_server>/arsys/WSDL/public/<servername>/
PBM_ProblemRelationshipInterface_WS
Configuring BMC Atrium web services registry for AR system

server group
BMC Atrium Core does not provide load-balancing support for BMC Atrium web services
components in an AR System server group environment. Instead, you can configure the AR
System server group for providing redundancy capabilities to the web services components. For
this, you need to update the BMC Atrium web services registry on the secondary servers.
To configure BMC Atrium web services registry for AR system server group
1. On the secondary AR system server, go to General > Server information > WS Registry
Integration.
2. Enter the Web service registry location.
http://<webserviceshostname>:<portNumber>/uddi
3. Enter the Registry Admin User name.
4. Enter the Registry Admin password.
5. Click Update Registry.
6. Click OK.
Enforcing security policy

Only the UsernameToken security policy is enforced by default. You can enable signature and
encryption policies by using the PolicyUtlility script. For information about changing security
policies, see BMC Atrium Core Web Services security.
BMC Atrium Core 9.0
Page 236 of 2268
Home
Updating the Tomcat startup script after installing BMC Atrium

Core Web Services
The BMC Atrium Core Web Services component requires changes to the JAVA_OPTS, JRE_HOME,
and PATH settings on the Tomcat server. Perform the following steps if you have chosen to
manually update the Tomcat startup script to see the bmcAtriumSetenv file.
To update the Tomcat startup script on Microsoft Windows

1. Go to the bin directory under the home directory of the Tomcat installation in which you have
installed the BMC Atrium Web Services components.
For example:
C:\Program Files\BMC Software\AtriumCore\shared\tomcat\bin
2. Locate and open the startup.bat file in a text editor.
3. Locate the following line in the startup.bat file:
set CLASSPATH=%CATALINA_HOME%\lib:%CLASSPATH%
4. Add the following line after the line mentioned in step 3.
if exist "%CATALINA_HOME%\bin\bmcAtriumSetenv.bat" call %
CATALINA_HOME%\bin\bmcAtriumSertenv.bat"
5. Save and close the startup.bat file.
6. Restart the Tomcat server.
To update the Tomcat startup script on UNIX and Linux

1. Go to the bin directory under the home directory of the Tomcat installation in which you have
installed the BMC Atrium Web Services components.
2. Locate and open the startup.sh file in a text editor.
3. Locate the following line in the startup.sh file:
exec "$PRGDIR"/"$EXECUTABLE" start "$@"
4. Add the following line before the line mentioned in step 3.
. $PRGDIR/bmcAtriumSetenv.sh
5. Save and close the startup.sh file.
Setting up BMC Atrium Service Context

The following topics describe setup and configuration steps you might need to perform for BMC
Atrium Service Context.
Initial setup steps for BMC Atrium Service Context
Configuring BMC Remedy AR System to support BMC Atrium Service Context
Additional configuration steps for BMC Atrium Service Context
BMC Atrium Core 9.0
Page 237 of 2268
Home
Some of these steps are required for BMC Atrium Service Context to function. Others might be
needed to ensure that attributes and data are displayed correctly.
Important
This section assumes that you have installed the Web Services Registry (UDDI), which is
required for BMC Atrium Service Context. The Web Services Registry is an option within
the BMC Atrium Core installation program.
For an overview of BMC Atrium Service Context, which includes information on required
components and how they function together, see Overview of BMC Atrium Service Context .
Initial setup steps for BMC Atrium Service Context

You might have to perform initial setup steps for BMC Atrium Service Context, if you have any of
the following symptoms:
The Service Context Summary window does not open,
Attributes are not visible,
The BMC Atrium Service Context icon is not visible within a BMC application.
The following table lists the required setup steps, in the order they must be completed:
BMC Atrium Service Context setup steps
For more information
In BMC Remedy AR System:

Add the server name in the Mid Tier
configuration
Define the default web path in BMC
Remedy AR System server settings
In each BMC application:

Register the web service
Configure the BMC Atrium Service
Context user
Configure BMC Atrium Service Context

permissions for administrators and users
Configuring BMC Remedy AR System to support BMC Atrium Service

Context
Installing BMC Atrium Single Sign-On with AR System if you want to
integrate BMC Atrium Single Sign-On in your environment
Online documentation for other compatible BMC applications at http://
docs.bmc.com
BMC Atrium Service Context permissions

Online documentation for your BMC application at http://docs.bmc.com
Enable attributes in the Service Context

Administration window

Configuring attributes in the Service Context Administration window
BMC Atrium Core 9.0
Page 238 of 2268
Home
Configuring BMC Remedy AR System to support BMC Atrium

Service Context
After you install BMC Remedy BMC Atrium Core, you must perform the following manual
configuration steps to enable BMC Atrium Service Context:
1. Configure the AR server in the BMC Remedy Mid Tier.
2. Configure the default web path in BMC Remedy AR System.
These steps allow you use to use BMC Atrium Service Context in applications like BMC Atrium
Explorer or BMC Server Automation.
To configure the AR server in the BMC Remedy Mid Tier
Note
You can ignore this step if the AR System server is already configured in the BMC
Remedy Mid Tier.
1. Access the BMC Remedy Mid Tier Configuration Tool using the URL:
http://<servername>:<port>/arsys/shared/config/config.jsp
2. When prompted, enter your Mid Tier password.
3. In AR Server Settings, enter your AR server information in the following fields:
Server Name
Admin Password
Port# (if applicable)
RPC# (if applicable)
For information on these settings, see BMC Remedy Mid Tier configuration in the BMC
4. Click Save AR Server.
5. Update Mid Tier cache.
To configure the default web path in BMC Remedy AR System

1. Access the BMC Remedy AR System using the URL:
http://<servername>:<port>/arsys
2. When prompted, enter your BMC Remedy AR System user name and password.
3. From the AR System Administration Console, select System > General > Server
Information.
4. Click the Advanced tab.
5.
BMC Atrium Core 9.0
Page 239 of 2268
Home
5. In the Default Web Path field, enter the fully qualified domain name of the Mid Tier server.
For example, enter:
http://<servername>:<port>/arsys
6. Click Apply.
7. Close the console.

By default, the Service Context Summary window only displays certain attributes supplied by BMC
Atrium Core. The caching interval and other properties are also set at specific default values.
Depending on your environment, you might want to configure BMC Atrium Service Context to do
the following:
Show additional attributes
Show more or less history for certain attributes, such as Completed Changes
Specify queries to filter related CIs
Change the caching interval
For more information on these and other settings, see Configuring attributes in the Service Context
Administration window and Configuring BMC Atrium Service Context cache and data retrieval
settings.
For other setup steps that might be required by your BMC applications, see:
Online documentation for other compatible BMC applications, located at http://docs.bmc.com
Implementing Distributed BMC Atrium CMDB

In some environments such as a company with offices in different cities, one BMC Atrium CMDB is
not practical. You can install more than more BMC Atrium CMDB and keep the BMC Atrium CMDB
data synchronized with the BMC Remedy Distributed Server Option (DSO).
Warning
Distributed CMDB does not support bi-directional DSO data transfer in BMC Atrium
CMDB versions 1.x and 2.x. The Distributed CMDB feature was first introduced in the
7.5.00 release.
You should only use Distributed CMDB to keep two CMDBs synchronized in real-time. Do
not use it with Development-to-Production environments. You should only use Distributed
CMDB with Development-to- Development or Production-to-Production environments.
BMC Atrium Core 9.0
Page 240 of 2268
Home
The following topics provide instructions for implementing and using DSO:
Implementing DSO for Distributed BMC Atrium CMDB
Setting up DSO for one-way transfer
Setting up DSO for two-way transfer
The performance that can be expected from DSO is also discussed.
Note
These procedures build on existing DSO documentation; it is not a standalone source of

DSO information. For detailed information on implementing DSO, see Setting up DSO to
synchronize data across multiple AR System servers .
Implementing DSO for Distributed BMC Atrium CMDB

BMC Remedy Distributed Server Option (DSO) is used in BMC Remedy AR System server
environments where installing more than one BMC Atrium CMDB is essential. You might need to
install more than one BMC Atrium CMDB if:
Multiple environments are widely separated.
All environments need a common view of the global IT environment.
The following topics provide information and instructions for implementing DSO for Distributed BMC
Atrium CMDB:
Replicating data with DSO
Transfering data with DSO
Transferring data between multiple sites using DSO
Protecting data integrity with DSO
Updating BMC Atrium CMDB with DSO
Discovering CIs in non-overlapping domains in multiple sites
Using DSO pools to improve performance
Replicating data with DSO

BMC Atrium CMDB is an integral part of any BMC Remedy IT Service Management environment.
BMC Atrium CMDB makes incident management more efficient by providing an up-to-date image of
the production IT environment. In an environment where more than one BMC Atrium CMDB is
installed, BMC Remedy Distributed Server Option keeps the BMC Atrium CMDB data synchronized
.
You can use DSO across two environments running BMC Remedy Incident Management, where
BMC Atrium Core 9.0
Page 241 of 2268
Home
both user communities need to be aware of all the tickets that are created at each site. In such a
situation, DSO replicates tickets that are created at each site.
DSO adds a prefix to replicated ticket IDs to differentiate them from other tickets. The ownership of
the replicated tickets can be altered allowing a ticket created at one site to be reassigned to a
remote site. This ticket can then be worked on during business hours from the remote site.
Transfering data with DSO

When you install BMC Atrium CMDB, two templates defining the workflow and filters to be used
along with BMC Remedy Distributed Server Option (DSO) are also installed. These templates when
implemented, transfer CDM data for all datasets from the source to the destination servers.
These filter templates on source server are required to transfer as soon as the data is modified or
created. To transfer data in batch mode, you can write an escalation that runs after 24 hours and
transfers the data that has been modified in the previous 24 hours
To use DSO to transfer data, you can create mappings and filters on the base forms of specific
BMC Atrium CMDB classes and their subsequent parent classes. However, a safer approach is to
create mappings and filters for the entire CDM. In this case, if a discovery product populates a
class that was not expected to be used, the data is still transferred to the remote site.
Every time data is written to a local form, a transfer corresponding to the mapping is entered in the
DSO Distributed Pending form. This form maintains a queue of all send operations that need to be
performed. You can configure various access methods for this queue. For example, you can
configure a push request to be executed as soon as send operations arrive in the queue.
Transferring data between multiple sites using DSO

BMC Atrium CMDB gives access only to the Reconciliation Engine to write to the production
dataset. Any other data source is first written to a staging dataset and then reconciled to the
production dataset.
When you implement BMC Remedy Distributed Server Option (DSO) for transferring data between
the production datasets at two sites, the two most common scenarios for transferring data between
two production datasets are:
The Reconciliation Engine reconciles the production dataset at one site, and the DSO
transfers this data to the remote production dataset.
Data is transferred between staging datasets of both the source and destination sites, and
reconciliation is performed at both ends.
You must first create a new filter in the BMC Atrium CMDB base forms. Each BMC Atrium CMDB
base form contains a hidden field named zCMDBEngOverrideCmd. The validation workflow first
looks at this value to determine a user's write permission.
BMC Atrium Core 9.0
Page 242 of 2268
Home
You must now create one additional filter for each base form. This new filter writes the value 577 to
the zCMDBEngOverrideCmd field before trying to write to other fields in the form. Set the filter
execution order of this filter to 99 to make sure that this write occurs before the validation workflow
validates the user.
Note
The filter that validates that the zCMDBEngOverrideCmd field is set has execution order
100.
On the destination server, the filter template sets a value of 3 and a filter order of 1 for
zCMDBEngOverrideCmd.
Protecting data integrity with DSO

BMC Atrium CMDB protects the production image of an IT environment by restricting write access
to the production dataset to only the Reconciliation Engine. Thiss ensures that data integrity is
maintained.
BMC Remedy Distributed Server Option (DSO) also contributes to protecting data integrity by an
existing functionality. Any failed transfer from the local Distributed Pending form to the remote
server is noted, and the data is retained until the transfer is successful. If additional validation is
deemed necessary, other DSO configuration options make sure that data is not deleted even after
a successful transfer.
Updating BMC Atrium CMDB with DSO

BMC Remedy Distributed Server Option (DSO) is best used for incrementally updating the BMC
Atrium CMDB.
Before the system goes live, BMC Atrium CMDB is initially populated by a full load. The database
containing the fully populated BMC Atrium CMDB can be physically copied to the remote site so
that both the sites have an identical image of the BMC Atrium CMDB.
After the system goes live, BMC Atrium CMDB is periodically updated to include new or changed
CIs identified by discovery sources. The number of CIs involved in updates is much smaller than
the total number of CIs in BMC Atrium CMDB. For example, a site with a CMDB that contains
roughly one million CIs might have daily updates that involving 1,000 to 10,000 CIs. Larger updates
are possible, but not very common. DSO transfers the new CIs to the database at the remote site.
How DSO updates BMC Atrium CMDB

Typically, updating BMC Atrium CMDB occurs in the following order:
Discovery scans are scheduled for detecting new and changed CIs.
Reconciliation jobs are scheduled to synchronize the production dataset with new data.
BMC Atrium Core 9.0
Page 243 of 2268
Home
The DSO Distribution Pending queue accumulates pending push operations.

BMC recommends that you configure DSO to consume the queue as soon as possible. For
example, the DSO can be scheduled during a batch window at night. You can expect some CPU
consumption during DSO usage. If the system is heavily used or if concurrent users might be
impacted, configure DSO to consume the pending queue in another scheduled batch window.
Discovering CIs in non-overlapping domains in multiple sites

Often, each site locally discovers its own IT assets and a bidirectional BMC Remedy Distributed
Server Option (DSO) then shares the data so that both sites can see information for the entire
enterprise. You can implement this as a simple bidirectional DSO transfer by setting up DSO for
one-way transfer on both the servers. No asset should be discovered by both sites. Because data
is transferred after it has been reconciled, if both sites try to write to the same CI, the CI might be
updated with different values by each site. It is most likely that the two sites discover identical
information about the CI.
Recommendation
BMC recommends that multiple sites should conduct local discovery in non-overlapping domains.
Alternatively, a utility enables you to use a master discovery site for the entire enterprise where
possible.
Using DSO pools to improve performance

You can use BMC Remedy Distributed Server Option (DSO) pools to achieve higher throughput.
DSO pools are independent sets of DSO activity that can be processed in parallel. By default, the
workflow and filter templates for DSO do not use any DSO pool. You can modify the templates to
use DSO pools. For CMDB data, you must first transfer CIs and then the relationships.
Because each DSO pool represents a thread of activity, the overhead of DSO is a linear function of
the number of DSO pools. Usually, each DSO pool consumes about 5-10% of the CPU space on a
two-CPU Intel server or equivalent for both the AR System server tier and the database tier.
In a lightly used system, the impact on online users should be small. In a system that heavily
consumes CPU space, the impact on response time or overall system throughput might be more
substantial.
Setting up DSO for one-way transfer

When you use Distributed Server Option (DSO) for replicating CMDB data, DSO transfers data
from a form in one AR System server to a similar form in a remote AR System server. The following
topics provide information and instructions for setting up DSO for one-way transfer:
Modifying armonitor.cfg or armonitor.conf files
Setting DSO passwords
Modifying the template for the source server
Creating mappings and filters for custom classes
BMC Atrium Core 9.0
Page 244 of 2268
Home
Modifying the template for the destination server

Importing workflows on the source and destination servers
For more information about setting up and using DSO, see Setting up DSO in the BMC Remedy
Modifying armonitor.cfg or armonitor.conf files

On the source and destination servers, you must enable the BMC Remedy Distributed Server
Option (DSO) service to start so that the servers can communicate and transfer data. To do this,
you must modify the armonitor.cfg (Microsoft Windows) or the armonitor.conf (UNIX) file.
Before you begin
To modify armonitor.cfg
To modify armonitor.conf
Before you begin

Ensure that the BMC Remedy AR System servers are licensed.
If needed, add DSO licenses for the servers in the distributed BMC Atrium CMDB.
To modify armonitor.cfg
1. From the Conf folder, open the armonitor.cfg file in a text editor. You can find the Conf
folder at the following location: AR_install_directory/Conf.
2. Locate the following line that includes serverds.exe.
#"C:\Program Files\BMC Software\ARSystem\serverds.exe" -i "C:\
Program Files\BMC Software\ARSystem" -m
3. Remove # from the start of the line.
4. Save the file.
5. After applying the DSO license and editing the configuration file, restart the AR System
server for the license to take effect.
To modify armonitor.conf
1. Open the armonitor.conf file in a text editor.
2. Locate the line that includes arservdsd.
3. Remove # from the start of the line.
4. Save the file.
5. After applying the DSO license and editing the configuration file, restart the AR System
server for the license to take effect.
Setting DSO passwords

To enable a source BMC Remedy AR System server to communicate with a destination AR System
server by using BMC Remedy Distributed Server Option (DSO), you must define the server name
and the DSO password.
BMC Atrium Core 9.0
Page 245 of 2268
Home
To define the DSO password

1. Log on to the AR System server, and open the AR System Administration Console.
2. Select System > General > Server Information.
3. From the Connection Settings tab, select the DSO Server tab.
4. For DSO Local Password, enter the DSO password (up to 30 characters).
5. In the table on the right, enter the full names and the respective passwords of the destination
servers in the distributed environment.
6. Click OK.
7. Restart the AR System server.
8. Perform this procedure for each remote server.
Modifying the template for the source server

On the BMC Atrium CMDB source server, you must modify the template with the name of the
destination server. Follow these steps to modify the template.
Note
The source server template does not include abstract classes.
To modify the source server template

1. In the AtriumCore_install_directory\AtriumCore\cmdb\en\workflow\
DistributedCMDBTemplates directory on the source server, make a copy of the
src_distcmdb.def file, and rename this copy with the destination server's name.
For example:
src_distcmdb-to-destination-server-name.def
2. Open the src_distcmdb-to-destination-server-name.def file in a text editor.
3. If you have custom classes, see Creating mappings and filters for custom classes .
4. Search for the text string to-server : DESTINATION-SERVER in the destination
mappings.
5. Replace all 80 instances in the destination mappings with the name of the destination server.
For example:
to-server : vw-sjc-bsm-vm17
Note
Make sure that you do not replace DESTINATION-SERVER in the filter names.
6. Save the file.
BMC Atrium Core 9.0
Page 246 of 2268
Home
Creating mappings and filters for custom classes

If you created classes, you must create a custom mapping and filter for each class as described in
the following sections:
Before you begin
To configure mappings for custom classes
To configure filters for custom classes
Before you begin

Ensure that you have Distributed Server Option (DSO) licenses for the servers in the
distributed BMC Atrium CMDB.
Depending on the class type, get the form name for each class.
If the class is regular type, get its BMC Remedy AR System form name. Generally the
form name is Namespace:ClassName.
If the class is a categorization subclass, get the form name of its nearest
non-categorization superclass, as well as the class ID.
To configure mappings for custom classes

1. Log in to BMC Remedy Developer Studio.
2. In the AR System Navigator, right-click All Objects > Distributed Mappings.
3. From the menu, select New Distributed Mapping.
4. Create a new mapping for each custom class.
a. In Basic, set the following parameter values.
State: Enabled
From Server Name: sourceServerName
Allow any Server in Server Group: Yes
From Form Name: customClassForm
To Server Name: destinationServerName
To Form Name: customClassForm
b. In Options, set the following parameter values.
When to Update: No Update
Transfer Mode: Independent Copy
Duplicate Request ID Action: Overwrite
Enforce Pattern Matching: Yes
Require Required Fields: Yes
Match by Request ID: No
Retries: Forever
Matching Qualification: 'InstanceId' = $InstanceId$
5. In Transfer and Return, click Auto Map.
6. In the Auto Map window, select all of the fields, and click OK.
7. Save the mapping as CMDB: destinationServerName-customClassName.
BMC Atrium Core 9.0
Page 247 of 2268
Home
To configure filters for custom classes

1. In BMC Remedy Developer Studio, create a new filter for each custom class.
a. In Associated Forms, click Add to select the form determined in Step 1.
b. In Execution Options, set the following parameter values.
State: Enabled
Execution Order: 99
Modify, Submit, Merge selected
c. For the categorization subclass, create a Run If Qualification that looks like the
following example.
(( 'ClassId' = $NULL$ ) OR ( 'ClassId' = ""
CategorizationClassId" ) OR ('ClassId' = "ConcreteClassId") OR
( 'zCMDBEngOverrideCmd' = 0) OR ( 'zCMDBEngOverrideCmd' = $NULL
$ )) AND ($USER$ != "Distributed Server" )
CategorizationClassId is the ID of the categorization subclass and ConcreteClassId
is the class ID of the super class, which is the non-categorization class.
d. For the regular class, create a Run If Qualification that looks like the following
example.
(('ClassId' = $NULL$) OR ('ClassId' = "ClassId") OR ((( '
zCMDBEngOverrideCmd' = 0) OR ( 'zCMDBEngOverrideCmd' = $NULL$ )
))AND $USER$ != "Distributed Server"
ClassId is the ID of the regular class.
e. For the If Actions, click Add Action, and select DSO Action.
2. Save the filter as DIST-CMDB:DestinationServerName-CustomClassName.
Modifying the template for the destination server

Follow these steps to modify the template for the destination server.
Important
Modify this template only when you have custom classes.
To modify the source server template

1. In AtriumCore_install_directory\AtriumCore\cmdb\en\workflow\
DistributedCMDBTemplates on the destination server, make a copy of the
dest_distcmdb.def file, and rename the copy with the destination server's name.
For example, dest_distcmdb-destination-server-name.def
2. On the destination BMC Remedy AR System server, open the BMC Remedy Developer
Studio and log in.
3. Import the DIST-CMDB:OverrideChecks filter from the
dest_distcmdb-destination-server-name.def file.
a.
BMC Atrium Core 9.0
Page 248 of 2268
3.
Home
a. In BMC Remedy Developer Studio, select File > Import.

b. In the Import window, select Object Definitions, and click Next.
c. In the Select Server window, select the server.
d. In the Import File window, click the ... button, and select the
dest_distcmdb-destination-server-name.def file in AtriumCore_install_directory\
AtriumCore\cmdb\en\workflow\ DistributedCMDBTemplates .
e. In the Object Selection window, select the DIST-CMDB:OverrideChecks filter, and
click Finish.
4. Open the DIST-CMDB:OverrideChecks filter for editing.
5. For Associated Forms, click Add, and select the form that corresponds to the custom class.
6. Click OK.
7. Save the DIST-CMDB:OverrideChecks filter.
Importing workflows on the source and destination servers

This topic provides instructions for importing workflows on the source and destination servers.
To import the template on the source server

1. On the source BMC Remedy AR System server, open BMC Remedy Developer Studio and
log in.
2. From the AR System Navigator tab, right-click the source server and select Import Object
Definitions.
3. For the Import File selection, select the edited source template, and click Open.
4.
5.
6.
7.
<AtriumCore_install_directory>\AtriumCore\cmdb\en\workflow\
DistributedCMDBTemplates\src_distcmdb-to- <destination-server-name>.def
Click Next.
Select the Replace Objects on the Destination Server option.
Click Finish.
When the import is complete, exit BMC Remedy Developer Studio.
To import the template on the destination server

1. On the destination BMC Remedy AR System serve, open BMC Remedy Developer Studio
and log in.
2. From the AR System Navigator tab, right-click the destination server and select Import
Object Definitions.
3. For the Import File selection, select the destination template file, and click Open.
4.
5.
6.
7.
<AtriumCore_install_directory>\AtriumCore\cmdb\en\workflow\
DistributedCMDBTemplates\dest_distcmdb.def
Click Next.
Select the Replace Objects on the Destination Server option.
Click Finish.
When the import is complete, exit BMC Remedy Developer Studio.
BMC Atrium Core 9.0
Page 249 of 2268
Home
Setting up DSO for two-way transfer

By default, the server and destination templates are configured for a one-way transfer where one
server is the source and the other server is the destination. If you have an environment in which
both servers update CIs and need to exchange data both ways, follow the instructions in this topic.
To set up DSO for two-way transfer

1. On the first server, change the source template to point to the second server.
2. Import both the source and the destination templates.
3. On the second server, change the source template to point to the first server.
4. Import both the source and the destination templates.
For a two-way, or bi-directional, transfer, avoid a loop of normalizing and reconciling data as follows
:
Shut off the continuous normalization and reconciliation on both servers.
Do not start scheduled jobs for normalization and reconciliation.
Warning
It is possible for the two-way transfer to get into a loop with normalization and
reconciliation jobs running on both servers. This loop can result in multiple reconciliation
IDs for the same item and in an inaccurate BMC Atrium CMDB.
Configuring load balancing for Atrium Integrator

The Atrium Integrator server can be used in a server group environment to distribute the jobs
across multiple Atrium Integrator Carte servers. In a BMC Remedy AR System server group
environment, you can schedule your jobs to run from different Atrium Integrator Carte servers. This
enables you to run multiple jobs at one time and also achieve load balancing.
The following figure illustrates the concept of BMC Remedy AR System server group and multiple
Atrium Integrator Carte server support.
BMC Atrium Core 9.0
Page 250 of 2268
Home
The UDM: Config form contains information about how many BMC Remedy AR System servers are
configured in a particular server group and which Atrium Integrator Carte server is associated with
each AR server. In Atrium Integrator server group environment, the Carte server on which a job will
get executed through Atrium Integrator console depends on the entry available in the UDM:Config
form. The AR system server installer creates an entry in UDM:Config form about the Carte server
host and port details.The host entry in UDM:Config form must follow the DNS standard.
The UDM:PermissionInfo form contains information about jobs and the associated Atrium Integrator
Carte servers they run on.
When you set up Atrium Integrator in server group environment, consider the following points:
Note
In this release, fail-over is not supported for BMC Remedy AR System servers.
You must also ensure that you have installed the Atrium Integrator Carte server and Atrium
Integrator Spoon components in a server group environment. When you install the Atrium
Integrator server on each server within the server group environment, the CMDB plug-ins are
deployed on the servers. For more information, see Installing Atrium Integrator server in a
server group.
When you create a job by using the Integration Job Builder wizard in a server group
environment, you have to select the appropriate Atrium Integrator Carte server on the
Schedule page. If you run a job in the Atrium Integrator console, the job runs on the Atrium
BMC Atrium Core 9.0
Page 251 of 2268
Home
Integrator Carte of BMC Remedy AR System server that you access through the mid-tier
server. You can change the Atrium Integrator Carte server by scheduling the job to a run on
a different Atrium Integrator Carte server. For more information, see Managing a Atrium
Integrator job schedule.
Important
BMC recommends that you do not run the same job on multiple Atrium Integrator Carte
servers within the server group environment.
In Atrium Integrator server group environment, the cache is created on the the server from
where you execute a job. For example, if server A is the primary server and server B is the
secondary server, and if you execute the job from server B, the cache is created on server B
.
If you schedule a job on a server with the cache enabled and then schedule the same job on
another server within the server group, you must manually copy the cache to the second
server to avoid a negative impact on the performance.
When you create or run CSV or XML jobs in a server group, make sure, the files are
physically present at the same location on all the BMC Remedy AR System servers in the
server group.
If you have a load balancer configured and if you want to run the job on the load balancer
content server (midtier), you must update the load balancer content server (midtier) entry in
the UDM:RAppPassword form.
BMC Atrium Core 9.0
Page 252 of 2268
Home
Upgrading
For the latest upgrade information, see BMC Remedy ITSM 9.0 Deployment online documentation .
About BMC Remedy ITSM Suite 9.0

Deployment online documentation
The following graphic illustrates scope and the contents of this online documentation.
The following table describes the contents of the different branches in this online documentation.
Branch
Description
Planning the
deployment
This section describes the deployment scenarios for the following new components:
Click here for a list of topics in this section
Planning BMC Remedy Smart Reporting deployment
Planning BMC Remedy shared service architecture
Preparing
This section provides information about the preparation you must do before installing or upgrading any
component of the BMC Remedy ITSM Suite.
Reviewing system requirements
Obtaining BMC Remedy license keys
Preparing your database
Preparing the base platform
Preupgrade checks and configuration checks
Completing the planning spreadsheet
BMC Atrium Core 9.0
Page 253 of 2268
Home
Branch
Description
Installing
This section provides information about the steps for performing a fresh installation.
Installing the platform components
Installing the application components
Installing offline documentation
Deploying BMC Remedy shared services
Upgrading
This section provides information about the steps for performing an upgrade.
Interactive end-to-end steps depending on the base version:
Upgrading from version 8.1 and later
Upgrading from a version 7.6.04 or 8.0.xx
Upgrading from a version earlier than 7.6.04
Upgrading information the individual components in the BMC Remedy ITSM Suite
Upgrading the platform
Upgrading the applications
Detailed information of different stages within the upgrade process:
Restrictions after restoring the database on the upgrade server
Setting up upgrade servers
Capturing a snapshot of your current environment
Creating overlays
Adjusting customizations when upgrading
Reconciling AR customizations
Migrating customizations
Setting up a staging server
Updating hard-coded server hostname references
Migrating delta data
Update to the multi-tenancy model
Post-upgrade activities
Upgrading secondary servers
User acceptance testing
Cutover activities
Go live activities
Troubleshooting
This section provides information about troubleshooting the issues specific to install or upgrade.
Working with logs
Troubleshooting data and workflow import issues
Troubleshooting driver issues
Troubleshooting information for individual components in the BMC Remedy ITSM Suite
Troubleshooting BMC Remedy AR System issues
Troubleshooting BMC Atrium Core issues
Troubleshooting BMC Remedy ITSM issues
Troubleshooting Process Designer issues
Troubleshooting BMC Service Request Management issues
Troubleshooting BMC Service Level Management issues
Troubleshooting the multi-tenancy update
BMC Atrium Core 9.0
Page 254 of 2268
Home
Integrating
BMC Atrium Core widgets are modules in the BMC Atrium Core Console that you can integrate with
other applications. These widgets are the BMC Atrium Explorer and the Atrium Query, which you
can integrate with other applications, including non-BMC Remedy AR System applications.
Use the following methods:
Launching BMC Atrium Core widgets from BMC Remedy AR System applications
Embedding BMC Atrium Core widgets in BMC Remedy AR System applications
Launching BMC Atrium Core widgets from non-BMC Remedy AR System applications
BMC Atrium CMDB and BMC Atrium Discovery and Dependency Mapping Integration
Launching BMC Atrium Core widgets from

BMC Remedy AR System applications
When you launch the Atrium:Explorer and Atrium:Query forms from other BMC Remedy AR
System applications, the BMC Atrium Configuration Management Database (BMC Atrium CMDB)
performs the initialization function for these forms.
To launch a BMC Atrium Core widget from AR System applications
Atrium:Explorer and Atrium:Query launch parameters from other AR System applications
BMC Atrium Core 9.0
Page 255 of 2268
Home
To launch a BMC Atrium Core widget from AR System

applications
1. With BMC Remedy Developer Studio, log on to the BMC Atrium CMDB server and create a
new active link for launching the BMC Atrium Explorer or BMC Atrium Query widget.
The properties for the active link are displayed in a tab form. For more information about
creating active links, see Developing an application in the BMC Remedy Action Request
System online documentation.
2. For the Associated Forms panel, click Add, and select Atrium:Explorer or Atrium:Query.
For more information, see Atrium:Explorer and Atrium:Query parameters--AR System
applications.
3. For the Execution Options panel, specify details, such as the Execute On criteria.
4. For the Run If Qualification panel, specify the appropriate condition as needed.
5. For the If Actions panel, right-click and select Add Action > Open Window.
6. For the Open Window panel, specify the following details:
Window Type
Search
Target
Location
New
Note: Launching the BMC Atrium Explorer from BMC Remedy AR Systems does not support the
Current option for the Target Location list.
Form View
Name
Default Admin View
Set Fields to
Defaults
In the table, specify the parameters listed in the following table or the following table.
Open Window parameters for BMC Atrium Explorer
7. Select the Active Link, and, in the Permissions tab, specify permissions for the active link.
8. On the BMC Remedy Developer Studio toolbar, click Save.
BMC Atrium Core 9.0
Page 256 of 2268
Home
Your active link is now saved.
Atrium:Explorer and Atrium:Query launch parameters from

other AR System applications
For BMC Atrium Explorer, you must specify the initialization parameters, such as Namespace,
Class Name, Dataset ID, CI ID, and Filters of the configuration item (CI) for which the
relationship data is displayed. The following table lists the parameters required to launch BMC
Atrium Explorer from other BMC Remedy AR System applications.
BMC Atrium Explorer launch parameters from AR System applications

Parameter
name
Description
Namespace
The namespace to which the instance belongs.
Class
Name
The class name to which the instance belongs.
CI ID
The Instance ID of the CI for which the relationship data is displayed.
Dataset
ID
The ID of the dataset where the instance resides.

Note: In the BMC.ASSET dataset, values for CI attributes set in BMC Remedy Asset Management take
precedence over BMC Atrium Explorer changes to those CIs. When you integrate the BMC Atrium Explorer widget
with another application, the widget cannot use a personal dataset (for example, your Sandbox) to updates values
from attributes already in BMC Atrium CMDB if they come from BMC Remedy Asset Management. To guarantee
data integrity, instead use Asset forms to modify these values directly in BMC Remedy Asset Management instead.
For more information about promoting changes to CIs to the BMC.ASSET dataset from the Sandbox, see
Promoting CIs and relationships from a Sandbox dataset.
Filter
Name
The filter name for the BMC Atrium Explorer. These filters enable you to specify qualifications for the instances you
want to view. The BMC Atrium CMDB application ships with one or more default filters. You can also create
additional filters to suit your needs.
The following table lists the parameters required to launch the Atrium:Query form.
Atrium:Query launch parameters from ARSystem applications

Parameter name
Description
ResultSet Location
The location of results list (bottom, right, none) within query widget.
Embedding BMC Atrium Core widgets in BMC

Remedy AR System applications
You can embed BMC Atrium Core widgets in a BMC Remedy AR System form.
BMC Atrium Core 9.0
Page 257 of 2268
Home
To embed a BMC Atrium Core widget in a BMC Remedy AR

System form
1. In BMC Remedy Developer Studio, open the form in which you want to embed the widget.
2. Right-click the form, and select Create a new Field > Data Visualization .
3. Select the Data Visualization field.
4. In the Properties tab, expand Database, and specify a name for the Data Visualization
field in the Name text box.
5. In the Properties tab, set the following Display properties:
From the Module Type list, select AtriumWidget.
Note
The AtriumWidget value in the Module type list does not appear if you have
not installed BMC Atrium CMDB.
From the Definition list, select the Atrium Query or BMC Atrium Explorer.
From the Server list, select the server hosting the widget.
6. On the Database tab, specify a name for the Data Visualization field in the Name text box.
7. Create an active link that executes when the Data Visualization field is initialized and
specify the following details for the active link:
On the Basic tab:
Specify a name for the active link.
From the Form Name list, select the form name.
On the If Action tab:
From the New Action list, select Set Fields
From the Read Value for Field From list, select the form name on which the
data visualization field is placed.
From the Name list, select the name of the Data Visualization field you
created.
In the Value field, set the required parameters for launching the widget.
BMC Atrium Explorer:
(((((((( "namespace=" + $Namespace$) + ",classname=") + $
Class Name$) + ",datasetid=") + $Dataset ID$) + ",
instanceid=") + $CI ID$) + ",filtername=") + "Components
and Dependencies"
Atrium Query:
(( "resultsetLocation=" + $Resultset Location$) + ",
datasetid=") + $Dataset ID$
BMC Atrium Core 9.0
Page 258 of 2268
Home
In the examples, the field names, such as $Namespace$ and $Class Name$
are based on the field names of a form. You must provide these field names as
you have specified in your form. You might also specify string values as shown
in the example.
Note
The namespace, classname, datasetid, instanceid, and
filtername parameters are BMC Atrium Explorer-defined keywords
.
8. Click Add Action to save the settings for the action.

9. Click Save to save the active link.
Note
Any HTTP response from the AtriumWidget plugin does not issue any browser cache
directives like the other Data Visualization Module (DVM)
Launching BMC Atrium Core widgets from

non-BMC Remedy AR System applications
You can launch the Atrium Query or BMC Atrium Explorer directly from any non-BMC Remedy AR
System applications using a browser. To launch the BMC Atrium Query or BMC Atrium Explorer,
you must specify the initialization parameters for the widget in the URL format.
In the URL for launching a widget, constants (such as F490001100 ) indicate the field ID on the
Atrium:Explorer or Atrium:Query form. These IDs are fixed values for the initialization parameters.
The following table lists the parameters and field ID mappings that you can use to launch the
Atrium:Explorer form.
BMC Atrium Explorer launch parameters for non-AR System applications
Field ID
Parameter name
Description
F490001100
Namespace (
The namespace to which the instance belongs.
required)
F400109900
Class Name (
The class name to which the instance belongs.
required)
F431400000
CI ID (required)
BMC Atrium Core 9.0
The Instance ID of the CI for which the relationship data is displayed.
Page 259 of 2268
Home
Field ID
Parameter name
Description
F431400001
Dataset ID (
The dataset from which the instance data is selected.
required)
F431400003
Filter Name (
The filter name for the view in BMC Atrium Explorer. These filters enable you to specify
optional)
qualifications for the instances that you want to view.
The following table lists the parameters and field ID mappings that are required to launch the
Atrium:Query form.
Atrium:Query launch parameters for non-AR System applications
Field ID
Parameter name
Description
F431400002
ResultSet Location
The location of the results list (bottom, right, none) within the widget.
To launch BMC Atrium Explorer from a browser

1. Open a browser and type the following URL in the address field:
For example, the following URL includes all the required and optional parameters (Name
Space, Class Name, CI ID, Dataset ID, and Filter Name) to launch the BMC Atrium Explorer
widget:
Note
Launching the widgets requires that you log on to the BMC Remedy Mid Tier. You
can supply a login ID and password in a POST command as part of the URL.
2. Press Enter.
3. In the BMC Remedy Action Request System login page, type a user name and password,
and click Log In.
The specified widget opens in the browser.
BMC Atrium CMDB and BMC Atrium Discovery

and Dependency Mapping Integration
As part of a fresh installation, BMC Atrium CMDB is available with preconfigured integration with
BMC Atrium Discovery and Dependency Mapping. The following tasks are performed automatically
with this new ADDM-CMDB integration feature:
1. Creation of BMC.ADDM Dataset
2.
BMC Atrium Core 9.0
Page 260 of 2268
Home
2. Creation a Reconciliation Job having the following three activities

a. Identification
b. Merge
c. Purge
Click here
to download the ADDM integration package for Windows and Linux operating
systems.
BMC Atrium CMDB - BMC ADDM Integration
Viewing BMC.ADDM Dataset, and Reconciliation Jobs

Perform the following steps to check the details of the dataset and reconciliation jobs.
1. Login to the BMC Remedy AR System.
2. In a new browser window, open the AR Form - BMC.CORE.CONFIG:BMC_Dataset. Type
BMC.ADDM in the Name field and then click Search. BMC.ADDM dataset created by
default is displayed in the search results.
3. Verify that the following drop-down lists have correct values:
Accessibility: Writable
DatasetType: Regular
4. In the AR System Home page, select BMC Atrium Core > BMC Atrium Core Console .
Click the Application Launcher bar that appears on the left side of the console and select
Advanced > Reconciliation.
5. Select the BMC.ADDM - Identification, Merge, and Purge in the list of jobs in the
Reconciliation tab and then click Edit Job icon.
6. Reconciliation job activities are listed in the Activities table in the Job Editor window. The
Sequence column in the Activities table has incremental values denoting the sequence in
which the activities will be completed.
BMC Atrium Core 9.0
Page 261 of 2268
6.
Home
Note
ADDM job first syncs the data as it is from the BMC.ADDM source dataset to the
BMC.ASSET dataset as a part of Identification and Merge activities. The Purge
activity should be performed after this, and hence should be the last activity in
order to ensure that CIs with MarkAsDeleted attribute as Yes are deleted from the
source dataset.
7. Select Purge activity in the Activities table and then click Edit Activity.
8. In the Edit Activity window, ensure the following:
a. Continue on Error check box is clear. This is to make sure that the purge activity
stops in case an error occurs during the purge operation.
b. BMC.ADDM is selected in the list of datasets.
c. Verify in Target Dataset check box is selected with the value BMC Asset in the list.
This is to make sure that the instances have been merged into the target dataset
BMC.Asset before they are purged.
BMC Atrium Core 9.0
Page 262 of 2268
Home
BMC Atrium Core 9.0
Page 263 of 2268
Home
Using
This section contains information about how to use BMC Atrium Core.
Navigating the interface
Working with CIs and relationships
Navigating the interface

The following topics provide information and instructions for navigating the BMC Atrium Core
interface:
Accessing BMC Atrium CMDB Dashboard
Accessing the BMC Atrium CMDB and BMC Atrium Core applications
Accessing the Atrium Integrator console
Launching Atrium Integrator Spoon from Atrium Integrator
Opening and searching the Service Catalog
Opening Class Manager and viewing classes
Accessing BMC Atrium CMDB Dashboard

This topic explains the following sections:
Prerequisites to view CMDB dashboard
Reports in CMDB Dashboard
Filtering Reports
Handling problems in viewing CMDB Dashboard
BMC Atrium Core 9.0
Page 264 of 2268
Home
The BMC Atrium Configuration Management Database (CMDB) Dashboard is a visual indicator of
the overall health of CMDB at a particular time. The details of the CIs are represented in the form of
reports. Each report enables you to look at the health of your CMDB from a different perspective.
Prerequisites to view CMDB dashboard

To view the BMC Atrium CMDB dashboard, you must:
upgrade to BMC Remedy IT Service Management Suite 9.0, which has BMC Remedy Smart
Reporting used for creating reports in CMDB dashboard.
complete the tenant onboarding procedure. For more information, seeOnboarding BMC
Remedy Smart Reporting
complete the report settings in mid tier configurations. For more information, seeConfigure
the BMC Remedy Mid-Tier
Note
If the report settings in mid tier configurations are not configured, the ARERR 9430 error is
displayed. For more information, see Configure the BMC Remedy Mid-Tier
To access CMDB Dashboard, navigate to the Applications menu and select Atrium Core >
Atrium Core Console.
Reports in CMDB Dashboard

Using the CMDB Dashboard you can generate reports based on different qualifications.
Report*
Description
Duplicate Computer System

by Token ID
This report displays the duplicate computer systems by token ID. Click Token ID to view a
detailed list.
BMC Atrium Core 9.0
Page 265 of 2268
Home
Report*
Description
Note: If you maximize the report, features available on the toolbar are not applicable.
List of Orphan CIs in CMDB
This report shows a list of Orphan CIs is represented in a tabular format. Click Class ID to view a
detailed list.
Note: If you maximize the report, features available on the toolbar are not applicable.
CIs by Type
This report displays a pie chart of the CIs by type. Select and drag the CI type, to view Keep,
Exclude, and Reset options.
Keep: The selected types are displayed in the pie chart.
Exclude: The selected types are excluded from the pie chart.
Reset: The pie chart is reset.
CI Creation Trend
This report displays the time wise trend of creation of CIs. You can see daily, weekly, monthly,
quarterly, and yearly trend.
Note: The options Millisecond, Second, Minute, and Hour are not applicable for this graph.
You can hide or view the series selection. To view the series selection, click Show Series
Selection.
Total CIs: To view the CI creation trend, select the check box and click Go.
Total Relationship CIs: To view the CI creation trend for Relationship CIs, select the
check box and click Go.
Select and drag the CI trend, to view Keep, Exclude, and Reset options.
Keep: The selected trends are shown in the graph.
Exclude: The selected trends are excluded from the graph.
Reset: The graph is reset.
Note: For this report, there is dependency on Flashboard variables for report generation.
*All the reports are created using BMC Remedy Smart Reporting.
The reports display No results returned if no data is found.
Filtering Reports
By default, all the chart data is displayed for BMC.Asset. To change the target dataset for a
particular report,
1. Click Filters on the left navigation menu.
2. Click > to expand the menu.
3. Select the required Dataset IDs.
4. Click Go.
Note
In the left navigation menu, features other than Filters are not applicable.
BMC Atrium Core 9.0
Page 266 of 2268
Home

If you are unable to view the CMDB Dashboard ensure that you are able to launch Smart
Reporting console and navigate to BMC Remedy Smart Reporting and check if you can view
the CMDB Dashboard added by default.
If you explicitly remove or delete the CMDB Dashboard tab from Smart Reporting console,
the default view that has been set in Smart Reporting is displayed in Atrium console. Ensure
that you add the CMDB Dashboard as a tab..
In case you do not view the CMDB Dashboard in the expected locale, you may have to
manually set the correct preference in BMC Smart Reporting. For more information, see
Setting the locale and time zone for BMC Remedy Smart Reporting .
Accessing the BMC Atrium CMDB and BMC Atrium Core

applications
You access the most important BMC Atrium Configuration Management Database (CMDB)
functionality and BMC Atrium Core applications through the BMC Atrium Core Console.
BMC Atrium Core Console
BMC Atrium Core 9.0
Page 267 of 2268
Home
For more information about the specific BMC Atrium Core applications, see the following topics:
BMC Atrium Core Console interface
Opening BMC Atrium Explorer
To access the CMDB and BMC Atrium Core applications through the BMC Atrium
Core Console
1. In a browser, enter the URL designated by an administrator. For example: *http: <
midTierServer>:<port>/arsys*
<midTier Server> is the name of the web server where the BMC Remedy Mid Tier is
installed*.*
<port>is the port number of the web server where the BMC Remedy Mid Tier is
installed, which is required only if the web server is not using the default port (80 if
using Microsoft IIS or 8080 if using Apache Tomcat).
BMC Atrium Core 9.0
Page 268 of 2268
Home
Note
BMC Remedy Mid Tier, configured to communicate with the AR System
server, is a requirement for running BMC Atrium Core Console. If you
encounter Page not found errors when trying to access BMC Atrium
Core Console, make sure that you have restarted the mid tier after
installation of BMC Atrium Core and that the mid tier is configured to
communicate with the appropriate AR System server.
2. In the login page, specify the following details:

In the User Name field, type your user name.
In the Password field, type your password.
In the Authentication field, type the authentication string (if one was provided by an
administrator)
3. Click Login.
4. In the AR System Home page, select Atrium Core > Atrium Core Console .
If you access multiple servers from the AR System Home page, you would select Atrium
Core > Atrium Core Console.
Opening Atrium Core Console from the AR System Home page
A bar at the top of the BMC Atrium Core Console displays the name of the current user. The
Application Launcher bar appears on the left side of the console. Use this bar to open
applications such as BMC Atrium Explorer.
5. Click Application Launcher in the upper left corner at any time to open or close the list of
available applications.
Note
To improve client performance, the Adobe Flash Player prompts you to cache up to
1MB of data when you first open the BMC Atrium Core Console. Do not confuse
the Adobe Flash Player cache with your browser cache.
BMC Atrium Core 9.0
Page 269 of 2268
Home
Adobe Flash Player Settings
6. Click Allow to store the cache information on your computer.

If you click Deny, the cache is not used and you are not prompted again when you log on. If
you change your mind and later want to modify the cache settings, you must adjust the
settings by performing the following actions:
a. Right-click inside the display pane and then select Settings.
Adobe Flash Player Settings dialog box
b. In the Adobe Flash Player Settings dialog box, move the slider to the far left to allow
0KB of local storage.
c. At the prompt that all information will be removed, click OK.
d. When you return to the Adobe Flash Player Settings dialog box, click Close. The next
time that you log on and open the BMC Atrium Core Console, the system prompts
you to store the cache on your computer.
7. Pause your mouse pointer over either Applications or Atrium Tools.
8. Click the icon of the application that you want to open (for example, BMC Atrium Explorer).
BMC Atrium Core 9.0
Page 270 of 2268
Home
BMC Atrium Core Console interface

The BMC Atrium Core Console serves as a central location where you can access BMC Atrium
applications, such as BMC Atrium Explorer, Normalization console, Reconciliation console, and
Federation Manager.
Depending on your permissions, you might be able to view only specific BMC Atrium applications.
BMC Atrium Core Console toolbar

The BMC Atrium Core Console toolbar contains links to perform functions, such as opening the
BMC Atrium CMDB Online Help and viewing the version information for the product.
BMC Atrium Core Console toolbar
BMC Atrium Core 9.0
Page 271 of 2268
Home
Use the BMC Atrium Core Console toolbar to access the BMC Atrium Configuration Management
Database (BMC Atrium CMDB) Online Help, close a BMC Atrium CMDB application, log out of the
BMC Atrium Core Console, and view the version of BMC Atrium Core that you have currently
installed. The following table describes the buttons on the toolbar.
BMC Atrium Core Console toolbar buttons

Button
or
menu
Description
Help
Launches the BMC Atrium CMDB Online Help.
About
Displays the copyright, version number, and build number information for the BMC Atrium Core Console. The product
version appears in the following format: V + R + MM +PPP (if you installed a patch), where
V=The BMC Atrium Core version, for example, 8.0.00.
R=Release
MM=Maintenance number
PPP=Patch number The product build information appears in the following format: YYMMDD-HHMMSS, where
YYMMDD--The year, month, and date on which the build was created.
HHMMSS--The exact time of the build in hours, minutes, and seconds.
Note: The alphabet 'L' appears in front of the build information if you applied a hotfix, for example, BUILD
L100413-175203.
Close
Closes the application that you have launched in the BMC Atrium Core Console. If you have launched several
applications, the BMC Atrium Core Console closes the one that is currently highlighted. To close the BMC Atrium Core
Console, make sure you close all other open applications first and then click Close again.
Logout
Logs you out of the BMC Atrium CMDB application.
BMC Atrium Core applications

The following table lists the BMC Atrium Core applications that you can open in the BMC Atrium
Core Console. Every application that you open in BMC Atrium Core Console contains its own tab,
which enables you to switch between applications in the same browser window.
Each application also contains its own navigation functions and buttons as well as other options
that enable you to adjust the viewing area of the application.
BMC Atrium Core applications

Application
Description
Class Manager
View and modify the classes in the data model. Only users with the CMDB Definitions Admin role can access
this application. For more information about Class Manager, see Creating, modifying, or deleting classes with
the Class Manager.
BMC Atrium Core 9.0
Page 272 of 2268
Home
Application
Description
Explorer
View information about the configuration items (CIs) and relationships in BMC Atrium Configuration
Management Database (BMC Atrium CMDB) in a graphical layout. For more information about BMC Atrium
Explorer, see Working with related CIs.
Normalization
Configure and monitor the normalization engine. The normalization engine makes sure that product names
and categorization are consistent across different datasets and from different data providers. For more
information about normalization, see Normalizing data.
Reconciliation
Configure, troubleshoot, and monitor the reconciliation engine. The reconciliation engine reconciles CI and
relationship data from multiple datasets into a single instance in the production dataset. Only users with the
CMDB RE User, CMDB RE Manual Identification, or CMDB RE Definitions Admin role can access this
application. For more information about reconciliation, see Reconciling data.
Service Catalog
Define a common list of services; map business services to supporting services; rationalize data across IT
processes based on a business context; and provide a service-oriented approach to enable management
reporting. For more information about the Service Catalog, see Administering service models and the Service
Catalog.
Federation
Manager
Configure how to access to federated data, which is stored outside BMC Atrium CMDB, and link that data to
CIs in the BMC Atrium CMDB. For more information about Federation Manager, see Configuring federated
data in BMC Atrium CMDB.
Impact Simulator
Determine the impact a change to a CI will have on other CIs. For example, you might run a simulation in
Atrium Impact Simulator to learn what devices and applications in the network will be impacted if you were to
take a server offline. For more information about Atrium Impact Simulator, see Finding BMC Atrium CMDB
data.
Product Catalog
View and create product entries, set up product categorization, and approve products for membership in your
Definitive Media Library (DML) and Definitive Hardware Library (DHL). For more information about the Product
Catalog, see Managing the Product Catalog and the DML.
AIE (
Application
Launcher >
Integration
Use BMC Atrium Integration Engine only for existing data exchanges between external data stores and BMC
Atrium CMDB, or between external data stores and BMC Remedy AR System (AR System) applications and
forms. For more information about BMC Atrium Integration Engine, see the BMC Atrium Integration Engine
User Guide.
Engines )
For creating new data transfers between external data stores and BMC Atrium CMDB, use Atrium Integrator,
as described in Understanding Atrium Integrator.
Atrium Integrator
(Application
Use Atrium Integrator for new data transfers between external data stores and BMC Atrium CMDB. For more
information about Atrium Integrator, see Understanding Atrium Integrator.
Launcher >
Integration
Engines )
Opening BMC Atrium Explorer

Use the BMC Atrium Explorer to manage the CI and relationship instances in BMC Atrium
BMC Atrium Explorer UI
BMC Atrium Core 9.0
Page 273 of 2268
Home
To open BMC Atrium Explorer

1. In a browser, enter the URL designated by an administrator. For example:
http://<midTierServer>:<port>/arsys
installed.
<port> is the port number of the web server where the BMC Remedy Mid Tier is
administrator)
3. Click Login.
If you access multiple servers from the AR System Home page, you would select BMC
Atrium Core > BMC Atrium Core Console .
BMC Atrium Core 9.0
Page 274 of 2268
Home
Application Launcher bar appears on the left side of the console.
5. Click the Application Launcher.
Use this bar to open applications such as BMC Atrium Explorer or Class Manager.
6. Mouse over Applications, and then select BMC Atrium Explorer.
BMC Atrium Explorer interface

The BMC Atrium Explorer user interface is divided into three panes: the toolbar, display pane, and
navigation pane.
BMC Atrium Explorer toolbar
Navigation pane
BMC Atrium Explorer UI
BMC Atrium Core 9.0
Page 275 of 2268
Home
BMC Atrium Explorer toolbar

Use the BMC Atrium Explorer toolbar and user interface to change the layout and view of the
instances in the display pane, create new views, and run filters. The following table describes the
buttons and menus on the toolbar.
Button or menu
Description
New View
Opens an empty view of the dataset in the

display pane. See Creating, copying, or
deleting views for more information. If you
have multiple datasets in BMC Atrium
Configuration Management Database (
BMC Atrium CMDB), use the attached list
to select a dataset for the new view.
Refresh View
Updates the display of the current view to

reflect any changes that you have made,
and makes sure that the view has been
synchronized with BMC Atrium CMDB.
Save View
Saves the view currently open in the

display pane. See BMC Atrium Explorer
views for more information.
Export View as Image
Enables you to save the current view as a

png image. See Saving a view as an
image for more information.
Print View
Prints the current view. Consider using the

Layout controls to optimize how instances
are displayed before printing the view.
Map IT Resources
Maps a query to any configuration item (CI)

for dynamic modelling to automate the
maintenance of service models supporting
that CI. You can associate a query with a
technical or business service and
dynamically update the CIs that are related
to the service. For more information about
creating dynamic service models, see
Administering service models and the
Service Catalog.
Options
Enables you to change the options for

displaying instances. For more information,
see Opening BMC Atrium Explorer.
Open Launch in Context Menu
Opens any Launch-method federated links

for the selected instance. For example, if
the BMC Remedy IT Service Management
applications are installed on your system,
this menu provides links to federated
change requests or incidents related to the
instance. See Viewing federated data in
BMC Atrium Explorer for more information.
BMC Atrium Core 9.0
Page 276 of 2268
Home
Button or menu
Description
This menu also provides a link to the
Service Context Summary window, which
allows you to view critical information about
business services and their performance.
This information is displayed in context of
the applications that are running in your
environment. For more information, see
Viewing business service CI information by
using BMC Atrium Service Context.
Display
Provides options for displaying instances:

Topology View Shows instances
graphically, with lines to illustrate
relationships between CIs.
Table View Lists instances as
rows in a table.
Create Relationship Mode and Relationship Type menu
Toggles the ability to add relationships

between CIs in the current view. See
Creating relationships between CIs for
more information. The display pane must
be visible as a topology, and not as a a
table, to create relationships.
Note: You cannot create relationships in
the BMC Asset dataset.
Manage Filters
Displays Filters dialog box. You can create,

copy, edit, or delete filters that restrict the
instances shown in the current view. See
BMC Atrium Explorer filters for more
information.
Promote Sandbox Changes
Runs the BMC Atrium Explorer

Identification and Merge reconciliation job
to promote changes in the Sandbox
dataset to the BMC Asset dataset.
Promote Sandbox Changes works only
with the Sandbox dataset. For more
information, see Sandbox views and
datasets. To promote CIs in the BMC
Sample dataset, run the BMC Sample
Dataset Identification and Merge job from
the Reconciliation console. To promote CIs
from any other dataset, create your own
reconciliation job. For more information,
see Reconciliation jobs.
Layout controls
BMC Atrium Core 9.0
From the topology view, applies any of the

following layout controls to the instances in
the display pane:
Page 277 of 2268
Home
Button or menu
Description
Choose filter Applies a filter that
limits the instances that are visible
in the current view or in a popup.
See BMC Atrium Explorer filters for
more information.
Layered Specifies the layout style
of the view (for example, Hierarchic)
. See BMC Atrium Explorer layout
controls for more options.
Top to Bottom Specifies the
direction of the instances in the
display pane. You apply it to the
layout style.
Run Layout
If you have added new CIs to a view, click

Run Layout in the view to reorganize the
view according to the selected layout.
Navigation pane
The navigation pane enables you to control the instances and views that are available in the display
pane. It also enables you to query BMC Atrium Configuration Management Database (BMC Atrium
CMDB) for specific instances to add to a view in the display pane. The navigation pane has several
sections, as described in the following table.
Section
Description
Classes
Lists the classes available in the data model. You can choose to view classes as an alphabetical list of names with
large icons, an alphabetical list of names with small icons, and a hierarchical list of icons. You can drag a class to the
display pane to create a new instance of that class, and add that instance to the current view. See Configuring instance
display options in BMC Atrium Explorer for more information.
Note: You cannot directly create CIs in the BMC Asset dataset, which is reserved for production use. To add new CIs
in the BMC Asset dataset, you must create the CIs in your Sandbox dataset and promote them.
Views
For each saved view, this section provides the name, the type (local or global), and a description. Select a view and
click Open to open that view in the display pane. See BMC Atrium Explorer views for more information.
Find
Enables you to query BMC Atrium CMDB for specific instances. After running a query, drag an instance from the results
list to add it to the current view.
Note: You can drag an instance from the results list to a view only if the view's dataset is the same as the query's
dataset. If the view's dataset differs from the query's dataset, a red X appears on the instance when you drag it and the
instance is moved back to the results list. Additionally, the following message appears in the display pane: CI dataset
does not match view dataset.
See Finding BMC Atrium CMDB data for more information.
Configuring instance display options in BMC Atrium Explorer

You can configure options for displaying instances in BMC Atrium Explorer.
Configuring instance display options in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 278 of 2268
Home
To open BMC Atrium Explorer and configure instance display options

1. On the left side of the BMC Atrium Core Console, click the Application Launcher.
2. Mouse over Applications and select BMC Atrium Explorer.
3. In the BMC Atrium Explorer toolbar, click Options.
4. In the Options dialog box, configure the following options:
Maximum Number of Characters to display (General tab) Sets the number of
characters to display for instance names. Default is 32.
Number of Graph Expansion Levels (General tab) Sets the number of levels to
open by default for an instance that you add to a view. Default is 2.
(Non-Query View) Expand Graph (General tab) Sets where to display configuration
items (CIs) and relationships when you expand a CI.
View By default, adds the expanded CIs directly to the view.
Popup Displays the expanded CIs in a popup dialog box.
For more information, see Working with related CIs.
Note
In the BMC Atrium Explorer Query view, CIs are always expanded as
popups. For more information, see Creating queries with folding rules
in BMC Atrium Explorer.
BMC Atrium Core 9.0
Page 279 of 2268
Home
Relationship Types tab Sets the color, weight, and style of the lines used to
indicate relationships. To revert to the original color scheme, click Restore Defaults.
Dataset Backgrounds tab Sets the background color for different types of views. To
revert to the original color scheme, click Restore Defaults.
5. Click OK.
Views of the dataset in the display pane

BMC Atrium Explorer displays BMC Atrium Configuration Management Database (BMC Atrium
CMDB) configuration item (CI) and relationship instances as a graphical map inside of a particular
view. Think of a view in BMC Atrium Explorer as a "window" into a particular dataset. A view lets
you display a subset of CIs from your dataset. Based on the dataset that you select in your query
options, you can perform various actions on the CIs within that view (for example, modify or delete).
After you have populated a view with CIs and then saved it, you can reopen that view to work with
those CIs.
To view the CIs in the dataset, you can drag one or more instances from the Find section of the
navigation pane to the display pane. When you drag a CI instance to the display pane, you show
the CI in a particular view. A message appears that indicates the result of dragging the instance or
the reason why the drag operation was rejected. You can also click a CI and select Expand
Children or Expand Parents to see associated CIs in the display pane.
Configuration items (CIs)
Relationships
Related topics
The following figure shows a topology of related instances in the display pane of BMC Atrium
Explorer.
Topology of related instances in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 280 of 2268
Home
All instances visible in the display pane are represented as a view of a specific dataset. You can
have several views opened at once, though only one at a time is active. After you have opened a
view, its name is listed at the bottom of the display pane (for example, View - BMC Asset or View1 Sandbox for John). Click the names at the bottom of the display pane to switch between views as
you work. For more information, see BMC Atrium Explorer views.
Use the zoom bar to resize the topology in the display pane for easier viewing.
Zoom Out makes the topology appear smaller, and Zoom In makes the topology appear
larger. You can also resize the topology by dragging the slider between these two buttons, or
by using the scroll wheel on the mouse.
Zoom Fit resizes the topology so that all CIs and relationships fit in the viewable area of the
display pane.
Show Overview is a navigation aid. You can click and drag the highlight box to select an
area of the graph that you are interested in and the large graph pans and zooms to display
the portion you have highlighted.
The following figure shows the zoom bar and its buttons.
Zoom bar in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 281 of 2268
Home
Configuration items (CIs)

Each CI is represented by an icon that indicates the class of that instance. Each icon includes
arrows that show other CIs related to that instance. Click the icon and either expand (show) or
collapse (hide) related CIs.
If a CI's isVirtual attribute is assigned the Yes value, the CI's icon is enclosed in a brown
rectangle, which enables you to quickly identify CIs running as virtual machines. The following
figure shows a virtual computer with a brown rectangle.
Virtual computer in BMC Atrium Explorer
The label below each CI icon identifies that CI. The text of the label is the value of an attribute of
the CI class. By default, BMC Atrium Explorer uses the Name or ShortDescription attribute of
that CI, depending on its CI class, as listed in the following table. CIs that represent logical
resources use the Name attribute. CIs that tend to have long, encoded names use the
ShortDescription attribute.
Classes with a Name attribute label
Classes with a ShortDescription attribute label
BMC_Collection
BMC_AccessPoint
BMC_Document
BMC_Equipment
BMC_LogicalEntity
BMC_Settings
BMC_Person
BMC_System
BMC_SystemComponent
BMC_SystemService
BMC Atrium Core 9.0
Page 282 of 2268
Home
Note
For CIs of classes that are not listed in the following table, BMC Atrium Explorer uses the
CI's ShortDescription attribute to identify the CIs.
A subclass uses the CI label settings of its superclass. For example, because the BMC_System
class uses the ShortDescription attribute for CI labels, the BMC_ComputerSystem class also
uses the ShortDescription attribute. You can configure different attributes to use for CI labels
of a class. For more information about changing the attributes that are used for CI labels, see
Defining CI labels for a class.
Instance icons can include a small graphic that indicates its status. While you make changes in a
personal Sandbox dataset, Edited, Deleted, New, and Virtual indicate the changes to each
instance of a CI class or a Relationship class in relationship to the BMC Asset dataset. These
icons enable you to keep track of the changes you have made before promoting those changes to
the production dataset. See Sandbox views and datasets for more information. Deleted is available
in all dataset views to indicate instances that are marked for deletion. Virtual is available in all
dataset views to indicate virtual instances. The following table describes the status icons for
different types of CIs or relationships.
Icon
Description
The CI has been edited in the Sandbox dataset. A corresponding copy of the CI exists in the BMC Asset dataset.
The CI has been deleted from the dataset.
The CI is new in the Sandbox dataset. No corresponding copy of the CI exists yet in the BMC Asset dataset.
The purple icon and arrow indicate the impact relationship and its direction. For more information about impact
relationships, see Impact states in Atrium Impact Simulator.
The CI is a virtual CI in the dataset.
None
If the CI is being viewed in BMC Asset, the status of CI is unchanged.
If the CI is being viewed in the Sandbox, the CI exists only in the Sandbox view but not in the Sandbox dataset. A
corresponding copy of the CI exists in the BMC Asset dataset.
Relationships
The lines connecting CIs represent the different types of relationships. The following table lists and
describes the types of relationships that are available in BMC Atrium Explorer at installation, and
the default lines that represent them in the display pane.
BMC Atrium Core 9.0
Page 283 of 2268
Home
Relationship lines in BMC Atrium Explorer

Relationship
type
Default
line
Description
Member of
Collection
Solid
black
The destination CI is a member of a collection related to the source CI. For more information about
member-of-collection relationships, see the BMC Atrium CMDB Data Model Help.
Partial group
Relationship
Dotted
red
Connects a CI to a group of related CIs, where the group is incomplete. For example, if browsing
CIs in a view causes a CI to be connected to two separate groups of CIs, when those groups would
ordinarily be in the same group, the partial group line is used. See Instance groups for more
information.
Element Location
Solid
The destination class is located in a place defined by the source CI. For more information about
blue
location relationships, see the BMC Atrium CMDB Data Model Help.
Group
Relationship
Dashed
grey
Connect a CI to a group of related CIs. See Instance groups for more information.
Virtual
Dashed
Connects a CI to another CI, but the relationship is indirect because a filter or folding action has
Relationship
red
removed an intermediate CI from the view. For example, CI-1 is related to CI-2, and CI-2 is related
to CI-3. If a filter has removed CI-2 from the view, the relationship between CI-1 and CI-3 is virtual.
For more information about virtual relationships, see the BMC Atrium CMDB Data Model Help.
Dependency
Impact
Solid
The destination CI depends on the source CI. For more information about dependency relationships
red
, see the BMC Atrium CMDB Data Model Help.
Solid
fuchsia
The source CI impacts the destination CI. This impact relationship line represents a "pure" impact
relationship that is a hard coded and unchangeable part of the relationship definition. Contrast the
Impact relationship type to an existing relationship (for example, Component) where the
HasImpact attribute is set to Yes. For more information about impact relationships, see Impact
states in Atrium Impact Simulator.
Component
Solid
green
The destination CI is a component of the source CI. For more information about component
relationships, see the BMC Atrium CMDB Data Model Help.
BMC_Genealogy
Solid
black
The destination CI is a clone of the source CI. For more information about BMC_Genealogy
relationships, see the BMC Atrium CMDB Data Model Help.
To change line colors and styles, click Options in the toolbar to open the Options dialog box.
BMC Atrium Core 9.0
Page 284 of 2268
Home
Related topics
BMC Atrium Core queries
BMC Atrium Explorer and building queries
Creating queries with folding rules
Display pane actions

You start by selecting a dataset in the query options. Based on the resulting list of configuration
items (CIs) that are returned from your search, you can perform various actions inside the display
pane. For example, right-click inside the display pane and then select Show All Sandbox Items.
Available actions inside the display pane
The following table lists the actions you can perform inside the display pane. Not all operations are
supported in every view. For example, you can only show all sandbox items inside the Sandbox.
Action
Description
Select All
Objects
To select all objects in the view, right-click in the display pane and then select Select All Objects. All the objects
are then high-lighted in the view.
Create CI
To create a CI, right-click in the display pane and then select CreateCI. The Classes pane automatically opens and
help text is displayed: Drag a class from the classes pane to the view to create a CI. For more information, see
Creating CIs in BMC Atrium Explorer.
Create
relationship
To create a relationship, right-click in the display pane and then select Create relationship. The Create
Relationship Mode is automatically enabled and help text is displayed: Create relationship mode has been turned
on. For more information, see Creating relationships between CIs.
BMC Atrium Core 9.0
Page 285 of 2268
Home
Action
Description
View as
Production
To view only the production instances, right-click in the display pane and then select View as Production. The
Asset view and only the production instances appear in the display pane. For more information, see Working with
related CIs.
Show All
Sandbox
Items
To review all the CI and relationship instances in the Sandbox before you promote them, right-click in the display
View as
Impact
Model
To view only the CIs with impact relationships, right-click in the display pane and then select View as Impact Model
pane and then select Show All Sandbox Items. All the CIs and their relationships in your Sandbox dataset are
displayed.
. A read-only topology view of the Impact Model appears. You can use the Layout menu to specify the layout (for
example, Hierarchic) and direction (for example, Top to Bottom) of the instances, but you cannot expand or edit the
Impact Model. When you finish with the Impact Model, close the view to return to BMC Atrium Explorer.
CI actions you can perform in the display pane

You start by selecting a dataset in the query options. Based on the resulting list of configuration
items (CIs) that are returned from your search, you can display, edit, delete, or expand those
instances in a particular view on the display pane.
Down arrow menu options when you select an instance
After you select the instance, you click the down arrow and then you select an item from the menu.
Not all operations are supported in every view. For example, you can only display not edit or delete
CIs from the BMC.ASSET view. When you try to edit a CI from the BMC.ASSET view, you are
BMC Atrium Core 9.0
Page 286 of 2268
Home
prompted to create a new Sandbox view. Only inside the Sandbox view can you edit the CI or
delete it from the database. When you make your final edits to the CI, you then promote it to the
BMC Asset dataset. For more information, see Views of the dataset in the display pane .
Action
Description
Edit
To edit all the attribute values of an instance, click the down arrow and then select Edit.
Note: This menu item is not available for service CIs and relationships, which should be modified in the Service
Catalog. For more information, see Restrictions on modifying service CIs and relationships in BMC Atrium Explorer .
For more information, see Editing CIs and relationships in BMC Atrium Explorer.
Quick
Edit
To edit the name and short description of an instance, click the down arrow and then select Quick Edit.
For more information, see Editing CIs and relationships in BMC Atrium Explorer.
Delete
from
Database
To delete instances, click the down arrow and then select DeletefromDatabase. The Delete from Database
command determines whether the selected instance should be:
Marked as deleted, or soft deleted. This action is indicated by Deleted.
Deleted from the dataset, or hard deleted. The instance is deleted from the database and removed from the
view.
Note: This menu item is not available for service CIs and relationships, which should be modified in the
Service Catalog. For more information, see Restrictions on modifying service CIs and relationships in BMC
Atrium Explorer.
For more information, see Sandbox views and datasets.
Discard
To remove instances or relationships from the Sandbox that you do not want to promote, click the down arrow and
Sandbox
Changes
then select Discard Sandbox Changes. The instance is removed from the Sandbox and any changes that you have
made are discarded.
For more information, see Sandbox views and datasets.
Remove
From
View
To remove an instance from a view, click the down arrow and then select Remove From View. For more information,
Properties
To view a list of instance properties, click the down arrow and select Properties. For more detailed information about
the properties of an instance, open that instance for editing as described in Editing CIs and relationships in BMC
Atrium Explorer.
Impacted
Services
To view of a list of services that are potentially impacted if the CI selected in the current view is unavailable or
see Sandbox views and datasets.
impaired, click the down arrow and then select Impacted Services. These services have the potential of being
impacted if the selected CI is affected adversely. For example, a service that depends on a server will be impacted if
the server is down. You can drag a service from the Impacted Services list to the current view. For more information
about impacted services, see Impact states in Atrium Impact Simulator.
To view any destination CIs in the display pane, click the down arrow and then select Expand Children.
BMC Atrium Core 9.0
Page 287 of 2268
Home
Action
Description
Expand
Children
Expand
To view any source CIs in the display pane, click the down arrow and then select Expand Parents.
Parents
Expand
Both
To view both the source and destination CIs in the display pane, click the down arrow and then select Expand Both.
Expand
Default
To expand the CI according to its default setting, click the down arrow and then select Expand Default.
If a scope is defined for the CI, Expand Default uses the scope to expand the CI.
If no scope is defined for the CI, the CI expands both the source and destination CIs.
Note: Expand Default performs the same action as double-clicking the CI.
Some CIs include a "scope" definition. A scope is a predefined query that limits the type of CIs displayed when
you expand a CI. Not all CI classes have scope definitions. The current scopes available are:
Business Service
Application (shown in Viewing scoped CI and expanded CIs in BMC Atrium Explorer )
Cluster
Software Server
Computer System (defined as Server)
For example, the Business Service scope expands the CI to display only Business Service, Application,
Software Server, Computer System, and Cluster CIs that are modeled with BMC_Dependency relationships.
Collapse
Children
To hide the destination CIs in the display pane, click the down arrow and then select Collapse Children.
Collapse
Parents
To hide the source CIs in the display pane, click the down arrow and then select Collapse Parents.
Group
Children
To group CIs of the same class (that is, the common children CIs) related to a parent CI, click the down arrow and
then select Group Children. When the Select Class Type(s) to Group dialog box appears, perform one of the
following actions:
Select one or more classes to group and then click Group
Click Select All and then click Group.
Group
To group CIs of the same class (that is, the common parent CIs) related to a child CI, click the down arrow and then
Parents
select Group Parents.
Simulate
Impact
To run an impact simulation, click the down arrow and then select Simulate Impact. For more information, see
Running an impact simulation.
Quick
Impact
Simulator
To access a streamlined version of Atrium Impact Simulator that lets you simulate the impact of a CI being
Compare
Instances
To compare Sandbox CIs against the version in the production dataset so that you can analyze manual changes
Compare
Against
Asset
Version
To compare an instance in the Sandbox with the BMC Asset dataset, click the down arrow and then select Compare
unavailable without having to launch the Atrium Impact Simulator, click the down arrow and then select Quick Impact
Simulator. For more information, see Running a quick impact simulation.
made, click the down arrow and then select Compare Instances. For more information, see Comparing CI and
relationship instances.
Against Asset Version. For more information, see Comparing CI and relationship instances.
BMC Atrium Core 9.0
Page 288 of 2268
Home
Action
Description
View
History
To view the audit history of an instance, click the down arrow and and then select View History. For more
information, see Viewing instance history in BMC Atrium Explorer.
Restrictions on modifying service CIs and relationships in BMC Atrium Explorer

When the Service Catalog creates relationships between service model classes, it assigns specific
names to the relationships. These relationships should not be edited or deleted within BMC Atrium
Explorer, and you should use the Service Catalog for modifications.
As a result, the Edit, Quick Edit, Delete from Database, and Discard Sandbox Changes context
menu items in BMC Atrium Explorer are disabled for the following relationship classes.
SERVICEREALIZEDBYOFFERING
ORGANIZATIONPROVIDESSERVICE
SERVICESUPPORTEDBYORGANIZATION
SERVICESUPPORTEDBYPERSON
BUSINESSSERVICESUPPORTEDBYTECHNICALSERVICE
TECHSERVICECOMPRISEDOF
SERVICEOFFERINGSUPPORTEDBYSERVICE
CONTRACTLINEINCONTRACT
OFFERINGCOVERSCONTRACTLINE
ORGANIZATIONCOVEREDUNDERCONTRACTLINE
PERSONCOVEREDUNDERCONTRACTLINE
CONTRACTLINERESULTOFCONTRACTLINE
SOCONTRACTSASSOLINE
ROOFFEREDBYLINEITEM
ROCONTRACTSASROLINE
SOENABLESRO
OPTIONLINEPARTOFSOLINE
SELECTEDOPTIONLINEPARTOFADDONLINE
OPTIONLINERECORDSOPTIONCHOICE
ORGANIZATIONISPROVIDERFORCONTRACT
ORGANIZATIONISCUSTOMERFORCONTRACT
ADDONSERVICEFORORGANIZATION
ADDONSERVICEFORPERSON
SOLINEISPARENTOFADDONLINE
ROCREATESADDONLINE
SOLINEISPARENTOFROLINE
OPTIONLINEPARTOFSOLINE
PERSONASSOCIATEDWITHORGANIZATION
ORGANIZATIONCOMPOSEDOF
OFFERINGMEASUREDBY
BMC Atrium Core 9.0
Page 289 of 2268
Home
OFFERINGOPTION
OFFERINGPRICE
OFFERINGCOST
OPTIONCHOICEPRICE
OPTIONCHOICECOST
OPTIONCOMPRISEDOFOPTIONCHOICE
DOCUMENTDESCRIBESOFFERING
SOSUPPORTSSO
FUNCTIONALMODELPROVIDESDEPLOYMENTMODEL
For instances of service classes, you should use the Service Catalog for modifications. The Edit,
Quick Edit, Delete from Database, and Discard Sandbox Changes context menu items in BMC
Atrium Explorer are disabled for the following configuration item (CI) classes:.
BMC_SERVICELEVELTARGET
BMC_REQUESTABLEOFFERING
BMC_CONTRACT
BMC_CONTRACTLINE
BMC_PRICE
BMC_TAG
BMC_OPTION
BMC_OPTIONCHOICE
BMC_COST
BMC_SERVICEOFFERING
Also, if a CI has the ServiceType attribute set to Business or Technical and connected to any
instances of BMC_ServiceOfferings, you cannot delete it. You can delete the CI if one or both
of the following conditions are true:
If ServiceType is not set to Business or Technical
If it is not connected to any instances of BMC_ServiceOfferings

The Atrium Integrator console is the main user interface for Atrium Integrator. You can access the
other Atrium Integrator components from the console.
Note
On a computer where you have installed BMC Atrium Core, you can also access Atrium
Integrator from BMC Atrium Core > BMC Atrium Core Console > Integration Engines
> Atrium Integrator
BMC Atrium Core 9.0
Page 290 of 2268
Home
To access the Atrium Integrator console

1. In a browser, enter the URL designated by an administrator. For example:http://midTier:port/
arsys
midTier is the name of the web server where the BMC Remedy Mid Tier is installed*.*
port is the port number of the web server where the BMC Remedy Mid Tier is installed
, which is required only if the web server is not using the default port (80 if using
Microsoft IIS or 8080 if using Apache Tomcat).
2. In the Log on page, specify the following details:
administrator)
3. Click Log on.
4. In the BMC Remedy AR SystemHome page, select BMC Atrium Integrator > Atrium
Integrator.
Atrium Integrator link from the BMC Remedy AR System Home page
The Atrium Integrator console appears.
Launching Atrium Integrator Spoon from Atrium Integrator

You can invoke Atrium Integrator Spoon from Atrium Integrator in one of the following ways:
In the Atrium Integrator console, click Launch Pentaho
In the Generated Transformations page of the Integration Job Builder wizard, click Launch
Pentaho. For information about creating jobs in the Integration Job Builder wizard, see
Creating a job through the Integration Job Builder wizard .
Note
BMC Atrium Core 9.0
Page 291 of 2268
Home
You can invoke Atrium Integrator Spoon only from a computer on which you have installed
either the Atrium Integrator server or the Atrium Integrator client.
Opening and searching the Service Catalog

With the Service Catalog, you can view the details and relationships of services and add new
services to the model.
To open the Service Catalog
To view the details of a service
To search services
The services in a service model represent parts of your business. As you build a service model, the
Service Catalog enables you to populate the service model from a catalog of services and add new
services. You can then view and edit services.
The Service Catalog enables you to:
Search and view all services that have been defined
Filter the currently displayed set of services by any of their associated attributes
Create a new service, service offerings, request actions, and options
Working in the Service Catalog
To open the Service Catalog

<midTierServer> is the name of the web server where the BMC Remedy Mid Tier is
installed*.*
BMC Atrium Core 9.0
Page 292 of 2268
Home
administrator)
3. Click Login.
If you access multiple servers from the AR System Home page, you would select BMC
Atrium Core > BMC Atrium Core Console .
Opening BMC Atrium Core Console from the AR System Home page
Use this bar to open applications such as BMC Atrium Explorer.
6. Mouse over Applications, and then select Service Catalog. When you open the Service
Catalog, any existing services that you previously created in BMC Atrium Explorer as either
a Business Service or a Technical Service are displayed. The listed services correspond to
services from the BMC.ASSET dataset. Unlike previous releases, the Service Catalog does
not save or load services from your Sandbox dataset.
To view the details of a service

1. In the Services table, select a service.
Service Catalog Details pane
BMC Atrium Core 9.0
Page 293 of 2268
Home
2. Click the Service Offering Details bar on the right.

3. View the service information in the Details pane.
The service offerings are displayed with the name, type, stage, and description of each.
To search services
In the Search field, enter text to search for in the service names and descriptions.
The search criteria applies as you enter text, and the matching services update automatically in the
Services table.
Opening Class Manager and viewing classes

Use the Class Manager application to manage the core of the data model. You can view, modify,
create, and delete configuration item (CI) and relationship classes and their attributes in the data
model.
For more information, see CDM and extension classes.
To open Class Manager and view classes

http://<midTierServer>:<port> /arsys
installed*.*
administrator)
3. Click Login.
4.
BMC Atrium Core 9.0
Page 294 of 2268
Home
4. In the AR System Home page, select Atrium Core > Atrium Core Console .
6. Mouse over Applications, and then select Class Manager.
7. In the Base Classes section of the navigation pane, click a base class.
8. In the display pane, use the expand/collapse buttons to locate the class you want to view.
9. Double-click the class you want to view.
The CI Class or Relationship Class dialog box appears. If you want to modify the class, see
the procedures in Creating, modifying, or deleting classes with the Class Manager .
Class Manager user interface

The Class Manager user interface includes the following panes:
Class Manager toolbar
Class Manager display pane
Class Manager navigation pane
Class Manager layout
BMC Atrium Core 9.0
Page 295 of 2268
Home
Class Manager toolbar

Use the buttons and menus in the Class Manager toolbar to:
Change the layout and view of the classes in the display pane
Create new classes
Edit and delete existing classes
Save the view of your data model as a .png image
Print the contents of the display pane
Change the layout of the classes in the display pane
Class Manager display pane

Each class of the data model is represented in the Class Manager display pane by an icon labeled
with the name of the class. The icon and its border represent the type of class, and an expand/
collapse box shows and hides subclasses. The icon's border differentiates the class type as follows
:
Regular class solid grey line
Categorization class dashed grey line
Abstract class dotted grey line
Final class solid black line
Final categorization class dashed black line
Click a class to highlight it and display its properties in the navigation pane. Double-click a class to
open it for editing. Right-click a class to access commands for adding a subclass, editing the class,
or deleting the class.
Right-click the background of the display pane to view commands that enable you to add new
classes.
After you have opened a base class, its name is listed at the bottom of the display pane. Click the
names at the bottom of the display pane to switch between base classes as you work.
Use the zoom bar to resize the class tree in the display pane for easier viewing. You can also
resize the class tree by using the scroll wheel on your mouse. Hold Shift and click the background
of the display pane to move the class tree within the pane.
Class Manager navigation pane

The Base Classes section of the Class Manager navigation pane shows the classes in the data
model that do not have a superclass, such as BMC_BaseElement and BMC_BaseRelationship.
Click a base class to open that class in the display pane.
BMC Atrium Core 9.0
Page 296 of 2268
Home
The Properties section of the navigation pane shows some of the properties of the class selected in
the display pane. For more information about the properties of a class, open the CI Class or
Relationship Class dialog box for that class as described in Opening Class Manager and viewing
classes.
Click the Hide/Restore arrow to hide or show the navigation pane. You can also resize the
navigation pane by clicking the border and dragging the pane edge left or right.
CDM and extension classes

For classes that are part of the CDM or BMC data-model extensions, you can view detailed
information about each class on the More Information tab of the CI Class or Relationship Class
dialog box. Use this information to help you with the following:
Planning how to use the classes in the data model
Deciding which classes and attributes should be extended if you determine that the current
data model must be extended
The More Information tab includes the following sections:
Sections in the More Information tab
Section
Description
Additional
Lists the following information:
Properties
The data model to which the class belongs, such as the Common Data Model or a BMC extension.
The product owning the class, such BMC Atrium Configuration Management Database (BMC Atrium
CMDB).
The underlying BMC Remedy AR System form.
A detailed description of the class, including recommendations for using the class to store data.
Data
Providers
Lists the products that provide information to the class. For example, a discovery product populates classes.
CI Mappings
Suggests the types of real-world configuration items (CIs) that you might store in the class. For each real-world
item, the CI Mappings section suggests the following recommendations:
Category, Type, and Item settings
Class attributes to set
Normalized
Relationships
Provides the following recommendations for defining relationships that involve this class:
The value to use for the Name attribute for instances of the relationship.
Recommended relationship class.
Source and destination CI classes, including the side of the relationship on which the class belongs.
For legacy CDM classes, the corresponding class from the 1.x version of CDM. This information can help
you plan to move data from legacy classes to current classes.
Relationships
Lists all of the possible relationships in which the class can participate, including the type of relationship class,
and the source and destination CI classes.
BMC Atrium Core 9.0
Page 297 of 2268
Home

You can manage the reconciliation of data between datasets from the Reconciliation console in the
BMC Atrium Core Console. From this console, you can create, view, modify, and delete jobs,
rulesets, and other reconciliation definitions.
The following table provides instructions for the tasks that you can perform related to reconciliation.
Reconciliation tasks
Task
Instruction
Create a standard reconciliation job.
Click Create Standard Identification & Merge Job.

For detailed instructions, see Creating a standard reconciliation job.
Create a customized reconciliation job.
Click Create Job.

For detailed instructions, see Creating and editing a customized reconciliation job.
Edit a reconciliation job.
Select a reconciliation job, and click Edit Job.

For detailed instructions, see Creating and editing a customized reconciliation job.
Manually start a reconciliation job.
Select a reconciliation job, and click Start Job.
Stop a current reconciliation job run.
Select a reconciliation job, and click Stop Job Run.
Completely stop a reconciliation job.

1. Select a reconciliation job, and click Edit Job.
2. Change the Status to Inactive.
3. Click Save.
Permanently remove a reconciliation job.
Select a reconciliation job, and click Delete Job.

If you delete a custom job, all its activities are also deleted. If you delete a a
standard job, all its activities and identification and precedence (merge) rulesets
are also deleted.
View a job's progress by activity (Identify,

Merge, Compare, Copy, Delete, Rename,
and Purge).
Click Show Job Details, and click the Activities & Schedule tab.
For detailed instructions, see Viewing reconciliation job status, results, and history
.
View when a job is scheduled to execute.
Click Show Job Details, and click the Activities & Schedule tab.
.
View a job's past and current executions (by
Click Show Job Details, and click the Job History tab.
.
status or date).
Create a dataset.
Click Create Dataset to define the dataset.

For detailed instructions, see Creating datasets in the Reconciliation console.
Modify the polling interval, RPC socket,

logging for the Reconciliation Engine.
Click Edit Server Configuration to modify the settings.

For detailed instructions, see Configuring Reconciliation Engine system
parameters.
Manually identify an instance that cannot be

identified with a reconciliation job.
BMC Atrium Core 9.0
Page 298 of 2268
Home
Task
Instruction
Click Manual Identification.
Select an unidentified instance, an identified instance to provide the identity for
the unidentified instance, and then click Apply Identity.
For detailed instructions, see Manually identifying data by using the Reconciliation
console.
Export reconciliation jobs and settings to

import to another server.
Click Export.
Modify standard rules for Identification and
Click Standard Rules Editor.
Merge Activities.
For Identification, define the attribute and priority.

For merge, define the precedence for a class or attribute. For detailed instructions
Select a reconciliation job or dataset, and click Save to Clipboard.

For detailed instructions, see Exporting reconciliation definitions.
, see Standard identification and precedence rules for reconciliation jobs.

You use the BMC Atrium Impact Simulator component of BMC Atrium Configuration Management
Database (BMC Atrium CMDB) to determine how a change to the availability of a configuration item
(CI) will affect other CIs.
You could run a simulation in BMC Atrium Impact Simulator to learn what business services
would be affected if you were to take a server offline.
You might also use BMC Atrium Impact Simulator to plan for disaster recovery. You can run
simulations to determine where the network is weakest, and then create your plans.
Before using BMC Atrium Impact Simulator, you should model the impacts among your CIs. For
more information, see Administering CI impact models.
The following topics describe BMC Atrium Impact Simulator in more detail:
Atrium Impact Simulator and BMC Service Impact Manager
Impact states in Atrium Impact Simulator
Atrium Impact Simulator interface
Running an impact simulation
Loading a saved impact simulation
Comparing impact simulations
Running a report of simulation results
Running a quick impact simulation
Opening a related change from BMC Atrium Impact Simulator
Calbro scenario for BMC Atrium Impact Simulator
BMC Atrium Core 9.0
Page 299 of 2268
Home

The BMC Atrium Impact Simulator can predict the impact on configuration items (CIs) by using the
impact relationships that you configure within BMC Atrium Configuration Management Database (
BMC Atrium CMDB). To define an impact relationship between two CIs, the HasImpact attribute in
the BMC_Relationship relationship class must be set to Yes.
If you have the BMC Service Impact Manager (SIM) installed, BMC Atrium Impact Simulator can
also use the impact relationships configured with the BMC Impact Model Designer.
BMC Impact Model Designer is installed as a component of BMC ProactiveNet CMDB Extension.
For more information, see Installing BMC ProactiveNet CMDB Extensions.
Atrium Impact Simulator and BMC SIM
Scenario
Description
Using BMC
Atrium Impact
If you have BMC SIM installed, BMC Atrium Impact Simulator uses the impact relationships that you have
configured by using the BMC Impact Model Designer, the impact relationships added by using BMC Atrium
Simulator with
BMC SIM
Explorer, and the impact relationships that are automatically created in the BMC Atrium CMDB or imported to
the BMC Atrium CMDB.
You can use Atrium Impact Simulator to test different impact scenarios before deploying those scenarios in your
production BMC SIM environment. The following features of BMC SIM are not used with BMC Atrium Impact
Simulator:
BMC SIM schedules
Custom propagation models
Custom status computation models
Custom status states
Dynamic priorities
Using BMC
Atrium Impact
Simulator
without BMC
SIM
If you do not have BMC SIM installed, Atrium Impact Simulator uses the impact relationships that you have
created in the BMC Atrium CMDB through BMC Atrium Explorer or through the dynamic service modeling
function of the Service Catalog.
For more information about creating impact relationships, see Creating relationships between CIs.
Related topic
CI impact models with and without BMC SIM
Impact states in Atrium Impact Simulator

When you run a simulation, you can specify an impact state for each configuration item (CI) in the
simulation.
The following table lists the states that you can select in BMC Atrium Impact Simulator (with the
corresponding BMC Service Impact Manager state in parentheses) and a description for each state
.
Impact states
BMC Atrium Core 9.0
Page 300 of 2268
Home
Atrium Impact Simulator state
Description
Slightly Impaired (Warning)
The CI is delivering services normally, but some issue might affect it.
Impaired (Minor)
The CI's delivery of service is slightly affected.
Very Impaired (Impacted)
The CI's delivery of service is affected.
Unavailable (Unavailable)
The CI has a failure and is unable to deliver service.
When you run a simulation, BMC Atrium Impact Simulator uses these states and the impact
relationships defined between CIs to predict the corresponding impact on those CIs. For example, a
simulation that includes a server with an impact state of Unavailable might return several related
CIs that are predicted to be unavailable as a result of the unavailable server. However, an Impaired
server in that same simulation might return impacted CIs that are predicted to be only Slightly
Impaired.
Atrium Impact Simulator interface

The BMC Atrium Impact Simulator console comprises two sections that contain information about
configuration items (CIs). The CIs for Simulation section lists the CIs that you want to include in a
simulation. The results section provides simulation results as either a table or a graphical topology.
CIs to use in a simulation
Simulation results
The following figure shows the BMC Atrium Impact Simulator layout.
BMC Atrium Impact Simulator layout
BMC Atrium Core 9.0
Page 301 of 2268
Home

Use the CIs for Simulation section to select the configuration items (CIs) to include in a simulation.
You can add one or more CIs to the CIs for Simulation section, each with its own simulated impact
state. The following table describes the fields and buttons in the CIs for Simulation section.
Fields and buttons in the CIs for Simulation section of BMC Atrium Impact Simulator
Field or
button
Description
Add CI
Click to query for one or more CIs to add to the table. For more information about finding CIs, see BMC Atrium
Explorer and building queries.
Remove
CI
Click to remove the selected CI from the table.
Refresh
CIs
Refreshes the list of CIs in the table. If you make changes to the impact model, such as adding or removing an impact
Simulate
Impact
Click to run an impact simulation for the CIs in the table.
relationship in BMC Atrium Explorer, click Refresh CIs to force Atrium Impact Simulator to use the updated data
model for the CIs in the table.
Simulations can include CIs that are instances of subclasses of BMC_BaseElement. Simulations
cannot include federated CIs.
BMC Atrium Core 9.0
Page 302 of 2268
Home
Simulation results
The results section lists the CIs that BMC Atrium Impact Simulator predicts will be affected by the
changes you set in the CIs for Simulation section. You can view the results of a simulation as either
a topology or a table.
Simulation results
Topology view
The Results in Topology view shows the results of a simulation as a topology, including any
relationships between CIs. Each image in the topology represents a CI in the simulation. Each line
connecting CIs represents a relationship.
An icon on each CI image represents the predicted impact state for each CI based on the
simulation criteria, as shown in the following table.
Impact-state icons for simulations
Icon
Predicted impact state

Slightly Impaired (Warning)
Impaired (Minor)
Very Impaired (Impacted)
Unavailable (Unavailable)
The following figure shows the lines and icons in the topology view of simulation results.
Lines and icons in the topology view of simulation results
BMC Atrium Core 9.0
Page 303 of 2268
Home
Click View in Explorer to open the results in BMC Atrium Explorer. By default, the BMC Atrium
Explorer navigation pane is collapsed to provide more viewing area for the topology. For more
information about the capabilities of BMC Atrium Explorer, see BMC Atrium Explorer interface, and
Working with related CIs.
Note
If you make any changes to CIs or relationships in BMC Atrium Explorer, such as creating
a new Impact relationship between CIs, those changes are not available in BMC Atrium
Impact Simulator until after you close and then reopen BMC Atrium Impact Simulator or
you use the refresh button to requery the model and republish it.
Table view
The Results in Table tab shows the results of a simulation as a table. Each row in the table
represents an impacted CI. The Predicted State check box indicates the expected impact for each
CI.
By default, the Predicted State, Name, Class, and ShortDescription check boxes are included in
the table. Click Change Columns to open a dialog box that enables you to add check boxes to or
remove check boxes from the table. You cannot remove the Predicted State check box from the
table.
BMC Atrium Core 9.0
Page 304 of 2268
Home
By default, all impacted CIs are listed in the table, including the CIs from the CIs for Simulation
section. To list only impacted service CIs, click Show Services. To list all impacted CIs, click Show
All Results.
Click View in Large Table to open the table in a separate, larger window. You might find a larger
table useful if a simulation returns several rows of impacted CIs.
Click Report to open the Reports form, which enables you to generate BMC Remedy AR System
reports for the results of a simulation.
Running an impact simulation

You can simulate the impact that a change to one or more configuration items (CIs) will have on
other CIs. The results of the simulation show how related CIs, such as other software on the server,
are affected when you restart the server.
For example, if you have to apply the latest patch to a database and the patch installation requires
the database's host computer to be restarted, you might want to simulate the impact of restarting
the server.
Before you begin

You should model the impacts among your CIs. For more information, see Administering CI impact
models.
To run an impact simulation

1. On the BMC Atrium Core Console, click the Application Launcher > Applications >
Impact Simulator.
2. Add CIs to BMC Atrium Impact Simulator by performing one of the following actions:
Action
Add CIs directly in BMC Atrium
Impact Simulator
Steps
a. In BMC Atrium Impact Simulator, click Add CI.
b. In the Query window, run a query that returns the CIs you want to include
in the simulation.
For more information about finding CIs, see Building queries in BMC
Atrium Explorer.
c. From the results list, select one or more CIs, and then click OK.
The selected CIs appear in the CIs for Simulation section.
Add CIs through BMC Atrium

Explorer
a. In BMC Atrium Explorer, open a view that contains the CIs you want to
include in the simulation.
b. Select one or more CIs.
c. Click a highlighted CI and select Simulate Impact.
BMC Atrium Impact Simulator opens, with the selected CIs in the CIs for
Simulation section.
3.
BMC Atrium Core 9.0
Page 305 of 2268
Home
3. In the CIs for Simulation section of the BMC Atrium Impact Simulator, select a CI, and then
select an impact state from the list in the Simulated Status check box.
Repeat this step until every row in the CIs for Simulation section has the impact state that
you want to simulate.
4. Click Simulate Impact.
When a large number of related CIs and relationships exist, a pop-up window appears,
showing you the progress of the simulation. The progress display shows you the current
state for the simulation. When the simulation is completed, the progress window closes
automatically. Closing the progress window before the simulation is complete does not
cancel the simulation.
If the results contain over 750 CIs, you are prompted to view the results in table view.
5. View the results of the simulation on the Results in Topology and Results in Table tabs.
6. If you want to save this simulation, complete the following steps:
a. Click Save Simulation.
b. In the Save Simulation dialog box, enter a name for the simulation.
c. Provide a description of the simulation, such as its purpose, and the CIs used in the
simulation.
d. Click OK.
Loading a saved impact simulation

If you have saved an impact simulation, use this procedure to load that simulation and refresh the
simulation results.
To load a saved impact simulation

1. Click the Application Launcher of the BMC Atrium Core Console, and then select Impact
Simulator.
2. Click Load Simulation.
3. In the Saved Simulation dialog box, select a saved simulation.
4. Click Load.
The simulation is loaded with its configuration items (CIs), Simulated States, and the results
from the last time that the simulation was saved.
5. Click Simulate Impact to refresh the results table.
If the impact model has changed, or the relationships between CIs in the data model have
changed, the saved simulation results might not be accurate. Running the simulation again
makes sure that the results section is current.
Comparing impact simulations

You can compare the results of any saved simulation with the simulation currently loaded. You
might also compare the results of a new simulation with an earlier version of that same simulation
to see how the results changed over time.
BMC Atrium Core 9.0
Page 306 of 2268
Home
For example, you might compare the predicted outcomes of two different impact simulations
designed to address the same plan for disaster recovery to see which scenario best suits your
needs.
A comparison between two impact simulations returns the following check boxes for comparison:
Predicted Status
Class
Name
Short Description
To compare impact simulations

1. In BMC Atrium Impact Simulator, either create a new simulation or load a saved simulation.
2. Click Compare Simulation.
3. In the Saved Simulation dialog box, select a saved simulation to compare with the simulation
you selected in step 1.
4. Click Load.
A new window displays the simulation results side by side.

You can save the results of a simulation as a report. For example, you can generate a web report
that lists all of the services that will be impacted if a server were to be taken offline. If needed, you
can then export the report in various formats (for example, Excel or PowerPoint if you create a web
report, or CSV or XML if you create an AR System report).
BMC Atrium Core 9.0
Page 307 of 2268
Home
Before you begin

For more information about creating and running reports, see the Report Console Help available
from the BMC Remedy Mid Tier client or Creating reports.
To run a report of simulation results

1. In BMC Atrium Impact Simulator, either create a new simulation or load a saved simulation.
2. Click the Results in Table tab.
3. Click Report.
4. In the Report Console, select the report that you want to run.
You can click New to create a web or AR System report. You might need to click Refresh
after you create a new report to view it in the list of available reports.
5. Click Run.
The report is generated to the destination you selected (for example, screen, or printer), in
the format you selected.
Running a quick impact simulation

If you want to simply view the impact simulation results of a CI, with status unavailable, you can run
a quick impact simulation of the CI. You can expand the CI to view all related CIs and their
relationships. But the full set of features available in BMC Atrium Impact Simulator is not available
in the streamlined Quick Impact Simulator. For example, you cannot modify the impact status of the
CI (to view the effects if the CI has Slightly Impaired impact status).
BMC Atrium Core 9.0
Page 308 of 2268
Home
Quick Impact Simulator
To run a quick impact simulation

1. In BMC Atrium Explorer, open a view that contains the CIs you want to include in the
simulation.
2. Select a CI in the display pane.
3. Click the down arrow and select Quick Impact Simulator.
The Quick Impact Simulator opens, with the selected CI displayed. By default, the CI is
displayed in the Unavailable predicted impact state.
4. Double-click the CI to view any parent and children CIs.
5. Modify the layout options as needed.
The direction option is enabled (for example, Top to Bottom display of the instances) only if
you select Layered or Hierarchic.
6. Close the Quick Impact Simulator when you are finished.
BMC Atrium Core 9.0
Page 309 of 2268
Home
Opening a related change from BMC Atrium Impact Simulator

After running a simulation, you might determine that the predicted results of a simulated change are
acceptable. If you want to make the changes in the working environment, you can open a change
request directly from BMC Atrium Impact Simulator.
Viewing CI impact from BMC Remedy Change Management
Note
From inside BMC Remedy Change Management, BMC Atrium Impact Simulator exposes
only the features required for the user, thereby simplifying the user experience.
Before you begin

BMC Remedy Change Management must be installed.
To open a related request

1. Run or load an impact simulation.
2. In the Relate to New field, select Change to open a related change request in BMC
Remedy Change Management.
3. Click Relate to New.
A new form in the related application opens, ready for you to submit a request.
BMC Atrium Core 9.0
Page 310 of 2268
Home
Calbro scenario for BMC Atrium Impact Simulator

A specialist at Calbro Services has been assigned to an incident for an accounting program that is
not working. He identifies that the issue is being caused by a faulty database, and determines that
he must update the database and restart the server to bring the program back online.
Before he restarts the server he runs a simulation in BMC Atrium Impact Simulator to determine the
impact of restarting the server on other CIs. For example, there might be other software on the
server unrelated to the issue he is trying to fix.
The results of the simulation show that restarting the server will also impact human resources
software using a different, and currently functional, database on the same computer. With this
knowledge, the specialist presents the issue and solution to the Emergency Change Advisory
Board at Calbro Services.

BMC Atrium Explorer provides many ways to query BMC Atrium Configuration Management
Database (BMC Atrium CMDB) configuration item (CI) and relationship instances.
How queries work
Find tab in BMC Atrium Explorer
Finding CIs using a saved query
Viewing federated data in BMC Atrium Explorer
Building queries in BMC Atrium Explorer
You can start by opening BMC Atrium Explorer and running one of the out-of-the-box queries (for
example, Business Services). The query returns a list of results.
Viewing scoped CI and expanded CIs in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 311 of 2268
Home
All CIs and relationships visible in the display pane are represented in a view (for example, the
Asset or Sandbox views). The following figure illustrates an Application CI that has been expanded
according to its scoped definition. Here the scope expands the Application CI to display only the
Business Service, Software Server, Computer System (defined as Server), or Cluster CIs and their
dependency relationships.You can have several views of different datasets open at the same time
in BMC Atrium Explorer. Though only one view at a time is active, you can switch between the
views.
You now have several options for viewing the CI and relationship data.
Method
Description
For more
information
Expand the
CI to view
underlying
data
Drag a CI into the view and double-click it. The CI expands according to its default setting to
display related CIs.
Expand Default
Create a
filter to hide
data
Filters hide the CI or relationship instances that are visible in the current view (for example,
the IP Endpoint class of the computer system). If CIs are excluded from view, their absence
is indicated by a red dashed lined that indicates a virtual relationship line.
Create a
query to
view data
A graphical map is used to build and display customized queries. In addition to the
out-of-the-box queries installed with BMC Atrium Explorer, you can build simple or
advanced queries to view different patterns of data.
BMC Atrium Core 9.0
BMC Atrium
Explorer
filters
Relationships
Building queries in
BMC Atrium
Explorer
Page 312 of 2268
Home
Method
Description
For more
information
Create a
folded query
to hide data
The results of a folded query are displayed in a Query view. A fold icon and a dashed red
virtual relationship line indicates the presence of hidden CIs.
Creating queries
with folding rules
Views display CI and relationship instances in BMC Atrium Explorer, providing distinct ways to view
the instances in BMC Atrium CMDB. Views are especially useful after you have queried the CI data
that you want to view and then you have filtered out the CIs you want to exclude. For more
information, see BMC Atrium Explorer views.
How queries work

Queries enable you to find instances based on query criteria such as multiple classes, attributes,
relationships, and the grouping of query conditions. For example, you can query for all computer
systems in Houston or London that are running Microsoft Windows 7.
The following topics explain queries so that you can understand how to create and use them:
Query structure of CIs and relationships
Relational-algebra formatting in BMC Atrium Explorer queries
BMC Atrium Explorer queries with parameters
Shared and personal queries in BMC Atrium Explorer
You cannot modify the out-of-the-box queries in the Query list, but you can use them as a template
for creating new queries. The Find section can also include queries that were created and saved by
other users. For more information about creating and saving queries, see BMC Atrium Explorer and
building queries.
Pause your mouse pointer on a query name to display a description of that query. If a saved query
has an arrow next to its name, you can click that arrow to see the variable conditions for that query.
The results list shows all instances that match the query criteria. Drag an instance from the results
list to the display pane to add that instance to the current view. For more information about viewing
instances, see Working with related CIs.
Note
When you create configuration item (CI) and relationship instances, you should use the
recommendations outlined in the Modeling business entities.
The out-of-the-box queries assume that CI and relationship instances have been created
following the best-practice guidelines in Modeling business entities. If you do not follow
these recommendations while creating CI and relationship instances, the out-of-the-box
queries might ignore these instances while displaying the results list.
BMC Atrium Core 9.0
Page 313 of 2268
Home
Query structure of CIs and relationships

Queries can include one or more configuration item (CI) classes and their relationships to other CI
classes.
For example, a query for all computer systems running a particular operating system would include
the BMC_ComputerSystem CI class, the BMC_HostedSystemComponent relationship class, and
the BMC_OperatingSystem CI class.
For each class, you can create one or more query conditions based on the attributes of that class.
For example, a query for computer systems with a particular operating system might include
several conditions for the BMC_ComputerSystem class (for the Name, ShortDescription,
ManufacturerName, and Model attributes) and other conditions for the BMC_OperatingSystem
class (for the ManufacturerName, OSType, and VersionNumber attributes). For more
information, see BMC Atrium Explorer and building queries . The following figure shows the sections
of the Query dialog box.
Query dialog box
When you connect a CI class to another CI class by a relationship class in a query, you can specify
BMC Atrium Core 9.0
Page 314 of 2268
Home
the direction of the relationship. Depending on the CI and relationship classes, the first CI class can
be either the source or destination of the relationship.
Recommendation
When you create an advanced query, use specific relationship classes to make your query more
efficient. Start with a CI class, add a relationship class, and then a second CI class that is
connected to the first CI class by the relationship. For example, you might query for all computer
systems with Windows 7 operating systems by building a query that includes the
BMC_ComputerSystem and BMC_OperatingSystem CI classes, as well as the
BMC_HostedSystemComponents relationship class.
Relational-algebra formatting in BMC Atrium Explorer queries

BMC Atrium Explorer queries use a relational-algebra format based on Structured Query Language
(SQL). For example, in a query for computer systems in Houston or London, the two conditions for
BMC_PhysicalLocation are linked by a Boolean OR operator.
Relational-algebra formatting also enables you to group query conditions. For example, a query for
all computer systems in either Houston or London and with a reconciliation ID. The condition that
queries the BMC_PhysicalLocation class for the City attribute that matches Houston is
grouped with the condition that queries for the City attribute that matches London. That group is
joined by a Boolean AND operator to a condition that queries for CIs that have a reconciliation ID.
These conditions are written in a relational-algebra format as:
(City = "Houston" OR City = "London") AND ReconciliationId != NULL
When you have more than one condition in a query, use the query condition buttons in the Query
dialog box to group and order the conditions according to relational algebra formatting. The
following table describes the query condition buttons.
Query condition buttons
Button
Description
Edit condition
Edits condition in the query.
Remove condition
Removes the selected condition from the query.
For more information about relational algebra in queries, start with Building qualifications and
expressions.
BMC Atrium Core 9.0
Page 315 of 2268
Home
BMC Atrium Explorer queries with parameters

You can provide the ability for users of a saved query to edit the value for one or more conditions
before running the query. This enables you to define multiple conditions as part of a single query.
You and others can quickly edit a portion of the query without creating and saving a new query.
When you create or edit a query, select the check box for any condition to allow users to edit the
value for that condition.
For example, one of the tasks of an IT staff member at Calbro Services is to make sure that all
computers with the Windows 7 operating systems are updated with the latest service packs. (For
more information about how to create such a query, see BMC Atrium Explorer and building queries .
) The IT staff member creates an advanced query to find Calbro Services computer systems and
defines the following conditions for the query:
OSType=MicrosoftWindows 7
ServicePack=<latestServicePackName>
Saved query with multiple conditions
When Microsoft announces the release of a new Windows 7 service pack, such as Windows 7
Service Pack 1, the IT staff member runs the query with the following values set for the query
conditions:
OSType=Microsoft Windows 7
ServicePack != Windows 7 Service Pack 1
BMC Atrium Core 9.0
Page 316 of 2268
Home
The query returns all Windows 7 operating system computers where Windows 7 Service Pack 1*is
not installed. The IT staff member can install Windows 7 Service Pack 1 on the Calbro Services
computer systems that are returned by the query.
You can specify the labels that appear for variable attributes in the Query list. This is helpful when a
query involves multiple classes, and variable conditions from different classes see attributes with
the same name. For example, Name is a common attribute. If you do not specify a label, the
attribute name is used as the label in the Query list.
When you create a query, if you provide a value for a variable condition, that value appears as the
default value for that condition in the navigation pane. If you do not provide a value, no default
value appears.
Variable conditions without values are not included when the query is run. For example, an IT staff
member at Calbro Services has saved a query that searches for Calbro Services computer systems
located in New York City, with a variable parameter for the City attribute. If the IT staff member
runs this query without specifying a city, the query returns all Calbro Services computer systems
that are related to any location. Even if some Calbro Services computer systems are not associated
with a location, the query still returns those configuration items (CIs). However, if the variable
conditions include values, the query returns instances only for which the condition applies.
Conditions that are not selected as variable are always included when the query is run.
Shared and personal queries in BMC Atrium Explorer

When you create a query, you have the option of saving the query, as a Personal Query or Shared
Query, to run later from the Find section. A saved query is stored as an instance of the
BMC_UIComponent form.
You can save a query as one of the following types:
Personal Query If you have the CMDB Data View role, you can create this type of a query
. You can use only personal queries that you created. By default, members with the CMDB
Data View role have access to a shared query.
Shared Query If you have the CMDB Console Admin role, you can create, edit, and
delete shared queries. Access to use a shared query is determined by the
CMDBRowLevelSecurity attribute value for the query's instance on the
BMC_UIComponent form.
For more information about permissions and roles, see Managing permissions in BMC Atrium Core .

Use the Find tab to perform important query functions in BMC Atrium Explorer.
BMC Atrium Core 9.0
Page 317 of 2268
Home
These functions include searching for configuration items (CIs) in a specific dataset, configuring
query options, showing the CI properties, and so on. The Find tab is divided into the following main
areas:
Find tab toolbar
Query list
Query results list
Display pane that shows CIs in a particular view (for example, the Sandbox or the Query
view)
Find tab toolbar

Use the Find tab toolbar to create, copy, modify, or delete queries. You can configure important
query options (for example, the dataset). You can also display or edit CI properties from the Find
toolbar. The following table describes the buttons on the toolbar.
Button or menu
Description
New Query
Creates a new query in the Query Builder. For more information, see Building queries in BMC
Atrium Explorer.
Copy Query
Copies a query from the list. You can rename the query and modify the search conditions.
See Copying a query for more information.
BMC Atrium Core 9.0
Page 318 of 2268
Home
Button or menu
Description
Edit Query
Modifies a query from the list. See Editing a query for more information.
Delete Query
Permanently deletes a query from the list.
Run Query
Runs the query without changing any search conditions. See Building queries in BMC Atrium
Explorer for more information.
Show Results as Query View
Runs a query that uses folding rules to restrict which instances are visible in BMC Atrium
Explorer. For more information, see Creating queries with folding rules.
Note: If no such query is defined, this icon is disabled in the Find tab.
Dataset list
Selects the dataset against which the query is run.
Query Options
Configure options that determine the default behavior of all queries. See Configuring query
options for more information.
Refresh Query
Refreshes results in the query list.
Show Properties
Displays the properties of the CI that was selected from the query list. Also visible in the
Table View.
Edit CI
Lets you edit the CI properties if the CI is in an editable dataset (for example, the Sandbox ).
Otherwise, you must convert the Asset view to a new Sandbox view, perform your edits, and
then run a promotion. See Editing CIs for more information. Also visible in the Table View.
Displays the CI from the query list in its dataset view within the display pane.
BMC Atrium Core 9.0
Page 319 of 2268
Home
Button or menu
Description
Show in View
Compare Instances
Compares instances in BMC Atrium Explorer within a single dataset or from two different
datasets in the display pane. Also visible in the Table View. For more information, see
Comparing CI and relationship instances.
View History
Displays the audit history of an instance. Also visible in the Table View. For more information,
see Viewing instance history in BMC Atrium Explorer.
Configure Columns
Displays check boxes visible in the Table View of the display pane. Add or remove check
boxes as needed.
Create Report
Creates a report (in .csv format) that lists details about the instances selected in the Table
View of the display pane.
To create a report:
1. Click
to select the Table View.
2. Click
to Export Table to CSV.
3. Save the file.
Finding CIs using a saved query

By default, the Query list shows several queries that were installed with BMC Atrium Core. The
following figure shows the out-of-the-box queries that are available after installation. For example,
the sample queries enable you to search for all Computer CIs with a specified operating system, or
all virtual machines.
Note
You cannot modify or delete these out-of-the-box queries. However, you can copy them to
use as templates when creating your own queries.
Queries, variable conditions, and results
BMC Atrium Core 9.0
Page 320 of 2268
Home
After you run a query, the results are displayed in a list. You can copy the query results to BMC
Atrium Explorer display pane.
Note
You can drag a configuration item (CI) from the results list to a view only if the view's
dataset is the same as the query's dataset. If the view's dataset differs from the query's
dataset, a red X appears on the CI when you drag it and the CI is moved back to the
results list. Additionally, the following message appears in the display pane: CI dataset
does not match view dataset
To find CIs by using a saved query

1. Open the Query list.
The Query list can appear in various locations in BMC Atrium Configuration Management
Database (BMC Atrium CMDB) products, including the Find section of BMC Atrium Explorer
and the Add CI dialog box of BMC Atrium Impact Simulator.
2. In the Query list, click Options.
3. In the Dataset list, select the dataset against which the query is run.
4.
BMC Atrium Core 9.0
Page 321 of 2268
Home
4. Click OK.
5. In the Query list, select a query.
6. Perform one of the following actions:
Action
Steps
Run the query without changing conditions.
Click Run for a simple search.
Edit values for query conditions before running the query.
a. Click the arrow by the query name.

b. Select an operator and enter a value for
any condition you want to edit.
c. Click Search for an advanced search.
Configure options that determine the default behavior of all queries. For
more information, see Configuring query options.
Click Options.
All CIs that match the query criteria appear in the results list.
7. (optional) Perform one or more of the following actions for the CIs in the results list:
Action
Step
View properties for a selected CI in the Properties section of the navigation pane.
Click Show
Properties.
Edit some of the attributes for a selected CI.
Click Edit.
Note: You cannot edit CIs in the BMC Asset dataset. You must convert the Asset view to a new
Sandbox view and then perform your edits.
For more information about editing CIs, see Editing CIs and relationships in BMC Atrium Explorer.
Copy or drag one or more selected CIs to a view in the display pane. For more information about
working with CIs in the display pane, see Working with related CIs.
Click Show in
Compare two CIs within a single dataset or from two different datasets. For more information, see
Click Compare
Comparing CI and relationship instances.
Instances.
View audit history of a CI. For more information, see Viewing instance history.
Click View
View.
History.
Creates a report (in .csv format) that lists details about the CIs selected in the Table View of the
display pane.
BMC Atrium Core 9.0
Click Create
report.
Page 322 of 2268
Home
Action
Step
Viewing federated data in BMC Atrium Explorer

Federated data is information about a configuration item (CI) that is stored outside BMC Atrium
CMDB and is linked to CIs in BMC Atrium Configuration Management Database (BMC Atrium
CMDB). BMC Atrium Explorer allows you to retrieve federated instances that are related to a core
CI in the BMC Atrium CMDB.
To view a CI related to federated data
To view federated data in an application launched from the BMC Atrium Explorer
Note
If the BMC Remedy ITSM applications are installed on your system, Open launch in
context menu provides links to federated records (for example, change requests or
incidents) related to the CI selected in the BMC Atrium Explorer display pane.
You can view additional federated data from BMC Atrium Explorer only if an administrator has set
up federation through the Federation Manager. An administrator can configure federated data to be
available in the BMC Atrium Explorer display pane, appearing as instances related to CIs that are
stored in BMC Atrium CMDB. Federated instances of the same federated data class appear as a CI
group. For more information about CI groups, see Instance groups.
The base class for federated data classes is BMC_FederatedBaseElement. When creating a
query that includes federated data and federated relationship classes, you cannot add query
conditions for federated relationship classes. A federated relationship class contains no data; it
exists only to connect a federated data class to a CI class in your data model.
If an administrator has configured a separate application to display federated data, perform the
following procedure to view that federated data.
For high-level information about federation, see Federated data model. For more information about
federated data and federated relationship classes, see Configuring federated data in BMC Atrium
CMDB.
To view a CI related to federated data

1. In BMC Atrium Explorer, query the CI that you want to view.
In the following figure, the saved query was an OR search for Calbro Services computer
system CIs where Model = PowerEdge or Manufacturer = Dell Computer Systems.
BMC Atrium Core 9.0
Page 323 of 2268
1.
Home
Relationship link between CI instance and external data in federated class
2. Drag the CI into the display pane.

3. Double-click the CI.
If you successfully related the source class and the federated destination class, the
federated class is displayed below the CI. The following figure shows that the bank server CI
is related to a federated class.
4. Double-click the federated class.
If you successfully created a federated relationship qualification, the federated CI is
displayed in BMC Atrium Explorer. This federated CI is a static record you cannot modify
it in any way because the database table underlying the federated class is external to BMC
Atrium CMDB and not under its control.
To view federated data in an application launched from the BMC Atrium Explorer
1. Select a CI in the BMC Atrium Explorer display pane.
2. In the toolbar, click Open launch in context menu.
3. Select a launch link to open (for example, View Related Change Requests ).
An application chosen by an administrator launches to display the federated data.
Building queries in BMC Atrium Explorer

For better analysis of your BMC Atrium Configuration Management Database (BMC Atrium CMDB)
data, the Query Builder helps you build topological queries with any pattern possible. In addition to
building simple queries that walk a particular path, you can build pattern queries to create service
models. You can then link logical configuration items (CIs), such as technical services) to
corresponding applications or to servers that support the service. You can also specify count
restrictions in the criteria for a relationship. This functionality allows you to create queries that return
, for example, only servers with three or more hard drives.
BMC Atrium Core 9.0
Page 324 of 2268
Home
Creating a simple query in BMC Atrium Explorer

Creating an advanced query in BMC Atrium Explorer
Creating queries with folding rules in BMC Atrium Explorer
Editing or copying a query in BMC Atrium Explorer
Configuring query options in BMC Atrium Explorer
Using BMC Remedy ITSM or BMC Remedy AR System class forms to find CIs
Using the results returned by an advanced query, for example, all the applications and services that
comprise the BMC IT Service Management business service at Calbro Services you can analyze
your current service models and create new logical entities.
Query Builder
You use the Query Builder to create new categories and new queries for configuration item (CI) and
relationship instances. It helps you determine which CIs to display (or expand) in BMC Atrium
Explorer.
When you drag an item from the result list to the Query Builder canvas, the graph expands
according to the items in the query.
You can use the query-by-path capability to search for any simple or detailed pattern
containing multiple relationships.
BMC Atrium Core 9.0
Page 325 of 2268
Home
You can use the lanes in the Query Builder to construct complex searches. The lanes
determine what level each item is displayed in.
Note
The lanes used in the Query Builder only affect how items are arranged in query
views. In regular instance views, the items are arranged according to the selected
layout setting. The Layered layout arranges the items by levels pre-defined for
each type.
The top lane in the query contains one or more items that are required in the query results
are only returned from the query if it includes instances of that item. The other lanes are
optional.
You can include multiple items in multiple lanes. Based on the relationships that you draw
between the items, the items in the various lanes are relative to each other:
Items in the second lane are relative to the items in the top lane
Items in the third lane are relative to items in the second and top lanes, and so forth.
Items in the same lane cannot be joined together with a relationship.
When specifying the relationships between various items, you can specify that items
in lower lanes must be returned in the query results. If the lower item must be present
in each result, you restrict the CIs displayed in the query results list.
You can include optional items in the query that do not restrict the results, but add more
query items within the visualization.
You can specify count restrictions in the criteria for a relationship. This functionality restricts
the CIs displayed in the query results list and allows you to create queries that return, for
example, only servers with three or more hard drives.
You can build a query that circles back in a loop to the top item. For example, you might
want your query to return all software servers that listen on a certain IP address, and also
return the computer system. Only required links are supported in a loop.
Note
You cannot query currency, diary, and attachment attributes.
You can build a query with folding rules that hide less important CIs. You can later unfold
these CIs in BMC Atrium Explorer as needed.
BMC Atrium Core 9.0
Page 326 of 2268
Home
Creating a simple query in BMC Atrium Explorer

The following example shows how to create a simple query that searches for all computers at
Calbro Services. This query includes a condition that limits the search to computers that have
Calbro in their name. Finally, it creates a new category for Calbro Services in the query list.
Before you begin
To create a simple query using the Query Builder
To test the results of your simple query
Before you begin

As test data, create several computer system configuration items (CIs) and name them
appropriately (for example, Calbro_ComputerSystem_SJ1). When you are finished, promote the
CIs to the BMC Asset dataset.
To create a simple query using the Query Builder

1. Open BMC Atrium Explorer.
2. Click the Find tab.
3. In the Find tab toolbar, click New.
4. In the General Information tab, enter the following:
a. In the Query Name field, type a new name for the query (for example, Computer
System CIs ).
b. (optional) In the Category field, type a category for the query. If you create a new
category (for example, Calbro Services), it is then displayed in the Query list.
c. (optional) In the Description field, type a description of the query.
d. Specify if the query is shared or personal. For more information, see Shared and
personal queries.
Defining General Information in Query Builder
5. Click the Editor tab.
6.
BMC Atrium Core 9.0
Page 327 of 2268
Home
6. (optional) Select the base class to use with the query.

By default, the BMC_BaseElement classes in the BMC Common Data Model are displayed (
the following figure). You can click the Select base class down arrow to view a different set
of classes. For example, select BMC_FederatedBaseElement to view any federated
classes that exist in your BMC Atrium Configuration Management Database (BMC Atrium
CMDB) data model. The class list refreshes to show the subclasses of that base class.
For easier viewing, you can select a Tile, List, or Tree view of the subclasses.
7. (optional) To filter the list of classes that are displayed, type a letter, word, or phrase in the
Locate field.
If you type com in the Locate field, the list shrinks and only classes with com in their name
are displayed (for example, Communication or Computer).
8. Drag and drop a class from the list to the Drop additional classes here lane in the Query
panel.
In this example, you would select the Computer System class.
Creating queries
The first object (Computer System) that you drag into the top lane of the Query builder is
special in several different ways. It becomes the top of the query and you cannot place any
items above it. This object then is a required element in the query results are only
returned from the query if it includes instances of that object.
Note
BMC Atrium Core 9.0
Page 328 of 2268
Home
You can add multiple objects to the top lane as long as the items in the graph are
all connected. For additional information about adding objects and relationships
into the Query Builder, see Creating an advanced query.
In Creating an advanced query, you add additional objects and relationships into the Query
Builder.
If necessary, select a class in the Query panel and then click Delete to remove it.
9. To edit the class conditions, double-click the class (or select the class and then click the edit
button in the toolbar).
10. In the Conditions dialog box, use the fields and drop-down lists to create one or more
conditions for that class. These conditions appear in the Find tab after you create the query.
Creating query conditions for classes
a. Click the check box to enable the query conditions.

b. Type a name for the condition, such as the label of the attribute (for example, OS
Version or Manufacturer ).
c. Select an attribute (for example, VersionNumber or ManufacturerName ).
d. Select an operator (for example, LIKE or !=).
e. Type a value (for example, Microsoft ).
f. If you want to add another condition, select AND or OR. An additional row then
appears in the Conditions dialog box.
g. If you have multiple conditions, use the move up or move down buttons to arrange
and group conditions to structure the query according to relational algebra formatting.
For example, you could create a class condition that queries only Dell Computers in
the San Jose location (ManufacturerName LIKE "Dell" AND Domain LIKE "
San Jose"). A yellow diamond then appears next to the class, indicating that the
class uses a condition.
h.
BMC Atrium Core 9.0
Page 329 of 2268
Home
h. Click Save.
In our simple query, create a query condition that searches for all computer systems
that include Calbro in their name Name LIKE Calbro%.
For more information about query structure, see Query structure.
11. Click the Viewing Options tab to select the CI attributes for display in the query output table.
Specifying CI attributes for display in the query
a. From the Configuration Items list, select a class (for example, Computer System).
b. From the Attributes Selected For Display list, select all attributes to display in the
query output table.
c. Select attributes from all the Configuration Item classes in the list.
12. Click Save to close the Query dialog box.
The new category and your new query appears in the Query list (see the following figure).
To test the results of your simple query

1. In the Find tab, review the categories in the query list.
Calbro Services now appears in the list as a new category.
2. Click the Calbro Services category.
3. Select the Computer System CIs query and then click Search.
This simple query returns all computer systems that include Calbro in their name.
4. Drag one or more CIs into the display pane to review them.
New category and query with results returned
BMC Atrium Core 9.0
Page 330 of 2268
4.
Home
Creating an advanced query in BMC Atrium Explorer

The following example shows how to create an advanced topological query that searches for all
Calbro Services computers that have a required component relationship to disk drives. It assumes
you already understand how to create a simple query and use conditions in your query.
Before you begin
To create an advanced query
To test the results of your advanced query
Before you begin

As test data, create one DiskDrive configuration item (CI), name it Calbro_DiskDrive_1, and then
create a Component relationship with one of the Calbro Computer Systems. When you are finished,
promote your changes to the BMC Asset dataset.
To create an advanced query

1. Edit the simple query that you created previously.
(optional ) In the General Information tab, change the name of the query to Computer
System and Diskdrive CIs.
3. Drag and drop the Diskdrive class from the Base Element CIs list to the Drop additional
classes here lanes in the Query panel.
Your advanced query can include multiple objects in multiple lanes. In this example,
Computer System in the top lane is the required object in the query. By default, each item
except the top item is optional.

Creating advanced queries
BMC Atrium Core 9.0
Page 331 of 2268
Home
4. Create a relationship between CI classes in your query.

For example, create a Component relationship between the Computer System and the Disk
Drive CIs. Without any additional restrictions, your query would return all Computer Systems,
even Computer System instances that do not have any Diskdrives. When the results are
returned, you see a list of Computer System instances. However, if you view and expand the
CI in the BMC Atrium Explorer display pane, you would see all the items that are included in
the query, not just the top one.
You must join all items you put in an advanced query by relationships to other items, and
ultimately to the top item. You cannot join items in the same horizontal lane directly with a
relationship. You should put additional connected items in a lower lane.
To create a relationship:
a. In the Query panel, select a class in one lane and drag your cursor to a class in
another lane.
The Relationship dialog box appears. You now can select the relationship type
between the top and lower items.
Specifying relationship between source and destination classes
BMC Atrium Core 9.0
Page 332 of 2268
Home
b. From the Type menu, specify the relationship type (for example, Component).
By default, the All Related relationship type is selected. This item includes all possible
relationships in the query. But you can narrow the relationship type as needed.
Depending on the type you select, other options might not be available. For example,
if you select Has Impact, you can specify cardinality but not conditions because the
Conditions tab is disabled.
Additional relationship options
c. (optional) Specify the direction of the relationship.

Typically, the top item in the query is the source and the lower item is the destination.
d. (optional) Select the Required check box.
By specifying that the lower item is required in each result, you restrict the CIs
displayed in the query results list. For example, if Diskdrive is required, no Computer
System instances are returned in the query that do not have any Diskdrives. For a
relationship that joins the top item with a lower item, checking the Required check
box means that the lower item is required in each result. When the query is run, no
instances of the top item are returned in the results unless there is also at least one
instance of the lower one.
e. (optional) In the Required check box, specify the count restrictions in the criteria for a
relationship.
BMC Atrium Core 9.0
Page 333 of 2268
e.
Home
By default, cardinality is not required. If an item is optional in the query

definition, then empty parameters have no effect.
If you select Required for the relationship, you can also set conditions on the
number of related items that must be present in order for the result to be
returned.
These numbers do not only restrict how many items are shown in the result.
Consider a relationship that connected the top item to another item in a lower
layer (for example, a Computer System related to a Diskdrive). The numbers
specify a minimum and a maximum range of the number of lower items
connected to the top item.
Types of cardinality
Cardinality
type
Explanation
Unrestricted
(1 to *)
One instance of the top class is related to one or more instances of another class. This
is the system default. For example, you query a computer system related to many disk
drives. Your query returns computer systems with at least one disk drive.
Restricted (
2 to *)
If you specify a minimum (2...*), one instance of a class is related to two or more
instance of another class. Your query returns only those computer systems that have
two or more disk drives.
Minimum
and
maximum (
2...4)
If you specify a minimum and maximum (2...4), one instance of the class is related to at
least two instances and up to four instances of another class. Your query returns only
computer systems that have between two and four hard drives.
One-to-one
For a one-to-one cardinality restriction, you would select "1...1," so that the minimum
and maximum are one--one instance of a class is related to a single instance of another
class. For example, you query one computer system to one disk drive. Your query
returns only those computer systems that have one and only one disk drive.
In our example, the Diskdrive is a required element in the relationship. In

addition, the default Unrestricted setting is used Computer System is the top
item, and the numerical condition is applied to Diskdrive, the lower item. As a
result, the query returns only Computer Systems that are related to Diskdrives.
To add additional complexity to the query, you could apply the same logic to a
third item (CDROM Drive) connected to the second item (Diskdrive).
Diskdrive is not the top item in the query, but is now considered the top item for
purpose of the example (because it is directly connected to Computer System,
the top item). The numerical restriction on the new relationship (between the
second and third items) is a condition on how many instances of that third item
are connected to each instance of the higher item. Depending on the
cardinality requirements, you could construct a query that returns all computer
systems that have at least one disk drive and at least one CDROM drive.
An advanced query can include multiple items and relationships in multiple
BMC Atrium Core 9.0
Page 334 of 2268
Home
lanes.
Finally, advanced queries can circle back in a loop to the item. But only
required links are supported in a loop. If you complete the loop in the query,
that final item is required. The query does not return any CIs on the attached
end without that last connection.
Multiple items in query
f. (optional) In the Conditions tab, use the drop-down lists to create relationship
conditions.
Note
You do not need to add conditions to most relationships.
g. Click Save.
5. Repeat these steps until you have added all of the classes, conditions, and relationships
necessary for the advanced query.
Your new advanced query appears in the Query list, under the Calbro Services category.
To test the results of your advanced query

1. Under the Calbro Services category, select the new Computer System and Diskdrive CIs
query.
2.
BMC Atrium Core 9.0
Page 335 of 2268
Home
2. Click Search.
This advanced query returns only the one Computer System that was related to the
Diskdrive. Unlike the simple query you created earlier, none of the other Computer Systems
are returned in the query.
When you drag the Computer System CI into the display pane, the CI automatically expands
and you see that the Computer System CI is related to a Diskdrive CI.
New advanced query with results returned
Creating queries with folding rules in BMC Atrium Explorer

When you run a query in BMC Atrium Explorer for example, you expand a business service
too much data can clutter your view. You might want to see only the direct links between servers
and not the IP Endpoint configuration items (CIs). To hide CIs returned from a query, you can
create a query that uses "folding" rules to hide instances that are currently visible.
Before you begin
To create queries with folding rules
To test the results of your folded query
Creating a query with nested folding rules
To test the results of your nested folding query
Query view that uses folding rules
BMC Atrium Core 9.0
Page 336 of 2268
Home
When you run the query that uses folding rules, the Query view displays the graphical results in
BMC Atrium Explorer. The Query view is a restricted view of the CIs, limited to the data returned
from the query. The CIs returned in the Query view are a static snapshot of the data. As a result,
the types of operations that you are allowed to perform are limited:
You can expand the parents and children of a CI, but the data is always displayed in a
popup. You cannot add parent or children CIs back to the Query view.
If you are querying any dataset other than the BMC Asset dataset, you can edit the CIs
returned. However, you cannot create or delete CIs or relationships in the Query view.
You cannot save a Query view.
The following example shows how to create a query that displays Calbro Computer CIs that are
related to operating system CIs in the Query view but folds the CD ROM and Disk Drive CIs.
Before you begin

As test data, create the following CIs:
Calbro_CDROMDrive_1
Calbro_OperatingSystem_1
Create Component relationships with the Calbro Computer System CI that you earlier related to the
Calbro_DiskDrive_1 CI. When you are finished, promote your changes to the BMC Asset dataset.
BMC Atrium Core 9.0
Page 337 of 2268
Home
To create queries with folding rules

1. Edit the advanced query that you created previously.
(optional ) In the General Information tab, change the name of the query to Folded CIs.
3. Drag the CDROM Drive and Operating System classes into the lane next to the Disk Drive
class in the query.
4. Create Component relationships with the Calbro Computer System CI.
5. Click the Viewing Options tab to select the CI attributes for display in the query output table
.
6. Click the Folding tab.
The following figure displays a preview of your query. If you run this query without
modification and you opened the Computer System CI inside the Query view, all three
related CIs are displayed.
Query Preview
7. In the left pane, click the Computer System class.

The Computer System icon now displays a folder that indicates the three related classes
have been folded in the query. The Query Preview pane shows that your query, if
unmodified, displays only Computer System CIs. The other related CIs are not displayed in
the Query view.
8.
BMC Atrium Core 9.0
Page 338 of 2268
Home
8. In the left pane, click the Operating System class.

As shown in the following figure, the Query Preview pane now shows that your query
displays Computer System CIs that are related to Operating System CIs. The other CIs are
folded into the Computer System CI.
Creating query with folding rules
To test the results of your folded query

1. Under the Calbro Services category, select the modified Folded CIs query.
2. Click Search.
The CI automatically expands and you see that the Computer System CI is related to the
other three CIs.
4. To test the folded query, click Show Results as Query View.
5. Click Search.
The results are returned in the Query view (as shown in the following figure). Query view is a
split-pane view with result rows listed on the left and a topology canvas on the right. You
select rows in the list to show their graphs on the canvas.
6. (optional ) Use the accordion slider bar to resize the results list and the Query view.
7.
BMC Atrium Core 9.0
Page 339 of 2268
Home
7. Click the Computer System CI in the results list.

Only the Computer System CI and the Operating System CI are displayed in the Query view.
The yellow folder icon is a visual indication that one or more CIs have been folded into the
Computer System CI. If needed, you can switch between multiple views.
Folded query displayed in the Query view
8. In the Query view, perform one of the following actions:

Action
Step
Select one or more CIs

from the results list
Unfold or fold the
hidden CIs
Click Select All to display all the CIs from the list.
Press the Ctrl key and then click another CI in the results list to display it.
a. Select the CI.
b. Click the down arrow.
c. Select Unfold. The hidden CIs are displayed.
d. Click the down arrow on the original CI and then select Fold to hide the CIs. The hidden
CIs are no longer displayed.
Edit CIs from the Query

view
a.
b.
c.
d.
e.
Set the query options to the Sandbox or BMC Sample dataset.

Search for the CI.
Select a row to display the CI in the Query view.
Select the CI.
Click the down arrow.
f. Select Edit or QuickEdit.

View the children and
parents of a CI in a
display-only popup
BMC Atrium Core 9.0
a. Double-click the CI. The children and parent CIs are displayed according to their
relative layer in a popup. You can also click the down arrow on the CI and then select
one of the Expand options (for example, Expand Both).
b. Click the close icon to close the popup. Because the CI data that is returned is static,
you cannot add the CIs back into the Query view.
Page 340 of 2268
Home
Creating a query with nested folding rules

Your query can include nested folds. You can nest folded CIs inside other folded CIs. For example,
the sample query that follows folds the Computer System and Software Server classes inside the
query. The benefit is that the returned items are hidden if they are folded, and you have a more
focused view with which to view the returned results.
Before you begin

Create a sample service model (for example, select Business Service > Application >
Application Infrastructure > Software Server > Computer System ). When you are finished,
promote your changes to the BMC Asset dataset.
To create a query with nested folding rules

1. Create a new query.
2. Click the Editor tab and drag the CI classes into their appropriate lanes.
Adding classes to the query
3. Create relationships between the CI classes (for example, Has Impact).

4. Click the Viewing Options tab.
5. Click the Folding tab.
6. Build the nested folds:
a.
BMC Atrium Core 9.0
Page 341 of 2268
6.
Home
a. Create the inner fold by clicking a class (for example, Software Server).
This action folds the Computer System class (indicated by the light blue box) under
the Software Server class (indicated by the folder in the dark blue box). If you ran this
query without further modifications, Computer System CIs are not displayed because
they are folded (as shown in the Query Preview pane).
b. Click outside the object tree.
c. Create the outer fold by clicking another class (for example, Application Infrastructure)
.
The left pane shows that you nested a fold inside a fold:
Software Server is folded under Application Infrastructure
Computer System is folded under Application
The Query Preview pane shows that your query displays only Business Service
, Application, and Application Infrastructure CIs.
Building the nested fold
To test the results of your nested folding query

1. Select the nested folding query.
2. Click Show Results as Query View.
3. Click Search.
The results are returned in the Query view.
4.
BMC Atrium Core 9.0
Page 342 of 2268
Home
4. Click the CI in the results list.

The Business Service, Application, and Application Infrastructure CIs are displayed in the
Query view. The yellow folder icon on the Application Infrastructure CI is a visual indication
that one or more CIs are included in the folds.
5. Click the Application Infrastructure CI and then select Unfold.
The Software Server CI is displayed. It also displays a yellow folder icon.
6. Click the Software Server CI and then select Unfold.
The Computer System CI is displayed.
Query with a nested fold
Note
You cannot save a Query view. The main value of a Query view is that it is a
restricted view of the CIs, a static snapshot limited to the data returned from the
query.
Editing or copying a query in BMC Atrium Explorer

After creating a query, you can perform the following changes to it:
Modify it to change the conditions defined in the query or run the query on different
configuration item (CI) and relationship classes.
Note
BMC Atrium Core 9.0
Page 343 of 2268
Home
You cannot modify out-of-the-box queries. You can only edit queries that you have
created.
Create a copy of the query and run it on different CI and relationship classes. You can create
a copy of an out-of-the-box query and any queries that you have created.
To edit a query
2. In the Query list, click Edit.
3. Modify the query information and criteria as required.
For more information, see BMC Atrium Explorer and building queries .
4. Click Save.
To copy a query
The Query list can appear in various locations in BMC Atrium CMDB products, including the
Find section of BMC Atrium Explorer and the Add CI dialog box of BMC Atrium Impact
Simulator.
2. In the Query list, click Copy.
3. In the QueryName field, type a new name for the query.
4. (optional ) In the Category field, type a category for the query. If you create a new category,
it is displayed in the Query list.
5. (optional ) In the Description field, type a description of the query.
6. Modify the query information and criteria as required.
For more information, see BMC Atrium Explorer and building queries .
7. Click Save.
Configuring query options in BMC Atrium Explorer

You can configure options that determine the default behavior of all queries.
Note
If your query returns unexpected results, you might be using the wrong dataset. Check the
Dataset option to make sure you are using the correct dataset.
BMC Atrium Core 9.0
Page 344 of 2268
Home
To configure query options

3. In the Edit Query Options dialog box, configure the following options:
Dataset The dataset against which queries are run.
Note
The selected dataset is not saved as part of query, but it allows you to
preview the query results before saving the query.
Show Deleted Items Whether instances that are marked for deletion are returned
in query results.
Retrieve results up to The maximum number of instances returned in query
results. If the number is very large, BMC Atrium CMDB might still retrieve a smaller
number of entries to optimize performance and reliability.
4. Click OK.
Using BMC Remedy ITSM or BMC Remedy AR System class forms to find CIs
An alternative to using queries is using BMC Remedy IT Service Management (BMC Remedy ITSM
) or BMC Remedy AR System class forms. This method lets you find configuration items (CIs) of
the class whose form you open and instances of its subclasses. This alternative is available for all
instances present in a view.
To use BMC Remedy ITSM or BMC Remedy AR System class forms to find CIs
1. In a BMC Atrium Explorer view, click an instance of the class you want to search and select
Edit.
If the BMC Remedy ITSM applications are installed (7.6.03 or later), BMC Atrium
Explorer opens the Asset view of the instance. For example, if you edit a computer
system CI, the Computer System form (AST:ComputerSystem) is displayed.
Otherwise, BMC Atrium Explorer opens the instance in its class form. For example, if
you edit a computer system CI, the BMC.CORE:BMC_ComputerSystem class form is
displayed.
Note
BMC Atrium Core 9.0
Page 345 of 2268
Home
BMC Asset Management does not have forms for all the classes in the CDM
. If no Asset view of the instance exists, BMC Atrium Explorer opens the
instance in its class form.
2. Click New Search to enable the Search mode of the form.

3. (optional) Enter the search criteria in the form fields, in the advanced search bar, or a
combination of both.
4. Click Search.
The form displays the instances in a results list.
Note
Another method is available to you if your BMC Remedy AR System administrator
has configured the AR System Object List in the BMC Remedy Mid Tier. By
opening the Object List with the following URL, all the BMC Remedy AR System
forms that you are permitted to access are displayed: http://<midTierServer>:<
port>/arsys/forms. For more information, see the Using the Object List in the BMC
Remedy AR System Online Documentation.
Working with CIs and relationships

The following topics explain how to use BMC Atrium Explorer to view and create configuration item
(CI) and relationship instances, and how to view instance history, related CIs, and federated data:
Creating CIs in BMC Atrium Explorer
Creating relationships between CIs
Deleting CIs in BMC Atrium Explorer
Editing CIs and relationships in BMC Atrium Explorer
Working with related CIs
Working with CIs and relationships in a popup
Viewing filtered CIs that are part of a virtual relationship in a popup
Comparing CI and relationship instances in BMC Atrium Explorer
Viewing instance history in BMC Atrium Explorer
Instance groups
BMC Atrium Explorer views
Sandbox views and datasets
Promoting CIs and relationships from a Sandbox dataset
BMC Atrium Explorer layout controls
Creating, copying, or deleting views
Saving a view as an image
BMC Atrium Explorer filters
BMC Atrium Core 9.0
Page 346 of 2268
Home
Using filters to restrict which instances are displayed

Viewing business service CI information by using BMC Atrium Service Context
Creating CIs in BMC Atrium Explorer

In BMC Atrium Configuration Management Database (BMC Atrium CMDB), most configuration
items (CIs) are created by discovery applications, such as BMC Atrium Discovery and Dependency
Mapping. However, you can use BMC Atrium Explorer to create CIs manually.
Recommendations
Before you begin
To create a CI
For example, you might have installed a new computer system, and you do not want to wait until
the next scheduled discovery process to include that CI in BMC Atrium CMDB.
Note
You cannot directly create CIs in the BMC Asset dataset, which is reserved for production
use. To add new CIs in the BMC Asset dataset, you must create the CIs in your
Sandbox dataset and promote them. Remember that Promote Sandbox Changes works
only with the Sandbox dataset.
Recommendations
If you manually create CIs in the CMDB, remember to populate key attributes with appropriate
values so that the CI can be identified against discovery data. Define conventions for manually
creating CIs, including the classes to populate, the attributes to populate, and the format of attribute
values.
For example, your company's conventions for manually creating CIs might include the following:
Calbro only manually creates Computer System CIs. Calbro never manually creates CIs for
components such as Operating System or Diskdrive.
Manually-created Computer System CIs must populate the HostName and Domain, or they
must populate the Serial Number as configured on the Computer System.
Before you begin

Before you create an instance, you must know both the name of the class that you are instantiating
and the namespace in which it resides. The classes provided with BMC Atrium CMDB in the
Common Data Model (such as BMC_ComputerSystem ) reside in the BMC.CORE namespace.
Classes provided with other integrating BMC products reside in other namespaces, as should the
classes that you create.
BMC Atrium Core 9.0
Page 347 of 2268
Home
If you do not know the namespace for the class that you are instantiating, contact a BMC Atrium
CMDB administrator. For more information about classes, see the BMC Atrium CMDB Data Model
Help.
Note
You must be a member of a group with either the CMDB Data Change role or the CMDB
Data Change All role to create instances in BMC Atrium CMDB. For more information
about roles, see BMC Atrium Core permission roles within applications .
To create a CI
1. In BMC Atrium Explorer, open a new or existing view for an editable dataset (for example,
the Sandbox).
Note
You cannot directly create a CI in the BMC ASSET view. When you drag a CI class
to a BMC Asset view, you are prompted to convert the view to a Sandbox view.
Follow the instructions in the dialog box to create the CI in an open Sandbox view.
2. From the Classes section of the navigation pane, drag a CI class to the display pane.
A new CI of the selected type is created in the Sandbox dataset (indicated by the star icon).
Note
When you drag a CI class to a new view, the CI is created and its name is a
combination of the class name and the number one. The number is incremented by
one for each additional CI that is created from the same class. However, if you
close BMC Atrium Explorer, reopen it, open the same view, and create another CI
of the same class, the third CI of this class is created and its name is a combination
of the class name and the number one. The numbering is reset when you close
and reopen the BMC Atrium Explorer. For example, if you drag the
BMC_ComputerSystem class to a new view, the first CI is created with
BMC_ComputerSystem_1 as its name. When you create a second CI of the
BMC_ComputerSystem class, the second CI is created with
BMC_ComputerSystem_2 as its name. Now, if you close BMC Atrium Explorer,
reopen it, open the same view, and create another CI of the
BMC_ComputerSystem class, the third CI is created with BMC_ComputerSystem
_1 as its name.
BMC Atrium Core 9.0
Page 348 of 2268
Home
3. Click the icon representing the CI, and select Edit.

If the BMC Remedy ITSM applications are installed (7.6.03 or later), BMC Atrium
Explorer opens the Asset view of the instance. For example, if you edit a computer
system CI, the Computer System form (AST:ComputerSystem) is displayed.
Otherwise, BMC Atrium Explorer opens the instance in its class form. For example, if
you edit a computer system CI, the BMC.CORE:BMC_ComputerSystem class form is
displayed.
Note
BMC Asset Management does not have forms for all the classes in the CDM
. If no Asset view of the instance exists, BMC Atrium Explorer opens the
instance in its class form.
4. Specify the following required attributes:

Name
The name of the instance.
Short Description
A description of the instance.
Warning
Do not edit values for the InstanceId and ReconciliationIdentity
attributes. BMC Atrium CMDB creates values for these attributes automatically
when you save the instance, and workflow requires that these values remain
unchanged.
5. (optional) Specify access control for this instance by using the following attributes:
CMDBRowLevelSecurity
The groups and roles that have permission to view this instance.
CMDBWriteSecurity
The groups and roles that have permission to modify or delete this instance.
For more information about permissions in BMC Atrium CMDB, see Managing permissions
in BMC Atrium Core.
6. (optional) Specify additional attribute values for the instance in the General, Specifications,
or Custom tabs.
For more information about the class attributes, see the BMC Atrium CMDB Data Model
Help.
Note
BMC Atrium Core 9.0
Page 349 of 2268
Home
If you assign the Yes value to the isVirtual attribute in the Custom tab of a CI
created from a BMC class, BMC Atrium Explorer displays the CI's icon enclosed in
a brown rectangle. The brown rectangle enables you to quickly identify CIs running
as virtual machines. If you add the isVirtual attribute to a CI of a custom class,
you can add the isVirtual attribute to the list of tooltip attributes for that class.
For more information about defining tooltips for a class, see Defining BMC Atrium
Explorer tooltips for a class.
7. Click Save.
8. Click Close.
Because no corresponding CI exists in the BMC Asset dataset until after you promote the
new CI, the star icon next to the CI does not change to a pencil icon in the Sandbox view.
9. If you are finished working in the Sandbox dataset and are ready to promote changes to the
BMC Asset dataset, click Promote Sandbox Changes in the toolbar.
For more information, see Promoting instances.
Creating relationships between CIs

In BMC Atrium Configuration Management Database (BMC Atrium CMDB), most relationships
between configuration items (CIs) are created in bulk discovery applications, such as BMC Atrium
Discovery and Dependency Mapping. However, you can use the BMC Atrium Explorer to create
relationships manually between CIs.
Before you begin
To create a relationship
For example, you might enhance your service model by relating business service CIs to physical
CIs. You might also create relationships between CIs that were created manually through the BMC
Atrium Explorer.
Note
You cannot directly create relationships in the BMC Asset dataset, which is reserved for
production use. To create a relationship in the BMC Asset dataset, edit the source and
destination CIs in the Sandbox dataset and then create a relationship between them in
the Sandbox dataset. Then, click Promote Sandbox Changes to merge the changes
into the BMC Asset dataset.
You can create an impact relationship between two CI instances in BMC Atrium Explorer. In an
impact relationship, if the source CI (for example, a database server or computer CI that supports
the technical service) is unavailable, then the technical service is impacted in some way.
BMC Atrium Core 9.0
Page 350 of 2268
Home
Creating impact relationships between CIs
Before you begin

You must be a member of a group with either the CMDB Data Change role or the CMDB
Data Change All role to create instances in BMC Atrium CMDB. For more information about
roles, see BMC Atrium Core permission roles within applications .
Decide on the following points:
Which relationship class you want to use to relate the two CIs. The classes available
to you depend on the class of each CI.
Which CI is the source member and which is the destination member of the
relationship.
For information about which CI classes can be related by a relationship class and
which is the source or destination member, see the More Information tab of the Class
Manager component of BMC Atrium CMDB, which shows recommended relationship
classes and all possible relationship classes for a CI class. For more information
about Class Manager, see Opening Class Manager and viewing classes . For more
information about classes, see BMC Atrium CMDB Data Model Help.
Note
BMC Atrium Core 9.0
Page 351 of 2268
Home
When you create CI and relationship instances, follow the recommendations outlined in
Modeling business entities. The out-of-the-box queries assume that CI and relationship
instances have been created following the guidelines in Modeling business entities. If you
do not follow these recommendations while creating CI and relationship instances, the
out-of-the-box queries might ignore these instances while displaying the results list.
To create a relationship
1. In BMC Atrium Explorer, open a new or existing view for an editable dataset.
2. In the toolbar, click Topology View to make sure that the view is displayed as a topology,
and not as a table.
3. Add the CIs that you want to relate to the view.
See Working with related CIs for more information.
4. In the toolbar, click Create Relationship Mode to turn on the create relationship mode.
5. Select a relationship type from the Choose Relationship Type list (for example, Component
).
Note
To create a generic relationship that has impact, you can select Impact
Relationship as a "short cut" relationship type. The Impact Relationship type sets
the HasImpact attribute to Yes in the BMC_BaseRelationship class. For more
information, see the following table.
6. In the display pane, click and drag the relationship line from the source CI to the destination
CI, and then release the mouse button.
A relationship instance is created between the CIs.
Creating a new relationship with two CIs
BMC Atrium Core 9.0
Page 352 of 2268
Home
The star icon displayed between the CIs indicates that you created a new Component
relationship in the Sandbox dataset. In addition, the purple arrow icon indicates the direction
of the impact relationship from the source CI to the destination CI.
Note
The two CIs shown in the following figure do not display a special status icon (for
example, the pencil icon). This is a visual indication to you that they exist in the
Sandbox view only as copies of corresponding CIs from the BMC Asset dataset;
they do not exist in the Sandbox dataset. For more information, see Sandbox
views and datasets.
7. Click Create Relationship Mode to turn off the create relationship mode.
8. Right-click the relationship line, and then select Edit.
The selected class form appears in a new window. For example, if you are creating an
instance of the BMC.CORE:BMC_Component class, the BMC.CORE:BMC_Component form
appears.
9. On the Relationship tab of the class form, verify the information for the source and
destination CIs.
10.
BMC Atrium Core 9.0
Page 353 of 2268
Home
10. Specify the following attributes (as needed):

Relationship attributes
Attribute
Description
Name
The name of the new instance. When populating the Name attribute of relationships, use
only the values in the Relationship Normalization table of Mapping Your Data to BMC
Atrium CMDB Classes. These values make your data compatible with future versions of
BMC products and future products will enforce these values. For example, when you are
creating a Dependency relationship where a Business Service is dependent on another CI,
the name of the relationship should be SERVICEDELIVEREDBY.
The groups and roles that have permission to view this instance. For more information
(General tab)
about permissions, see Managing permissions in BMC Atrium Core.
CMDBWriteSecurity (
The groups and roles that have permission to modify or delete this instance. For more
information about permissions, see Managing permissions in BMC Atrium Core.
General tab)
HasImpact (Custom tab)
Yes specifies that the relationship instance has impact characteristics that are defined and
active.
ImpactDirection (
Specifies the Impact direction. For impact relationship instances, the default value is
Custom tab)
Source-Destination. You can set the attribute to:

Source-Destination
Destination-Source
Other
Unknown
Warning
Do not edit values for the InstanceId and ReconciliationIdentity
attributes. BMC Atrium CMDB creates values for these attributes automatically
when you save the instance, and workflow requires that these values remain
unchanged.
11. (optional) Specify additional details for the instance in the General, Specifications, or
Custom tabs.
For example, you can increase the ImpactWeight to 400, so that you can model the impact
to the business service if a particular provider is unavailable. For more information about
manually creating impact models of services, see Manually creating CI impact models of
services.
For more information about the class attributes, see the BMC Atrium CMDB Data Model
Help.
12. Click Save.
13. Click Close.
14.
BMC Atrium Core 9.0
Page 354 of 2268
Home
14. Refresh the view in BMC Atrium Explorer.

Because no corresponding relationship exists in the BMC Asset dataset until after you
promote the new relationship, the star icon next to the relationship does not change to a
pencil icon in the Sandbox view.
If you set the HasImpact and ImpactDirection attributes, the impact relationship and its
direction are indicated by the purple arrow.
Deleting CIs in BMC Atrium Explorer

Reconciliation jobs should automatically purge instances from BMC Atrium Configuration
Management Database (BMC Atrium CMDB) when the CIs that those instances represent are
deleted from their dataset. If reconciliation jobs miss an instance that should be deleted, you can
delete that instance manually through the BMC Atrium Explorer. For more information about
reconciliation jobs, see Reconciliation jobs.
If you use BMC Atrium Explorer to delete an underlying CI related to BMC Remedy IT Service
Management records for example, a CI related to a change request in BMC Change
Management the CI status is automatically propagated to the consuming applications. You do
not need to clean up broken CI relationships and associations in consuming BMC applications.
CI deletion and relationships
Instance deletions in the BMC Asset dataset
To delete instances
CI deletion and relationships

When you manually delete a configuration item (CI) from the database in BMC Atrium Explorer, all
relationships associated with that CI are also deleted. When you run a promotion, deleting the
computer CI deletes the two relationships to the operating system and the monitor. But by default,
deleting the source CI does not delete the destination CIs.
Deleting CI and relationships
BMC Atrium Core 9.0
Page 355 of 2268
Home
However, if Cascade Delete is enabled for the relationships, deleting a source CI cascades down to
destination CIs. When you delete a source CI of a Cascade Delete relationship, the destination CI
of the relationship and all destinations of relationships below it are deleted when the source CI is
deleted. Administrators can only enable Cascade Delete in relationship classes that follow weak
relationships, or that follow 1-to-1 or 1-to-many cardinality. For more information about cascading
delete, see Relationships in the data model.
Instance deletions in the BMC Asset dataset

You cannot directly delete instances in the BMC Asset dataset, which is reserved for production
use. To delete an instance in the BMC Asset dataset, you must first convert the Asset view to a
Sandbox view. You then can delete it in the Sandbox dataset. The instance is marked as deleted,
or soft deleted, and appears in the view with the Deleted icon. Then, click Promote Sandbox
Changes to merge the changes into the BMC Asset dataset.
After the changes are merged, run a reconciliation job with the Purge activity to physically delete
only instances that have been marked as deleted, or soft deleted. For more information about the
Purge activity, see Purging soft-deleted data by using the Reconciliation Engine .
BMC Atrium Core 9.0
Page 356 of 2268
Home
To delete instances
1. In BMC Atrium Explorer, open a view for an editable dataset (for example, the Sandbox).
2. Add the instances that you want to delete to the view.
You can query for instances as described in BMC Atrium Explorer and building queries , or
you can open an existing view containing the instances you want to edit as described in
BMC Atrium Explorer views.
3. In the display pane, select one or more instances you want to delete.
4. Click the selected instances and select Delete from Database.
The instance is marked as deleted, or soft deleted, and appears in the view with the Deleted
icon.
Note
The Delete from Database command determines whether the selected
instance should be marked as deleted ( soft deleted ) or deleted from the dataset (
hard deleted ).
For example, if you create a CI in the Sandbox view, click the CI, and then select
Delete from Database, the CI is deleted from the Sandbox dataset (hard
deleted ) and removed from the view. However, if you are working in a BMC Asset
view that has been converted to a new Sandbox view, and you click the CI and
then you select Delete from Database, the CI is marked as deleted ( soft
deleted ) and appears in the view with the Deleted icon.
5. In the confirmation dialog box, click OK.

Editing CIs and relationships in BMC Atrium Explorer

Usually, changes to configuration items (CIs) and their relationships are reflected in BMC Atrium
Configuration Management Database (BMC Atrium CMDB) instances automatically after discovery,
normalization, and reconciliation processes have completed. However, you can also edit instances
manually.
To edit CIs
BMC Atrium Core 9.0
Page 357 of 2268
Home
To perform a quick edit of common attributes

To add impact to relationship instances
For example, if you reassign a computer system to a new employee, you might want to update the
instance for that CI in BMC Atrium CMDB to show the new owner.
Note
You cannot directly edit instances in the BMC Asset dataset, which is reserved for
production use. When you click an instance in the display pane and select Edit or Quick
Edit, the BMC Asset view is converted into a Sandbox view.
To edit CIs
1. In BMC Atrium Explorer, open a view for an editable dataset (for example, the Sandbox).
2. Add the instances that you want to edit to the view.
You can query for instances as described in BMC Atrium Explorer and building queries , or
you can open an existing view containing the instances you want to edit as described in
BMC Atrium Explorer views.
CIs from the production dataset added to the Sandbox do not display a special status icon (
for example, the pencil icon). This is a visual indication to you that they exist in the Sandbox
view only as copies of corresponding CIs from the BMC Asset dataset; they do not exist in
the Sandbox dataset. For more information, see Sandbox views and datasets.
3. Click an instance and select Edit.
Edit immediately copies the instance to the Sandbox view and dataset. The pencil icon next
to the instance indicates the CI has been edited in the Sandbox dataset while a
corresponding copy of the CI exists in the BMC Asset dataset (even if you cancel the Edit
action).
If the BMC Remedy IT Service Management applications are installed (7.6.03 or later)
, the Asset view of the instance appears. For example, if you edit a computer system
CI, the Computer System form (AST:ComputerSystem) is displayed.
Otherwise, the instance appears in its class form. For example, if you edit a computer
system CI, the BMC.CORE:BMC_ComputerSystem class form is displayed.
4. Modify the attribute values as needed, and then click Save.
You cannot revert your edits inside the Sandbox view. You must open the instance in the
Asset or class form, and then manually restore the changes.
Warning
Do not edit the InstanceId and ReconciliationIdentity attributes. BMC
Atrium CMDB workflow requires that these values remain unchanged.
BMC Atrium Core 9.0
Page 358 of 2268
Home
5. Click OK.
To perform a quick edit of common attributes

By default, you can perform a quick edit of the name and short description.
1. Click an instance and select Quick Edit.
Quick Edit temporarily copies the instance to the Sandbox view but it is not yet in the actual
dataset.
After you edit the instance, the instance then becomes part of the Sandbox dataset. The
pencil icon next to the instance indicates the CI has been edited in the Sandbox dataset
while a corresponding copy of the CI exists in the BMC Asset dataset.
If you cancel the Quick Edit action, the pencil icon does not appear next to the instance.
2. In the dialog box, enter new values, and then click OK.
Administrators can configure different attributes to appear. For more information about
configuring the attributes available for quick editing, see Defining Quick Edit attributes for a
class.
To add impact to relationship instances

1. Double-click a relationship instance.
2. In the Quick Editor, update the following attributes:
Short Description Type a description of the relationship.
HasImpact Select Yes.
ImpactDirection Select the direction (for example, Source-Destination or
Destination-Source).
3. Click OK.
The purple arrow icon now displays the direction of the impact relationship from the source
CI to the destination CI.
Working with related CIs

In BMC Atrium Explorer, you can view configuration items (CIs) and their relationships as a
graphical map. You can traverse this map from one CI to another to view relationships at all levels
throughout your environment. The display pane in BMC Atrium Explorer provides an Asset view of
the BMC Asset dataset so that you can browse the production CIs and their relationships in the
view. You can also view CIs and their relationships in a popup. For more information, see Working
with CIs and relationships in a popup .
BMC Atrium Core 9.0
Page 359 of 2268
Home
To work with CIs and relationships in the view

1. In the Find section of the BMC Atrium Explorer navigation pane, query for the CI that you
want to view.
For more information about finding CIs, see BMC Atrium Core queries and BMC Atrium
Explorer and building queries.
2. Drag one or more instances from the results list to the display pane.
Note
You can drag an instance from the results list to a view only if the view's dataset is
the same as the query's dataset. If the view's dataset differs from the query's
dataset, a red X appears on the instance when you drag it and the instance is
moved back to the results list. Additionally, the following message appears in the
display pane: CI dataset does not match view dataset
3. Right-click in the display pane and select View as Production to see the production
instances in your environment.
The Asset view and only the production instances appear in the display pane.
4. (optional) Click the expand arrows on a CI icon to view related CIs.
5. (optional) Select an instance and view its properties in the Properties section of the
navigation pane.
6. (optional) Select a filter from the Choose filter list inside the display pane.
Filters limit the instances that appear in a view. For more information about filters, see BMC
Atrium Explorer filters.
Working with CIs and relationships in a popup

You can view configuration items (CIs) and their relationships in a popup. The popup window lets
you preview the set of expanded CIs before you decide to add them to the view.
Working with CIs in a popup
BMC Atrium Core 9.0
Page 360 of 2268
Home
Before you begin

Configure BMC Atrium Explorer to expand the graphical map to use popups, as described in
Opening BMC Atrium Explorer.
To work with CIs and relationships in a popup

want to view.
2. Drag a CI from the results list to the display pane.
3. (optional) Select a filter from the Choose filter list (shown in the left layout menu) inside the
display pane.
4. (optional) From the layout menu, select an option (for example, Hierarchic ) to organize the
view inside the popup.
5. Expand the CI.
The parents and children of the CI appear in a popup window, with the original CI highlighted
(as shown in the following figure). You can resize the popup or move it within the display
pane.
When you select a filter, it is applied to both the original CI and the popup view--as indicated
BMC Atrium Core 9.0
Page 361 of 2268
Home
by the red virtual relationship line between the two CIs. To view an alternate configuration of
CIs in the view, you can select a different filter from the layout menu, or even turn off the
filter. Applying a different filter does not refresh the CIs displayed in the popup. The new filter
can affect the popup content if you close the popup and then expand the CI again to open a
new popup.
6. Perform one of the following tasks:
To add the expanded CIs shown in the popup to the original view, right-click an empty
spot inside the popup and then click Add to View. The popup closes and the CIs
displayed in the #popup now appear in the view.
Click the red X to close the popup.
Viewing filtered CIs that are part of a virtual relationship in a

popup
As shown in the following figure, the virtual relationship line between the two configuration items (
CIs) shows that one or more intermediate CIs are removed from the view by a filter. A popup
window lets you view filtered CIs that are part of a virtual relationship.
Before you begin

Select a filter that hides a CI in the view. In the following figure, a filter hides the BMC_Chassis CI
and produces a virtual relationship.
Virtual relationship between two CIs
BMC Atrium Core 9.0
Page 362 of 2268
Home
To view filtered CIs that are part of a virtual relationship

1. To show the CIs hidden in the view, double-click the relationship line (or right-click the virtual
relationship line) and then select Show Hidden Objects.
The BMC_Chassis CI, hidden in the virtual relationship between BMC_DiskDrive and
BMC_Database, is now displayed in a popup (shown in the following figure).
Hidden objects from a virtual relationship displayed in a popup window
The hidden CIs in this popup are display-only. Because the CIs already exist in the view
they are merely hidden by a filter you cannot add them to the view.
2. Click the red X to close the popup.
Comparing CI and relationship instances in BMC Atrium

Explorer
At any given time, BMC Atrium Configuration Management Database (BMC Atrium CMDB) can
contain more than one instance that represents the same real-world configuration item (CI). These
instances normally reside in different datasets.
To compare instances
To compare Sandbox instances with the BMC Asset dataset
To create an instance comparison report
Comparing instances in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 363 of 2268
Home
You can use BMC Atrium Explorer to perform the following CI comparison tasks:
Compare two instances within a single dataset or from two different datasets.
Compare two different CIs within a single dataset by selecting both of them and clicking
Compare Instances. The two instances should not represent the same physical entity.
Compare two relationship instances.
Create a report (in .csv format) that compares CI details.
The differences between the two instances are displayed in the Compare Instances view in a
results table. For example, if you suspect that two instances in the same dataset represent the
same real-world CI, you can compare instances to determine which instance to delete.
To compare instances
2. In the Find section of the BMC Atrium Explorer navigation pane, query for the instances that
you want to compare from the first dataset.
3. Perform one of the following comparison methods:
Comparing instances
Action
Using Compare Instances
Steps
a. Select an instance from the results list.
b. Click Compare Instances in the Find tab toolbar.
Using the display pane
a. Drag instances from the results list to the display pane.

b. Select an instance that you want to compare.
c. Click and then select Compare Instances.
BMC Atrium Core 9.0
Page 364 of 2268
Home
The Compare Instances view appears as a results table in the display pane. The results
table lists the attributes and values for the first instance.
4. Reset the query options and then query for instances from a second dataset.
5. Drag an instance from the results list to the results table.
The results table now displays the attributes and values for both instances.
6. To view the attribute values, filter the results displayed in the Show field:
Select Show > Differences only (the default) to display only the CI attributes that are
different in the results table.
Select Show > All attributes to display all the CI attributes in the results table.
7. To compare other instances from the same dataset, drag and drop instances from the query
results list into the header table of the Compare Instances view.
The results tables lists the new comparison results.
To compare Sandbox instances with the BMC Asset dataset

You can compare Sandbox instances with the BMC Asset dataset, for example, to verify if the CIs
in the Sandbox and the BMC Asset datasets match.
2. Open a new or existing view for an editable dataset (for example, the Sandbox).
3. In the Find tab, edit the query options to include a different dataset (for example, the
Sandbox).
4. Perform a new search.
5. Drag and drop instances from the query results list into the Sandbox.
6. Edit the instances as needed.
7. In the toolbar, click Table View to see the instances as rows in a table.
8. Right-click an instance from the row and then select Compare Against Asset Version.
The Compare Instances view appears. By default, the results table displays the different
values between the Sandbox and BMC Asset instances.
To create an instance comparison report

You can create a report (in .csv format) that provides the comparison details about the instances.
1. Perform a comparison between two instances.
2. Click Create Report.
3. Select the location to create the report.
4. Save the report in .csv format.
5. Open the report and view the details for the CI attributes.
BMC Atrium Core 9.0
Page 365 of 2268
Home

You can view the audit history of an instance so that you can track all the changes made to that
instance. The two types of auditing used when modifying a class Copy or Log save different
information about audited instances, but are displayed the same way in the Instance History.
Before you begin
To view instance history
Note
The Instance History is no longer available after you delete a configuration item (CI) in
Before you begin

You can view history only for classes that have auditing enabled and that have at least one attribute
with an Audit Option other than None (for example, Audit, Copy, or Audit & Copy).
Instance history in BMC Atrium Explorer
For more information about the audit feature, see:
BMC Atrium Core 9.0
Page 366 of 2268
Home
Types of auditing
Configuring auditing for a class
To view instance history

2. Click the Find tab.
3. Perform one of the following methods to open the Instance History window:
Opening the Instance History window
Action
Steps
Clicking View History in the Find tab toolbar
a. Search for a CI.

b. Select an instance from the results list.
c. Click View History in the Find tab toolbar.
Using the display pane
a.
b.
c.
d.
Search for a CI.

Drag instances from the results list to the display pane.
(optional) Edit the instance as needed.
Select the instance in the display pane.
e. Click the CI menu arrow and then select View History.
The Instance History window then provides the history of the instance. The main section lists
essential information (for example, Action, Submitter, and so on) about the audit, sorted by
the date of the audit.
4. Select a record in the table to view more details about the history.
The Instance History window displays the results of the three different audit attributes
Audit, Copy, and Audit & Copy in various ways.
The Changed Attribute Information section lists all the attributes that are Audit or
Audit & Copy enabled and were changed.
The Additional Attribute Information section lists attributes that are Copy enabled.
The following table shows the settings in the audit life cycle when you create or
modify a computer system CI.
Audit life cycle of a sample instance
Operation
Audit
attribute (
Domain)
Copy
attribute (
Hostname)
Audit &
Copy
attribute (
Workgroup)
Audit
triggered
?
Additional
attribute written
to Instance
History
Create
NULL
CALBRO1
NULL
Yes
Hostname-CALBRO1
Modify
calbro.com
CALBRO1
NULL
Yes
calbro.com
CALBRO-SJ
NULL
No
BMC Atrium Core 9.0
Hostname
-CALBRO1
Workgroup
--NULL
Not applicable
Changed
attribute written
Domain-NULL
Workgroup
--NULL
Domain-calbro.com
Not applicable
Page 367 of 2268
Home
Operation
Audit
attribute (
Domain)
Copy
attribute (
Hostname)
Audit &
Copy
attribute (
Workgroup)
Audit
triggered
?
Additional
attribute written
to Instance
History
Changed
attribute written
calbro.com
CALBRO-SJ
IDD
Yes
Hostname
Workgroup
CALBRO-SJ
IDD
Not applicable
Not available
Modify attribute
not enabled for
audit (for
example,
Category)
Modify
Delete
Not
available
Not
available
Not
available
Yes
For a different view of the audit history, you can review the CMDB.DefaultAuditLog
form.
5. Click Create Report.
6. Select the location to create the report.
7. Save the report in .csv format.
8. Open the report and view the audit history for the CI.
Instance groups
Multiple instances of the same class are grouped in BMC Atrium Explorer and are represented as
either a folder icon for configuration items (CIs) or a circle icon (for federated instances). A number
above the folder icon indicates the number of instances in the group.
Select and then pause your mouse pointer on a group icon to display the name of the class and the
number of instances in the group.
Right-click a group and select an option to display all items in the group or select items from the
group. You can show specific items by choosing Select Items to Show and clicking the
appropriate check boxes in the Select to Show dialog box.
By default, an instance group appears in BMC Atrium Explorer when four or more instances of a
class are related to a CI. BMC Atrium Configuration Management Database (BMC Atrium CMDB)
administrators can change the default number of instances that form an instance group. For more
information about changing the instance group threshold, see Defining instance group thresholds
for a class.
BMC Atrium Explorer views

Views display configuration item (CI) and relationship instances in BMC Atrium Explorer, providing
distinct, localized ways to view the instances in BMC Atrium Configuration Management Database (
BMC Atrium CMDB). For example, you might create a view of only the computer systems in one
city, or of the most impacted servers in the network.
BMC Atrium Core 9.0
Page 368 of 2268
Home
When you first open BMC Atrium Explorer, the display pane contains an empty BMC Asset view.
Populate the view by:
Using an out-of-the-box query or building a new query to discover CIs
Adding CIs and their relationships to the display pane
Expanding the CIs
Removing a CI from a view by right-clicking that instance and choosing Remove From View
Applying a filter to hide CIs in the view
Using the Map IT resources dialog box to update the view dynamically
After you have named and saved the view for reuse, you can reopen that view at any time, without
having to repopulate the display pane. All saved views appear in the Views section of the
navigation pane.
Note
If you create a CI in a Sandbox view and you do not save the view, the CI is saved in the
view's dataset. To review all the CIs and relationships in the Sandbox before you promote
them, right-click in the display pane and then select Show All Sandbox Items. All the CIs
and their relationships from all Sandbox views are displayed.
To open a view, select that view and then click Open. You can have many views open at once. All
opened views are listed at the bottom of the display pane, where you can click a name to make that
view appear.
When you create a new view, you must specify whether the view is Shared or Personal. Shared
views are available to everyone that logs in to BMC Atrium Explorer. Personal views are available
only to you.
To save time, you can create a copy of a view that displays a set of CI and relationship instances
and then modify it as needed. Finally, you can delete views as needed.
Sandbox views and datasets

By using a Sandbox dataset to edit configuration items (CIs), you take advantage of a safety
mechanism that prevents unintended changes to your production data. Only new or edited CIs are
present in the Sandbox view all other CIs exist in the production dataset. You cannot directly edit
data in the production dataset. You must use the Sandbox. This makes sure that your edits are
reconciled and the production dataset continues to accurately represent your environment.
Sandbox view and dataset
BMC Atrium Core 9.0
Page 369 of 2268
Home
The following topics explain how to edit instances in the Sandbox dataset and how to promote the
changes:
Using the Sandbox view and dataset
Promotion of CI changes to the BMC Asset dataset from the Sandbox
BMC Atrium Configuration Management Database (BMC Atrium CMDB) automatically creates a
personal Sandbox for every user, so that multiple users can edit configuration items (CIs) from the
production dataset without interfering with each other. The Sandbox acts as a temporary staging
area before promoting your changes to the production BMC Asset dataset. Because users have
their own Sandbox, this safety mechanism prevents them from editing instances directly used in the
production. The Sandbox dataset is an overlay dataset for the BMC Asset dataset and allows you
to make changes in a separate partition without changing the production data and without
duplicating the entire dataset.
You must work in the Sandbox view instead of the BMC Asset view when you are making changes
to CIs. When you click an instance in the display pane and select Edit or Quick Edit, you are
prompted to convert the BMC Asset view into a Sandbox view.
After you finish editing instances in your Sandbox, you promote your changes to the production
dataset. The Reconciliation Engine includes out-of-the-box rules to promote your changes from the
Sandbox to the production dataset. Only the Reconciliation Engine can update the production BMC
Asset dataset. For more information, see Promotion of CI changes to the BMC Asset dataset from
the Sandbox.
BMC Atrium Core 9.0
Page 370 of 2268
Home
For example, the Sandbox (and the instances contained in it) that belongs to Allen Allbrook at
Calbro Services is different from the Sandbox that belongs to Mary Mann. Allen cannot directly
create, edit, or delete CIs in the BMC Asset dataset, which is reserved for production use. Instead,
he would query for a CI, drag it to his Sandbox, edit the CI, and then promote his changes back to
the BMC Asset dataset.
You might see multiple computer instances in the new Sandbox view. Unless these CIs have the
pencil or star icon next to them, they are production instances (and therefore exist in the BMC
Asset dataset). If you create new relationship instances between them, the relationships (indicated
by the star icon) are part of the Sandbox overlay dataset but the computer CIs are not. If you then
run a promotion, only the relationship instances are reconciled into the BMC Asset dataset. To
view only the production instances, right-click inside the Sandbox view and then select View as
Production. The Asset view and only the production instances appear in the display pane.
You can create multiple views of the Sandbox dataset. All changes you make in a Sandbox
dataset are saved in the Sandbox dataset until you decide to promote those changes to the BMC
Asset dataset by clicking Promote Sandbox Changes in the toolbar.
When you click Promote Sandbox Changes, all of your CI changes are promoted. A reconciliation
job reconciles your changes with the production instances in the BMC Asset dataset. Your edits in
the Sandbox dataset are immediate. If you make a change that conflicts with an earlier change,
your new change overwrites it.
Note
If you create a CI in a Sandbox view and you do not save the view, the CI is still created in
the Sandbox dataset.
While the promotion is running, all instances in Sandbox views are unavailable. Only one promotion
can be running at any time for all the Sandbox users in BMC Atrium CMDB. If another user has
started a promotion, BMC Atrium Explorer notifies you that a promotion is already running.
After the promotion has completed, any views with Sandbox instances that have been promoted
now contain the production instances from the BMC Asset dataset.
Using the Sandbox view and dataset

You can use the Sandbox view and dataset to create, modify, or delete instances.
Recommendations
You should review the changes that you make to your Sandbox, so that you do not accidentally
promote configuration items (CIs) to the production BMC Asset dataset. For example, you might
have saved work in several Sandbox views over the course of many days. You can review all the
CIs and relationships in the Sandbox before you promote them. Right-click in the display pane and
BMC Atrium Core 9.0
Page 371 of 2268
Home
then select Show All Sandbox Items. All the CIs and their relationships from all your personal
Sandbox views are displayed. If the Sandbox includes CIs that you do not want to promote,
right-click the instance in the Sandbox view and select Discard Changes. The CI is removed from
the Sandbox.
Before you begin

If you determine that you need to edit instances in the BMC Asset dataset, copy those instances to
a new Sandbox view and perform the required modifications to the instances.
To use the Sandbox view and dataset

1. In BMC Atrium Explorer, open a new or existing view for an editable dataset (for example,
the Sandbox).
2. Use the Find pane to query for instances that you want to edit.
3. Select the instances and drag them to the Sandbox view.
4. Click the selected instances and select Edit or Quick Edit.
Understanding how the Sandbox view and dataset works is important when creating, editing
, or deleting instances. Just because an instance appears in the Sandbox view does not
mean that it exists in the Sandbox dataset you can see both Production and Sandbox CIs
in the same Sandbox view. For example, the Quick Edit action does not copy a Production
CI into your Sandbox dataset until you actually save edits to it. In addition, only CIs that
have been edited are promoted from the Sandbox dataset to the BMC Asset dataset.
5. Click OK.
You can drag Production and Sandbox instances into the Sandbox view. The production
instances are automatically copied to the Sandbox view as edit actions require.
For a complete list of actions you can perform inside the Sandbox, see Display pane actions.
Promotion of CI changes to the BMC Asset dataset from the Sandbox

In the BMC Asset dataset, values for configuration item (CI) attributes set in BMC Asset
Management take precedence over BMC Atrium Explorer changes to those CIs.
As a result, when using BMC Atrium Explorer (or the topology viewer accessed from BMC Remedy
IT Service Management suite), you cannot make changes in the BMC Asset dataset to values for
CI attributes that were edited or set first by BMC Asset Management. This applies to all attributes
for CIs that are created manually in the BMC Asset Management application. BMC Atrium Explorer
accepts your changes in the Sandbox dataset. But when you promote the changes to the BMC
Asset dataset, the values set by BMC Asset Management will not be changed. Instead, use Asset
forms to modify these values directly in BMC Asset Management.
Promoting changes to CIs from the Sandbox to the BMC Asset dataset only works for:
BMC Atrium Core 9.0
Page 372 of 2268
Home
CIs that were created outside BMC Asset Management

Attribute values that were never set or modified by the CI editor forms in BMC Asset
Management
Modifying the Merge Precedence set for BMC.ASSET.SANDBOX can affect BMC Asset
Management integrity. Before modifying the default behavior (for example, lowering the settings to
the same level as the personal Sandbox), you should carefully evaluate these changes.
Promoting CIs and relationships from a Sandbox dataset

After you create new instances, modify instances, or delete instances in the Sandbox dataset, you
must promote those changes to the production BMC Asset dataset.
Note
In the Sandbox dataset, if you make changes to an attribute and another dataset with
higher merge precedence has provided a value for this attribute, your changes to the
attribute are not promoted. For more information, see:
Reconciliation Merge activity
Before you begin

After you finish editing instances in your Sandbox, you promote your changes to the production
dataset. The Reconciliation Engine includes out-of-the-box rules to promote your changes from the
Sandbox to the production dataset. To understand the promotion process, see Sandbox views and
datasets.
To run a promotion
1. In BMC Atrium Explorer, when you are finished working in the Sandbox dataset and are
ready to promote changes to the BMC Asset dataset, click Promote Sandbox Changes in
the toolbar.
Promote Sandbox Changes works only with the Sandbox dataset.
2. In the Promotion Preview Dialog, filter which instances to view.
Promotion Preview Dialog
BMC Atrium Core 9.0
Page 373 of 2268
Home
The Promotion Preview Dialog enables you to view details of configuration item (CI) and
relationship instances before you promote them to the BMC Asset dataset.
Show > CIs and Relationships
Shows all the instances to be promoted.
Show > CIs
Shows only the CI instances to be promoted.
Show > Relationships
Shows only the relationship instances to be promoted
Note
If you create a CI in the Sandbox dataset, click the CI and select Edit, and set the
MarkAsDeleted attribute to Yes, the CI appears in the Promotion Preview
Dialog as a newly created CI. However, if you delete the CI by clicking the CI and
selecting Delete from Database, the CI is deleted and does not appear in the
Promotion Preview Dialog. For more information, see Deleting CIs in BMC Atrium
Explorer.
3. Filter which actions to view.

Show > All
Actions
Shows all the instances to be promoted.
Show >
New
Shows only the newly created instances. These instances exist only in the Sandbox dataset.
Show >
Changed
Shows only the instances that have been changed. These instances have been promoted previously but
require changes before being promoted again.
Show >
Deleted
Shows only the instances that have been deleted. Marked as deleted in the BMC Asset dataset is set to
false and Marked as deleted in the Sandbox dataset is set to true.
4.
BMC Atrium Core 9.0
Page 374 of 2268
Home
4. Filter which attributes are displayed in the left pane.

You can easily compare instance values in the Sandbox dataset with values in the B*MC
Asset* dataset.
a. Select an instance in the left pane to see its details on the right pane.
b. To compare the attribute values of the current selection between the Sandbox and
BMC Asset sandboxes*,* select from the following actions:
Show > All Attributes
Compares all attribute values of an instance.
Show > Edited Attributes
Compares only those attribute values that have changed.
5. Click Create Report to generate a report in .csv format that lists important CI and
relationship details during promotion.
6. When you are finished viewing the instances and actions, click Promotion to promote these
instances to the BMC Asset dataset, or click Cancel.
After the Promotion run, the status icons (for example, the star that indicates a new CI) are
no longer displayed next to the instances in BMC Atrium Explorer. This is a visual indication
to you that the instances exist only in the Sandbox view but not in the Sandbox dataset.
BMC Atrium Explorer layout controls

The layout controls work together to change the topology view of the configuration items (CIs) in
the BMC Atrium Explorer display pane. By default, the Layout view is set to Layered. When you can
drag CI classes to the display pane the CI automatically moves to its predefined layer. You can
add CIs to the service model in any order. You then use the layout controls to change the layout (
for example, to Hierarchic) and direction (Bottom to Top) of the instances in the display pane or to
run filters.
Using layout controls to view CIs (Layered view)
BMC Atrium Core 9.0
Page 375 of 2268
Home
To make the graphic UI predictable, the Layered view follows pre-defined best practices when
displaying your service model. Out-of-the-box, Service CIs form the top layer, then Application CIs,
and so on. These layers are customizable in the BMC_UIComponent form. If there are no Service
CIs, then Application CIs appear on the top.
Layout control options
Working with layout controls to view CIs

You can apply any of the following layout options to the CIs (for example, in the Sandbox or BMC
Asset views).
Layout control menu or
button
Description
Choose filter
Applies a saved filter, which limits the CIs that are visible in the current view or in a popup. The
following figure shows the results of applying a filter--it has hidden one or more intermediate CIs in
the view. The red dashed line indicates the virtual relationships between the CIs. See BMC Atrium
Explorer filters for more information.
Layered
Specifies the layout of the CIs.
BMC Atrium Core 9.0
Page 376 of 2268
Home
Layout control menu or

button
Description
Layered Uses BMC best practices to organize the view in horizontal layers according to the
type of CI, relative to other CI types. CIs of the same type are aligned even if there is a
different number of connections from each CI of the same type to a common CI in a higher
layer.
The Layered arrangement ignores relationships for determining vertical positioning. The
horizontal positioning adjusts in the view for the best relationship placement. In a Layered
view, if three Software Servers are connected to an Application but one of the Servers is
connected through an Application Infrastructure CI, then all three Servers are aligned on the
same layer, with the Application Infrastructure CI between them and the Application (as shown
in the following figure).
Hierarchic Organizes the CIs in the view according to the hierarchy of the classes in the
data model.
In a Hierarchic view, if three Software Servers are connected to an Application, but one of the
Servers is connected through an Application Infrastructure CI, then the two Servers are
aligned with the Application Infrastructure (one "hop" from the Application), and one Server
would be below them (as shown in Hierarchic layout (Bottom to Top)).
Orthogonal Arranges CIs in a compact format.
Circular Groups related CIs in circles to help you visualize how the groups are related.
Organic Groups instances according to their relationship with each other, with space
between groups.
Top to Bottom
Specifies the direction of the CIs, based on your layout selection. If you select the Layered or
Hierarchic layout option, you can also specify the direction of the CIs in the display pane:
Top to bottom (default)
Bottom to top
Left to right
Right to left
Run Layout
If you have added new CIs to a view, click Run Layout in the view to reorganize the view according
to the selected layout.
Working with layout controls to view CIs

You can use BMC Atrium Explorer layout controls to change the topology view of the configuration
items (CIs) in the display pane.
Before you begin

Review how to use queries and filters:
To work with layout controls to view CIs

want to view.
2. Drag the CI from the results list to the display pane.
3.
BMC Atrium Core 9.0
Page 377 of 2268
Home
3. Expand the CI.

4. Select a filter from the Choose filter menu inside the display pane.
To view an alternate configuration of CIs in the view, you can select a different filter from the
layout menu, or even turn off the filter.
5. Specify the layout (for example, Hierarchic) of the CIs.
Hierarchic layout (Bottom to Top)
6. Use the Top to Bottom menu to specify the direction of the CIs (for example, Bottom to Top
) if you select Layered or Hierarchic.
7. If you add new CIs to a view, click Run Layout in the view to reorganize the view according
to the selected layout.
Creating, copying, or deleting views

In BMC Atrium Explorer, you can create unique views of instances in BMC Atrium Configuration
Management Database (BMC Atrium CMDB). If needed, you can copy or delete these views.
To create and save a view
To copy a view
To delete a view
To create and save a view

1. In BMC Atrium Explorer, open a new view by using one of the following methods:
In the toolbar, click New View and then select one of the menu items (for example,
BMC Asset).
BMC Atrium Core 9.0
Page 378 of 2268
1.
Home
In an Asset view, click the configuration item (CI) and then select Edit or QuickEdit.
The Asset view is converted to a new Sandbox view. For more information, see
Sandbox views and datasets.
2. If necessary, add instances to the display pane as described in Working with related CIs.
3. In the toolbar, click Save View.
4. In the Save View As dialog box, enter the following information:
Name A name for the view. Consider using a name that indicates the purpose of
the view.
Group Whether the view is Shared or Personal.
Description A more detailed explanation of the purpose of the view. Consider
explaining the types of instances or the main CI displayed in the view.
5. Click Save.
To copy a view
1. In BMC Atrium Explorer, click the Views tab.
2. To copy a view, select that view and then click Copy.
3. In the Save View As dialog box, enter the name, group, and description.
4. Click Save.
To delete a view
1. In BMC Atrium Explorer, click the Views tab.
2. Select a view from the list and then click Delete.
3. Click OK to confirm that you really want to delete the view.
The view is removed from the list.
Saving a view as an image

In BMC Atrium Explorer, the display pane shows objects as a graphical chart. If you want to save a
view of that chart for use outside of the BMC Atrium Explorer, you can save the contents of the
display pane as a .png image.
To save a view as an image

1. In the BMC Atrium Explorer display pane, open the view that you want to save as an image.
2. Use the zoom bar to resize the contents of the view to fit within the display pane.
3. Click Export View as Image.
4. In the Export Image dialog box, select a scale mode:
None Saves the entire contents of the display pane, including areas that you must
scroll to see, to a maximum size of 2880 pixels by 2880 pixels.
ViewPort Saves only the portion of the display pane that is currently visible.
Fit Scales the entire contents of the display pane to fit in the pixel parameters that
you set.
5.
BMC Atrium Core 9.0
Page 379 of 2268
Home
5. Select the number of insets, which determines how many pixels of border surround the
saved image.
6. Select a background color for the image, and then click Export.
7. Click Save to save the image to the location of your choice.

BMC Atrium Explorer filters limit the instances that are visible in the current view. Use the Filters
section of the navigation pane to create and modify these filters.
The following figure shows the filter options available in the Filter dialog box.
Note
BMC Atrium Explorer filters differ in concept from BMC Remedy AR System filters. For
more information about BMC Remedy AR System filters, see Filters.
Show and Hide options in the Filter dialog box
BMC Atrium Core 9.0
Page 380 of 2268
Home
When you create a filter, you select configuration item (CI) and relationship classes, and then you
specify whether the instances for those classes are included or excluded from the current view. If
you expand a CI, any CIs that are filtered in the view are not displayed.
You can include or exclude the following base classes and their subclasses:
Base Element
All Related
BMC_FederatedBaseElement
BMC_FederatedBaseRelationship
But you can only run one filter at a time.
When you select Show the selected classes, only instances in the Selected Classes pane are
displayed. When you select Hide the selected classes, only classes in the Selected Classes
pane are hidden. For example, you can build a filter that includes instances of the
BMC_ComputerSystem and BMC_SoftwareServer CI classes, and also includes instances of
the BMC_Component relationship class. This filter would not allow instances of other CI and
relationship classes to be displayed.
You can also specify whether the filter excludes instances that are marked for deletion.
Note
Each relationship level shown in BMC Atrium Explorer consists of a relationship and a CI.
If both instances meet the criteria of the currently selected filter, both are shown. If either
instance does not meet the filter criteria, neither are shown. To view only impact
relationships between CIs, right-click in the BMC Atrium Explorer display pane and then
select View as Impact Model. A read-only topology view of the Impact Model appears.
Using filters to restrict which instances are displayed

When you create a filter, you can also determine whether that filter can be used by others or only
by you. Shared filters are available to everyone. Personal filters are available only to you.
To create a filter
To use a filter
To create a filter
1. In the BMC Atrium Explorer toolbar, click Manage Filters.
2. In the Filters dialog box, click New.
3. In the FilterName field of the Filter dialog box, enter a name for the filter.
BMC Atrium Core 9.0
Page 381 of 2268
3.
Home
Note
The maximum number of characters that you can enter in the FilterName field is
32.
4. Determine whether the filter is available to others by selecting either Shared Filter or
Personal Filter.
5. (optional) In the Description field, provide information about the purpose of the filter, such
as whether it is meant to exclude certain types of instances, or when the filter should be
applied.
6. If you want to filter instances that are marked for deletion, select the Show deleted items
check box.
7. Select the classes that are included or excluded by the filter:
a. From the Available Classes list, select one or more classes, and then click the right
arrow to move those classes to the Selected Classes list.
b. Select values for Show the selected classes/Hide the selected classes to
determine whether the selected classes are included or excluded by the filter.
8. Click OK.
To use a filter
1. Query the configuration items (CIs) that you want to view in BMC Atrium Explorer.
2. Drag the CIs into the display pane.
3. Expand the CIs as needed.
For example, you can view the CIs in the view or in a popup.
4. Select a filter from the Choose filter list inside the display pane.
The view or popup is displayed again, with the CI or relationship instances excluded from the
view.
Viewing business service CI information by using BMC Atrium

Service Context
BMC Atrium Service Context enables you to easily view critical information about a business
service and its performance, such as related incidents, changes, and configuration items.
Employees in different functional areas in your organization can view the same information about
the business service while launching BMC Atrium Service Context from within various BMC
applications, such as BMC Atrium Explorer, BMC Service Desk, or BMC Asset Management.
BMC Atrium Core 9.0
Page 382 of 2268
Home
The various applications that launch the Service Context Summary window also supply the data
that is used by BMC Atrium Service Context, in the form of key attributes that your administrator
can configure. In order for BMC Atrium Service Context to collect the data, applications that supply
various attributes must be installed and running in your environment. For more information and a
list of BMC applications that interact with BMC Atrium Service Context, see Applications that
interact with BMC Atrium Service Context .
This section describes how to view the Service Context Summary window for business services
within BMC Atrium Explorer. For information about launching the Service Context Summary window
within other BMC applications, see the online documentation for each application, located at http://
docs.bmc.com .
The following sections are provided:
Scenarios for using BMC Atrium Service Context
Working with BMC Atrium Service Context
Scenarios for using BMC Atrium Service Context

In many organizations, information might not flow freely and efficiently across departments. Issues
encountered in one area might stay with the personnel in that department. Even if the issues are
communicated, some pertinent information might not reach the relevant people in another
department.
With BMC Atrium Service Context, service support and service delivery information is provided to
all IT departments and disciplines in a fast and consistent manner, allowing teams to collaborate
more efficiently.
The following use cases illustrate situations in which you might need to quickly view information
about your business services and related computer systems and software applications.
Use case 1: Assigning incident requests
Use case 2: Cross-discipline collaboration
Use case 1: Assigning incident requests

At Calbro Services, a service desk agent receives a call from a customer, who reports that the
Oracle iTime service is performing slowly. Based on key information that the agent records in the
incident, the incident is automatically assigned to Mary Mann, the Support Specialist at Calbro
Services.
Mary is not very familiar with the Oracle iTime business service so she needs additional information
. From BMC Service Desk, she launches BMC Atrium Service Context to see the following
additional information about the service in the Service Context Summary window:
Service description
Outage records
BMC Atrium Core 9.0
Page 383 of 2268
Home
Related services and configuration items (CIs)

Mary notices that there are 20 CIs related to the Oracle iTime service. She clicks the number next
to Services and CIs to obtain more information, and sees details about each of the related CIs.
One of the related CIs is for a web server. Mary learns from the web server team that the server is
having an issue, which directly impacts the Oracle iTime service. Mary promptly reassigns the
incident to the web server team.
Conclusion: With the help of BMC Atrium Service Context, Mary reassigns the incident to the right
IT organization in the company, based on key information available in the Service Context
Summary window.
Use case 2: Cross-discipline collaboration

At Calbro Services, David Duncan, a database administrator (DBA) launches BMC Atrium Service
Context from BMC Asset Management when monitoring a database that he manages. David has
been receiving complaints that the query response time of the database is unusually slow.
After launching BMC Atrium Service Context, David notices that a change request was completed
on the database server around the time that the complaints started arriving. David provides the
change coordinator with the change request ID and asks him to launch the Service Context
Summary window. BMC Atrium Service Context allows David and the change coordinator to view
the same information.
With the help of BMC Atrium Service Context, David demonstrates to the change coordinator that
the most recent change to the server is causing issues on the database management system.
Conclusion: With the help of BMC Atrium Service Context, the change coordinator immediately
understands the issue and begins diagnosing the root cause. BMC Atrium Service Context helps
disparate teams communicate more efficiently.
Working with BMC Atrium Service Context

The Service Context Summary window (shown in the following figure) displays key information
about a business service, such as the name, description, and related services and configuration
items (CIs). Your administrator can configure additional attributes, such as Outage Records and
Completed Changes, depending on the applications that are running in your environment, such as
BMC Asset Management and BMC Change Management.
Service Context Summary window
BMC Atrium Core 9.0
Page 384 of 2268
Home
Additional information about the CI, such as related incidents, is displayed in the bottom portion of
the Service Context Summary window. You can click the number next to an item to view more
information, such as the date and time and incident ID.
The number next to an item indicates the number of results returned for that attribute. If there was
an error retrieving data from the provider, a dash ( - ) is displayed instead of a number. You can
click the dash to see the error message. If an excessive number of items is returned, a message is
also displayed. See your administrator for help in these situations.
Before you begin

Make sure that you have the CMDB SC User role and are a member of the CMDB SC User
Group group. Also make sure that you have view permissions for the CIs that you will access
with BMC Atrium Service Context.
Make sure that your user locale settings are correct for your chosen language and date/time
display.
See your administrator for help with permissions settings.
BMC Atrium Core 9.0
Page 385 of 2268
Home
To view BMC Atrium Service Context information about a business service CI in BMC Atrium
Explorer
1. Open BMC Atrium Explorer and search for a business service CI.
2. Select the CI and click Open launch in context menu in the toolbar.
Launching the Service Context Summary window
3. Select BMC Atrium CMDB > Service Context, as shown in the above figure.
4. To view additional information, click the number next to an item in the Related Information
section.
5. For a related service or CI, such as an application, server, or other business service,
double-click the CI.
6. To go back to the original Service Context Summary window, click Home.
7. To view more up-to-date information in any Service Context Summary window, click Refresh
at the bottom of the window.
Note
By default, clicking Refresh retrieves CI information stored in BMC Atrium Service
Context cache. In this case, the timestamp shown is the time Refresh was clicked,
not the time CI information was loaded into cache. Your administrator can turn off
caching so that Refresh retrieves CI information directly from the data source.
Turning off caching might result in a delayed response time for showing results.
BMC Atrium Core 9.0
Page 386 of 2268
Home
Administering
The following topics provide information and instructions for administering BMC Atrium Core:
Configuring logging information in CMDB
Modeling data and impacts in BMC Atrium CMDB
Denormalized CMDB Data Storage
Administering service models and the Service Catalog
Managing datasets in BMC Atrium Core
Normalizing data
Reconciling data
BMC Configuration Drift Management
Viewing CI status in context of installed applications
Triggering jobs to import data into BMC Atrium CMDB
Configuring Data Archiving
Configuring logging information in CMDB

BMC Atrium CMDB provides information about logging configuration parameters in different
components like the CMDB Engine, Normalization Engine, and Shared Plugins. Using this
configuration, you can eliminate the downtime while enabling detailed logs.
The logs provide the following information:
BMC Atrium Core 9.0
Page 387 of 2268
Home
Timestamp The date and time of the log entry.

Log Type The type of log entry: warning, error, or information.
Message The message for the log entry (classified into error, warning, and information
categories).
Understanding Log Levels
Log levels determine the types of messages that are logged for the calls. The following different
types of log levels are available in CMDB:
Level
Description
Fatal
Logs the events that may lead the application to abort.
Error
Logs the events in which application continues to run with some errors.
Warning
Logs the events that are potentially harmful situations.
Info
Logs the events and calls with their results that highlight the progress of the application at high level.
Debug
Logs the events and calls with input and output values that are useful to debug an application.
Trace
Logs the events that can be used to trace the information for solving support issues in production environment without
disturbing a running system.
Clear
Logging is disabled.
You can configure logging for the following BMC Atrium components:
CMDB Engine You can configure logging information for CMDB Engine from CMDB
Administrator console. For more information, see Configuring BMC Atrium CMDB Engine
logging.
Normalization Engine You can configure Normalization logging information from
Normalization Engine console. For more information, see Configuring Normalization Engine
logging.
Shared plugins You can configure shared plugins logging information from AR System
Administration console. For more information, see Configuring shared plugins logging.
Notes
No file system access required for making any configuration changes.

For any change to logging configurations to take effect you do not need to restart
the BMC Remedy AR System server.
You can perform all the Atrium CMDB configurations through the Centralized Configuration System
(CCS). For more information, see Centralized configuration.
BMC Atrium Core 9.0
Page 388 of 2268
Home
Additional Information
Reconciliation job logging
Atrium Integrator logging
Configuring shared plugins logging

You can configure the logging setting for all BMC Atrium CMDB shared plugins from the Central
Configuration System.
To configure logging for shared plugins

1. In the BMC Remedy AR System Administration Console, click System > General > Plugin
Server Configuration.
2. A Plugin Server Configuration form opens in a window. From the Plugin Server Instance
list, select plugin server with port number 9556.
3. Click Plugin Configuration tab to view the configured shared plugins.

4. Click Plugin Server Configuration tab and modify the following settings:
Enable Plugin
Log
Select True to enable logging for the plugin server.
Log level
This option defines what type of information is saved in the log file. For more information about log
levels, see Understanding Log Levels
Log file
This defines the path on the server where the log file is saved.
Maximum
Log File Size
When the log file reaches the file size limit, it is renamed and a new log file is created. The older files
are not automatically deleted.
For example, if the log file is named neJob.BMC.ASSET.0001.log, the older files are named
neJob.BMC.ASSET.0001.log.1 and neJob.BMC.ASSET.0001.log.2.
Log History
Specify a value to keep a history of number of log files to be maintained as a backup.
5. Click Apply and then Close.

To start the end-to-end process, set up permissions for users who need access to BMC Atrium
Core applications. After completing the configuration tasks, verify that the roles and permissions
have access to the data as planned.
BMC Atrium Core 9.0
Page 389 of 2268
Home
BMC Atrium Core provides several methods of controlling user access to data: application roles,
class and attribute permissions, and instance permissions. The following topics provide instructions
for setting permissions for BMC Atrium Core, including access to different areas of the application
and access to configuration data:
Configuring user access to BMC Atrium Core components
Groups installed with BMC Atrium CMDB
BMC Atrium Core permission roles within applications
Calbro Services scenario for BMC Atrium CMDB groups, roles, and users
BMC Remedy AR System license types required for data access in BMC Atrium Core
BMC Atrium CMDB data permissions for classes and attributes
Roles, instance permissions, and row-level access in BMC Atrium Core
Permission scenarios when managing user access to BMC Atrium CMDB data
Managing dataset level permissions

User access to BMC Atrium Core components requires that you create BMC Remedy AR System
groups and users who are properly licensed. You must also map these groups to their BMC Atrium
Core roles.
Note
When you upgrade BMC Atrium Core, the installer does not create new groups and does
not modify existing role and computed group definitions. As a result, the upgrade process
does not break the existing groups, roles, and mappings that you have configured for your
system.
To configure user access to components

1. Open the Group form and create a BMC Remedy AR System regular group (Change group
type) for the different levels of access you need defined.
Use the following direct access URL to open the Group form:
http://<midTierServer>: <portNumber>/arsys/forms/<arSystemServer>/Group
For example, create a regular group ( <CMDBAdmin>) that you use for all your BMC Atrium
Core administrators. You can also re-use regular groups that you have previously created.
For general information about working with groups, see Creating and managing
groups
For detailed information about groups in the BMC Atrium Core solution, see Groups
installed with BMC Atrium CMDB.
2.
BMC Atrium Core 9.0
Page 390 of 2268
Home
2. In the Group form, click Append Group to add the <CMDBAdmin> regular group to a
computed group (for example, CMDB Console Admin Group).
For example, your Group Definition would now read:
Administrator OR CMDBAdmin
3. Open the Roles form and map a group that you created in step 1 to the Production state of
the BMC Atrium Core roles that you want to associate with that group. Use the following
direct access URL to open the Roles form:http://<midTierServer>:<portNumber>/arsys/
forms/<arSystemServer>/Roles
Many roles already have groups mapped to them. For example, the CMDB Console Admin
role is mapped out-of-the-box to the CMDB Console Admin Group in the Production state.
Note
If a group is already mapped to the role, add your group to that computed group
instead of modifying the mapping.
For general information about working with roles, see Creating and mapping roles
For detailed information about roles in the BMC Atrium Core solution, see BMC
Atrium Core permission roles within applications.
For examples of users with the groups and roles required to accomplish their tasks,
see Calbro Services example--BMC Atrium CMDB groups, roles, and users .
4. Open the User form and create BMC Remedy Action Request System (AR System) users.
Use the following direct access URL to open the User form:http://<midTierServer>:<
portNumber>_ /arsys/forms/<arSystemServer>/User
In the Group Listfield, select the regular groups associated with the access permissions
needed by each user.
Note
You cannot select a computed group from the Group List field when creating a
user. This is why you had to create a regular group and then add it to the group
definition of the computed group.
For information about the BMC Remedy AR System license types to grant to users of
BMC Atrium Core, see BMC Remedy AR System license types required for data
access in BMC Atrium Core.
For information about creating users, see Creating and managing users
Related topics
Calbro Services example BMC Atrium CMDB groups, roles, and users
BMC Atrium Core 9.0
Page 391 of 2268
Home

When defining BMC Atrium CMDB access control, you must create groups on your BMC Remedy
AR System server that represent functional areas of the CMDB. You should create group types that
are consistent with the purpose of the group. For example, you should define a group that does not
need to modify data as a View group type.
Note
If BMC Remey ITSM applications are installed, the BMC Remey ITSM permissions are
automatically incorporated into the CMDB Computed Groups. This grants permissions to
BMC Remey ITSM end users to access to the CIs and BMC Atrium CMDB Consoles
through the respective BMC Remey ITSM consoles and forms.
Your groups have no authority in the BMC Atrium CMDB until they are mapped to CMDB
permission roles. You must map the groups you have defined for functional areas of the CMDB to
the corresponding roles installed with the product.
The following table lists the default groups that are available when you install BMC Atrium CMDB.
Default groups installed with BMC Atrium CMDB
Name
Group
type
Category
type
CMDB Console User Group
Change
Computed
Users in this group can
Function in the CMDB Console User role.

Function in the CMDB Data View role.
Function in the CMDB Definitions Viewer
role.
CMDB Console Admin Group
Change
Computed
Function in the CMDB Console Admin role.
Function in the CMDB Data Change role.
Function in the CMDB RE User role.
CMDB RE User Group
Change
Computed
Function in the CMDB RE User role.
CMDB Definitions Viewer Group
Change
Computed
Function in the CMDB Definitions Viewer role.
RE Operator (Reconciliation Engine Operator)
Change
Regular
Start and cancel reconciliation jobs.
RE Definition Author (Reconciliation Engine
Change
Regular
Create and modify reconciliation job definitions.
RE Manual Identification (Reconciliation Manual

Identification)
Change
Regular
Perform manual identification.
CMDB Data Change Group
Change
Computed
Function in the CMDB Data Change role.
CMDB Data View Group
View
Computed
Function in the CMDB Data Viewer role.
Definition Author)
BMC Atrium Core 9.0
Page 392 of 2268
Home
Name
Group
type
Category
type
Users in this group can
CMDB Write Security
Change
Dynamic
View and modify the attributes of BMC Atrium

CMDB data.
Atrium Foundation Admin
Change
Regular
Grant administrator access to Atrium Foundation

components.
Atrium Foundation Admin Computed
Change
Computed
Function as the Atrium Foundation Administrator.
Atrium Foundation Viewer
View
Regular
Grant view access to Atrium Foundation

components.
Atrium Foundation Viewer Computed Group
Change
Computed
Function as the Atrium Foundation Viewer.

This topic discusses the application roles available for BMC Atrium Core components.
Permission roles in BMC Atrium Core applications
BMC Atrium CMDB computed groups and roles
Assigning a BMC Atrium CMDB role to a user

A BMC Remedy AR System deployable application named BMC:Atrium CMDB contains the BMC
Atrium CMDB class forms. When you use Class Manager to create new classes, the new classes
are automatically added to the application. This application allows you to manage permissions with
BMC Remedy AR System roles. Other BMC Atrium Core components have their own deployable
applications, as listed in the following table.
Several permission roles are available for these deployable applications to enable you to grant
users the permissions that they need to do their jobs. For information on computed groups on roles,
see BMC Atrium CMDB computed groups and roles .
Note
These permission roles can overlap, with the security of one role sometimes taking
precedence over another role. In general, more restrictive permissions take precedence
over less restrictive or unrestricted permissions. As a result, you should be careful what
roles and permissions that you assign to your users, because your selections can have
unexpected results.
The following table lists the application roles available for BMC Atrium Core components.
BMC Atrium Core 9.0
Page 393 of 2268
Home
Role name
Applications
CMDB Data
View
BMC:Atrium CMDB
Mapped groups (
default)
Test
None
Production
CMDB
Data View
Group
Capabilities of users with this role
Gain access to the Atrium Impact Simulator.

View class instances. Works in conjunction with the
CMDBRowLevelSecurity and CMDBWriteSecurity
attributes. See Roles, instance permissions, and row-level
access. To view class instances from the BMC Atrium Core
Console, a user must also have the CMDB Console User role.
Can create instances, but only for classes where all required
attributes have either a default value or Allow Any User to
Submit is enabled.
Note: The CMDB Data View role is for the BMC:Atrium CMDB
application and is different than the similarly-named CMDB
Data Viewer role used for the Atrium Impact Simulator
application.
CMDB
Definitions
Admin
AtriumCMDBConsole
Test None
Gain administrator permissions for all the defined applications.
Production
CMDB Definitions
Admin Group
CMDB Data
Change
BMC:Atrium
CMDB
Test
None
View, create, and modify class instances. Works in

conjunction with the CMDBRowLevelSecurity attribute. See
Atrium Impact
Simulator
Production-CMDB
Roles, instance permissions, and row-level access.

View, create, modify, and delete shared queries.
To perform these tasks from the BMC Atrium Core Console, a
user must also have the CMDB Console User role.
Data
Change
Group
CMDB Data
View All
BMC:Atrium CMDB
Test
None
Production
None
View all class instances, regardless of the

CMDBRowLevelSecurity attribute for row-level security. To
view class instances from the BMC Atrium Core Console, a
user must also have the CMDB Console User role. To view
class instances in the Atrium Impact Simulator, a user must
also have the Atrium Impact Simulator User and CMDB Data
Viewer roles.
Can create instances, but only for classes where all required
attributes have either a default value or Allow Any User to
Submit is enabled.
CMDB Data
Change All
BMC:Atrium CMDB
Test
None
Production
None
View, create, and modify all class instances, regardless of the

CMDBRowLevelSecurity attribute for row-level security.
Test
Gain access to the BMC Atrium Core Console.
View, create, modify, and delete shared queries.

To perform these tasks from the BMC Atrium Core Console, a
user must also have the CMDB Console User role.
AtriumCMDBConsole
BMC Atrium Core 9.0
Page 394 of 2268
Home
Role name
Applications
Mapped groups (
default)
CMDB
Console
User
Production
CMDB
Console
User Group
Perform queries from applications on the BMC Atrium Core

Console (you must also have one of the two CMDB Definitions
roles).
View federation definitions.
Launch applications in context.
View instance history (you must also have one of the two
CMDB Definitions roles, row-level security on the audited
instances, and permissions on the audit or log form).
Note: You must be a member of the BMC Remedy AR System
Administrator group to create and update class definitions.
CMDB
AtriumCMDBConsole
Test
None
Production
CMDB
Console
Admin
Group
Console
Admin
CMDB
Definitions
Viewer
AtriumCMDBConsole
Atrium
Atrium Impact
Impact
Simulator
Simulator
User
Perform all of the tasks granted by the CMDB Console User

role.
View, create, modify, and delete federation definitions.
Note: You must be a member of the BMC Remedy AR System
Administrator group to create, update, and delete federation plugins.
Test
None
Production
CMDB
Definitions
Viewer
Group
Open BMC Atrium Explorer.

Run queries in the BMC Atrium Core Console.
Test
CMDB Data
View Group
Production
CMDB
Data View
Group
View the Atrium Impact Simulator in the BMC Atrium Core

Console.
View and run impact simulations in Atrium Impact Simulator.
Users must also have the CMDB Data Viewer role.
Note: You must have a BMC Remedy AR System write
license to run simulations in Atrium Impact Simulator. For
more information about license types needed for BMC Atrium
Core, see BMC Remedy AR System license types required for
data access in BMC Atrium Core.
CMDB Data
Viewer
CMDB RE
User
Atrium Impact
Simulator
REApplication
Deployable
BMC Atrium Core 9.0
Test
CMDB Data
View Group
Production
CMDB
Data View
Group
View and run impact simulations in Atrium Impact Simulator. Users

must also have the Atrium Impact Simulator User role.
Note: The CMDB Data Viewer role is for the Atrium Impact
Simulator application and is different than the similarly-named
CMDB Data View role used for the BMC: Atrium CMDB application.
For the Reconciliation Engine:
Page 395 of 2268
Home
Role name
Applications
Mapped groups (
default)
CMDB RE
Definitions
Admin
REApplication
Deployable
CMDB RE
Manual
Identification
REApplication
Deployable
NE User
NEApplication
Test
None
Production
CMDB
RE User
Group
View jobs.
Start, pause, and cancel jobs.
Test
None
Production
None
View, create, modify, and delete jobs, activities, sets, and

rulesets.
Start and cancel jobs.
Manually identify instances
Modify standard rules
Create datasets, edit server configurations, change
Identification activities, and export reconciliation definitions.
Manually identify instances.

Test
None
Production
None
Note: The CMDB RE Manual Identification role has been deprecated

. You must reassign any users who were assigned to this role to the
CMDB RE Definitions Admin role.
Test
None
Production
View jobs, the Job History, class configurations, system

configurations, and dataset configurations.
None
NE
Administrator
CMDB SC
Admin
NEApplication
Remedy
Foundation
Product
Catalog
Test
None
Production
None

View, create, and modify jobs.
Delete Job History data.
Administer class configurations, system configurations, and
dataset configurations.
Test
CMDB SC
Admin
Group
Production
CMDB
SC Admin
Group
Configure attributes and other settings in the Service Context

Administration window
Use the Service Context Summary window to view CIs,
attributes, and related data
Service Context
Note: In addition to the CMDB SC Admin role, administrators

must have view permissions for the business service CI from
which they launch the Service Context Summary window.
They must also have view permissions for each related CI to
see details about those CIs.
CMDB SC
User
Service Context
Test
CMDB SC
User Group
Use the Service Context Summary window to view CIs, attributes,

and related data
Note: In addition to the CMDB SC User role, users must have view
BMC Atrium Core 9.0
Page 396 of 2268
Home
Role name
Applications
Mapped groups (
default)
Production
CMDB
SC User
Group
AIE
Definitions
Admin
BMC Atrium
Integration Engine
AIE User
BMC Atrium
Integration Engine
Atrium
Foundation
Viewer
Test
None
Production
None
permissions for the business service CI from which they launch the
Service Context Summary window. They must also have view
permissions for each related CI to see details about those CIs.
View, create, and modify data mappings and data exchanges.

Manage the BMC Atrium Integration Engine configuration and
connection settings.
View data mappings and data exchanges.

Test
None
Production
None
Remedy
Foundation
Test
Atrium
Product
Catalog
Foundation
Viewer
Remedy
Definitive
Computed
Production
Software
Library
Atrium
Foundation
Remedy
Foundation
Viewer
Computed
View records for BMC Atrium Product Catalog products, versions,

patches, files, suites, storage (software library items), and signatures.
Site
Remedy
Foundation
Company
Remedy
Foundation
Prime
Elements
Atrium
Foundation
Admin
BMC Atrium Core 9.0
Remedy
Foundation
Product
Catalog
Remedy
Definitive
Software
Library
Remedy
Foundation
Site
Remedy
Foundation
Company
Test
Atrium
Foundation
Admin
Computed
Production
Atrium
Foundation
Admin
Computed
View, create, modify, and delete records for BMC Atrium

Product Catalog products, versions, patches, files, suites,
storage (software library items), and signatures.
Add and remove BMC Atrium Product Catalog relationships.
Page 397 of 2268
Home
Role name
Applications
Mapped groups (
default)
Remedy
Foundation
Prime
Elements
General
Access
Remedy
Foundation
Product
Catalog
Remedy
Definitive
Software
Library
Remedy
Test
General
Access
Production
General
Access
Use BMC Atrium Product Catalog fields and access BMC Atrium
Core Product Catalog and DML Online Help.
Foundation
Site
Remedy
Foundation
Company
Remedy
Foundation
Prime
Elements
Unrestricted
Access
BMC Atrium Core 9.0
Remedy
Foundation
Product
Catalog
Remedy
Definitive
Software
Library
Remedy
Foundation
Site
Remedy
Foundation
Company
Remedy
Foundation
Prime
Elements
Test
Unrestricted
Access
Production
Unrestricted
Access
Use BMC Atrium Product Catalog fields and access BMC Atrium
Core Product Catalog and DML Online Help.
Page 398 of 2268
Home
BMC Atrium CMDB computed groups and roles

For a BMC Atrium CMDB application's Production state, the CMDB Data View and CMDB Data
Change roles are each mapped by default to a computed group, which acts as a supergroup for the
people in each member group. This allows you to assign the most common roles in your
organization to more than one BMC Remedy AR System group.
You can create computed groups to organize users of BMC Atrium CMDB. For example, in a
service-provider environment, you might create one computed group to contain the groups for one
company, and another computed group to contain the groups for another company. You could then
assign these computed groups to BMC Atrium CMDB roles. This arrangement simplifies role
assignments and makes it easier for you to configure instance permissions. For more information,
see Roles, instance permissions, and row-level access .
For more information about BMC Remedy AR System application roles and computed groups, see
Regular, computed, and dynamic groups
Assigning a BMC Atrium CMDB role to a user

Methods for assigning roles to users differ slightly, depending on whether you want to assign the
CMDB Data View and CMDB Data Change roles, or another BMC Atrium CMDB role.
To assign a BMC Atrium CMDB role to a user

1. Open the User form and search for BMC Remedy AR System users.
a. Go to AR System Administration > AR System Administration Console .
b. In the left navigation pane, click Application > Users/Groups/Roles.
c. Click Users. The User form is displayed.
2. Make the user a member of a group that is a member of the computed group mapped to one
of the following roles:
CMDB Data View
CMDB Data Change roles
These two roles are mapped to computed groups provided with the BMC Atrium
CMDB named CMDB Data View Group and CMDB Data Change Group.
3. Make the user a member of the group that is mapped to other BMC Atrium CMDB roles, or
map one of the user's existing groups to the role.
4. Save your changes.
Calbro Services scenario for BMC Atrium CMDB groups, roles,

and users
Access to BMC Atrium Core components requires that you correctly configure groups, roles, and
users on the BMC Remedy AR System server.
The following example illustrates how you can create permissions for Calbro users. The following
table lists examples of two users that require different permissions to BMC Atrium Core
components based on the tasks they need to perform.
BMC Atrium Core 9.0
Page 399 of 2268
Home
Bob Baxter manages Backoffice Support at Calbro Services. His job description requires him
to view BMC Atrium CMDB data. He notices that the Oracle database needs a patch. He
needs to be able to run a simulation on the Oracle CI to see the impact to the Calbro IT
infrastructure if he brings down the server.
He also must view any CIs, attributes, and tickets related to the Service Context of the
underlying business service. Bob is considered a "low-access" user to the BMC Atrium
CMDB.
Mary Mann is part of Calbro's support staff. Calbro's IT department uses the IT infrastructure
to deliver value to the business, in the form of services. These services are tracked in BMC
Atrium CMDB as CIs. They can be related to the IT infrastructure CIs that support them. Part
of Mary's job description is to create the service CIs that represent the Calbro service model.
Mary must be able to enable and view related information about her company's business
services, including CIs, incidents, work orders, completed change requests, SLM service
targets, and SLM agreements.
Mary is considered a power user of the BMC Atrium CMDB.
The table lists the groups and roles needed by these users to accomplish their tasks. In an actual
environment, users require different combinations of groups and roles than the examples in the
following table.
Roles required for different levels of access

Type of user and
sample tasks
Low-access user, who
needs only to view data.
Bob must be able to:
View BMC Atrium
CMDB data
Run simulations
in Atrium Impact
Simulator
Use the Service
Context Summary
window to view
CIs, attributes,
and related data.
Full-access
administrator, who
needs write access to all
data and configurations.
Mary must be able to:
Overview steps
1. Create a low-access regular group (LowUserGroup ).

2. Add the LowUserGroup group to the CMDB Console User Group and
CMDB SC User computed groups.
3. Create a user.
4. Add the user to the LowUserGroup group.
Note: Bob cannot view specific BMC Atrium CMDB data until you add
row-level security to the data, or you map the LowUserGroup group to
the CMDB Data View All production role. For more information, see
Roles, instance permissions, and row-level access in BMC Atrium Core .
1. Create a full-access regular group ( AdminGroup ).

2. Add the AdminGroup group to the following computed groups:
CMDB Console Admin Group computed group
CMDB Console User Group computed group
Atrium Foundation Viewer Computed
CMDB SC Admin Group
NE User Production Role
BMC Atrium Core 9.0
Results
Bob can view the

data in the following
BMC Atrium CMDB
applications:
BMC Atrium
Explorer
Atrium Impact
Simulator
Product
Catalog
Console
Mary can view and

modify the data in
the following BMC
Atrium CMDB
applications:
BMC Atrium
Explorer
Page 400 of 2268

3.
Home
Type of user and

sample tasks
View, create,
modify, and
delete BMC
Atrium CMDB
data
Create and
modify queries
View, create, and
modify class
definitions
View, create, and
modify federation
definitions
View and run
simulations in
Atrium Impact
Simulator
Configure
attributes and
Overview steps
3. Map the AdminGroup group to the NE User production role and to the
NE Administrator production role.
4. Add the AdminGroup group to the following RE roles:
CMDB RE User
CMDB RE Definitions Admin
CMDB RE Manual Identification
5. Create a user, and then add her to the following groups in the Group List
:
General Access
Unrestricted Access
Administrator (if you want this user to view, create, and modify
class definitions)
6. Add the user to the AdminGroup group.
Note: Mary cannot see or change specific BMC Atrium CMDB data until
you add row-level security to the data, or you map the AdminGroup
group to the CMDB Data View All and CMDB Data Change All roles. For
more information, see Roles, instance permissions, and row-level
access in BMC Atrium Core.
Results
Atrium Impact
Simulator
Class
Manager
Federation
Manager
Normalization
console
Product
Catalog
Console
Reconciliation
console
Service
Catalog
Service
Context
Administration
window
other settings in
the Service
Context
Administration
window
Use the Service
Context Summary
window to view
CIs, attributes,
and related data
View, create,
modify, and
delete
Reconciliation
Engine jobs,
activities, rules,
and rulesets
Manually identify
instances
Start and cancel
Reconciliation
Engine jobs
Modify
normalization
settings
Start and cancel
Normalization
Engine jobs
View, create,
modify, and
delete Product
Catalog records
Add and remove
Product Catalog
relationships
BMC Atrium Core 9.0
Page 401 of 2268
Home
Review carefully the groups and roles for other tasks that you might need to add to your users. For
more information, see:
BMC Remedy AR System license types required for data

access in BMC Atrium Core
The type of BMC Remedy AR System license granted to a user helps determine that user's ability
to see and modify data in BMC Atrium Core. BMC Remedy AR System licenses can be grouped
into the following categories:
Read licenses Enable users to search for and display requests within their assigned
permissions. Administrators can configure the AR System server to enable users with Read
licenses to submit requests and to modify requests that they submit. This category includes
the Read and Restricted Read license types.
Write licenses Include all the capabilities of a Read license, and also enable users to
modify and save data for requests that they did not submit based on the groups to which
they belong. This category includes the Fixed and Floating license types.
Read licenses allow users to search for CIs and relationships, and display instances in BMC Atrium
Explorer, but do not allow users access to some BMC Atrium Core functionality. If you want BMC
Atrium Core users to create or modify CIs and relationships, run impact simulations in Atrium
Impact Simulator, and so on, make sure that those users have write licenses.
For more information about BMC Remedy AR System license types, see License types overview.
BMC Atrium CMDB data permissions for classes and attributes

This topic discusses how to specify permissions on BMC Atrium CMDB data at both the class and
attribute level.
Class permissions on BMC Atrium CMDB data
Attribute permissions on BMC Atrium CMDB data
Class permissions on BMC Atrium CMDB data

You can specify which explicit groups and roles have the following permissions on each class:
Hidden Members of these groups and roles can access the class through workflow, but
cannot see its instances in the BMC Atrium Explorer or open its form with a web client.
BMC Atrium Core 9.0
Page 402 of 2268
Home
Visible Members of these groups and roles can see and access the class in all ways:
instances in the BMC Atrium Explorer, the class form with a web client, and through
workflow.
You specify class permissions from the Permissions tab when viewing a class in the Class
Manager. For more information, see Setting class permissions in the Class Manager .
Warning
Do not use BMC Remedy Developer Studio to change permissions on the class forms.
These permissions are overwritten the next time a change is made to the class with the
Class Manager.
Class permissions are equivalent to BMC Remedy AR System form permissions. For more
information about BMC Remedy AR System form permissions, see Form, active link guide, and
application permissions
Attribute permissions on BMC Atrium CMDB data

You can specify which explicit groups and roles have the following permissions on each attribute:
View Members of these groups and roles can view the attribute in the class form, but
cannot modify its value.
Change Members of these groups and roles can view and modify the attribute value.
You can also specify that a user without Change permissions can set the attribute's value when
creating an instance. To do so, select Allow Any User to Submit.
You specify attribute permissions from the Permissions tab when viewing an attribute (in the
Attributes dialog box) from the Class Manager. For more information, see Class attributes in the
Class Manager.
Warning
Do not use BMC Remedy Developer Studio to change permissions on the attribute fields.
These permissions are overwritten the next time a change is made to the class with the
Class Manager.
Attribute permissions are equivalent to BMC Remedy AR System field permissions. For more
information about BMC Remedy AR System field permissions, see Field permissions
BMC Atrium Core 9.0
Page 403 of 2268
Home
Roles, instance permissions, and row-level access in BMC

Atrium Core
This section discusses roles, instance permission, and row-level access for BMC Atrium Core.
Also see the following topics:
Specifying permissions to instances in BMC Atrium CMDB
Configuring default permissions of classes
The CMDB Data View and CMDB Data Change roles do not completely control access to instances
in BMC Atrium CMDB. They control access to the contents of instances in general. But to view or
modify a specific instance, you must also have row-level access to that instance. A class attribute
controls row-level security and another one controls write security. These attributes and the CMDB
Data View and CMDB Data Change roles work together:
CMDBRowLevelSecurity Users who are members of a group with row-level access
have permission to view the instance if they also have the CMDB Data View or CMDB Data
Change role.
CMDBWriteSecurity Users who are members of a group with write access have
permission to modify the instance if they also have row-level access and the CMDB Data
Viewer role. This permission is useful for giving someone write access to a specific instance
without giving write access to all instances with one of the CMDB Data Change roles.
If you have row-level access to an instance but not the CMDB Data View role, you cannot view the
instance. If you have the CMDB Data Change role but not row-level access to an instance, you
cannot view or modify the instance. The CMDB Data View All and CMDB Data Change All roles
have row-level access to all instances and do not depend on the CMDBRowLevelSecurity
attribute.
For example, suppose a service provider has created groups named Solaris Group and
WindowsGroup. The service provider wants the SolarisGroup to have write access to certain CIs,
and the WindowsGroup to have read access to those CIs. The service provider assigns both
groups to the CMDB Data View role, and then adds those groups to the CMDBRowLevelSecurity
attribute value for each CI, giving everyone read access to those CIs. You then add the
SolarisGroup to the CMDBWriteSecurity attribute for the CIs he wants them to be able to modify.
The following table shows another example. Joe is a member of the Service Desk group and has
the CMDB Data View role, and Jane is a member of the Change Team group and has the CMDB
Data Change role. They are both members of the All Hands group.
Example instance permissions using roles and security attributes
BMC Atrium Core 9.0
Page 404 of 2268
Home
InstanceId
attribute
CMDBWriteSecurity
attribute
Joe can
read
NULL
NULL
NULL
Service Desk
Service Desk
NULL
Yes
Service Desk
Service Desk
Yes
Change Team
NULL
All Hands
NULL
Yes
All Hands
Service Desk
Yes
Joe can
write
Jane can
read
Jane can
write
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Neither user can read or write to instances 1 and 2, which have no group specified for row-level
security. Neither write security nor the CMDB Data View and CMDB Data Change permission roles
have any effect without row-level security.
Recommendations
You can automatically configure row-level security at the instance level using the Normalization
Engine. The Normalization Engine includes rules that set the row-level and attribute-level
permissions on CIs as you define them. For more information, see Normalization and instance
permissions .
If BMC Atrium CMDB represents just one organization, use the CMDB Data View All and CMDB
Data Change All roles for users. If you are using BMC Atrium CMDB for a multitenancy
environment, use the CMDB Data View and CMDB Data Change roles with the
CMDBRowLevelSecurity and CMDBWriteSecurity attributes.
Note
BMC Remedy IT Service Management (ITSM) uses instance permissions by means of the
Company field. If you are planning to use BMC Remedy ITSM, see Configuring
multi-tenancy before implementing instance permissions.
Related Topics
Tenancy mode
Using the multi-tenancy mode
Specifying permissions to instances in BMC Atrium CMDB

You must specify the proper row-level access to instances in the BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 405 of 2268
Home
Before you begin

Carefully read Working with CIs and relationships for information about working with CI and
relationship instances.
To specify instance permissions

1. In BMC Atrium Explorer, add the instances that you want to create or edit into a Sandbox
view.
2. Right-click an instance and then click Edit.
The instance appears in a class form
or
If you have BMC Remedy ITSM installed, the Asset view of the instance is displayed.
To view the class form use the following URL:
http://<midtier>:<port>/arsys/forms/<ar server>/<form name>
3. Search for the instance in the sandbox data set.
4. Set the value of the CMDBRowLevelSecurity or CMDBWriteSecurity attribute to a
group name or list of group names.
Tip
Enter the Group ID instead of the Group Name. Do not enclose the Group Name in
single quotes (for example, 'AdminGroup'.
BMC Atrium Core 9.0
Page 406 of 2268
Home

6. In BMC Atrium Explorer click, Promote Sandbox Changes
The Promotion Preview dialog box is displayed.

7. Select the instance and click Promote.
Configuring default permissions of classes

You can use the BMC.CORE.CONFIG:BMC_DefaultAccountPermissions form to configure the
default permissions of classes in the BMC Atrium CMDB.
Before you begin
To configure default permissions
Default instance permissions of classes
BMC.CORE.CONFIG:BMC_DefaultAccountPermissions form
BMC Atrium Core 9.0
Page 407 of 2268
Home
Before you begin

Carefully read Working with CIs and relationships for information about working with CI and
relationship classes.
Review Default instance permissions of classes to specify CMDBRowLevelSecurity and
CMDBWriteSecurity values for an entire class.
To configure default permissions

1. Open the BMC.CORE.CONFIG:BMC_DefaultAccountPermissions form in New request
mode.
Use the following direct access URL to open the form:
http:<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/
BMC.CORE.CONFIG:BMC_DefaultAccountPermissions
2. In the MATCHAccountID field, type the name of a specific account or type default to match
all accounts for which you do not specify permissions.
3. In the MATCHAppliedToClassId field, type the class ID of a BMC Atrium CMDB class or
type default to match all classes for which you do not specify permissions.
Note
BMC Atrium Core 9.0
Page 408 of 2268
Home
The class ID is case sensitive and might not be the same as the class name. For
example, the BMC_ComputerSystem class has a class ID of
BMC_COMPUTERSYSTEM. For more information about the class ID of a specific
class, see the BMC Atrium CMDB Data Model Help .
4. In the ASSIGNRowLevelSecurity field, enter the Group IDs (instead of the Group Names)
that you want to have row-level security for new instances, separated by spaces.
You can use any BMC Remedy AR System group or role, such as those listed in BMC
Atrium Core permission roles within applications. The field menu appends selections to the
value currently in the field.
5. In the ASSIGNWriteSecurity field, enter the Group IDs (instead of the Group Names) that
you want to have write security for new instances, separated by spaces.
Note
In this procedure, you are creating a new instance of the
BMC_DefaultAccountPermissions class. In addition to the previously specified
attribute fields, which are relevant to the default permissions that you want to
create, you can set permissions on this instance by entering group names in the
CMDBRowLevelSecurity and CMDBWriteSecurity fields, or you assign it to an
account by typing an AccountName value. Do not enter values in the remaining
fields.
6. Click Save.
Default instance permissions of classes

Default instance permissions allow you to specify CMDBRowLevelSecurity and
CMDBWriteSecurity values for an entire class instead of specifying them every time you create
an instance of the class. You can give these permissions to a different group for each account ID,
which supports multitenancy by enabling you to grant users access to only the instances for their
account.
Using the BMC_DefaultAccountPermissions form, you specify default permissions with the
BMC_DefaultAccountPermissions class, a special class in the BMC.CORE.CONFIG
namespace. Each BMC_DefaultAccountPermissions instance can grant both row-level and
write security. You can specify the class and account it applies to, or allow it to apply more broadly
by using the keyword default.
Note
BMC Atrium Core 9.0
Page 409 of 2268
Home
In the Class Manager, you can find the BMC_DefaultAccountPermissions class as a

subclass of the BMC_ConfigBaseElement base class.
The AccountID and ClassId attributes of every new instance are compared against the
MATCHAccountID and MATCHAppliedToClassId attributes in
BMC_DefaultAccountPermissions. The BMC_DefaultAccountPermissions instance with
the lowest precedence number as shown in the following table supplies permissions for the new
instance. If no instance matches and you do not supply values for the CMDBRowLevelSecurity
or CMDBWriteSecurity attribute of the instance, no user has that level of security for the instance
.
BMC_DefaultAccountPermissions matching precedence

Precedence
Account matching
Class matching
MATCHAccountID matches AccountID on instance
MATCHAppliedToClassId matches ClassId on

instance
MATCHAccountID matches AccountID on instance
MATCHAppliedToClassId is default
MATCHAccountID is default
MATCHAppliedToClassId matches ClassId on

instance
MATCHAccountID is default
MATCHAppliedToClassId is default
Default permissions are applied to an instance only when it is created. If you later change the
permissions mappings in BMC_DefaultAccountPermissions, the permissions on existing
instances are not updated. In that case you must edit the instances manually to match the new
permissions.
Note
If you supply values for CMDBRowLevelSecurity and CMDBWriteSecurity when
creating an instance, those values are appended to the default permissions. Both values
are saved at instance creation.
For example, given the BMC_DefaultAccountPermissions instances in the following table, a

new instance of BMC_ComputerSystem with an AccountID of Calbro Services would have the
Service Desk group placed in both its CMDBRowLevelSecurity and CMDBWriteSecurity
attributes. An instance of BMC_Monitor with an AccountID of Calbro Services would have the
Service Desk group placed in its CMDBRowLevelSecurity attribute and the Change Team group
placed in its CMDBWriteSecurity attribute.
BMC Atrium Core 9.0
Page 410 of 2268
Home
Example instances of BMC_DefaultAccountPermissions

MATCHAccountID
MATCHAppliedToClassId
ASSIGNRowLevelSecurity
ASSIGNWriteSecurity
default
BMC_COMPUTERSYSTEM
10333
20008
(Group ID for All Hands group)
(Group ID for Problem Master group)
20008
20008
20008
20013
(Group ID for Change Master group)
20013
20013
Calbro Services
Calbro Services
default
default
BMC_MONITOR
default
Permission scenarios when managing user access to BMC

Atrium CMDB data
BMC Atrium CMDB provides the following methods of managing user access to data:
Application roles
Class and attribute permissions
Instance permissions
The following table lists different scenarios of how data access-control might be configured for read
and write access to a class and an instance of that class, and what happens when Joe Unser, an
employee at Calbro Services, tries to read or modify that instance.
Data-access scenarios for reading and writing data
Member
of CMDB
Data View
role?
Member of
CMDB
Data
Change
role?
Class
permission
Permission
for all
attributes
CMDB
RowLevel
Security
access?
CMDB
Write
Security
access
?
Result
N/A
Yes
Visible
View
Yes
N/A
Joe can see the class in his list of objects, and

can see all attributes of the class. Joe can view
and modify the instance.
Yes
No
Visible
View
Yes
No

can see all attributes of the class. Joe can see
the instance, but when he tries to modify the
instance, he sees a permission error.
N/A
Yes
BMC Atrium Core 9.0
Visible
View
N/A
No

can see all attributes of the class. Joe can see
the instance, but when he tries to modify the
instance, he sees a permission error.
Page 411 of 2268
Home
Member
of CMDB
Data View
role?
Member of
CMDB
Data
Change
role?
Class
permission
Permission
for all
attributes
CMDB
RowLevel
Security
access?
CMDB
Write
Security
access
?
Result
N/A
Yes
Hidden
N/A
N/A
Yes
Joe cannot see the class in his list of objects.

However, Joe can modify the data on that
instance through workflow started in another
class.
No
No
Visible
Change
N/A
N/A

can see all attributes of the class. Joe can view
and modify the instance.
Managing dataset level permissions

The following topics discuss the concepts of dataset level permissions.
Understanding dataset level permissions
To assign permissions to a dataset
Understanding dataset level permissions

For fresh installations and upgrades, all users have read and write access to the data in the
datasets. All users, provided they have appropriate permissions, can perform create, read, update,
and delete operations on the data. However, you can restrict certain users from making changes to
the data. You can do this using the dataset level permissions, which ensures data security at the
dataset level.
Dataset level permissions can be configured only for user groups or user roles and cannot be
configured for individual users. When user groups or user roles are assigned permissions for a
particular dataset, the users of that groups or roles get read and write access for the assigned
dataset. All other user groups or roles continue to have only read access to the particular dataset.
Note
Remedy Application Service (RAS) is a user account used by Remedy applications for
integration with other Remedy applications. This account and the accounts used by
Installers, Distributed Servers and Escalation are treated as special accounts. They are
excluded from dataset permissions.
Example:
ADDMGroup and OtherGroup have access to BMC.ADDM dataset. By default, all users belonging
to these user groups have permissions to create, read, update, and delete data. Consider that
ADDM administrator does not want other users to modify the data in the BMC.ADDM dataset. The
administrator configures dataset permissions for BMC.ADDM dataset and selects a ADDMGroup,
BMC Atrium Core 9.0
Page 412 of 2268
Home
thereby allowing users of ADDMGroup to create, read, update, delete data in BMC.ADDM dataset.
However, the users of OtherGroup will continue to have read access to data in BMC.ADDM dataset
.
To assign permissions to a dataset

The following steps explain how to assign dataset permissions:
1. In the Atrium Core Console, open the Dataset Configuration application
2. Select the desired dataset. In the Permissions list, select the desired group and roles.
Dataset Configuration
3. Click Save.
BMC Atrium Core 9.0
Page 413 of 2268
Home

The Product Catalog provides definitions of the products used within companies and organizations,
allowing you to manage products by approval status, categorization, development status, and other
attributes. The Product Catalog provides data for normalizing CIs.
Overview of the BMC Atrium Core Product Catalog
Product Catalog and multitenancy
Populating the Product Catalog
Product categorization
Updating the Product Catalog data
Normalization and the Product Catalog overview
Managing Product Catalog entries in bulk
Exporting Product Catalog data
Overview of the BMC Atrium Core Product Catalog

A part of BMC Atrium CMDB, the Product Catalog manages products for companies and
organizations. In version 7.5.00, the BMC application called Definitive Software Library (DSL) was
renamed as BMC Atrium Product Catalog (Product Catalog).
The Product Catalog has several purposes:
Provide identifying characteristics of products as product metadata
Provide a single name for each product and its versions
Manage products by categorization, life cycle, development status, approval status, and
other attributes
Manage products by companies and organizations (multitenancy)
Provide data for normalization and discovery, including storage of product signatures
The following topics describe the Product Catalog in more detail.
Product Catalog components
Advantages of using the Product Catalog
Product Catalog data
DML, DHL, and approved products
Product Catalog and normalization example
Platform and operating system support in the Product Catalog
Product Catalog status options
Multitenancy support in the Product Catalog
Product Catalog and Software License Management
Product Catalog permissions
Accessing the Product Catalog
BMC Atrium Core 9.0
Page 414 of 2268
Home
Understanding the Product Catalog Console

Product Catalog and DML documentation for other BMC applications

The following components make up Product Catalog:
The Product Catalog is a library of all software products, hardware products, and services
available to an organization, and it defines products and their class attributes, such as
Model (Product name), ManufacturerName, VersionNumber, MarketVersion,
Category, Type, and Item. Before discovery tools create or update configuration items (
CIs) in BMC Atrium CMDB, the Normalization Engine verifies the CI data with the product
information in the Product Catalog.
The Company form enables you to create companies or organizations and their information
so that you can associate products, versions, and patches with them.
The Sites form enables you to create a site for each company location, including time zone,
address, and region.
The Definitive Media Library (DML) is a subset, or filter, of the Product Catalog and
represents software products that an organization approves for its use.
The Definitive Hardware Library (DHL) is also a subset, or filter, of the Product Catalog and
represents hardware products that an organization approves for its use.
BMC Atrium Core 9.0
Page 415 of 2268
Home
Advantages of using the Product Catalog

The Product Catalog entries give an IT professional the following advantages:
In procurement, BMC Asset Management chooses a normalized application name from the
Product Catalog when ordering software.
In license management, you can associate license certificates with products in the Product
Catalog that are normalized.
In license compliance, you can compare discovered applications with licenses by using
normalized names in the Product Catalog and provide meaningful reports of over- and
under-licensed software.
You can have software in the DML with normalized names in the Product Catalog to make
easy comparisons across the enterprise.
Using the Product Catalog enables IT to always see an application as one complete entity, whether
IT is buying it, associating license contracts with it, packaging it, deploying it, discovering it, or
referring to its usage.
BMC Atrium Core 9.0
Page 416 of 2268
Home
Product Catalog data

The Product Catalog data, not the DML, is used to normalize discovered data. The Product Catalog
entries are the definitive, or master, names and descriptions of products, including hardware,
software, network devices, and services. The Product Catalog entries are ordered according to
version. For the exact versions, you can specify a Storage Location for the master.
Each Product Catalog entry can have an accompanying model or version and a patch. For software
products, you can also set a Market Version in the Product Catalog entry. The software license
management engine in BMC Asset Management uses the Market Version to determine whether
that Product Catalog entry must have a related software license contract. For more information
about the Market Version, see Product Catalog and Software License Management .
In addition to Product Catalog entries and Storage Locations, another component of the Product
Catalog is the Product Suites, which are groups of one or more Product Catalog entries. For
example, the Microsoft Office suite contains the Word, Excel, Powerpoint, and Outlook products.
The Product Catalog enables application administrators to facilitate software license management
and software deployment by adding or modifying Product Catalog entries, Storage Locations, and
Product Suites, using the Product Catalog Console.
DML, DHL, and approved products

The Definitive Media Library (DML) is an IT Infrastructure Library (ITIL) concept. In ITIL version 3,
the Definitive Media Library replaced the Definitive Software Library that was in version 2. The DML
is the software products that an organization has reviewed and authorized for use in its production
environment. You can define the DML by selecting the Approved option for a product, version, or
patch. With the 7.5.00 release of the BMC Atrium Core product, the Definitive Software Library (
DSL) product was renamed to BMC Atrium Product Catalog (Product Catalog). The DML in the
Product Catalog stores all products, not just those specified in an ITIL DSL or DML.
In the Product Catalog, you can approve products and specify their storage location. The DML
contains the metadata of master product copies and includes not just software metadata but also
the metadata of other types of media, such as databases and files. Configuration items (CIs) that
are stored in BMC Atrium CMDB can include software, release packages, patches, system images,
and so on.
An organization can manage its approved software using the DML, making the DML
customer-specific.
As the DML defines approved software, the Product Catalog uses the Definitive Hardware Library (
DHL) as a repository of all approved hardware products in an organization. In the Product Catalog,
you can approve hardware products and define their storage location. The CIs of the hardware
products are stored in BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 417 of 2268
Home
The procedure to approve products for the DHL is the same as approving products for the DML.
For more information, see Approving and managing products, versions, and patches in the Product
Catalog. Multitenancy is also supported for DHL.
Approved products in the DML and DHL

When you install the Product Catalog, the DML and DHL are initially empty. To populate the
libraries with product entries, you must approve the products in the Product Catalog.
You can approve products in the Product Catalog in the Company and Module Relationships area
of the PCT: Product Catalog Setup form. For more information about approving products, see
Approving and managing products, versions, and patches in the Product Catalog .
You can search for products in the DML or DHL from the Product Catalog Console by selecting
them in the Product Catalog View.
Multitenancy with the DML and DHL

Multiple organizations can access the software and hardware products from the Product Catalog
and maintain separate DMLs and DHLs. With multitenancy support, you can approve products for
different organizations. Each organization can manage and approve its own products without being
affected by other organizations sharing the same Product Catalog. For each organization, you can
approve items at the product, version, or patch level.
For more information about multitenancy, see Multitenancy support in the Product Catalog .
Product Catalog and normalization example

The following figure shows how a discovery tool finds an application in a server environment and
how BMC Atrium CMDB normalizes that CI using the Product Catalog information. If the Product
Catalog Key, Signature ID, product name, manufacturer name, version, or file name and size are
specified in both the Product Catalog and in the discovered instance, the Normalization Engine can
update BMC Atrium CMDB with the normalized name by using the attributes in the following order:
1. Dictionary ID (Product Catalog Key) Provided by the Product Catalog to identify each
entry uniquely. In the Product Catalog, the Dictionary ID is defined in the
patchInstanceId attribute.
2. Signature ID Stored in the Product Catalog and created by discovery tools for identifying
products.
3. Product attributes The Model, ManufacturerName, VersionNumber, and
MarketVersion, attributes of the CI.
4. File name and file size
BMC Atrium Core 9.0
Page 418 of 2268
Home
Example of normalizing discovered data with the Product Catalog
Platform and operating system support in the Product Catalog

The Product Catalog supports data providers populating platform and operating system information
for the product model and version. This support allows a product to have multiple entries for the
same product and version, with different platforms and operating systems. You can then create
patches that are specific to a combination of operating system and platform.
For example, if you searched for Oracle Enterprise 10.2 in the Product Catalog, you could have the
following results:
Example of version with multiple platforms and operating systems
Product
Version
Platform
Operating system
Oracle Enterprise
10.2
Microsoft Windows
Windows 2003
Oracle Enterprise
10.2
UNIX
Oracle Solaris 9
Oracle Enterprise
10.2
UNIX
Solaris 10
Oracle Enterprise
10.2
UNIX
HP-UX 11
Oracle Enterprise
10.2
UNIX
Red Hat Linux AS 3.0
BMC Atrium Core 9.0
Page 419 of 2268
Home
To search for products by platform or operating system, you must use the Advanced Search field in
the Product Catalog Console. For more information about searching for products, see Viewing and
searching for products in the Product Catalog .
For each platform, you must create a separate model/version entry and specify the platform and
operating system. For each version, you can then add a patch for that platform and operating
system. For more information about modifying the list of platforms, see Modifying the list of
platforms in the Product Catalog.
Product Catalog status options

The Product Catalog has several status options that can be used to manage the products in your
organization. You can set these options at the product, version, and patch levels. When you set the
status options for a product, the associated versions and patch entries also have their options set
implicitly (through workflow).
Note
Status settings are propagated only downstream, from a product to the version and patch.
The Product Catalog does not propagate status settings upstream, from a patch to the
version and product.
To allow for each company to have its own status options for each product, you must set the status
options when relating a product to a company. For more information, see Multitenancy support in
the Product Catalog and Relating companies to Product Catalog entries .
You can set these options for individual Product Catalog entries, or for many entries at the same
time. For more information, see Approving and managing products, versions, and patches in the
Product Catalog and Bulk actions for managing Product Catalog entries .
The Product Catalog provides the following status options:
Approved Product Use the Approved status to authorize a product to be installed in the
organizational environment.
Approved products are in the DML or DHL, depending on whether they are software or
hardware.
Note
BMC Atrium Core 9.0
Page 420 of 2268
Home
If the Allow Unapproved CIs option is enabled in the Normalization console, the
Normalization Engine normalizes CIs of the products that are not approved in the
Product Catalog. If this option is disabled, CIs are still created for the unapproved
products but the NormalizationStatus attribute for those CIs is set to
Normalized Not Approved. By default, the NormalizationStatus attribute is
hidden on all BMC Atrium CMDB class forms.
Managed Product Use the Managed status to track the product in your organization.
You can configure BMC Atrium CMDB so that CIs for unmanaged products are deleted from
the CMDB. In this way, you can leverage the Managed status to purge unnecessary CIs that
are populated in the BMC Atrium CMDB datasets by discovery tools. For more information,
see Using the Managed Product status to delete unwanted CIs in bulk .
BMC applications, such as BMC Remedy IT Service Management (BMC Remedy ITSM),
can also interpret the Managed Product status and take actions, such as manage CIs in
BMC Atrium CMDB.
Blacklisted Product Use the Blacklisted status to mark a product as a security risk.
The Product Catalog does not do anything when this option is set; instead, other applications
, such as BMC Remedy ITSM, can interpret and use this option to manage products or CIs
in BMC Atrium CMDB. For example, you can use this option to create a ticket to remove the
blacklisted product from the organizational environment.
Hidden Product Use the Hidden status to disable the display of a product in the Product
Catalog Console.
Hidden products remain in the Product Catalog and appear in search results if they match
the criteria. You can use this option to reduce the number of displayed products in the
Product Catalog Console.
Product Life Cycle Use the Life Cycle status to specify a product's phase, which a product
such as BMC Remedy ITSM could use to define actions. For example, you could decide that
patch 2 of a finance application can only be installed in the production environment only if it
is marked as Released.
Development The product is being created or assembled and is not yet tested.
Test The product has completed development but is being validated.
A Test product could be approved for a select group of people for testing purposes.
Released The product has completed development and testing, and it is ready for
use in the production environment.
Normalized Product The Normalized Product status indicates to the Normalization Engine
to use the alias that has been defined for the product.
For more information about aliases, see Creating a product alias in the Product Catalog .
Multitenancy support in the Product Catalog

allows you to have a single Product Catalog shared among multiple organizations but tracks the
approved products for each organization from the same Product Catalog data.
BMC Atrium Core 9.0
Page 421 of 2268
Home
For each organization, you can define the approved items for the version and patch levels, not just
the product name. All the other options in the Product Catalog are separated for each products by
organization as well, such as the following status options:
Managed (Product/Version/Patch)
Blacklisted (Product/Version/Patch)
Normalized (Product/Version/Patch)
Hidden (Product/Version/Patch)
Life Cycle (Product/Version/Patch): values are Deployment, Released, and Test
The (Product/Version/Patch) represents the label provided under each company association.
For more information about these status options, see Product Catalog status options.
Multitenancy can also be used when a smaller company is part of another company and their
finances are managed separately. For example, Calfin Services is a part of Calbro Services. Their
finances are managed separately. Both companies use the same Product Catalog. With
multitenancy, they can access products that are approved for their own organizations.
Calbro Services can track the software and hardware approved for each company. Rather than
create a separate Product Catalog for each company, Calbro Services uses one Product Catalog to
manage the approved software and hardware for Calbro Services and Calfin Services. The
following table shows what Oracle versions Calbro Services and Calfin Services have approved.
Software
Calbro Services approved versions
Calfin Services approved versions
Oracle 9i
9.2
9.2, 9.3
Oracle 10g
10.1, 10.2
None
The approval, status, and other flags are segregated by company so that Calbro Services does not
use Oracle versions approved by Calfin Services. Calfin Services has not approved versions of
Oracle 10g and does not see them as approved, even though Calbro Services has approved them.
Only the 9.2 version of Oracle 9i is globally approved.
For more multitenancy and Calbro Services examples, see Multitenancy example - Calbro Services
and Calfin Services.
Product Catalog and Software License Management

The Product Catalog entries are the definitive, or master, names and descriptions of software
products and enable the effective management of software licenses in the production environment.
Software titles are discovered by products such as BMC Atrium Discovery and BMC BladeLogic
Client Automation Configuration Discovery Integration for CMDB. These discovered CIs are
normalized by the Normalization Engine, which (after applying Version Rollup and alias rules)
compares the CIs against the Product Catalog entries.
BMC Atrium Core 9.0
Page 422 of 2268
Home
Software License Management and product versions

Software License Management and product suites
For more information about how the Normalization Engine and the Product Catalog fit together and
interact to normalize configuration items (CIs), see Normalization and the Product Catalog (PC) .
Software License Management and product versions

Each Product Catalog software entry can have accompanying version and patch information.
However, you must set the Market Version for a Product Catalog entry if you plan to use the BMC
Asset Management product to manage software licenses in your production environment. BMC
Asset Management refers to the Market Version of a product entry to determine whether that
Product Catalog entry must have a related software license contract. This feature helps maintain
certificates because instead of relating each minor version to the certificate, you can relate only the
Market Version of the product to the certificate.
To normalize the MarketVersion attribute for CIs, you can manually specify the Market Version
for a product entry in the Product Catalog or use Version Rollup rules in the Normalization Engine.
The Version Normalization feature uses Version Rollup rules to normalize multiple version strings to
a common market version value (MarketVersion ), based on default or custom rules.
You can take advantage of manufacturer aliases to reduce the number of Version Rollup rules
required. To do so, make sure that the Manufacturer Name field in the Product Catalog, the
ActualName field in the manufacturer alias, and the Manufacturer Name field of the
corresponding Version Rollup rule, all have the same manufacturer name value.
For information on manufacturer aliases, see Product name and manufacturer normalization aliases
in the Product Catalog.
For information about manually specifying the MarketVersion value, see, To add product model
and version information.
For more information about the Version Normalization feature, see Normalization steps and the
Product Catalog and Configuring Version Rollup normalization rules.
Note
If a CI instance corresponds to a Product Catalog entry for which MarketVersion is set
and the CI instance also maps to a Version Rollup rule, the MarketVersion value in the
Version Rollup rule has higher priority by default. However, you can change the default
configuration to assign higher priority to the Product Catalog in the Normalization Engine.
For more information, see Priority of Version Rollup rules and Product Catalog entries .
BMC Atrium Core 9.0
Page 423 of 2268
Home
Software License Management and product suites

The Product Catalog also stores information about product suites, which are groups of one or more
Product Catalog entries. For example, the Microsoft Office suite contains the Word, Excel,
PowerPoint, and Outlook products. For more information about defining suites in the Product
Catalog, see Adding products to a suite in the Product Catalog .
You can also use the Suite Rollup feature in the Normalization Engine to create suites and
associate existing Product Catalog entries as components of the suites. The Suite Rollup feature
enables you to create rules that identify CI instances as a suite or suite component. For more
information about the Suite Rollup feature, see Configuring Suite Rollup normalization rules.
Product Catalog permissions

To configure or use the Product Catalog, you must be a member of a group that has one of the
assigned permission roles listed in the following table.
Note
Permission roles can overlap, with one role sometimes taking precedence over another
role. As a result, you should be careful what roles and permissions that you assign to your
users, because your selections can have unexpected results. For example, for each user,
you should select either Atrium Foundation Viewer permissions or Atrium Foundation
Admin permissions, but not both.
For more information about BMC Atrium Core permissions and how to assign them, see BMC
Atrium Core permission roles within applications.
Note
Make sure that the AR User Fixed license is installed, to enable you to access and use
the Product Catalog.
Product Catalog permission roles

Role name
What members of groups with this role can do
Atrium Foundation
Viewer
View records for Product Catalog products, versions, patches, files, suites, storage (software library
items), and signatures.
Atrium Foundation
Admin
BMC Atrium Core 9.0
Create, modify and delete records for Product Catalog products, versions, patches, files, suites,
storage (software library items), and signatures.
Add and remove Product Catalog relationships.
Page 424 of 2268
Home
Role name
What members of groups with this role can do
General Access
Access to non-product information, such as BMC Atrium CMDB Online Help, public forms or data, etc.
Atrium Foundation Data

Management
This permission is required to load data from the Load forms to Product Catalog using the Job Console.
Accessing the Product Catalog

You can manage the Product Catalog by using the Product Catalog Console or the APIs.
Product Catalog Console access

1. Enter the following URL, and log on:
http://<midtierServer>:<portNumber>/arsys
2. From the Application Launcher menu, select Applications > Product Catalog > Product
Catalog Console.
For more information about accessing the BMC Atrium Core Console, see Accessing the BMC
Atrium CMDB and BMC Atrium Core applications .
API access
You can programmatically manage the Product Catalog by using the BMC Remedy AR System
APIs, including Oracle Java, C++, web services, and forms. For more information, see Developing
an API program in the BMC Remedy Action Request System online documentation.
Understanding the Product Catalog Console

The Product Catalog Console consists of areas, as shown in the following figure:
Product Catalog View This area contains the options for defining what is displayed in the
Product Catalog Entries list, including displaying all products, all software or hardware
products, or only approved hardware or software products.
Search Criteria This area contains options for searching the Product Catalog.
Product Catalog Entries This area contains a list of Product Catalog entries and their
versions.
Products in Suite If a Product Catalog entry is part of a suite, the name of that suite
appears in this area. If a Product Catalog entry is identified as a suite, the list of products in
that suite appears in this area.
Storage Location This area contains the location of a Product Catalog entry, such as a
physical location, a path to a location, or a URL.
Product Files Product Catalog entries are made up of one or more files. These files are
represented in this area as metadata, and are not the actual files.
Product Catalog Console
BMC Atrium Core 9.0
Page 425 of 2268
Home
Product Catalog and DML documentation for other BMC applications

For information about using the Product Catalog with specific BMC applications, see the following
documentation.
Note
BMC BladeLogic Client Automation documents are available from the BMC Customer
Support website, located at http://support.bmc.com.
BMC BladeLogic Client Automation Report Center User Guide , which describes predefined
DML queries located in the Report Center Query Library. For details, see the Service
Management integration information.
BMC BladeLogic Client Automation Application Packager User Guide , which describes how
to store packages created in Application Packager as a Storage Location within the Product
Catalog.
BMC BladeLogic Client Automation Configuration Discovery Integration for CMDB Getting
Started Guide, which describes how to use the DML in conjunction with BMC Atrium CMDB
and BMC BladeLogic Client Automation Configuration Discovery Integration for CMDB.
BMC BladeLogic Client Automation Transmitter and Proxy User Guide , which describes how
to configure the master transmitter and CMS to work with the DML.
BMC Atrium Core 9.0
Page 426 of 2268
Home
BMC Configuration Automation for Clients Reference Guide (part of the BMC BladeLogic
Client Automation documentation), which describes how to use Content Replicator to store
data as a Storage Location within the Product Catalog.
BMC Asset Management documentation, located at https://docs.bmc.com/docs/display/
asset81, which describes how to use the DML within the Asset Management system.
BMC Change Management documentation, located at https://docs.bmc.com/docs/display/
change81, which describes how to use the DML within the Change Management system.
Product Catalog and multitenancy

Multitenancy scenarios
Company types
The Product Catalog supports defining approved products for different companies. Multitenancy
allows you to have a single Product Catalog shared among multiple companies but tracks the
approved products for each company from the same Product Catalog data. For each company, you
can define the approved items for the product, version, and patch levels. Similarly, the Managed,
Blacklisted, Mark for Deletion, Hidden, Life Cycle, and Status attributes in the Product Catalog are
also defined for each product by company.
Note
You can also set up multiple companies to represent organizations or groups within a
single company. For example, you can set up companies to represent the Finance,
Human Resources, Administration, and Sales organizations within a company.
The Product Catalog includes forms for creating and updating company and site information.
Although the Site and Region forms are part of the Product Catalog, they are mostly referred to and
used by BMC Remedy IT Service Management. For more information, see the BMC IT Service
Management online documentation.
By default, Product Catalog entries are associated with the - Global - company and are available to
all companies or organizations. For information about associating Product Catalog entries with
specific companies, see Relating companies to Product Catalog entries .
Multitenancy scenarios
You can set up multitenancy in your environment in any of the following scenarios:
When a smaller company is part of another company and you want to manage access to
products separately. Both companies can use the same Product Catalog and access only
the products that are approved for their own organizations.
When you are managing the IT environment for various companies but want to track the
approved products for each company from the same Product Catalog.
BMC Atrium Core 9.0
Page 427 of 2268
Home
When you want to manage access to products based on the departments or organizations
within the same company. For example, you might want to approve the payroll management
application for the finance department only.
For more information about multitenancy, see Multitenancy support in the Product Catalog .
Company types
The Product Catalog supports different types of companies, as listed in the following table. You can
also define a company as a combination of different types such as Customer and Operating
Company.
Company types
Company type
Description
Supports
multitenancy
Customer
An external company for which you provide services.
Yes
Generic Contact
Other companies that you want to see included on the People form.
Yes
Manufacturer
A company that manufactures a product in the Product Catalog.
No
Operating
A company or business unit for which your company or organization provides
Yes
Company
services.
Supplier
Third-party supplier of products. Used by Asset Management.
No
Vendor
Third-party vendor that provides services for your company or organization.
Yes
Service Provider
A company that provides services and support to other companies
Yes
Overview of creating and managing companies and sites

You create and modify companies by using the COM:Company form. If you have BMC Remedy
ITSM installed, you can also create and modify a company by following the procedures described in
the BMC IT Service Management documentation .
After creating a company, you can define aliases for the company, which make searching for the
company easier see, [Defining aliases for a company. You can also update company information,
such as locations, contact information, and hours of operation.
You create and modify sites by using the SIT:Site form. Sites identify unique physical locations and
are associated with one or more companies. After you create a site, you can define aliases for the
site. You can also create a company relationship with the site.
The procedure to work with Company and Sites are discussed in details in the following related
topics.
Companies in the BMC Remedy ITSM Hub and Spoke configuration
Creating a company
Defining aliases for a company
BMC Atrium Core 9.0
Page 428 of 2268
Home
Updating company information

Creating a site
Defining aliases for a site
Creating a company relationship with a site
Companies in the BMC Remedy ITSM Hub and Spoke configuration

When a BMC Remedy ITSM environment is configured for Hub and Spoke, the Hub and Spoke tab
is enabled in the COM:Company form. When you create a company, you must associate that
company with a registered spoke server.
Note
In a Hub and Spoke configuration, you can create a company only on the BMC Remedy
ITSM server that is configured as the hub.
The Hub and Spoke configuration in BMC Remedy ITSM enables a service provider company (the
hub) to set up the logical topology that is required to support multiple operating companies (the
spokes) while ensuring strict data security between the service provider and individual operating
companies.
When an environment is configured for Hub and Spoke, a member of the service provider's support
staff can log on to the hub and work with records from any of the operating companies that the
support staff person is registered with. The hub server receives and stores only the transactional
data from the original record (for example, company name, client name, record type, and record ID
number). The rest of the record's data remains securely on the spoke server. The hub server then
displays the transactional data in the corresponding application console on a workstation with the
service provider. On this workstation, a member of the support staff can perform all of the
centralized functions related to the record.
For more information about configuring Hub and Spoke, see the BMC IT Service Management
documentation.
Creating a company
When you create a company, the status of that company is set to Enabled by default. Depending
on the status, the company is available for selection in other forms, such as the Company and the
Module Relationships forms.
Note
You must be in the Administrator group to create companies.
BMC Atrium Core 9.0
Page 429 of 2268
Home
To create a company
1. On the server configured as the hub, open the COM:Company form in New mode as an
administrator:
a. Enter the direct URL for the form by using the following syntax:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemHubServer>/COM:
Company
b. When prompted, log on as an administrator.
The form opens in Search mode.
c. Click New Request.
2. In the Company field, enter the company or organization name.
3. From the Type list, select the company type from the items described in Product Catalog
and multitenancy.
4. From the Status list, select the company's status.
Note
If you are using BMC Asset Management and BMC Atrium Discovery, do not set
companies to offline in BMC Asset Management if they are used to set the
ManufacturerName attribute in a BMC Atrium Discovery CI. Doing so causes
BMC Atrium Discovery to fail when creating CIs with those companies as
Manufacturer.
5. (Optional) In the Company ID field, enter a unique external identifier for the company.
Note
BMC Asset Management can use the Company ID field to store the Supplier ID
data.
6. (Optional) In the Abbreviation field, enter the abbreviated version of the company name.
7. (Optional) In the Category field, enter a category that describes the type of company you
are creating.
8. (Optional) In the Description field, enter detailed information about the company.
9. From the Spoke Server list on the Hub and Spoke tab, select a registered spoke server
with which you want to associate the company.
Note
BMC Atrium Core 9.0
Page 430 of 2268
Home
The Hub and Spoke tab is displayed only when you have installed BMC Remedy
ITSM and configured Hub and Spoke. For more information about configuring Hub
and Spoke, see the BMC IT Service Management 8.0 documentation, located at
https://docs.bmc.com/docs/display/itsm81.
If you do not select a spoke server and then try to save the company, a message (error
48510) is displayed.
10. Click Save.
If you try to create a company on the BMC Remedy ITSM system that is configured as a
spoke, a message (error 48509) is displayed.
Defining aliases for a company

A company alias is another term that you can use to reference a company. If a company is known
by more than one name, you can create aliases for all of those names so that a search finds the
company regardless of the name specified.
To create or modify a company alias

1. From the Company list in the COM:Company form, select a company.
2. From the Alias tab, click Update Alias.
3. Perform one of the following actions in the Company Alias Update window:
Enter a company alias into the field at the top of the window and click Add.
Tip
If your underlying database is case-sensitive, creating a company alias in
lowercase enables users to add information in uppercase or lowercase.
Select the company alias to modify, update the alias name, and click Modify.
4. Click Close.
The company alias appears in lists for the Company field on forms.
Updating company information

After you have created a company, you can define the company locations, company contact
information, and company time information (hours of operation). Company locations are sites that
represent a physical location (such as a building) for a company.
To create locations
To add company contact information
To add company time information
BMC Atrium Core 9.0
Page 431 of 2268
Home
To create locations
2. Click the Locations tab.
3. Click Update Locations.
Note
The Update Locations button is enabled only if you have installed BMC Remedy
ITSM and have logged in as a user with the Contact Location role.
4. In the Location Update window, complete the following fields:

In the Site field, enter the site name.
In the Country field, enter the name of the country.
In the City field, enter the name of the city.
5. Click Add.
6. When you are finished configuring the company locations, click Close.
To add company contact information

2. From the Miscellaneous tab, complete the following fields:
Company contact fields
Field
Description
Hot Line
The main number for the company.
Email
The primary email address for the company.
Web Page
The URL of the primary website for the company.
3. Click Save.
To add company time information

2. From the Miscellaneous tab, complete the following fields:
Company time fields
Field
Description
Hours of Operation
The business hours of the company location.
Time Zone
The time zone of the company location.
3. Click Save.
BMC Atrium Core 9.0
Page 432 of 2268
Home
Note
If you have BMC Remedy ITSM installed, you can also create and modify an organization
by following the procedures described in the BMC IT Service Management 8.0
documentation, located at https://docs.bmc.com/docs/display/itsm81.
Creating a site
When you create a site, the status of that site is set to Enabled by default. Depending on the status,
the site is available for selection in other forms.
Note
You must be in the Administrator group to create sites.
To create a site
1. Open the SIT:Site form in New mode as an administrator:
a. Enter the direct URL for the form by using the following syntax:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/SIT:Site
b. When prompted, log on as an administrator.
The form opens in Search mode.
2. In the Site Name field, enter the site name.
3. From the Status list, select the company's status.
4. In the Address Information tab, from the Country list, choose a country.
5. In the City field, enter the name of the city.
6. Click Save.
Defining aliases for a site

A site alias is another term that you can use to reference a site. If a site is known by more than one
name, you can create aliases for all of those names so that a search finds the site regardless of the
name specified.
To create or modify a site alias

1. From the SIT:Site form, select a site.
2. From the Site Alias tab, click Update.
3. Perform one of the following actions in the Site Alias Update window:
Enter a site alias into the field at the top of the window and click Add.
BMC Atrium Core 9.0
Page 433 of 2268
3.
Home
Tip
If your underlying database is case-sensitive, creating a site alias in
lowercase enables users to add information in uppercase or lowercase.
Select the site alias to modify, update the alias name, and click Modify.
4. Click Close.
The site alias appears in lists for the Site field on forms.
Creating a company relationship with a site

You must have defined a company before creating a relationship.
To create a company relationship with a site

1. From the SIT:Site form, select a site.
2. From the Company Relationships tab, click Update.
3. From the Status list, select the status for the relationship.
Note
By default the status field value is selected to Enabled.
4. From the Company list, select an existing company.

5. Define the Region for the site.
6. From the Site Group list, select the group that the site is a member of.
7. Click Add.
8. Click Close.
Multitenancy example - Calbro Services and Calfin Services

This topic provides a scenario for multitenacy. Consider the following information before proceeding
further.
Andrew Admin is the administrator for both Calbro Services and Calfin Services, and has the
following permissions:
General Access
Andrew Admin configures the following users for these organizations:
Betty Admin for Calbro Services
Charlie Admin for Calfin Services
BMC Atrium Core 9.0
Page 434 of 2268
Home
Andrew Admin creates a user account each for Betty and Charlie and assigns the accounts
to the following groups to access the Product Catalog for their respective companies:
General Access
Automatically generated group for respective companies
To do this, Andrew Admin performs the following actions:
To create the Calfin company
To locate the group names for the Calfin and Calbro companies
To create Product Catalog users for the Calfin and Calbro companies
To create the Calfin company

1. Open the COM:Company form in New mode as Andrew Admin.
a. Enter the direct URL for the form:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/COM:
Company
b. Log on as Andrew Admin.
2. In the Company field, enter Calfin Services.
3. From the Type list, select Operating Company.
For information about the company types, see Product Catalog and multitenancy.
4. From the Status options, select the company's status, such as Enabled.
5. Click Save.
To locate the group names for the Calfin and Calbro companies
1. Open the BMC Remedy AR System Administration Console as Andrew Admin.
a. Enter the following URL:
http://<midTierServer>:<portNumber>/arsys
c. Select Applications > AR System Administration > AR System Administration
Console.
2. Select Application> Users/Groups/Roles > Groups.
3. In the Long Group Name
field on the Group Information form, type Calbro Services and click Search.
4. Note the Group Name for Calbro Services.
5. Repeat step 3 and step 4 for Calfin Services.
In this example, the Group Name of Calbro Services is 1000000006, and of Calfin Services
is 1000000007.
BMC Atrium Core 9.0
Page 435 of 2268
Home
To create Product Catalog users for the Calfin and Calbro companies
1. Open the BMC Remedy AR System Administration Console as Andrew Admin.
http://<midTierServer>:<portNumber>/arsy
c. Select Applications > AR System Administration > AR System Administration
Console.
2. Select Application > Users/Groups/Roles > Users.
3. Click New Request.
4. Create and save users using the following values:
Field
Calbro Services user
Calfin Services user
Login Name
Betty Admin
Charlie Admin
Full Name
Betty Admin
Charlie Admin
Group List
General Access
1000000006
General Access
1000000007
License Type
Fixed
Fixed
Status
Current
Current
After Andrew Admin has configured users, he can configure the products and view the products for
the respective organizations. See the examples in Relating companies to Product Catalog entries .
For an overview of multitenancy, see Controlling access to data with multitenancy. For more
information about setting permissions, see BMC Atrium Core permission roles within applications .

Creating custom Product Catalog entries
Overview of importing custom Product Catalog data
Each Product Catalog entry must be unique. A Product Catalog entry is considered unique based
on the manufacturer name, product name, and product categorization tier 1, tier 2, and tier 3 values
. These values correspond to the ManufacturerName, Model, Category, Type, and Item
attributes in a CI.
The names of some fields in the Product Catalog do not match their respective CI attribute names.
The following table shows how some key CI attributes map to Product Catalog fields.
CI attribute name
Product Catalog field name
Category
Categorization Tier 1
Type
BMC Atrium Core 9.0
Page 436 of 2268
Home
CI attribute name
Product Catalog field name
Item
ManufacturerName
Manufacturer
Model
Product Name
VersionNumber
Model/Version
MarketVersion
Market Version
The following process diagram illustrates different paths you can use to populate the Product
Catalog.
Paths to populate Product Catalog
Manually add product entries From the Product Catalog Console, you can create new
companies or products, versions, and patches and define their status. For more information,
see Creating custom Product Catalog entries.
Import Product Catalog data provided by BMC BMC releases Product Catalog data
updates on a regular basis. For more information, see the online documentation BMC Atrium
Core Product Catalog Data.
The BMC data contains only software products. If you are only tracking software, importing
this data might be all that you need. However, if you are tracking hardware, services, or
other types of products, you must create custom product entries manually, import data from
external files, or use the Normalization Engine to create product entries.
BMC Atrium Core 9.0
Page 437 of 2268
Home
Import product entries from other sources You can use BMC Remedy Data Import to load
data from supported data sources, such as formatted files and spreadsheets, into staging
forms and then the PDL:ESIDImportConsoleCustom form to import the data from the staging
forms to the Product Catalog forms. For more information, see Overview of importing custom
Product Catalog data. You can import companies and product information.
Use the Normalization Engine to create product entries You can configure the
Normalization Engine to create Product Catalog entries based on the CIs in the BMC Atrium
CMDB datasets. You must configure this option before normalizing the dataset. For
guidelines and procedures, see Preparing the Product Catalog and planning classes for
normalization.
When using the Normalization Engine to create product entries, verify that the CIs in the BMC
Atrium CMDB dataset contain the appropriate values for the ManufacturerName, Model,
Category, Type, and Item attributes. Make sure that all CIs for a specific product have the same
values for these attributes; otherwise, the Normalization Engine is likely to create duplicate entries
for a product in the Product Catalog. If you have duplicates in the Product Catalog, you must
remove them manually.
If you are implementing software license management, evaluate the VersionNumber and
MarketVersion values of software CIs. Before normalizing the CIs and creating new Product
Catalog entries, create Version Rollup rules to map related VersionNumber values to a single
MarketVersion value. For more information, see Product Catalog and Software License
Management.
Creating custom Product Catalog entries

To add custom Product Catalog entries, you can create entries individually or import them in bulk
from supported data sources. For information about importing custom entries, see Overview of
importing custom Product Catalog data.
Before you begin
To add a Product Catalog entry manually
To create a new manufacturer for a Product Catalog entry
Before you begin

To create custom Product Catalog entries, you must log on as a user with the Atrium Foundation
Admin and General Access permission roles. You use the Product Catalog Setup form, opened in
New mode (shown in the following figure), to perform the following tasks:
Add Product Catalog entries
Add product model and version information
Add patch information (if needed)
Note
BMC Atrium Core 9.0
Page 438 of 2268
Home
To access and use the Product Catalog, you must make sure that the AR User Fixed
license is installed and assigned to you.
Product Catalog Setup form
To add a Product Catalog entry manually

1. Open the Product Category Update window.
a. From the Product Catalog Console, click General Functions > New Product/Suite.
The Product Catalog Setup form opens in New mode.
2. Select a Product Type, such as Hardware, Software, Service, Business Service, or Network
Segment.
The CI Type list is populated based on the type of product that you select.
BMC Atrium Core 9.0
Page 439 of 2268
Home
Note
The Product Type selection is used only to broadly classify product entries within
the Product Catalog and to appropriately populate the CI Type list. Product
categorization does not refer to the Product Type or CI Type fields to categorize
products.
3. In the Product Category area of the Product Catalog Setup form, click Create.
The Product Category Update window opens, as shown in the following figure.
Product Category Update window
4. From the CI Type list, select the CI class for which you want to create the product.
CI Type is the type of configuration item that this Product Catalog entry represents.
5. Categorize the entry.
a. In the Product Categorization Tier 1 field, enter the tier 1 for the product.
If the value for a tier is already in the Product Catalog, you can select it. Otherwise,
you must enter the new value.
b. In the Product Categorization Tier 2 and Product Categorization Tier 3fields, enter
the tier 2 and tier 3 for the product.
Note
BMC Atrium Core 9.0
Page 440 of 2268
Home
The Product Categorization Tier 2 list is populated based on the

categorization that you select for tier 1, and the Product Categorization
Tier 3 list is populated based on the categorization that you select for tier 2.
6. In the Product Name field, enter the name of the product.

7. Perform one of the following actions for specifying the manufacturer for the product:
From the Manufacturer list, select a manufacturer.
Create a new manufacturer, as explained in the following procedure.
8. From the Statuslist, select the status for the product.
Note
Specifying a status for this entry enables the application to search on the status.
The status is informational only; it does not cause any actions to occur.
Proposed Temporarily prevents the product category from being selected by an

application.
Enabled Enables the product category to be selected by an application. Only
product categories that are set to Enabled appear in lists for product fields.
Offline Specifies that the product category is offline and temporarily unavailable.
Obsolete Specifies that the product category is obsolete and no longer available.
Archive Specifies that the selected product category has been archived.
Delete Sets the status of the selected product category to Delete. Product Catalog
entries are deleted using the Delete button on the Product Category tab on the
Product Category Setup form.
Note
You must be part of the BMC Remedy AR System administrator group to
actually delete the record.
(clear) Clears the Status field.

9. If the product is a suite of products, select Yes for Suite Definition.
Note
The Origin field is set to Custom by default and cannot be updated. The Third
Party option is used only for products that are provided by BMC.
10.
BMC Atrium Core 9.0
Page 441 of 2268
Home
10. Click Save and then Close.

When you save the product entry, it is automatically related to the "- Global -" company. This
makes the product category available on other forms, such as the Incident form, for all
operating and customer companies.
You can now create model and version information for the product, or associate the product
with a company. For more information, see Product Catalog and multitenancy.
To create a new manufacturer for a Product Catalog entry

1. Open the Product Category Update window, as explained in the previous procedure.
2. Next to the Manufacturer list, click New.
The New Manufacturer window opens.
3. In the Company field, enter the name of the company.
4. From the Status list, select the status of the manufacturer.
Note
This section describes how to import custom data into the Product Catalog. For
information on importing the Product Catalog data provided by BMC, see the Product
Catalog Data Update documentation, located at https://docs.bmc.com/docs/display/pcdata
.
You can use BMC Remedy Data Import to import Product Catalog entries in bulk from supported
data sources, such as formatted files and spreadsheets, into staging forms and then use the PDL:
ESIDImportConsoleCustom form to import the data from the staging forms to the Product Catalog
forms.
Staging forms used for importing custom Product Catalog data
Creating the custom Product Catalog data
Validating the custom Product Catalog data
Importing the custom Product Catalog data
Before attempting to import the data, you must understand what data is required and how this data
is represented on the Product Catalog Console. The Product Catalog consists of a collection of
products and suites. Software products are composed of one or more files. Each product entry
contains information, such as the name, the manufacturer, and the version number of the
BMC Atrium Core 9.0
Page 442 of 2268
Home
application. Suites are groups of one or more Product Catalog entries. A suite is technically a
product entry for which the Suite option is set to Yes. Each of these elements is represented by a
staging form, as shown in the following figure.
To create individual Product Catalog entries, see Creating custom Product Catalog entries.
Product Catalog staging forms
Staging forms used for importing custom Product Catalog data

Before attempting to import the data, you must understand how the required data on each staging
form is represented on the Product Catalog Console, as displayed in the following figure.
BMC Atrium Core 9.0
Page 443 of 2268
Home
The following table lists the set of staging forms required for importing custom titles into the Product
Catalog. The Object column in the table refers to the data about the Product Catalog entry that is
selected in the Product Catalog Entries area in the previous figure. The Console area column
indicates the location of the data in the Product Catalog Console after the data is imported from the
staging forms to the Product Catalog forms, as shown in the previous figure.
Required forms for importing custom entries into the Product Catalog
Object
Form name and description
Console area
Version Info
PDL:ESIDversioninfoCustom
Version Info is not displayed on the Product

Catalog Console.
This form contains information about the custom version of the

data to be imported. You must create an entry in this table
because the entry identifies the set of custom data being
imported.
Manufacturer
PDL:ESIDmanufacturerCustom
This form contains information about the application
manufacturers. You must create an entry in this table.
File
PDL:ESIDfilesCustom
This form contains information about each file.
Application
BMC Atrium Core 9.0
The manufacturer name is displayed in Area 1

of the console. Specific information about a
manufacturer is on the COM:Company form.
File information is not displayed on the

console, but you can view it by using the View
button in Area 3.
Application information is displayed in Area 1.
Page 444 of 2268
Home
Object
Form name and description
Console area
PDL:ESIDappsCustom
This form contains information about each application.
Application
to File
PDL:ESIDappfilesCustom
relationship
This form maps files to the applications to which they are

associated. Each application consists of a single main executable
Files that are related to an application are

displayed in Area 3.
and zero or more support files.

Suite
PDL:ESIDsuitesCustom
Suites are displayed in Area 1 if the Suite field

for the product entry is set to Yes.
This form contains information about suites. Suites are

collections of applications identified by a combination of the
applications and an identifying GUID.
Suite to
PDL:ESIDsuiteappsCustom
Application
relationship
This form contains information that relates suites to applications.
Signature
PDL:ESIDsignatureCustom
Area 2 displays either of the following items:

The products that are part of the suite
The suite to which the product is
associated.
Signatures are not displayed on the Product

Catalog Console.
This form contains information about a product signature.

Signature to
product
relationship
PDL:ESIDsignatureProductCustom
Signature data is not displayed on the Product

Catalog Console.
This form contains information about signature product

association records.
Creating the custom Product Catalog data

Before creating the data, you must decide whether you will import custom data on a regular basis. If
you import custom data more than once, you must make sure that you are using a unique Version
Info in the PDL:ESIDversioninfoCustom form. However, if you clear all entries from the custom
staging forms before starting a subsequent custom data import, the unique Version Info is not
required. For more information about Version Info, see Staging forms used for importing custom
Product Catalog data.
Loading the custom Product Catalog data into the staging forms
Common fields in the custom Product Catalog product staging forms
PDL ESIDversioninfoCustom form
PDL ESIDmanufacturerCustom form
PDL ESIDfilesCustom form
PDL ESIDappsCustom form
PDL ESIDappfilesCustom form
PDL ESIDsuitesCustom form
PDL ESIDsuiteappsCustom form
PDL ESIDsignatureCustom form
PDL ESIDsignatureProductCustom form
BMC Atrium Core 9.0
Page 445 of 2268
Home
Note
When you import custom data, the BMC_Product and BMC_OperatingSystem classes
are populated with entries. No products exist for other classes.
Loading the custom Product Catalog data into the staging forms
You can use BMC Remedy Data Import to load data from supported data sources, such as
formatted files and spreadsheets, into the following custom staging forms:
PDL:ESIDfilesCustom
PDL:ESIDappsCustom
Note
To load data from spreadsheets, you also must create mapping files that specify
which spreadsheet fields map to the destination form fields.
There is no custom staging form PDL:ESIDaliasesCustom for importing aliases. To
import or to create aliases you should use the NE:ProductNameAlias form.
You can also manually create entries in each of the staging forms. The required fields and sample
data are shown in the following tables.
Common fields in the custom Product Catalog product staging forms

The following table lists fields that exist on all the staging forms. The Sample data column shows
the data values that produce the Product Catalog entries displayed in the Product Catalog Console.
Common fields in staging forms
BMC Atrium Core 9.0
Page 446 of 2268
Home
Field name
Description
Maximum
length
dataStatus
Status field used to track import progress. All entries should be

created as New.
Not
applicable
Values
Sample
data
New
New
Validated
Inactive
Imported
Update
EventCommand
Action field used to trigger import.
60
Status
Additional status field used to track import status.
Not
applicable
New
New
Assigned
Fixed
Rejected
Closed
Short
Description
Character field that stores error notes during import.
254
None or
"."
Data Version
Data version identifier. Used on all the forms to identify which

custom version this entry belongs to.
50
Sample
data
version
The following sections list the fields in each of the staging forms:
PDL ESIDversioninfoCustom form

The PDL:ESIDversioninfoCustom staging form contains information about the version of custom
data that is loaded into the Product Catalog. Use this data to keep track of which version of custom
data is installed on your system.
PDL:ESIDversioninfoCustom fields
Field name
Description
Maximum length
Sample data
component
Component name
20
Sample
versionmajor
Major version number
versionminor
Minor version number
versionmaint
Maintenance version number
versionbuild
Build version number
description
Complete version number in string format
20
recver
Not currently used
255
Sample Custom Data
PDL ESIDmanufacturerCustom form

The PDL:ESIDmanufacturerCustom staging form contains information about the manufacturers
whose applications are loaded in the Product Catalog.
BMC Atrium Core 9.0
Page 447 of 2268
Home
DL:ESIDmanufacturerCustom fields
Field name
Description
Maximum length
Sample data
name
Manufacturer name
254
Sample
Manufacturer
mfgid
Manufacturer ID assigned to this manufacturer, as referenced in
30
Mfgl
90 (address1 +
1234 Main Street
the COM:Company form

address1
Manufacturer address
address2)
address2
Manufacturer address
city
Manufacturer city
60
Sunnyvale
state
Manufacturer state
60
CA
zip
Manufacturer zip
15
94086
country
Manufacturer country
60
United States
businessphone
Manufacturer phone
50
(408) 777-1234
techsupport
Manufacturer technical support information
customerservice
Manufacturer support reference
45
(800) 777-1234
url
Manufacturer web address
128
www.sample.com
comments
Miscellaneous comments
254
countrycode
Two-character ISO country code
*http://
support.sample.com
*
US
Entries where the manufacturer country is not known can be marked with country = "UNKNOWN"
and countrycode = "ZY."
PDL ESIDfilesCustom form

The PDL:ESIDfilesCustom staging form contains metadata about the files that are related to
applications. Each entry contains the file name and file size of each file that is associated with an
application.
PDL:ESIDfilesCustom
Field name
Description
Maximum length
Sample data
name
File name
254
sample.exe
kbfileid
Unique file ID
60
File1
filesize
File size in bytes
50
9482
quickcrc
CRC (ISO 3309) based on the first 1024 bytes of the file
50
timestamp
DOS-style date/time stamp of the file
BMC Atrium Core 9.0
Page 448 of 2268
Home
Field name
Description
Maximum length
Sample data
versionmajor
File major version number
60
versionminor
File minor version number
60
versionmaint
File maintenance version number
60
versionbuild
File build version number
60
PDL ESIDappsCustom form

The PDL:ESIDappsCustom staging form contains information about the applications that are
loaded in the Product Catalog. Each entry contains the application name and references the
manufacturer by manufacturer ID. The main executable file is referenced by file ID.
PDL:ESIDappsCustom Fields
Field name
Description
Maximum length
Sample data
name
Application name
254
Sample
Application
kbappid
Application ID
60
App1
filesize
File size in bytes
50
9482
mfgid
Manufacturer ID
90 (address1 + address2)
Mfgl
versionstring
Application version in string format
240
1.0.0.1
versionmajor
Application major version number
60
versionminor
Application minor version number
60
versionmaint
Application maintenance version number
60
versionbuild
Application build version number
60
mainexe
File ID of the application's main executable
60
File1
OpSys
0 = Not an operating system 1 = operating system
Product Categorization Tier

1
Tier 1 category
60
Software
Tier 2 category
60
Application

3
Tier 3 category
60
Sample
Origin
0 = Third party 1 = Custom
Suite Definition
0 = No 1 = Yes
Operating System
Platform description
Requires Contract
0 = Yes 1 = No
BMC Atrium Core 9.0
254
0
Page 449 of 2268
Home
PDL ESIDappfilesCustom form

The PDL:ESIDappfilesCustom staging form relates applications to files.
Note
Each application can have only one main executable file.
Field name
Description
Maximum length
Sample data
kbappid
Application ID
60
App1
kbfileid
Unique field ID
60
File1
flags
1 = File is the main executable 0 = File is not the main executable
AssignedTo
Unique ID to identify this application-file entry
A1F1
PDL ESIDsuitesCustom form

The PDL:ESIDsuitesCustom staging form contains information about the suites that are loaded in
the Product Catalog. Suites are named collections of applications. Each entry contains the suite
name and references the manufacturer by the manufacturer ID.
PDL:ESIDsuitesCustom fields
Field name
Description
Maximum length
identityGuid
GUID for the suite
254
kbsuiteid
Unique suite ID
60
Suite1
name
Suite name
254
Sample Suite
versionstring
Suite version in string format
240
2.0
mfgid
Manufacturer ID
60
Mfgl
OpSys
0 = Not an operating system 1 = Operating system
licensesuiteID
The ID of the grouping-level entry for this suite
254
Product Categorization Tier 1
Tier 1 category
60
Software
Tier 2 category
60
Application
Tier 3 category
60
Sample
Origin
0 = Third party 1 = Custom
Suite Definition
0 = No 1 = Yes
Operating System
Platform description
BMC Atrium Core 9.0
Sample data
254
Page 450 of 2268
Home
Field name
Description
Requires Contract
0 = Yes 1 = No
Maximum length
Sample data
0
PDL ESIDsuiteappsCustom form

The PDL:ESIDsuiteappsCustom staging form identifies which applications are associated with a
particular suite.
PDL:ESIDsuiteappsCustom fields
Field name
Description
Maximum length
Sample data
kbappid
Application ID
60
App2
kbsuiteid
Unique suite ID
60
Suite1
AssignedTo
Unique ID to identify this application-suite entry
SuiteApp2
PDL ESIDsignatureCustom form

The PDL:ESIDsignatureCustom staging form contains information about the signature file of a
product.
Note
If you have customized the signature, you must include this form for migrating Product
Catalog data.
Field name
Description
Data type
Maximum length
Signature ID
Random unique string
String
254
Version
Signature version
String
50
Grouping
Signature group
String
50
Type
User-defined string used for data segregation
String
50
Signature file
Location of the signature file
String
Not applicable
PDL ESIDsignatureProductCustom form

The PDL:ESIDsignatureProductCustom staging form contains information about the signature
product association records.
Note
BMC Atrium Core 9.0
Page 451 of 2268
Home
If you have customized the signature, you must include this form for migrating Product
Catalog data.
Column
Description
Maximum length
kbappid
Application ID
60
Signature ID
Random unique string
254
Platform
Name of the platform
254
Validating the custom Product Catalog data

When all the data has been loaded into the staging forms, you must validate the data using the
Data Import - Custom console.
To validate the custom Product Catalog data
Performing post-validation on the PDL:ESIDmanufacturerCustom staging form
To perform the post-validation step
To validate the custom Product Catalog data

1. Open the PDL:ESIDImportConsoleCustom form.
Use the following direct-access URL to open the PDL:ESIDImportConsoleCustom form:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/PDL:
ESIDImportConsoleCustom
2. Click the Validate tab.
3. Select the type of file to validate (in the left column), and then click the Validate Data button.
The dataStatus field in each entry is set to Validated after successful validation. If the dataStatus
field is set to Invalid, check the Short Description field for the description of the violation.
The following table lists the integrity checks done during validation.
Integrity checks
Form name
Validation
Manufacturer is associated with an application or suite
Manufacturer Country exists in the CFG:Geography Country form
PDL:ESIDfilesCustom
File is referenced in the app/files table
PDL:ESIDappsCustom
Files are associated with this application
Main.exe file exists in the File table
BMC Atrium Core 9.0
Page 452 of 2268
Home
Form name
Validation
Manufacturer exists in the Manufacturer table
PDL:ESIDappsfilesCustom
Application exists in Application table
File exists in File table
Suite is referenced in Suite/Apps table
Application exists in Application table
Suite exists in the Suite table
Performing post-validation on the PDL:ESIDmanufacturerCustom staging form

This procedure applies to an installation of DML with a BMC Remedy IT Service Management
application, and not a standalone installation with other BMC products. Search on the PDL:
ESIDmanufacturerCustom form with country = " ". Any matching entries must be modified manually
by using this procedure.
Use the following direct access URL to open the PDL:ESIDmanufacturerCustom form:
ESIDmanufacturerCustom
To perform the post-validation step

1. From the CFG:Geography Country form, locate the entry that corresponds to the country
code.
Use the direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/CFG:Geography
+Country
2. Change the status for that entry to ENABLED.
3. For the matching entry, copy the country name, and enter it in the PDL:ESIDmanufacturer
entry, where country = " ".
Importing the custom Product Catalog data

After the data is successfully validated, you are ready to import the data into the Product Catalog
forms.
To import the custom Product Catalog data

1. Use the following direct-access URL to open the PDL:ESIDImportConsoleCustom form:
ESIDImportConsoleCustom
2. Click Import Data.
BMC Atrium Core 9.0
Page 453 of 2268
Home
After the import finishes, you can check to see if the data has been imported correctly. Open each
of the following forms in search mode with datastatus = imported. All records have datastatus =
imported when they are imported correctly.
PDL_ESIDversioninfoCustom
PDL_ESIDmanufacturerCustom
PDL_ESIDfilesCustom
PDL_ESIDappsCustom
PDL_ESIDappfilesCustom
PDL_ESIDsuitesCustom
PDL_ESIDsuiteappsCustom
Product categorization
Product categorization is leveraged by multiple BMC applications. By understanding the
product-specific use of categorization, you can determine the impact when setting up product
categorization or when making additions and changes to the product category structure.
Whether you are setting up the product categorization from scratch or fine-tuning product
categorization to fit your needs, the BMC recommendations can help you avoid common pitfalls.
Categorization values provided in the Mapping Your Data to BMC Atrium CMDB Classes document
have been defined using experience gained during many service management implementations.
These categorization values include a variety of hardware products. The Product Catalog data
provided by BMC also has software categorization values for categorization Tier 3 that are
determined by using industry standard categories based on IDC Software Taxonomy. You can use
these values to more quickly implement any of the applications that use product categorization.
The Mapping Your Data to BMC Atrium CMDB Classes document is listed with other BMC Atrium
Core documents at PDFs and videos.
Overview of product categorization
How BMC products use product categorization
Product categorization and discovery
Product categorization process
Setting up product categorization data
Managing product categorization changes
Overview of product categorization

Product categorization divides CIs into groups. Using the three-tier structure of product
categorization, you can create successively smaller, more tightly defined groups. You can create
groups of CIs in Tier 1. In Tier 2, you can define smaller groups within each of those groups. In Tier
3, you can create even smaller groups within these groups.
BMC Atrium Core 9.0
Page 454 of 2268
Home
For example, you might use Tier 1 to divide CIs into hardware and software groups. Within the
hardware group, you might define Tier 2 groups for disk device, peripheral, processing unit, and
virtual systems. Within processing unit, you might define Tier 3 groups for desktop, laptop,
mainframe, personal digital assistant, and server.
The associated Product Name and Manufacturer fields provide an even more fine-grained
grouping of CIs. Version can be specified on CIs but is not part of the Product Catalog.
Product categorization is defined in the Product Catalog. CIs stored in BMC Atrium CMDB include
this categorization in equivalent fields defined at the BMC_BaseElement Common Data Model (
CDM) class level, as show in the following table.
Product categorization fields on the CI and in the Product Catalog

Categorization fields in the Product Catalog
Categorization attributes on the CI
Example values
Tier 1
Category
Hardware
Tier 2
Type
Processing Unit
Tier 3
Item
Server
Manufacturer
ManufacturerName
IBM Corporation
Product Name
Model
IBM x445
Benefits of product categorization

A well-thought-out product categorization structure helps you to more efficiently perform the
following capabilities:
Reporting
Searching
Workflow
Even though the product categorization is focused on the categorization of CIs, the BMC Remedy
IT Service Management suite (BMC Remedy ITSM) and other BMC products use product
categorization. The following section describes the ways in which the product categorization can be
leveraged.
How BMC products use product categorization

In addition to dividing CIs into groups, the product categorization structure is also used to classify
other entities within BMC Remedy ITSM, such as incidents and change requests. This section lists
the records that use the product categorization and documents the product features that use this
classification. This information can help you to determine the impact of your planned structure for
product categorization.
BMC Atrium Core 9.0
Page 455 of 2268
Home
Records that use product categorization

The following tables show how product categorization classifies records throughout BMC products.
BMC Atrium CMDB and product categorization
Entity
Description
CIs
A CI is any item that must be managed to deliver an IT service. Information about each CI is recorded in the BMC
Atrium CMDB. Product categorization is used to classify CIs.
Product
Catalog
entries
A Product Catalog entry is an entry in the Product Catalog that represents the master name of a software, hardware,
service, or other CI. The Product Catalog includes the three tiers of categorization and the product name and
manufacturer. In BMC Asset Management, Product Catalog entries can be related to software contracts. Software
License Management matches the product categorization of CIs to Product Catalog entries that are related to software
contracts to determine the utilization of software contracts.
The following figure shows the Product Catalog Setup form, which enables you to search the
product categorization that is defined in the Product Catalog.
Example of a Product Catalog form
BMC Atrium Core 9.0
Page 456 of 2268
Home
BMC Asset Management and product categorization

Entity
Description
Bulk
inventory
BMC Asset Management extends BMC Atrium CMDB with a class for bulk inventory. Bulk inventory items are
ordered in quantity and are not tracked by an individual record for each item. The total quantity of a bulk inventory
item is tracked against reorder levels. Product categorization is used to classify bulk inventory CIs.
Schedules
You can create schedules to notify IT or asset management personnel (or to create a change request) when
maintenance for CIs is necessary. For example, you can schedule a notification to IT every six months that routine
maintenance for all printers is due. Product categorization is used to search for CIs to relate to the schedule.
In the following figure, a schedule uses product categorization to search for applicable CIs.
Example of a schedule
BMC Change Management and product categorization

Entity
Description
Change
requests
A change is the addition, modification, or removal of anything that could have an effect on IT services. Change
Management is the process that controls the lifecycle of all changes. Product categorization applied to change
requests can be used to automatically route the requests for assignment and approval.
Tasks
and task
templates
A task is a unit of work that must be completed to implement an incident, problem investigation, or change request. In
the BMC Change Management application, an administrator can create task templates that can be reused for the
same type of requests. Product categorization can be used to determine the applicable task template for a change
request.
BMC Atrium Core 9.0
Page 457 of 2268
Home
BMC Knowledge Management and product categorization

Entity
Description
Solutions
Reusable solutions to customer problems are stored in a database. Product categorization can be used to match
solutions with incidents and requests.
BMC Service Desk and product categorization

Entity
Description
Incidents
An incident is an unplanned interruption to an IT service or a reduction in the quality of an IT service. In BMC

Remedy ITSM, product categorization can be used to classify the incident and the resolution of the incident.
Categorization can be used in the incident matching function to search for applicable solutions, incidents, known
errors, and problem investigations. Categorization can also be used to automatically assign the incident to the
appropriate support group.
Known errors
A known error is a problem that has been successfully diagnosed and for which a temporary workaround or
permanent solution has been identified. When a known error is categorized, it can be matched to incidents.
Categorization can also be used to automatically assign the known error to the appropriate support group.
Problem
investigations
A problem is the root cause of one or more incidents. Problem Management is the process that manages the
lifecycle of all problems. When a problem investigation is categorized, it can be matched to incidents.
Categorization can also be used to automatically assign the problem investigation to the appropriate support
group.
Script
mapping
Scripts are detailed instructions that are set up by an administrator to prompt users with questions that can assist
with resolving or assigning an incident. Script mapping determines which scripts are available for an incident.
Product categorization can be used to determine the applicable script for an incident.
In the following figure, product categorization classifies an incident.

Example of an incident
BMC Atrium Core 9.0
Page 458 of 2268
Home
BMC product features that use product categorization

The classification of the records listed in the previous section helps enable the following reporting,
searching, and workflow capabilities:
Reporting
Analytics
Dashboards
Reports included with the product
Searching
Incident matching
BMC Knowledge Management
Online searches
Workflow
Approval --- You can configure approval routings for change requests to be
automatically applied based on product categorization.
Assignment --- For all entities that can be assigned (such as incidents, change
requests, and CI unavailability), you can configure workflow to automatically assign
entities to the appropriate support group based on product categorization.
Depreciation --- In BMC Asset Management, you can configure the CI depreciation
method to be automatically applied based on product categorization.
Discovery --- BMC Atrium Discovery and BMC BladeLogic Client Automation
Configuration Discovery Integration for CMDB assign three tiers of categorization to
CIs that they discover.
Notifications --- In BMC Asset Management, you can configure notifications to be sent
automatically upon the state transition of a CI, such as when a CI is deployed or goes
down. You can configure this notification based on product categorization.
Service Level Management --- You can use product categorization values to set
conditions to determine whether a Service Level Agreement (SLA) applies.
Software License Management --- Software License Management matches the
product categorization of CIs to Product Catalog entries that are related to software
contracts to determine the use of software contracts.
Product categorization and discovery

CIs in BMC Atrium CMDB require valid product categorization. When a CI is discovered, it must
include valid product categorization.
By default, BMC Atrium Discovery and Dependency Mapping applies recommended
categorization values to all CIs that are discovered. For information about these
categorization values, see Mapping Your Data to BMC Atrium CMDB Classes . For software
categorization values, also refer to the Product Catalog data provided by BMC. For
information, see the BMC online documentation.
BMC Atrium Core 9.0
Page 459 of 2268
Home
BMC BladeLogic Client Automation Configuration Discovery Integration for CMDB uses an
XML file to apply categorization values to all CIs that are discovered. Based on the product
categorization option that is selected during installation of the product, BMC BladeLogic
Client Automation Configuration Discovery Integration for CMDB applies the appropriate
categorization values to the CIs. For information about the default categorization values, see
the following table.
Note
BMC recommends that you do not change the categorization in the data providers. BMC
recommends that you instead change the categorization through the Product Catalog, as
described in Reviewing the categorization of Product Catalog entries for discovered CIs .
Default categorization in BMC BladeLogic Client Automation Configuration Discovery

Integration for CMDB
CDM class
Tier 1
Tier 2
Tier 3
BMC_BaseElement
Unknown
Unknown
BMC Discovered
BMC_ComputerSystem
Hardware
Machine
BMC Discovered
BMC_Printer
Hardware
Printer
BMC Discovered
BMC_NetworkPort
Hardware
Network
BMC Discovered
BMC_Media
Hardware
Storage
BMC Discovered
BMC_DiskDrive
Hardware
Storage
BMC Discovered
BMC_FloppyDrive
Hardware
Storage
BMC Discovered
BMC_CDROMDrive
Hardware
Storage
BMC Discovered
BMC_Monitor
Hardware
Monitor
BMC Discovered
BMC_Keyboard
Hardware
Keyboard
BMC Discovered
BMC_PointingDevice
Hardware
Pointing Device
BMC Discovered
BMC_Processor
Hardware
Processor
BMC Discovered
BMC_Chassis
Hardware
Chassis
BMC Discovered
BMC_Card
Hardware
Card
BMC Discovered
BMC_Memory
Hardware
Memory Card
BMC Discovered
BMC_Product
Software
Application
BMC Discovered
BMC_OperatingSystem
System Settings
Operating System
BMC Discovered
BMC_Patch
System Settings
Patch
BMC Discovered
BMC Atrium Core 9.0
Page 460 of 2268
Home
CDM class
Tier 1
Tier 2
Tier 3
BMC_LocalFileSystem
System Settings
File System
BMC Discovered
BMC_DiskPartition
System Settings
Disk Partition
BMC Discovered
BMC_IPEndpoint
System Settings
Network
BMC Discovered
BMC_BIOSElement
System Settings
BIOS
BMC Discovered
When BMC BladeLogic Client Automation discovers a CI, it tries to find a match in the BMC Atrium
Product Catalog. If it finds a match, it applies the Product Catalog values of the Model,
ManufacturerName, Model, Category, and Item attributes. If it does not find a match in the
Product Catalog, it tries to find a match in the XML file selected at installation, and applies those
categorization values to the CI.
Even when you use the recommended categorization, BMC BladeLogic Client Automation
Configuration Discovery Integration for CMDB uses additional categorization for CIs that it cannot
otherwise classify. The following table provides these categorizations.
Additional categorization BMC BladeLogic Client Automation Configuration Discovery
Integration for CMD
CDM class
CI type
Tier 1
Tier 2
Tier 3
BMC_BusinessService
Logical Entity-Business Service
Miscellaneous
Service
BMC
Discovered
BMC_Product
System Component-Product
Software
Application
BMC
Discovered
Unknown
Unknown
BMC
For any discovered CI that cannot otherwise be classified,

regardless of CDM class or CI type.
Discovered
Product categorization and normalization of discovered CIs

The Normalization Engine makes sure that only CIs with valid categorization are reconciled with the
production dataset.
In a typical CMDB deployment, all new CIs or CI updates are first added to import datasets, which
are then normalized and reconciled with the production dataset. You can set up a normalization job
so that, whenever a CI is submitted to be created or updated, the CI's attributes are normalized with
the values defined in the Product Catalog.
The Normalization Engine checks against the Product Catalog, which stores the definition of
categorization data, and either validates or rejects the CI. For more information about the
normalization process, see Normalization steps and the Product Catalog .
BMC Atrium Core 9.0
Page 461 of 2268
Home
Examples of product categorization and normalization of discovered CIs

This section illustrates how the categorizations for discovered CIs are normalized. The following
table shows examples of submitted CIs and the result of their validation against the following entry
in the Product Catalog:
CI Class: BMC_ComputerSystem
Tier1: Hardware
Tier2: Processing Unit
Tier3: Server
Manufacturer Name: Hewlett-Packard
Product Name: Proliant DL380 G4
Examples of submitted CIs

Submitted CI
Result of validation
Class:
BMC_ComputerSystem
Because the product name and manufacturer both match an entry in the Product Catalog, the CI is
validated and inserted into BMC Atrium CMDB as:
Name: foo.bmc.com
Category: Hardware
Class: BMC_ComputerSystem
Type: Processing Unit
Name: foo.bmc.com
Item: Server
Category: Hardware
ManufactureName:
Hewlett-Packard
Model: Proliant DL380
Item: Server
G4
Model: Proliant DL380 G4
Class:
BMC_ComputerSystem
Because the product name and manufacturer both match an entry in the Product Catalog, the CI is
validated. The product categorization is rewritten with the categorization from the Product Catalog entry
and inserted into BMC Atrium CMDB as:
Name: foo.bmc.com
ManufactureName: Hewlett-Packard
Category: Hardware
Type: Machine
Item: Server
Name: foo.bmc.com
ManufactureName:
Category: Hardware
Hewlett-Packard
G4
Item: Server
Class:
BMC_ComputerSystem
Varies, depending on product categorization alias mapping and datasets configured for normalization,
as illustrated in the following table.
Name: foo.bmc.com
Category: Hardware
Type: Machine
Item: Server
ManufactureName:
HP
G4
BMC Atrium Core 9.0
Page 462 of 2268
Home
The following table presents scenarios of what can happen to the third CI in the previous table-when the discovered ManufacturerName does not match an entry in the Product Catalog. The
first column indicates the Discovery product categorization on the PCT:
ProductCatalogAliasMappingForm form. The Product Catalog target values are set to the values
indicated in the following table.
Outcome of product categorization alias and dataset configured for normalization

Product
categorization alias
Discovery product
categorization
Dataset
configured
for
normalization
?
CI Class:
BMC_ComputerSystem
Not applicable
Result of each step of workflow
1. Manufacturer not in the Product

Catalog.
Tier1: Hardware
Tier2: Machine
Tier3: Server
ManufacturerName:
2. Product categorization alias maps

Tier 2 and the manufacturer. The CI
is now validated.
Result of validation
CI validated and inserted into BMC

Atrium CMDB as:
Name: foo.bmc.com
Category: Hardware
HP
G4
Item: Server
CI Class:
BMC_ComputerSystem
Yes
1. Manufacturer not in the Product
Catalog.
Tier 2. The manufacturer name is not
mapped.
3. Because the CI comes from a dataset
configured for normalization, a
Product Catalog entry with the new
manufacturer is created. A company
record for the new manufacturer is
also created. The CI is now validated.
Tier1: Hardware
Tier2: Machine
Tier3: Server
Note: This product
categorization alias
does not include the
ManufacturerName or
Model.
CI Class:
No
CI validated and inserted into BMC

Atrium CMDB as:
Name: foo.bmc.com
Category: Hardware
Item: Server
ManufactureName: HP
CI rejected. Although there is an alias
BMC_ComputerSystem
1. Manufacturer not in catalog.
Tier1: Hardware
Tier2: Machine
Tier3: Server

Tier 2. The manufacturer name is not
mapped.
3. Because the CI does not come from a
for the three tiers of categorization,

because the dataset is not configured
for normalization, a new entry cannot
be created for the manufacturer and
model.
dataset configured for normalization,

the CI is rejected.
None
Yes
2. A product categorization alias is not
found.
3. Because the CI comes from a dataset
configured for normalization, the CI is
validated.
BMC Atrium Core 9.0
The Product Catalog is extended; CI

validated and inserted into BMC
Atrium CMDB as submitted.
Page 463 of 2268
Home
None
No
CI rejected.
2. A product categorization alias is not
found.
3. The CI does not come from a dataset
configured for normalization.
4. The CI is rejected.
Product categorization process

To implement categorization for BMC Atrium Core, you must complete the following process:
1. Define the product categorization structure.
To build a comprehensive and consistent product categorization structure, BMC
recommends that you first identify all distinct entities that will be stored in BMC Atrium CMDB
.
If you have already defined a product categorization structure, you can skip this step.
Otherwise, use the guidelines described in Considerations when defining the product
categorization structure.
For a comprehensive example of product categorizations, see Mapping Your Data to BMC
Atrium CMDB Classes.

2. Set up the categorization data, including the Product Catalog and product categorization
aliases.
Product categorization aliases map CI categorization coming from data providers to the
categorization you defined in the Product Catalog. For more information, see Product
categorization data in preproduction and production environments .
Considerations when defining the product categorization structure

BMC Atrium Core provides a categorization structure, but you can define your own categorization
structure in BMC Remedy IT Service Management.
"Other" as a value in categorization
"New" as a value in categorization
BMC recommends that you consider the following points when you define the product
categorization structure:
BMC Atrium Core 9.0
Page 464 of 2268
Home
BMC Atrium Discovery applies the best categorization values by default to the discovered
CIs. BMC BladeLogic Client Automation Configuration Discovery Integration for BMC Atrium
CMDB can be installed with either default categorization or best-practice categorization. You
must use the same categorization in both discovery products, which can extend your
Product Catalog. If you use different categorization for the BMC Atrium Core products,
extensions to the BMC Atrium Core are inconsistent.
You can override all or part of the BMC discovery products categorization with categorization
that you define.
BMC recommends that you adhere to the following guidelines when adding new values to the
product categorization or modifying existing product categorization values:
Do not include brand names or manufacturer names.
This additional information for CIs can be captured in the Product Name and Manufacturer
fields in the Product Category Update form and the Product Model/Version field in the
Product Model/Version form.
Limit the number of values from which a user can select.
The more values a user sees in a list, the less likely the user is to actually review them all
and pick the right one. Lists of up to ten values are considered manageable.
All values should be mutually exclusive.
Ambiguous values cause unreliable results in searches and reporting.
Each list of values should be complete.
When the list is not complete, users select values that are not accurate, which negatively
impacts the effectiveness of the product categorization structure.
Specify all three tiers.
Specifying all tiers makes sure that the same level of detail is registered in all instances.
The Product Catalog should reflect the CIs in BMC Atrium CMDB.
Information about components, such as memory and CPU type, can be either attributes of
the computer system (or virtual system) or separate CIs. If this information is recorded as an
attribute of the computer system, do not include that component in the product
categorization structure. For information about planning CIs in BMC Atrium CMDB, see
Planning.
Tip
Plan your categorization structure carefully before implementing the Product
Catalog in your production environment. Modifying the Product Catalog can cause
inconsistency in search results and reporting if records with the old categorization
values are not updated.
BMC Atrium Core 9.0
Page 465 of 2268
Home
"Other" as a value in categorization

To allow users to make accurate selections, if a category might not be complete, you can add the
Other Type of Item value, where Item is the applicable item, such as Card.
Tip
BMC recommends that you use the Other Type of Item value, instead of Other. Users are
less likely to use this value as a default and more likely to use it only when no other option
applies.
If you include Other Type of Item values in the Product Catalog, perform reporting on a regular
basis to make sure that the Other Type of Item values are not abused and, if the numbers justify it,
to add new values to the product categorization structure.
Use the Other Type of Item value only for the third tier. If a CI has no applicable Tier 1 or Tier 2
defined, the CI falls outside the scope of the CMDB and should not be registered.
Be aware that rather than search for the appropriate categorization, people might select the "Other"
value because it is easy to use. To keep the full value of your categorization, you might choose not
to create "Other" categories and to use an alternative generic term in the third tier. For example,
your third tier under Software, Software Application might include values for the supported classes
of applications and also a value of Unsupported. This example value is broad enough to catch
software not yet classified, but is less likely to be selected for established supported software that
clearly matches an existing category.
"New" as a value in categorization

BMC recommends that if you are creating alternative generic terms in the third level, do not use the
term New. A user who manually registers a new CI might be tempted to select the New value
because it is a new CI.
Product categorization data in preproduction and production environments

Product categorization data includes the Product Catalog and Product Catalog alias mapping. You
set up product categorization data in a preproduction environment and then deploy it to your
production environment.
Preproduction environments include test, development, and QA environments. The preproduction
environment must have BMC Atrium Core installed.
If you have not yet implemented the Product Catalog in your production environment, you must
start with an empty Product Catalog in your preproduction environment.
BMC Atrium Core 9.0
Page 466 of 2268
Home
If you are using product categorization in your production BMC Remedy ITSM environment, you
must bring your production Product Catalog into the preproduction environment by performing the
following actions:
On your production server, follow the instructions in Exporting Product Catalog data.
On your preproduction server, follow the instructions in Overview of importing custom
Setting up product categorization data

Running the discovery process in the preproduction environment
Reviewing the categorization of Product Catalog entries for discovered CIs
Actions to perform based on review of the Product Catalog
Modifying product categorization attributes
Using product categorization aliases for discovered CIs
Following are the high-level steps for setting up product categorization data. The referenced
sections provide detailed steps. Shortcuts to this process are indicated as tips in the relevant
procedures.
Procedure
Reference sections
To create Product Catalog entries by importing from

external files or creating entries through the
Populating the Product catalog
To run through all your discovery processes in the

preproduction environment
To review the Product Catalog and recategorize

Product Catalog entries as required
Reviewing the categorization of Product Catalog entries for

discovered CIs
For your environment if you require, create product categorization
aliases. For more details see Using product categorization aliases
for discovered CIs.
To export the data from the revised Product Catalog
Exporting data from the Product Catalog.
To import the revised Product Catalog into the

production environment
After the data is discovered, the categorization validation workflow replaces the categorization
values for the CI with the revised Product Catalog values. This replacement is based on the
incoming product name and manufacturer name, along with the product categorization alias
configuration.
Tip
BMC Atrium Core 9.0
Page 467 of 2268
Home
If you use multiple discovery products, you can use this procedure to make sure that CIs
are categorized consistently, even if you choose not to use product categorization in BMC
Remedy ITSM.

If you allow the Normalization Engine to create Product Catalog entries, you must run your
discovery process. Make sure that you get representative data from the providers. Ideally, you are
categorizing a comprehensive list of entities. The more comprehensive the list, the easier you can
define the right categorization for those CIs, and the easier you can manage the content of the
Product Catalog.
The number of CIs is not important; the discovery should include as many distinct types of CIs that
are representative of your environment. For example, discovering 10 HP Proliant computers and
inserting the CIs is no more helpful than discovering one. However, if you have two different models
of a computer in your environment, you want to discover both models.
When this step is complete, the Product Catalog is populated with entries created by all the data
providers.
For instructions for running the discovery process, see the BMC Atrium Discovery documentation
located at http://discovery.bmc.com/confluence/display/83/ and the BMC BladeLogic Client
Automation CMS and Tuner User Guide .
Tip
If you cannot run the discovery process at this time, you can look at the default
categorization to see what categorization is assigned during discovery. For more
information about default categorization, see Product categorization and discovery.
Reviewing the categorization of Product Catalog entries for discovered CIs

The Product Catalog contains entries for the representative CI entities being discovered. For each
product name and manufacturer, the Product Catalog entry is set to a default categorization. You
must review the Product Catalog.
Note
If you did not run the discovery data and export the data to BMC Atrium CMDB, you must
review either the discovered data reports or the default categorization, instead of the
Product Catalog. In this situation, you still recategorize Product Catalog entries where
required by your review.
BMC Atrium Core 9.0
Page 468 of 2268
Home
Where the categorization entry in the Product Catalog does not match the appropriate
categorization, you must recategorize the Product Catalog entry and create a product
categorization alias. The alias enables corresponding CIs from the data providers to be correctly
categorized in BMC Atrium CMDB.
If you already have a Product Catalog in your production environment, during this process you
might extend the product categorization. You also can create product categorization aliases, so that
discovered CIs use the same categorization. For more information, see Using product
categorization aliases for discovered CIs.
To review the Product Catalog and recategorize catalog entries

1. Log on to the BMC Remedy ITSM server as an administrator.
b. Log on as an administrator.
c. Select Applications > Administrator Console > Application Administration
Console.
2. From the Application Administration Console, click the Custom Configuration tab.
3. From the Application Settings list, select Foundation > Products / Operational Catalogs
> Product Catalog, and then click Open.
The Product Catalog Setup form opens, as shown in the following figure.
Product Catalog Setup form
BMC Atrium Core 9.0
Page 469 of 2268
Home
Tip
The CI Type field defines which BMC Atrium CMDB class is associated with a Product
Catalog entry. If you have a large number of Product Catalog entries, you might find it
easier to work with entries for one CI type at a time.
1. Specify the search criteria for the portion of the Product Catalog that you want to review, and
then click Search.
To review the entire Product Catalog, leave the search criteria fields blank.
2. Based on the results of your review, perform actions as indicated in Actions to perform
based on review of the Product Catalog .

The following table describes actions to perform based on your review of the Product Catalog. As
you review and revise Product Catalog entries, use the rules indicated in Considerations when
defining the product categorization structure .
BMC Atrium Core 9.0
Page 470 of 2268
Home
For detailed procedures for performing these actions, see Modifying product categorization
attributes.

Results of review
Actions to perform
Instructions
The Product Catalog entry for a

product and manufacturer is
different from the default
categorization applied by a
discovery product.
If you expect that other products might be discovered using

this default categorization, you can create a Product Catalog
alias mapping to map the three levels of default discovery
categorization to the three levels in the Product Catalog.
Using product categorization

aliases for discovered CIs
No other action is required. When CIs for this product and

manufacturer are discovered, the categorization validation
workflow automatically resets the categorization to the values
A Product Catalog entry that was
created from a discovery dataset
exists for a product and
manufacturer. The appropriate
categorization does not exist.
Delete unwanted Product Catalog entries that have not been

applied to records in the production environment.
Deleting Product Catalog

entries
Set as offline Product Catalog entries that have been applied
From the Product Catalog

Console, search for the
product by clicking Search
Products. Select the product
to records in the production environment Note: A selection

that is offline cannot be applied to new records.
and click Set Offline.

Create the appropriate categorization. If you expect that other
products might be discovered using this default categorization,
you can create a Product Catalog alias mapping to map the
three levels of default discovery categorization to the three
levels in the Product Catalog.
Overview of populating the

Product Catalog. Using
product categorization
aliases for discovered CIs.
No Product Catalog entries exist

for a categorization that you want.
Create the categorization.
Overview of populating the

Product Catalog.
Exactly one catalog entry exists

for a product name and
manufacturer. It is the correct
categorization.
No action is required.
None
Repeat step 4 and step 5 until you have completely reviewed the Product Catalog and no further
modification to categorization is required.

After you have reviewed the Product Catalog, you might need to change categorization of products.
After creating a product in the Product Catalog, you can modify the categorizations using the
following methods:
BMC Atrium Core 9.0
Page 471 of 2268
Home
With the PCT:Product Catalog form

After you have installed the Product Catalog, you can modify the categorizations with this
Product Catalog form. You can use this method if you do not have BMC Remedy ITSM
installed.
With the BMC Remedy ITSM Data Wizard
After you have installed the Product Catalog and BMC Remedy ITSM, you can modify the
categorizations with the Data Wizard.
If you are upgrading and already use the default, or legacy, categorizations with BMC Atrium
Discovery and Dependency Mapping or BMC BladeLogic Client Automation Configuration
Discovery Integration for BMC Atrium CMDB, you should continue to use them. Otherwise, you
should use the recommended categorizations.
If you modify product categorizations in the Product Catalog, you must also update CI
categorizations in BMC Remedy ITSM records with the BMC Remedy ITSM Data Wizard. If you are
using BMC Knowledge Management Express, use the Search and Replace tool to change
knowledge articles.
For example, Calbro Services imported data for the Product Catalog through staging forms and
wants to use the recommended categorization. Oracle 10g has the following categorization values:
Category --Software
Type --Application
Item --Custom
To use the recommended categorization, Calbro Services must change the categorization to the
following values:
Category --Software
Type --Software/Application/System
Item --Relational Database System
For more information about the BMC Remedy ITSM Data Wizard, see Using the data wizard to
modify data.
Warning
Before using the BMC Remedy ITSM Data Wizard, back up your database.
BMC Atrium Core 9.0
Page 472 of 2268
Home
Before you begin

To maintain data integrity while modifying the product categorization attributes, you should
disable escalations, reconciliation jobs, discovery products, and the BMC Remedy AR
System Distributed Server Option (DSO). When you have completed modifying the product
categorizations, you can restart these components.
Run the BMC Remedy ITSM Data Wizard to update categorization at times when the
systems are unavailable for general use, such as a scheduled change windows.
Install or create the Product Catalog data.
To modify product categorization attributes with the BMC Remedy ITSM Data Wizard
1. Access the BMC Remedy ITSM Data Wizard.
a. Log on to the BMC Remedy AR System server as an administrator.
b. From the Application Administration Console, click the Custom Configuration tab.
c. From the Application Settings list, select Foundation > Data Management Tool >
Data Wizard Console.
2. Select the Update Target Values action.
3. For the type of data to update, select Product Categorization.
When you select the type of data, a window prompts you for the target value and the new
value.
4. Select the CI type for which to modify the categorization.
For example, to modify a BMC_Product entry, select System Component > Product.
5. Select the product name and manufacturer for which to modify the categorization.
6. For each of the categorization tiers, enter or select the target value.
7. For each of the categorization tiers, specify the new value.
You can click Copy to copy the target value and then make the appropriate changes, or you
can type the new value. You must specify a new value for each target value.
8. Click Go.
You are prompted to confirm whether to proceed. When you proceed, the Data Wizard
Status window appears, listing forms to be updated. As the update is processed, the status
changes from Pending to Complete.
If you close the Data Wizard Status window during processing, you can open it by clicking
View Status. However, after the update is complete, you cannot reopen this window.
To change categorization with the PCT:Product Catalog form

1. Enter the direct URL for the form:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/PCT:Product%
20Catalog
2. Click New Search.
3. Type the search criteria, such as the product name, and click Search.
BMC Atrium Core 9.0
Page 473 of 2268
3.
Home
Tip
You can use broad search criteria for a longer list of products to modify. For
example, to modify all the operating system entries, you might set Product
Categorization Tier 2 to Operating System and Product Categorization Tier 3
to Third Party. Then, modify and save each product in the search results.
4. From the results, select the desired product, and modify the categorization as needed.
5. Click Save.
Using product categorization aliases for discovered CIs

Product categorization aliases are used to rewrite the product categorization of a discovered CI to
the preferred categorization. You can map incoming CI categorizations from a discovery product to
categorizations that you define in the PCT:ProductCatalogAliasMappingForm form. When the CI is
normalized, it receives the mappings defined in the PCT:ProductCatalogAliasMappingForm form.
For example, if you specify Desktop in the Categorization Tier 1 field in the Discovery Product
Categorization area and Hardware in the Categorization Tier 1 field in the Mapped Product
Categorization area, any incoming CI that is received as Desktop for tier 1 is saved as Hardware for
tier 1.
Note
BMC recommends that you do not map product names for different CI types, such as
mapping product names of a software CI to a hardware CI.
The Setting up aliases for normalization contains information about mapping product categorization
aliases. Follow these procedures to set up a product categorization alias. See Actions to perform
based on review of the Product Catalog to determine when this procedure is required.
Tip
Include Product Name and Manufacturer in the mapping only if you want to rewrite the
Product Name and Manufacturer supplied from the discovery dataset. By leaving these
fields blank, you can extend the Product Catalog with the appropriate product
categorization for newly discovered products.
Note
BMC Atrium Core 9.0
Page 474 of 2268
Home
A product alias is not the same as product categorization alias. A product alias is a
shortcut for the product name, which can be used by Product Catalog users.
Managing product categorization changes

After you set up product categorization in the Product Catalog, you might want to add, delete, or
modify Product Catalog entries. When performing these tasks, consider the following guidelines:
Adding a new Product Catalog entry.
You can add new entries without affecting existing data.
Deleting a Product Catalog entry.
In general, avoid deleting Product Catalog entries. If the categorization has not yet been
applied to any records, you can safely delete the Product Catalog entry. If the categorization
has been applied to records, you can set the catalog entry offline instead. Offline catalog
entries still exist but cannot be applied to new records. Product categorization is applied to
CIs in BMC Atrium CMDB but is also used in other BMC applications, as described in How
BMC products use product categorization.
Modifying a Product Catalog entry.
You cannot modify Product Catalog entries. You must create a new entry and either delete
the old entry or set it offline. If you set up Product Catalog alias mapping for the old entry,
you must update the alias to map to the new categorization.
When you modify the Product Catalog, these changes are not automatically propagated to
existing CIs in BMC Atrium CMDB or to other records. You must propagate the
categorization changes, which can be a lengthy process.
Consider how this change affects reporting and searches. For example, if you make what
seems like a simple name change in a value, this change can cause inconsistency in reports
and in search results if the records with that particular value are not also updated.
Recommendation
BMC recommends that deletion and modification of categorization be managed as

exceptions on a production system.
By using a preproduction system to set up, modify, test, and validate categorization
, you minimize the need for deleting and modifying existing categorization on the
production system. In general, on the production system, only extensions to the
Product Catalog should occur.
BMC Atrium Core 9.0
Page 475 of 2268
Home
Updating the Product Catalog data

This section describes how an application administrator can update Product Catalog entries and
Storage Locations in the Product Catalog to facilitate software license management and
deployment .
Note
For information about simultaneously updating a large set of product entries, see
Managing Product Catalog entries in bulk .

Viewing and searching for product entries in the Product Catalog
Creating a product alias in the Product Catalog
Specifying Storage Locations for a patch in the Product Catalog
Using signatures to identify products in the Product Catalog
Associating a signature with a product in the Product Catalog
Relating companies to Product Catalog entries
To remove the relationship between product entry and a company in the Product Catalog
Approving and managing products, versions, and patches in the Product Catalog
To add product model and version information in the Product Catalog
Creating product files in the Product Catalog
Adding patch information in the Product Catalog
Adding related files to a patch entry in the Product Catalog
Adding products to a suite in the Product Catalog
Viewing suites and products in a suite in the Product Catalog
Modifying the list of platforms in the Product Catalog
Deleting Product Catalog entries
Cloning Product Catalog entries
Viewing and searching for product entries in the Product Catalog

This section describes how to view and search for products in the Product Catalog and search
entries in the Product Catalog by organization.
Viewing and searching for products in the Product Catalog
Viewing and searching entries by company in the Product Catalog
Viewing and searching for products in the Product Catalog

You can define what types of products are displayed in the Product Catalog Entries list. From this
list, you can create and view model and version, patch, location, product files, and related suites.
BMC Atrium Core 9.0
Page 476 of 2268
Home
To search for products in the Product Catalog

To use the Advanced Search field in the Product Catalog Console
Note
A product must have model or version information before it appears in the Product
Catalog Entries list.
To search for products by platform or operating system, use the Advanced Search button. For more
information, see Using the Advanced Search field in the Product Catalog Console .
Recommendation
BMC recommends that you do not make unqualified searches to avoid timeouts due to a
large volume of data retrieval. Limit the number of search entries to be displayed by
specifying values, such as the manufacturer name or product name, in the Search Criteria
area.
To search for products in the Product Catalog

1. From Product Catalog View area on the Product Catalog Console, select the type of
products to view.
Definitive Media Library The software that you have marked as approved in the
Product Catalog.
Definitive Hardware Library The hardware that you have marked as approved in
the Product Catalog.
All Software All approved and unapproved software in the Product Catalog.
All Hardware All approved and unapproved hardware in the Product Catalog.
All Products All approved and unapproved software, hardware, and other types of
products in the Product Catalog.
2. To display by particular product attributes, select or type values for any of the following fields
:
Product Name
Model/Version
Manufacturer
3. (Optional) Select the following settings to view only those products with the following
matching states:
Managed
Blacklisted
Hidden
BMC Atrium Core 9.0
Page 477 of 2268
Home
Note
If you do not select the Hidden setting, the products for which the Hide
Product option is set are not displayed.
4. (Optional) From the Origin list, select the source of the product entries:
Third Party entries are product entries that are provided by BMC.
Custom entries are product entries that you have created manually, imported through
staging forms, or created through the Normalization Engine.
5. (Optional) To build an expression for a more complex search, click Advanced Search and
specify the criteria.
For more information, see Using the Advanced Search field in the Product Catalog Console .
6. Click Search.
To use the Advanced Search field in the Product Catalog Console

You can create an advanced search expression for searching for products based on platform or
operating system.
For example, to search for products on the UNIX platform, you could use the expression '
Platform' LIKE "UNIX". To search for products by operating system, use an expression such
as 'Operating System' LIKE "Solaris 9" .
To view an expression, click the ... button; however, you cannot edit the expression in this window.
Viewing and searching entries by company in the Product Catalog

You can view the product entries that are related to a company by using the Product Catalog
Console.
Before you begin

Make sure that you have related entries to companies that you want to search for.
To view Product Catalog entries by company

1. Log on to the Product Catalog Console as a user related to the company for which you want
to view the entries.
b. Log on as a user related to the company.
c. Select Applications > Product Catalog > Product Catalog Console .
2. From the Company list, select the company for which you want to view the products.
3.
BMC Atrium Core 9.0
Page 478 of 2268
Home
3. (Optional) Specify the search criteria for products. For information about the search criteria,
see To search for products in the Product Catalog .
4. Click Search.
Only the products that have an association with the - Global - company or with the company
for which you want to view the products, are displayed in the Product Catalog Entries area.
Creating a product alias in the Product Catalog

The Product Catalog can use a product alias for naming products. A product alias specifies another
name that might be used for a product in the Product Catalog. When you create this alias, you
change the Product Catalog entry for the product. Product aliases are used in BMC Change
Management, license compliance, Report Center, and other reports that use Product Catalog data.
For example, you can use the product alias of a software CI to generate a report for outdated
licenses for that software.
Note
This alias is not used in normalization. To create a product or manufacturer alias for
normalization, see Product name and manufacturer normalization aliases in the Product
Catalog.
You can create product aliases to use in reports and references. For example, Calbro Services
wanted to have the product named Microsoft Notepad listed in reports as Notepad without
modifying the Product Name value. So Calbro Services created an alias of Notepad for the
Microsoft Notepad product.
To create a product alias for a product entry

1. From the Product Catalog Console, click General Functions > New Product/Suite.
The Product Catalog Setup window opens in New mode.
2. From the Product Catalog Setup window, search for a product, or create one.
3. From the Product Category area, select the product.
4. On the Product Alias tab, click Create.
5. In the Product Alias Update window, enter the product alias.
6. Click Save.
7. In the Company and Module Relationships area, click View.
8. Set the Normalized Product status to Yes.
9. Click Save.
BMC Atrium Core 9.0
Page 479 of 2268
Home
Specifying Storage Locations for a patch in the Product Catalog

To specify the location for a patch that is defined for a Product Catalog entry, create a Storage
Location. When a patch is marked as Approved, it can be installed from the specified Storage
Location for that patch. You can also add up to three attachments for each location.
To create a Storage Location for a patch
To add an attachment to a Storage Location
To create a Storage Location for a patch

1. In the Product Catalog Entries area of the Product Catalog Console, select the patch for
which you want to specify a location.
2. In the Storage Location Area field, click Create to open the Storage Location window.
3. In the Description field, enter a description for the patch.
4. From the Type list, select the type of location:
Marimba Signifies that the entry or location is a BMC BladeLogic Client
Automation tuner.
Other Signifies an entry or location other than a BMC BladeLogic Client
Automation tuner.
5. Enter a location for the patch, such as a physical location, a path to a location, or a URL.
6. In the State field, select Active or Inactive.
Note
To make the patch active and available for deployment, select Active for the State
and Yes for Deployable.
To add an attachment to a Storage Location

1. From the Product Catalog Entries area of the Product Catalog Console, select the patch for
the Storage Location.
2. From the Storage Location table, select an item and click View to open the Software Library
Item form.
3. Click Add to open the Attachment Details window.
4. From the Status list, select a status.
5. In the Description field, enter a description of the attachment.
6. In the Attachments table, click Add.
7. Click Browse to select the attachment.
8.
BMC Atrium Core 9.0
Page 480 of 2268
Home
8. Click OK to add the attachment.

You can add up to three attachments per Storage Location record.
Using signatures to identify products in the Product Catalog

A signature identifies a product, and BMC Atrium Discovery can create and associate signatures for
products in the Product Catalog. BMC Atrium Discovery can upload manually created signature
files into the Product Catalog and associate it to a product in the Product Catalog. For information
about associating a Signature ID with a product, see Associating a signature with a product in the
Product Catalog.
Each signature is associated with a Signature ID, which is a random unique string. A signature is a
unique ID associated with a product ID. The Product Catalog does not interpret it or use it for any
other purpose.
Signature files are stored in the Product Catalog as attachments, such as an XML or text file. The
maximum attachment file size defined by BMC Remedy AR System is 5 MB. If no Signature ID is
provided, the Signature ID is automatically generated and populated from the product information
using the following algorithm:
part : vendor : product : version : update : edition : language
The following example shows the signature for Microsoft Office 2002 Patch 10.0.2627.0:
:microsoft_product:microsoft_Office:2003:11.0.5614.0 Ent.:: :Microsoft_Corporation:

Microsoft_Outlook:2002:10.0.2627.0::
Note
You can also modify the generated Signature ID or provide a unique string ID manually.
The following information is used to create signature entries in the PCT:Signature form:
Signature ID Random unique string
Version Signature version
Grouping User-defined signature groups, such as Test or Production to logically
segregate your data
Type User-defined string, such as dynamic or static, used for data segregation
Signature file Location of the signature file
BMC Atrium Core 9.0
Page 481 of 2268
Home
Associating a signature with a product in the Product Catalog

Use the following procedure to associate a signature file with a product in the Product Catalog.
Before you begin

If the product, model or version, and patch information does not already exist in the Product
Catalog, create it.
To associate a signature with a product

1. In the Product Catalog Console, select General Functions > Create/Associate Product
Signature.
2. In the Signature Product Association window, from the Product Key list, select a product.
Tip
Use a pattern search with %<pattern>% to get a shorter list of products. For
example, if you enter %note%, only products with note in the name are listed, such
as Notepad, Programmer NotePad, and LotusNotes.
3. (Optional) In the Platform field, enter the platform for the software product.
A Signature ID is automatically generated.
Note
You can modify the automatically generated Signature ID. While modifying the
signature ID, avoid special characters.
4. To associate a signature with the product, click New Signature.

5. In the Product Signature window, specify the Logical Data Group.
6. Specify the type and version of the signature.
You can specify your own type and version for the signature to make the signature unique.
7. To attach a signature file, right-click under Filename and select Add.
8. Browse and select the signature file, and click Open.
9. From the Status list, select the status for the product.
10. To save the new signature record, click Save.
11. To save the signature association, click Save.
Note
BMC Atrium Core 9.0
Page 482 of 2268
Home
When you customize the signature data, make sure that you include the PDL:
ESIDsignatureCustom and PDL:ESIDsignatureProductCustom forms during
Product Catalog data migration.
Relating companies to Product Catalog entries

You can relate companies to Product Catalog entries to separate the Product Catalog entries
associated with different companies.
You can associate companies to products, versions, and patches. If a Product Catalog entry is
associated with the - Global - company, that product entry is available to all companies or
organizations, and you cannot specify a company relationship. By default, when you create Product
Catalog entries, they are associated with the - Global - company. For example, the Microsoft Office
Word 2003 entry is associated with the - Global - company in the Product Catalog of Calbro
Services. So, Microsoft Office Word 2003 is available for both Calbro Services and Calfin Services.
Tip
Configure relationships with the - Global - company first and apply company-specific rules
only for multitenancy. This reduces the number of records in the Product Catalog that
must be maintained for each customer.
For information about creating and managing companies, see Product Catalog and multitenancy.
Before you begin

Create software product and version entries for products to which you want to relate entries.
To relate a company to Product Catalog entries

1. From the Product Catalog Console, select General Functions > Search Products.
The Product Catalog Setup window opens in Search mode.
2. In the Product Category area of the Product Catalog Setup window, select a product to
relate to a company.
3. (Optional) In the Model Version tab, select a version or model for the selected product.
4. (Optional) In the Patch tab, select a patch for the selected version.
5. In the Company and Module Relationships area, click Create.
Note
If a product is associated with the - Global - company, you must delete the
association and then click Create.
BMC Atrium Core 9.0
Page 483 of 2268
Home
6. From the Company list, select the company to relate to the selected Product Catalog entries
.
Note
Only companies that are tenant-types (i.e company type that are either Customer
or Generic Contact or Service Provider or Operating Company or Vendor) are
available in the list.
7. From the Status list, select the status for the product.
Note
Specifying a status for this entry enables the application to search on the status.
The various statuses are informational only; they do not cause any actions to occur
.
Proposed Temporarily prevents the product category from being selected by an

application.
Enabled Enables the product category to be selected by an application. Only
product categories that are set to Enabled appear in lists for product fields.
Offline Specifies that the product category is offline and temporarily unavailable.
Obsolete Specifies that the product category is obsolete and no longer available.
Archive Specifies that the selected product category has been archived.
Delete Specifies that the selected product category has been deleted. Product
Catalog entries are deleted using the Delete button on the Product Category tab on
the Product Category Setup form.
(clear) Clears the Status field.
8. Select the Product Status Flags.
For more information about the status options, see Approved Product, Managed Product,
and other status options in the Product Catalog .
9. Click Save and then click Close.
To remove the relationship between product entry and a company in the Product
Catalog
You can remove the relationship between a product entry and a company if you no longer want to
manage that product entry for a specific company.
1.
BMC Atrium Core 9.0
Page 484 of 2268
Home
2. In the Product Categorization Search Criteria area, enter your criteria, and click Search.
Results matching your search criteria are displayed in the tables.
3. On the Product Category tab, select a product entry.
The company that the product entry is related to appears on the Company and Module
Relationships area.
4. In the Company and Module Relationships area, click Delete.
5. Click Yes to confirm.
Approving and managing products, versions, and patches in the Product Catalog
As part of managing your products, approving products in the Product Catalog is important.
Products with the Approved status are available in the DML or DHL, depending on whether they are
software or hardware.
By default, the Normalization Engine normalizes both approved and unapproved CIs. If you disable
the Allow Unapproved CIs option in the Normalization console, the Normalization Engine still
normalizes CIs of the products that are not approved in the Product Catalog but sets the
NormalizationStatus attribute for those CIs to Normalized Not Approved.
You can also decide if you want to track a product by using the Managed status option, mark a
product as Blacklisted, and so on. For more information about status options, see Approved
Product, Managed Product, and other status options in the Product Catalog .
The following procedures explain how to set status options for individual products, versions, and
patches:
To approve and manage individual products
To approve and manage versions of products
To approve and manage patches of products
To set status options for many Product Catalog entries at the same time, see Bulk actions for
managing Product Catalog entries.
To approve and manage individual products

To view a list of products, click in the table to refresh it.
Specify the search criteria to view the product in the table.
3. Select a product in the Product Category area.
4. In the Company and Module Relationships area, select the Product Company Assoc tab.
Select - Global - and click View.
BMC Atrium Core 9.0
Page 485 of 2268
5.
Home
If you have set up multitenancy, select the specific company, and click View.
6. In the Company/Module Relationship window, perform the following steps:
a. For Approved Product, select Yes.
b. For Managed Product, select Yes. (The installation of the managed product should
be tracked in CMDB).
c. (Optional ) Set other Product Status Flag options.
d. Select the Status Flag (such as Enabled ) and update other details.
7. Click Save.
To approve and manage versions of products

4. On the Model/Version tab, select a version or model for the selected product.
5. In the Company and Module Relationships area, select the Version Company Assoc tab.
7. In the Company/Version Relationship window, perform the following steps:
c. (Optional ) Set other Version Status Flag options.
d. Select the Status Flag (such as Enabled ) and update other details.
8. Click Save.
To approve and manage patches of products

4. On the Patch tab, select a patch for the selected product.
5. In the Company and Module Relationships area, select the Patch Company Assoc tab.
7. In the Company/Patch Relationship window, perform the following steps:
a.
BMC Atrium Core 9.0
Page 486 of 2268
Home
7.
c. (Optional ) Set other Patch Status Flag options.
d. Select the Status Flag (such as Enabled) and update other details.
8. Click Save.
To add product model and version information in the Product Catalog

Use the following procedure to add model and version information for a product. From the Product
Model/Version window, you can also define the platform, operating system, availability, support,
part number, and locale information for a version or model of the product.
Note
A product must have model or version information before it appears in the Product
Catalog Entries list.
1. From General Functions > New Product/Suite, search for a product, or create one.
The Product Catalog Setup window opens in New mode.
2. From the Product Catalog Setup window, select a product.
3. In the Product Category area, click the Model/Version tab, and click Create.
4. In the Product Model/Version field, enter the product version.
If you do not know the version, click Unknown.
5. From the Product Model/Version State list, select the status of the version, such as Future
Consideration or General Availability.
6. In the Requires Contract field, select Yes or No.
If you select Yes, this means that this Product Catalog entry must be related to a Software
License contract in BMC Asset Management to facilitate software license compliance of
specified software configuration items. For more information, see the BMC Asset
Management documentation.
7. From the Status list, select the status of the version.
This parameter enables you to set the product version to one of the following status values.
These values are informational only; they do not cause any actions to occur.
Proposed Temporarily prevents the product version from being selected by an
application.
Enabled Enables the product version to be selected by an application.
Offline Specifies that the product version is offline and temporarily unavailable.
BMC Atrium Core 9.0
Page 487 of 2268
Home
Obsolete Specifies that the product version is obsolete and no longer available.
Archive Specifies that the selected product version has been archived.
Delete Specifies that the selected product version has been deleted.
8. (Optional) In the Market Version field, enter the common product version with which the
software licenses should be associated.
For example, if Calbro Services wants to track the multiple service packs and versions for
Microsoft Excel as instances of version 2003, Andrew Admin enters 2003 in the Market
Version field of the Microsoft Excel Product Catalog entry.
The MarketVersion value is used by the software license management engine to
determine if the Product Catalog entry must have a related software license contract.
9. (Optional) In Verification Key, enter the authentication key for the software package.
10. (Optional) In the System Requirements area, enter the minimum requirements for installing
the product version:
Minimum CPUs
Minimum CPU Speed (GHz)
Minimum RAM
Minimum Disk Space
11. Enter any other optional information.
12. Click Save.
You can now create patch information for the model or version.
Creating product files in the Product Catalog

If a product's files do not exist in the Product Catalog, you can create them. Completing this
procedure makes the file available so that you can relate it to a patch entry. For more information,
see Adding related files to a patch entry in the Product Catalog .
To create a product file

1. In the Product Catalog Entries area on the Product Catalog Console, select a product.
2. In the Product Files area, click Create.
3. In the File Name field, enter the name of the file and its extension.
4. In the File Size field, enter the size (in bytes) of the file, such as 820512.
5. (Optional) In the CRC field, specify the check value for the file, such as ADE50E9F.
6. (Optional) In the Timestamp field, click the ... button to define the date and time for the file,
such as 11/23/2001 4:00:00 PM.
7. Click Save.
8. In the dialog box, click OK.
BMC Atrium Core 9.0
Page 488 of 2268
Home
Adding patch information in the Product Catalog

You can define another level of identification for a software Product Catalog entry by creating a
related patch ID. For example, you might have a software Product Catalog entry called Microsoft
Word 2000, version 1.0, patch SP3.
To create a related patch ID

1. From the Product Catalog Console, search for a product.
2. Expand the product list, and select a version or model.
For more information, see Viewing and searching for products in the Product Catalog .
Note
If you select the product instead of a version or model, clicking Create opens the
Model/Version window.
3. In the Product Catalog Entries area, click Create.

4. From the Status list, select a status.
5. In the Patch Last Build ID field, enter the patch number.
6. (Optional) Add a build date and description.
7. Click Save.
When you save the patch, it is automatically related to the - Global - company.
Adding related files to a patch entry in the Product Catalog

Product Catalog patch entries are made up of one or more files. These files are represented in the
Product Files area as metadata, and are not the patch files. You can select an existing file to relate
to a patch entry.
For information about creating file entries, see Creating product files in the Product Catalog .
To add related files to an entry

1. In the Product Catalog Entries area on the Product Catalog Console, select a patch.
2. In the Product Files area, click Add.
3. From the File ID list, select the name of the patch file to relate to this entry.
Tip
To find the file more quickly, limit the search, for example, by typing %.exe% in the
File ID field, then clicking the down arrow by the field.
BMC Atrium Core 9.0
Page 489 of 2268
Home
If the file name does not appear in this list, return to the Product Files table and click Create
to add it.
4. If this file is the main executable, select the Yes option.
5. Click Save.
Adding products to a suite in the Product Catalog

After you have created or modified your Product Catalog entries, you can add the products that
should be part of a suite to the Products in Suite table from the Product Catalog Console.
You define which Product Catalog entries are suites by selecting the Yes option for Suite Definition
on the Product Category Update form. See Creating custom Product Catalog entries.
Note
You can use the Suite Rollup feature in the Normalization Engine to create suites and
associate existing Product Catalog entries as components of the suites. The Suite Rollup
rules identify CI instances as a suite or a suite component. For more information about the
Suite Rollup feature, see Configuring Suite Rollup normalization rules.
To add products to a suite

1. In the Product Catalog Entries area of the Product Catalog Console, select a product model
or version that is a suite.
2. In the Products in Suite area, click Add.
3. From the Product ID list, select a manufacturer, product, and version to add to this suite,
then click Save.
4. Repeat the procedure for each product that you want to appear in the suite.
5. Click Close.
Viewing suites and products in a suite in the Product Catalog

You can view a suite and the products that are in the suite.
To view a suite or the products in a suite

1. In the Product Catalog Entries area of the Product Catalog Console, select a product version
that is in a suite.
2. In the Related Suites area, select the suite and click View.
The View Suite Entry dialog box appears.
3. To view information about the suite, click the Product Details tab.
4. To view the list of products in the suite, click the Suite tab.
BMC Atrium Core 9.0
Page 490 of 2268
Home
Modifying the list of platforms in the Product Catalog

To modify the list of platforms in the Product Model/Version form, create new records in the PCT:
MenuItems form. For more information about platform support for products, see [Platform and OS
support in the Platform and operating system support in the Product Catalog .
To modify the list of platforms

1. Enter the direct URL for the PCT:MenuItems form.
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/PCT:MenuItems
3. In the Menu Category field, select Software.
4. In the Menu Type field, enter OSPLATFORMTYPE.
5. In the Menu Label 1 field, enter the display label for the OS platform, such as UNIX, Linux,
Windows, Mac OS, or Solaris.
6. In the Menu Label 2 field, enter the display label for the specific sub-type of the OS noted in
step 5, such as HP-UX 11, Windows Vista, Mac OS 10.5, FreeBSD 7, or Solaris 10.
7. In the Menu Value 1 field, enter the name of the OS platform that you entered in step 5.
8. In the Menu Order 1 counter field, enter the record's position to be displayed in the menu,
where 1 is the first list item.
Note
If you do not select a value for Menu Order or if multiple platforms are assigned
the same value, the platforms are listed in alphabetical order. Platforms with two or
more words are then listed in alphabetical order based on the second string, for
example, Windows 2003, Windows NT, and Windows Vista.
9. In the Locale field, to create localized versions, enter a value such as en.
10. From the Status options, select the appropriate status for the platform.
The default status is Enabled. When the menu list is displayed, records that do not have
Enabled status are not displayed.
11. Click Save.
Deleting Product Catalog entries

You can delete Product Catalog entries by using the Delete button on the Product Category tab on
the Product Category Setup form.
BMC Atrium Core 9.0
Page 491 of 2268
Home
To delete a Product Catalog entry

1. From the Product Catalog Console, click Search Products.
2. In the Product Categorization Search Criteria area, enter your criteria, then click Search.
Results matching your search criteria appear in the tables.
3. On the Product Category tab, select the entry to delete.
4. In the Product Category area, click Delete.
Note
If an entry is related to a Storage Location, a message appears stating that you
cannot delete the entry. If this happens, open the Product Catalog Console and
delete the Storage Locations that are related to this entry, then repeat this
procedure.
Cloning Product Catalog entries

You can duplicate, or clone, existing product entries. You might use this when a product name
changes, but you do not want to modify the original entry. When you clone a product, you can
change the product name, categorization, status, version, and other attributes. The original entry is
set to offline.
To clone a Product Catalog entry

1. In the Product Catalog Entries area of the Product Catalog Console, select the patch to
clone.
2. Click Clone.
3. In the Clone Product Catalog Entry window, enter a new name for the cloned product.
4. Modify the product information as needed.
5. Click Save.
Normalization and the Product Catalog overview

Normalization process in the Product Catalog
Configuring the Normalization Engine to populate Product Catalog entries
As part of BMC Atrium CMDB, the Normalization Engine provides a centralized, customizable, and
uniform way to overcome consistency problems by normalizing attributes for hardware and software
products. The Normalization Engine and Product Catalog interact with each other in two ways:
The Normalization Engine requires the Product Catalog to normalize CI attributes.
BMC Atrium Core 9.0
Page 492 of 2268
Home
The Normalization Engine can create Product Catalog entries when it does not find a
matching product for a CI.
For the Product Catalog, a product is a normalized definition of real-world CIs. A CI is an instance
of a class and of a product in the Product Catalog. For each CI, the Normalization Engine checks
the Product Catalog for a corresponding product and, if found, normalizes the CI based on that
matching product. The following figure illustrates this procedure.
Normalization and the Product Catalog
By default, the Normalization Engine normalizes both approved and unapproved CIs. So, the
Normalization Engine uses the DML, DHL, and the rest of the Product Catalog during normalization
. You can configure the Normalization Engine to normalize only approved products.
You can also configure BMC Atrium CMDB to reduce the volume of CIs added by discovery tools
and to track only specific products in the BMC.ASSET production dataset by marking the
unmanaged products for deletion during the normalization process. For more information, see
Using the Managed Product status to delete unwanted CIs in bulk .
For a detailed description of the normalization process, see Normalization steps and the Product
Catalog. For detailed information about configuring and using normalization, see Preparing for
normalization.
BMC Atrium Core 9.0
Page 493 of 2268
Home
Normalization process in the Product Catalog

The Normalization Engine performs validation against different scenarios. The CI being validated
falls into one of the scenarios indicated in the following steps. The Normalization Engine performs
validation sequentially. The following figure illustrates the checks and actions performed in this
process, matching the steps to the numbers in the figure. (Specifically, the following figure shows
the process using the Version Normalization and DML Based Instance Normalization features. For
more information about Normalization Features, see Normalization features.)
The Normalization process is as follows:
1. The Normalization Engine checks the Normalization Alias form for aliases for the
ManufacturerName and Model attributes.
2. The Normalization Engine applies Version Rollup rules and sets MarketVersion using the
Version Rollup rules. For information on Version Rollup, see Normalization and software
license management and Configuring Version Rollup normalization rules.
3. The Normalization Engine searches the Product Catalog for a product and its versions
based on Model and ManufacturerName.
Note
For versions 8.1.01 or later, if Model or ManufacturerName are NULL, you must
manually set the values of Model to BMC_UNKNOWN and ManufacturerName
to BMC_UNKNOWN in the Product Catalog. Set the values of Category, Type
and Item appropriately.
If the product is not found, it checks if the Allow New Product Catalog Entry option is
enabled.
If it is enabled, the Normalization Engine creates a new product entry, sets the
NormalizationStatus and ends the normalization process for the CI.
Else, the Normalization Engine updates the CI's NormalizationStatus attribute as
Normalization Failed and ends the normalization process for the CI.
4. Normalization Engine checks the product association with the Company populated in the CI.
If it is not associated, the Normalization Engine updates the CI's NormalizationStatus
attribute as Normalization Failed and ends the normalization process for the CI.
5. If version in the Product Catalog is 'Unknown' and version of the CI is NULL, the
Normalization Engine sets the NormalizationStatus and ends the normalization process
for the CI.
6.
BMC Atrium Core 9.0
Page 494 of 2268
Home
6. If MarketVersion is populated for a CI, the Normalization Engine searches the Product
Catalog for a product that matches the CI using ManufacturerName, Model, and
MarketVersion.
If it finds ManufacturerName, Model, and MarketVersion, the Normalization
Engine substitutes Category, Type, and Item attribute values from the Product
Catalog entry in to the corresponding CI attributes.
The Normalization Engine updates the NormalizationStatus attribute to
Normalized and Approved or Normalized and Unapproved, and then ends the
normalization process for the CI. Normalization of unapproved products depends on
whether the Allow Unapproved CI option is disabled. By default, it is enabled.
Normalization checks the IsApproved flag for the entry.
Normalization Engine applies all the normalization features enabled for the dataset.
7. If Normalization Engine does not find a match in the Product Catalog with
ManufacturerName, Model, and MarketVersion, and if VersionNumber is populated
for a CI, it searches the Product Catalog for a product that matches the CI using
ManufacturerName, Model, and VersionNumber.
If it finds a ManufacturerName, Model, and VersionNumber, the Normalization
8. If both, MarketVersion and VersionNumber are not populated for a CI, Normalization
Engine checks for match with ManufacturerName and Model. If it finds a match, the
Normalization Engine substitutes Category, Type, and Item attribute values from the
Product Catalog entry in to the corresponding CI attributes.
9. If the Normalization Engine does not find a Product Catalog entry with matching version, it
checks if the Allow New Product Catalog Entry option is enabled.
After data is normalized, it can be reconciled to the BMC Atrium CMDB production dataset.
Tip
BMC Atrium Core 9.0
Page 495 of 2268
Home
You can use the Product Catalog Mapping Alias with datasets configured for
normalization to control automatic expansion of the Product Catalog. For example, a
Product Catalog Mapping Alias might map all of the data provider's default Tier 1, Tier 2,
and Tier 3 categorization to preferred categorization in the Product Catalog. The Allow
New Product Catalog Entry option is selected for the data provider's dataset in the
Normalization console. So, every time a new product name and manufacturer combination
is discovered, a new Product Catalog entry is created, using the preferred three
categorization tiers and the discovered product name and manufacturer.
Configuring the Normalization Engine to populate Product Catalog entries

If you use the option to create Product Catalog entries with the Normalization Engine, you must
complete the following steps to make sure that the products are correctly created.
For more information about configuring normalization and using the Normalization Simulation utility,
see Preparing for normalization and Simulating normalization.
To configure the Normalization Engine to populate the entries

1. From the Configuration Editor in the Normalization console, enable the Allow New Product
Catalog Entry option for a dataset.
This option cannot be enabled for certain classes. Make sure that the CIs in such a dataset
have been manually normalized.
2. Ensure that Version Rollup rules map related version numbers to a single Product Catalog
entry with a particular Market Version value.
The Version Rollup rules enable you to normalize multiple version strings to a common
Market Version value. For more information on Version Rollup, see Configuring Version
Rollup normalization rules.
3. From the Normalization Features in the Normalization console, make sure that the
appropriate Version Rollup rules are activated.
The Version Rollup rules enable you to normalize multiple version strings to a common
market version value.
4. From the Configuration Editor in the Normalization console, click Configure Normalization
Features (...) and enable the Suite Rollup Normalization Feature for a dataset.
5. From Normalization Features in the Normalization console, configure the appropriate Suite
Rollup rules.
You can use the Suite Rollup feature to create new suites in the Product Catalog and assign
existing products to the suites. The Suite Rollup rules can also identify instances as a suite
or suite component.
6. After setting up normalization, run the Normalization Simulation utility to preview
normalization results.
For more information, see Simulating normalization.
7. From the Normalization console, create and run a normalization job.
BMC Atrium Core 9.0
Page 496 of 2268
Home
In the Product Catalog Console, after the normalization job runs, review the new Product Catalog
entries and make changes to their status options as needed. For more information, see Approved
Product, Managed Product, and other status options in the Product Catalog .
Configuring the Product Catalog for normalization

For the Normalization Engine to normalize CIs successfully, you must complete the following steps
to configure the Product Catalog.
1. Create or import Product Catalog entries for the class instances that you want to normalize.
Because the Normalization Engine uses product definitions to normalize CIs, you must
populate the Product Catalog by importing products, manually creating products, or using
the Normalization Engine to create products. For more information about methods to
populate the Product Catalog, see Overview of populating the Product Catalog .
2. Add a Market Version value to each software product entry, as needed.
For more information on using the Market Version, see Product Catalog and Software
License Management.
3. Create product and manufacturer normalization aliases.
For more information, see Product name and manufacturer normalization aliases in the
Product Catalog.
4. Create product categorization aliases for the following reasons:
If the combination of the values of Category, Type, Item, Model, and
ManufacturerName is not in the Product Catalog data. Or, if these values are in the
Product Catalog but are not related to the company for whom the CI is being
submitted.
If a CI's Model or ManufacturerName attribute has no value. For more information
about null values and normalization, see Normalization and NULL values for Model (
Product Name) and ManufacturerName.
If the Allow New Product Catalog Entry option is disabled in the Normalization
Engine.
For more information, see Using product categorization aliases for discovered CIs .
If the Normalization Engine failed to normalize CIs, the utility indicates whether the Model or
ManufacturerName value is null. You can create aliases for these failed CIs. For more
information about the Normalization Simulation utility, see Simulating normalization.
BMC Atrium Core 9.0
Page 497 of 2268
Home
Product name and manufacturer normalization aliases in the Product Catalog

Product entries in the Product Catalog are your trusted source for product and manufacturer names
, and for other attribute values for normalized CIs. The Normalization Engine uses product ( Model )
and manufacturer name (ManufacturerName ) data to match CIs in a dataset with entries in the
Product Catalog.
Discovery tools might populate the Model and ManufacturerName attributes in CIs with values
that differ from the corresponding Product Catalog entries. In this case, you can create product
name and manufacturer aliases. These aliases are stored as entries in the Normalization Alias form
.
During normalization, the Normalization Engine looks up alias information in the Normalization Alias
form by using the Model and ManufacturerName attributes in a CI. If the Normalization Engine
finds a matching alias, it replaces the Model and ManufacturerName data in the CI with correct
Model and ManufacturerName data. Using this correct Model and ManufacturerName data,
the Normalization Engine is able to match the CI with the corresponding Product Catalog entry.
For example, Calbro Services has the following Product Catalog entry for one of their applications:
Model: Financial Advisor Pro
ManufacturerName: Calbro Services
VersionNumber: 1.0
Category: Software
Type: Software Application/System
Item: Financial/Resource Planning Application
But in their discovery dataset, the CIs have the following attribute values:
Model: Financial Advisor Pro
ManufacturerName: CFS
VersionNumber: 1.0
The CIs fail to normalize. Calbro Services notices that the ManufacturerName values for the CI
and Product Catalog entry do not match. The staff creates a ManufacturerName alias where the
Normalization Engine substitutes Calbro Services for CFS and then normalizes the CI by using the
matching product values.
Tip
BMC Atrium Core 9.0
Page 498 of 2268
Home
If the Product Catalog contains entries that you do not want to use as your trusted source
for normalizing CIs, you must delete those entries and create new entries. After creating
the new entries, create product and manufacturer aliases as needed to ensure that
discovered CIs are mapped to the new, trusted Product Catalog entries.
For more information on how the Normalization Engine uses aliases during normalization, see
Normalization steps and the Product Catalog .
Note
Product name or manufacturer aliases that are used in normalization are different from the
product aliases that you specify in the Product Alias Update window. The product aliases
that you create by using the Product Alias Update window specify another name for a
product in the Product Catalog and are used in BMC Change Management, license
compliance, Report Center, and other reports that use Product Catalog data. For more
information, see Creating a product alias in the Product Catalog .
Related Topics
Working with product and manufacturer aliases by using the Product Catalog Console
Working with product and manufacturer aliases by using the Manage Products Console
Marking a manufacturer as an alias in the Product Catalog
Marking a product as an alias in the Product Catalog
Deleting aliases from the Product Catalog
You can create, search, and edit product and manufacturer aliases in the Normalization Alias form.
Note
The product or manufacturer alias defined in the Normalization Alias form is different from
the product alias that is used by the Product Catalog for specifying another name for a
product entry. For more information, see Creating a product alias in the Product Catalog .
You can create aliases for a product only if the status of the product entry is Enabled.
To create product and manufacturer aliases by using the Product Catalog Console
1. From the Product Catalog Console, select General Functions > Search Normalization
Alias.
2.
BMC Atrium Core 9.0
Page 499 of 2268
Home

3. In the Normalization Alias form, specify the following details:
AttributeName: ManufacturerName or Model attribute
AliasName: Name of the discovered product or manufacturer
ActualName: Product or manufacturer name that you have specified for the product
in the Product Catalog
Status: Status of the alias as New, Assigned, Fixed, Rejected, or Closed
4. Click Save
To search for and edit product and manufacturer aliases by using the Product Catalog Console
1. From the Product Catalog Console, select General Functions > Search Normalization
Alias.
2. In the Normalization Alias form, specify search criteria.
3. Click Search.
4. Select an alias entry in the results list.
5. Edit the entry.
6. Click Save.
Note
While editing an alias in the Normalization Alias form, if you edit an alias so that it is
the same as an alias that already exists, an error message is displayed.
For information about creating product name and manufacturer aliases for normalization, see
83888.
Related topics
You can also create or modify a normalization alias for a product or manufacturer by using the
Manage Products Console. When you create an alias, the status of that alias is changed to Offline.
You can precede or follow the alias name with the % wildcard to associate multiple alias values
with a product. For example, instead of creating multiple aliases (MS Word 2000, Word 2000, and
Micro Word 2000) for the Microsoft Word 2000 product, you can use the % wildcard to create one
alias, %Word 2000%. In the normalization process, the Normalization Engine uses the LIKE
BMC Atrium Core 9.0
Page 500 of 2268
Home
operator to check for a Model or ManufacturerName alias.

Creating an alias this way adds a new entry in the Normalization Alias form.
To create a product or manufacturer alias by using the Manage Products Console

1. Search for the product by using Bulk Functions according to To search for product entries in
the Manage Products Console.
2. From the Products tab of the Search Results table, select a product.
3. Click Convert to Alias.
4. In the Normalization Alias area of the Convert Discovered/New Product to Alias window,
click Create.
5. In the Add Normalization Alias window, perform the following actions:
a. From the AttributeName list, select ManufacturerName or ModelName.
b. In the AliasName field, enter the name of the alias.
c. Click Add.
d. Click OK to confirm the creation of the alias.
e. Click Close.
The alias is displayed in the Normalization Alias table.
To modify a product or manufacturer alias by using the Manage Products Console

2. From the Products tab of the Search Results table, select a product that has an alias.
4. In the Normalization Alias area of the Convert Discovered/New Product to Alias window,
select the alias.
5. Click View.
6. In the Modify Normalization Alias window, perform the following actions:
a. In the AliasName field, enter a new name for the alias.
b. Click Save.
c. Click OK to confirm the modification of the alias.
d. Click Close.
The alias is displayed in the Normalization Alias table.
Related topics
BMC Atrium Core 9.0
Page 501 of 2268
Home

After you search for a product, you can mark its manufacturer as an alias. When you mark the
manufacturer as an alias, the status of that product is changed to Offline.
To mark the manufacturer of an existing product as an alias

4. In the Find Similar Products area of the Convert Discovered/New Product to Alias window,
search for the product for which you want to create the alias by specifying the first word of
the product name followed by %.
Example: Adobe%
All records except those that have been marked as alias are displayed in the table.
5. From the list of products in the Similar Products table, select the product for which you
want to mark the manufacturer as an alias.
6. Click Create Manufacturer Aliasto mark the discovered product manufacturer as a
manufacturer alias for the product selected from the Similar Products table.
Note
If you select a product from the table that has the same manufacturer as the
discovered product, you cannot mark it as an alias for the discovered product.
7. Click OK to confirm the creation of the alias and to list the alias in the Normalization Alias
table.
Related topics
BMC Atrium Core 9.0
Page 502 of 2268
Home

You can mark a product as an alias for normalization. When you mark a product as an alias, the
status of that product is changed to Offline.
Note
You cannot create an alias for an existing product entry that is marked as an alias.
To mark a product as an alias for normalization

2. From the Products tab of the Search Results table, select the product.
4. In the Find Similar Products area of the Convert Discovered/New Product to Alias window,
search for the product for which you want to create the alias by specifying the first word of
the product name followed by %.
Example: Adobe%
All records except those that have been marked as aliases are displayed in the table.
5. From the list of products in the Similar Products table, select the product for which you
want to mark the discovered product as an alias.
6. Click Create Product Name Alias to mark the discovered product as a product name alias
for the product selected from the Similar Productstable.
Note
You cannot mark a product as an alias if its ProductType attribute is different
from the selected product.
7. Click OK to confirm the creation of the alias.

The discovered product is listed in the Normalization Alias table.
Related topics
BMC Atrium Core 9.0
Page 503 of 2268
Home

You can delete entries from the Normalization Alias table for a selected product. Doing so erases
the alias entries from the Normalization Alias form.
To delete entries from the Normalization Alias table

4. From the Normalization Alias table in the Convert Discovered/New Product to Alias window
, select an entry.
5. Click Delete.
6. Click Yes to confirm the deletion.
Related topics
Working with name and manufacturer aliases by using the Product Catalog Console
Working with name and manufacturer aliases by using the Manage Products Console
Configuring datasets for normalization and new Product Catalog entries

To ensure that data from a dataset is normalized, you must configure the dataset for normalization
in the Normalization console.
When a dataset is configured for normalization and a new CI is discovered, the categorization
validation workflow performs a lookup for the product entry in the existing Product Catalog entries
to validate the CI. If no entries are found, the product entry is compared with the product
categorization aliases.
To configure a dataset for normalization, make sure that you select the Allow New Product
Catalog Entry option for that dataset in the Normalization console. Every time a new product name
and manufacturer combination is discovered, a new Product Catalog entry is created using the
preferred three categorization tiers and the discovered product name and manufacturer. The CI is
then validated and related to the - Global - company.
If a dataset is not configured for normalization, the categorization validation workflow does not
check the categorization of a discovered CI and the CI could be rejected.
BMC Atrium Core 9.0
Page 504 of 2268
Home
For more information, see the Normalizing data and Reconciling data topics.
CIs are not validated and created for products that are not in the Product Catalog and that are
coming from a dataset that is not configured for normalization
Note
When you install BMC Atrium Discovery or BMC BladeLogic Client Automation
Configuration Discovery Integration for CMDB, or both, in a server environment where the
Product Catalog is already installed, the BMC Atrium Discovery and Dependency Mapping
and BMC Configuration Import datasets are configured for normalization. In this situation,
you can skip this procedure. If you install BMC Remedy ITSM after you deploy the BMC
Atrium CMDB extensions from BMC Atrium Discovery, you must redeploy the extensions.
BMC Asset Management, BMC Change Management, the Incident Management feature
of BMC Service Desk, or the Problem Management feature of BMC Service Desk must be
installed.
Managing Product Catalog entries in bulk

This section describes how an application administrator can perform bulk actions on Product
Catalog entries that you have created manually, imported through the staging form, or created
through the Normalization Engine. The bulk actions include deleting or hiding products and
versions, updating product and version associations with BMC Atrium CMDB, setting the lifecycle
status for products and versions, and associating products and versions with a software license
contract.
Searching for product entries in the Manage Products Console
Viewing details of a product entry in the Manage Products Console
Bulk actions for managing Product Catalog entries
After you have populated data in the Product Catalog, you must update the associated version
information, assign the appropriate association with BMC Atrium CMDB, and set the lifecycle status
. You can individually update each product entry by using the Product Catalog Setup form, which
you can access by selecting General Functions > Search Products. However, this process
requires a lot of time if you have a large set of product entries to update. Instead, you can select
Bulk Functions > Manage Products to quickly manage a large set of product entries.
Note
The Manage Products Console, which you can access by selecting Bulk Functions >
Manage Products, has replaced the Search New Products console in earlier releases.
BMC Atrium Core 9.0
Page 505 of 2268
Home
The Manage Products Console enables you to easily manage multiple product entries for a
company. You can search for product entries that are associated with a company and then perform
bulk actions to update the selected product entries, such as updating product and version
associations with BMC Atrium CMDB, setting the lifecycle status for products and versions, or
associating product versions with a software license contract.
Searching for product entries in the Manage Products Console

The Manage Products Console enables you to search for and perform bulk actions on product
entries that are associated with a single company only. Before you specify the search criteria, you
must select the company for which you want to manage the product entries.
Note
The product entries that are associated with the - Global - company are available to all
companies.
All product entries are associated with the - Global - company by default. However, if you have set
up multitenancy, you can associate product entries with other companies. For information about
associating product entries with companies, see Approving and managing products, versions, and
patches in the Product Catalog . For information about setting up and managing companies, see
Product Catalog and multitenancy.
Note
The product entries that are provided by BMC (Third Party) are not displayed in the
search results and cannot be managed in bulk. To search for and update the product
entries that are provided by BMC, see Viewing and searching for product entries in the
Product Catalog.
You can also create, edit, or delete manufacturer or product name normalization aliases for the
product entries. Normalization alias entries are added to the NE:ProductNameAlias form. For more
information, see Product name and manufacturer normalization aliases in the Product Catalog .
To search for product entries in the Manage Products Console

1. From the Product Catalog Console, select Bulk Functions > Manage Products.
2.
BMC Atrium Core 9.0
Page 506 of 2268
Home
2. From the Company list in the Manage Products Console, select the company for which you
want to manage the product entries.
You can search for product entries that are associated with a single company only. Before
you specify the search criteria, you must select the company for which you want to manage
the product entries.
Note
If you select a company from the Company list in the Product Catalog Console
before opening the Manage Products Console, that company is selected by default
in the Manage Products Console.
3. Specify the search criteria for product entries:

Specify the product name or manufacturer.
Select the creator, or accept the default selection of Normalization Engine.
Custom entries are product entries that you have created manually or by importing
data from a different vendor. Normalization entries are product entries that are
created through the Normalization Engine.
Specify the date range.
Specify the data status.
When the Normalization Engine creates a new entry, the value for this field is set to
New. The other values displayed in the Data Status list are Work in Progress and
Completed.
4. Click Search.
By default, the products listed in the Search Results table are sorted based on the date and
time. The most recently discovered product is listed at the top in the table. The product
entries that have been marked as a normalization alias of another product entry are also
listed in the table.
Note
When a normalization alias is created for a product, the status of the product entry
that is marked as an alias is changed to Offline.
Viewing details of a product entry in the Manage Products Console

When you have the search results displayed in the Manage Products Console, you can view the
details of the products and versions that are listed.
BMC Atrium Core 9.0
Page 507 of 2268
Home
To view the details of a product entry in the Manage Products Console

1. Search for the product entry by specifying search criteria according to To search for product
entries in the Manage Products Console .
3. Click View Details.
4. In the View Product Details window, view the details of the product.
5. Click Close.
6. From the Model/Version tab of the Search Results table, select a version.
7. Click View Details.
8. In the View Product Model/Version Details window, view the details of the version.
9. Click Close.
Bulk actions for managing Product Catalog entries

You can perform the following bulk actions on Product Catalog entries:
Hiding or displaying products and versions in the Product Catalog Console in bulk
Relating product versions to a software license contract in bulk
Setting the life cycle status of products and versions in bulk
Editing details of products and versions in bulk
Setting the Approved, Managed, and Blacklisted status options of products and versions in
bulk
Using the Managed Product status to delete unwanted CIs in bulk
Deleting the association between a product or version and BMC Atrium CMDB in bulk
Deleting offline products and versions in bulk
Hiding or displaying products and versions in the Product Catalog Console in bulk
You can control the display of products and associated versions in the Product Catalog Console.
By hiding products or versions that are not used frequently, you can reduce the number of
displayed products and versions in the Product Catalog Console. When you hide a product or
version, that product or version is retained in the Product Catalog and it appears in search results if
it matches the criteria.
To hide or display products in the Product Catalog Console in bulk
To hide or display versions in the Product Catalog Console in bulk
To hide or display products in the Product Catalog Console in bulk

1. Search for the products by specifying search criteria according to To search for product
2. From the Products tab of the Search Results table, select the products that you want to
hide or display in the Product Catalog Console.
3. From the Select Actions list, select Set > Hide Products and perform one of the following
actions:
BMC Atrium Core 9.0
Page 508 of 2268
3.
Home
To hide the selected products, select Yes.

To display the selected products, select No.
Note
When you hide a product, all the versions associated with that product are
also hidden in the Product Catalog Console.
4. Click Perform.
To hide or display versions in the Product Catalog Console in bulk

2. From the Products tab of the Search Results table, select one or more products.
The versions associated with the selected product are displayed in the Model/Version tab.
3. From the Model/Version tab of the Search Results table, select the versions that you want
to hide or display in the Product Catalog Console.
4. From the Select Actions list, select Set > Hide Versions and perform one of the following
actions:
To hide the selected versions, select Yes.
To display the selected versions, select No.
5. Click Perform.
Relating product versions to a software license contract in bulk

You can relate specific product versions to a software license contract in BMC Asset Management
to facilitate software license compliance of specified software configuration items.
BMC Asset Management provides dynamic mechanisms to connect the software that has been
deployed and represented in BMC Atrium CMDB. License certificates provide a definition of how to
find the software in BMC Atrium CMDB and leverage information from the Product Catalog, so that
the searches are performed using a consistent, normalized set of data. The license engine uses
this information to query BMC Atrium CMDB to find the new or updated software that has been
deployed, and to connect that software to the appropriate license certificates. For more information
about managing software licenses, see Setting up the Software License Management process in
the BMC Asset Management online documentation.
To relate all product versions to a software license contract in bulk
To relate specific product versions to a software license contract in bulk
BMC Atrium Core 9.0
Page 509 of 2268
Home
To relate all product versions to a software license contract in bulk

2. From the Products tab of the Search Results table, select the products for which you want
to relate all versions to a software license contract.
3. From the Select Actions list, select Set > Requires Contract > Yes.
4. Click Perform.
To relate specific product versions to a software license contract in bulk

The versions associated with the selected products are displayed in the Model/Version tab.
Note
If you do not select any product from the Products tab of the Search Results table
, the Model/Version tab does not display any product versions.
3. From the Model/Version tab of the Search Results table, select the versions that you want
to relate to a software license contract.
4. From the Select Actions list, select Set > Requires Contract > Yes.
5. Click Perform.
Setting the life cycle status of products and versions in bulk

You can set the life cycle status of products and versions in the Product Catalog, based on which a
product such as BMC Remedy ITSM can define actions. For example, you can define an action in
BMC Remedy ITSM that a finance application can be installed in the production environment only if
it is marked as Released.
To set the life cycle status of products in bulk

2. From the Products tab of the Search Results table, select the products for which you want
to set a particular life cycle status.
3. From the Select Actions list, select Set > Product Life Cycle.
4. Select one of the following life cycle options:
Development The product is being created or assembled and is not yet tested.
BMC Atrium Core 9.0
Page 510 of 2268
4.
Home
Test The product development is complete but the product is being validated.
A test product could be approved for a select group of people for testing purposes.
Released The product development and testing are complete, and it is ready for
5. Click Perform.
Note
The life cycle status that you set for a product is also applicable for all the versions
associated with that product.
To set the life cycle status of versions in bulk

The versions associated with the selected product are displayed in the Model/Version tab.
3. From the Model/Version tab of the Search Results table, select the versions for which you
want to set a particular life cycle status.
4. Select Set > Version Life Cycle from the Select Actions list.
5. Select one of the following life cycle options:
Development The version is being created or assembled and is not yet tested.
Test The version development is complete but the version is being validated.
A test version could be approved for a select group of people for testing purposes.
Released The version development and testing are complete, and it is ready for
6. Click Perform.
Note
The life cycle status that you set for a version is also applicable for all the patches
associated with that version.
Editing details of products and versions in bulk

You can simultaneously edit the details of multiple products and versions.
To edit details of products in bulk
To edit details of versions in bulk
BMC Atrium Core 9.0
Page 511 of 2268
Home
To edit details of products in bulk

3. From the Select Actions list, select Modify > Product Details.
4. Click Perform.
5. In the Product Category Update window, edit the details of the selected products.
Note
The Product Name, Manufacturer, and Origin fields are disabled when you are
editing the details of multiple products.
6. Click Modify.
To edit details of versions in bulk

3. From the Select Actions list, select Modify > Version Details.
4. Click Perform.
5. In the Product Model-Version window, edit the details of the selected versions.
Note
The Product Model/Version field is disabled when you are editing the details of
multiple product versions.
6. Click Modify.
Setting the Approved, Managed, and Blacklisted status options of products and versions in
bulk
This topic provides instructions for setting the Approved, Managed, and Blacklisted options.
To set status options for products in bulk
To set status options for versions in bulk
BMC Atrium Core 9.0
Page 512 of 2268
Home
You can set the Approved, Managed, and Blacklisted status options of products and versions by
modifying the flags that indicate the association between Product Catalog entries and BMC Atrium
CMDB.
The Product Associations with CMDB options are mapped to a combination of settings for
the Approved Product, Managed Product, and Blacklisted Product status options that are
displayed on the Product Catalog Setup window.
The Version Associations with CMDB options are mapped to a combination of settings for
the Approved Version, Managed Version, and Blacklisted Version status options that are
displayed on the Product Catalog Setup window.
For more information about the status options, see Approved Product, Managed Product, and other
status options in the Product Catalog .
Product or Version Associations with CMDB options mapping with the status options
Product Associations with CMDB OR{}Version Associations with CMDB
Approved
Managed
Blacklisted
Approved and Managed
Yes
Yes
No
Yes
No
No
Yes or No
Yes or
No
Yes
No
Yes
No
No
No
No
Select this option for products or versions that are approved for use in the production
environment and which should trigger an action from IT.
For example, Calbro Services has approved the use of the Microsoft Word product in their
environment but wants to manage the number of instances that are installed based on the
available licenses. In this case, Calbro Services selects the Approved and Managed
option for the Microsoft Word product entry.
Approved and Unmanaged
Select this option for products or versions that are approved for use in the production
environment but which should not be tracked by IT.
For example, Calbro Services has approved the use of the Notepad product in their
environment but does not want to manage the number of instances that are installed. In
this case, Calbro Services selects the Approved and Unmanaged option for the Notepad
product entry.
Blacklisted
Select this option for products or versions that are not approved for use in the production
environment but which should trigger an action from IT.
For example, Calbro Services has identified that a security risk is associated with a
specific version of a product that is installed in their environment. In this case, Calbro
Services selects the Blacklisted option for the specific version of that product entry.
Unapproved and Managed
environment but which should trigger an action from IT.
BMC Atrium Core 9.0
Page 513 of 2268
Home
Product Associations with CMDB OR{}Version Associations with CMDB
Approved
Managed
Blacklisted
Unapproved and Unmanaged

environment and which should not trigger an action from IT.
To set status options for products in bulk

3. From the Select Actions list, select Modify > Product Associations with CMDB, and
select the appropriate option.
Note
If you change the Approved and Managed option to the Blacklisted option for a
product, the corresponding Blacklisted Product status option on the Company/
Module Relationship window is set to Yes. The existing Yes value of the
corresponding Approved Product and Managed Product status options is not
changed. In this case, the Blacklisted Product status option is given a higher
precedence.
4. Click Perform.
To set status options for versions in bulk

3. From the Model/Version tab of the Search Results table, select one or more versions.
4. From the Select Actions list, select Modify > Version Associations with CMDB, and
select the appropriate option.
Note
If you change the Approved and Managed option to the Blacklisted option for a
product version, the corresponding Blacklisted Version status option on the
Company/Version Relationship window is set to Yes. The existing Yes value of the
Approved Version and Managed Version status options is not changed. In this
case, the Blacklisted Version status option is given a higher precedence.
BMC Atrium Core 9.0
Page 514 of 2268
Home
5. Click Perform.
Using the Managed Product status to delete unwanted CIs in bulk

Your organization might not want to track all approved products in the BMC.ASSET production
database. For example, the Notepad++ or Winzip applications might be approved products in an
organization, but the organization might not choose to track and manage them, because they do
not require licenses. With the Managed status, you can select the products to track.
You can configure BMC Atrium CMDB so that if the Managed status is not set for a product, CIs
associated with that product are marked for deletion during normalization. Then a reconciliation
purge activity deletes that CI from the CMDB dataset. In this way, you can leverage the Managed
status to purge unnecessary CIs that are populated in the BMC Atrium CMDB datasets by
discovery tools.
Use the following procedure to delete CIs (instances) of unmanaged products.
Before you begin
To delete CIs (instances) of unmanaged products in bulk
Important
By default, the Managed status is set to No. Before configuring BMC Atrium CMDB to
delete instances of unmanaged products, be sure to review the Managed status setting for
all Product Catalog entries.
Before you begin

Evaluate the Managed status setting for Product Catalog entries. For Product Catalog entries
whose instances you do not want to delete, set the Managed status option to Yes.
For more information, see Approving and managing products, versions, and patches in the Product
Catalog and Setting the Approved, Managed, and Blacklisted status options of products and
versions in bulk.
To delete CIs (instances) of unmanaged products in bulk

1. Open the BMC.CORE.CONFIG:BMC_CMDBCompent form in search mode by using the
direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/
BMC.CORE.CONFIG:BMC_CMDBCompent
2. Search for the record to modify:
a. Click New Search.
b. Enter the following in the Component ID field:
com.bmc.cmdb.normalizationEngine
c.
BMC Atrium Core 9.0
Page 515 of 2268
2.
Home
c. Enter the following in the Property Name field:

com_bmc_ne_system_DeleteUnmanagedInstances
d. Click Search.
3. Change the value in the Property Value field to TRUE.
4. Click Save.
5. Run a normalization job, or wait for the next continuous or batch normalization job to finish.
During normalization, CIs of unmanaged products are marked for deletion (the
MarkAsDeleted flag is set to Yes ).
6. Run a reconciliation job that contains a purge activity.
CIs marked for deletion are removed from BMC Atrium CMDB.
Deleting the association between a product or version and BMC Atrium CMDB in bulk
You can delete the association between BMC Atrium CMDB and products and versions in the
Product Catalog.
To delete the association between products and BMC Atrium CMDB in bulk
To delete the association between versions and BMC Atrium CMDB in bulk
Note
If the selected products are associated with a company other than the "- Global -"
company, the association between that company and the selected products is removed
and an association with the "- Global -" company is created. The same product-company
association is also created for the versions and patches of the selected products. If the
selected products are associated with the "- Global -" company, the Delete > Product
Associations with CMDB operation is not performed for those product entries.
To delete the association between products and BMC Atrium CMDB in bulk
3. From the Select Action list, select Delete > Product Associations with CMDB.
4. Click Perform.
To delete the association between versions and BMC Atrium CMDB in bulk
3. From the Model/Version tab of the Search Results table, select one or more versions.
4.
BMC Atrium Core 9.0
Page 516 of 2268
Home
4. From the Select Action list, select Delete > Version Associations with CMDB.
5. Click Perform.
Deleting offline products and versions in bulk

You can delete only those products and versions that are marked as Offline in the Product Catalog.
For information about changing the status of a product to offline, see To relate a company to
Product Catalog entries. When you delete a product, its versions and company and relationship
associations are also deleted.
To delete offline products in bulk

2. From the Products tab of the Search Results table, select the offline products that you
want to delete.
3. From the Select Actions list, select Delete > Products.
4. Click Perform.
5. Click OK to confirm the deletion.
To delete offline versions in bulk

3. From the Model/Version tab of the Search Results table, select the offline versions.
4. From the Select Actions list, select Delete > Versions.
5. Click Perform.
6. Click OK to confirm the deletion.
Exporting Product Catalog data

Before attempting to export the data, you must understand what data is required and how this data
is represented on the Product Catalog Console.
The Product Catalog consists of a collection of products and suites. Software products are
composed of one or more files. Each product entry contains information, such as the name, the
manufacturer, and the version number of the application. Suites are composed of one or more
products. A suite is technically a product that is identified as having a relationship to one or more
other applications. Each of these elements is represented by a staging form as explained in
Overview of importing custom Product Catalog data .
BMC Atrium Core 9.0
Page 517 of 2268
Home
You can export Product Catalog entries in bulk to external files or staging forms. You must export a
number of forms from the preproduction server, as indicated in Staging forms used for importing
custom Product Catalog data.
Before you begin

Create a new report of AR System type for each staging form. When designing this report, include
all the fields. You use this report to export the data in .arx format.
To export data from the Product Catalog

1. Log on to the BMC Remedy ITSM server as an administrator.
2. Use one of the following methods to open the appropriate form:
Enter the direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/yourForm
For example, to open the PDL:ESIDversioninfoCustom form:
http://CalbroServer:8080/arsys/forms/SanJoseServer/PDL:ESIDversioninfoCustom
Open the Object List to search for the form:
http://<midTierServer>:<portNumber>/arsys/forms
If the form has an alias, you must search for the alias. Otherwise, search for the form
name. If you see two versions of the form listed, select the object listed as a Form,
and not the Join Form.
For more information about creating reports and configuring the object list, see Using
the Object List in the BMC Remedy Action Request System online documentation.
3. Make sure that the form is in Search mode.
4. Search for all records in the form or for just the subset that you want to export.
To search for all records, leave the form blank and click Search.
If an error occurs when you perform an unqualified search or if your query hits the 1000record query limit, perform the following steps:
a. Open the IT Home page.
b. Open the AR System Administration Console for the BMC Remedy ITSM server.
c. Click System > General > Server Information.
d. On the AR System Administration: Server Information form, click the Configuration
tab.
e. Select Allow Unqualified Searches.
f. In the Server Table Chunk Size field, enter a different value (for example, 0, for
unlimited records returned in the query). This setting can result in slower performance
.
g. Click OK.
You can then return to the form and perform the search.
5. Create reports to export the data from the staging forms.
a.
BMC Atrium Core 9.0
Page 518 of 2268
Home
5.
a. Select all the records returned in the search.
b. Click the Report button.
When the Reporting Console opens, reports that are associated with the form and
that you have permission to access appear in the list. The list can include AR System,
BIRT, and Crystal types of reports. If no reports appear in the Reporting Console list,
you must create a new AR System type of report.
c. To generate .arx output, select an AR System type report, as identified in the Report
Type field.
All the records that you selected are passed to the report.
If no reports appear in the Reporting Console list, either there is no report
associated with this form or you do not have permission to access it. In that case, you
must create a new AR System type of report.
d. In the Destination field, select File.
e. In the Format field, select AR Export.
f. Enter a name for your report.
Change the file name to the form name, and do not use illegal characters.
g. Click Run.
6. Repeat this procedure for each staging form that you are exporting.
Modeling data and impacts in BMC Atrium

CMDB
The following topics provide information and instructions for modeling data:
Modifying your data model
Deprecating classes and attributes in your data model
Administering CI impact models
Summary of changes to the Common Data Model
Modifying your data model

As you evaluate your business environment and plan your data model, you might determine that
the Common Data Model (CDM) installed with BMC Atrium CMDB is not sufficient to store
information for some of your assets.
Creating, modifying, or deleting classes with the Class Manager
Defining custom icons for a class instance
Defining CI labels for a class
BMC Atrium Core 9.0
Page 519 of 2268
Home
Defining BMC Atrium Explorer tooltips for a class

Defining Quick Edit attributes for a class
Defining instance group thresholds for a class
Creating Data Model Help with the cdm2html utility
The following example illustrates how you might update the data model for your particular needs.
Suppose you are a BMC Atrium CMDB administrator at the fictional company Calbro Services and
you want to track the model year of several of the devices on the network, such as servers,
workstations, and routers. Because the model year is a critical piece of information, you want to
include it in the data model. You have reviewed the recommendations in Planning the data model,
and have decided that the best approach is to extend the data model by adding a new attribute to
an existing class.
After referring to the BMC Atrium CMDB Data Model Help, you determine that the new attribute
should be added to the BMC_ComputerSystem class. Because each subclass inherits attributes
from its superclass, the BMC_Mainframe and BMC_Printer classes also use the new attribute.
However, not every element that can be tracked by the BMC_ComputerSystem class and its
subclasses needs a model year attribute. For example, the model year is not important for load
balancers and firewalls. You decide that the attribute should be optional.
Using Class Manager, you can add a new, optional attribute to the BMC_ComputerSystem class.
Note
Before extending the CDM, review the recommendations in Planning the data model.
Adding new classes and attributes are among the last things you should consider.
Creating, modifying, or deleting classes with the Class Manager

You use the Class Manager to add, modify, or remove classes in your data model.
Process overview for creating or modifying classes
Defining class properties in the Class Manager
Namespaces and partitioning the data model
Setting class permissions in the Class Manager
Creating CI and relationship class attributes
Propagating attributes for weak relationships
Specifying class indexes from the Class Manager
Deleting a class with the Class Manager
Saving the data model as an image
Status of classes after you make changes
BMC Atrium Core 9.0
Page 520 of 2268
Home
Warning
Do not use BMC Remedy Developer Studio to modify classes and attributes directly on
class forms. Modifying the BMC Atrium CMDB data model requires more than just editing
a form, and you might break some functionality.
Federated data and federated relationship classes appear in Class Manager. You can update some
properties of a federated class through Class Manager (for example, Author). However, you cannot
create attributes in these classes through Class Manager. You modify these classes in Federation
Manager, as described in Editing a federated data class and Creating or editing a federated
relationship class.
Recommendations
BMC Software recommends that you attempt to use the classes and attributes in the BMC CDM as
they were originally defined. However, you might have corporate reasons to extend the data model.
You can create your own classes or extend classes by adding attributes, and these changes are
preserved across upgrades.
Never modify the core CDM class attributes because upgrades across versions overwrite these
customizations. Modifications to the CDM, for example, changing the attribute field length in a class
, are not preserved during upgrades.
For recommendations for extending the data model, see Planning to extend the data model . For
information about the process for creating or modifying a class, see Process overview for creating
or modifying classes.
Process overview for creating or modifying classes

If you must add a new class to the data model, follow the process outlined by the following steps. If
you must modify an existing class, you can enter the process at any step, or perform any step
independently.
Recommendations
BMC recommends that you set Development Cache Mode in the Configuration tab on the BMC
Remedy AR System Administration: Server Information window before you create or modify classes
. Otherwise, you might experience server crashes due to server memory exceeding 2 GB during
copy of the server cache. When you finish your changes to the data model, clear the Development
Cache Mode.
BMC Atrium Core 9.0
Page 521 of 2268
Home
Creating or modifying classes process
1. Define the properties of the class, which include its type, how it stores data, and (for
relationship classes) the relationship type. For more information, see Defining class
properties in the Class Manager.
2. (optional) Specify permissions. If you do not specify permissions for a class, BMC Atrium
CMDB assigns default permissions. For more information, see Setting class permissions in
the Class Manager.
3. Define one or more CI and relationship class attributes. For more information, see Creating
CI and relationship class attributes.
4. (optional) Propagate attributes in a weak relationship. This step is necessary only if you have
created a relationship class that has a weak relationship in which the attributes from one
class should be propagated to another class. For more information, see Propagating
attributes for weak relationships.
5. (optional) Specify indexes. Indexing can reduce database query time, so index attributes that
you expect users to use in queries frequently. For more information, see Specifying class
indexes.
6. (optional) Configure instance auditing for the class. Auditing enables you to track the
changes made to instances of a class. For more information, see Configuring auditing for a
class.
Note
When you use the Class Manager to create a new class, a delay of up to five
minutes might occur before a user can start creating instances of that class in BMC
Atrium Explorer. This delay happens only rarely, typically in test environments, and
is caused by how admin cache memory works in the BMC Remedy AR System
when you create objects from a new form. In general, BMC Atrium Core users do
not experience delays in a production environment.
BMC Atrium Core 9.0
Page 522 of 2268
Home
Defining class properties in the Class Manager

The BMC Atrium CMDB Class Manager helps you define properties for Configuration Item (CI) and
relationship classes. The properties of a class define the class and how it stores data.
To define class properties
Common CI and relationship class properties
For more information on class and relationship properties, see Common CI and relationship class
properties.
To define class properties

1. In the Class Manager, browse the data model until you have selected the class that will be
the superclass for the new class.
2. In the toolbar, click either New CI Class or New Relationship Class.
3. In the Properties section of the Generaltab, enter information as described in the following
table.
Note
You cannot modify the Data Storage Method, Final, and Singleton fields after
you have saved a class.
4. (optional) In the Additional Information section of the More Information tab, enter a
description of the class in the Description field.
5. If the class is a relationship class, define relationship type properties as described in the
following table; otherwise skip this step.
BMC Atrium Core 9.0
Page 523 of 2268
6.
Home
Action
Steps
You want to provide additional information

for the class
Continue with the process described in Process overview for creating or

modifying classes.
You are finished working with this class
a. Click OK.
b. In the confirmation dialog box, click OK.
Common CI and relationship class properties

This section describes the common CI and relationship properties you can define when defining a
class.
For information on defining class properties, see Class properties. The class properties
defined in the CI Class and Relationship Class dialog boxes are listed in the following table.
This table also describes how you should enter information for those properties when
creating a new class.
Most of these properties are fields on the General tab of the CI Class and Relationship Class
dialog boxes. The Description field is on the More Information tab.
For information on relationship classes that define how the relationship functions with CI
classes, see Additional properties for Relationship classes .
Class properties
Class properties
Property
Description
Class Type
Indicates the type of class.
Super
Class
Select a class to be the parent class of the new class.
Namespace
Select a namespace from the list or enter a new namespace. For more information, see Namespaces and
partitioning the data model.
Class
Name
Enter a name that describes the class. Class names are limited to alphanumeric characters and underscores.
Status
Indicates the current state of the class. You cannot enter a new value in the Status field. When you create or
modify a class, its Status is set automatically to Change Pending.
Author
Enter your name, as the person who created the class.
Final
Select the Final check box to prevent subclasses from being created for the new class. For more information, see
How additional subclasses extend the data model.
Singleton
Select the Singleton check box if this class represents a unique CI. For more information, see How additional
subclasses extend the data model.
Description
Enter a brief description of the class, such as information about the type of data stored by the class, how the class
should be used, and any unusual characteristics of the class.
BMC Atrium Core 9.0
Page 524 of 2268
Home
Property
Description
Note
This property is in the More Information tab.
Data
Storage
Method
Select an option:
Regular--The class stores instances on its own BMC Remedy AR System form. If the class is a subclass, the
AR System form is a join form that joins the attributes of the superclass with the attributes unique to the
subclass.
Categorization-- The class stores instance attributes in the AR System form of its superclass rather than in a
join form. A join form is still created using the class name for your convenience, but it is not part of the
inheritance tree.
Abstract with data replication--The class cannot hold any direct instances, but instances of its subclasses are
replicated to a form that holds only the attributes of the superclass.
Abstract without data replication--The class cannot hold any direct instances and does not have an AR
System form.
For more information about data storage methods for classes, see BMC Atrium CMDB data storage methods
.
Custom
Properties
A list of user-defined custom characteristics for the class. The ID for each list item can be set to any user-defined
characteristic but must be between 100000 and 199999. You must enter the custom properties in serialized format:
<listSize>\<propId>\<dataType>\<propValue>\<propId>\<dataType>\<propValue>\...
For example, the serialized property list could be represented as 1\100050\2\1.
listSize The number of items in the properties list.
propId The ID for the property, which is within the 100000-199999 range.
dataType The data type for the property, which can be of any native data type as specified in the ar.h file.
For example, an integer is 2 and a character string is 4. For more information, see BMC Atrium CMDB C API
header files.
propValue The value for the property. For some data types, the <propValue> can contain information
about the value itself.
For data types CHAR, DIARY, VIEW, and DISPLAY, the <propValue> contains both the data value length
and the prop value, so the serialized format is:
<listSize>\<propId>\<dataType>\<dataLength>\<propValue>
For data type DECIMAL, the serialized format is:
<listSize>\<propId>\10\<valueLength>\Value
For data type CURRENCY, the serialized format is:
<listSize>\<propId>\12\<valueLength>\Value\<currencyCodeLen>\<currencyCode>\<
timeStamp>\<numItems>\<funcValueLength>\<funcValue>\<funcCurrencyCodeLength>\<
funcCurrencyCode>
For example, a Custom Properties list containing one value, an integer with ID 100050 and value 1 would be
formatted: 1\100050\2\1
For example, a custom property of data type CHAR, ID 100000, and value of Houston would be formatted: 1
\100000\4\7\Houston
For example, a custom property of data type CURRENCY, ID 100001, and value of $3.30 would be
BMC Atrium Core 9.0
Page 525 of 2268
Home
Property
Description
formatted: 1\100001\12\4\3.30\3\USD\1242870112284\1\4\3.30\3\USD
Combining two properties in a list would be formatted:
2\100000\4\7\Houston\300001\12\4\3.30\3\USD\1242870112284\1\4\3.30\3\USD
Additional properties for Relationship classes

Relationship classes require additional properties that define how the relationship functions with CI
classes.
Member classes Two CI classes must be members of a relationship class. Class 1 is the
source member and Class 2 is the destination member. If you need directionless or
directionally symmetric relationships, you can create another relationship with Class 1 and
Class 2 switched.
Roles Refers to the relationship roles of the member classes. You can use the default
Source and Destination roles, or you can specify new roles when you create a relationship
class. Role names are used as prefixes on the field labels of attributes pertaining to each
member class.
The following table lists the properties defined in the Relationship Class dialog box, and how you
should enter information for those properties when creating a new class.
Relationship type properties

Property
Description
Class 1
Select a class to use as the source class.
Class 2
Select a class to use as the destination class.
Role 1
Enter a role name for Class 1. By default, this is Source.
Role 2
Enter a role name for Class 2. By default, this is Destination.
Cardinality
Select a cardinality:
One to one--Each instance of Class 1 can have this relationship with one instance of Class 2.
One to many--Each instance of Class 1 can have this relationship with multiple instances of Class 2.
Many to one Multiple instances of Class 1 can have this relationship with each instance of Class 2.
Many to many Each instance of Class 1 can have this relationship with multiple instances of Class 2, and
vice versa.
BMC Atrium CMDB enforces the cardinality of a relationship class. Fulfilling a "many" cardinality means that
multiple instances of the relationship exist.
Cascade
Delete
Select the Cascade Delete check box to delete (or mark as deleted) the destination member whenever the source
member is deleted (or marked as deleted). This field applies only to relationships with a left-hand cardinality of One
to One or One to Many.
Weak
Reference
BMC Atrium Core 9.0
Page 526 of 2268
Home
Property
Description
Select the Weak Reference check box to create a composite object with the relationship and its member instances
in which the destination member is a weak entity. This field applies only to relationships with a left-hand cardinality
of One.
Propagated
Attributes
If you have selected classes in the Class 1 and Class 2 fields and you have selected the Weak Reference check
box, click Propagated Attributes to map attributes between members of a weak relationship. For more information,
see Propagating attributes for weak relationships.
Namespaces and partitioning the data model

You can partition the data model by using namespaces. Unlike datasets, which partition instance
data, namespaces partition classes and attributes in the data model. This allows you to specify the
provider or consumer of a certain type of data, or to make other arbitrary groupings. For example,
all classes in the Common Data Model are in the BMC.CORE namespace, and other classes
provided by BMC Atrium CMDB that hold information such as configuration definitions are in the
BMC.CORE.CONFIG namespace.
Other BMC Software products that extend the data model, such as BMC Impact Solutions or BMC
Atrium Discovery and Dependency Mapping, create their own namespaces to hold the new classes
and attributes. Likewise, BMC extensions that are distributed independently of BMC products use
their own namespaces.
Namespaces can be applied at the attribute level as well as the class level. This means that some,
or even all, of the attributes of a class can reside in a different namespace from the class itself. This
is useful when you have a class that is used for more than one purpose, but one of those purposes
requires an extra attribute.
A namespace serves as a label to identify classes that serve different purposes, and serves also to
create unique names. A namespace prepends the names of its class forms, though not its attribute
fields. Therefore, a class that you create in one namespace can have the same name as an
existing class in another namespace. However, attributes of the same class in different
namespaces cannot share the same name.
Namespaces do more than just serve as a logical categorization system for the data model.
Because many reconciliation definitions allow you to specify namespaces, you can easily target a
reconciliation activity to include only data that is being stored for a particular purpose. Instead of
creating a lengthy qualification to select or omit several specific classes, you can include or omit
them from an activity by specifying their namespace.
Whenever you extend the data model, use your own namespace instead of BMC.CORE. This
prevents your extensions from being overwritten by new BMC Software classes when you upgrade
BMC Atrium Core 9.0
Page 527 of 2268
Home
to a future version of the CDM. When creating namespaces, use the naming convention
COMPANYNAME.PURPOSE. For example, if the Calbro Services company created a set of classes
for storing data about buildings and other facilities-related CIs, they might store them in the
namespace CALBRO.FACILITIES.
Setting class permissions in the Class Manager

The Class Manager helps you set permissions for CI and relationship classes. Class and attribute
permissions determine which users, according to their groups and roles, can view and modify
classes and attributes.
To set permissions for a class
Default visible permissions
To set permissions for a class

1. In the Class Manager, open a class for editing.
2. On the General tab, open the Permissions section.
3. In the Hidden Permissions list, select one or more groups and roles to have access to the
class without being able to see it in lists of classes.
4. In the Visible Permissions list, select one or more groups and roles to have access to the
class and be able to see it in lists of classes.
If you do not specify permissions, BMC Atrium CMDB assigns default permissions.
Action
Steps
You want to provide additional information for

the class

modifying classes.

1. Click OK.
BMC Atrium Core 9.0
Page 528 of 2268
Home
Default visible permissions

If you do not set permissions in the Class Manager, BMC Atrium CMDB automatically assigns the
following default visible permissions:
CMDB Data Change
CMDB Data Change All
CMDB Data View
CMDB Data View All
For more information about BMC Atrium CMDB permissions, see Groups installed with BMC Atrium
CMDB.
Creating CI and relationship class attributes

The BMC Atrium CMDB Class Manager helps you create attributes for Configuration Items (CI) and
relationship classes. The Attributes tab of the CI Class and Relationship Class dialog boxes helps
you manage the attributes of a class.
To create an attribute
Class attributes in the Class Manager
Before creating an attribute for a CI class, determine whether you want to store configuration data
or lifecycle data for the CI in the new attribute. You must create a new attribute to store only
configuration data for the CI. To store lifecycle data for the CI, you must add a field on the BMC
Remedy ITSM Foundational form, AST:Attributes.
Note
Version 8.0 of BMC Remedy IT Service Management moved the CI lifecycle data out of
BMC Atrium Configuration Management Database (BMC Atrium CMDB) and included the
data as fields in the BMC Remedy ITSM Foundational form, AST:Attributes. For detailed
information about the changes, see Changes to the BMC Atrium CMDB for BMC Remedy
ITSM.
BMC Atrium Core 9.0
Page 529 of 2268
Home
To create an attribute
2. In the CI Class or Relationship Class dialog box, click the Attributes tab.
3. In the Attributes tab, click New.
4. In the Attribute dialog box, enter information for the common fields, as listed in the following
table.
5. Enter information for the optional fields specific to your selection for the Data Type field, as
listed in the following table.
6. (optional) In the Permissions section, select groups and roles that can view and modify the
attribute.
If you do not specify permissions, BMC Atrium CMDB assigns the following permissions:
View permissions
Change permissions
CMDB Data View

CMDB Data View All
CMDB Write Security

CMDB Data Change
CMDB Data Change All
7. To add more attributes, repeat step 3 through step 6.

8. Click OK to close the Attribute dialog box.
Action
Steps

the class

modifying classes.

1. Click OK.
BMC Atrium Core 9.0
Page 530 of 2268
Home
Class attributes in the Class Manager

The Class Name column lists the selected class and the superclasses from which the class inherits
attributes. For example, the Attributes tab for the BMC_Patch class lists the BMC_BaseElement,
BMC_Patch, BMC_Software, and BMC_SystemComponent classes. Click the arrow next to a
class to show all of the attributes for that class.
Attributes of the BMC_Patch class
You can view, modify, and delete existing attributes of a class. However, you can modify or delete
only attributes that are unique to a class. You cannot modify or delete attributes inherited from a
superclass.
When creating an attribute of the Selection data type, you can specify custom enumeration values
instead of the default values, which start at 0 and increment by 1. This allows you to leave unused
any numbers between the values you select. The benefit is that you can later add a selection
between two others without invalidating existing data by changing the enumeration of the existing
selections.
Note
BMC Atrium Core 9.0
Page 531 of 2268
Home
New attributes are not automatically visible on the class forms. For information about
laying out attribute fields on class forms, see Control of the layout of class forms .
Common attribute fields

You can define common attributes for every attribute data type.
The following table lists the fields that appear in the Attribute dialog box and describes how you
should enter information for those fields when creating an attribute. Fields marked with an asterisk
are required.
Field
Description
Data Type
The type of information that the attribute contains. After you select a data type, data type characteristics fields
specific to your selection appear to the right of the Data Type field. For more information about these fields, see
Data Type attribute fields.
Attribute
Name
A descriptive name of up to 80 alphanumeric characters (including underscores) that is indicative of the function.
Note: There is no mechanism in the Class Manager to specify a localized label to appear in place of the Attribute
Name on the class form. To change the label, use BMC Remedy Developer Studio to create or edit the appropriate
view of the class form. For more information about BMC Remedy AR System views, see Form views.
Namespace
Namespace for the attribute. Select or enter a namespace if this attribute should be in a different namespace than
the class that contains it. To use the class namespace, leave this field blank. For more information, see
Namespaces and partitioning the data model.
Field ID
ID of the field created for the attribute on the class form. It is an integer that must be greater than 536870911 but
less than 2147483647, which is the default maximum value for field IDs. To have the system generate an ID, leave
this field blank.
Entry Mode
Mode that determines whether the attribute must contain a value for each instance and whether its value is stored
in the database. It can be any one of these options:
Required The attribute value must be filled in when a user creates an instance. A required attribute
appears with a bold label in the class form.
Optional You can enter information for the attribute or leave it empty.
Display only The attribute is used as a temporary field. The value of the attribute is not stored in the
database.
Audit
Option
An option that determines whether changes to this attribute value trigger an audit:
Audit Changes to the value trigger an audit.
Copy Changes to the value cause the attribute to be written to the audit form.
Audit and Copy Changes to the value trigger an audit and cause the attribute to be written to the audit
form.
The default is None. For more information about these options, see Attribute audit options in classes.
Attribute
Type
The type of the attribute, either regular or core. You can create only regular attributes.
Custom
Properties
Additional information about the attribute. You must enter the custom properties in serialized format. The
serialization format for most attribute items is:
<listSize>\<propId>\<dataType>\<dataLength>\<propValue>
Custom properties for attributes are the same as for classes. For more information, see Custom Properties.
BMC Atrium Core 9.0
Page 532 of 2268
Home
Field
Description
Primary
Key
Read-only value that indicates whether the attribute is a primary key for an index of this class in the database. For
more information about indexes, see Indexes and class attributes.
Hidden
An option that determines whether the attribute is hidden on the class form.
Data Type attribute fields
Some fields in the Attribute dialog box appear only when you select certain values for the Data
Type field.
The following table describes the fields on the Attribute dialog box that appear according to the
Data Type selected for the attribute. All of these fields are optional. For more information about
these fields, see:
BMC Remedy AR System Field types
BMC Remedy AR System Data fields
Fields
Description
Applicable
data types
Allowable
Currency
Types
List of currency types allowed.
Currency
Attachment
Pool
Name of the attachment pool to which the attachment field belongs.
Attachment
Field
Default
Value
Value that is saved for the attribute when a new instance is created if you do not enter
BMC Atrium Core 9.0
a value. The Default Value can be a static value or a keyword from the field menu.
Character
Currency
Page 533 of 2268
Home
Fields
Description
Applicable
data types
Date
Date/
Time
Decimal
Diary
Integer
Real
Selection
Time
Enum Type
Specifies the way in which selection-field options are ordered in the database.
Selection
Regular BMC Remedy AR System assigns the IDs beginning with 0 and
incrementing by 1.
Custom You must assign the IDs manually. You can enter any value from
10,001 through 214,74,83,647.
Note: For out-of-the-box attributes, BMC has reserved a range of enum IDs from
0 to 10,000.
Functional
Currency
Types
List of currency types to which the value can be converted when it is saved to the
database.
Currency
ID Values
If you selected a custom Enum Type for a selection field, enter the IDs for each of the
Selection
values.
Note: For out-of-the-box attributes, BMC has reserved a range of enum IDs from 0 to
10,000. All new customizations must be done using IDs starting from 10,001.
Input
Determines the maximum size of the attachment, measured in bytes. A value of 0
Attachment
Length
defaults to the maximum allowed by the database.
Field
List Format
If you want the attribute to contain a list of character values, enter the maximum
Character
number of elements in the list in the format L <max>. If you want the attribute to
contain only one value, leave this field empty. For example, enter L4 to specify a
maximum of four list elements. This maximum is enforced by the BMC Atrium CMDB
API. When creating instances of this class, delimit list elements in this attribute with a
semicolon (; ). To include a semicolon in a list element, place a backslash (** ) in front
of it. A semicolon after the last element is optional. For example, to create a list
containing a, b, \;, and d, enter the string a;b;\;;d in this attribute when creating an
instance of the class.
Max
Maximum value allowed in this field. For Currency and Decimal types, the maximum
can be any amount. For the Integer type, the maximum can be as high as 2147483647.
Currency
Decimal
For the Real type, the maximum can be as high as 1.845e+019.
Integer
Real
Max
Length
Maximum number of characters that a user can enter in the attribute. The default is
255.
Character
Menu
Name
BMC Remedy AR System menu to attach to the attribute to allow users to select a
value.
Character
Menu Style
Select Append to append menu selections to the attribute's existing value, or

Overwrite to replace an existing value with each menu selection.
Character
Min
Minimum value allowed in this field. For Currency and Decimal types, the minimum can
be any amount. For the Integer type, the minimum can be as low as -2147483647. For
the Real type, the minimum can be as low as -1.845e+019.
BMC Atrium Core 9.0
Currency
Decimal
Integer
Page 534 of 2268
Home
Fields
Description
Applicable
data types
Real
Pattern
Select a pattern if you want to allow only certain types of values in the attribute, such
Character
as alphabetic characters or selections from an attached menu.

Precision
Number of decimal places displayed.
QBE Match
Select the type of Query By Example (QBE) matching to be used when querying on
this attribute from the class form. The default is Anywhere.
Decimal
Real
Character
Anywhere--The string matches if it is found anywhere in the attribute value.

Leading--The string matches if it is found at the beginning of the attribute value.
Equal--The string matches if it is exactly the same as the attribute value.
Values
Values that appear in the selection field.
Selection
Propagating attributes for weak relationships

The BMC Atrium CMDB Class Manager helps you propagate (or copy) attributes for weak
relationships. You can map attributes between members of a weak relationship. The value of a
mapped attribute of the source class is copied, or propagated, to the corresponding attribute on the
destination class. This allows you to find out limited information about a source Configuration Item (
CI) while viewing a destination CI, without having to follow the relationship and view the source CI.
Recommendations
Before you begin
To propagate attributes for weak relationships
Recommendations
To propagate a source attribute, you must map it to an existing attribute on the destination class.
Create new attributes on the destination class for this purpose, instead of mapping to an attribute
provided by the Common Data Model (CDM). Doing so allows CDM attributes to serve their
intended purpose and prevents you from accidentally overwriting propagated source CI values with
values from somewhere else.
BMC Atrium Core 9.0
Page 535 of 2268
Home
Mapped attributes in a weak relationship
The attribute that you propagate to on the destination class must be the same data type as the
attribute on the source class, and it cannot be inherited from a superclass. When you set up
propagation, the limit characteristics of the destination attribute are modified to match those of the
source attribute. For example, if you propagate an integer attribute that has a Min value of 3 on the
source side to a destination attribute with a Min value of 1, the Min value of the destination attribute
changes to 3.
Before you begin

Make sure that you have:
A relationship class that will connect two CI classes.
An attribute on the destination class for each attribute that will be propagated from the
source class.
To propagate attributes for weak relationships

1. In the Class Manager, open the relationship class for editing.
2. In the Relationship Type section of the Relationship Class dialog box, select the Weak
Reference check box.
3. Click Propagated Attributes.
4. In the Class 1 table of the Weak Reference Propagated Attributes dialog box, select a
source attribute to propagate.
5. In the Class 2 table, select a destination attribute.
6. Click Map Relationship.
7.
BMC Atrium Core 9.0
Page 536 of 2268
Home
7. Repeat step 5 through step 7 for each attribute you want to propagate.
8. Review the mapped attributes in the mapped relationship table.
9. Click OK to save the mappings.
Action
Steps

the class

modifying classes.

1. Click OK.
Specifying class indexes from the Class Manager

The BMC Atrium CMDB Class Manager helps you index your classes. Indexing classes can reduce
database query time. Index attributes that you expect users to query frequently, are used by
discovery applications to identify Configuration Items (CIs), and are used in reconciliation
identification rules. For more information about identification rules, see Creating an Identification
ruleset for reconciliation.
Recommendation
To specify a class index
Indexes and class attributes
Recommendation
Specifying or modifying indexes in a class that already holds a large number of instances can take
a significant amount of time and disk space. Therefore, avoid creating indexes during normal
production hours. For more information about BMC Remedy AR System indexes, see Defining
indexes.
To specify a class index

2.
BMC Atrium Core 9.0
Page 537 of 2268
Home
2. In the General tab of the CI Class or Relationship Class dialog box, expand the Indexes
section.
3. Click New.
4. In the Name field of the Index dialog box, enter a name for the new index.
5. Add at least one field to the index:
a. Select one or more fields in the Fields on Form table. If you want to select multiple
fields for a composite index, press the Ctrl key as you select fields.
b. Click Add.
6. (optional) Specify indexing characteristics for the fields in the index:
a. In the Fields in Index table, select a field.
b. If all values for the field must be unique, click the Unique check box.
c. If the index is the primary key for the class, click the Primary Key check box.
d. Repeat step a through step c for the other fields in the Fields in Index table.
7. In the Index dialog box, click OK.
8. Repeat step 3 through step 7 for other indexes you want to create for this class.
Action
Steps

the class

modifying classes.

1. Click OK.
Indexes and class attributes

If you create an index for a Character attribute, you can save query time by setting the QBE
Match characteristic of that field to Leading or Equal instead of Anywhere.
Use the Indexes section on the General tab of the CI Class and Relationship Class dialog boxes to
specify the indexes for a class. You can specify indexes on non-inherited attributes only. If an
attribute is inherited form a superclass, you must specify the index for that attribute on the
superclass. Display-only attributes cannot be indexed, because no values are stored for them.
To combine multiple attributes into a composite index, specify as many as 16 attributes per
composite index. The sum of all attribute lengths in a single index must be fewer than or equal to
255 bytes, so Diary attributes and Character attributes larger than 255 bytes cannot be indexed.
More time is required to modify a class (for example, adding new attributes) when indexes have
been specified for it. The greater the number of indexes specified for the class, the more time and
disk space are required. Specifying and modifying instances also takes longer for classes with
many indexes.
BMC Atrium Core 9.0
Page 538 of 2268
Home

You can use the BMC Atrium CMDB Class Manager to configure auditing for a class and specify
which attributes in that class are included in an audit.
Auditing changes to instance data
To configure auditing for a class
Audit types in classes
Attribute audit options in classes
Auditing changes to instance data

You can keep a history of changes to instance data, which is called auditing. You enable auditing
on a per-class basis, and you select which attributes trigger an audit and which are written as a
result. An audit is triggered when an instance is created or deleted or when the value of one or
more selected attributes changes as the result of an instance being modified. The new value must
be different from the existing value to trigger an audit. Copying the same attribute value does not
trigger an audit. For example, during reconciliation, a merge activity replaces the existing 348981
value for the SerialNumber attribute with 348981. This does not change the value and does not
trigger an audit.
Note
By default, no classes in the data model are configured for auditing. Select an auditing
strategy wisely, limiting class auditing to business-critical situations. As the number of
classes with auditing increases, system performance might slow.
For more information, see:

Types of auditing for detailed information about auditing, including recommendations
BMC Atrium Core 9.0
Page 539 of 2268
Home
To configure auditing for a class

1. In the Class Manager, right-click on the class to open a class for editing.
2. In the General tab of the CI Class dialog box, expand the Auditing section.
3. In the Audit Type field, select Copy or Log, as described in Audit types in classes.
4. If you selected Log auditing, enter the name of the log form in the Audit Log Form field, or
accept the default form name, CMDB:DefaultAuditLog.
This form stores log entries for this class. If the form that you specify does not exist, it is
created automatically.
5. In the Qualification field, type a qualification to specify which instances of the class are
audited.
For example, the following qualification specifies that only instances in the BMC.ASSET
dataset are audited:
'DatasetId' = "BMC.ASSET"
If you want all instances to be audited when they are created and deleted and when a
selected attribute is changed, leave this field blank.
6. Click the Attributes tab.
7. Select an attribute that you want to be included in audits and click Edit.
8. From the Audit Option menu, select an option for this attribute, as described in Attribute
audit options in classes.
9. In the Attribute dialog box, click OK.
10. Repeat step 7 through step 9 for each attribute that should be included in audits.
11. In the Class dialog box, click OK.

You can specify the following types of audit when modifying a class:
Copy Creates a copy of each audited instance. When you enable Copy auditing for a
class, each BMC Remedy AR System form pertaining to that class is duplicated to create
audit forms that hold audited instances. This includes forms from superclasses, because
they hold data for instances of their subclasses.
Log Creates an entry in a log form that stores all attribute values from the audited
instance in one field. When you enable Log auditing for a class, you specify the name of the
log form to use. If this form does not already exist, it is created automatically. You can use
the same log form with multiple classes.
Note
BMC Atrium Core 9.0
Page 540 of 2268
Home
You cannot use Log auditing above Copy auditing in the inheritance tree. This means that
if you already have Copy auditing enabled for a class, you cannot enable Log auditing for
any of its superclasses, and if you already have Log auditing enabled for a class you
cannot enable Copy auditing for any of its subclasses. This is due to the structure of audit
forms. For more information about audit forms, see Types of auditing.

Using the following attribute audit options to specify which attributes trigger an audit and which are
written during an audit:
None Changes to this attribute do not trigger an audit. NULL is written to this field in the
audit form in a Copy audit, and nothing is written to the Log field in a Log audit. This option
is the default.
Audit When the value of this attribute changes, an audit is triggered and the attribute
value is written to the audit form or log form. When another attribute triggers an audit, this
attribute is not written.
Copy Changes to this attribute do not trigger an audit, but the attribute value is written to
the audit form or log form when another attribute triggers an audit.
Audit & Copy When the value of this attribute changes, an audit is triggered. This attribute
value is written to the audit form or log form in any audit, regardless of whether its value
changed.
As long as there is at least one Audit, Copy, or Audit & Copy attribute for a class, a Create or
Delete operation triggers an audit regardless of the values of such attributes. Audit, Copy, and
Audit & Copy attributes are all written during such an audit.
Deleting a class with the Class Manager

You can use the BMC Atrium CMDB Class Manager to delete a class from the data model.
Recommendations
To delete a class
Recommendations
Never delete classes or attributes from the BMC Atrium CMDB Common Data Model (CDM).
Deleting such classes or attributes can cause issues during upgrade.
Warning
When you delete a class, all of its subclasses and dependencies (such as audit forms) are
deleted. If it is a Configuration Item (CI) class, all of the relationship classes in which it or
its subclasses participate are also deleted.
BMC Atrium Core 9.0
Page 541 of 2268
Home
You can also deprecate a class and its attributes from the data model (for example, to improve the
performance of the BMC Atrium CMDB or update the data model to adjust to your business needs).
For more information, see Managing permissions.
To delete a class
1. Open the Class Manager.
2. In the display pane, browse the data model until you have selected the class that you want
to delete.
3. In the toolbar, click Delete Class.
4. In the confirmation message, click Yes.
Saving the data model as an image

The BMC Atrium CMDB Class Manager displays the data model as a color-coded, hierarchical
chart. If you want to save a view of that chart for use outside of the Class Manager, you can save
the contents of the display pane as a .png image. For example, if you are developing internal
documentation for the data model, include an image that shows your extensions.
To save the data model as an image

1. In the display pane of the Class Manager, open the data model to show all of the classes
that you want to include in your image.
2. Resize the view of the data model to fit within the display pane.
3. Click Export View As Image.
4. In the Export Image dialog box, select a scale mode:
None Saves the entire contents of the display pane, including areas that you must
scroll to see, to a maximum size of 2880 pixels by 2880 pixels.
ViewPort Saves only the portion of the display pane that is currently visible.
Fit Scales the entire contents of the display pane to fit in the pixel parameters that
you set.
5. Select the number of insets, which determine how many pixels of border surround the saved
image.
6. Select a background color for the image, and then click Export.
7. Save the image to the location of your choice.
Status of classes after you make changes

After you make any change to a class or attribute with the BMC Atrium CMDB Class Manager or a
BMC Atrium CMDB API program, the class definitions are automatically synchronized with the BMC
Remedy AR System forms that hold class data and the workflow that enforces hierarchy and other
rules.
A class can be in one of the following statuses:
Change Pending The Class Manager is in the process of updating BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 542 of 2268
Home
Active The Class Manager has synchronized modifications with BMC Atrium CMDB.
Error A Class Manager update or create operation has failed. Pause your mouse pointer
over Error in the display pane to see the error message.
The Class Manager displays the current status. In the tree view, a clock icon in the corner of the
class box indicates a status of Change Pending. When the clock icon is not displayed, the status is
Active.
In the table view, the Status column indicates the status of each class.
Defining custom icons for a class instance

You can create your own custom icons (using a class instance of BMC_UIComponent ) to
represent class instances in BMC Atrium Explorer. BMC Atrium Explorer displays a specific icon to
represent each instance. The icon is defined for a specific class, and you can add and modify those
icons in BMC Atrium CMDB.
An instance of BMC_UIComponent for each Configuration Item (CI) class in the Common Data
Model (CDM) defines an icon to represent that class in the BMC Atrium Explorer. You can modify
these icons, create new icons to represent classes outside of the CDM, or create multiple icons for
the same class. If there is no BMC_UIComponent icon instance for a class, that class is
represented in the BMC Atrium Explorer by the same icon as its superclass.
To define a custom icon
Class instance icons
For more information, see Class instance icons.
To define a custom icon

1. Use the following direct access URL to open the BMC_UIComponent form:
http://:/arsys/forms//BMC.CORE.CONFIG:BMC_UIComponent
2. Create or modify an instance of BMC_UIComponent, entering values for the following
attributes:
ClassId Type BMC_UICOMPONENT.
ComponentLocale Type the locale where this icon should be displayed. When a
client requests an icon under a locale for which there is no icon defined, the en_US
icon is displayed.
ComponentName (optional) Type a name for the icon.
ComponentQual (optional) Type a qualification that specifies which instances of
the class in ComponentRelatedClassId are represented by this icon. If you do not
specify a value for ComponentQual, this icon represents all instances of the class,
subject to the values of ComponentLocale and ComponentTag4.
BMC Atrium Explorer supports only qualifications that use string or integer values. In
addition, you can use the AND or = operators when constructing a qualification, and
BMC Atrium Core 9.0
Page 543 of 2268
Home
you can include multiple AND statements with the qualification. For example:
'Name'="DesktopPC" AND 'PrimaryCapability'=3 AND 'Manufacturer'
="Dell"
ComponentRelatedClassId Type the class ID of the class that this icon
represents. The class ID is case sensitive, and might not be the same as the class
name. For example, the class with a name of BMC_ComputerSystem has a class ID
of BMC_COMPUTERSYSTEM. For more information about the class ID of a specific
ComponentTag1 Type the name of the application that owns the icon. It should be
a name other than BMC_CMDB, which is used for icons supplied by the BMC Atrium
CMDB.
ComponentTag2 (optional) Type an integer from 1 to 5 to indicate the size of the
icon, with a smaller number meaning a smaller size. For a standard 32-by-32-pixel
icon, specify 3. This is the default for the icons shipped with the BMC Atrium CMDB.
ComponentTag3 (optional) Type an integer to specify the format of the file
attachment in ComponentAttachment:
1 JPEG
2 BMP
3 GIF
4 ---TIFF
5 PNG
In this release, ComponentTag3 is stored but not used.
ComponentTag4 Type an integer to specify the precedence value of this icon.
When more than one icon's ComponentLocale and ComponentQual match an
instance to be represented in the BMC Atrium Explorer, the icon with the highest
precedence value is displayed. The icons shipped with the BMC Atrium CMDB all
have a precedence value of 10.
ComponentType Select Icon.
ComponentAttachment Specify the image file of an icon.
New and changed icons are available to BMC Atrium Explorer within ten minutes. To make
them available sooner, restart the mid tier. After waiting ten minutes or restarting the mid tier,
reopen BMC Atrium Explorer.
Class instance icons

You can use multiple instance icons for the same class to:
Display different icons for different sets of instances of the class. For example, you might
use one icon to represent desktop computer instances of BMC_ComputerSystem and
another to represent laptop computer instances.
Display different icons in different locales. For example, you might change the colors of the
icons for a locale where the original colors carry an unwanted meaning.
BMC Atrium Core 9.0
Page 544 of 2268
Home
Display different icons in different data consumer products. Because instances of

BMC_UIComponent are available to any BMC Atrium CMDB client like instances in the data
model, those clients can make use of icons that you store here. For example, BMC Atrium
Discovery and Dependency Mapping display these icons.
If you have not defined an icon for a class, or if no icon defined for the class has a qualification that
matches the current instance, the BMC Atrium Explorer displays the icon of the nearest superclass
that has a defined icon. If you create a new base class without an icon, the new class uses the
BMC_BaseElement icon.
Defining CI labels for a class

You can define the label that appears below each Configuration Item (CI) icon to help you identify
that CI. In the BMC Atrium Explorer display pane, a label appears below each CI icon to help you
identify that CI. The text of the label is the value of an attribute of the CI class. By default, BMC
Atrium Explorer uses the Name or ShortDescription attribute of that CI, depending on its CI
class, as listed in #Default attributes for CI labels.
Recommendations
To define a CI label for a class
Default attributes for CI labels
Recommendations
When choosing new attributes to use for CI labels, select:
Attributes that are likely to have clear values. Some attributes might have no values or
values that are not descriptive of the CI.
Attributes that allow you to identify CIs with fewer characters, because the default limit in
BMC Atrium Explorer for CI labels is 32 characters. For example, avoid using the
Description attribute, because the full description is likely to exceed the display limit. You
can change the character limit as part of the BMC Atrium Explorer options, available in the
BMC Atrium Explorer toolbar.
To define a CI label for a class

attributes.
When searching for existing BMC_UIComponent instances of a class, specify the
ClassLabelAttribute for the ComponentType field as part of your search criteria.
ComponentType Select ClassLabelAttribute.
BMC Atrium Core 9.0
Page 545 of 2268
Home
ComponentRelatedClassId The ID of the class to which this entry applies. The

class ID is case sensitive, and might not be the same as the class name. For example
, the class with a name of BMC_BaseElement has a class ID of BMC_ASSETBASE.
For more information about the class ID of a specific class, see the BMC Atrium
CMDB Data Model Help.
ComponentString The attributes to use for CI labels, listed in order of preference
. Separate attributes with a comma and a space. For example, enter Description,
Category to specify Description as the first attribute and Category as the
second attribute.
ComponentLocale The locale for which this label is applied. When a client
requests a locale for which there is no label defined, the en_US threshold is used.
CMDBRowLevelSecurity Select the Public group.
New and changed CI labels are available to BMC Atrium Explorer within ten minutes. To make
them available sooner, restart the mid tier. After waiting ten minutes or restarting the mid tier,
reopen BMC Atrium Explorer.
Default attributes for CI labels

The type of CI determines its label:
CIs that represent logical resources use the Name attribute.
CIs that tend to have long, encoded names use the ShortDescription attribute.
Classes with a Name attribute label
Classes with a ShortDescription attribute label
BMC_Collection
BMC_AccessPoint
BMC_Document
BMC_Equipment
BMC_LogicalEntity
BMC_Settings
BMC_Person
BMC_System
BMC_SystemComponent
BMC_SystemService
A subclass uses the CI label settings of its superclass. For example, because the BMC_System
class uses the ShortDescription attribute for CI labels, the BMC_ComputerSystem class also
uses the ShortDescription attribute.
Classes have a prioritized list of attributes for CI labels to ensure that every CI has a label in BMC
Atrium Explorer. If the first attribute is empty, then BMC Atrium Explorer uses the second attribute,
and so on. If all listed attributes are empty, then BMC Atrium Explorer displays the class name as
the CI label. This ensures that the CI label is never empty.
You can configure different attributes to use for CI labels of a class by creating an instance of the
BMC Atrium Core 9.0
Page 546 of 2268
Home
BMC_UIComponent form for that class. By default, classes that use the ShortDescription
attribute for CI labels do so because they inherit that setting from a BMC_UIComponent form entry
for the BMC_BaseElement class. Classes that use the Name attribute have their own
BMC_UIComponent form entries.
Defining BMC Atrium Explorer tooltips for a class

When you mouse over an instance in BMC Atrium Explorer, it displays a tooltip containing attribute
values for that instance. The list of attributes in the tooltip are defined for a specific class, and you
can add and modify those tooltips in BMC Atrium CMDB.
Model (CDM) defines a tooltip listing attribute values for that class in the BMC Atrium Explorer. You
can modify these tooltips, create new tooltips to represent classes outside of the CDM, or create
multiple tooltips for the same class.
To define a tooltip
attributes:
ComponentLocale Type the locale where this tooltip should be displayed. When
a client requests a tooltip under a locale for which there is no tooltip defined, the
en_US tooltip is displayed.
ComponentName (optional) Type a name for the tooltip.
ComponentQual(optional) Type a qualification that specifies which instances of
the class in ComponentRelatedClassId display the attributes listed in this tooltip.
If no ComponentQual is specified, this tooltip is displayed for all instances of the
class, subject to the values of ComponentLocale and ComponentTag4.
Qualifications use dollar signs to enclose attribute names. For example, the
qualification $Name$ LIKE "Computer%" matches instances where the value of the
Name attribute begins with "Computer."
ComponentRelatedClassId Type the class ID of the class for which this tooltip
displays attribute values. The class ID is case sensitive, and might not be the same
as the class name. For example, the class with a name of BMC_ComputerSystem
has a class ID of BMC_COMPUTERSYSTEM. For more information about the class ID of
a specific class, see the BMC Atrium CMDB Data Model Help .
ComponentString Type the names of the attributes, delimited by commas, for
which values are displayed when a user mouses over an instance of the class in
ComponentRelatedClassId in the BMC Atrium Explorer.
BMC Atrium Core 9.0
Page 547 of 2268
Home
ComponentTag1 Type the name of the application that owns the tooltip. It should
be a name other than BMC_CMDB, which is used for tooltips supplied by the BMC
Atrium CMDB.
ComponentTag4 Type an integer to specify the precedence value of this tooltip.
When more than one tooltip's ComponentLocale and ComponentQual match an
instance to be represented in the BMC Atrium Explorer, the tooltip with the highest
precedence value is displayed.
ComponentType Select Tooltip.
New and changed tooltips are available to BMC Atrium Explorer within ten minutes. To make them
available sooner, restart the mid tier. After waiting ten minutes or restarting the mid tier, reopen
Defining Quick Edit attributes for a class

When you right-click an instance in BMC Atrium Explorer, you can select Quick Edit to quickly edit
certain attributes for that instance without opening the full instance editor. By default, you can
quick-edit the name and short description of an instance. However, the list of attributes included for
Quick Edit are defined against a specific class, and you can configure which fields appear.
Model (CDM) defines which attributes for that class appear for Quick Edit in the BMC Atrium
Explorer. Edit that instance to configure which attributes appear for Quick Edits.
To define Quick Edit attributes

http://<mid_tier_server>:<port>/arsys/forms/<ar_server_name>/BMC.CORE.CONFIG:
BMC_UIComponent
attributes:
ComponentLocale The locale for which this set of Quick Edit attributes is applied.
When a client requests a locale for which there are no Quick Edit attributes defined,
the en_US attributes are displayed.
ComponentName The name for this set of Quick Edit attributes.
ComponentQual A qualification that specifies which instances of the class in
ComponentRelatedClassId display the set of Quick Edit attributes. If no
ComponentQual is specified, this set of attributes is displayed for all instances of the
class, subject to the values of ComponentLocale and ComponentTag4.
Qualifications use dollar signs to enclose attribute names. For example, the
qualification $Name$ LIKE "Computer%" matches instances where the value of the
Name attribute begins with "Computer."
BMC Atrium Core 9.0
Page 548 of 2268
Home
ComponentRelatedClassId The class ID of the class for which this set of

attributes applies. The class ID is case sensitive, and might not be the same as the
class name. For example, the class with a name of BMC_ComputerSystem has a
class ID of BMC_COMPUTERSYSTEM. For more information about the class ID of a
specific class, see the BMC Atrium CMDB Data Model Help .
Modify the instance with a ComponentRelatedClassId of BMC_ASSETBASE to
apply the set of Quick Edit attributes to all classes in the Common Data Model.
ComponentString The names of the attributes, delimited by commas, that are
available for Quick Edit in the BMC Atrium Explorer.
ComponentTag1 The name of the application that owns the set of Quick Edit
attributes. It should be a name other than BMC_CMDB, which is used for tooltips
supplied by the BMC Atrium CMDB.
ComponentTag4 An integer to specify the precedence value of this set of Quick
Edit attributes. When more than one set's ComponentLocale and ComponentQual
match an instance to be represented in the BMC Atrium Explorer, the set with the
highest precedence value is displayed.
ComponentType Select QuickEditAttributes.
New and changed sets of Quick Edit attributes are available to BMC Atrium Explorer within ten
minutes. To make them available sooner, restart the mid tier. After waiting ten minutes or restarting
the mid tier, reopen BMC Atrium Explorer.
Defining instance group thresholds for a class

When you right-click an instance in BMC Atrium Explorer, you can select Expand Children or
Expand Parents to view the Configuration Items (CIs) related to the selected CI. By default, if four
or more instances of a class are related to the CI, the related CIs appear as an instance group to
conserve space in the display pane.
For more information about viewing instance groups in BMC Atrium Explorer when you work with
related CIs, see Instance groups.
To change the default number of CIs that cause an instance group to appear for a CI class, create
an instance of BMC_UIComponent for that CI class. If you specify an instance group threshold for a
superclass, the threshold applies to all subclasses that do not also have a threshold specified in a
BMC_UIComponent instance. For example, if you specify an instance group threshold of 10 for the
BMC_ComputerSystem class, that threshold also applies to the BMC_Mainframe class unless you
specify a different threshold value for mainframe CIs.
BMC Atrium Core 9.0
Page 549 of 2268
Home
To define instance group thresholds

attributes:
ComponentLocale The locale for which this threshold is applied. When a client
requests under a locale for which there is no threshold defined, the en_US threshold
is used.
CMDBRowLevelSecurity Select the Public group.
ComponentString The minimum number of CIs of this class that form an BMC
Atrium Explorer instance group.
ComponentType Select ExplorerGroupThreshold.
ComponentRelatedClassId The ID of the class to which this threshold applies.
The class ID is case sensitive, and might not be the same as the class name. For
example, the class with a name of BMC_ComputerSystem has a class ID of
BMC_COMPUTERSYSTEM. For more information about the class ID of a specific class,
see the BMC Atrium CMDB Data Model Help .
Modify the instance with a ComponentRelatedClassId of BMC_ASSETBASE to
apply the instance group threshold to all classes in the Common Data Model.
New and changed instance group thresholds are available to BMC Atrium Explorer within ten
minutes. To make them available sooner, restart the mid tier. After waiting ten minutes or
restarting the mid tier, reopen BMC Atrium Explorer.
Creating Data Model Help with the cdm2html utility

BMC Atrium CMDB comes with Data Model Help that describes the classes and attributes (hidden
and non-hidden) in the Common Data Model (CDM). This help is generated from a live BMC Atrium
CMDB data model by using the cdm2html utility. If you install other BMC products that extend the
BMC Atrium CMDB data model or if you add classes or attributes yourself, the Data Model Help no
longer reflects the actual data model. The cdm2html utility enables you to update the Data Model
Help to reflect the current data model.
The cdm2html utility creates an HTML-based help system that provides information about the data
model, including class inheritance, attributes, and characteristics such as whether a class is
abstract or a categorization class.
Recommendation
cdm2html prerequisites
cdm2html restrictions
cdm2html.bat file ( Microsoft Windows)
BMC Atrium Core 9.0
Page 550 of 2268
Home
cdm2html Java command syntax
Recommendation
This help includes the descriptions found in the BMC Atrium CMDB Class Manager in the Class
Description field for classes and the Description field for attributes. If you have created new
classes or attributes, enter meaningful descriptions for them in the Class Manager before running
cdm2html.
cdm2html prerequisites
The cdm2html utility is a BMC Atrium CMDB Java API client, and requires the following software:
Java Runtime (J2SE) version 1.7 or later.
Apache Xalan-Java version 2.7 or later. This is bundled with BMC Atrium CMDB and
installed in <CMDBInstallDir>\utils.
Prerequisites for BMC Atrium CMDB Java API and BMC Remedy AR System Java API
clients as listed in the JavaAPI_Overview.html file of the BMC Atrium CMDB Javadoc Help.
cdm2html restrictions
The cdm2html utility is subject to these restrictions:
It can be used only with a BMC Atrium CMDB that has English as its data language.
It does not delete help files. If you delete a class from the data model and then run cdm2html
, the previously existing HTML file for that class remains untouched. You should always
generate Data Model Help into a new folder or clean out the existing folder before generating
.
cdm2html.bat file ( Microsoft Windows)

On Windows, you can avoid typing the extensive CLASSPATH information by invoking the
cdm2html utility from a wrapper batch file, cdm2html.bat. Before running the batch file, you must
set these system variables:
JAVA_HOME Set to your Java installation directory, such as C:\Program Files\Java\jre7
CMDBSDK Set to your BMC Atrium CMDB SDK installation directory, such as C:\Program
Files\BMC Software\AtriumCore\cmdb\sdk\bin
The batch file is located in <CMDBInstallDir>\utils. Its parameter syntax is the same as for the
direct Java command. Here is an example command:
cdm2html.bat -server localhost -user Demo -port 0 -password "" -outdir C:
\TEMP -attributes visible
After running the utility, the outdir directory contains a zipped version of the help and an HTML
folder containing the unzipped help.
BMC Atrium Core 9.0
Page 551 of 2268
Home
cdm2html Java command syntax

This section explains how to directly invoke cdm2html with a Java command from a Microsoft
Windows or UNIX command prompt. You must either add the following paths and files to your
CLASSPATH environment variable before running cdm2htm or include the -cp parameter at runtime
to specify them:
<cmdbInstallDir>\utils
<cmdbInstallDir>\utils\cdmutil.jar
<cmdbInstallDir>\utils\xalan.jar
<cmdbInstallDir>\sdk64\bin\cmdbapi90.jar
<cmdbInstallDir>\sdk64\bin\arapi90_build001.jar
<cmdbInstallDir>\sdk64\bin\commons-lang-2.4.jar
<cmdbInstallDir>\sdk64\bin\log4j-1.2.14.jar
The command syntax is:
java [-cp Path] com.bmc.cmdb.cdmutil.cdm2html -indir Path -outdir Path server HostName -user UserName -password Password -port Number
The parameters are:
-indir The path where cdmutil.jar resides. By default, this file is installed in <
cmdbInstallDir>\utils. If you specify a relative path, it must begin with a period (.) and be
relative to the directory from which you are executing the command.
-outdir The path in which to generate the help files. If you specify a relative path, it
must begin with a period (.) and be relative to the directory from which you are executing the
command. The default is the current directory.
-server The BMC Atrium CMDB server from which you want to export Data Model Help.
You can specify either a host name or IP address. The default value is localhost.
-user The BMC Remedy AR System user to perform the operation. The default value is
Demo. You must have the CMDB Definitions Viewer role.
-password The password for this user. The default value is blank.
-port The port number on which to connect to the server. The default value is 0, which
means to use the BMC Remedy AR System portmapper.
-attributes <visible|all> The CDM attributes to display. This parameter is
optional. The default value is visible, which means only non-hidden attributes are
displayed. If you include -attributes all, all the attributes (non-hidden and hidden) are
displayed.
Here is an example command at the <cmdbInstallDir>\utils prompt on a Window 64-bit computer,
assuming that you did not add anything to the CLASSPATH:
java -cp "C:\Program Files\BMC Software\AtriumCore\CMDB\utils\;C:\Program
Files\BMC Software\AtriumCore\CMDB\utils\cdmutil.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk64\bin\cmdbapi81.jar;C:\Program Files\BMC
BMC Atrium Core 9.0
Page 552 of 2268
Home
Software\AtriumCore\CMDB\utils\xalan.jar;C:\Program Files\BMC Software\

AtriumCore\CMDB\sdk64\bin\arapi81_build001.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk64\bin\commons-lang-2.4.jar;C:\Program Files\
BMC Software\AtriumCore\CMDB\sdk64\bin\log4j-1.2.14.jar;C:\Program Files\
BMC Software\AtriumCore\CMDB\sdk64\bin" com.bmc.cmdb.cdmutil.cdm2html outdir .HTMLHelp -indir "C:\Program Files\BMC Software\AtriumCore\CMDB\
utils" -user Demo -password ""
After running the utility, the outdir directory contains a zipped version of the help and an HTML
folder containing the unzipped help.
Deprecating classes and attributes in your data model

You might need to deprecate one or more objects in your data model to adapt to your changing
business needs, and evolving technology and services. When you deprecate a class or an attribute
in your data model, you remove it or replace it with another class or attribute.
Use cases for deprecating your data model
Identification of the metadata to deprecate
Creating deprecation mappings
Installation of the updated data model
To deprecate data model objects, you must first create deprecation mappings in the BMC Atrium
Explorer and then run the Deprecation utility, which is located in the following directories depending
on the installation version:
32-bit version cmdb/sdk/bin
64-bit version cmdb/sdk64/bin
On Microsoft Windows, the Deprecation utility uses the deputil77.jar file and the deputil.cmd
script file to run the utility. On UNIX, the utility uses the deputil.sh script file.
When you create a deprecation mapping, you mark a class and its attributes for deprecation.
Whether you delete a class or mark a class for deprecation, the changes are not replicated in the
data model until you run the Deprecation utility. This mechanism enables applications with older
versions of the data model to function smoothly until they are ready for the upgrade.
The Deprecation utility does not allow you to transform data values when deprecating a class and
migrating its data. You must correct your data before deprecating its class.
Note
BMC Atrium Core 9.0
Page 553 of 2268
Home
BMC recommends that only you or the application that creates a class should deprecates
classes. For example, if a discovery application extends the BMC_SoftwareServer
class, which ships with BMC Atrium Core, and creates an OracleAppServer class, only
the discovery application should deprecate the OracleAppServer class.
You deprecate classes and attributes in your data model in the following steps:
1. Identify the metadata to deprecate, as described in the procedure on Identification of the
metadata to deprecate.
2. Create the deprecation mappings, as described in the procedure on Creating deprecation
mappings.
3. Install the updated data model, as described in the procedure on Installation of the updated
data model.
Use cases for deprecating your data model

If the data model has changed or if modeling guidelines have changed between releases, you no
longer have to upgrade the dependent consuming applications (such as BMC Remedy ITSM) or
providers (such as BMC Atrium Discovery and Dependency Mapping) at the same.
To reduce the total cost of ownership, BMC Atrium CMDB contains a deprecation model for
complete backward compatibility from CDM changes. Coupled with API backward compatibility, this
deprecation model now allows for phased upgrades to the CDM.
The Class Manager includes a Deprecation Class Editor to deprecate classes and attributes in your
data model. The Deprecation Class Editor ( Deprecate Class Editor) is useful for deprecating one
or more objects in your data model to adapt to your changing business needs, and evolving
technology and services. For example, you might want to deprecate a class and its attributes to
improve the performance of BMC Atrium CMDB or to update your data model to adjust to changing
technology and business needs.
The scenarios for deprecating your data model that are supported by the Deprecation utility are
limited to:
Deprecation of a subclass and its replacement with a superclass
Deprecation of a subclass and its replacement with a sibling
Replacement of a subclass with its superclass sibling
Deprecation of relationship classes
Deprecation of federation and abstract classes, and federation and abstract relationships
Deprecation of attributes
For use cases not supported, see Deprecation of attributes.
BMC Atrium Core 9.0
Page 554 of 2268
Home
Deprecation of a subclass and its replacement with a superclass

You can deprecate any subclass in your data model and replace it with its superclass. Andy Admin
at Calbro Services has decided that the company no longer needs to track BMC_Impact
relationships as separate instances. So he decides to deprecate the BMC_Impact class and
replace it with its superclass, BMC_BaseRelationship, in the data model.
The following figure illustrates the data model after the BMC_Impact subclass is replaced with the
BMC_BaseRelationship superclass.
Replacing a subclass with its superclass
Limitations to replacing a subclass with its superclass

You cannot deprecate a subclass in a legacy application that uses a workflow to query its
superclass for the deprecated instances. In this scenario, the data is not returned by the query
because the superclass is not a deprecated class. This issue occurs because BMC Atrium CMDB
cannot differentiate between a request for data from a legacy application and one from a new
application.
Deprecation of a subclass and its replacement with a sibling

You can deprecate any subclass and replace it with another class at the same level in the data
model hierarchy. To improve the performance of the BMC Atrium CMDB application, Andy Admin at
Calbro Services has decided to store the pointing device information in the BMC_Keyboard class.
The following figure illustrates the data model after the BMC_PointingDevice subclass is
replaced with the BMC_Keyboard subclass.
Replacing a subclass with its sibling
BMC Atrium Core 9.0
Page 555 of 2268
Home
Limitations to replacing a subclass with its sibling class

The Deprecation utility does not support the following transactions after you replace a subclass with
its sibling class:
If you query instances of the replacement class, the query results will also include the
instances that are migrated from the deprecated class. For example, at Calbro Services, if
Andy Admin queries the instances of the BMC_Keyboard class, the results will also include
the migrated instances of the BMC_PointingDevice class. This issue occurs because
BMC Atrium CMDB cannot determine the version of the client requesting the data.
If you initiate a query from the superclass (for example, BMC_HardwareSystemComponent
), the result will contain instances of the replacement subclass ( BMC_Keyboard ) instead of
the deprecated subclass (BMC_PointingDevice ).
Replacement of a subclass with its superclass sibling

You can replace any subclass in your data model with a sibling class of its superclass. The
following figure illustrates the data model after the BMC_J2EEApplicationServer subclass is
replaced with its superclass sibling BMC_SoftwareServer.
Replacing a subclass with its superclass sibling
BMC Atrium Core 9.0
Page 556 of 2268
Home
Because the BMC_SoftwareServer subclass already contains all the attributes that might be
required to model a J2EE application server, Andy Admin decides to deprecate the
BMC_J2EEApplicationServer subclass. Andy sets the Type attribute of the
BMC_SoftwareServer subclass with a value of 'J2EE' to differentiate between the software
servers.
Limitations to replacing a subclass with its superclass sibling

The Deprecation utility does not support the following transactions after you replace a subclass with
its superclass sibling:
If you initiate a query from the superclass that had the subclass before deprecation, the data
that is returned will not include the subclass instances. For example, as shown in the
following figure, if you query the BMC_ApplicationInfrastructure class, the results
that are returned will not include the instances of BMC_J2EEApplicationServer.
If you initiate a query from the superclass that has the subclass after deprecation, the results
returned will also include the instances that are migrated from subclass. For example, as
shown in the following figure, if you query the BMC_SoftwareServer class, the results will
also include the instances of BMC_J2EEApplicationServer.
Deprecation of relationship classes

You can deprecate a relationship class in the same way as you can deprecate a CI class. If a
relationship instance R exists between the instances A and B, where A and B are endpoint classes
of relationship R, then you can migrate the relationship class to R1 (A1, B1). You can only migrate
relationship R to R1 if A1 and B1 are subclasses of A and B, respectively, and have the same or
more permissive cardinality. For example, you can migrate a relationship class with a cardinality of
1:1 to a relationship class where the cardinality is 1:1, 1:many, or many:many.
BMC Atrium Core 9.0
Page 557 of 2268
Home
Recommendation
Although you can migrate a relationship class to another relationship class with more permissive
cardinality, migrate the relationship class to another relationship class with the same cardinality. All
the use cases for CI classes explained in this section are also applicable to relationship classes.
Deprecation of federation and abstract classes, and federation and abstract relationships
For federation classes and relationships, and abstract classes, the Deprecation utility only sets the
deprecated class property to "deprecated." Because the federated data is not contained in BMC
Atrium CMDB, the Deprecation utility cannot perform any data migration.
Because federated relationships do not have any underlying data, the Deprecation utility sets the
metadata property for such relationships regardless of whether it is deprecated. Although you can
deprecate federation and abstract classes, you cannot specify a replacement class for them.
Deprecation of attributes
You can deprecate the attributes of a class to rename or increase the data length of the attribute.
You cannot deprecate any System attributes of a class (for example, ClassId and InstanceId ).
Important
You must map an attribute of a class with another attribute in the same class to qualify the
operation as an attribute deprecation. If you map an attribute of a class with an attribute of
another class, the operation is considered a class deprecation.
Deprecation scenarios not supported

The following scenarios are not supported when deprecating a class in the data model:
Moving a class to another hierarchy
Replacing a superclass with its subclass--You can replace a subclass with its superclass as
a workaround for this scenario.
Identification of the metadata to deprecate

When deprecating objects in your data model, the first step is to identify the class or attribute to
deprecate. Decide whether you want to delete a class or replace a class with another class. When
you replace a class, you must map the required attributes in the source class (class to deprecate)
to the attributes in the destination class (replacement class).
Before you migrate a class or its attributes to another class, review the data model planning
information. For the scope and limitations of the deprecation process, see Use cases for
deprecating your data model.
BMC Atrium Core 9.0
Page 558 of 2268
Home
Creating deprecation mappings

A class mapping is used to delete a class or migrate a class and its data to another. An attribute
mapping is used to delete an attribute or migrate data from one attribute to another attribute within
the same class. To deprecate a class and replace it with another, you must define class and
attribute mappings. These mappings are required to migrate data to the replacement class.
The Deprecation utility enforces the following rules when deprecating classes and attributes. Make
sure you observe the following rules when creating deprecation mappings:
You can map a class to only one class.
You can only map a relationship class to another relationship class. Cardinality rules are
enforced for relationship classes.
You cannot map federation classes and relationships. They can only be marked for
deprecation.
You can map an attribute to only one attribute. The field types must be identical on each side
of the mapping, and the field length of the replacement attribute must not be less than the
attribute to deprecate.
You cannot map an attribute or class to deprecate to an attribute or class that is deprecated.
You must create attribute and class mappings based on the relationship cardinality rules and
endpoint class rules defined in BMC Atrium CMDB.
To create deprecation mappings

1. Open Class Manager.
2. In the toolbar, click Deprecation Mapping.
3. In the Class and Attribute Deprecation window, click the Deprecate Classes tab.
4. Click Create.
The Deprecate Class Editor opens.
Tip
To edit an existing class mapping, click the appropriate class mapping row and
click Edit.
Deprecate Class Editor
BMC Atrium Core 9.0
Page 559 of 2268
Home
5. From the Deprecate Action section, specify whether you want to delete or deprecate the
class.
Delete ---Deprecates the class without a mapping. The class property is set to
Deprecated, indicating that the class and its data are to be deleted in a future version
of the data model.
Replace Deprecates the class and uses a mapping to replace it with a different
class. Data is moved to the class that you specify in the Replacement Class selection
list, and the class is to be deleted in a future version of the data model. When you
click Replace, the Replacement Class field is enabled.
6. From the Class to Deprecate menu, select the class to deprecate from the selection list.
7. In the Application field, type or select the application that wants to deprecate the class or
attribute.
The application is usually the owner of the class or attribute that wants to deprecate the
class or attribute (for example, BMC Atrium CMDB or BMC Remedy Asset Management).
8. In the Version field, type or select the version number of the application in which to
deprecate or replace the class (for example, 8.0.00 ).
9. From the Replacement Class menu, select an appropriate replacement class to which you
want to migrate the data from the deprecated class.
The Attribute Mapping section is enabled.
10. In the Attribute Mapping section, click Map Attributes.
Complete the following steps for deprecating a class and its attributes:
a. From the Attribute to Deprecate list, select the attribute that you want to deprecate.
b.
BMC Atrium Core 9.0
Page 560 of 2268
10.
Home
b. From the Replacement Attribute list, select the attribute on the target class that you
want to replace it with.
c. Click Add Attribute Mapping.
The attribute is then mapped to deprecate.
Mapping attributes to deprecate
Note
Make sure that the datatype of the replacement attribute matches with the
datatype of the attribute to deprecate. For example, map a Character field
only to a Character field. Otherwise, an error might occur when migrating
data to the replacement class.
11. Click Specify Default Value.

Complete the following steps when transferring data from the deprecated class to the
replacement class:
a. From the Replacement Attribute list, select the attribute for which you want to specify
a default value.
b. In the Default Value field, select the default value from the list or type a value of your
choice.
This field is used to specify constant values that are used when migrating data. The
value specified in this field overrides the values in the attribute to deprecate and the
replacement attribute.
c. Click Add Attribute Mapping.
12.
BMC Atrium Core 9.0
Page 561 of 2268
Home
12. Click Qualify Queries.

When you deprecate an attribute, you use Qualify Queries to specify the data to migrate to
the replacement attribute. For example, you want to deprecate an attribute that has location
data about your worldwide offices but your company is closing the Pojoaque office. When
you depreciate the attribute in the attribute mapping, you can create a Location !=
Pojoaque qualification expression that migrates all location data except for Pojoaque to an
attribute in the replacement class.
Complete the following steps when modifying attribute values to determine whether the data
belongs to the replaced class or the deprecated class:
a. From the Attribute list, select an attribute on the replacement class.
Note
Make sure that you select an attribute for which data exists in the class to
deprecate. Otherwise, data migration errors might occur.
b. Select an operator.
c. Select a keyword or type a value. If you type a value, enclose it in double quotation
marks.
Query qualifier for class mappings
13. Click OK.

You are prompted that you successfully created a class mapping.
14.
BMC Atrium Core 9.0
Page 562 of 2268
Home
14. Click OK.

The new mapping appears in the Class and Attribute Deprecation window.
Installation of the updated data model

After you create the class and attribute mappings, you must run the Deprecation utility to update
your data model. You can run this utility from the command line or automatically trigger it from the
BMC Atrium Core installer.
As part of migrating data after the classes are deprecated, the Deprecation utility updates the
relationship instances to point to the class that replaced the original endpoint. For example, if you
are replacing the BMC_PointingDevice class with the BMC_Keyboard class, the relationships
for the BMC_PointingDevice class now points to the BMC_Keyboard class as one of its
endpoints.
If you want to update the data model on your local computer, run the utility from the command line.
If you want to update the data model on several computers, run it with the installer.
Deprecation utility CLI parameters
Examples of command-line syntax
Deprecation utility CLI parameters

The following table lists the CLI parameters for the Deprecation utility.
Deprecation utility command-line parameters
Parameter
Description
Default values
-u
User name (required)
Demo
-p
Password (required)
""
-s
Server name (required)
localhost
-t
TCP port
-q
AR RPC queue
-qCMDB
CMDB RPC queue
-a
Authentication string
""
-n
Number of threads
-l
Location of the log files (required)
c:\Program Files\BMC Software\

AtriumCore\atrium core\cmdb\
sdk\bin\deputil.log
-trace
Flag which turns on the debug logging. If the -trace option is not used, then
it is set to off.
By default, the logging is for INFO

level.
Maximum log file size
10 MB
-L
Clean up the deprecated classes and attributes
BMC Atrium Core 9.0
Page 563 of 2268
Home
Parameter
Description
Default values
-c
-cp
The classpath environment variable to set for Java
-Xms512m
JVM memory setting for Java
-d
Deprecate classes and attributes using the mapping file (required)
-fm
Executes the data migration again, post-deprecation, in case of system failure
-mid
Deprecates or migrates the data selectively for a particular mapping. If the mid option is omitted or its value is blank, then the Deprecation utility
deprecates or migrates data for all mappings.
Examples of command-line syntax

This section provides examples of executing the Deprecation utility from the command line.
Example 1: Deprecating class and attributes ( -d option) and logging the activities in a file ( -l
option):
C:\Program Files\BMC Software\AtriumCore\works\cmdb\sdk\bin> deputil.cmd
-s Scavenger1 -u Demo -p "" -d -l c:\temp\deputil.log -trace
Example 2: Deprecating class and attributes with four threads running at a time ( -n option):
-s Scavenger1 -u Demo -p "" -d -l c:\temp\deputil.log -n 4
Example 3: Deleting the deprecated class and attributes ( -c option):
-s Scavenger1 -u Demo -p "" -c -l c:\temp\deputil.log -trace
Example 4: Deprecates class with specific deprecation class mapping ( -mid option):
-u "Demo" -s "localhost" -p "" -d -fm -mid "
deprecationClassMappingInstanceID"
Administering CI impact models

In BMC Atrium Configuration Management Database (BMC Atrium CMDB), you can configure an
impact model by creating impact relationships between configuration items (CIs) in BMC Atrium
Explorer. With an impact model, you can run impact simulations in Atrium Impact Simulator to
determine how changes to a CI affect other CIs or business services.
BMC Atrium Core 9.0
Page 564 of 2268
Home

Manually creating CI impact models of services
CI impact model
For example, you could run a simulation to learn what devices and applications in your network
would be impacted if you were to take a server offline. You can manually create an impact
relationship between two CIs in BMC Atrium Explorer, but you can also set the HasImpact
attribute to Yes in an existing relationship (for example, Hosted System Component). As you add
more impact relationships between CIs, the impact model grows. With an established impact model
, you can run impact simulations with the Atrium Impact Simulator, as described in Running an
impact simulation.
In BMC Atrium CMDB, you can assign impact relationships between CIs with BMC Atrium Explorer,
as described in Creating relationships between CIs.

The BMC Atrium Impact Simulator can predict the impact on CIs by using the impact relationships
both regular relationships with impact and impact-only relationships that you configure within
BMC Atrium Configuration Management Database (BMC Atrium CMDB). If you have BMC Service
Impact Manager (SIM) installed, Atrium Impact Simulator can also use the impact relationships
configured for BMC SIM.
BMC Atrium Core 9.0
Page 565 of 2268
Home
BMC Atrium Impact Simulator and BMC SIM

If you have BMC SIM installed, BMC Atrium Impact Simulator uses the impact models that you
have configured in BMC SIM in addition to any impact relationships you create manually in BMC
Atrium CMDB. In this scenario, you might use BMC Atrium Impact Simulator to test different impact
scenarios before deploying those scenarios in BMC SIM.
The following features of BMC SIM are not used with BMC Atrium Impact Simulator:
BMC SIM schedules
Custom propagation models
Custom status computation models
Custom status
BMC Atrium Impact Simulator without BMC SIM

If you do not have BMC SIM installed, BMC Atrium Impact Simulator uses the impact relationships
that you create between CIs in BMC Atrium CMDB. You can create these relationships manually
through BMC Atrium Explorer, or through the dynamic service modeling function of the Service
Catalog.
Related topic
Manually creating CI impact models of services

You can manually create impact models of services in BMC Atrium Explorer without the BMC
Service Impact Manager (SIM) product or extensions installed. You then can use Atrium Impact
Simulator to test the impact to a service when a provider is unavailable. For example, you can test
the effects of weighted averaging to a consuming configuration item (CI) in the impact model when
one or more provider CIs are unavailable.
For information about creating impact models, see the following topics:
Creating impact models in BMC Atrium Explorer
Settings that affect the impact model
The following figure shows a sample impact model created in BMC Atrium Explorer. There are four
server CIs connected to a cluster CI, which is then connected to a technical service CI.
The impact relationships in this impact model use the following default settings:
ImpactWeight 100
ImpactPropagationModel DIRECT
By default, the ImpactComputationModel of the cluster is set to STANDARD.
Creating impact model in BMC Atrium Explorer
BMC Atrium Core 9.0
Page 566 of 2268
Home
If you do not modify the impact weight, propagation model, or cluster type default values, the
servers function independently of each other in the impact model. As a result, if a server CI is
unavailable, the predicted impact is that the cluster CI and the technical service CI will likewise be
unavailable, even though three other servers are fully functional.
Impact on service if provider is unavailable and no weighted clustering
You can subsequently modify the impact model in various ways. For example, you can modify the
ImpactComputationModel setting of the cluster to WEIGHTED_CLUSTER. The
WEIGHTED_CLUSTER setting uses the ImpactWeight value of each of the providers. If you do not
BMC Atrium Core 9.0
Page 567 of 2268
Home
modify the default values from 100, all of these providers are considered equal in the impact model.
The impact of any single provider is a weighted averaged with the other providers. As a result,
when the provider is unavailable, there should be no impact to the technical service.
You can also modify the impact weights and propagation model settings of the relationships (for
example, by setting the impact weight to 400 and the propagation model to INCREASING). If you
increase the ImpactWeight of one of the providers, that server is now assigned more weight in the
computed status than the back-up servers. As a result, when the provider is unavailable, there now
should be a minor impact to the technical service.
Creating impact models in BMC Atrium Explorer

You can manually create impact models of services in BMC Atrium Explorer.
After you have set up the impacts, you can use BMC Atrium Impact Simulator to set impact states
on configuration items (CIs) and to see what the affects are.
Before you begin

You can easily test the impact model in BMC Atrium Explorer. The following examples assume that
you created the impact model shown in the following figure. The servers, cluster, and technical
service use their default settings.
Review the main settings that affect the impact model, as described in Settings that affect the
impact model.
To test the settings that affect impact simulations

1. Edit the propagation model settings of the impact relationship between two CIs (for example,
between one of the software server CIs and the cluster CI).
a. Right-click the relationship and then click Edit.
b. In the BMC_BaseRelationship form, click the Custom tab.
c. In the ImpactPropagationModel field, type INCREASING.
d. Click Save.
2. Run an impact simulation on the server (for example, setting the simulated status to Very
Impaired).
The INCREASING value in the propagation model increases the severity of the status
propagated from the provider CI to the consuming CI. The predicted impact is that the
cluster and the technical service will be Unavailable.
Impact on service with change to propagation model values
BMC Atrium Core 9.0
Page 568 of 2268
Home
3. Edit the cluster.

a. Right-click the cluster and then click Edit to open the BMC_Cluster form.
If BMC Remedy ITSM is installed, you must use the following direct access URL to
open the BMC_Cluster form:
http://http://:/arsys/forms//BMC_Cluster
You then must search for the cluster that you need to edit.
b. Click the Custom tab.
c. In the ImpactComputationModel field, enter WEIGHTED_CLUSTER.
d. Click Save.
e. Perform the same steps on the technical service.
4. Run an impact simulation on the server CI (for example, setting the simulated status to
Unavailable).
Based upon the new WEIGHTED_CLUSTER value, all of the providers are considered
equally in the weighted average. Even when one server is unavailable, the predicted impact
is that the cluster and the technical service will experience no impairment, because three
other servers are still running. The effect of one server being unavailable has been balanced
among the four providers.
Impact on service with change only to cluster settings
BMC Atrium Core 9.0
Page 569 of 2268
Home
5. Edit the impact weight of the impact relationship between two CIs (for example, between one
of the software servers and the cluster).
a. Right-click the relationship and then select Edit.
b. In the BMC_BaseRelationship form, click the Custom tab.
c. In the ImpactWeight field, enter 400.
The ImpactWeight is an integer that is relative to the other providers to the cluster. To
change the behavior of the impact model and to provide more weight to the provider
in the computed status, you must change the weight relative to the other values. The
provider now has four times the weight relative to the other servers.
d. Click Save.
6. Run an impact simulation on the server CI (for example, setting the simulated status to
Unavailable).
Based upon these new values, one provider is considered four times more important in the
weighted average. When that provider is unavailable, the predicted impact is that the cluster and
the technical service will experience some kind of impairment.
Impact on service with change to cluster and impact weight settings
BMC Atrium Core 9.0
Page 570 of 2268
Home
When you run the actual simulation in Atrium Impact Simulator, you see that the cluster and the
technical service will experience minor impairment: The server's delivery of service is slightly
affected.
Related topics
Impact states in Atrium Impact Simulator.
Simulating the impact of changes to CIs .
Settings that affect the impact model

When you are editing relationships to model impacts, use the following settings.
Impact model settings
Settings
Description
ImpactWeight (in impact
Specifies the weight that this impact relationship has in computing the status of the consumer CI.
The default setting is 100. This weight is relative to all relationships providing impact to the
consumer CI. Weighting an impact relationship allows you to model the effect to the business
service if a provider CI is unavailable (for example, a server goes down).
relationship)
ImpactPropagationModel
(in impact relationship)
Specifies the propagation model used for this impact relationship. The following values are
available:
DIRECT (default) Propagates status of the provider CI to the consumer CI. For example,
if the provider CI status is Unavailable and the ImpactPropagationModel setting is
DIRECT, then the consumer CI status is Unavailable.
INCREASING Increases the severity of the status of the provider CI. The status of the
consumer CI becomes more critical than that of its provider CI by one level. For example, if
the provider CI status is Impacted and the ImpactPropagationModel setting is
INCREASING, then the consumer CI status is Unavailable.
DECREASING Decreases the severity of the status of the provider CI. The status of the
consumer CI is less critical than that of the provider CI by one level. For example, if the
provider CI status is Unavailable and the ImpactPropagationModel setting is
DECREASING, then the consumer CI status is Impacted.
BMC Atrium Core 9.0
Page 571 of 2268
Home
Settings
Description
JUST_WARNING Propagates only warning information from the provider CI to the
consumer CI.
ImpactComputationModel
Specifies the status of the cluster, based on the statuses propagated from provider CIs. The
(in cluster)
following values are available:

STANDARD (default) Computes the status using the highest propagated value of the
incoming relationships. For example, if the provider is Unavailable, the cluster will be
Unavailable.
CLUSTER Computes the status where greater than 50% of the providers (the "quorum"
percentage) must agree on the same status. If you have four server providers, three of
them must have the same (or worse) status in their impact relationship to the cluster.
WEIGHTED_CLUSTER Computes the status by averaging all statuses of provider CIs and
propagating the impact weight to the cluster. The weight determines how much importance
(numerically weighted) to give to each provider relationship that impacts a consumer CI.
The higher the number, the greater the importance.
Using the WEIGHTED_CLUSTER setting allows the providers to operate together as a
functional whole and increase their availability.

This data modeling information describes how to model business entities in BMC Atrium CMDB.
The information uses the Common Data Model (CDM) and extensions to that model, and explores
recommended practices for using new entities effectively.
Data model diagrams
Storage entity models
Application models
Software server models
Computer system models
Network topology models
This data modeling information illustrates how to use the classes that BMC provides for the BMC
Atrium CMDB to model a particular business entity, focusing on how you use the entire model
rather than on general information about a class or attribute. Although descriptions of classes and
attributes are provided to give you context when determining how to model CIs, detailed information
such as syntax and the type of attribute is not specified. For that level of information, see the BMC
Atrium CMDB Data Model Help.

Audience
About Atrium CMDB
Terminology
Differentiating Name and ShortDescription attributes
BMC Atrium Core 9.0
Page 572 of 2268
Home
Audience
This information is intended for configuration managers, application administrators, asset analysts,
and related IT professionals.
About Atrium CMDB

The BMC Atrium Configuration Management Database (CMDB) enables you to store and manage
information about products and services that are in your environment. The BMC Atrium CMDB uses
the term class to describe a configuration item (CI) or relationship classification. Each CI is partially
classified using some common attributes that describe the base class (BMC_BaseElement ).
Specific details about each class of CI are described by attributes of subclasses of
BMC_BaseElement. Relationships are also modeled as a base relationship class (
BMC_BaseRelationship ) with subclasses for different types of relationships.
As a provider of BMC Atrium CMDB data, BMC Atrium Discovery products can discover large
amounts of configuration data for use by data consumers. BMC Atrium Discovery products are
natural enablers for the creation of service models because they can discover many of the
components, or CIs, that ultimately make up the service models. These components include:
Computer systems (including servers, routers, physical and virtual systems, and operating
systems)
Applications
Software servers (including specialized elements such as SAP, Siebel, and mainframe
infrastructure components)
Databases
Business process definitions
Network elements
Terminology
In many cases you will be modeling an entity using classes from the CDM, but you might also
model part of that same entity using an extension to the CDM. For models that require extensions
to the CDM, the term data model is used. This information is organized so that the entities are
introduced first in each section, including the recommended practice for that implementation. Any
classes and attributes that can be included in the deployment of these business entities in an IT
infrastructure are described in an architectural diagram. Where appropriate, recommendations are
provided for setting specific attributes for a given class.
Attributes are defined as either key or additional. Key attributes are those that BMC recommends
that you populate for a given class to model a specific CI. Additional attributes are optional
attributes that you can populate to further classify a CI or relationship.
BMC Atrium Core 9.0
Page 573 of 2268
Home
Differentiating Name and ShortDescription attributes

A common misconception is that the caption for the CI on user interfaces and reports is
represented by the Name attribute, when it is actually the ShortDescription attribute. In the data
modeling diagrams, the names that appear are not from the Name attribute, they are the
ShortDescription attribute (which is usually just a user interface caption). Also, in modeling
recommendations, ShortDescription is the more user-friendly label, and should always be
provided and set with a value that makes sense to an end user.
Data model diagrams

Illustrative model diagrams help explain the concepts and modeling recommendations, and also
show how you might model an entity in a real-world business environment. In these diagrams, CIs
are represented by single-line boxes that contain attributes of the class or its parent class. Where
applicable, key attributes are shown in the box that depicts a specific class and, in some cases,
include the recommended value of those attributes.
Note
Illustrative diagrams are just examples, and might not reflect every possible class,
attribute, or relationship that you would use for modeling all types of the represented
object.
This section contains the following topics:

Relationships represented in data models
Dependency relationships
Component relationship
Collection relationship
Cardinality in relationships
Weak relationships
Relationships represented in data models

In the diagrams, boxes illustrate how CIs in your environment should be mapped to the CDM, or
how to extend the CDM to create your own data model. Lines are used to represent the type and
direction of the relationship.
Colors are used in the diagrams to help you easily distinguish at a glance which relationship type is
recommended to model an example business object. Additionally, the source and destination of
each relationship are represented by the letters S and D, respectively. BMC_Dependency
relationships use solid red arrows, BMC_Component relationships use solid green arrows, and
BMC_Collection relationships use black arrows. These relationships in the diagrams apply the
conventions used by BMC Atrium Explorer in the BMC Atrium CMDB UI.
BMC Atrium Core 9.0
Page 574 of 2268
Home
Note
Arrow directionality is from Source to Destination.
Dependency relationships
Dependency relationships are represented by red lines with an arrow to show the direction of the
relationship. In a BMC_Dependency relationship, the arrow starts at A, the antecedent (Source) of
the relationship, and ends at B, the dependent (Destination). Entity B is dependent on Entity A.
Component relationship
In a component relationship, the source CI is a group that has a component or part; its destination.
Entity A is a group (Source) that has a component B (Destination). In diagrams, component
relationships are represented by green lines with an arrow to show directionality.
Collection relationship
A BMC_MemberOfCollection relationship is represented in diagrams by black lines with an
arrow to show directionality. A is the collection class (Source) and B is the member class (
Destination) where the collection class uses properties of the member class.
BMC Atrium Core 9.0
Page 575 of 2268
Home
Cardinality in relationships
Every relationship class has a cardinality that defines how many instances of the source class can
be related to each instance of the destination class and vice versa. Where cardinality is specified in
the diagrams, it is shown at the ends of the relationship lines as one of the following types:
1:1 (one to one)
1:* (one to many)
*:1 (many to one)
: (many to many)
Weak relationships
Where a weak relationship exists between two instances, that relationship is indicated by the letter
W in the illustrative model diagrams. If the relationship is a weak relationship, its destination
member, called the weak member, cannot exist without its source member, called the strong
member. A weak relationship creates a logical composite object consisting of both member CIs.
Storage entity models

The following topics explain how to model storage entities and their relationship to the computer
systems that will utilize the services provided:
Storage entity and device characteristics
Tape drive models
DASD models
Virtual disk models
NAS device models
Raw storage models
Storage entity and device characteristics

Storage entities and devices that you want to model in your environment might include tape drives,
disk drives, virtual disks, network-attached storage (NAS), and pool of storage subsystems.
Tape drive models

A tape drive is modeled as an instance of BMC_TapeDrive (derived from BMC_Media ).
Logical identity of BMC_TapeDrive
Additional attributes for BMC_TapeDrive
Tape drive instance
Logical identity of BMC_TapeDrive

The following table describes key attributes of a tape drive.
Key attributes that identify tape drives
BMC Atrium Core 9.0
Page 576 of 2268
Home
Attribute
Usage
Name
Identifies the instance. The unique name is not necessarily human-readable.
NameFormat
Specifies the heuristic used to generate the Name value.
SystemName
Specifies the name of the system in which the component resides. This attribute is automatically populated from
the related CI when a weak relationship is created between the computer system and the tape drive.
Additional attributes for BMC_TapeDrive

The following table describes additional attributes of a tape drive.
Additional attributes of a tape drive
Attribute
Description
Description
The description of the instance.
ManufacturerName
The name of the vendor.
MediaType (not inherited)
The type of media. Its value is always Removable Media.
Model
The tape drive model.
ShortDescription
A caption of the instance.
Tape drive instance

The following table illustrates an example instance.
Example of a tape drive instance
Attribute
Value
Description
003590.B1A.IBM.13.000000044832.0080
ManufacturerName
IBM
MediaType
Removable Media
Model
3590-1
Name
003590.B1A.IBM.13.000000044832.0080
NameFormat
Mainframe
ShortDescription
003590.B1A.IBM.13.000000044832.0080
SystemName
003590.B1A.IBM.13.000000044832
DASD models
A direct access storage device (DASD) is modeled as an instance of BMC_DiskDrive (derived
from BMC_Media ).
Logical identity of BMC_DiskDrive
BMC Atrium Core 9.0
Page 577 of 2268
Home
Additional attributes for BMC_DiskDrive

DASD instance
Logical identity of BMC_DiskDrive

The following table describes key attributes of a DASD.
Key attributes that identify DASDs
Attribute
Usage
Name
Identifies the instance of the disk drive. Use this attribute to specify the unique name of the instance; not
necessarily human-readable.
NameFormat
SystemName
Specifies the name of the system in which the component resides. This attribute is automatically populated from
the related CI when a weak relationship is created between the computer system and the tape drive.
Additional attributes for BMC_DiskDrive

The following table describes additional attributes of a DASD.
Additional attributes of DASD
Attribute
Description
Description
The description of the instance.
ManufacturerName
The name of the mainframe vendor.
MediaType (inherited from BMC_Media )
The type of media. Its value is always Fixed Hard Disk.
Model
The DASD model.
SerialNumber
The manufacturer-allocated number used to identify the instance.
ShortDescription
A caption of the instance.
DASD instance
The following table illustrates an example of an DASD instance.
Attributes of a DASD instance
Attribute
Value
Name
002105.000.IBM.13.000000025559.0B46
NameFormat
Mainframe
SystemName
002105.000.IBM.13.000000025559
Description
002105.000.IBM.13.000000025559.0B46
ManufacturerName
IBM
MediaType
Fixed Hard Disk
BMC Atrium Core 9.0
Page 578 of 2268
Home
Attribute
Value
Model
3390
SerialNumber
ADR071
ShortDescription
ADR071
Virtual disk models

A virtual disk refers to storage allocated to a virtual machine for use by the operating system. The
file system is laid on the provided virtual disk. Virtual disks are created from a physical hard drive or
allocated from NAS/SAN infrastructure. A virtual disk is modeled as an instance of
BMC_LogicalDisk.
Logical identity of BMC_LogicalDisk virtual disk
Additional attributes of BMC_LogicalDisk
Virtual disks allocated to virtual machines
Logical disks allocated to a virtual machine from a resource pool
Logical identity of BMC_LogicalDisk virtual disk

The following table describes key attributes of a virtual disk.
Key attributes that identify virtual disks

Attribute
Usage
Name
Identifies the logical disk with respect to the virtual machine to which the disk is allocated. The following list
provides examples of the values that the Name attribute might contain, depending on the OS:
Microsoft Windows Name of the drive, for example, *E:*

UNIX Access path, for example, '/dev/... '
NameFormat
Specifies the heuristic used to generate the Name value. When this attribute is set to OS Device Name, the Name
attribute is populated with a uniquely identifiable device name.
SystemName
Name of the computer system to which the logical device belongs.
Additional attributes of BMC_LogicalDisk

The following table describes additional attributes of a virtual disk.
Additional attributes of a virtual disk
Attribute
Description
BlockSize
Size of the blocks (in bytes) that form the given storage extent. If the block size is variable, make sure
that you specify the maximum block size in bytes. If the block size is unknown, specify a value of 1.
NumberOfBlocks
BMC Atrium Core 9.0
Page 579 of 2268
Home
Attribute
Description
Total number of logical contiguous blocks that form the given storage extent. You can calculate the total
size of the storage extent by multiplying the BlockSize by the value of the NumberOfBlocks attribute. If
the BlockSize is 1, this property is the total size of the Extent.
AvailableCapacity
Indicates the total amount of free space (in bytes) that is available on the given storage extent. If the free
space is unknown, specify a value of 0.
ConnectionType
The storage protocol used to communicate with the storage controller, for example, SCSI, iSCSI, FCoE,
and Infiniband.
Virtual disks allocated to virtual machines

Model the virtual disk allocated to a virtual machine (VM) using the BMC_LogicalDisk class and
create an association to the VM by using the SYSTEMDEVICE relationship.
The following figure illustrates a simple scenario where a virtual disk is allocated to a VM and a file
system is installed on it.
Example of modeling virtual disk allocated to a VM
BMC Atrium Core 9.0
Page 580 of 2268
Home
BMC Atrium Core 9.0
Page 581 of 2268
Home
Logical disks allocated to a virtual machine from a resource pool

You can model storage resources that are allocated from the storage resource pool using the
BMC_ResourcePool class. This class has attributes to store the capacity and utilization properties
of the storage resources. The resource pool should be related to the storage system that hosts it
using HOSTEDRESOURCEPOOL relationship.
You might have one or more virtual disks in your environment that are created from a storage
system and are allocated to virtual machines. You model such virtual disks by using the
BMC_LogicalDisk class. You can associate this class to the hosted virtual machine by using the
SYSTEMDEVICE relationship. You also need to associate the logical disk to the resource pool
where it comes from by using the ELEMENTALLOCATEDFROMPOOL relationship.
You should model the file system laid by the virtual computer system on the logical disk by using
the BMC_LocalFileSystem class. You associate this class to the logical disk by using the
RESIDESON relationship. Associate the BMC_ComputerSystem class by using the
HOSTEDFILESYSTEM relationship.
The following figure illustrates an example of a logical disk that is allocated from a resource pool
and is hosted on a storage system.
Example of modeling a logical disk from a resource pool
BMC Atrium Core 9.0
Page 582 of 2268
Home
NAS device models

This section describes how to model simple and complex NAS devices.
Simple NAS devices
Remote mounted file systems
Simple NAS devices

To model a NAS device in a simple scenario, represent the NAS device using the
BMC_ComputerSystem class. Set the PrimaryCapability attribute of the class to Storage.
The following figure illustrates how to model a simple NAS device.
Example of modeling a simple NAS device
BMC Atrium Core 9.0
Page 583 of 2268
Home
Remote mounted file systems

When a virtual machine mounts a file system from a network-attached storage (NAS) device, model
the file system by using the BMC_RemoteFileSystem class.
You model the file system on the NAS device by using the BMC_LocalFileSystem class. You
relate the remote file system to the local file system by using the MOUNTEDON relationship.
Associate the remote file system with the computer system by using the HOSTEDFILESYSTEM
relationship.
You can model various logical storage components in the NAS device by using the
BMC_LogicalDisk class and the BMC_ResourcePool class.
The following figure illustrates an example where a virtual machine accesses a NAS device and
uses the NAS to mount a file system from it.
Example of modeling a remote mounted file system
BMC Atrium Core 9.0
Page 584 of 2268
Home
Raw storage models

A raw storage volume might be directly mapped to a physical or virtual machine, provided a storage
volume manager is present, from the host computer over the network, from SAN infrastructure, or a
physical machine.
The virtualization platform, in order to access such volumes over the network, uses protocols such
as iSCSI or Fiber Channel. Raw storage volume is modeled as an instance of
BMC_StorageVolume.
Logical identity of BMC_StorageVolume for raw storage volume
Additional attributes of BMC_StorageVolume
Storage volumes allocated to a virtual machine
BMC Atrium Core 9.0
Page 585 of 2268
Home
Storage volumes allocated to a virtual machine from a resource pool

Relationships for storage systems
Logical identity of BMC_StorageVolume for raw storage volume

The following table describes key attributes that identify raw storage volumes.
Key attributes that identify raw storage volumes
Attribute
Usage
Name
Identifies the storage volume allocated to a virtual machine. A unique device identifier that is returned from the
storage system is populated in this attribute.
NameFormat
SystemName
Name of the computer system on which the storage volume is hosted.
Additional attributes of BMC_StorageVolume

The following table describes additional attributes of a raw storage volume.
Additional attributes of a virtual disk
Attribute
Description
LUNID
A logical unit number (LUN) is the identifier of a device, which is being addressed by the SCSI protocol
or similar protocols, such as Fiber Channel and iSCSI.
BlockSize
Size of the blocks (in bytes) that form the given storage extent. If the block size is variable, make sure
that you specify the maximum block size in bytes. If the block size is unknown, specify a value of 1.
NumberOfBlocks
Total number of logical contiguous blocks that form the given storage extent. You can calculate the total
size of the storage extent by multiplying BlockSize by the value of the NumberOfBlocks attribute. If the
BlockSize is 1, this property is the total size of the Extent.
AvailableCapacity
Indicates the total amount of free space (in bytes) that is available on the given storage extent. If the free
space is unknown, specify a value of 0.
ConnectionType
The storage protocol used to communicate with the storage controller, for example, SCSI, iSCSI, FCoE,
and Infiniband.
Storage volumes allocated to a virtual machine

You can model storage volume allocations to virtual machines (VMs) by using the
BMC_StorageVolume class and associating it to the containing computer using the
SYSTEMDEVICE relationship
The following figure illustrates a simple scenario where a storage volume is used in a VM.
Example of modeling a storage volume allocated to a VM
BMC Atrium Core 9.0
Page 586 of 2268
Home
Storage volumes allocated to a virtual machine from a resource pool

Model virtual machine (VM), storage resource pool, and the storage system, as described in
Storage volumes allocated to a virtual machine .
You should model the raw device that is mapped directly to a VM by using the
BMC_StorageVolume class. You associate this class to the resource pool by using the
ELEMENTALLOCATEDFROM relationship and the BMC_ComputerSystem class that represents
the virtual system by using the SYSTEMDEVICE relationship.
BMC Atrium Core 9.0
Page 587 of 2268
Home
The following figure illustrates an example of allocating a storage volume to a VM from a storage
system.
Example of modeling a raw storage volume

The following table describes the relationships used for storage systems. Use the value listed in the
table to specify the name for a relationship between any two storage classes.

Relationship
Relationship class
Value of Name attribute
Storage subsystem and an operating system
BMC_Dependency
STORAGESUBSYSTEMOS
Storage subsystem and a DASD
STORAGESUBSYSTEMDASD
Storage subsystem and a tape drive
STORAGESUBSYSTEMTAPE
File system hosted on a physical or virtual machine
HOSTEDFILESYSTEM
A logical disk allocated to a virtual machine
SYSTEMDEVICE
A file system residing on a logical disk
BMC_Dependency
RESIDESON
A storage volume allocated to a virtual machine
SYSTEMDEVICE
Relationship between a remote mounted file system such

as NFS and the file system where it actually resides.
BMC_Dependency
MOUNTEDON
BMC Atrium Core 9.0
Page 588 of 2268
Home
Application models
The following topics describe how to model software business entities, including applications,
software servers, databases, and middleware:
Application characteristics
Applications running on servers
Applications running on application servers or systems
Applications running on computer systems
Relationships for applications
Business application and service models
Application characteristics
Applications have characteristics that help you determine how to best use the CDM in your
modeling strategy. The following table maps the characteristics of an application to the type of class
you would use to model that application. Note that not all objects and relationships are required to
model certain types of applications. For example, patch information may not be required in the case
of software license management.
Example of mapping application characteristics to a class

Characteristic
Description
Class
Runtime
Running instances of applications and software servers
BMC_SoftwareServer,
aspect
BMC_Application,
BMC_ApplicationInfrastructure
Installation
aspect
Identifies the product that is installed, its version, and any patch
BMC_Product
Service aspect
Business applications. (For business applications supporting a

particular function such as payroll and trading, use the
BMC_Application,
BMC_BusinessService
BMC_BusinessService class.)
The following figure illustrates how the installed, runtime, and service aspects of an application
relate to each other.
Example of representing multiple application relationships
Click the figure to expand
BMC Atrium Core 9.0
Page 589 of 2268
Home
Applications running on servers

The BMC_SoftwareServer class represents the deployed, runtime aspects of applications; in
other words, the instances of software actually running on a server. You instantiate this class to
capture long-lived, server-type applications in your environment. When modeling applications, you
must remember this distinction. To model static, installed components such as Microsoft Excel or
Microsoft Word, create a BMC_Product instance.
You can also use the BMC_Product class to model noncommercial products, such as in-house
software. One application can be installed once, yet have multiple instances running. For example,
you can create a BMC_Product instance to represent the installed version of WebServer and
create several BMC_SoftwareServer instances to represent actual instances of WebServer, one
listening on port 80, another on port 8000, and a third on port 8080.
For complete descriptions of the classes described in this section for modeling applications,
including examples of usage, see the BMC Atrium CMDB Data Model Help. For more information
about using the BMC_Product class to model components, see Software inventory models.
For example, you would model WebLogic first by instantiating the BMC_Product class (to indicate
where it is installed, the number of licenses, product name, and version). To add the runtime aspect
, you would instantiate a BMC_SoftwareServer class. The following figure illustrates an example
BMC Atrium Core 9.0
Page 590 of 2268
Home
of this model, where two instances of a WebLogic application server (server1 and server2) are
actually instances of the same installed product.
Example of modeling a WebLogic application

Accounting for the runtime aspect of the application in this context is very important for
understanding the impact of an application on a business service. You must consider capturing
WebLogic patches (using the BMC_Patch class), because the patch will then be connected to the
service through the installed product, runtime, applications and, ultimately, the service and its
relationships. Consequently, an IT administrator responsible for updating patches on WebLogic
BMC Atrium Core 9.0
Page 591 of 2268
Home
would understand how the change relates to the business that WebLogic supports.
Applications running on application servers or systems

The BMC_Application class stores information about standalone applications, applications
deployed on servers (such as SAP), and applications deployed on distributed systems (such as
SAP).
The BMC_ApplicationInfrastructure class stores information about the framework that
supports applications in a distributed or composite system. This class represents the platform to
model your applications. For example, you would model SAP as an instance of
BMC_ApplicationInfrastructure. After an application is deployed in that platform, it can run
on any application server in the SAP environment. An application can be hosted by different types
of environments: an application server or application system, or a physical or virtual system.
To model applications to run directly on top of an application server or application system, relate an
instance of the BMC_Application class to a hosting BMC_ApplicationInfrastructure
instance.
In this model, the application has only one relationship: a dependency on the application
infrastructure hosting the application. This dependency is modeled by a BMC_Dependency
relationship, as illustrated in the following figure. When using the relationship, set the Name value to
DEPLOYEDAPPLICATION.
Example of modeling applications running on application systems
An application infrastructure cannot have any direct relationship to computers. Only applications
and software servers have relationships to computers.
This model can also be applied to an application or set of applications that support or collaborate to
provide a particular business function. For example, an Oracle application infrastructure supports
two applications, TimeCard and HR personal data, both stored in the BMC_Application class.
The two classes relate to each other through the BMC_Dependency relationship, meaning that both
the TimeCard and HR personal data applications are dependent on the supporting Oracle
application infrastructure. To decompose the system into its functional components, relate an
instance of this class to its component BMC_SoftwareServer instance with the
BMC_Dependency class.
BMC Atrium Core 9.0
Page 592 of 2268
Home
Applications running on computer systems

To model applications to run on computer systems (physical or virtual), relate an instance of the
BMC_Application class to a hosting physical or virtual BMC_ComputerSystem instance.
Example of modeling applications running on computer systems
Relationships for applications

The relationships for modeling applications are described in the following table.
Relationships for modeling applications
Relationship
Relationship
class
Application infrastructure hosting the application.
BMC_Dependency
APPLICATIONSYSTEMHIERARCHY
System hosting the application (mandatory).
BMC_Dependency
APPLICATIONSYSTEMCOMPUTER
Operating system running the application (optional).
BMC_Dependency
APPLICATIONSYSTEMOS
Product representing the installed software of which this application

is an instance (optional).
BMC_Dependency
APPLICATIONSYSTEMPRODUCT
BMC Atrium Core 9.0
Page 593 of 2268
Home
Business application and service models

To model the business aspect of applications, use the BMC_BusinessService class. Business
applications support a particular business function (such as payroll or trading) and are, generally,
made up of a set of applications, servers, and databases that collaborate to provide a particular
service.
The following figure illustrates a business services model.
Example of modeling business services
Note
In this model, the BMC_BaseElement name is typically an application or database.
Software server models

The following topics describe how to model software servers, such as database servers, web
servers, DNS servers, mainframe servers, and directory servers:
Software server characteristics
Database server models
Oracle Listener model
Database models
Database storage entity models
Relationships for database servers and databases
BMC Atrium Core 9.0
Page 594 of 2268
Home
Software server characteristics

A software server is a system that provides services to client applications and other servers, runs
on top of a physical or virtual system, and is modeled using the BMC_SoftwareServer class.
Logical identity of BMC_SoftwareServer
Additional attributes for BMC_SoftwareServer
Relationships for software servers
The following figure illustrates a software server model.
Example of modeling software servers
Logical identity of BMC_SoftwareServer

The BMC_SoftwareServer class stores information about a server that provides a single service
to client applications or other systems. Database servers, web servers, DNS servers, mainframe
servers, and directory servers can be represented by this class.
The following table details the key attributes used in the BMC_SoftwareServer class. When
modeling software servers, you identify the unique server type in the SoftwareServerType
BMC Atrium Core 9.0
Page 595 of 2268
Home
attribute.
For example, for database servers, set the SoftwareServerType attribute to DatabaseServer.
Key attributes that identify BMC_SoftwareServer
Attribute
Usage
Name
Identifies the name of the software server.
NameFormat
Sets the heuristic used to generate the Name value.
SoftwareServerType
Specifies the type of software server (for example, DatabaseServer).

The following table describes additional attributes for BMC_SoftwareServer.
Attribute
Description
ShortDescription
A caption of the software server.

The following table describes the relationships for software servers.

Source CI clasS
Destination CI class
Relationship class
BMC_AdminDomain
BMC_SoftwareServer
BMC_MemberOfCollection
J2EESYSTEMOFDOMAIN
BMC_Application
BMC_SoftwareServer
BMC_Component
BMC_ComputerSystem
BMC_SoftwareServer
BMC_Dependency
BMC_Product Installed
BMC_SoftwareServer
BMC_Dependency
BMC_SoftwareServer
BMC_DataBase
BMC_Dependency
MANAGEDDATABASE
BMC_SoftwareServer
BMC_SoftwareServer
BMC_Component
BMC_SoftwareServer
BMC_SoftwareServer
BMC_Dependency
APPLICATIONSYSTEMDEPENDENCY
software of which the

software server is an
instance (optional).
BMC Atrium Core 9.0
Page 596 of 2268
Home
Database server models

A database server is a form of software server that, like all software servers, must be uniquely
named in the context of the CDM. A database server is modeled as an instance of the
BMC_SoftwareServer class (derived from the BMC_ApplicationSystem class) and is
identified by its Name attribute.
A key attribute for this class is SoftwareServerType, which must be set to DatabaseServer.
The following figure illustrates how to model a database server.
Example of modeling database servers
BMC Atrium Core 9.0
Page 597 of 2268
Home
Oracle Listener model

The Oracle Listener manages network communications for one or more database instances. An
Oracle Listener is modeled as an instance of the BMC_SoftwareServer class (derived from
BMC_ApplicationSystem ) and is identified by both its Name attribute (set to Oracle Listener)
and SoftwareServerType attribute (set to Other).
The following table details the attributes used to model Oracle Listeners.
Attributes used to model Oracle Listeners
Attribute
Usage
Name
Identifies the Oracle Listener.
NameFormat
Defines the heuristic used to generate the Name value.
SoftwareServerType
Defines the type of server. This value must be set to Other.
ShortDescription
A caption of the database.
TokenId
Specifies the unique identifier populated by BMC Discovery products and used by the Reconciliation
Engine to identify instances.
Database models
A database is a collection of interrelated data that is treated as a unit and that is organized into one
or more schemas. Databases are dependent on software servers and, therefore, are dependent on
database servers.
Logical identity of BMC_DataBase
Additional attributes for BMC_DataBase
Logical identity of BMC_DataBase

A database is modeled as an instance of the BMC_DataBase class (derived from the
BMC_LogicalEntity class) and is identified by its Name attribute.
The BMC_DataBase class defines the properties that are common across database models and
vendor implementations for the database entity that is represented by the unit of interrelated data.
Create an instance of this class for each managed database. You can use this class to specify the
software that belongs to the database or view runtime statistics for the database.
To represent database storage areas, use the BMC_DataBaseStorage class. The key to a
BMC_DataBase instance in an enterprise environment is its Name attribute. For more information
about database storage, see Database storage entity models.
BMC Atrium Core 9.0
Page 598 of 2268
Home
Additional attributes for BMC_DataBase

Although databases are primarily defined by the Name attribute, the following table provides
additional information about an instance of BMC_DataBase:
Additional information for BMC_DataBase
Attribute
Description
ShortDescription
A short description of the database.
TokenId
A unique identifier populated by BMC Discovery products and used by the Reconciliation Engine (of BMC
Atrium CMDB) to identify instances.
Database storage entity models

Database storage entities are an extension of file system CIs in a database environment and are
modeled using the BMC_DataBaseStorage class.
Logical identity of BMC_DataBaseStorage

The BMC_DataBaseStorage class stores information about a collection of logical storage areas
that hold and retain data. You model a database storage CI as an instance of the
BMC_DataBaseStorage class (derived from the BMC_FileSystem class) and identify the
instance by its Name and SystemName attributes. The BMC_DataBaseStorage class extends a
file system CI and uses its inherited associations to represent the internal structure of the database.
The following table details the attributes used to model database storage CIs.
Key attributes that identify model database storage CIs
Attribute
Usage
Name
Identifies the storage area (tablespace) name.
NameFormat
Specifies the heuristic used to generate the Name value. Set it with the storage name used to generate the Name
value.
SystemName
Specifies the name of the parent BMC_Database CI. This attribute is automatically populated from the related CI
when a weak relationship is created between the computer system and the operating system.
Additional attributes for BMC_DataBaseStorage

The following table describes attributes that provide additional information about an instance of
BMC_DataBaseStorage.
Additional information for BMC_DataBaseStorage
Attribute
Description
isSystemArea
Specifies whether the storage area is a system area.
ShortDescription
A caption of the database.
BMC Atrium Core 9.0
Page 599 of 2268
Home
Attribute
Description
TokenId
A unique identifier populated by BMC Discovery products and used by the Reconciliation Engine to
identify instances

The BMC_Dependency class is a generic association used to establish dependency relationships
between instances in the BMC Atrium CMDB. This association allows you to establish dependency
relationships between endpoints, including the roles of the endpoints.
The following table describes the relationships for database servers and databases.
Relationship
Relationship class
Computer system (source) and database server (

destination)
BMC_Dependency
Computer system (source) and Oracle Listener (

destination)
BMC_Dependency
Oracle Listener (source) and database server (
BMC_Dependency
DEPENDENCY
Installed software of which this software server is an

instance (optional).
BMC_Dependency
Database server (source) and database (destination)
BMC_Dependency
MANAGEDDATABASE
Computer system (source) and the file system (

destination)
HOSTEDSYSTEMCOMPONENT
Database storage (source) and database (

destination)
BMC_Dependency
DATABASEDATASTORAGE
destination)
Computer system models

This section describes how to use the CDM to model computer systems (servers, workstations, and
network nodes such as routers, switches, and hubs). It details the classes, relationships, and
attributes used to model computer systems, operating systems, hardware components, software
inventory and patches, access points, and network interfaces.
For information on modeling applications, including modeling runtime versus installed aspects of
applications, see Application models.
Computer system characteristics
Software inventory models
Operating system models
Hardware component models
Access point models
Network interface and address models
BMC Atrium Core 9.0
Page 600 of 2268
Home
Router models
Virtual system models
Software and hardware cluster models
Computer system characteristics

Computer systems are parent objects that may be represented as an aggregation of component
parts (such as operating systems, hardware, software inventory, or network addresses) that are
child instances related to the BMC_ComputerSystem instance.
Systems provide computing capabilities and aggregate one or more of the these elements: file
systems, operating systems, processors, and memory (including volatile and nonvolatile storage).
Therefore, additional information about a computer system might not be part of a
BMC_ComputerSystem instance but be available from instances of other classes connected to the
BMC_ComputerSystem instance through relationships.
Example of modeling a server

The following figure represents a model for a server, a network-addressable computer system.
Illustrative model of a server
Servers, workstations, network devices (such as routers, switches, hubs, load balancers, or
BMC Atrium Core 9.0
Page 601 of 2268
Home
firewalls) are all instances of BMC_ComputerSystem, the class representing all network
addressable systems. BMC_ComputerSystem represents an entity made up of component parts
that operate as a functional whole.
The PrimaryCapability attribute is crucial to identifying whether a specific instance is a server,
a router, or something else. BMC Atrium CMDB planners might use the PrimaryCapability
attribute to define a vendor-specific switch used in their network, making it easy to import this data
from a vendor's environment as an industry-standard item in their BMC Atrium CMDB.
Logical identity of BMC_ComputerSystem

BMC_ComputerSystem is a class that stores CIs relating to collections of managed system
elements. This is the primary class that you use to model the computers in your organization. You
can use the attributes in this class to identify the purpose of each computer CI in your organization.
For example, the class contains several attributes that represent any network-addressable system,
such as a server, a workstation, or a network device (router, switch, hub, load balancer, firewall,
and so forth), as well as mainframes, printers, and virtual systems. The following table shows the
key attributes that identify an instance of BMC_ComputerSystem.
Key attributes that identify BMC_ComputerSystem instances
Attribute
Usage
Name,
Identifies a computer system. The Name attribute should be a unique instance identifier that may not be Human
NameFormat
Readable. Because multiple valid naming conventions may exist and can be used according to specific
contexts, set the NameFormat attribute with a value indicating the heuristic used to generate the Name value.
For example, in some cases, an instance of BMC_ComputerSystem will be identified by an external DNS
name (a name configured in a DNS server). In other cases, a static IP address will be used. The naming
conventions for NameFormat are:
IP--a valid IP address (decimal bytes delimited with dots).
DNS--a fully qualified host name, formatted as a HostName and a DomainName delimited with dots (the
DomainName can also be made of multiple components delimited with dots).
TOKEN--Name holds a value defined by the TokenId (see Additional attributes for
BMC_ComputerSystem for more information on the TokenId ).
Domain
Identifies the domain name of the computer, as known by the end points.
HostName
Specifies the local name of the computer, as known by the end points. This value must be set according to
BMC nationalization guidelines that specifies the algorithms and methods required to obtain the correct values.
SerialNumber
Specifies the serial number of the computer.
Key attributes for BMC_ComputerSystem

The following table shows the attributes that further describe the role of an instance of
BMC_ComputerSystem.
Key attributes that describe BMC_ComputerSystem instance roles
BMC Atrium Core 9.0
Page 602 of 2268
Home
Attribute
Usage
CapabilityList
Defines the main functions that the computer can perform. This is a character attribute in which you can
enter any value listed in the description. You can enter more than one of these values; however, make
sure that multiple values are delimited by commas. A computer system can be dedicated to a single
function, such as printing, routing, or switching packets, or it can perform several functions. Typically, the
PrimaryCapability attribute is set to the first value specified in CapabilityList.
PrimaryCapability
Describes the main function that the computer performs. By convention, PrimaryCapability is the
first item in the CapabilityList attribute.
ShortDescription
Specifies a short description for the instance when the value of the Name attribute is encoded.
ShortDescription should always be provided and set with a value that makes sense to an end user.
The following list illustrates the functions and values to assign to a CapabilityList attribute
depending on the function of the computer.
Functions and values for CapabilityList attribute
Not Dedicated--0
Unknown--1
File Server --17

Mobile User Device --18
Storage Virtualizer--34
Media Library--35
Other--2
Storage--3
Repeater--19
Bridge/Extender--20
ExtenderNode--36
NAS Head--37
Router--4
Switch--5
Gateway --21
LoadBalancer--22
Self-contained NAS--38
UPS--39
Layer 3 Switch--6
Central Office Switch--7
Mainframe--23
SANSwitch--24
IP Phone--40
Management Controller--41
Hub--8
Access Server--9
SANHub--25
SANBridge--26
Chassis Manager--42
Host-based RAID controller--43
Firewall--10
Print--11
SANRouter--27
SANDirector--28
Storage Device Enclosure--44

Desktop--45
I/O--12
Web Caching--13
RAIDStorageDevice--29
Virtual Tape Library--30
Laptop--46
Virtual Library System--47
Server--14
Management --15
JBOD--31
Workstation--32
Blade System--48
Blade Server--49
Block Server --16
StorageSubsystem--33
For example, a server with active firewall capabilities could have the values 14 (Server) or 10 (
Firewall) for CapabilityList. PrimaryCapability would be set to Server if this is the main
function of the system. However, a switch device would have CapabilityList = 5 (Switch) and
PrimaryCapability = 5.
Additional attributes for BMC_ComputerSystem

The following table describes the attributes that provide additional information about an instance of
BMC_ComputerSystem.
Additional information for BMC_ComputerSystem
BMC Atrium Core 9.0
Page 603 of 2268
Home
Attribute
Description
Description
The functions that the computer system can perform.
DHCPUse
Specifies whether the system is configured to use DHCP: Enabled = configured to use DHCP
Disabled = not configured to use DHCP
ManufacturerName
The company that manufactured the computer.
Model
The model of the computer.
OwnerContact
The contact information that specifies how the primary system owner can be reached (such as phone
number or email address).
OwnerName
The name of the primary system owner.
TokenId
A unique identifier populated by BMC Discovery products and used by the Reconciliation Engine (of
the BMC Atrium CMDB) to identify instances.
TotalPhysicalMemory
The total physical memory, in kilobytes.
For more information about specific attributes, see the BMC Atrium CMDB Common Data Model
Help.
Software inventory models

Software inventory represents the products and patches that are installed on a computer.
BMC_Product represents instances of installed products, whereas BMC_Patch represents
instances of patches (operating system patches and product patches).You might not want to model
patches in your BMC Atrium CMDB in all cases. For example, you might store patches for servers
in BMC Atrium CMDB, but it might not be necessary to do so for desktops and routers.
Both BMC_Product and BMC_Patch are subclasses of BMC_Software and
BMC_SystemComponent. You should associate each instance of a product or of a patch to the
parent instance of BMC_ComputerSystem by the BMC_HostedSystemComponents relationship.
When modeling software inventory, be aware that the BMC_Product class captures only installed
products or applications, not runtime aspects.
For more information about modeling runtime applications and using instances of BMC_Product
for application modeling, see Application models.
Example of modeling software inventory with two products

The following figure illustrates an example model of a server with two installed products.
Illustrative model of a software inventory containing two installed products
BMC Atrium Core 9.0
Page 604 of 2268
Home
Example of modeling software inventory with one patch

The following figure illustrates an example model of a server with one installed patch.
Illustrative model of a software inventory with a patch
Logical identity of BMC_ComputerSystem for products or patches

Like any child instance of BMC_ComputerSystem, a product or a patch is identified by the Name
attribute in conjunction with the SystemName attribute that represents the name of the computer
instance. Thus, the Name attribute represents the local name of the CI in the context of the
computer that is hosting it, as described in the following table.
Key attributes that identify BMC_ComputerSystem instances
Attribute
Usage
Name
Identifies the child instance in the context of the parent instance of BMC_ComputerSystem.
SystemName
Specifies the name of the computer instance. This must be the same as the parent instance of the
BMC_ComputerSystemName attribute. This attribute is automatically populated from the related CI when a weak
relationship is created between the computer system and the product or patch.
BMC Atrium Core 9.0
Page 605 of 2268
Home
Additional attributes for BMC_ComputerSystem for products or patches

The following table describes attributes that provide additional information about products and
patches.
Additional information about products and patches
Attribute
Description
Description
The description for the component.
ManufacturerName
The company that manufactured the component.
SerialNumber
The serial number of the component.
ShortDescription
A caption for the component.
PatchNumber
The version number of the patch.
VersionNumber
The version number of the component.
Operating system models

An operating system is software or firmware that controls the operation of a computer and directs
the processing of programs. This section describes how to model Windows and UNIX operating
systems.
To model a Windows or UNIX operating system, create an instance of the
BMC_OperatingSystem class. Associate the instance to the parent BMC_ComputerSystem
instance by a BMC_HostedSystemComponents relationship.
Note
This class is not reserved for servers and workstations only but is used to capture any
type of operating system, such as the IOS for a Cisco network switch or router.
Logical identity of BMC_OperatingSystem

As with any related component of BMC_ComputerSystem, an operating system is identified by the
Name attribute in conjunction with the SystemName attribute that represents the name of the parent
instance of the computer. Therefore, the Name attribute represents the local name of the operating
system CI in the context of the computer that is hosting it, as described in the following table.
Key attributes that identify BMC_OperatingSystem instances
Attribute
Usage
Name
BMC Atrium Core 9.0
Page 606 of 2268
Home
Attribute
Usage
Identifies the name of the child instance in the context of the parent instance of BMC_ComputerSystem. If
multiple operating systems are installed on the same computer, Name must be structured so that the multiple
instances have different names.
SystemName
Specifies the name of the system. This must be the same as the parent instance of the BMC_ComputerSystem
Name attribute. This attribute is automatically populated from the related CI when a weak relationship is created
between the operating system and a computer system.
Additional attributes for BMC_OperatingSystem

The following table describes additional attributes of BMC_OperatingSystem.
Additional attributes of BMC_OperatingSystem
Attribute
Usage
Description
The description for the operating system.
ManufacturerName
The company that manufactured the operating system.
SerialNumber
The serial number of the operating system.
ShortDescription
A caption for the operating system.
VersionNumber
The version number of the operating system.
Hardware component models

The hardware components that make up a computer system are captured by subclasses of
BMC_HardwareSystemComponent. Generally, one subclass represents one type of hardware
component. Examples of hardware components include:
Disk drive--Machine that reads data from and writes data to a disk.
Disk partition--Logical allocation of space on a disk drive.
Monitor--Video device attached to computer systems that displays computer operations.
Keyboard--Set of typewriter-like keys that enables you to enter data into a computer.
Memory--Stores information about internal storage areas in a computer.
Processor--Device that interprets a machine instructions in a computer.
Network port--Interfaces that connect network drives to computer systems.
For example, you might identify a specific processor as an instance of
BMC_HardwareSystemComponent. Each instance representing a hardware component is
associated to the parent BMC_ComputerSystem instance by the
BMC_HostedSystemComponents relationship.
BMC Atrium Core 9.0
Page 607 of 2268
Home
Logical identity of BMC_HardwareSystemComponent

Like any child instance of BMC_ComputerSystem, a hardware component is identified by the Name
attribute in conjunction with the SystemName attribute that represents the name of the parent
computer instance. Therefore, the Name attribute represents the local name of the hardware CI in
the context of the computer that is hosting it, as described in the following table.
Key attributes that identify BMC_HardwareSystemComponent instances
Attribute
Usage
Name
Identifies the child instance in the context of the parent instance of BMC_ComputerSystem.
SystemName
Specifies the name of the system. This must be the same as the parent instance of BMC_ComputerSystemName
attribute. This attribute is automatically populated from the related CI when a weak relationship is created between
the computer system and the operating system.
Additional attributes for BMC_HardwareSystemComponent

The following table describes additional attributes of BMC_HardwareSystemComponent.
Additional attributes of BMC_HardwareSystemComponent
Attribute
Description
Description
ManufacturerName
SerialNumber
ShortDescription
VersionNumber
The version number of the component.
Because each hardware component contains attributes specific to its type, see the BMC Atrium
CMDB Data Model Help for a complete list of BMC_HardwareSystemComponent types and
attributes to ensure you can accurately and completely represent your specific hardware CIs.
Access point models

A computer provides functions for other entities to use. Access points represent those available
functions. Each access point represents the configuration of access to a function or the ability to
invoke a service and is modeled by the BMC_AccessPoint class. This characteristic is further
defined by BMC_ProtocolEndpoint, the only direct subclass of BMC_AccessPoint. Among
other types of access points, a network address such as an IP address, MAC address, or IPX
address, is captured as a subclass of BMC_AccessPoint.
BMC Atrium Core 9.0
Page 608 of 2268
Home
Instances of the BMC_AccessPoint class are related to a computer system through a

BMC_HostedAccessPoint dependency relationship. Access points exist within the context of a
computer system, and are associated to their parent instance of the system through the
BMC_HostedAccessPoint dependency relationship.
Logical identity of BMC_IPEndpoint

An IP address is modeled as an instance of BMC_IPEndpoint. Like any child instance of
BMC_ComputerSystem, an instance of BMC_IPEndpoint is identified by the Name attribute in
conjunction with the SystemName attribute that represents the name of the parent instance of the
computer. Therefore, the Name attribute represents the local name of the CI in the context of the
computer that is hosting it, as described in the following table.
Key attributes that identify BMC_IPEndpoint instances
Attribute
Usage
Name
Identifies the child instance in the context of the parent instance of the BMC_ComputerSystem. Name must be an
IPv4 or IPv6 address, and must be formatted as decimal numbers delimited by a period, with no leading zeros.
NameFormat
Sets the heuristic used to generate the Name value. This value must be set to IP.
SystemName
between the computer system and the operating system.
Additional attributes for BMC_IPEndpoint

The following table describes additional attributes for BMC_IPEndpoint.
Additional attributes for BMC_IPEndpoint

Attribute
Description
Address
The IP address. This value must be compliant with AddressType.
AddressType
The enumeration that defines the type of address. This value must be set to either 0 (Unknown), 1 (IPv4)
, or 2 (IPv6).
DNSName
The system name based on its DNS name. The DNS name corresponds to the IP address; therefore,
when you want to search a system by DNS name, you should look up the IPEndpoint CIs, and then the
parent computer.
ProtocolType
The enumeration that categorizes and classifies instances of this class.
ShortDescription
A caption of the IP address.
SubnetMask
The IP address subnet mask.
ManagementAddress
The selection that defines if the IP address is a management address such as a Discovered Address or
an SNMP address.
BMC Atrium Core 9.0
Page 609 of 2268
Home
Logical identity of BMC_LANEndpoint

A MAC address is modeled as an instance of BMC_LANEndpoint. Like any child instance of
BMC_ComputerSystem, a MAC address is identified by the Name attribute in conjunction with the
SystemName attribute that represents the name of the parent instance of the computer. Therefore,
the Name attribute represents the local name of the CI in the context of the computer that is hosting
it, as described in the following table.
Key attributes that identify BMC_LANEndpoint instances
Attribute
Usage
Name
Identifies the MAC address. The value must be an address suffixed by an index. The index uniquely identifies a
MAC address for situations where multiple identical MAC addresses are configured within the same system. The
index is generally the index of the MAC address entry in the SNMP MIB.
NameFormat
Specifies the heuristic used to generate the Name value. This value must be set to MACAddress:Index.
SystemName
between the computer system and the operating system.
Additional attributes of BMC_LANEndpoint

The following table describes additional attributes of BMC_LANEndpoint.
Additional attributes for BMC_LANEndpoint
Attribute
Description
Address
The MAC address.
ProtocolType
The enumeration that categorizes and classifies instances of this class, such as for 14 (for Ethernet).
ShortDescription
A caption of the MAC address.
Access point binding

Some access points use the services provided through another access point. You can use access
point binding to establish a layering of two protocols, with the upper layer represented by the
dependent and the lower layer represented by the antecedent.
This binding is modeled in the CDM by the BMC_Dependency relationship with the Name attribute
set to BindsTo.
Network interface and address models

Network interfaces are captured by instances of BMC_NetworkPort. Although model extensions
might define subclasses (like a FiberChannel port), the class that you should use for network
interfaces is BMC_NetworkPort. Like other hardware components, each instance of a network
port is associated to the parent instance of the BMC_ComputerSystem by the
BMC_HostedSystemComponents relationship.
BMC Atrium Core 9.0
Page 610 of 2268
Home
Network addresses are captured by BMC Discovery products as access points (inherited from
BMC_AccessPoint ) and therefore must always be associated to their parent instance of the
computer through the BMC_HostedAccessPoint relationship. Also, a network address can have
a relationship to the network interface for which it is configured. This relationship is modeled by a
BMC_Dependency relationship in which the network interface is the antecedent (source) and the
network address is the dependent (destination).
For more information on modeling network addresses, including an illustration of the relationships
used in the model, see Network topology models.
Logical identity of BMC_NetworkPort

Like any child instance of BMC_ComputerSystem, a network port is identified by the Name attribute
in conjunction with the SystemName attribute that represents the name of the parent instance of
the computer. Therefore, the Name attribute represents the local name of the CI in the context of
the computer that is hosting it, as described in the following table.
Key attributes that identify BMC_NetworkPort instances
Attribute
Usage
Name
Identifies the network address. This must be an address suffixed by an index. The index uniquely identifies a
MAC address for situations where multiple identical MAC addresses are configured within the same system.
The index is generally the index of the MAC address entry in the SNMP MIB.
NameFormat
Specifies the heuristic used to generate the Name value. For instance, in many cases, network interfaces are
best discovered and identified using SNMP information.
PhysicalIndex
Specifies the index, which must be a valid SNMP index relative to the SNMP IF Table of the computer.
SystemName
Identifies the name of the system. This must be the same as the parent instance of the
BMC_ComputerSystem Name attribute. This attribute is automatically populated from the related CI when a
weak relationship is created between the computer system and the operating system.
Additional attributes for BMC_NetworkPort

The following table describes additional attributes of BMC_NetworkPort.
Additional attributes for BMC_NetworkPort
Attribute
Description
AutoSense
The Boolean value that indicates whether the port can automatically determine the speed or other
communications characteristics of the connected network media.
Description
FullDuplex
The Boolean value that indicates whether the port is operating in full duplex mode (carrying signals in
both directions).
LinkTechnology
The enumeration of the types of link technologies, with values such as Unknown, Other, Ethernet, IB,
FC, FDDI, ATM, Token Ring, Frame Relay, Infrared, BlueTooth, or Wireless LAN.
BMC Atrium Core 9.0
Page 611 of 2268
Home
Attribute
Description
ManufacturerName
MaxSpeed
The maximum bandwidth of the port in bits/second.
NetworkAddresses
The list of strings specifying the network addresses for the port.
PermanentAddress
The network address hard-coded into the port. This address can be changed by a firmware upgrade
or software reconfiguration. If it is changed, update this field. If no hard-coded address exists for the
network port, leave this attribute blank.
PhysicalDescription
The physical description or location for the port, such as slot3/port4.
PortType
The enumeration of the types of ports, with values such as Ethernet, FDDI, Token Ring, WAN, or
Unknown.
ShortDescription
SerialNumber
SpeedConfigured
The maximum bandwidth of the port in bits/second.
Router models
Routers are modeled using the BMC_ComputerSystem class by setting the PrimaryCapability
attribute to Router. The following figure illustrates an example model of a network router.
BMC Atrium Core 9.0
Page 612 of 2268
Home
Example of modeling routers

In the model, two BMC_IPEndpoint classes are used to represent the interfaces to the router.
Illustrative model of a router
Virtual system models

Virtual systems represent one or more virtual machines that are hosted by a physical computer. A
virtual system has the same relationships to subcomponents and applications that a physical
system does. In other words, a virtual system has an operating system (such as Windows or UNIX),
network addresses, and software. The major difference is that these subcomponents, although
captured as regular CIs, are all virtual. Additionally, virtual systems can have BMC_Genealogy
relationships that define relationships between a parent virtual system and its child virtual systems.
For example, If you have a virtual system named win2k-vm1 and a clone of that system named
win2k-vm2, the win2k-vm1 system is the parent and the win2k-vm2 system is the child.
BMC Atrium Core 9.0
Page 613 of 2268
Home
When modeling virtualization in your environment, represent the virtual computer system using the
BMC_ComputerSystem class, and the virtualization software (such as Hypervisor or virtualization
software), using the BMC_VirtualSystemEnabler class.
Example of modeling multiple virtual systems without resource pools and settings
The following figure illustrates multiple virtual systems (virtual machines, or VMs), the physical
computer system that hosts them, and the virtualization operating system, which is hosted on the
physical system and runs the VMs. The diagram is simplified and does not contain resource pools.
Illustrative model of a virtual system without resource pools and settings
Logical identity of BMC_System and BMC_ComputerSystem for virtual systems

Virtual systems are modeled as instances of BMC_ComputerSystem, a subclass of BMC_System.
You should follow the same naming rules as for an instance of BMC_ComputerSystem class. For
more information about this class, see Logical identity of BMC_ComputerSystem.
BMC Atrium Core 9.0
Page 614 of 2268
Home
The key attributes for defining virtual systems are VirtualSystemType (for the
BMC_ComputerSystem class) and isVirtual (for the{{BMC_System}} and
BMC_SystemComponent classes and their subclasses). Both attributes are described in the
following table.
Key attributes that identify virtual system instances

Attribute
Usage
VirtualSystemType
Identifies the type of virtual machine. Values are Other (0), Unknown (1), PR/SM (2), z/VM (3), VMWare
(4), Xen (10), Hyper-V (15), Oracle Solaris Container (20), VPar (25), NPar (30) and LPar (35).
isVirtual
Specifies whether the instance is virtual or physical. Values are NULL, No (0), or Yes (1). If you know
that it is a virtual machine, use Yes. If you know that it is a physical machine, use No. If you are unsure,
use NULL.
Note
In BMC Atrium CMDB 7.6.00, the isVirtual attribute was moved from the
BMC_ComputerSystem class to the BMC_System and BMC_SystemComponent classes.
This move expands the virtualization scope beyond computer systems, enabling you to
model potential future virtualizable entities, such as applications. Because
BMC_ComputerSystem is a subclass of the BMC_System class, the isVirtual attribute
is still available in the BMC_ComputerSystem class. If you know that it is a virtual
machine, use Yes. If you know that it is a physical machine, use No. If you are unsure,
use NULL.
Logical identity of BMC_VirtualSystemEnabler

The BMC_VirtualSystemEnabler class stores information about software that enables a
collection of virtual computer systems to run on a single physical computer system (for example,
VMware). This class is used to capture the virtualization OS, such as operating systems that run
virtual machines (including VMware images, Solaris zones, IBM AIX logical partitions, HP-UX
virtual partitions, and so forth).
The BMC_VirtualSystemEnabler class is associated to the parent computer system instance
by the BMC_HostedSystemComponents relationship.
As a subclass of BMC_ComputerSystem, any instance (representing a new business CI) of the
BMC_VirtualSystemEnabler class is identified, at minimum, by the Name and SystemName
attributes.
BMC Atrium Core 9.0
Page 615 of 2268
Home
Key attributes for BMC_VirtualSystemEnabler

The key attribute for BMC_VirtualSystemEnabler is EnablerType, described in the following
table.
Key attributes for BMC_VirtualSystemEnabler

Attribute
Usage
EnablerType
Specifies the virtualization software or OS. The possible values are Other (0, the default), Unknown (1), PR/SM (
2), z/VM (3), VMWare Server (4), Solaris Resource Manager (5), LPar (6), VPar (7), HP nPartitions (20), Integrity
VM (25), Microsoft Hyper-V (30), VMWare ESX Server (35), VMWare Workstation (40), Xen Hypervisor (45), and
LDOM Hypervisor (50).
For a complete list of attributes for the BMC_VirtualSystemEnabler class, see the BMC Atrium
CMDB CDM Help.
Key attributes for BMC_VirtualSystemSettingData

The BMC_VirtualSystemSettingData class (derived from BMC_Settings ) provides
additional granularity about a virtual system's settings through a set of virtualization-specific
properties.
Key attributes for defining the virtual aspects using the BMC_VirtualSystemSettingData class
are described in the following table.
Key attributes for defining BMC_VirtualSystemSettingData

Attribute
Usage
VirtualSystemState
Specifies the state of the virtual machine. Values are Other (0), Unknown (1), Active (10),
InActive (15), Suspended (20), and Disabled (25).
VirtualSystemType
Specifies a type of virtual system. Values are Other (0),Unknown (1), LPAR (2), VM/VM Guest
(3), VMware (4), Xen (20), LDOM (25), Solaris Container (30), HP nPartitions (35), VPar (40),
and Microsoft Hyper-V (45).
ActualProvisionDate
The date and time that a specific VM was provisioned. This attribute is important for enabling
successful reporting on BMC Dashboards.
ProposedDecommissionDate
The date and time that the VM will be removed from the environment. One of the biggest
problems causing virtual system sprawl is that organizations do not decommission VMs and
track the information. This attribute helps to drive workflow actions such as:
Notifying users that their VM is about to be decommissioned and enabling them to
extend the time before that occurs.
Automatically creating change requests to begin the decommissioning process.
Automatically starting a job in BMC BladeLogic, BMC Atrium Orchestrator, and other
consuming applications to decommission the VM.
ActualDecommissionDate
BMC Atrium Core 9.0
Page 616 of 2268
Home
Attribute
Usage
The date of the actual decommission. There can be an extension to that date to enable you to
report or track a VM. You can also compare differences between the decommission date and
actual decommission date, or block future updates to the extension date.
Example of modeling a virtual system environment with settings and containers

The following figure displays an organization that has a virtual system environment, where a Solaris
server is divided into two domains (LDOM1 and LDOM2), which are further divided into containers (
Container1 and Container2).
For the virtualization environment, use BMC_ComputerSystem, where the isVirtual attribute is
set to Yes. The parent system, which is either virtual or physical has to be related to the virtual
system with a BMC_Dependency relationship where the Name attribute has a value of
HostedVirtualSystem. To model the virtualization technology, BMC_VirtualSystemEnabler is
related to the host system with the appropriate EnablerType attribute set to the correct type of
software (for example, LDOM Hypervisor) and relationships are set to BMC_ComputerSystem (the
physical computer).
For containers, create a relationship to BMC_VirtualSystemEnabler (Solaris Resource
Manager) and relationships to the domain (or physical computer, depending on the configuration),
and operating system.
BMC Atrium Core 9.0
Page 617 of 2268
Home
Logical domain virtual systems with settings and containers

Logical identity of BMC_ResourcePool (for virtual systems)

The BMC_ResourcePool class serves as a logical entity (with associated controls) provided by the
host system to allocate and assign resources. A resource pool may be used to allocate resources
of a specific type. Hierarchies of resource pools may be created to provide administrative control
over allocations. In cases where resources are subdivided, multiple resource pools may exist.
Key attributes for defining BMC_ResourcePool

Key attributes for defining resource pools using the BMC_ResourcePool class are described in the
following table.
Key attributes for defining BMC_ResourcePool
Attribute
Usage
Primordial
Specifies how the resource pool is used in the activity of resource management. If set to true, this attribute
indicates that the resource pool is a base from which resources are drawn and returned in the activity of
resource management. It also indicates that this resource pool shall not be created or deleted by consumers of
this model. However, other actions (whether they are modeled or not), may affect the characteristics or size of
primordial resource pool. If set to false (the default), this attribute indicates that the resource pool serves as a
BMC Atrium Core 9.0
Page 618 of 2268
Home
Attribute
Usage
concrete resource pool, meaning that is subject to resource allocation services functions. This distinction is
important, because higher-level resource pools may be assembled using the Component or
ElementAllocatedFromPool associations. Although the higher-level abstractions can be created and deleted,
the most basic, hardware-based resource pools (such as primordial pools) cannot. Instead, they are physically
realized as part of the system, or are actually managed by some other system and imported as if they were
physically realized.
ResourceType
Specifies the type of resource that the resource pool may allocate. Values are Other (0), Computer System (2),
Processor (3), Memory (4), IDE Controller (5), Parallel SCSI HBA (6), FC HBA (7), iSCSI HBA (8), IB HCA (9),
Ethernet Adapter (10), Other Network Adapter (11), I/O Slot (12), I/O Device (13), Floppy Drive (14), CD Drive (
15), DVD drive (16), Disk Drive (17), Tape Drive (18), Storage Extent (19), Other storage device (20), Serial
port (21), Parallel port (22), USB Controller (23), Graphics controller (24), IEEE 1394 Controller (25),
Partitionable Unit (26), Base Partitionable Unit (27), Power (28), Cooling Capacity (29), Ethernet Switch Port (
30), Logical Disk (31), Storage Volume (32), Ethernet Connection (33).
In systems that support over-commitment, pools represent the reservable capacity, not an upper
bound or limit on the maximum amount that can be allocated. Admission control during power-on
may detect and prevent systems from powering due to resource exhaustion. For example,
over-commitment on a resource pool with ResourceType set to Memory would require that
sufficient space be available in a backing store that might be managed through a storage resource
pool.
Logical identity of BMC_ResourceAllocationSettingData (for virtual systems)

The BMC_ResourceAllocationSettingData class (derived from BMC_Settings ) represents
settings that specifically relate to an allocated resource.
Use BMC_VirtualSystemSettingData and BMC_ResourceAllocationSettingData to
represent virtual system settings, and BMC_ResourcePool to model resource pools.
The key attribute for defining settings using the BMC_ResourceAllocationSettingData class
is ResourceType, described in the following table.
Key attribute for defining BMC_ ResourceAllocationSettingData

Attribute
Usage
ResourceType
Specifies the type of resource that this allocation setting represents. Values are Other (0), Computer System (2
), Processor (3), Memory (4), IDE Controller (5), Parallel SCSI HBA (6), FC HBA (7), iSCSI HBA (8), IB HCA (9
), Ethernet Adapter (10), Other Network Adapter (11), I/O Slot (12), I/O Device (13), Floppy Drive (14), CD
Drive (15), DVD drive (16), Disk Drive (17), Tape Drive (18), Storage Extent (19), Other storage device (20),
Serial port (21), Parallel port (22), USB Controller (23), Graphics controller (24), IEEE 1394 Controller (25),
Partitionable Unit (26), Base Partitionable Unit (27), Power (28), Cooling Capacity (29), Ethernet Switch Port (
30).
Example of modeling a virtual system with one resource pool and resource allocation
BMC Atrium Core 9.0
Page 619 of 2268
Home
Using the following figure as an example, a physical box is related to BMC_ResourcePool by

BMC_Component where the Name attribute is set to HostedResourcePool. Use the relationship
class BMC_MemberOfCollection, where the Name attribute is set to{{isMemberofPool}} to
allocate resources and resource pools. You can use the relationship class BMC_Dependency,
where the Name attribute is set to ElementAllocatedFromPool to allocate resources and
resource pools. You can also use the relationship class BMC_Dependency, where the Name
attribute is set to ResourceAllocationFromPool to allocate resources and resource pools.
Model of a virtual system with one resource pool and resource allocation
Deprecated classes for virtual systems

The following classes were deprecated in BMC Atrium CMDB 7.5.00, and are no longer used for
modeling virtualized environments:
BMC_VirtualSystem (including all subclasses)
BMC_VMWare
BMC_VMWareVirtualSystem
BMC_UnixVirtualSystem
BMC_MFVirtualSystem
BMC_MFVirtualSystemEnabler
BMC Atrium Core 9.0
Page 620 of 2268
Home
BMC_LPAR
Relationships for virtual systems

The following table describes the relationships for virtual systems.
Relationships used for virtual systems
Relationship
Relationship class
Managed elements and setting data
BMC_SettingsOf
ELEMENTSETTINGDATA
Allocated resource and resource pool
BMC_MemberOfCollection
ISMEMBEROFPOOL
Resource allocated from a pool
BMC_Dependency
ELEMENTALLOCATEDFROMPOOL
Software and hardware cluster models

Use the BMC_Cluster class to classify or update groups of software or hardware. Clusters are
modeled using the BMC_Cluster class, which stores information about the cluster in relation to the
BMC_System component.
Clusters help increase the performance of resources by representing groups of two or more
computer systems or applications so that they operate together as a functional whole. Using
clusters helps to improve and maintain the reliability, serviceability, and availability of your
operating-system environment.
Illustrative model of a hardware cluster
BMC Atrium Core 9.0
Page 621 of 2268
Home
Logical identity of BMC_Cluster

The Name attribute for the BMC_Cluster class that identifies software and hardware clusters.
Key attribute that identifies BMC_Cluster instances
Attribute
Usage
Name
Attribute identifier that represents the cluster, that is, Name represents all the hardware/software in the cluster.
Key attributes for BMC_Cluster

The following attributes for the BMC_Cluster class further define software and hardware clusters.
Key attributes for defining BMC_Cluster instances
Attribute
Description
isVirtual
BMC Atrium Core 9.0
Page 622 of 2268
Home
Attribute
Description
Specifies whether the instance is virtual or physical. Values are NULL, No (0), or Yes (1). If you know that
it is a virtual machine, use Yes. If you know that it is a physical machine, use No. If you are unsure, use
NULL.
ClusterType
1, if a Hardware cluster; 2, if a Software Server cluster.
Interconnect
Attribute that specifies the interconnection mechanism for the cluster.
MaxNumberOfNodes
Attribute that specifies the maximum number of nodes that can participate in the cluster. If the number is
unlimited, enter 0 (zero).
Network topology models

This section details how to model network topology, including components on a subnet, network
interfaces, and LAN and WAN networks.
Network topology characteristics
L3 topology and IP connectivity models
L2 topology and physical connectivity model
Network topology and LAN and WAN network models
Network topology characteristics

Topologies are based on the BMC_ConnectivityCollection class, which are collections of
BMC_ProtocolEndpoint (communication points from which data may be sent or received) of the
same type and which can communicate with each other. Logical groupings of these connectivity
collections enable users to define the scope of LAN and WAN networks.
L3 topology and IP connectivity models

A BMC_IPConnectivitySubnet instance represents a group of related BMC_IPEndpoint
instances that can communicate with each other as members of a subnet and describes the
characteristics of the subnet.
BMC Atrium Core 9.0
Page 623 of 2268
Home
Example of modeling servers and routers on a subnet

The following figure illustrates a server and a router that belong to the same subnet.
Illustrative model of components on a subnet
Logical identity of BMC_IPConnectivitySubnet

The following table describes key attributes of BMC_IPConnectivitySubnet.
Key attributes that identify BMC_IPConnectivitySubnet

Attribute
Usage
Name
Identifies the IP address of the entire subnet, formatted according to the appropriate convention as defined in the
AddressType attribute. When AddressType is 1 (IPV4), the Name must be built by concatenating the
SubnetNumber and SubnetMask separated by a forward slash.
NameFormat
Specify the heuristic used to generate the Name value, which must be set to IP.
BMC Atrium Core 9.0
Page 624 of 2268
Home
Additional attributes for BMC_IPConnectivitySubnet

The following table describes attributes that provide additional information about
BMC_IPConnectivitySubnet.
Additional attributes for BMC_IPConnectivitySubnet
Attribute
Description
AddressType
An enumeration that describes the format of the Name and SubnetNumber properties in
BMC_IPConnectivitySubnet:
0--Unknown
1--IPv4
2--IPv6
PrefixLength
A prefix length for IPv6 addresses in the IP subnet ( AddressType property is 2).
SubnetMask
The mask for the starting address of the IPv6 IP subnet ( AddressType is 1).
SubnetNumber
The IP address of the entire subnet; must be equal to the Name attribute.
Relationships for components on a subnet

BMC_IPEndpoint instances are associated to the BMC_IPConnectivitySubnet to which they
belong through the BMC_InIPSubnet relationship.
L2 topology and physical connectivity model

A BMC_ConnectivitySegment instance represents a group of related instances of
BMC_LANEndpoint of a particular type (such as Ethernet, token ring, or fiber channel) that can
intercommunicate without the assistance of bridging or routing services. They are sometimes
referred to as members of the same collision domain. The class describes the characteristics of the
group, or segment.
Example of modeling a server and a switch

The following figure illustrates a server and a switch, with the server having one NIC directly
connected to a network interface of the switch.
BMC Atrium Core 9.0
Page 625 of 2268
Home
Illustrative model of a network interface

Logical identity of BMC_ConnectivitySegment

The following table describes key attributes of BMC_ConnectivitySegment.
Key attributes that identify BMC_ConnectivitySegment
Attribute
Usage
Name
Identifies the connectivity segment, which uses the following information and generates a hash code as resulting
value:
The list of physical addresses that belong to the segment.
The name of the LAN instance to which the segment belongs.
NameFormat
Specifies the heuristic used to generate the Name value, which must be set to OID.
Additional attributes for BMC_ConnectivitySegment

The following table describes attributes that provide additional information about
BMC_ConnectivitySegment.
BMC Atrium Core 9.0
Page 626 of 2268
Home
Additional attributes for BMC_ConnectivitySegment

Attribute
Description
ConnectivityType
An enumeration that describes the type of technology used:

0--Unknown
1--Other
2--Ethernet
3--Token Ring
4--FDDI
5--Fiber Channel
Count
The current number of endpoints connected to this segment. When this value equals 2 it indicates a direct
connection between the two network ports interconnected by means of the segment.
Relationships for network interfaces

Instances of BMC_LANEndpoint are associated to the BMC_ConnectivitySegment to which
they belong through the BMC_InSegment relationship.
Network topology and LAN and WAN network models

LAN and WAN networks do not have a well-known identifier, such as an IP address or mask for an
IP subnet. These networks are characterized by the list of machines that can intercommunicate at
the physical level without crossing the boundaries of gateways. This description includes the
infrastructure network devices (switches, hubs) that enable these machines to communicate. In the
CDM, LANs and WANs are captured by entities that aggregate that list of IP subnets.
Example of modeling a LAN network

The following figure illustrates a LAN that aggregates IP subnets.
Illustrative model of a LAN
BMC Atrium Core 9.0
Page 627 of 2268
Home
Example of modeling a WAN network

The following figure illustrates an example of a WAN that aggregates IP subnets.
Illustrative model of a WAN
Logical identity of BMC_LAN

You can model a virtual LAN by using the BMC_LAN class and setting its isVirtual attribute to
Yes. The following table describes key attributes of BMC_LAN.
Key attributes that identify BMC_LAN
BMC Atrium Core 9.0
Page 628 of 2268
Home
Attribute
Usage
Name
Identifies the LAN, computed from the list of IP subnets that make up the LAN. The name for the LAN is the
lexicographically lower value of the names of IP subnets.
NameFormat
Logical identity of BMC_WAN

The following table describes key attributes of a BMC_WAN.
Key attributes that identify BMC_WAN
Attribute
Usage
Name
Identifies the WAN, computed from the list of IP subnets that make up the WAN. The name for the WAN is the
lexicographically lower value of the names of IP subnets.
NameFormat
WANType
Specifies the enumeration that describes the type of technology used:

0--Unknown
1--Other
2--ATM
3--Frame relay
Summary of changes to the Common Data Model

The following topics list the changes that were made to the Common Data Model since the 7.5.00
release:
Changes to the BMC Atrium CMDB 9.0.01 Common Data Model

The ennum type of the following attributes was changed from Regular to Custom in BMC Atrium
CMDB 9.0.01. In addition, new items were added to the attributes.
Class
Attributes
Item
OperatingSystem
OSType
Windows Server 2012, Windows 10
ComputerSystem
SystemType
No new items added
BMC Atrium Core 9.0
Page 629 of 2268
Home
Class
Attributes
Item
Processor
Processorfamily
POWER 8

The following classes and attributes are added in BMC Atrium CMDB 9.0.00.
New classes and attributes in BMC Atrium CMDB 9.0.00
New class
Existing class
New attributes
Not applicable
BMC_Dataset
CMDBDatasetSecurity
Attributes that have been modified

Added new enunm type (IA64-Intel PC) to SystemType attribute of BMC_ComputerSystem
class.
Default Currency value for currency fields on all attributes fixed at 0 USD for the following
classes:
BMC.CORE:BMC_ContractLine: PriceAmount
BMC.CORE:BMC_Cost: CostAmount
BMC.CORE:BMC_Price: PriceAmount

New class
Existing class
New attributes
Not applicable
BMC_BaseElement
SystemEnvironment

New class
Existing class
New attributes
Not applicable
BMC_BaseElement
CheckSumValue, LicensingType
Not applicable
BMC_ComputerSystem
PartitionId

No new changes to the 8.0.00 Common Data Model

Classes and attributes added in BMC Atrium CMDB 7.6.04
BMC Atrium Core 9.0
Page 630 of 2268
Home
Classes and attributes added in BMC Atrium CMDB 7.6.04 SP2

Classes and attributes that have been deprecated
Classes and attributes added in BMC Atrium CMDB 7.6.04

New class
Existing class
New attributes
Not applicable
BMC_BaseElement
ReconciliationIdType, LastUpdatedDatasetId
Not applicable
BMC_BaseRelationship
ReconciliationIdType, LastUpdatedDatasetId
Not applicable
BMC_Offering
IsLocked, WarrantyLevel
Not applicable
BMC_ServiceLevelTarget
SLTClassification
Not applicable
BMC_Document
DocumentPurpose, ExecutionDate, TerminationDate
Not applicable
BMC_BusinessService
ServiceLifeCycle
Not applicable
BMC_ContractLine
Quantity, PerPricePeriod, PriceAmount, PriceUOM,

ServiceRequestId
Not applicable
BMC_FileSystem
FileSystemSize, AvailableSpace, FileSystemType, BlockSize
Not applicable
BMC_Collection
isVirtual
Not applicable
BMC_ResourcePool
HighWaterMark, LowWaterMark, MaxConsumableResource,

MinConsumableResource
BMC_ServiceOffering
Not applicable
IsDefault
BMC_RequestableOffering
Not applicable
IsAddOn, DeliveryRO
BMC_ServiceOfferingInstance
ActualDecommissionDate, ProposedDecommissionDate,
ProvisionDate
BMC_Option
ChoiceSelectionMode, FulfillmentDetails, OptionType
BMC_OptionChoice
Sequence, IsDefault
BMC_FinancialElement
PerTimePeriod, UOM
BMC_Cost
CostAmount, CostDeliveredFlag
BMC_Price
IsLocked, MaximumQuantity, MinimumQuantity, PriceAmount,

PriceLifeCycle, PriceQuantity
BMC_StorageExtent
Not applicable
BlockSize, NumberOfBlocks, AvailableCapacity, ConnectionType
BMC_LogicalDisk
Not applicable
No attributes added
BMC_StorageVolume
Not applicable
LUNID
BMC_Tag
Not applicable
IsCategory, CategoryName
Not applicable
BMC_Offering
IsLocked, WarrantyLevel
BMC Atrium Core 9.0
Page 631 of 2268
Home
Classes and attributes added in BMC Atrium CMDB 7.6.04 SP2

New classes and attributes in BMC Atrium CMDB 7.6.04 SP2
New class
Existing class
New attributes
Not applicable
BMC_BaseElement
ReconcilationIdentificationError
Not applicable
ReconcilationIdentificationError
Classes and attributes that have been deprecated

The OfferingType attribute of the BMC_Offering class is deprecated. Use the
BMC_ServiceOffering or the BMC_RequestableOffering derived classes instead of the
BMC_Offering class to store OfferingType information for a service.

Class and attributes that have been added
Classes that have been deprecated
Class and attributes that have been added

The following classes and attributes have been added in BMC Atrium CMDB 7.6.03.
New class
Existing class
New attributes
BMC_MFCouplingFacility
Not applicable
CFRMName, CFRMSiteName, NodeDescriptor, Storage
BMC_StorageSubsystem
Not applicable
No attributes added
Not applicable
BMC_BaseElement
ADDMIntegrationId, MarketVersion, NormalizationStatus,

ReconciliationMergeStatus
Not applicable
BMC_ComputerSystem
IsUnqualified
Not applicable
BMC_IPEndpoint
IsUnqualified
Not applicable
BMC_ApplicationSystem
MFJobName, MFServerId
Not applicable
ImpactSourceId, ImpactDestinationId, NormalizationStatus,

ReconciliationMergeStatus
Not applicable
BMC_HostedAccessPoint
IsUnqualified
Not applicable
CFRMName, CFRMSiteName, NodeDescriptor, Storage
Classes that have been deprecated

The BMC_Impact relationship class is deprecated and is mapped to the
BMC_BaseRelationship class. The HasImpact attribute of the BMC_BaseRelationship class
is set to "Yes" and the Name attribute is set to "ImpactOnly".
BMC Atrium Core 9.0
Page 632 of 2268
Home

The following classes and attributes have been added in BMC Atrium CMDB 7.6.00.
New class
Existing class
New attributes
BMC_Geneology
Not applicable
No attributes
Not applicable
BMC_VirtualSystemSettingData
ActualDecommissionDate, ActualProvisionDate,
ProposedDecommissionDate
Attributes that have been moved

In BMC Atrium CMDB 7.6.00, the isVirtual attribute was moved from the
BMC_ComputerSystem class to the BMC_System and BMC_SystemComponent classes. This
move expands the virtualization scope beyond computer systems, enabling you to model potential
future virtualizable entities, such as applications. Because BMC_ComputerSystem is a subclass of
the BMC_System class, the isVirtual attribute is still available in the BMC_ComputerSystem
class.
Attributes that have been hidden

The Dimensions attribute in the BMC_ComputerSystem class is hidden in the Console view but
can be seen in the Class Manager.

The following CI classes were added to the CDM in BMC Atrium CMDB 7.5.00:
New CI classes in BMC Atrium CMDB 7.5.00
CI class
Description
BMC_Offering
stores information about service offerings that are part of a high-level service
BMC_ServiceLevelTarget
stores information about Service Level Targets (SLTs)
BMC_Contract
acts as a container object made up of line items that establish a specific

agreement between a provider and a customer
BMC_ContractLine
stores contract line items that establish specific agreements between the provider
and the customer
BMC_Transaction
specifies a single transaction initiated by an end user or system
BMC_ResourcePool
serves as a logical entity (with associated controls) provided by the host system to
allocate and assign resources
BMC_ResourceAllocationSettingData
represents settings that specifically relate to an allocated resource that is outside

the scope of the CIM class (which is typically used to represent the resource itself)
BMC_VirtualSystemSettingData
defines the virtual aspects of a virtual system through a set of virtualization-specific

properties
BMC Atrium Core 9.0
Page 633 of 2268
Home
CI class
Description
BMC_Settings
represents additional attributes of a given CI that are not part of the CI type
definition
The following relationship classes were added to the CDM in BMC Atrium CMDB 7.5.00:
New relationship classes in BMC Atrium CMDB 7.5.00
Relationship class
Description
BMC_Impact
represents a generic association used to establish impact relationships between objects
BMC_SettingsOf
represents the association between ManagedElements and applicable setting data
BMC_ServiceRealizedByOffering
defines the relationship between the business service and the offering
BMC_OfferingMeasuredBy
defines the relationship between the offering and the Service Level Target
BMC_ContractComponent
defines the relationship between the contract and the contract line item
The BMC_VirtualSystem class was removed. The VirtualSystemType attribute from the
removed class was added to BMC_ComputerSystem. The TotalMemory attribute was deleted.
Your virtual system information should be stored in BMC_ComputerSystem.

The following topics discuss Denormalized CMDB Data Storage (DCDS).
Note
Denormalized CMDB Data Storage is also referred to as CDM Denormalization.
Understanding Denormalized CMDB Data Storage

Regular classes converted to categorization subclasses
Adding a categorization subclass as a child of an abstract class
Scenarios
Understanding Denormalized CMDB Data Storage

The amount of Configuration Item (CI) information in the BMC Atrium CMDB is increasing day by
day. The increasing amount of data affects the performance of the different components within the
BMC Atrium Core ecosystem while also leading to performance issues for the producers and
consumers of CI data. To address the performance issues, you must minimize the number of tables
or forms in which different but related pieces of CI data are stored, which can be accomplished
using Denormalized CMDB Data Storage (DCDS) concept.
BMC Atrium Core 9.0
Page 634 of 2268
Home
DCDS can be achieved by converting regular classes into categorization classes and storing all
related CI data in fewer or a single form or table, thereby optimizing the read and write performance
of the database.
The need for Categorization subclass
A Categorization subclass is created when you have only a few attributes specific to that class, and
most of those attributes are derived from the parent class. To avoid an additional join, a
categorization subclass is created in the CMDB.
For categorization subclass, attributes specific to the class are created on its parent form. For
example, if you create a class "A" of type categorization subclass derived from the
ComputerSystem class, which has attributes called Attribute1 and Attribute2, then both attributes
are created on the ComputerSystem form and not on categorization subclass "A".
The categorization subclass attributes are stored on the parent form. You must ensure that those
attributes are not defined as Required or Mandatory. If the attributes are defined as Required, when
you create a CI for the parent class, then the workflow will make it mandatory to enter the attribute
values, even though they do not really have context in the parent class. This is the main limitation
when using the categorization subclass.
DCDS results in optimizing the class join hierarchy by converting regular classes into categorization
subclasses thereby improving the create, read, update, delete (CRUD) throughput, and hence the
performance of BMC Atrium CMDB.
DCDS also improves reconciliation performance during the loading of data into BMC Atrium CMDB.
Regular classes converted to categorization subclasses

The following regular classes and relationships are converted to categorization subclasses:
Classes in DCDS
BMC_LogicalSystemComponent
The following fields related to the attributes of the BMC_LogicalSystemComponent class in
DCDS are moved to BMC_BaseElement class:
SystemClassid attribute field of BMC_SystemComponent class
SystemName attribute field of BMC_SystemComponent class
isVirtual attribute field of BMC_SystemComponent class
BMC_Product
The following fields related to the attributes of the BMC_Product class in DCDS are moved
to BMC_BaseElement class:
BuildNumber attribute field of BMC_Software class
ProductType attribute field of BMC_Product class
BuildType attribute field of BMC_Software class
BMC Atrium Core 9.0
Page 635 of 2268
Home
LicenseType attribute field of BMC_Software class

ServicePack attribute field of BMC_Software class
ConfigurationBasicNumber attribute field of BMC_Software class
ContractID attribute field of BMC_Software class
LicensesAvailable attribute field of BMC_Software class
PatchNumber attribute field of BMC_Software class
InstallLocation attribute field of BMC_Software class
Relationships in DCDS:
BMC_Component
The following fields related to the attributes of the BMC_Component relationship in DCDS
are moved to BMC_BaseRelationship class.
IsNext attribute field of BMC_SettingsOf class
IsMaximum attribute field of BMC_SettingsOf class
IsDefault attribute field of BMC_SettingsOf class
IsMinimum attribute field of BMC_SettingsOf class
IsCurrent attribute field of BMC_SettingsOf class
IsPending attribute field of BMC_SettingsOf class
Adding a categorization subclass as a child of an abstract class

You can now add categorization subclass as a child of abstract class with data replication. When
you do so, consider the following factors:
The fields that correspond to the attributes of the abstract class are created on the form
associated to the immediate super (regular) class.
You cannot fetch instances of a categorization subclass that is a child of an abstract class
with data replication
Scenarios
The following scenarios describe how a DCDS can be created.
Scenario for a class in DCDS

The following diagram illustrates the comparison betwe en existing CDM classes hierarchy and the
CDM classes hiera rchy in DCDS.
BMC Atrium Core 9.0
Page 636 of 2268
Home
In the existing CDM class hierarchy, when you create or update an instance of the BMC_Product
class, the following conditions occur:
The instance information is stored in the BMC_BaseElement,
BMC_LogicalSystemComponent, and BMC_Product class tables.
Before the instance is created or updated in BMC_BaseElement class, an Insert or Update
call is made to the BMC_Product class, the preceding BMC_LogicalSystemComponent
regular class, and the BMC_BaseElement class.
Three Insert or Update calls are made before the instance is created or updated in the
BMC_BaseElement class table.
BMC Atrium Core 9.0
Page 637 of 2268
Home
In the DCDS class hierarchy, when you create or update an instance of the BMC_Product class:
The BMC_Product and BMC LogicalSystemComponent classes are categorization
subclasses.
The instance data is directly stored in the BMC_BaseElement class (abstract and
categorization subclasses do not have storage tables).
The Insert or Update call is made directly to the BMC_BaseElement class, thus reducing the
number of calls.
BMC Atrium Core 9.0
Page 638 of 2268
Home
Scenario for a relationship in DCDS
BMC Atrium Core 9.0
Page 639 of 2268
Home
In the existing CDM relationship hierarchy, when an instance of BMC_Component relationship

class is created or updated:
The instance data is stored in the BMC_Component, and BMC_BaseRelationship classes.
An Insert or Update call is made to BMC_Component and BMC_BaseRelationship classes.
Two Insert or Update calls are made before the instance is created in the
BMC_BaseRelationship class.
In the denormalized CDM relationship hierarchy, when you create or update an instance of the
BMC_Component relationship class:
BMC_Component is the categorization subclass.
The instance data is stored directly in the BMC_BaseRelationship (abstract and
categorization subclasses do not have storage tables).
An Insert or Update call is made directly to the BMC_BaseRelationship, thus reducing the
number of calls.
Deploying CDM denomalization package using installer wizard

The installer summary panel displays information that CDM denormalization related binaries will be
copied on the system that will be used to execute denormalization process during the post upgrade.
BMC Atrium Core 9.0
Page 640 of 2268
Home
As a part of the installation, CDM Denormalization Utility is also installed so that you can
perform CDM denormalization. After the installation is complete, ensure that the utility is
available in <install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening.
For more details about User Interface, See Using GUI for denormalizing Common Data Model .
Performing denormalization of Common Data Model

The following topics provide instructions for denormalizing Common Data Model (CDM) classes
and relationships:
Common Data Model denormalization implementation scenarios
Common Data Model denormalization strategy
To denormalize CDM classes and relationships
Limitations
Common Data Model denormalization implementation scenarios

For fresh installation scenario
BMC Atrium Core 9.0
Page 641 of 2268
Home
If you are performing a fresh installation the classes discussed in the Regular classes converted to
categorization subclasses section are available as categorization subclasses.
For upgrade scenario
If you are performing an upgrade, you will need to run the CDM denormalization utility after the
upgrade procedure is complete.
Similar to fresh install scenario, the classes discussed in the Regular classes converted to
categorization subclasses section will be available as categorization subclasses after you run the
utility.
See Deploying CDM denomalization package using installer wizard for more details
Common Data Model denormalization strategy

The following points will help you to understand the Common Data Model denormalization stratergy
. When you denormalize your common data model:
You don't need to modify the AST Forms (Eg AST:PRODUCT), or any higher level joins in
the denormalized classes.
You don't need to modify the APIs, filters, or webservices level integrations that exist with
BMC Atrium CMDB ecosystem.
The maintenance window is kept to minimal and you don't need to restart the BMC Remedy
AR server.
Denormalization is performed without changing the CDM logical hierarchy and without
disturbing the CDM hierarchical object Model.
Denormalization is achieved by converting the Regular Classes in the class hierarchy to
Categorization Sub-Class.
After denormalization, all attributes will still stay with the class to which they belonged earlier
but, the fields corresponding to those attributes move to the immediate regular parent class.
During the actual CDM denormalization process, a parallel hierarchy is created where all the
CDM denormalization changes are implemented successfully and then it is switched with the
existing hierarchy.
During denormalization, pre and post validation checks are performed which ensure script
execution with better control of the process.
The following infographic provides an overview of the performing CDM denormalization.
BMC Atrium Core 9.0
Page 642 of 2268
Home
To denormalize CDM classes and relationships

1. Ensure that you have performed the following tasks before you begin denormalizing the
Common Data Model:
a. Create a staging server
b. Minimum version requirements
BMC Remedy AR System 9.0.00
BMC Atrium Core 9.0.00
c. Deploy the CDM denormalization utility.
The CDM denormalization utility is deployed at the following location:
<install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening
d. Take the database backup. This step is crucial in case of recovery.
2. On the computer where you have installed BMC Atrium Core, run the cdm denormalization
utility through UI.
a.
BMC Atrium Core 9.0
Page 643 of 2268
2.
Home
a. The cdm denormalization utility is located at the following location:

<install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\bin
b. The Atrium UI link will be available to invoke UI to run the Utility in the background.
3. Select check box that you have taken a database backup then only you will be able to click
button to run CDM denormalization utility.
The CDM denormalization utility performs pre-validation tasks. Ensure the following during
the pre-validation stage.
For 9.0.00.001 pre-validation checks, do the following
a. Check the log for any pre-validation errors.
b. Fix the pre-validation errors.
c. Open the Denormalization utility again and run it.
For pre-validation checks, do the following
a. Validation errors occur, and the utility exits.
b. Fix the validation errors.
c. Open the Denormalization utility again and run it.
For more information on pre-validation checks see, Common Data Model denormalization
pre-validation tasks.
4. List of the all the classes that are denormalizaed is logged into the log file.
5. The CDM denormalization process begins. At this stage, various tasks are performed to
denormalize the classes. At this stage, you need to factor in the downtime that is required
during the denormalization process. See, Common Data Model denormalization execution
tasks.
The maintenance window is during the interchange between original and parallel hierarchy.
During this stage any query(ies) triggered on denormalized class(es) may give you
undesired results. This is because the joins are changed from _(Underscore) form(s) to
OBJSTR:CatClassStub thus making _(Underscore) form(s), namely BMC_Product_,
BMC_LogicalSystemCompoennt_, BMC_Component_ orphan. The data is stored in _(
Underscore) form(s) and values for related fields in regular parent form (in this case
BaseElement and BaseRelationship) are blank.
During data migration stage (which is immediately after flip of original hierarchy with parallel),
data is getting moved from _(Underscore) forms to immediate regular parent forms for the
fields which are moved to parents. During this period any query(ies) fired on the
denormalized class(es) may give undesired results. This is because if data is not moved yet
during data migration stage and query is fired for the denormalized classes then query will
return blank values for the attributes.
For all the steps prior to flip hierarchy, there is really no change for user. User can work
without any issues seamlessly with NO impact to work due to denormalization process.
Observation:
The overall maintenance window is ~15 minutes for ~2 million CIs.
The overall maintenance window is ~85 minutes for ~10 million CIs.
No. of CIs
Maintenance Window for
Flip Activity
Migration Activity
BMC Atrium Core 9.0
Page 644 of 2268
Home
No. of CIs
Maintenance Window for
2 million
10 minutes
5 minutes
10 million
50 minutes
35 minutes
6. The cdm denormalization utility performs post-validation tasks. Ensure that post-validation
stage is completed successfully.
At this stage, if any post-validation errors are reported, the utility will exit. You must fix the
error and re-run the utility. When you re-run the utility, it will skip all the tasks that were
completed successfully and resume from the point the error occured.
See, Common Data Model denormalization post-validation tasks .
7. (Optional) In the cdmflattenning.log file verify if the CDM classes and relationships are
denormalized and the data is migrated to the BMC_BaseElement and
BMC_BaseRelationships class.
The log file is located at the following location:
<install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\log\
cdmflattenning.log
8. Refresh the BMC AR System mid tier. You need to sync the cache.
9. Migrate the delta data. See, Migrating delta data after Common Data Model denormalization .
Note
After the denormalization process is complete, you can delete the database tables
corresponding to BMC_Product_, BMC_LogicalSystemCompoennt_, and
BMC_Component_ forms. For detailed documentation on searching corresponding
forms, see The main data table for a form
Limitations
While running the CDM denormalization utility, if there is any custom CatSubclass below the
BMC_Software abstract class with existing attributes of custom CatSubclass then those
attributes will not get moved to the BaseElement class.
After running the CDM denormalization utility, the related field to those attributes are moved
to the BaseElement class. These fields are displayed automatically only for an English locale
view.
After running the CDM denormalization utility, the join definition for the deprecated class
below the denormalized class does not get updated with form name of parent class.
Using GUI for denormalizing Common Data Model

You can run the Common Data Model (CDM) denormalization process using the GUI provided in
the BMC Atrium Core console.
BMC Atrium Core 9.0
Page 645 of 2268
Home
Note
You must always perform CDM Denormalization after you have finished the delta
data migration activity. However, for some reason, if you need to perform CDM
Denormalization after delta data migration, see Migrating delta data after Common
Data Model denormalization
You cannot perform CDM denormalization if you have already executed it once on
the system.
The following steps explain how to use the CDM denormalization GUI:
1. In the Atrium Core Console, select Advanced > CDM DeNormalization. Atrium CDM
DeNormalization Console opens in a new window.
2. In the Atrium CDM DeNormalization Console, select the following check boxes
a. Have you taken the AR database backup (mandatory)
b. Do you want to rebuild indexes on the impacted tables at the end (optional)
3. Click Start CDM DeNormalization button.
Note
Start CDM DeNormalization button will remain unavailable until you have selected
the Have you taken AR database backup? check box.
The status of denormalization is displayed in the table. The following color coding is used to
denote a particular status:
BMC Atrium Core 9.0
Page 646 of 2268
Home
Green: Success
Amber: In progress
Red: Failed
4. A message is displayed after the denormalization process has completed successfully.
5. Click OK.
Common Data Model denormalization pre-validation tasks

When you run the CDM denormalization utility, the utility performs certain pre-validation tasks
before the actual denormalization happens. During, perform the following.
For 9.0.00.001 pre-validation checks, do the following
1. Check the log for any pre-validation errors.
2. Fix the pre-validation errors.
3. Open the Denormalization utility again and run it.
BMC Atrium Core 9.0
Page 647 of 2268
Home
For pre-validation checks, do the following

1. Validation errors occur, and the utility exits.
2. Fix the validation errors.
3. Open the Denormalization utility again and run it.
The details of the pre-validation tasks are recorded in the cdmflattening.log and <localhost>.txt
file located at the following location:
<install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\logs

The CDM denormalization utility performs the following pre-validation tasks.
No
.
Pre-validation check
To troubleshoot
Pre-validation check for mandatory

fields in the denormalized classes
CDM denormalization utility exits if you have used mandatory fields in the classes
that are going to be flattened.
You must change the mandatory attributes from the classes to optional before
denormalization.
Pre-validation check for custom filters

in the denormalized classes
CDM denormalization utility exits if you have used custom filters in the classes that
are going to be flattened.
You must remove the filters from the classes to be flattened and move to the
BMC_BaseElement class.
Pre-validation check for custom

active links in the denormalized
CDM denormalization utility exits if you have used custom active links in the classes
that are going to be denormalized.
classes
You must remove the active links from the forms that are mapped to the classes that
are to be flattened and move to the form representing BMC_BaseElement class.
4

escalations in the denormalized
classes
CDM denormalization utility exits if you have used custom escalations in the classes
that are going to be denormalized.
You must remove the escalations from the forms that are mapped to the classes
that are to be flattened and move to the form representing BMC_BaseElement class
.

classes entry in the denormalized
CDM denormalization utility exits if you have modified the cdmflatten.properties

file by adding additional classes in the list of classes to be denormalized.
classes list
You must remove the custom classes from the list, as CDM denormalization is
supported only for OOTB classes.
6
Pre-validation check for Attribute

Name conflict
CDM denormalization utility exits if there are attributes with same name among the
classes to be flattened.
You must rename the duplicate attributes.
Pre-validation check for Attribute

Field ID conflict
CDM denormalization utility exits if there are attribute fields with same ID.
You must change the field ID of the duplicate attribute field.

Indexes conflicts
BMC Atrium Core 9.0
Re-attach the index
---
Page 648 of 2268
Home
No
.
Pre-validation check
To troubleshoot
Pre-validation check for whether

CDM denormalization is already
performed
10
Pre-validation check for whether AIE/
Stop the jobs and continue.
AI/NE/RE jobs are running

You must manually stop any third party tools you use to integrate CMDB
data.
Where to go from here

Common Data Model denormalization execution tasks
Common Data Model denormalization execution tasks

CDM denormalization terminologies
Parallel hierarchy: A copy of the existing CDM hierarchy. The denormalization changes are
first implemented in the parallel hierarchy.
Refresh class: Classes which are immediate child of the denormalized classes.
New class: Classes in the parallel hierarchy which are denormalized by converting to
categorization sub class.
When the actual CDM denormalization process is performed, all the CDM denormalization changes
are first implemented in the parallel hierarchy (Step 1 to Step 7) and then the parallel hierarchy is
flipped with the existing CDM hierarchy (Step 8 to Step 10) .
The following tasks are performed:
No
Task
Description
Export
existing
flatten
class
definitions
The following definitions of the classes to be denormalized are exported to the backup folder. This essentially is a file system backup.
BMC Atrium Core 9.0
forms
views
filters
active links
Page 649 of 2268
Home
No
Task
Description
Create
parallel
class
hierarchy
A parallel hierarchy of the classes to be denormalized is created with the appropriate class type as categorization sub class. This tasks helps
Move all
related
attributes
All the related attributes of the classes to be denormalized are moved the immediate regular class.
With this release, the following classes are flattened:
TMP_Product categorization sub class is created in the parellel hierarchy for the BMC_Product regular class.
TMP_LogicalSystemComponent categorization sub class is created in the parellel hierarchy for the BMC_LogicalSystemComponent r
TMP_Component categorization sub class is created in the parellel hierarchy for the BMC_Component regular class.
For this release, attributes of following classes in the parallel hierarchy are moved:
Attributes of TMP_Product categorization sub class are moved to BMC_BaseElement class in the parallel hierarchy.
Attributes of TMP_LogicalSystemComponent categorization sub class are moved to BMC_BaseElement class in the parallel hierarchy
Attributes of TMP_Component categorization sub class are moved to BMC_BaseRelationship class in the parallel hierarchy.
BMC Atrium Core 9.0
Page 650 of 2268
Home
No
Task
Description
Export
existing
refresh
class
definitions
Forms/views/worlfkow definitions of classes which are immediate child of denormalized classes are exported.
The class list includes
For regular class
BMC.CORE:BMC_DiskPartition;
BMC.CORE:BMC_FileSystem;
BMC Atrium Core 9.0
Page 651 of 2268
Home
No
Task
Description
BMC.CORE:BMC_ResourcePool;
BMC.CORE:BMC_Share;
BMC.CORE:BMC_StorageExtent;
BMC.CORE:BMC_SystemResource;
BMC.CORE:BMC_Patch;
BMC.CORE:BMC_SystemSoftware
For relationship regular class
BMC.CORE:BMC_ApplicationSystemServices;
BMC.CORE:BMC_ContractComponent;
BMC.CORE:BMC_OfferingMeasuredBy;
BMC.CORE:BMC_ServiceRealizedByOffering
BMC Atrium Core 9.0
Page 652 of 2268
Home
No
Task
Description
Export
new class
definitions
The class definitions of the new categorization sub classes classes created as part of parallel class hierarchy are exported. Essentially, form
BMC Atrium Core 9.0
Page 653 of 2268
Home
No
Task
Description
Modify
exported
new class
defintions
The exported new class definitions are modified.
BMC Atrium Core 9.0
Page 654 of 2268
Home
No
Task
Description
For example, the form name of TMP_Product form created as part of the parallel hierarchy is modified to BMC_Product from which is the ac
7
Modify
refresh
class
definition
The refresh class definitions are updated wherein, join definition of the classes are modifed to include immediate parent class instead of _ fo
For example,
Before flattening: The secondary form of BMC_DiskPartition class is BMC_LogicalSystemComponent
After flattening: The secondary form of BMC_DiskPartition class is BMC_BaseElement
BMC Atrium Core 9.0
Page 655 of 2268
Home
No
Task
Description
Import
modified
new and
refresh
class
definition
The modified new and refresh class definitions are imported from the parallel hierarchy to the actual hierarchy. The New and refresh class de
BMC Atrium Core 9.0
Page 656 of 2268
Home
No
Task
Description
Update
CMDB
metadata
to reflect
the
correct
class type
for
flattened
classes.
The BMC Atrium CMDB metadata is updated to reflect the correct class type for denormalized classes.
For example, OBJSTR:Class form name of flattened class with show CategorizationSubClass field as 1 which indicates the class is denorma
BMC Atrium Core 9.0
Page 657 of 2268
Home
No
Task
Description
10
Do data
migration
Task will do the Data movement for the attributes which got moved to the immediate regular parent.
BMC Atrium Core 9.0
Page 658 of 2268
Home
No
Task
Description
Attributes of the denormalized classes are moved to immediate parent regular class. Data is migrated from the _ forms BMC_product, is mov
Where to go from here

Common Data Model denormalization post-validation tasks
Common Data Model denormalization post-validation tasks

When you run the CDM denormalization utility, the utility performs certain post-validation tasks after
the actual denormalization happens. If an validation error occurs, the utility exists. You must fix the
error and restart the process. The utilty will skip all the successful post-validation checks and
resume from the point when error was recorded.
The details of the post-validation tasks are recorded in the cdmflattening.log and localhost.txt file
located at the following location:
<install dir>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\logs
The CDM denormalization utility performs the following post-validation tasks.
BMC Atrium Core 9.0
Page 659 of 2268
Home
Post validation check
Description
Verify CMDB class metadata

operations
Verifies if denormalized classes are created successfully.
Verify CMDB class type information
Verifies if all classes in denormalized list are changed to type Categorization subclass.
Verify CMDB form definitions
Verifies join form information of classes after denormalization.

For example, in case of BMC_LogicalSystemComponent categorization subclass, the
primary from is OBJSTR:CatClassStubb and Secondary from is BMC_BasElement
Verify CMDB instance API operations
Verifies the API operations of the denormalized classes

Verifies Create/Set/Delete/Get instance operations of denormalized classes and
relationship.
Verify fields movement to base forms
Verifies if fields are moved to the BMC_Baselement.

For example, in case of BMC_Product class, the Product Type field is now moved to the
BMC_BaseElement class. You will see the Product Type field in the Base Element form.
The UI will have checkbox to rebuild

indexes of BMC_BaseElement and
BMC_Baserelationship classes.
It is recommended to rebuild indexes on CDM base tables (BMC.CORE:

BMC_BaseElement & BMC.CORE:BMC_BaseRelationship) for performance benefits.
Time taken to complete rebuilding will depend on size of DB and its performance.
Please select if you want to continue rebuilding index - (Y/N)?
Migrating delta data after Common Data Model denormalization

In case of a parallel upgrade (with staging server), please consider the following before migrating
the delta data:
You need to refresh the Delta Data Migration (DDM) package before you migrate the delta
data to the server with denormalized CDM.
You must perform the delta data migration only after the CDM denormalization is complete
and all the validation tasks are successfully complete.
For this release, the scope of the delta data migration is limited to the following
out-of-the-box classes and attributes. Delta data only for the these classes and attributes is
migrated. If you are using custom attributes for any of these classes, you need to update the
respective .arm file.
The scope of current DDM is limited to the following OOTB classes and attributes:
Supported Classes
Attributes
BMC_LogicalSystemComponent
SystemClassId
SystemName
isVirtual
BMC_Product
ProductType
BuildType
LicenseType
BMC Atrium Core 9.0
Page 660 of 2268
Home
Supported Classes
Attributes
ServicePack
ConfigurationBasicNumber
ContractID
LicensesAvailable
PatchNumber
InstallLocation
BuildNumber
BMC_Component
IsNext
IsMaximum
IsDefault
IsMinimum
IsCurrent
IsPending
To migrate delta data after CDM denormalization

1. Copy the 9.0 folder of CDM denormalization DDM package from Atrium Core Home
directory to the Migrator installation folder.
For example,
Copy From:
C:\Program Files\BMC Software\AtriumCore\cmdb\utils\cdmflattening\Migrator\DDM\
DDM_Packages\Atrium\CMDB\8.8\
To:
C:\Program Files\BMC Software\Migrator\migrator\DeltaDataMigration\Packages\Atrium\
CMDB\8.8\
2. Open the BMC-Atrium_CMDB.xml file from the 8.8 folder of CDM denormalization in the
Atrium Core Home directory.
For example,
C:\Program Files\BMC Software\Migrator\migrator\DeltaDataMigration\Packages\Atrium\
CMDB\8.8
3. Locate the BMC.CORE:BMC_Product_ form name entry and change the data enabled tag
to false.
For example:
From:
<data enabled="true" source-form="BMC.CORE:BMC_Product_" destination-form="
BMC.CORE:BMC_Product_" type="data" mode="search" merge-option="update"
ignore-required-fields="true" ignore-pattern-matching="true" count="0"
disable-related-workflow="true">
BMC Atrium Core 9.0
Page 661 of 2268
Home
To:
<data enabled="false" source-form="BMC.CORE:BMC_Product_" destination-form="
BMC.CORE:BMC_Product_" type="data" mode="search" merge-option="update"
ignore-required-fields="true" ignore-pattern-matching="true" count="0"
disable-related-workflow="true">
4. Repeat step 3 for BMC_LogicalSystemComponent_ and BMC_Component_ forms.
5. Run the Migrator. See, Migrating delta data after an upgrade .
Common Data Model denormalization logging

You can refer to the following logs when implementing CDM denormalization.
When you deploy the BMC Atrium Core CDM Denormalization DevOps pack 1, logs are
created in the \temp folder in the devops_install_log.log file
Detail logs of the CDM denormalization process are recorded in the cdmflattening.log file
located at the following location:
<installation directory>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\log
The summary of CDM denormalization process is recorded in the localhost.log file located
at the following location:
<installation directory>\BMC Software\AtriumCore\cmdb\utils\cdmflattening\log
Administering service models and the Service

Catalog
A service model is an extensible system that defines the resources that deliver business services,
models their behaviors and functional relationships, and manages the delivery of the resulting
services.
Creating the service model in BMC Atrium Core
Defining options for the Service Catalog
Adding a customer price or delivery cost to an option, service, or request action
Creating new services for the Service Catalog
Creating a service offering in the Service Catalog
Creating a request action in the Service Catalog
Using a CI query to create dynamic service models
Service model
BMC Atrium Core 9.0
Page 662 of 2268
Home
You can view and change the relationships between the components and add new components to
the model. Service models enable you to understand how the IT infrastructure impacts the business
services that IT provides.
For example, a cart checkout application is a component of an online store that supports and
enables the convenient checkout feature of the online store. The relationship between these items (
the application and the actual service) is part of the service model of the online store. For
information about designing a service model, see Designing a service model.
Supporting your service model, the impact model enables you to assess the effect that an incident,
fault, or other change might have on business operations or services.
BMC Atrium Core 9.0
Page 663 of 2268
Home
ITIL V3 has raised the importance of service lifecycle management and the need to align IT with
business goals. Creating a service catalog has two main challenges. First, customers and partners
need to know clearly what services IT offers and what it does not. One reason is that services are
fragmented, and service information is managed in different places or silos. Process and end user
information is managed in one place, service level management is managed elsewhere, and
another application manages costs.
Second, service models tend to focus on the infrastructure and on the technical services and
associated CIs in an environment. The focus is on the supporting services and details and not on
the business services. For example, when a particular server fails, an IT staff member might not
know the business service that is affected, such as the ability to book orders. In this situation, the
service model and the service catalog present only a partial view of the services.
As a result of these challenges, an IT user cannot view the whole service. Rather than design a
service catalog starting with the CIs, ITIL V3 requires starting with the business service. The
Service Catalog in BMC Atrium Core allows you to overcome fragmentation and to provide a more
complete view of services:
Focus on services to generate better business results.
Create a catalog of services in which you manage cost, quality, and value.
Use a common language for IT and businesses to communicate clearly what IT does and
does not do.
Creating the service model in BMC Atrium Core

The service modeling process helps you identify your business services and how those services
are delivered and supported by your IT framework. While the process of creating your service
model enables you to view your business services in the context of all your business processes, the
service model is more useful if you use it to manage the impacts of events on your business
services. For example, you can use the BMC Atrium Impact Simulator to determine how business
services would be impacted by taking a server offline to upgrade software.
Using BMC TrueSight Operations Management to create a service model
Deciding on the structure of the service model
Maintaining your service model dynamically
Using BMC Impact Solutions to create a service model

The applications that make up BMC Impact Solutions help you build and use a service model.
Those tools also enable you to manage impacts of events on your business services. For example,
the Service Catalog represents the service model as individual resources represented by
component instances. A component instance is created through BMC Impact Model Designer as a
single instance of a class that is defined in BMC Atrium Configuration Management Database (
BMC Atrium CMDB). Classes can identify such physical components as servers or databases, and
such logical components as user groups.
BMC Atrium Core 9.0
Page 664 of 2268
Home
Whether you have implemented BMC Impact Solutions in your environment or not, BMC Atrium
Impact Simulator and the Service Catalog offer additional ways to use your service model.
Deciding on the structure of the service model

How you organize service model components depends on the goals that your organization wants to
attain through Service Impact Management, so determine those goals first. You can organize your
service model components by using one of these basic organizational strategies:
The business continuity and service availability strategy implements a business-centric
model in which business processes and services rely on a small number of vital IT
components to give a status overview of the underlying environment. This type of
implementation is driven from the top, ensuring that IT is delivering their services as agreed.
The driving force is business continuity and availability. This strategy is similar to the BMC
Software BSM strategy that is called a Business Service Impact Model.
The business-focused operational efficiency strategy creates a balanced representation of
the operational environment, encompassing the IT components, such as systems and
applications, and the logical components, such as services, user groups, and other business
objects. This type of implementation is likely to involve various populations of management
in the enterprise. The driving force is operational efficiency but with a balanced business
perspective.
The IT resource management strategy creates a thin layer of logical groupings on top of a
large number of IT resources, ranging from applications and systems to hard disks and other
hardware components. This type of implementation is run by and for the IT group. Services
are just logical groupings that provide a convenient way of classifying the technical
resources. The driving force behind this model is operational efficiency.
Although these strategies are only briefly outlined here, they are helpful in understanding that each
implementation probably has a different focus, favoring some types of components and having
more or less granularity in some branches of the component hierarchy. The strategy that you
choose also affects the amount of time and effort required for its development and implementation.
For more information about service models as used in BMC Service Impact Manager, see
the BMC Impact Solutions: Service Model Administrator's Guide .
For more information about BMC Atrium Impact Simulator, see Simulating the impact of
changes to CIs.
For more information about the Service Catalog, see Administering service models and the
Service Catalog.
Maintaining your service model dynamically

BMC Atrium CMDB has a dynamic service modeling feature that can automatically relate technical
services in your Service Catalog to infrastructure configuration items (CIs), such as computer
systems, that support them. BMC recommends that you take advantage of this feature to enable
you to better manage your services.
BMC Atrium Core 9.0
Page 665 of 2268
Home
For instructions on configuring dynamic service modeling, see Using a CI query to create dynamic
service models.
Defining options for the Service Catalog

Like request actions, options are visible to end users and define the flexibility of your services. An
option might be one particular customization, such as an email inbox capacity of 250 MB, where a
request action might be a bundle of options, such as storage and backup options. For example, a
mobile cell plan can offer a bundle of options, such as unlimited messages, call forwarding, and a
data plan, or a user can select each of them as individual options as needed.
In the Service Catalog, you can use options for the service offerings and request actions. An option
has one or more choices, each of which has cost and price information. These options and their
choices are used when end-users make a request in a request console, such as BMC Service
Request Management. They are managed separately from offerings because they do not rely on a
specific offering. You can reuse options across offerings.
To create an option and option choices

1. In the Service Catalog, click Options Editor.
Tip
While editing a service offering or request action, you can also open the Options
Editor in the Options tab.
Options Editor
BMC Atrium Core 9.0
Page 666 of 2268
Home
2. In the Options area, click New Option.

3. In the New Option window, enter a name and description for the option.
4. For Option Type, select whether the option is for request definition, post-deploy action, or
any request.
Any Request (the default) Available as an option for request actions and service
offerings.
Request Definition Available as an option for service offerings.
Post-Deploy Action Available as an option for request actions.
5. Click OK.
The new option is listed, and you can create option choices for it.
6. To allow users to select more than one choice for an option, select the Multi-Select check
box.
By default, Multi-Select is not enabled, and users can select only one choice per option.
7. In the Option Choices area, click New Option Choice.
8. In the New Option Choice window, enter a name and description for the option choice.
Option Choice
BMC Atrium Core 9.0
Page 667 of 2268
Home
9. Set the Customer Price or Delivery Cost.

For detailed instructions, see Adding a customer price or delivery cost to an option, service,
or request action.
10. In the New Option Choice window, click OK.
The new option choice is listed.
11. To change the order of the choices, select a choice, and click the move up or down button.
Customers will see the order of choices that you have defined.
12. To make a choice the default, select the Pre-Select check box.
13. Create options and choices as needed.
14. In the Option Editor, click OK.
Note
You must click OK in the Options Editor to save changes to the options and
choices.
Adding a customer price or delivery cost to an option, service,

or request action
When defining an option, service, or request action, you can use the Price Editor to include optional
customer prices or the Cost Editor to include an optional delivery cost. The fields in the Price Editor
and the Cost Editor are the same. The only difference is their function.
Customer Price Amount charged to the customer for the option choice.
BMC Atrium Core 9.0
Page 668 of 2268
Home
Delivery Cost Amount that it costs to offer the option choice. This cost can include real
cost, notational costs (such as staffing time), and depreciation.
To add a customer price or delivery cost to an option, service, or request action

1. Click Add new price to open the Price Editor (shown in the following figure), or click Add
new cost to open the Cost Editor.
Price Editor
2. Enter a name (for example, Per Instance).

3. From Currency, select a currency type (for example, EUR).
The default is USD.
4. Click This is my default to override your previous default settings.
5. From Units, select a unit of measure.
You can select GB (Storage), CPU Count, CPU Seconds, CPU % Utilization, Named User,
Concurrent User, or Instance (the default).
6. In Alias, enter an alias to the unit (for example, each).
8. From Period, select a time period.
You can select Hour, Day, Week, Month (the default), Quarter, Year, a One-Time charge, or
Other.
9. In Alias, enter an alias to the unit (for example, every ).
11.
BMC Atrium Core 9.0
Page 669 of 2268
Home
11. Click Show Choices with alias to display the alias appear in the Base Deployment Price
field.
Or click Show Choices without alias to hide the aliases.
12. Click Save.
The settings appear in the Customer Price or Delivery Cost fields.
Creating new services for the Service Catalog

A service is the utility that an organization provides and is defined by its service offerings, request
actions, and service level targets. For example, the Calbro IT organization offers an email service,
which includes gold and silver service offerings that have service level targets based on response
times.
In the Service Catalog, a service must have at least one service offering and can have one or more
request actions. For more information, see Creating a service offering in the Service Catalog and
Creating a request action in the Service Catalog .
When you create a service, it is saved to BMC.ASSET dataset.
Recommendations
To make sure that your business service configuration items (CIs) appear in the Service Catalog,
use the Service Catalog to create them. The Service Catalog displays only instances of
BMC_BusinessService where the ServiceType attribute is set to "BusinessService" or "
TechnicalService", and it correctly sets this attribute when creating a CI. Other BMC interfaces
that create business service CIs, such as BMC Atrium Explorer or BMC Impact Model Designer, do
not correctly set the value for ServiceType. If an existing business service CI does not appear in the
Service Catalog, edit the value of ServiceType to make it appear. To avoid potential issues with
reconciliation and promotion, do not create service CIs with duplicate names.
To create a service
1. In the Service Catalog, click Create a new service.
Creating a new service
BMC Atrium Core 9.0
Page 670 of 2268
Home
2. Enter the service name.

3. For Type, select a service type.
Business service Services that customers use and that shows the customer view of
services, such as email or an online store.
Technical service Supporting IT and infrastructure resources required to support
business services that are not visible to customers, such as servers, applications, and
network CIs.
4. Enter a description of the service.
5. Click Save to create the service.
After creating a service, define a service offering. For more information, see Creating a service
offering in the Service Catalog.
For technical services, you can use the Map IT Resources to use queries to associate CIs with
technical services. For more information, see Using a CI query to create dynamic service models .
Creating a service offering in the Service Catalog

A service offering defines a level of service for a price: it combines the service (utility) and a service
level target (warranty) to bring value to the customer.
For example, the Calbro IT organization offers different service offerings, or levels, for a email
service based on response times. Each service offering costs a different amount based on the
service level targets.
About service offerings
Before you begin
To create a service offering
BMC Atrium Core 9.0
Page 671 of 2268
Home
About service offerings

The gold service offering has the following definition:
Service Level Target
Type: Response Time
Description: 5 minutes 80% of time
Price: USD $8 per year per instance
The silver service offering has the following definition:
Service Level Target
Type: Response Time
Description: 15 minutes 80% of time
Price: USD $12 per year per instance
You can define service offerings based on how you want to manage your services. For example, if
managing your services by location is important to your business, you might create the service
offerings for Email-US, Email-Europe, and Email-Asia. If managing services by organizations and
their resource demands, you might have service offerings for Finance-Small, Finance-Medium,
Finance-Large, Support-Medium, and Support-Large to customize for the different storage
requirements for each organization.
In the Service Catalog, you can further define a service offering:
Associate a service offering with a technical service.
Add options to the service offering for end users to select.
All technical and business services must have at least one service offering and can have more than
one.
When you create a service level target in the Service Catalog, it does not create a record in nor
retrieve data from BMC Service Level Management. For more information, see :
Before you begin

Create the technical services needed to support each service offering.
(optional ) Define the options and choices.
BMC Atrium Core 9.0
Page 672 of 2268
Home
To create a service offering

1. From the Service Catalog, edit or create a service.
In the Service Offering tab, a default service offering is available, which you can edit.
Creating a new service offering
2. To add a new offering to the service, click Create a New Service Offering.
Tip
You must be in the Service Offerings tab to create a new service offering.
3. In the General Information tab, define the parameters described in the following table.
Service offering parameters
Parameter
Description
Default
Service
Offering
Enable this option to make the selected service offering the default for the service. Unless users select a
different service offering, the default service offering is used.
Name
A short, descriptive name for the service offering.
Description
A more detailed description of the service offering.
Lifecycle
Stage
Set the service offering to one of the following ITIL stages:

Requirements The business or IT organization has submitted a set of outline requirements for a
new or changed service.
Defined The requirements for a new service are being assessed, defined and documented, and
the Service Level Requirements (SLRs) are being produced.
Analyzed The requirements for a new service are being analyzed and prioritized.
Approved The requirements for a new service are being finalized and authorized.
BMC Atrium Core 9.0
Page 673 of 2268
Home
Parameter
Description
Chartered The new service requirements are being communicated, and resources and budget
are being allocated.
Designed the new service and its constituent components are being designed and procured as
required
Developed The service and its constituent components are being developed or collected as
required.
Built The service and its constituent components are being built.
Tested The service and its constituent components are being tested.
Released The service and its constituent components are being released
Operational The service and its constituent components are operational within the live
environment.
Closed The service and its constituent components that was released is not available but not
retired.
Retired The service and its constituent components are being retired because the business no
longer needs them, other services have superseded them, or they are no longer cost-effective.
4. Set the Base Customer Price to define the amount charged to the customer for the service
offering.
You can enter multiple customer prices per service. For detailed instructions, see Adding a
customer price or delivery cost to an option, service, or request action .
The settings appear in the Base Customer Cost fields.
5. Set the Base Delivery Cost to define the amount that it costs to provide the service offering.
The Cost Editor appears. You can enter only one customer price per service. For detailed
instructions, see Adding a customer price or delivery cost to an option, service, or request
action.
The settings appear in the Base Delivery Cost fields.
6. Click Apply to activate the Options tab, and then click the Options tab.
Options when creating a new service offering
7. In the Options tab, add options to the service offering.

You can only select options whose Type is set to Any Request or Request Definition.
BMC Atrium Core 9.0
Page 674 of 2268
7.
Home
The choices for the selected option appear in the Option Choice table.
To create an option or option choice, click Options Editor.
8. To create categories for options, follow these steps.
a. In the Selected Options view, select an option that you have added to the service
offering.
b. In the Category field, type a name for a new category.
c. Click Add category.

The selected option appears in the new category.
d. To move choices among categories, select an option, and use the arrows to move it
up or down in the list.
If a category is empty, it is deleted.
e. To delete a category, select it, and click Remove category.
The category is removed, and options in that category are moved to the Default
Category.
9. To complete the remaining steps, click Show Advanced Features.
The Link Request Actions, Supporting Technical Services, and Service Level Targets
tabs appear.
10. In the Link Request Actions tab, select the request actions that are currently associated
with the global service.
Link request actions included in the service
BMC Atrium Core 9.0
Page 675 of 2268
Home
These request actions are created in BMC Service Request Management. By default, they
are associated with the global service. When you select them in the Link Request Actions
tab, they are then associated with the current service offering. If you clear a request action, it
is no longer associated with the current service offering and links to the service offering in
the global service.
For more information, see Creating a request action in the Service Catalog .
11. In the Supporting Technical Services tab, link the service offering to technical services.
Linking service offering to technical services
## In the Available Technical Services area, search for a technical service.

Only the names of technical services are searched.
a. Select a technical service.
b. Click Add.
c.
BMC Atrium Core 9.0
Page 676 of 2268
Home
c. In the Selected Technical Services table, select the technical service.

The service offerings for the technical service appear in the Service Offerings table.
d. Select a service offering.
Note
You cannot select more than one technical service offering.
12. In the Service Level Targets tab, create and modify service level targets for the selected
service offering.
Defining service level targets
a. Define the parameters described in the following table.

Parameter
Description
Name
A short, descriptive name for the service offering.
Description
A more detailed description of the service offering. You can use the description to specify the
target requirement.
Type
Select the type of service level target from the following list:
Measurement
Policy
Other
Classification
Select the classification of the service level target from the following list:
Incident Response
Availability
Capacity
SR Turn Around Time
b. To add the target to the service offering, click New Service Level Target.
c.
BMC Atrium Core 9.0
Page 677 of 2268
Home
c. To modify a target, select one, and click Edit selected Service Level Target.
d. Modify the target's parameters.
e. Click Save to Selected Service Level Target.
13. Click Save.
After creating a service offering, you can define a request action. For more information, see
Creating a request action in the Service Catalog .
Creating a request action in the Service Catalog

A request action is the part of a service that end users can see and request. Like a service offering,
it combines a service (utility) and a service level target (warranty). But unlike with a service offering,
end users can select a request action.
For example, the Calbro IT organization creates the following request actions for its email service:
Create a new account.
Reset an account password.
Increase the inbox size limit.
Backup and restore email.
The Calbro Finance group has the silver email service offering. An end user like Patrick Paycheck
cannot see or select a service offering, such as gold or silver, but he can select from the request
actions. He already has an account but, because he deals with budget requests from several other
groups, he needs a higher quota on his inbox size.
In the Service Catalog, services do not require a request action but can have one or more. You can
also associate options with a request action.
Before you begin

Create a service with at least one service offering.
(optional ) Define the options and option choices.
To create a request action

1. From the Service Catalog, edit or create a service.
2. Select a service offering.
3. From the pulldown list for Create a New Service Offering, select New Request Action.
4.
BMC Atrium Core 9.0
Page 678 of 2268
Home
4. In the General Information tab, enter a name and description for the request action.
Creating a new request action
5. To set the One-time Price and Base Delivery Cost, select a monetary unit and amount, and
then select the charge type and interval.
The One-time Price is the amount charged to the customer for the request action. You
can include multiple one-time prices.
The Base Delivery Cost is the amount that it costs to provide the request action.
For detailed instructions, see Adding a customer price or delivery cost to an option,
service, or request action.
6. In the Options tab, add options to the service offering.
You can only select options whose Type is set to Any Request or Post-Deploy Action.
The choices for the selected option appear in the Available Options table.
To create an option or option choice, click Options Editor.
7. To create categories for options, follow these steps.
a. In the Selected Options view, select an option that you have added to the service
offering.
b. In the Category field, type a name for a new category.
c. Click Add Category.

The selected option appears in the new category.
d.
BMC Atrium Core 9.0
Page 679 of 2268
Home
d. To move choices among categories, select an option, and use the arrows to move it
up or down in the list.
If a category is empty, it is deleted.
e. To delete a category, select it, and click Remove Category.
The category is removed, and options in that category are moved to the Default
Category.
8. Click Save.
9. Click the Link Request Actions tab on the service to view all the request actions that are
currently associated with the global service. For more information, see Creating a service
offering in the Service Catalog (step 10) .
Using a CI query to create dynamic service models

You no longer need to manually create relationships between configuration items (CIs) if you have
a business rule that you can apply in your IT infrastructure. For example, servers should
automatically be linked to an application or to a cluster. The dynamic service model lets you map a
query to any CI to automate the maintenance of service models supporting that CI.
In your service model, you can dynamically link or unlink a technical service to the CIs delivering
that service. You can create and associate one or more queries with a technical service from the
BMC Atrium Explorer toolbar. You can then define a scheduled interval when the dynamic service
model server runs those queries. The CIs returned by these queries are automatically linked to the
technical service attached to the queries. Any existing links to components that are no longer
returned by these queries are unlinked from the service.
For example, Allen Allbrook, the Calbro Services administrator, does not want to manually examine
all the computer CIs that have changed in his IT infrastructure to see how they affect a technical
service CI. Instead, he can create an automated query that runs every 30 hours. This query returns
all computer CIs related to that technical service.
To associate queries with a technical service (when creating a dynamic service model)
To delete a query
To edit a query associated with a technical service
To associate queries with a technical service (when creating a dynamic service

model)
1. In BMC Atrium Explorer, open the BMC.ASSET dataset.
2. Search for a technical service CI and drag it into the display pane.
3. Select the technical service CI.
4. From the BMC Atrium Explorer toolbar, click Map IT Resources.
Note
BMC Atrium Core 9.0
Page 680 of 2268
Home
Map IT Resources in BMC Atrium Explorer is enabled when you select any CI
from the BMC.ASSET dataset and you have administrative privileges.
The Map IT Resources dialog box appears. The Available Queries list shows the queries
available for the selected service.
Map IT Resources dialog box
5. Perform the following actions with CI queries:

Associating queries with a technical service
Task
Steps
To use an
existing
query
a. Select a query from the Available Queries list

b. Click the arrow to add it to the Selected Queries list.
To create a
new query
a. Click New.
b. In the Query - New dialog box, create a query that returns CIs that you want related to the
technical service.
For example, you might create a query of the BMC_ComputerSystem class for computer names
that start with "Calbro". The qualification for that query is Name LIKE Calbro%.
c. Click Save.
For more information about creating queries, see Building queries in BMC Atrium Explorer.
6.
BMC Atrium Core 9.0
Page 681 of 2268
Home
6. In the Run queries every field, specify the time (by minutes, hours, or days) to run the
automated query.
The default is 30 hours.
7. Click Apply.
8. Click Close.
9. Wait for the queries to run in their specified time (for example, 30 hours).
10. Reopen the technical service and then expand its children.
The related CIs returned by the queries appear under the technical service in BMC Atrium
Explorer.
Note
If the query does not return the expected CIs linked to the technical service, review
the <atriumInstallDirectory>/logs/dsm.log file for errors. Make sure the DSM
engine and the plugin filters are properly running.
To delete a query
1. Select a query from the list.
2. Click Delete.
3. Click Yes when prompted.
To edit a query associated with a technical service

To edit a query associated with a technical service, search for a technical service instance in the
BMC.ASSET production dataset, and click Map IT Resources in the toolbar.
1. Search for a technical service CI and drag it into the display pane.
2. Select the technical service CI.
3. From the BMC Atrium Explorer toolbar, click Map IT Resources.
4. In the Map Technical Services dialog box, select a query.
5. Click Edit.
The Query - Edit dialog opens.
BMC Atrium Core 9.0
Page 682 of 2268
Home
Note
Dynamic service model is a continuously running process and it is not possible to
pass parameters during runtime. Hence, dynamic service model does not support
parameterized queries.
Even if you pass any parameters for search, a blank query will overwrite the
parameters and will quality all the CIs. It is hence recommended to keep the
qualifier check box clear.
6. Edit the query to match your current needs for the technical service.
For more information about queries, see Finding BMC Atrium CMDB data.
7. Click Save.
Managing datasets in BMC Atrium Core

Creating datasets in BMC Atrium CMDB to store data provided by different data providers is the
first step when importing data.
Creating datasets in the Reconciliation console
Deleting a dataset
Modifying datasets
A dataset is a logical grouping of data. It can represent data from a particular source, a snapshot
from a particular date, or other purpose.
BMC Atrium Core 9.0
Page 683 of 2268
Home
Make sure that each data provider has its own import dataset.
You should also note what dataset is your production, or golden, dataset so that you can plan your
normalization and reconciliation jobs. By default, the BMC.ASSET dataset is the production dataset
. In reconciliation, the production dataset is used in different ways. First, it is used as a master
dataset to identify duplicate CIs, matching attributes for the CI in the production dataset with the CIs
in the imported datasets. Second, it can be the target dataset in a merge activity so that the CIs are
updated to keep the production dataset current and accurate. Also, do not normalize the production
dataset because you should normalize CIs before identifying and merging them.
In cases where you need to merge more than one dataset at time, you might want to create an
intermediate dataset for merging. For better performance and to minimize impact on users of the
production dataset, BMC recommends that you merge one import or discovered dataset at a time
with the production dataset. You might want to merge multiple source datasets in separate jobs to
an intermediate dataset and then merge the intermediate dataset with the production dataset.
For more information about datasets, see Grouping CIs into datasets.
Creating datasets in the Reconciliation console

When you create a dataset, you give it both a name and an ID. The naming convention for dataset
IDs is as follows, and should be written using all capital letters:
<VENDOR_NAME>.<PURPOSE>[<.VENDOR _SPECIFIC_PRODUCT>]
<VENDOR_NAME> is the name of the company whose product provides or consumes data
from the dataset. If it is a site-specific dataset, it should have a vendor name of SITE.
<PURPOSE> is the purpose of the dataset, for example, ASSET, IMPORT, or ARCHIVE.
<VENDOR_SPECIFIC_PRODUCT> is the product or functionality area within a purpose.
For example, BMC Asset Management uses the BMC.ASSET dataset ID.
Note
Use datasets primarily to represent different data providers, but you can use datasets to
represent other types or groupings of data, such as test data, obsolete data, or data for
different companies or organizations for multitenancy.
Recommendation
Typically, you should create a regular dataset. Do not create an overlay dataset for a data provider.
For more information about overlay datasets, see Overlay datasets in BMC Atrium CMDB .
BMC Atrium Core 9.0
Page 684 of 2268
Home
To create a dataset
1. Create a dataset from different places in the console.
From the Identify activity, click Add Dataset Identification Group Association, and
then click Create Dataset.
In the Reconciliation console., click Create Dataset.
2. Complete the following fields.
Name
Type a unique name. The name cannot contain any characters that are not allowed in file names for the
operating system of your server. For example, on a Windows server, your job name cannot contain the
following characters: \ / : * ? " < > |
ID
Type a unique ID string for the dataset. The Dataset ID cannot contain a slash (/) , semicolon (;) , or
comma (,). If you do not provide an ID, the system generates a GUID to use for this ID. The Dataset
Name and Dataset ID cannot be changed from this window after you have created the dataset. However,
you can rename a dataset with a Rename activity. For information about this, see Renaming datasets by
using the Reconciliation Engine.
Accessibility
Select the whether instances can be created, modified, and deleted in the dataset.
Writable Any process can write to the dataset
Read-Only No process can write to the dataset; its data can only be viewed
Writable by client only Only the client processes specified in the ClientTypeList field can write
to the dataset
In most cases, select Writable.
Client Type
List
If you selected Writable by client only, type the client IDs of each BMC Atrium client that can write to this
dataset in the ClientTypeList field.
To allow all clients to write to this dataset, leave this field blank. If you enter any IDs here, only those
clients can create, modify, or delete instances in the dataset. Client IDs are integer values and must be
delimited by semicolons. The allowable client values are the following IDs:
BMC Impact Publishing Server: 28
BMC Impact Model Designer: 59
Reconciliation Engine: 32
Type
Select Regular or Overlay. For information about overlay datasets, see Overlay datasets in BMC Atrium
CMDB.
Source
Dataset ID
If you selected Overlay, type the SourceDatasetId for this new dataset. This is the Dataset ID of the
existing regular dataset that your new dataset overlays.
3. Click Save.
Deleting a dataset
Before deleting a dataset, you must run a reconciliation job to purge or delete configuration items (
CIs) from the dataset. Otherwise, the server returns an error when you try to delete the dataset.
For more information about all these normalization and reconciliation activities, see Normalizing
data and Reconciling data.
BMC Atrium Core 9.0
Page 685 of 2268
Home
To delete a dataset
1. To produce good identification results in reconciliation, use the Normalization Engine to
normalize the CI attributes between the two datasets.
You perform this step to make it easier to determine which CIs represent the same object. If
you do not intend to preserve the CIs, you can ignore this step.
2. For CIs that you want to preserve from the dataset that you intend to delete, create a
standard Identification and Merge job to merge the CIs into the BMC.ASSET dataset.
If you do not intend to preserve the CIs, you can ignore this step.
3. To remove all instances from the dataset, create and run a manual reconciliation job with a
Delete or Purge activity to remove all the CIs from the dataset.
4. Open the BMC.CORE.CONFIG:BMC_Dataset form and search for the dataset record that
you want to delete.
5. Delete the dataset record.
The dataset is now removed from the server.
Modifying datasets
As a BMC Atrium Core administrator, you might need to modify the dataset configuration settings a
dataset. The following tasks might be necessary:
Modifying the accessibility or client list of a dataset that you created in the Reconciliation
Engine.
Restricting the default ability to directly create configuration items (CIs) in the BMC.ASSET
dataset.
Creating a dataset that you must later delete.
Warning
Be careful how you modify the dataset especially datasets created by an installer (for
example, BMC.ASSET ) because your new settings might render it unusable. Do not
modify the DatasetType, Name, ClassId, or CoreDatasetId settings.
To modify the dataset settings

1. Open the BMC.CORE.CONFIG:BMC_Dataset form.
For example:
http://midTier:port/arsys/forms/ARServer/BMC.CORE.CONFIG:BMC_Dataset
http://vw-bsm-idd-midtier:8080/arsys/forms/idd-arserver/BMC.CORE.CONFIG:
BMC_Dataset
2. Search for the dataset record.
3.
BMC Atrium Core 9.0
Page 686 of 2268
Home
3. Change the configuration settings to restrict users from creating CIs directly in the BMC
Asset database with a back-end form (for example, BMC.CORE:BMC_ComputerSystem or
AST:ComputerSystem).
Important
BMC recommends that you create, modify, or delete CIs in the Sandbox dataset
and only then promote them to the BMC.ASSET dataset.
a. Change the Accessibility setting from Writable to Writable by client only.

b. In the ClientTypeList field, enter a client ID (for example, 32 is the Reconciliation
Engine).
If you add any client IDs in this field, only those clients can create, modify, or delete
instances in the dataset. Client IDs are integer values and must be delimited by
semicolons.
The following are the allowable client values:
BMC Impact Publishing Server: 28
BMC Impact Model Designer: 59
Reconciliation Engine: 32
Web browser: 9
BMC Remedy User (discontinued in the 8.0.00 release of the BMC Remedy
AR System): 3
4. Click Save.
5. To test the changes:
a. Open BMC.CORE:BMC_ComputerSystem in a web browser.
b. Create a new CI.
c. Set the DatasetId to BMC.ASSET.
d. Save the record.
If you correctly modified the dataset, the server returns the following error message:
You don't have proper access to this dataset. :Dataset ID:
BMC.ASSET. Current client type: 9 (ARERR 120124)

The following topics provide information and instructions for importing data by using Atrium
Integrator:
BMC Atrium Core 9.0
Page 687 of 2268
Home
Understanding Atrium Integrator

Limitations of Atrium Integrator
Scenario for transferring data to BMC Atrium CMDB
Working with Atrium Integrator data store connections
Creating a job in Atrium Integrator
Editing Atrium Integrator jobs and transformations
Running an Atrium Integrator job
Monitoring jobs in Atrium Integrator
Complex jobs in Atrium Integrator Spoon
Upgrading and migrating Atrium Integrator jobs
Migrating existing data exchanges to Atrium Integrator
Mapping BMC Atrium Integration Engine and Atrium Integrator
Important
BMC provides limited support for Pentaho and Atrium Integrator Spoon. See, Atrium
Integrator Spoon support.
The following interactive graphic summarizes the different tasks you need to perform using Atrium
Integrator. (The graphic may take a few seconds to load.)
Click on the use cases to view the graphical explanation.
Understanding Atrium Integrator

The following topics discuss different aspects of Atrium Integrator:
Atrium Integrator value proposition
Atrium Integrator Spoon support
Calbro Services user story for Atrium Integrator
Datasets used by Atrium Integrator
Atrium Integrator terminology
Atrium Integrator components
Overview of the data transfer process
Atrium Integrator performance considerations
Atrium Integrator permissions
Atrium Integrator in a server group environment
Atrium Integrator is an integration engine that enables you to transfer data from external data stores
to BMC Atrium Configuration Management Database (BMC Atrium CMDB) classes. You can
connect to a wide variety of input sources using connectors such as JDBC, ODBC, JMS, native
databases, web services, and complex XML. Atrium Integrator provides you with the ability to clean
and transform your data before putting it into BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 688 of 2268
Home
Atrium Integrator replaces BMC Atrium Integration Engine. You can continue using BMC Atrium
Integration Engine for existing data mappings and exchanges, but BMC recommends that you use
Atrium Integrator for all new data transfers.
Note
BMC Atrium Integration Engine is being replaced with a new offering called Atrium
Integrator. The BMC Atrium Core version 8.1 is the last release that includes BMC Atrium
Integration Engine. No new versions (major or minor) of BMC Atrium Integration Engine
will be released after 8.1. For more information, see Product announcements for BMC
Atrium Core
The following figure illustrates how Atrium Integrator integrates with the BMC Atrium Core
components to form a solution.
BMC Atrium Core architecture
Atrium Integrator transfers data from an external data store to BMC Atrium CMDB. When the data
is in a BMC Atrium CMDB dataset, the Normalization Engine ensures that data from different data
providers is consistent. The Reconciliation Engine merges data from multiple import datasets into
the BMC Asset dataset. For more information about datasets, see Datasets used by Atrium
Integrator.
Atrium Integrator value proposition

Your IT management data resides in multiple repositories-for example, in an SQL table, an XML file
, and a discovery dataset. You want to load this data into BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 689 of 2268
Home
Atrium Integrator uses Pentaho, which is an ETL tool wherein, it enables you to extract, transform,
and load data.
You can use Atrium Integrator to load data from multiple external data stores into BMC Atrium
CMDB. You can define how external data maps to BMC Atrium CMDB and transform external data
using various rules.
With Atrium Integrator, you can schedule and perform bulk data transfers. You can also use Atrium
Integrator for initial data loading, incremental data transfers, and data synchronization. For example
, you can use Atrium Integrator to synchronize IT data from a discovery application with BMC
Atrium CMDB, where it can be reconciled with data from other sources to your production dataset.
During data transfers, Atrium Integrator identifies the records to be transferred and performs some
or all of the following tasks, depending on how you have configured your integration:
Extract records
Creates new records
Updates records
Deletes records
Transforms data (such as concatenating fields)
Atrium Integrator Spoon support

BMC provides limited support for Atrium Integrator Spoon and you must consider the following:
Install and use only the Pentaho and Atrium Integrator Spoon version that is packaged with
the BMC Remedy AR System installer. For more information see, Installing BMC Remedy
AR System (new installations).
Though Pentaho Spoon is supported on other platforms, BMC supports Atrium Integrator
Spoon only on the Windows platform. For more information see, Checking the compatibility
matrix for system requirements and supported configurations for new installations .
BMC supports selected steps from those provided in the Spoon. See, Adding intermediate
steps to a Atrium Integrator transformation for the list of supported steps. This list will be
revisited periodically and support for new steps might be added or removed during each
revision. Any queries around complex customization using unsupported steps will be
addressed selectively and at discretion of BMC. For information about steps other than
supported by BMC, see the Pentaho documentation.
BMC supports selected vendor databases which include IBM DB2, MS SQL Server, Oracle
, Sybase, and My SQL. So for example, when you are using the Table Input or Table output
step you can point only to the BMC supported vendor databases.
Calbro Services user story for Atrium Integrator

A fictional company named Calbro Services is used to explain how Atrium Integrator principles and
procedures are used in practice. Although Calbro Services is a fictional company, it is based on
research of actual BMC customers. Seeing how Calbro Services completes tasks should prove
BMC Atrium Core 9.0
Page 690 of 2268
Home
useful as you implement Atrium Integrator in your own environment.

Calbro Services needs to transfer its existing data about processors, disk drives, printers, and so
on to their centralized database in New York. This data resides in multiple databases, flat files, and
XML files in various locations across the globe. Calbro Services wants to transfer information from
its Chicago, London, Dublin, and Adelaide sites to their New York centralized database. Calbro
Services also wants to transfer the personnel records of employees from the Dublin site to the New
York site.
Related topic
Datasets used by Atrium Integrator

A dataset is a logical group of data in BMC Atrium CMDB. It is a collection of Configuration Item (
CIs) and relationships for a given purpose. A dataset can represent data from a particular source or
a snapshot from a particular date. The primary purpose of datasets is to partition data according to
the data providers. Each discovery application that you use should store the data it collects in a
separate dataset. You can also use datasets for any other logical group of data.
All CIs and relationships in BMC Atrium CMDB reside in a particular dataset, which is specified by
the value of their DatasetID attribute.
BMC discovery products and BMC Asset Management provide the default datasets in BMC Atrium
CMDB, as shown in the following table.
Default datasets in BMC Atrium CMDB
Data created by
Dataset name
DatasetID
BMC Atrium CMDB
BMC Asset
BMC.ASSET
BMC Atrium CMDB
BMC Sample
BMC.SAMPLE
BMC Asset Management
BMC.ASSET.SANDBOX
BMC.ASSET. SANDBOX
BMC BladeLogic Client Automation
BMC Configuration Import (User-defined)
BMC.IMPORT. CONFIG
BMC Server Automation
(User-defined)
BMC.IMPORT. BL
(User-defined)
BMC.ADDM
The BMC Asset dataset is used as the production dataset and is used by BMC products for
reconciled data. The Reconciliation Engine merges data from multiple import datasets in the BMC
Asset dataset. Data consumers should use this consolidated view of your data and you should
base your business decisions on the data in this dataset.
Note
BMC Atrium Core 9.0
Page 691 of 2268
Home
It is recommended to not use Atrium Integrator to transfer data directly into the BMC Asset
dataset. Instead, transfer the data into staging dataset and then reconcile it into BMC
Asset dataset.
If you use a third-party product to discover products, you should create a different dataset to bring
in this data. For information about creating datasets, see Creating datasets in the Reconciliation
console.
For more information about configuring datasets, see Configuring normalization settings for
datasets.
Note
/ (forward slash) is not accepted in dataset id name as the directory name is set as the
dataset id name. If you use /, what follows after the / is treated as a new directory and the
data set tries to identify the directory ID for that and returns null because no such directory
exists. However, you can use other special characters in data set ID name.
Atrium Integrator terminology

The complete process of transferring data from an external source (for example, an XML file) to a
BMC Atrium CMDB CI class is referred to as an integration.
The following terms are used in Atrium Integrator to describe the various aspects of an integration:
A transformation is the combination of steps and hops that make an integration between
source and target data stores possible. It reads data from the source data store, transforms
it according to the rules that you specify, and stores it in the target data store.
A transformation consists of a series of steps. Steps define the input and output data stores
as well the clean up or adjustment actions that you might want to perform on the data before
adding it to BMC Atrium CMDB.
Steps are connected by hops, which indicate the direction of the data flow.
A job defines the order in which a series of transformations are run so that the dependencies
of the individual transformations are met.
A repository is a relational database in which you can store your transformations and jobs.
You can also use a repository to store the logs that are generated when executing
transformations and jobs.

This topic describes Atrium Integrator components.
Atrium Integrator Spoon
BMC Atrium Core 9.0
Page 692 of 2268
Home
Atrium Integrator Plugins for BMC Remedy AR System

Atrium Integrator Carte server
Atrium Integrator console
Atrium Integrator client
Atrium Integrator architecture overview
Note
The BMC Remedy AR System database, which stored the jobs and transformations, had
to be installed separately in Atrium Integrator 7.6.04. However, with Atrium Integrator
8.0.00 and later, the jobs and transformations are stored in the forms in the BMC Remedy
AR System database you don't need to install a separate BMC Remedy AR System
database.
The following figure shows how the Atrium Integrator components work together.
BMC Atrium Core 9.0
Page 693 of 2268
Home

Atrium Integrator Spoon Overview
After you build your job, you can edit it in the Atrium Integrator Spoon.
Atrium Integrator Spoon has a drag-and-drop graphical user interface that makes it easy for you to
edit your transformations and clean up your data before putting it into BMC Atrium CMDB.
On a remote Windows computer, Atrium Integrator Spoon directly connects to the BMC Remedy
AR System database to save and retrieve transformations and jobs.
BMC Atrium Core 9.0
Page 694 of 2268
Home
Atrium Integrator Spoon is installed as part of the BMC Remedy Action Request System. For
information about installing Atrium Integrator Spoon, see Performing a new installation.
For information about launching Atrium Integrator Spoon, see Launching Atrium Integrator Spoon
from Atrium Integrator.
Note
In BMC Remedy AR System, the Pentaho Spoon application is referred to as Atrium
Integrator Spoon.
Important
BMC provides limited support for Pentaho and Atrium Integrator Spoon. See, Atrium
Integrator Spoon support.
Atrium Integrator Spoon interface

The following figure illustrates the parts of Atrium Integrator Spoon interface.
Atrium Integrator Spoon application
BMC Atrium Core 9.0
Page 695 of 2268
Home
Menu bar
The menu bar provides access to common actions such as creating a new transformation or job,
editing it, connecting to a repository, and running or debugging the job or transformation.
Navigation panel
The navigation panel on the left contains a View tab and Design tab.
The View tab maintains a history of the different types of steps that were added to the active
transformation or job. For a new transformation or job, this tab displays the steps that a
transformation must include to run successfully.
The Design tab provides an organized list of transformation steps or job entries used to
build transformations and jobs.
You can perform a search in either tab by typing a phrase in the search field and pressing the
Enter key. The steps containing the search phrase are displayed.
Click the
icon to expand all steps and the
icon to collapse the steps.
Toolbar
The toolbar provides buttons for common actions such as creating a new file, opening a saved file,
and saving a file. It also provides buttons for quick access to common actions specific to the active
transformation or job, such as Run, Preview, and Debug.
Canvas
BMC Atrium Core 9.0
Page 696 of 2268
Home
The canvas is the main design area for building transformations and jobs.
Active transformation or job

The canvas displays a number of tabbed views that represent the open transformations and jobs. In
the following figure, the DiskDrive transformation is the active transformation.
Atrium Integrator Plugins for BMC Remedy AR System
To import and export data to and from BMC Remedy AR System across the BMC Remedy IT
Service Management suite (BMC Remedy ITSM), you can use BMC Atrium Integrator plugins(AR
Input and AR Output) for AR System. For information about configuring and using BMC Atrium
Integrator Adapter for AR System, see Atrium Integrator adapter for BMC Remedy AR System

Atrium Integrator Carte server is also referred to as Atrium Integrator Engine. It is a simple web
server that you can use to execute transformations and jobs remotely. All the jobs scheduled and
run through Atrium Integrator console always run on the Carte server.
You can start a job from the Atrium Integrator console only if the Atrium Integrator Carte server is
running. When you install the BMC Remedy AR System server, Atrium Integrator Carte server is
automatically installed on the same computer, and runs in the background. If you restart the BMC
Remedy AR System server, the Carte server also restarts automatically.
The start and stop functions of the Atrium Integrator Carte server are monitored using the
armonitor.cfg file.
For information about installing Atrium Integrator Carte server, see Performing a new installation.
To access Atrium Integrator Carte server
To access Atrium Integrator Carter server from Atrium Integrator console
To connect to the Atrium Integrator Carte server by using a browser
To change Atrium Integrator Carte server port
To access Atrium Integrator Carte server

You can access the Atrium Integrator Carte server using the following URL:
http://<ARserver_host*>:20000*
20000 is the default port. You can find the port number from the UDM:Config form.
You can login using AI Admin or AI User credentials. For more information, see Atrium Integrator
permissions.
BMC Atrium Core 9.0
Page 697 of 2268
Home
To access Atrium Integrator Carter server from Atrium Integrator console

When you run a job from Atrium Integrator console, you can view the job run status from Atrium
Integrator Carte server. While the job is running, the Job Run Status link is displayed in the Logging
details section under the History tab. Click the Job Run Status link to view the job run status in
Atrium Integrator Carte server. You can login to Atrium Integrator Carte server as a AI Admin or AI
User.
To connect to the Atrium Integrator Carte server by using a browser

1. In a browser window, type:
http://<HostName>:<PortNumber> HostName is the host name of the computer where the
Atrium Integrator server is installed, and PortNumber is the number displayed in the Port
field of the UDM:Config form.
2. Click Enter.
3. Log on to BMC Atrium Integrator Carte server with AI Admin or AI User permissions
also.See Atrium Integrator permissions.
4. (optional) To view the status of the jobs and transformations that have been run from the
Atrium Integrator console, click Show status in the Status window.
5. (optional) To display the log details for a job, click on that job.
To change Atrium Integrator Carte server port

You can identify a default Atrium Integrator Carte server port by referring to the UDM:config form,
which has the Atrium Integrator Carte server details.
1. Update the Atrium Integrator Carte server port in the armonitor.cfg file on the BMC Remedy
AR System server.
2. Update the Atrium Integrator Carte server port in the UDM:Config form on the BMC Remedy
AR System server.
3. Restart the BMC Remedy AR System server.
BMC Atrium Core 9.0
Page 698 of 2268
Home
If you have a server group environment, restart all the other BMC Remedy AR System servers in
the server group. If the BMC Remedy AR System server is connected to any server from mid-tier
then the Pentaho AR plugin picks up these changes.

Using the Atrium Integrator console, you can perform the following tasks:
Create new jobs using the Integration Job Builder wizard. See, Creating a job through the
Integration Job Builder wizard.
Start, stop, and delete jobs. See, Running a job from the Atrium Integrator console .
View the list jobs available in the repository.
Create data store connections using the Manage Data Stores tool. See, Creating a new data
store connection in Atrium Integrator.
Schedule jobs using the Job Scheduler tool. See, Managing Atrium Integrator job schedule.
Open jobs directly in Atrium Integrator Spoon.
Monitor jobs through the Integration Job Details tab that displays the date, source and
target types, and description of a job. Viewing Atrium Integrator job details.
View job run details in the History tab. Viewing Atrium Integrator job history.
Display jobs with a specific status or jobs that executed within a range of dates.
Related topic

To transfer data from an external data store to BMC Atrium CMDB, you must also install the Atrium
Integrator server, which can be installed with BMC Atrium Core and BMC Remedy AR System
server. The Atrium Integrator server installs the Atrium Integrator console, CMDB adapters (CMDB
Input, CMDB Output, and LookUp), and deploys sample jobs.
For information about installing the Atrium Integrator server, see Installing Atrium Integrator server
on a single computer.
Atrium Integrator client

You can use the BMC Remedy AR System installer to install only Atrium Integrator Spoon on a
remote Microsoft Windows computer and connect to the Repository on the BMC Remedy AR
System server. Atrium Integrator Spoon on a remote Windows computer directly connects to the
BMC Remedy AR System database to save and retrieve transformations and jobs. To use the
remote instance of Atrium Integrator Spoon to transfer data to BMC Atrium CMDB, you must install
the Atrium Integrator client, on the same computer.
For information about installing the Atrium Integrator client, see Installing Atrium Integrator client on
a single computer.
BMC Atrium Core 9.0
Page 699 of 2268
Home
Overview of the data transfer process

To transfer data into BMC Atrium CMDB, follow the process outlined in the following steps.
Loading Data into BMC Atrium CMDB from database
Each step represents a procedure. In the section that relates to each procedure, the graphic is
repeated, and the related step is highlighted.
1. Configure source and target connection.
You must define connection parameters (such as host name, port number, user name, and
password) to your external data store and BMC Atrium CMDB. After you create a connection
, you can reuse it for multiple transformations or jobs. For instructions, see Working with
Atrium Integrator data store connections.
2. Create a job or transformation.
The Integration Job Builder wizard guides you through the process of creating a job or
transformation. After you specify the source and the CIs that you want to import, the wizard
makes recommendations on the relationships for the selected CIs. For instructions, see
Creating a job in Atrium Integrator.
You can also create a job in the BMC Atrium Integrator Spoon application. For instructions,
see the Spoon User Guide at http://wiki.pentaho.com/display/EAI/Spoon+User+Guide .
3. Edit your transformation or job in BMC Atrium Integrator Spoon.
You can add intermediate steps for cleaning up or manipulating your data before adding it to
BMC Atrium CMDB. BMC Atrium Integrator Spoon provides support for JavaScript and a
variety of prebuilt functions. For instructions, see Editing Atrium Integrator jobs and
transformations.
4. Verify and run your job. If the job completes without any errors, verify that the data has been
added to the appropriate BMC Atrium CMDB class. If the job displays error messages,
debug the job and run it again. For instructions, see Running an Atrium Integrator job.
5. Monitor your jobs.
After you create and run your job, you can monitor it. The Atrium Integrator console displays
the job run information. For information, see Monitoring jobs in Atrium Integrator.
Scenario for transferring data to BMC Atrium CMDB takes you through the complete data transfer
process for a sample scenario.
Preparing to transfer data

To prepare data to transfer into BMC Atrium CMDB, follow the process outlined in the following
steps:
BMC Atrium Core 9.0
Page 700 of 2268
Home
1. Create a new source dataset to which you can migrate your source data. Datasets help in
categorizing data by providers. You can then reconcile your dataset with BMC.ASSET.
2. Create index entries on the BMC_BaseElement class in the Class Manager application to
improve the performance of Atrium Integrator.
For instructions, see Specifying class indexes from the Class Manager .
Atrium Integrator performance considerations

Performance considerations for Atrium Integrator depend on your network, BMC Remedy AR
System, the BMC Remedy AR System server database, and the external data store load.
Predicting the effect of a specific change on Atrium Integrator performance is difficult, but
configuration considerations can influence performance.
Although it is easy to add field mappings or extra transformations for each field, remember that
each item you add is compared against every record in your database. Seemingly minor additions
could have a major impact if your database contains many records. For example, if you have 1200
records in your database and a change adds an additional half-second to the run time for each
record, the data transfer might take an additional 10 minutes to run.
Note
You can use server clustering to improve performance of your data transfer jobs. For
more information, see Improving performance of Atrium Integrator by load balancing .

Improving performance of Atrium Integrator
Improving performance of Atrium Integrator by load balancing
Improving performance of Atrium Integrator

Following are some recommendations that can improve the performance of Atrium Integrator:
Create index entries on:
The BMC_BaseElement class for keys that are used as primary keys in the CMDB
Output plugin and DatasetId in Atrium Integrator Spoon.
External data stores for transformations with the External Data to CMDB data
direction and for relationship transformations.
Provide minimum and maximum values for the Fast Thread and List Thread options in the
BMC Remedy AR System Administration Console. For more information about the Fast
Thread and List Thread options and how to specify the number of threads, see Defining
queues and configuring threads.
BMC Atrium Core 9.0
Page 701 of 2268
Home
Launch multiple copies of a step. For optimum performance, you can launch 20 copies of a
step. You can also use the following formula:
Number of copies=Number of CPUs x 3 threads
For more information, see Launching several copies of a step in BMC Atrium Integrator
Spoon.
For all data transfer jobs created by using the Integration Job Builder wizard, the
CMDBOutput step is set to launch three times. Depending on the configuration of your
computer, you can increase the number of copies of the CMDBOutput step to increase the
overall throughput of the data transfer job. BMC recommends that you set th
To run bulk job (more than one million) from Atrium Integrator console, the JVM size of the
Carte server must be minimum 2GB. To increase the JVM size of Carte server, update the
required JVM size in armonitor.conf file.
For bulk transfer, you must use 64 bit JVM. 32 bit JVM does not support data transfer of
more than 2 GB.
Set the Is Cache Required option to Yes to improve performance in update cycle.
Improving performance of Atrium Integrator by load balancing

You can use server clustering to improve performance of your data transfer jobs. Clustering allows
transformations and transformation steps to be executed in parallel on more than one server. The
clustering schema defines which slave servers you want to assign to the cluster and offers a variety
of clustered execution options. You can designate one server as the master server. The master
server manages the rest of the servers in the schema, which are slave servers.
The following topics are provided
To configure master and slave servers
To create a cluster schema
To enable a transformation step to use clustering
To configure master and slave servers

1. In Atrium Integrator Spoon, open the transformation that you want to run in a clustered mode
, or create a new job.
2. In the left navigation panel, select the View tab.
3. On the View tab, double-click Transformations > Slave server.
4. In the Slave Server dialog box, enter the following information.
Field
name
Value
Service
tab
Server
name
Name of the server
Hostname
Host name of the server
BMC Atrium Core 9.0
Page 702 of 2268
Home
Field
name
Value
Port
Port number you want to use for communicating with the remote server
Username
User name for the remote BMC Remedy AR System server
Password
Password of the remote BMC Remedy AR System server
Is the
master
Select this only for the master server
Proxy tab
Proxy
server
hostname
Host name of the proxy server through which you want to connect
Proxy
Port number you want to use for communicating with the proxy server
server
port
Ignore
proxy for
hosts
Servers for which the proxy should not be active This option supports specifying multiple servers using
regular expressions. You can also add multiple servers and expressions separated by the vertical bar (|)
character.
5. Click OK.
The server is listed under the slave server category in the left navigation pane.
To create a cluster schema

1. In Atrium Integrator Spoon, open the transformation that you want to run in a clustered mode
, or create a new job.
2. In the left navigation panel, select the View tab.
3. In the left navigation panel, double-click Transformations > Kettle cluster schemas.
Field name
Value
Schema name
Name for the schema
Port
Port from which to start numbering ports for the slave servers. Each additional clustered step that is
executed on a slave server consumes an additional port.
To avoid networking problems, ensure that no other networking protocols are in the same range.
Sockets buffer
size
Internal buffer size
Sockets flush
interval
Number of rows after which the internal buffer is sent completely over the network and emptied
Sockets data
compressed?
When selected, all data is compressed using the Gzip compression algorithm to minimize network
traffic.
Dynamic cluster
When selected, the master server checks the availability of the slave servers at run time.
Slave servers
Click Select slave servers to add the master and slave servers that you want to be used in the
schema.
4. Click OK.
BMC Atrium Core 9.0
Page 703 of 2268
Home
To enable a transformation step to use clustering

1. Right-click a step in Atrium Integrator Spoon.
2. Select Clusterings.
3. In the Cluster schema dialog box, select the cluster schema that you want to use.
4. Click OK.
5. Click Run
6. In Execute a Transformation, select Execute clustered.

7. Select the following options as needed.
Option
Description
Post transformation
Splits the transformation and posts it to the master and slave servers.
Prepare execution
Runs the initialization phase of the transformation on the master and slave servers.
Start execution
Starts the execution of the master and slave transformations.
Show transformations
Shows the generated (converted) transformations that will be executed on the cluster.

To use the Atrium Integrator console, you must be assigned to one of the assigned BMC Remedy
AR System permission roles:
AI Admin Group To give administrator rights, assign the AI Admin group to the user.
AI User Group To give AI user rights, assign the AI user group to the user.
For more information about BMC Remedy AR System users and groups, see Creating users,
groups, and roles.
Depending on the role assigned to a user the icons in Atrium Integrator console are enabled.
Note
To use the Atrium Integrator Spoon, you must be assigned AR Admin (Base administrator
) role.
The following table lists the permissions for AI Admin and AI User role.
Atrium Integrator roles and permissions
Role
Groups assigned to
Permissions
AI Admin
AI Admin
AI UDM Admin
AI Arssystem
Scheduler
BMC Atrium Core 9.0
Create jobs
Run jobs
Delete jobs
Schedule jobs
Page 704 of 2268
Home
Role
Groups assigned to
Permissions
Launch jobs in BMC Atrium Integrator Spoon.
However, you will need to login as AR Admin user to view the job.
Monitor jobs
Create data store connection
Edit UDM forms
Access BMC Remedy AR System Scheduler
Access BMC Atrium Integrator Carte server
Access to Atrium Integrator Spoon
Edit Atrium Integrator Spoon jobs
AI User
AI User
AI UDM User
AI Arssystem
Scheduler
AR User
Schedule jobs
Run jobs
Monitor jobs
View datastore connections
View UDM forms
Access BMC Remedy AR system Scheduler
Access BMC Atrium Integrator Carte server
All groups
(Base administrator)
All AI Admin permissions

Launch and edit jobs in BMC Atrium Integrator Spoon
Atrium Integrator in a server group environment

The Atrium Integrator server can be used in a server group environment to distribute the jobs
across multiple Atrium Integrator Carte servers. In a BMC Remedy AR System server group
environment, you can schedule your jobs to run from different Atrium Integrator Carte servers. This
enables you to run multiple jobs at one time and also achieve load balancing.
The following figure illustrates the concept of BMC Remedy AR System server group and multiple
Atrium Integrator Carte server support.
BMC Atrium Core 9.0
Page 705 of 2268
Home
configured in a particular server group and which Atrium Integrator Carte server is associated with
each AR server. In Atrium Integrator server group environment, the Carte server on which a job will
get executed through Atrium Integrator console depends on the entry available in the UDM:Config
form. The AR system server installer creates an entry in UDM:Config form about the Carte server
host and port details.The host entry in UDM:Config form must follow the DNS standard.
The UDM:PermissionInfo form contains information about jobs and the associated Atrium Integrator
Carte servers they run on.
When you set up Atrium Integrator in server group environment, consider the following points:
You must also ensure that you have installed the Atrium Integrator Carte server and Atrium
Integrator Spoon components in a server group environment. When you install the Atrium
Integrator server on each server within the server group environment, the CMDB plug-ins are
deployed on the servers. For more information, see Installing Atrium Integrator server in a
server group
When you create a job by using the Integration Job Builder wizard in a server group
environment, you have to select the appropriate Atrium Integrator Carte server on the
Schedule page. If you run a job in the Atrium Integrator console, the job runs on the Atrium
Integrator Carte of BMC Remedy AR System server that you access through the mid-tier
server. You can change the Atrium Integrator Carte server by scheduling the job to a run on
a different Atrium Integrator Carte server. For more information, see Managing a Atrium
Integrator job schedule.
Important
BMC Atrium Core 9.0
Page 706 of 2268
Home
BMC recommends that you do not run the same job on multiple Atrium Integrator Carte
servers within the server group environment.
In Atrium Integrator server group environment, the cache is created on the the server from
where you execute a job. For example, if server A is the primary server and server B is the
secondary server, and if you execute the job from server B, the cache is created on server B
.
If you schedule a job on a server with the cache enabled and then schedule the same job on
another server within the server group, you must manually copy the cache to the second
server to avoid a negative impact on the performance.
When you create or run CSV or XML jobs in a server group, make sure, the files are
physically present at the same location on all the BMC Remedy AR System servers in the
server group.
If you have a load balancer configured and if you want to run the job on the load balancer
content server (midtier), you must update the load balancer content server (midtier) entry in
the UDM:RApPassword form.
Limitations of Atrium Integrator

The following table describes the limitations with Atrium Integrator (AI).
Limitations of AI
Limitation
Impact\Workaround
To modify AI jobs, you have to launch

Pentaho\spoon client
Use the link provided on AI console to launch the spoon client. For steps to launch spoon
client from AI console, see Launching Atrium Integrator Spoon from Atrium Integrator
Cannot create transformations and

jobs for AR System forms from AI
console
Use Pentaho or spoon client to create transformations and jobs for AR System forms

Calbro Services needs to transfer its existing data about processors, disk drives, printers, and so
on to their centralized database in New York. This data resides in multiple databases, flat files, and
XML files in various locations across the globe. Calbro Services wants to transfer information from
its Chicago, London, Dublin, and Adelaide sites to their New York centralized database. Calbro
Services also wants to transfer the personnel records of employees from the Dublin site to the New
York site.
This section describes a sample BMC Atrium CMDB scenario in which the Calbro Services
administrator, Allen Allbrook, prepares his CMDB for Atrium Integrator, creates and runs an Atrium
Integrator job, verifies its success, and schedules it to run repeatedly.
Source data organization at Calbro Services
Creating a database connection for Calbro data transfer
BMC Atrium Core 9.0
Page 707 of 2268
Home
Creating a Calbro data transfer job

Editing the Transfer Calbro data job in Atrium Integrator Spoon
Running the Transfer Calbro data job
Monitoring the Transfer Calbro data job
Verifying that Calbro's data is transfered in BMC Atrium CMDB
Source data organization at Calbro Services

Calbro Services maintains its discovery data in CSV files that store information about all the
hardware components in its environment. There are separate CSV files for computers, processors,
disk drives, memory, and so on.
Mapping Calbro source data to BMC Atrium CMDB

The organization of the discovery data for computers and disk drives is shown in the following
figure.
Organization of the computer and disk drive data
BMC Atrium Core 9.0
Page 708 of 2268
Home
The records in the Computer CSV correspond to instances of the BMC_ComputerSystem class in
BMC Atrium CMDB. The records in the Disk Drive CSV correspond to instances of the
BMC_DiskDrive class in BMC Atrium CMDB.
Mapping Calbro relationship classes

Much of the value of BMC Atrium CMDB comes from the ability to store information about the
relationships between configuration items (CIs), not just information about the CIs themselves.
BMC Atrium Core 9.0
Page 709 of 2268
Home
Each record in the Disk Drive CSV contains the name of its corresponding computer in the
AssociatedComputer column. This relationship associates a specific instance of a disk drive in the
external database with a specific instance of a computer. For example, in the following figure, disk
1520 in the Disk Drive CSV is associated with computer vm2-w4-dev01 in the Computer CSV.
Because each disk drive is associated with a computer, you can select a relationship that
associates a particular instance of BMC_DiskDrive with a particular instance of
BMC_ComputerSystem. In this case, the AssociatedComputer attribute in the BMC_DiskDrive
class and the HostName attribute in the BMC_ComputerSystem class contain the data necessary
to create the relationship.
Each relationship class in BMC Atrium CMDB defines one CI class as the source member of the
relationship and another CI class as the destinationmember of the relationship. In this case,
BMC_ComputerSystem is the source (primary) member and BMC_DiskDrive is the destination (
secondary) member of the BMC_HostedSystemComponents relationship class. For more
information about relationship classes, see Relationship classes in the Common Data Model .
Note
The transformations that bring data from the external data store into the CI classes (in this
case, BMC_DiskDrive and BMC_ComputerSystem ) must finish before the
transformation for the relationship class can run, because that transformation needs the
instance IDs of the related CIs for their relationship instance. The wizard schedules the
transformations in this order automatically.
The relationship between computer systems and disk drives at Calbro Services is stored within the
source CSVs, as shown in the following figure. The following figure shows how data from the
external database is transferred into BMC Atrium CMDB to create CIs, and then how a relationship
class instance is created based on attributes in the CI classes.
Creating relationships based on attributes in both CI classes
BMC Atrium Core 9.0
Page 710 of 2268
Home
For each BMC_DiskDrive instance, a match between its AssociatedComputer value and the
Name value in a BMC_ComputerSystem instance causes the creation of a

BMC_HostedSystemComponents relationship between the two CIs.
The instance IDs of these member CIs are stored in the relationship instance as
Source.InstanceId for the BMC_ComputerSystem instance and Destination.InstanceId
for the BMC_DiskDrive instance.
Creating a database connection for Calbro data transfer

Allen creates a database connection in Atrium Integrator to communicate with the external CSV
data store, which is the source of the discovery data. Allen then creates a connection to
communicate with the BMC Atrium CMDB server, which is the destination for the data.
To create a source database connection

1. Use the direct access URL to open the BMC Remedy Mid Tier and log on with your user
name and password.
2. On the AR System Home page, select BMC Atrium Integrator > Atrium Integrator .
3. In the Atrium Integrator console, click Manage Data Store Connections
4. Click New Data Store
5.
BMC Atrium Core 9.0
Page 711 of 2268
Home
5. In the New Data Store section on the right side of the Manage Data Stores window, select
the Data Store Type as CSV.
6. Type Calbro Source CSV in the Data Store Name field.
7. Specify the remaining information for the source CSV data store.
8. To verify the source database connection parameters, click Test Connection.
9. Click Save.
To create a target database connection

2. In the New Data Store section on the right side of the Manage Data Stores window, select
AR System as the Data Store Type.
3. Type Calbro Connection to CMDB in the Data Store Name field.
4. In the AR Server Name field, type the name of your BMC Remedy AR System server.
5. (optional ) Type the port number.
6. Specify the remaining information for the target database.
7. To ensure that you can connect to BMC Atrium CMDB, click Test Connection.
8. Click Save.
Creating a Calbro data transfer job

Specifying Calbro source and target data store details
Selecting CI types to transfer for Calbro
Selecting relationships to transfer for the CI type for Calbro
Mapping target attributes to source columns for Calbro
Defining relationship mapping for the CI types to transfer for Calbro
Creating a schedule for Transfer Calbro data job
Viewing summary for Transfer Calbro data job
Specifying Calbro source and target data store details

Allen specifies the job name and description, external data store, and the CMDB class and
DatasetID to which the data needs to be transfered.
To specify source and target data store details

1. In the Atrium Integrator console, click Create Job.
2. Click anywhere in the Overview page.
The General page appears.
3. In the Job Name field, enter Transfer Calbro data.
4. In the Description field, enter Transfer computer system and disk drive information to
CMDB.
5. In the Type field of the Specify Data Store Details for Source area, select Database and
in the Name field, select Calbro Source Tables.
6.
BMC Atrium Core 9.0
Page 712 of 2268
Home
6. In the Name field of the Specify Data Store Details for Target area, select Calbro
Connection to CMDB, and in the Dataset ID field, select CALBRO.IMPORT.
As BMC recommends, Allen does not use Atrium Integrator to transfer data directly into the
BMC Asset dataset. Instead, he transfers the data into the CALBRO.IMPORT dataset and
then reconciles it into BMC Asset.
7. Click Next.
The CI Type Selection page appears.
Selecting CI types to transfer for Calbro

Allen specifies the job name and description, external data store, and the CMDB class and
DatasetID to which the data needs to be transferred.
To specify source and target data store details
1. In the Atrium Integrator console, click Create Job
2. Click anywhere in the Overview page.

3. In the Job Name field, enter Transfer Calbro data.
4. In the Description field, enter Transfer computer system and disk drive information to
CMDB.
5. In the Type field of the Specify Data Store Details for Source area, select CSV and in the
Name field, select Calbro Source CSV.
6. In the Name field of the Specify Data Store Details for Target area, select Calbro
Connection to CMDB, and in the Dataset ID field, select CALBRO.IMPORT.
As BMC recommends, Allen does not use Atrium Integrator to transfer data directly into the
BMC Asset dataset. Instead, he transfers the data into the CALBRO.IMPORT dataset and
then reconciles it into BMC Asset.
7. Click Next.

Allen selects the SYSTEMDEVICE relationships to be transfered.
To select relationships to transfer for the CI type

1. From the Available CI Types of Relationships table, select SYSTEMDEVICE and click Add.
This relationship identifies Computer system as the parent CI and Disk drive as the
child CI.
The step toolbar is updated to reflect the selections that Allen made, as shown in the
following figure.
2. Click Next.
The Computer system Mapping page appears.
BMC Atrium Core 9.0
Page 713 of 2268
Home
Related information
Selecting relationships to transfer for the CI types.
Mapping target attributes to source columns for Calbro

The Computer system Mapping page displays the target CI class as BMC_ComputerSytem. Here,
Allen maps attributes from the BMC_ComputerSystem class to columns from the source table to
specify the fields and attributes to be transferred.
To map target attributes to source columns

1. On the Select Source field, select CSV.
2. In the File field, select COMPUTERSYSTEM.csv.
3. Select a target attribute and corresponding source column as displayed in the following table
, and click Map.
Repeat this step for each row in the table. The names in the Source column are the
Computer table database columns in Organization of the computer and disk drive database
tables.
Target attribute
Source Column
Name
HostName
SerialNumber
SerialNumber
ManufacturerName
Manufacturer
Each row is added to the Mapped Columns area.

For the HostName row, select the Source Key check box (which indicates that the
HostName column uniquely identifies each row of data in the source table).
4. Click the Transformation Options tab.
5. For Delta, leave the default selection of Yes and select the LastModified column.
The default value of Delta is Yes only when your source table has a date/time column.
6. For Delete, leave the default selection of Yes.
7. Click Next.
The Disk drive Mapping page appears, which displays the target CI class as
BMC_DiskDrive.
8. On the Select Source field, select CSV.
9. In the File field, select DISCDRIVE.csv.
10. Select a target attribute and corresponding source column as displayed in the following table
, and click Map.
Repeat this step for each row in the table. The names in the Source column are the
Computer table database columns in Organization of the computer and disk drive database
tables.
Target attribute
Source Column
Name
Name
SerialNumber
SerialNumber
BMC Atrium Core 9.0
Page 714 of 2268
Home
Target attribute
Source Column
ParentCITag
Associated Computer
11. For the SerialNumber row, select the Source Key check box (which indicates that the
SerialNumber column uniquely identifies each row of data in the source table).
13. For Delta, leave the default selection of Yes. Select the source column to be used for delta.
14. For Response, leave the default selection of No.
15. For Delete, leave the default selection of Yes.
16. Click Next.
The Relationships Mappings page appears.
Defining relationship mapping for the CI types to transfer for Calbro

The Relationships Mappings page lists the Parent CI as Computer system and child CI as Disk
drive. On this page, Allen specifies how the two source tables are related to each other.
To define relationship mapping for the CI types to transfer

1. Leave the default selection of Key Columns of Computer system in table "
CalbroComputerSystem" are mapped to columns of "Disk drive" in table "
CalbroDiskDrive". This indicates that relationship information is stored in the computer
system and disk drive source tables. For more information, see Mapping relationship classes
.
The Computer system Key Columns table displays the Source key that Allen had selected
while mapping target attributes to source columns (HostName).
2. From the Disk drive Columns area, select AssociatedComputer.
This indicates that for each BMC_DiskDrive instance, a match exists between its
AssociatedComputer value and the HostName value in a BMC_ComputerSystem.
3. In the Transformation Options tab, leave the default selection of Yes for Delta and select
the LastModified column.
4. Click Next.
The Schedule page appears.
Creating a schedule for Transfer Calbro data job

On the Schedule page, Allen specifies the time at which the job is to run, and the time interval
between jobs.
To schedule a job
1. In the Start Time field, enter 5:00:00 PM.
2. In the Interval area, type 1 in the Hours field.
3. Calbro Services wants to update the database with ATM transactions. Allen, therefore,
schedules a data exchange at an interval of an hour to populate the database with the
information of the ATM transactions.
4.
BMC Atrium Core 9.0
Page 715 of 2268
Home
4. Click Next.
The Summary page appears.
Viewing summary for Transfer Calbro data job

This topic shows how to view summary information for a Transfer Calbro data job.
To view job summary

1. In the Summary page, click Finish.
The Generated Transformations dialog box displays the list of transformations generated to
transfer the computer system and disk drive records to BMC Atrium CMDB.
The following naming convention is used:
Name of job_CI being transferred (for example, Transfer Calbro data_Computer system)
2. Click OK.
The job is listed in the job catalog on the left side of the Atrium Integrator console, and runs
as scheduled. If you want to do a test run, select the job from the job catalog and click Start
Job
Editing the Transfer Calbro data job in Atrium Integrator Spoon

Allen Allbrook wants to make the following edits to the job that he created:
Edits to the Transfer Calbro data job
Change
Method
The abbreviation that Calbro Services uses for the name of the marketing department
has changed from Mktg to MKTG.
See, Changing Department column

values to uppercase
Calbro Services wants to transfer data from the dbo.ComputerSystem.Department

field only if the value is not NULL. Otherwise, they want to keep the value in the target
See, Adding a step to transfer data from

the Department field only if the value is
database.
not Null
Map an additional source field to a target attribute.
See, Mapping additional fields to target

attributes
Opening the Transfer Calbro data job and transformations in Atrium Integrator Spoon
After creating a simple data transfer job through the Integration Job Builder wizard, Allen Allbrook
opens the job in Atrium Integrator Spoon to edit it.
To open the job in Atrium Integrator Spoon

1. On the computer where the Atrium Integrator Spoon client is installed, select Start > All
Programs > BMC Software > AR System > BMC Atrium Integrator Spoon .
The AR Server connection dialog box appears.
AR Server Connection
BMC Atrium Core 9.0
Page 716 of 2268
Home
2. Log on as follows:
a. From the AR Server list, select the BMC Remedy AR System server on which you
have installed the BMC Remedy AR System database.
b. In the User Name field, enter the user name for the BMC Remedy AR System server.
For information about the user name that you must specify, see Atrium Integrator
permissions.
c. In the Password field, enter the credentials for the BMC Remedy AR System server.
d. Click OK.
3. In the Atrium Integrator Spoon window, select Tools > Repository > Explore.
4. In the Repository explorer dialog box, expand the Jobs directory, and then expand the
directory
All the jobs in the PDIREPO_ servername repository are displayed.
5. Now expand the Transfer Calbro data directory.
Jobs and transformations for Calbro Services
BMC Atrium Core 9.0
Page 717 of 2268
Home
6. Double-click the Transfer Calbro data job.

The job opens.
Transfer Calbro data job
7. Double-click the Set variables step.

The Set Variables dialog box shows the delta and response settings that Allen specified
when creating his job through the Integration Job Builder.
Set variables step in the Transfer Calbro data job
BMC Atrium Core 9.0
Page 718 of 2268
Home
8. Click OK and then double-click the*Sub_Transfer Calbro data* step_._

The Executing a job dialog box shows the delta and response arguments. The argument
number is specified within the respective transformations.
Executing a job dialog box
BMC Atrium Core 9.0
Page 719 of 2268
Home
9. Click OK.
10. Right-click the Sub_Transfer Calbro data step and select Open job.
The transformations created for the Transfer Calbro data job are displayed.
11. Right-click Transfer Calbro data_Computer system and select Open transformation.
The computer system transformation is displayed. Allen Allbrook makes edits to this
transformation in Editing the Transfer Calbro data job in BMC Atrium Integrator Spoon .
Computer system transformation in Atrium Integrator Spoon
BMC Atrium Core 9.0
Page 720 of 2268
Home
The following table describes each step in the Transfer Calbro data_Computer
system_Deltatransformation.
Steps in the Transfer Calbro data_Computer system_Delta job transformation
Step name
What the step does

Gets the latest time stamp from the NGIEDELTA table. For a delta job, records are
transferred to BMC Atrium CMDB only if the Table Source Delta has a later time stamp
than the Table Source Time Stamp.
Specifies the argument number for the delta setting. This steps gets the appropriate
argument number from the Set variables step as shown in the following figure.
Specifies whether delta is set to yes, in which case the LastModified time stamp
determines whether to transfer the records on a subsequent run. If delta is set to no, all
records are transferred.
Deletes fields that are not required. This step is only for internal processing.
Specifies the source table.
BMC Atrium Core 9.0
Page 721 of 2268
Home
Step name
What the step does
Provides a placeholder step to add a new field by performing simple calculations.
Provides a placeholder step to map a field to a constant value.
Specifies the argument number for the response setting. This steps gets the appropriate
argument number from the Set variables step as shown in the following figure.
Specifies the BMC Atrium CMDB class, namespace, and Dataset ID to which the data is
to be transferred. This step also specifies the source key and input file-target attribute
mappings.
After the records are transferred to BMC Atrium CMDB, the NGIEDELTA table is
updated to reflect the time that the latest record was created in the source table.
Specifies the name of the transformation.
After the data is transferred to BMC Atrium CMDB, updates the NGIEDELTA table with
the time stamp of the latest-created record in the source table. On the next delta run,
only records that have a time stamp later than this will be transferred.
Specifies the name and path of the file to which errors are written to.
Defines the job flow. If you set Response as Yes, the job updates the specified source
field.
For those records that were transferred successfully to BMC Atrium CMDB, the
response values in the source table is set to 0.
BMC Atrium Core 9.0
Page 722 of 2268
Home
Step name
What the step does
For those records that were not transferred to BMC Atrium CMDB, the response values
in the source table is set to 1.
For those records that were not transferred to BMC Atrium CMDB, the response values
in the source table is set to 1.
Changing Department column values to uppercase

The abbreviation that Calbro Services uses for the name of the marketing department has changed
from Mktg to MKTG. Allen Allbrook uses a calculator step to convert the values in the Department
source column to uppercase before transferring them to BMC Atrium CMDB.
To change the Department column values to uppercase

1. In the Transfer Calbro data_Computer system_Delta transformation, double-click the
Calculator step.
Calculator step
2. In the New field column, enter Used By.

3. In the Calculation row, select UpperCase of a String A.
4. In Field A, select the Department column.
The upper case values from the Department column will be written to the Used By column.
5. Click OK.
BMC Atrium Core 9.0
Page 723 of 2268
Home
Adding a step to transfer data from the Department field only if the value is not Null
Calbro Services wants to transfer data from the dbo.ComputerSystem.Department field only if the
value is not NULL. Otherwise, they want to keep the value in the target database. Allen uses the
Filter rows step to set this up.
To add a step to transfer data from the Department field only if the value is not NULL
1. In the navigation panel, click Design.
2. From the Flow menu in the navigation panel, click the Filter rows step and drag it between
the IsResponse and CMDBOutput steps. Click Yes to split the hop.
Inserting the Filter rows step
3. From the Transform menu in the navigation panel, click the Dummy plugin step and place
it over the Filter rows 2 step.
4. Click the Filter rows 2 step, press the CTRL key, and then select the Dummy plugin step.
5. Right-click the Dummy plugin step and select New hop.
6. In the Hop dialog box, ensure that the value of the From step is Filter 2 row, the value of
the To step is Dummy plugin, and the Enable hop check box is selected.
This enables you to set a condition and data that does not comply with your condition is
transferred over to the*Dummy plugin* step.
7. Click OK.
In the dialog box that appears, select Distribute.
A hop connects the Filter rows 2 and Dummy plugin steps.
8. Double-click the Filter rows 2 step.
9. In the Filter rows dialog box, enter the appropriate values.
a. For Step name, enter Filter rows.
b. For Send true data to step, enter CMDBOutput.
c. For Send false data to step, enter Dummy plugin.
d. For the condition, specify Used B y as IS NOT NULL.
Filter rows dialog box
BMC Atrium Core 9.0
Page 724 of 2268
Home
10. Click OK.
Mapping additional fields to target attributes

Allen wants to map an additional source field to a target attribute. Allen edits the CMDBOutput step
to achieve this.
To map additional fields to target attributes

1. Double-click the CMDBOutput step.
CMDBOutput dialog box
BMC Atrium Core 9.0
Page 725 of 2268
Home
2. In the Update fields table > Class Attribute column, select Used By.
3. In the Stream field column, select Assigned To, and in the Update column, select Y.
Allen Allbrook selects these values to map the Used By column to the Assigned To
attribute.
4. Click OK.
Allen has completed his edits.
5. Select File > Save.
BMC Atrium Core 9.0
Page 726 of 2268
Home
Running the Transfer Calbro data job

After editing the job in Atrium Integrator Spoon, Allen Allbrook runs it to verify that it runs correctly.
1. In the Atrium Integrator Spoon window, click the Sub_Transfer Calbro data tab.
2. Select File > Save.
3. Click Run
4. In the Execute a job window, leave the default selection of Local execution.
Note
Allen runs this job locally because Calbro has BMC Atrium Core installed on the
same computer as the Atrium Integrator Spoon client. If the Atrium Integrator
Spoon client is installed on a different computer, Allen would execute the job
remotely.
5. Click Launch.
The job runs and displays the logging details (in the Logging tab) in the bottom half of the
window.
Job Run window
You can also see the job progress on the Atrium Integrator console.
BMC Atrium Core 9.0
Page 727 of 2268
Home
Monitoring the Transfer Calbro data job

Allen Allbrook can monitor the Calbro jobs (whether he ran them from the Atrium Integrator console
or BMC Atrium Integrator Spoon) in the Atrium Integrator console.
To monitor the data transfer job

1. From the job catalog of the Atrium Integrator console, select the Transfer Calbro data job.
The History tab displays the start and end times for each run of this job, as shown in the
following figure.
History tab of the Atrium Integrator console
2. Click the Integration Job Details tab to view additional details of the selected job.
Integration Job Details tab of the Atrium Integrator console
BMC Atrium Core 9.0
Page 728 of 2268
Home
Verifying that Calbro's data is transfered in BMC Atrium CMDB

After the Transfer Calbro data job completes running, Allen Allbrook verifies that the computer
system, disk drive, and relationship records have been transferred to BMC Atrium CMDB.
To verify that the records have been transferred to BMC Atrium CMDB
1. Return to the browser window and open the BMC Atrium Core Console.
2. Select Application Launcher > CMDB Applications > Explorer .
3. In BMC Atrium Explorer, click the Find tab.
The Edit Query Options dialog box appears.
5. In the Dataset list, select the Calbro.Import dataset and click OK.
6. In the Quick search of all CIs area, click Search.
The disk drives and computers from the external data store are displayed in the search
results.
7. To view the relationship between the disk drives and computers, perform the following steps:
a. Click the View tab.
b. Click the New View button and select CALBRO.IMPORT.
A new view of the CALBRO.IMPORT dataset appears.
c. Drag a CI (for example, Disk 1534) to the relationship panel.
d. Right-click the CI and select Expand Parents.
The relationship between Computer vm2-w5-dev06 (parent) and Disk 1534 (child) is
displayed.
Working with Atrium Integrator data store connections
This section describes how to connect to your data stores, which is the first step in the data transfer
process.
Data store configuration checklist
Atrium Integrator supported data types
Creating a new data store connection in Atrium Integrator
Editing a data store connection in Atrium Integrator
Deleting a data store connection in Atrium Integrator
RPC ports in BMC Atrium CMDB
Changing AR system port
BMC Atrium Core 9.0
Page 729 of 2268
Home
Data store configuration checklist

Use the following table to gather and record the required configuration information, which you need
to create a data store connection.
Type of information
Value
BMC Atrium CMDB

BMC Remedy AR System server name
Host name
Port
RPC Program Number
User ID
Password
CSV or Excel files
Path to directory where the file is saved
Database
Host name
Database type
Database name
Port
Instance name (only for Microsoft SQL Server)
User ID
Password
Atrium Integrator supported data types

The following table shows the supported external data store types and indicates whether you must
define specific connection parameters when using that type. The following table lists the data types
supported for each external database.
Supported data store types

Type
Requires specific connection parameters
BMC Atrium CMDB
Yes
Comma separated value (CSV) flat file
No
XML
No
Databases
Yes
IBM DB2
BMC Atrium Core 9.0
Page 730 of 2268
Home
Type
Requires specific connection parameters

Microsoft SQL Server
MySQL
Oracle
Sybase
BMC Atrium CMDB attribute data types and corresponding supported data types in external
data stores
BMC Atrium CMDB attribute data type
Oracle
SQL
DB2
Sybase
XML and CSV
MySQL
character
number
char
varchar
float
date
varchar
int
float
char
date/time
decimal
real
int
varchar
decimal
char
date
time
real
varchar
int
float
char
date/time
numeric
time
real
string
int
number
int
Varchar
float
char
date/time
integer
time
Real
date
decimal
timestamp
currency
number varchar
number
varchar
number
varchar
number
varchar
string
int
number
int
varchar
float
char
integer
real
decimal
date
date
date/time
real
date
time
date/time
time
date
date/time
time
date
timestamp
date/time
char
varchar
date/time
date
time
varchar
char
date
varchar
char
decimal
Not applicable
int
float
decimal
real
int
decimal
real
int
float
numeric
real
int
varchar
float
integer
time
real
date
decimal
diary
number
char
varchar
float
date
varchar
int
float
char
date/time
decimal
real
int
varchar
decimal
char
date
time
real
varchar
int
float
char
date/time
numeric
time
real
string
int
number
int
varchar
float
char
date/time
integer
time
real
BMC Atrium Core 9.0
Page 731 of 2268
Home
BMC Atrium CMDB attribute data type
Oracle
SQL
DB2
Sybase
XML and CSV
MySQL
date
decimal
timestamp
integer
number
float
int
float
int
decimal
int
float
decimal
real
real
numeric
real
number
int
int
float
integer
real
decimal
real
number
float
int
float
decimal
real
int
decimal
real
int
float
numeric
real
number
int
int
float
integer
real
decimal
selection
char
int
int
varchar
string
int
varchar
number
decimal
number
varchar
varchar
decimal
char
number
int
float
char
numeric
real
int
strings
varchar
char
integer
char
varchar
varchar
varchar
date
varchar
varchar
char
char
char
time
char
Note
If a BMC Atrium CMDB attribute of the currency data type is mapped to an integer field in
the external data store, the default allowable currency type (USD) in BMC Atrium CMDB is
populated along with the integer field. However, if a BMC Atrium CMDB attribute of the
currency data type is mapped to a varchar field in the external data store, Atrium
Integrator sets the currency type based on the value that you have specified in the varchar
field. For example, if the varchar field value is 2134 EUR, Atrium Integrator sets the
currency type as EUR.
Note
Each value that is defined for a BMC Atrium CMDB attribute of the enum data type has an
associated ID. A varchar field in the external data store can be mapped to the selection
value that is defined for the attribute of the enum data type. An integer field in the external
data store can be mapped to the associated ID that is defined for the attribute of the enum
data type.
Creating a new data store connection in Atrium Integrator

Consider the following when creating data store connections:
BMC Atrium Core 9.0
Page 732 of 2268
Home
For XML and CSV connection, if there are too many files in the folder, check if the fields from
these files are populated in NGIE:FileMetaData file before you create a job.
For XML and CSV connection, do not add files under root folder.
For database connection, if you plan to create a transformation with Response enabled,
ensure that user has permissions to access the associated tables in the data base.
You can create a CSV or XML datastore connection with a remote Atrium Integrator Carte
server.
To support this capability, Job_FileMetaLoader job is added to Atrium Integrator sample
jobs. Do not delete this job or you will not be able to create CSV or XML datastore
connection with Atrium Integrator Carte server. For more information, see Using Atrium
Integrator sample jobs.
To create data store connection

1. In the BMC Remedy AR System Home Page, select BMC Atrium Integrator > Atrium
Integrator.
The Atrium Integrator console appears.
2. Click Manage Data Store Connections
The Manage Data Stores window appears, with a list of defined data sources.
Manage Data Stores window

The New Data Store section appears on the right side of the Manage Data Stores window.
New Data Store section of the Manage Data Stores window
BMC Atrium Core 9.0
Page 733 of 2268
Home
4. Select the Data Store Type.

The fields below the Data Store Type change depending on the data store that you selected.
Note
You must specify only the server name, and not the fully qualified domain name, in
the Database Host Name field.
5. To create a connection to BMC Remedy AR System, complete the following steps. To create
a connection to a CSV or XML file, skip to step 6. To create a connection to a database, skip
to step 7.
a. Type a name for the connection.
b. In the AR Server Name field, type the name of your BMC Remedy AR System server
.
c. (optional ) In the Port field, type the port number.
d. (optional) Type the port number.
Note
You can specify a private RPC Program Number for data transfers into BMC
Atrium CMDB through BMC Atrium Integrator Spoon. You must use the
ports defined by BMC Atrium CMDB. For more information about the RPC
ports defined by BMC Atrium CMDB, see RPC ports in BMC Atrium CMDB .
e. Type the password to log on to BMC Remedy AR System.

6.
BMC Atrium Core 9.0
Page 734 of 2268
Home
6. To create a connection to a CSV or XML file, complete the following steps:
Note
You must structure your XML source file based on the sample
PULL_MONITOR.xml file that is located in the ARInstallationDirectory\diserver\
data-integration\NGIE-Sample directory.
a. In the Data Store Name field, type a name for the connection.
b. In the Directory Path field, specify the path to the folder that contains the source file.
c. From the Carte Server drop-down list, select the Atrium Integrator Carte server.
d. Click Refresh to get the latest file.
7. If space is used in a field or column in the CSV or XML file then the space is replaced by an
underscore.
The source files must be on the same computer on which you have installed the
Atrium Integrator server.
For an XML connection, duplicate attributes will be renamed with an underscore and
copy number( attribute name1, _attribute name_2 and so on)
8. To create a connection to a database, complete the following steps:
Creating a connection to a database
BMC Atrium Core 9.0
Page 735 of 2268
Home
a. Type a name for the connection.

b. Enter the host name.
c. Specify the database type.
d. Enter the name of the database you want to connect to.
The default port for the specified database is displayed.
e. (optional ) For a SQL Server database, type the instance name.
f. Type the user ID and password to log on to the database.
9. Click Test Connection to verify the connection parameters.
10. Click Save.
The data store connection is created and displayed in the Data Stores section on the left
side of the Manage Data Stores window. Each connection has an icon attached to it
depending on the data store type, as described in the following table.
Icons associated with data stores
BMC Atrium Core 9.0
Page 736 of 2268
Home
Icon
Associated data store type

AR System
CSV file
XML file
Database
Click on a data store to view the connection parameter details for that source.
Editing a data store connection in Atrium Integrator

All data store connections are displayed in the Data Stores section of the Manage Data Stores
window.
1. In the Manage Data Stores window, select the data store for which you want to edit the
connection information.
Connection details for the selected data store are displayed on the right side of the window.
Connection details in the Manage Data Stores window
2. Make the necessary changes. Note that you cannot edit the data store name and the data
store type.
3. (optional ) For CSV and XML data stores, click Refresh, to update the data store.
4. Click Test Connection to verify the connection parameters.
5.
BMC Atrium Core 9.0
Page 737 of 2268
Home
5. Click Save.
The data store connection is saved. Any new jobs that you create are based on the edited
connection, but jobs defined using the previous connection are not updated.
Deleting a data store connection in Atrium Integrator

All data store connections are displayed in the Data Stores section of the Manage Data Stores
window.
1. In the Manage Data Stores window, select the data store for which you want to delete the
connection.
2. Click Delete Data Store
The data store connection is deleted. Jobs that were based on the deleted connection are
not affected.
RPC ports in BMC Atrium CMDB

BMC Atrium CMDB has assigned the following RPC ports for Atrium Integrator and Reconciliation
Engine.
#define CMDB_RPC_PROGRAM_NUM_STANDARD 390696
#define CMDB_RPC_PROGRAM_NUM_ADMIN 390697
#define CMDB_RPC_PROGRAM_NUM_PRIVATE_MIN 390698
#define CMDB_RPC_PROGRAM_NUM_PRIVATE_MAX 390699
Changing AR system port

If you change the BMC Remedy AR system port address before running a job, you must also
update the port information in the Atrium Integrator data store and Atrium Integrator Spoon.
To update the port information in Atrium Integrator data store

See Editing a data store connection in Atrium Integrator .
To update the update the port information in Atrium Integrator Spoon

1. Open the job in Atrium Integrator Spoon.
2. In the Atrium Integrator Spoon Explorer, click Database connections.
3. Double-click the CMDB connection step.
The Database connection dialog box is displayed.
4. Update the TCP Port field.
5. Click Save.
BMC Atrium Core 9.0
Page 738 of 2268
Home
Creating a job in Atrium Integrator
You can create a job in the Atrium Integrator console by using the Integration Job Builder wizard, or
in the Atrium Integrator Spoon application.
Atrium Integrator provides an easy-to-use wizard for creating a simple data transfer job for
importing data into BMC Atrium CMDB. For complex data manipulations, you can first create a
simple data transfer job using the wizard, and then refine the generated job and transformations in
Atrium Integrator Spoon.
To import and export data from inputs like LDAP, BMC Remedy AR System forms, or BMC
Remedy IT Service Management (BMC Remedy ITSM) forms, you can create a job in Atrium
Integrator Spoon using the samples provided by BMC.
Creating a job through the Integration Job Builder wizard
Modifying Integration Job Builder templates
Creating a job in Atrium Integrator Spoon
Managing access to jobs in the Atrium Integrator console
Setting up event-driven jobs in Atrium Integrator
Creating a job through the Integration Job Builder wizard

You can use the Integration Job Builder wizard in the Atrium Integrator console to create a simple
job for transferring data from XML files, CSV files, or databases (IBM DB2, Microsoft SQL Server,
MySQL, Oracle, and Sybase) to BMC Atrium CMDB.
Using the wizard has the following benefits:
You need to specify only the business names for the information types to be transferred to
BMC Atrium CMDB. The wizard automatically selects the Common Data Model (CDM)
classes and relationships based on the information entered.
The wizard has built-in templates that specify typical integrations based on BMC experience
in populating the CMDB.
Note
BMC Atrium Core 9.0
Page 739 of 2268
Home
The best-practice templates are installed as part of the BMC Atrium CMDB
installation and not the Atrium Integrator server installation. If the templates are not
displayed in the Integration Job Builder wizard, you must verify that they have been
successfully installed on the BMC Atrium CMDB server that you have specified as
the target source. To verify, check the NGIE:BSM template.
When creating an Atrium Integrator job using Job Builder wizard, make sure that
the job name does not contain a space before and after the special character.
For example, test & delta is not considered as a valid job name.
The wizard adheres to best practices for populating data, such as auto populating
categorizations and name fields for relationships.
When multiple CI and relationship classes are selected, data transfers are sequentially
ordered.
Processing of delta records is simplified.
High-level steps for creating a job through the Integration Job Builder wizard
This section describes the high-level steps for creating a job to transfer data from an external data
store to BMC Atrium CMDB using the Integration Job Builder wizard.
Recommendations
BMC recommends that you use the Integration Job Builder wizard to automatically generate a job
and transformations from best practice templates. This will improve your productivity by providing a
starting point for developing and simplifying the transformation of data into BMC Atrium CMDB.
High-level steps for creating a job through the Integration Job Builder wizard
Step
no
Task
Description
Specify source and

target details.
You must specify the job name and description, external data store, and the CMDB class and
DatasetID to which you want to transfer data. For more information, see Specifying source and
target details.
Select CI types to
transfer.
Select the CI types that you want to transfer from the external data store. You can either select
CIs from a list, or select CIs based on a template. For more information, see Selecting CI types
to transfer.
Select the relationships

to transfer for the CI
types.
Based on the CI types that you want to transfer, the Integration Job Builder wizard displays the
relationships between the CI types. Select the relationships that you want to transfer. For more
information, see Selecting relationships to transfer for the CI types.
Map target attributes to

source columns.
Map the target attributes of the CI to the columns in the external data store. For more information
, see Mapping target attributes to source columns.
Define the relationship

mapping for the CI
types to be transferred.
Specify whether the source has a:
BMC Atrium Core 9.0
Direct association between parent and child classes

This option creates a mapping for a relationship class based on attributes in the CI
classes (parent-child) that are members of this relationship.
Page 740 of 2268
Home
Step
no
Task
Description
Separate table to define relationships

This option creates a mapping for a relationship class based on relationship data stored in
the external data store.
For more information, see Defining relationship mapping for the CI types to transfer.
Schedule the job to run

at a specific time or
For more information, see Managing a Atrium Integrator job schedule.
timed interval.
7
View the job summary
Verify the job name, and the CI types and relationships that you are transferring. For more
information, see Viewing the job summary.
Note
If you want to import CIs that are not included in the best practice templates, you must
create a relationship between the CIs before creating a job. For more information, see
Creating custom relationships.
Specifying source and target details
To specify source and target details
1. In the Atrium Integrator console, click Create Job
2. In the Overview page, click anywhere on the screen.

General page of the Integration Job Builder wizard
BMC Atrium Core 9.0
Page 741 of 2268
Home
3. In the General page, enter the name and description of the job.
4. In the Specify Data Store Details for Source area, specify the type and name of the external
data store.
If you do not have a data store connection to your source data, click Data Store to create a
new connection. For more information, see Creating a new data store connection in Atrium
Integrator.
5. In the Specify Data Store Details for Target area, select the name of the data store and
DatasetID of the BMC Atrium CMDB class to which you are transferring data.
If you do not have a data store connection to BMC Atrium CMDB, click Data Store to create
a new connection. For more information, see Creating a new data store connection in Atrium
Integrator.
Note
Do not use Atrium Integrator to transfer data directly into the BMC Asset dataset.
Instead, transfer the data into staging dataset and then reconcile it into BMC Asset.
6. Click Next. The Next button is enabled only after the Job Name, Source and Target Name,
and DatasetID fields have valid entries.
BMC Atrium Core 9.0
Page 742 of 2268
Home
Selecting CI types to transfer
You can transfer the select CI types:

Grouped together in a template. See, To select CI types to transfer from a templates list .
CI types for which you want to transfer data from a CI list.See, To select CI types to transfer
from a CI list.
Custom CI. See, To select CI types to transfer from a CI list .
Note
In Atrium Integrator, the CI mapping is based on mapping defined in the CMDB:
DataModelReference_CIMapping form. To modify the mapping you need to update this
form.
To select CI types to transfer from a templates list

The Integration Job Builder wizard offers a desktop, server, application, discovery, and virtual
machine template. Each available template groups together the appropriate CIs and relationships.
For example, the virtual machine template groups all the CIs that make up that virtual machine. If
you select this template, the wizard automatically moves all related CIs to the Selected CI Types
area.
Note
The templates are installed as part of the BMC Atrium CMDB installation and not the
Atrium Integrator server installation. If the templates are not displayed in the Integration
Job Builder wizard, you must verify that they have been successfully installed on the BMC
Atrium CMDB server that you have specified as the target source. To verify, check the
NGIE:BSM template.
You can modify the templates that are available on the CI Type Selection Page of the Integration
Job Builder wizard. For more information, see Modifying templates.
1.
BMC Atrium Core 9.0
Page 743 of 2268
Home
1. In the CI Type Selection page, leave the default selection of Templates in the Select CI
Types from area.
CI Type Selection page of the Integration Job Builder wizard-Templates
2. Select the template from which to transfer CI types.

3. Click Add.
The selected template moves to the Selected Templates list. Click
to see the CIs and
relationships included in that template.

The CIs bundled with the selected template are displayed in the Selected CI Types area.
You can remove a CI by selecting it and clicking Remove.
4. Click Next.
The Next button is enabled after one or more templates have been added to the Selected
Templates column.
The CI Type Relationships page appears.
To select CI types to transfer from a CI list

1. In the CI Type Selection page, click Select CI Types from CIList.
CI Type Selection page of the Integration Job Builder wizard- CI List
BMC Atrium Core 9.0
Page 744 of 2268
Home
2. Select the CI type that you want to transfer.

To select multiple CI types, press the CTRL key and then select the CI types.
When you hover over a CI type, its class name and Product categorization attributes (
Category, Type, and Item or CTI) are displayed.
To filter the CI types by name, type in the Available List of CI Typesfield. Filtering is case
insensitive and displays all results containing the filter text.
Note
You can also select custom CI types for creating custom relationships.
3. Click Add.
The selected CI types move to the Selected CI Types list.
4. Click Next.
The Next button is enabled after a CI type has been added to the Selected CI Types
column.
The CI Relationships page appears.
BMC Atrium Core 9.0
Page 745 of 2268
Home
Selecting relationships to transfer for the CI types
The CI Types Relationships page displays the available relationships for the selected CI types.
When you hover over a relationship type, the relationship name and parent and child CIs are
displayed.
To select relationships to transfer for the CI types
Creating custom relationships
To create custom relationships
Related information
To select relationships to transfer for the CI types

1. In the CI Relationships page, select the relationships that you want to transfer.
To select multiple relationships, press the CTRL key and select the relationships. To filter
the relationships by name, type in the Available Relationships field. Filtering is case
insensitive and displays all results containing the filter text.
2. Click Add to move the selected relationships to the Selected CI Types Relationships list.
3. You can define a custom relationship. For more information, see [#Creating custom
relationships].
4. Click Next.
The Mapping page for the last selected CI type appears. For example, if you had selected
Computer system, Disk drive, and Operating system to be transferred to BMC Atrium CMDB,
the Operating system Mapping page would appear.
Note that the step toolbar at the top of the page is updated to display a mapping step for
each CI type that you selected and a step for the relationships. Each relationship is
represented as a tab in the relationship page. For example, if you had selected the
Computer system, Disk drive, and Operating system CIs and the SYSTEMOS relationship,
the step toolbar would be updated.
Step toolbar of the Integration Job Builder wizard
BMC Atrium Core 9.0
Page 746 of 2268
Home
Creating custom relationships

You can also define new relationships and create custom relationships.
If you want to import CIs that are not included in these templates, you must create a relationship
between the CIs before creating a job.
When you create custom relationships, please consider the following:
Field mapping is validated by datatype. Refer, Atrium Integrator supported data types before
you create a create relationship.
You can change the mapping later from BMC Atrium Integrator Spoon by modifying the
CMDBoutput plugin.
Follow the CDM standards and recommendations when you create a relationship.
To create custom relationships

1. In the Namespace list, select a namespace.
Custom namespaces if any, are also populated in this list.
CI Relationships page of the Integration Job Builder wizard
2. In the Relationshiplist, select a relationship available for the selected namespace.
Note
If the selected relationship does not have appropriate parent or child CI types
selected, an error message is displayed. Select required CI Type from the CI Type
Selection page.
3.
BMC Atrium Core 9.0
Page 747 of 2268
Home
3. In the Parent CI list, select a parent CI for the selected relationship.

All the parent CIs under that relationship are populated in the Parent list. Atrium Integrator
validates the CDM to display the list of selected CIs.This list is populated based on the CIs
you have selected.
4. In the Child CI list, select a child CI for the selected relationship.
5. (optional) If the parent and child CI belong to the same class, you are prompted to enter a
logical name for the child CI.
6. Click Add.
Related information
Mapping target attributes to source columns
Mapping target attributes to source columns defines how data in the source corresponds to data in
BMC Atrium CMDB and which actions to take when transferring between them. A source key
uniquely identifies a row of data. You must specify the attributes of the CI class and the
corresponding column in the external data store that together make up the source key. After a data
transfer, the source key is the link that matches a record in the external data store with its
counterpart in BMC Atrium CMDB.
Recommendations
To map target attributes to source columns for CSV or XML files
To map target attributes to source columns for database tables or views
Recommendations
When choosing an attribute as a source key, consider the following points:
Do not use an attribute whose value could change or could be NULL, such as the
Description attribute. If the source key of a record is NULL, the record cannot be
identified and it cannot be transferred.
If your external database has records with empty values, you can create a view of your
external database to filter out such records. You can then map target attributes to source
columns based on this view.
Select a unique attribute that you can also use for identification during reconciliation. You
can select attributes to use for the source key that are already in the standard identification
rule. This ensures that you can use a Standard Job for reconciliation. For more information
about Standard Jobs, see Creating a standard reconciliation job.
BMC Atrium Core 9.0
Page 748 of 2268
Home
If you cannot use the standard rules, use attributes inherited from the BMC_BaseElement
class. This simplifies your reconciliation setup by allowing multiple classes to inherit
identification rules from the BMC_BaseElement class. For the sample scenario shown in
Organization of the computer and disk drive database tables , you would define a source key
that relates a drive ID in the Disk drive ID column of the CalbroDiskDrive table with the
CalbroIntegrationID attribute in the BMC_DiskDrive class.
If you select more than one key in CMDBOutput and CMDBLookUp plug-in then make sure
that the data in source does not contain comma or update will not happen correctly.
To map target attributes to source columns for CSV or XML files

1. In the Mapping page, select the CSV or XML file from which you want to transfer records.
For CSV, columns from the selected file are displayed in the Source Columns list.
For XML, columns from the selected file are displayed in the Source Columns list
after you select File > Xpath. The Xpath field lists all the parent nodes available in an
XML file. When you select a parent node, respective child nodes are displayed in the
Source Columns list.
Note
For XML, duplicate attributes will be renamed with an underscore and copy
number( attribute name1, _attribute name_2 and so on)
Mapping page of the Integration Job Builder wizard for XML files
2. Select a target attribute to which you want to transfer data. To filter attributes by name, type
in the Target Attributes field. Filtering is case insensitive and displays all results containing
the filter text.
BMC Atrium Core 9.0
Page 749 of 2268
2.
Home
Note
You must map all attributes identified by a * preceding the attribute name (for
example, *Name).
3. From the Source Columns table, select a column from which you want to transfer data to
the selected attribute.
To map the selected attribute to a constant value, enter the value in the field below the
Source Columns table. To filter columns by name, type in the Source Columns field.
Filtering is case insensitive and displays all results containing the filter text.
4. Click Map. The selected attribute and source column move to the Mapped Columns table.
Note
By default, the type for all mapped fields that are listed in the XML or CSV step
input is set to String. Based on your requirements, you can manually change the
type for specific fields. When you change type to date, the date format must be the
same format used in the CSV or XML file. For more information, see Changing the
field type in the XML or CSV step input in BMC Atrium Integrator Spoon .
5. Repeat step 2 through step 4 for each attribute to which you want to transfer data.
6. In the Mapped Columns table, select the Source Key check box for the Target Attribute/
Source Column row that you want to specify as a source key.
7. Repeat step 6 for each source key that you want to map.
When you have a source key with more than one attribute from each side, the expressions
are joined with an AND operator. That means a data row in the external data store matches
an instance in BMC Atrium CMDB only if each pair of attributes in the source key matches.
Note
You must have at least one attribute/source column mapping in addition to those
specified as source keys.

Transformation Options tab-Integration Job Builder wizard
BMC Atrium Core 9.0
Page 750 of 2268
Home
9. In the Delta area:

Select No to retrieve all source records each time your job runs.
Select Yes to import only new or updated source records since the last transfer was
run. Then select the column in your source that holds the time stamp indicating when
each record was last modified. During each data transfer, the only records retrieved
from the source are new records and those with a last modified time stamp that is
later than the most recent successful transfer.
The default value for Delta is Yes if a column in your source table has a Date/Time
value. If the source is a CSV file, all columns are listed in the Delta area.
Note
For XML delta and CSV delta, by default, the type for all mapped fields that
are listed in the source step ( Get Data from XML step for XML and Text file
input step for CSV) and are set to String. When you select a field for the
Delta option, you must manually change the type for that field to Date. For
more information, see Changing the field type in the XML or CSV step input
in BMC Atrium Integrator Spoon.
Recommendations
BMC recommends that you select the Delta=Yes mode when you first create the job
so that the job can be run in both delta and full modes in the future. If you specify
Delta=No (that is, select full mode), the transformation that is designed will require
significant manual changes in BMC Atrium Integrator Spoon to make it delta enabled.
10. Specify whether you want to set a Response field. You can specify a field that is updated in
the source record after a record is created or updated in the target. Only integer and
character type values are supported in the Response field.
a. To modify the response value, edit the UpdateResponse step.
b.
BMC Atrium Core 9.0
Page 751 of 2268
10.
Home
b. If you select Yes, select the column in your source that you want to update.
Recommendations
Typically, you use a Response field when a value is generated at the time a target
record is created or modified and you want that value stored in the source record. For
example, you might need to store the ID number of the target record just created, or
you might want to update a time stamp in the source data, indicating the time that a
transfer took place.
11. In the Delete area:
(default) Select No to retain a record in BMC Atrium CMDB when that record is
deleted from the source data store.
Select Yes to delete a record from BMC Atrium CMDB when that record is deleted
from the source data source. This option sets the MarkAsDelete field to Yes for the
records that are deleted from the source data store.
When you select Yes, a separate Delete transformation is created as part of the job.
The Delete transformation is triggered immediately after the transformation that
transfers the corresponding data to BMC Atrium CMDB is complete.
Note
The Delete option is also not available for relationship classes.
12. Click Next. The Mapping page for the next CI type appears. For example, if you had
selected Computer system and Disk drive to be transferred to BMC Atrium CMDB, the
Disk drive Mapping page appears. If you selected only one CI, the Schedule page appears.
To map target attributes to source columns for database tables or views

1. In the Mapping page, specify whether your source data is in a table or a view. The columns
from the source table are displayed in the Source Column Name list box.
Mapping page of the Integration Job Builder wizard for database tables
BMC Atrium Core 9.0
Page 752 of 2268
Home
2. Select the Schema and Table name for the source data.
3. Follow step 2 to step 12 to map target attributes to source columns.
Defining relationship mapping for the CI types to transfer
How you define the relationship between the CI types that you are transferring to BMC Atrium
CMDB depends on whether the relationship data in your source tables is class-based or stored in
an external table.
Defining relationship mapping based on attributes in CI classes
Defining relationship mapping with an external data store as the source
Defining relationship mapping based on attributes in CI classes

If your relationship data is stored within your source CI tables, you can follow the example in
Source data organization at Calbro Services. You would have defined a mapping for the
BMC_DiskDrive CI class that contains an attribute called AssociatedComputer. This attribute
associates an instance of a disk drive with an instance of a computer. For example, disk 1520 in
BMC Atrium Core 9.0
Page 753 of 2268
Home
the Disk Drive table is associated with computer vm2-w4-dev01 in the Computer table. You also
would have defined a mapping for the BMC_ComputerSystem CI class that contains an attribute
called Name. This attribute defines the name of a computer that you have in inventory.
Because each disk drive in your company is associated with a computer, you can create a mapping
for the BMC_HostedSystemComponents relationship class that associates a particular instance of
BMC_DiskDrive with a particular instance of BMC_ComputerSystem. In this case, the
AssociatedComputer attribute in the BMC_DiskDrive class and the Name attribute in the
BMC_ComputerSystem class contain the data necessary to create the relationship.
Each relationship class in BMC Atrium CMDB defines one CI class as the parent member of the
relationship and another CI class as the child member of the relationship. In this case,
BMC_ComputerSystem is the source (parent) member and BMC_DiskDrive is the destination (
child) member of the BMC_HostedSystemComponents relationship class. For more information
about relationship classes, see Relationship classes in the Common Data Model .
To define relationship mapping with CI classes as the source

1. In the Relationship Mappings page, leave the default selection which says that the
relationship data is contained within the source columns of the two CIs.
Relationship Mapping page of the Integration Job Builder wizard-CI classes as source
The source key that you specified for the parent CI (SerialNumber for Computer system in
the example) is displayed in the first column.
2. From the child CI column, select the column that contains the information that associates the
child CI with the parent CI.
In the sample Calbro scenario ( Creating a data transfer job), the Computer system Key
BMC Atrium Core 9.0
Page 754 of 2268
2.
Home
Column displays SerialNumber (the source key for computer system). From the Disk drive
Columns, the Calbro administrator selects AssociatedComputer, which maps a disk drive
to appropriate computer system.
3. Click Next.
The Relationship Mapping page appears.
Defining relationship mapping with an external data store as the source

This method compares attributes between each CI class and the external data store. The instance
IDs of these member CIs are stored in the relationship instance as Source.InstanceId and
Destination.InstanceId. If no attribute values correspond, no relationship instance is created.
The following figures present an example of mapping in two stages based on relationship data
stored in an external data store.
Stage 1 of creating a data mapping based on relationship data stored in an external data
store
BMC Atrium Core 9.0
Page 755 of 2268
Home
In Stage 1, the Name attribute from the Computer Information table from the external data store is
mapped to the Name attribute of the BMC_ComputerSystem class. Instance IDs for individual
members of the BMC_ComputerSystem class are generated. The Name attribute from the Disk
Drive Information table from the external data store is mapped to the Name attribute in the
BMC_DiskDrive class. Instance IDs for individual members of the BMC_DiskDrive class are also
generated. In this stage, no relationship is created.
Stage 2 of creating a data mapping based on relationship data stored in an external data
store
In Stage 2, when the data exchange runs, a match is found between the values of the
AssociatedComputer attribute from the Disk Drive Information table and the Name attribute
from the BMC_ComputerSystem class.
When attributes from a data table in an external data store correspond between two CI classes in
BMC Atrium CMDB, a relationship is created between the two CI classes in BMC Atrium CMDB.
In this example, attributes from the Disk Drive Information table in the external data store
BMC Atrium Core 9.0
Page 756 of 2268
Home
correspond to the attributes in the BMC_ComputerSystem and BMC_DiskDrive tables in BMC

Atrium CMDB. A relationship is thus created between BMC_ComputerSystem and BMC_DiskDriv
e. This relationship is stored in the BMC_HostedSystemComponents relationship class.
BMC_ComputerSystem becomes the source class and BMC_DiskDrive becomes the destination
class for the relationship mapping. The instance IDs of the member CIs are stored in the
BMC_HostedSystemComponents relationship class as Source.InstanceId and
Destination.InstanceId for BMC_ComputerSystem and BMC_DiskDrive.
To define relationship mapping with external data store as the source

1. In the Relationship Mappings page, select the button whose label says that the key columns
of the CIs are related using columns in an external table.
Relationship Mapping page of the Integration Job Builder wizard-external data store
as source
2. Specify the schema and name of the external table containing the relationship information.
3. For the parent CI, the source key is displayed in the left column. In the Association Table
Columns, select the column from the external table that maps to the source key.
4. For the child CI, the source key is displayed in the left column. In the Association Table
Columns, select the column from the external table that maps to the source key.
5. Click the Transformation Options tab and specify the delta options.
6. Click Next.
The Schedule page appears.
BMC Atrium Core 9.0
Page 757 of 2268
Home
Creating an Atrium Integrator job schedule
For Atrium Integrator 8.1 and later, you can create a schedule only for the selected job. You cannot
create schedule for one job and then assign it to a different job.
To create a schedule for the job

1. On the Schedule page:
a. Select Active.
b. Select the Create new schedule option.
c. Enter a schedule name.
d. In Start Time, select the time (BMC Remedy AR System server time) at which you
want the job to first run.
e. In the Recurrence type area, specify how frequently you want the job to run.
Note
When you run reconciliation jobs, ensure that you do not run the
reconciliation jobs and Atrium Integrator jobs at the same time, because the
reconciliation jobs and Atrium Integrator jobs could query or update the
same data.
Schedule page
BMC Atrium Core 9.0
Page 758 of 2268
Home
2. Click Next.
3. The Summary page appears.
Viewing the Atrium Integrator job summary
To view the job summary

1. In the Summary page, verify the CI types and relationships that you have selected. If you
need to make any changes, click Back.
If you make changes that have dependencies, you must go page by page and update your
selections. For example, if you change the CI type to transfer, you must update the CI type
relationships, the mapping between key source columns and target columns, and
relationship mapping.
Summary page of the Integration Job Builder wizard
BMC Atrium Core 9.0
Page 759 of 2268
Home
2. Click Finish.
A list of the transformations created for your job is displayed.
3. Click OK.
A job is created and saved in the Atrium Integrator Spoon repository.
The saved jab can be identified as:
<AI server name><datasetid>/<Job name>

If an error occurred while creating your job, an error message is displayed. For
troubleshooting information, see Troubleshooting Atrium Integrator console issues.
Modifying Integration Job Builder templates

You can modify the templates that are available on the CI Type Selection Page of the Integration
Job Builder wizard when you are creating a data transfer job. For more information about creating a
job, see Creating a job through the Integration Job Builder wizard .
To modify a template
1. In a browser, log on to the BMC Atrium CMDB server that is defined as the target data
source.
2. Open the NGIE:BSMTemplate form in New mode.
3. Select the template that you want to modify.
4. From the Config Items field, select the alias names of the CIs that you want to add to the
template.
The CIs you added now appear in the CI Types list when you select the modified template.
BMC Atrium Core 9.0
Page 760 of 2268
Home

You can use Atrium Integrator Spoon to import and export data from inputs like LDAP, BMC
Remedy AR Systems forms, BMC Remedy ITSM forms, and those requiring complex staging tasks
or complex data manipulations. BMC provides several sample jobs that you can use as a starting
point. You can also refer to sample transformations for each step, which can be accessed from the
following location:
<ARInstallationDirectory>\diserver\dataintegration\Sample
For more information about different complex jobs, see Complex jobs in BMC Atrium Integrator
Spoon.
Recommendations
Use a naming convention for jobs and transformations that makes them easy to identify. Use
the same name prefix to identify related jobs and transformations.
Use variables for file paths or computer-specific connection information so that file paths and
so forth can be determined dynamically instead of statically. You can refer to the Sample
jobs for this information.
When you create a transformation from Atrium Integrator Spoon, ensure that the AR server
connnection used in the CMDBInput CMDBOutput, LookUp, ARInput, and AROutput steps
has an entry in the UDM:RAppassword form with the Remedy Application service user and
its password.
To customize a sample job or transformation

1. On the computer where the Atrium Integrator Spoon client installed, select Start >
The AR Server connection dialog box appears.
BMC Atrium Core 9.0
Page 761 of 2268
Home
permissions.
d. Click OK.
The Repository explorer dialog box shows the sample jobs and transformations in the BMC
SAMPLES directory.
4. Double-click a sample job or transformation.
5. Select File > Save as.
6. In the properties window, enter a name for the job or transformation and then click OK.
The sample job or transformation is saved with the name that you specify.
Note
When you create an BMC Remedy AR System transformation from Atrium
Integrator Spoon, the records inserted and updated are displayed in the Output
column of the Step Matrix table.
7. Edit the job or transformation as needed.
BMC Atrium Core 9.0
Page 762 of 2268
Home
7.
Note
When you schedule a job from Atrium Integrator Spoon, the scheduling information
is not updated the AR System Job and AR System Item forms.
For more information about creating a job in Atrium Integrator Spoon, see the Spoon User Guide at
http://wiki.pentaho.com/display/EAI/Spoon+User+Guide .
Managing access to jobs in the Atrium Integrator console

When you create a job in the Atrium Integrator console, the Public permission is assigned to that
job and the generated transformations by default. Therefore, users with access to the Atrium
Integrator console can view the jobs and transformations that have been created by other users. To
restrict access to the jobs and transformations, you must manually set the permissions by using the
UDM:PermissionInfo form. You must be assigned to the UDM Administrator role to configure the
access permissions for jobs or transformations. Also, ensure that the same permissions are
configured for a job and the transformations that are part of that job.
To configure access permissions for a job or transformation

1. In a browser, open the UDM:PermissionInfo form in a Search mode.
UDM:PermissionInfo form
2. Search for the job or transformation for which you want to configure permissions.
3.
BMC Atrium Core 9.0
Page 763 of 2268
Home
3. From the Permissions list, select the group or role to which you want to restrict access.
4. Click Save.
Setting up event-driven jobs in Atrium Integrator

You can create an event-driven job by using the Application Pending form.
To set up an event-driven job

1. In the Atrium Integrator console, open the Integration Job Details of the job you want to set
to event-driven.
2. Open the Application Pending form and set the following parameters for according to the
details displayed in the Integration Job Detailstab in the Atrium Integrator console:
Category: AI
Command: <JOB_NAME> as in the Integration Job Details tab
Form: <DIRECTORY_PATH> as in the Integration Job Details tab
Source ID: <JOB_ID> as in the Integration Job Details tab
Status: Pending (This tells that a new request is pending)
3. Click Save.
The job is executed.
Related topic
Editing Atrium Integrator jobs and transformations
After you create your job with the Integration Job Builder wizard, you can edit it in the Atrium
Integrator Spoon application.
Recommendations
BMC recommends that you validate and clean up your source data before transferring it to BMC
Atrium CMDB.
Opening Atrium Integrator job or transformation
Mapping the Integration Job Builder wizard output to Atrium Integrator Spoon steps
Connecting transformation steps or job entries in Atrium Integrator Spoon
Adding intermediate steps to a Atrium Integrator job
Adding intermediate steps to a Atrium Integrator transformation
Editing Atrium Integrator transformation steps
Editing Atrium Integrator transformation properties
BMC Atrium Core 9.0
Page 764 of 2268
Home
Verifying jobs
Launching several copies of a step in Atrium Integrator Spoon
Changing data mappings in Atrium Integrator Spoon
Changing the field type in the XML or CSV step input in Atrium Integrator Spoon
Exploring a database connection in Atrium Integrator Spoon
Browsing source data in Atrium Integrator Spoon
Changing source configuration in Atrium Integrator Spoon
Transferring source records to BMC Atrium CMDB without checking for duplicates
Inserting or updating bulk records in BMC Atrium CMDB
Increasing cache size for Atrium Integrator
Configuring the checksum value for loading data into BMC Atrium CMDB
Mapping currency field
Opening Atrium Integrator job or transformation

After you create your job through the Integration Job Builder wizard, you need to open it in Atrium
Integrator Spoon to make edits.
Note
The .ktr files of the jobs are available in the %USERPROFILE% directory on Microsoft
Windows operating system and in home directory on UNIX operating system.
To open a job or transformation

1. On the computer where you have the Atrium Integrator Spoon client installed, select Start >
BMC Software > Atrium Integrator > BMC Atrium Integrator Spoon .
2. The AR Server connection dialog box appears.
BMC Atrium Core 9.0
Page 765 of 2268
Home
permissions.
d. Click OK.
The Repository explorer dialog box shows all the jobs and transformations in the BMC
Remedy AR System database.
Repository explorer window with sample jobs and transformations
BMC Atrium Core 9.0
Page 766 of 2268
Home
This section describes how each page in the Integration Job Builder wizard maps to Atrium
Integrator Spoon steps. This will help you understand what steps you should edit in Atrium
Integrator Spoon.
Wizard page
Corresponding Atrium
Integrator Spoon step
General > Job Name
Name of job_CI being

transferred
General > Data Store details for Source To create a source data store, go to the Manage
Input step
Data Stores > New Data Store page.

General > Data Store details for Target To create a target data store, go to the Manage
Output > CMDBOutput step
Data Stores > New Data Store page.

CI Type Selection
CMDBOutput.ClassName field
Relationships Selection
CMDBOutput.ClassName field
CI Mapping
CMDBOutput
Data mapping
CMDBOutput (table section)
Key mapping
CMDBOutput (key section)
Relationship Mapping
CMDBLookUp
Configuration and Logging options
Set variables
BMC Atrium Core 9.0
Page 767 of 2268
Home
Connecting transformation steps or job entries in Atrium Integrator Spoon

The following topics are available:
To create a hop
To flip a hop
To disable a hop
To delete a hop
Specifying the condition on which a job entry is executed
Transformation hop colors
In Atrium Integrator Spoon, a hop connects one transformation step or job entry with another.
A transformation hop defines the direction of the data flow.
Transformation hop
A job hop defines the job execution order and the condition on which the next job entry is to be
executed.
Job hop
To create a hop
You can create a hop between steps in a transformation or between jobs.
1. In Atrium Integrator Spoon, open the job or transformation to which you want to add a hop.
2. Select the first step.
BMC Atrium Core 9.0
Page 768 of 2268
Home
3.
Press the Shift key and draw a line to the second step.
Press the Ctrl key and select the second step, and then press the right mouse button
and select New hop.
The steps are connected by a hop. The hop arrow indicates the direction of the data flow.
You can change the direction of the data flow by reversing the direction of the hop.
To flip a hop
Right-click a hop and select Flip direction.
The direction of the hop is reversed.
You can disable a hop for testing purposes.
To disable a hop
Right-click on a hop and select Disable hop.
Note
The Disable hop command appears only when you right-click on an active hop.
The hop is disabled and its color changes to gray.
To delete a hop
Right-click a hop and select Delete hop.
The hop is deleted.
Specifying the condition on which a job entry is executed

You can specify the condition on which the next job entry is to be executed by specifying an
evaluation mode for the hop that goes to that job entry.
To specify the evaluation mode

1. Right-click a job hop and select Evaluation.
2. Select one of the following commands:
Unconditional specifies that the next job entry must be executed regardless of the
result of the originating job entry. An unconditional job hop uses the
Follow when result is true specifies that the next job entry is to be executed
when the result of the originating job entry is true. This job hop uses the
BMC Atrium Core 9.0
Page 769 of 2268
Home
Follow when result is false specifies that the next job entry is to be
executed when the result of the originating job entry is false. This job hop uses the
Transformation hops are displayed in a variety of colors based on the properties and
state of the hop, as described in the following table.
Transformation hop colors

Transformation hops are displayed in a variety of colors based on the properties and state of the
hop, as described in the following table.
Hop line colors
Hop color
Description
Black
The hop has a defined target step.
Gray
The hop is disabled.
Green
If multiple hops are leaving a step, rows of data are evenly distributed to all target steps.
Red
If multiple hops are leaving a step, all rows of data are copied to all target steps.
Yellow
Provides information about the step and distributes rows.
Magenta
Provides information about the step and copies rows.
Red dot line
The hop carries rows that caused errors in source steps.
Adding intermediate steps to a Atrium Integrator job

You can add intermediate steps to a job that you create through the Integration Job Builder wizard,
or to a custom job you create through the Atrium Integrator Spoon.
To add an intermediate step to a job

Click the step that you want to add and drag it to the canvas.
The following table lists the common steps you can add to your job to ma nipulate the data before
adding it to BMC Atrium CMDB.
For information about additional steps that you can add to your job, see the Spoon User Guide at
http://wiki.pentaho.com/display/EAI/Spoon+User+Guide .
Intermediate steps for jobs
Option
What it helps you do
Utility menu
Abort job
Aborts the specified job.
Display
Msgbox Info
Displays a message box in the job to enable you to see where you are in the process.
BMC Atrium Core 9.0
Page 770 of 2268
Home
Option
Ping a host
Pings a host machine using the ICMP protocol.
Truncate tables
Truncates one or several tables.
Write to Log
Writes a specific string to the PDI logging system.
General menu
Start
Starts a job.
Dummy
Adds a dummy step to enable you to test your job. The dummy step does not perform any evaluation.
Job
Executes a previously defined job.
Success
Clears an error state found in a job and forces it to the success state.
Transformation
Executes a previously defined transformation.
Mail menu
Get mails
Retrieves email messages from a POP server and stores them into one or more files.
Mail
Sends a text or HTML email messages with optional file attachments.
File
management
menu
Add filenames
to result
Adds a set of files or folders to the result list of the job entry. This list of file names can then be used in the
various job entries all around.
Compare
folders
Compares two folders to check if their content is identical.
Copy Files
Copies one of more files or folders.
Copy or Move
result
Copies or moves all the file names that are in the result files list of the last job entry.
filenames
Create a folder
Creates a folder at the specified location.
Create file
Create an empty file at the specified location. This is useful for creating trigger files from within jobs.
Delete file
Deletes the specified file.
Delete
filenames from
result
Delete all the file names that are in the result files list of the last job entry.
Delete files
Deletes a set of files.
Delete folders
Deletes one or more folders and all the content in them.
File Compare
Compares the contents of two files and controls the flow of the job by it. When the contents of the files are the
same, the success outgoing hop is followed; otherwise, the failure hop is followed.
HTTP
Gets a file from a web server using the HTTP protocol.
Move Files
Moves a number of files and, folders, or both to alternate locations on your file system.
Unzip file
Unzips one or more files.
BMC Atrium Core 9.0
Page 771 of 2268
Home
Option
Wait for file
Waits for a file. This job entry sleeps and periodically checks whether the specified file exists, after which the
flow continues. The job entry can either wait indefinitely for the file or it can time out after a certain time.
Zip file
Creates a standard ZIP archive using the options that you specify.
Conditions
menu
Check if a
Verifies if a folder is empty (contains no files).
folder is empty
Check if files
exist
Verifies if certain files exist on the server on which Kettle runs.
Columns exist
in a table
Verifies that one or more columns exist in a database table.
Evaluate rows
number in a
Define the success condition that can be evaluated. The job process can be branched by the result of this step.
For the success condition, you can check the number of rows if they are:
table
Equal to
Different from
Smaller than
Smaller or equal to
Greater than
Greater or equal to
File Exists
Verify if the specified file exists on the server on which Kettle runs.
Simple
evaluation
Evaluates contents of a variable or a field in the result stream. You can connect two steps with the output of the
Simple Evaluation. The green connection is used to indicate success, the red one to indicate failure.
Table exists
Verifies if the specified table exists on a database.
Wait for
Wait for the specified time before running the next job entry.
Scripting menu
JavaScript
Executes a JavaScript script.
Shell
Executes a shell script on the host where the job is running.
SQL
Executes an SQL script.
Bulk loading
menu
BulkLoad from
Mysql into file
Loads data from a MySQL table to a text file.
BulkLoad into
MSSQL
Loads data from a text file into a Microsoft SQL Server table.
BulkLoad into
Mysql
Loads data from a text file into a MySQL table.
XML menu
Check if XML is
well formed
Verifies that one or more files contain well formed (allowed) XML content.
BMC Atrium Core 9.0
Page 772 of 2268
Home
Option
DTD Validator
Verifies that an XML file corresponds to a certain structure or format.
XSD Validator
Validates the specified XML file against the specified XML Schema Definition (XSD) file.
XSL
Transformation
Transforms the specified XML file into another document.
Repository
menu
Check if
connected to
repository
Checks whether you are connected to the repository.
File transfer
menu
Get a file with
FTP
Gets one or more files from an FTP server.
Get a file with

SFTP
Gets one or more files from an FTP server using the Secure FTP protocol.
Put a file with
Puts one or more files on an FTP server.
FTP
Put a file with
SFTP
Puts one or more files on an FTP server using the Secure FTP protocol.
Adding intermediate steps to a Atrium Integrator transformation

You can add intermediate steps to a transformation in a job that you create through the Integration
Job Builder wizard, or to a custom job you create through the BMC Atrium Integrator Spoon
application.
The following table lists the steps that you can add to your transformation to manipulate the data
before adding it to BMC Atrium CMDB.
BMC supports only the steps listed in the table. For information about additional steps that you can
add to your transformation, see the Pentaho documentation
Note
Any queries around complex customization using unsupported steps will be addressed
selectively and at discretion of BMC. See, Atrium Integrator Spoon support.
Intermediate steps for transformations

Step
What it helps you to do
Input
BMC Atrium Core 9.0
Page 773 of 2268
Home
Step

ARInput is a BMC provided step. It allows you to migrate AR data into BMC Atrium CMDB.
ARInput step fields and description (click to expand)
ARInput
Field and description

Field
Description
General tab
Connection
Specify the AR server name.
Form Name
Specify the form name from where you want fetch the AR data.
Chunk Size
Specify the number of records you want to pull in one thread.
Qualification tab
Qualification
String
Specify the qualification value.
Fields tab
Field list
Displays the AR field details. Click Get Fields to populate all the available AR fields.
CMDBInput is a BMC provided step. It allows you to migrate data from the BMC Atrium CMDB on your
development server to the BMC Atrium CMDB on your production server.
CMDBInput
To understand how the CMDBInput step is used see, Creating a job to migrate data from one BMC Atrium CMDB
to another.
CMDBInput step fields and description (click to expand)
Field
Description
Connection
Class Name
Specify the CMDB form name from where you want to read the data.
NameSpace
Specify the BMC namespace. For example BMC.Core
Dataset Id
Specify the BMC dataset ID. For example, BMC.ASSET
Attribute List
Displays the list of attributes that belong to the selected class. Click Get Attributes to
populate the list.
To Filter Criteria
Select Values of
Attributes
Define the filter criteria to compare CMDB fields to qualifications value.
Selected
Qualifications
Displays the list of qualification strings. For example, in AND 'MarkAsDeleted' = NULL
string, AND is the join condition, MarkAsDeleted is the field value and NULL is the
qualification value .
ARX File Input is a BMC provided step. It allows you to migrate data from ARX files into BMC Atrium CMDB.
ARX File Input step fields and description (click to expand)
BMC Atrium Core 9.0
Page 774 of 2268
Home
Step
ARX File
Input

Field
Description
File Name
Specify fieldname that will contain the filename(s) to read from.
Chunk Size
Specify number of records you want to pull in one thread.
Schema Names
AR form name that the arx file uses.
Connection
Fields table
List of arx data fields. The data is pushed in the displayed fields only.
Preview Rows button
Click to view the data in the fields.
Table input step allows you to read information from a database, using a connection and SQL. Basic SQL
statements are generated automatically.
Table Input
BMC supports selective vendor databases which include IBM DB2, MS SQL Server, Oracle, Sybase, and My
SQL.
To understand how Table input step is used, see Verifying jobs with table as input and BMC Atrium CMDB as
output.
For information about adding qualifications to the Table Input step, see the
Input step video.
Adding Qualification to Table
Table Input step fields and description (click to expand)

Field
Description
Connection
The database connection from which to read data.
SQL
The SQL statement used to read information from the database connection. You can also click
Get SQL select statement... to browse tables and automatically generate a basic select
statement.
Enable
Select if you want to avoid unnecessary data type conversions. Enabling this option results in a
lazy
conversion
significant performance improvements.
Replace
variables
in script?
Select if you want to replace variables in the script. This option allows you to test with or without
performing variable substitutions.
Insert data
from step
Input step name where Pentaho can expect information to come from. This information can then
be inserted into the SQL statement. The locators where Pentaho inserts information is indicated
by ? (question marks).
Execute
for each
row?
Select to perform the data insert for each individual row.
Limit size
Sets the number of lines that is read from the database. Zero (0) means read all lines.
CSV File input step allows you to migrate data from CSV files into BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 775 of 2268
Home
Step

CSV File Input step fields and description (click to expand)
CSV File
Input
Field
Description
Filename
Select the fieldname that will contain the filename(s) to read from.
Delimiter
Specify the file delimiter character used in the target file. Special characters (e.g. CHAR
HEX01) can be set with the format $[value], e.g. $[01] or $[6F,FF,00,1F].
Enclosure
Specify the enclosure character used in the target file. Special characters (e.g. CHAR HEX01)
can be set with the format $[value], e.g. $[01] or $[6F,FF,00,1F].
NIO buffer
This is the size of the read buffer. It represents the amount of bytes that is read in one time
size
from disk.
Lazy
conversion
The lazy conversion algorithm tries to avoid unnecessary data type conversions and can
result in a significant performance improvements if this is possible. For example, reading from
a text file and writing back to a text file.
Header row
present?
Select this option if the target file contains a header row containing column names.
Add filename
to result
Adds the CSV filename(s) to the result of this transformation. A unique list is being kept in
memory that can be used in the next job entry in a job, for example in another transformation.
The row
number field
name (
optional)
The name of the Integer field that will contain the row number in the output of this step.
Running in
parallel?
Select if you have multiple instances of this step running (step copies) and if you want each
instance to read a separate part of the CSV file(s).
When reading multiple files, the total size of all files is taken into consideration to split the
workload. And make sure that ALL step copies receive all files that need to be read, otherwise
, the parallel algorithm will not work correctly.
WARNING:
For technical reasons, parallel reading of CSV files is only supported on files that don't have
fields with line breaks or carriage returns in them.
File encoding
Specify the encoding of the file being read.
Fields Table
Displays an ordered list of fields to be read from the target file.
Preview
Click to preview the data coming from the target file.
button
Get Fields
button
Click to return a list of fields from the target file based on the current settings (i.e. Delimiter,
Enclosure, etc.). All fields identified will be added to the Fields Table.
The Text File Input step allows you to migrate data from a variety of different text-file types.
Text File Input
The Text File Input step provides you with the ability to specify a list of files to read, or a list of directories with
wild cards in the form of regular expressions. In addition, you can accept filenames from a previous step making
filename handling more even more generic.
Text file input step fields and description (click to expand)
BMC Atrium Core 9.0
Page 776 of 2268
Home
Step

Field
Description
File tab
File or
This field specifies the location and/or name of the input text file.
directory
Click Add to add the file/directory/wildcard combination to the list of selected files (grid).
Regular
Specify the regular expression you want to use to select the files in the directory specified in
Expression
the previous option. For example, you want to process all files that have a .txt extension.
Exclude
Specify the regular expressions you want to exclude.
Regular
Expression
Selected
files table
Displays a list of selected files (or wildcard selections) along with a property specifying if file is
required or not. If a file is required and it isn't found, an error is generated. Otherwise, the
filename is skipped.
Accept
filenames
from
previous
step
This option allows even more flexibility in combination with other steps such as "Get Filenames
". You can construct your filename and pass it to this step. This way the filename can come
from any source: text file, database table, etc.
Pass
Select if you want to pass through fields from previous step.
Select this option to get filenames from previous steps.
through
fields from
previous
step
Step to read
filenames
from
Specify the step from which to read the filenames.
Field in input
to use as
Text File Input looks in this step to determine which filenames to use.
filename
Show
filenames(s).
..
Displays a list of all files that will be loaded based on the current selected file definitions.
Show file
content
Displays the content of the selected file.
Show
content from
first data line
Displays the content from the first data line only for the selected file.
Content tab
The content tab allows you to specify the format of the text files that are being read.
File type
Can be either CSV or Fixed length. Based on this selection, Atrium Integrator Spoon launches
a different helper GUI when you click the Get fields button in the Fields tab.
Separator
BMC Atrium Core 9.0
Specify one or more characters that separate the fields in a single line of text. Typically this is ;
or a tab. Special characters (e.g. CHAR ASCII HEX01) can be set with the format $[value], for
example, $[01] or $[6F,FF,00,1F].
Page 777 of 2268
Home
Step

Field
Description
Enclosure
Some fields can be enclosed by a pair of strings to allow separator characters in fields. The
enclosure string is optional. If you use repeat an enclosures allow text line 'Not the nine o''
clock news.'. With ' the enclosure string, this gets parsed as Not the nine o'clock news. Special
characters (e.g. CHAR ASCII HEX01) can be set with the format $[value], for example, $[01]
or $[6F,FF,00,1F].
Escape
Specify an escape character (or characters) if you have these types of characters in your data.
If you have \ as an escape character, the text 'Not the nine o\'clock news' (with ' the enclosure)
gets parsed as Not the nine o'clock news. Special characters (e.g. CHAR HEX01) can be set
with the format $[value], for example, $[01] or $[6F,FF,00,1F].
Header
Select if your text file has a header row (first lines in the file). You can specify the number of
times the header lines appears.
Footer
Select if your text file has a footer row (last lines in the file). You can specify the number of
times the footer row appears.
Wrapped
lines
Use if you deal with data lines that have wrapped beyond a specific page limit.
Note:
Headers and footers are never considered wrapped.
Page layout
Use these options as a last resort when dealing with texts meant for printing on a line printer;
use the number of document header lines to skip introductory texts and the number of lines per
page to position the data lines.
Compression
Select if your text file is placed in a Zip or GZip archive.

Note:
Currently, only the first file in the archive is read.
No empty
rows
Select if you do not send empty rows to the next steps.
Include
filename in
output
Select if you want the filename to be part of the output.
Rownum in
output
Select if you want the row number to be part of the output
Format
Can be either DOS, UNIX or mixed. UNIX files have lines that are terminated by line feeds.
DOS files have lines separated by carriage returns and line feeds. If you specify mixed, no
verification is done.
Encoding
Specify the text file encoding to use; leave blank to use the default encoding on your system.
To use Unicode, specify UTF-8 or UTF-16. On first use, Spoon searches your system for
available encodings.
Limit
Sets the number of lines that is read from the file; zero (0) means read all lines.
Be lenient
when
parsing
dates
Deselect, if you want strict parsing of data fields. If case-lenient parsing is selected, dates like
Jan 32nd will become Feb 1st.
BMC Atrium Core 9.0
Page 778 of 2268
Home
Step

Field
Description
The date
This locale is used to parse dates that have been written in full such as "February 2nd, 2006;"
format locale
parsing this date on a system running in the French (fr_FR) locale would not work because
February is called Fvrier in that locale.
Add
filenames to
result
Select to add output file names as a field in the results.
Error
Handling
tab
The error handling tab allows you to specify how the step reacts when errors occur.
Ignore errors
Select if you want to ignore errors during parsing.
?
Skip error
lines
Select if you want to skip those lines that contain errors. You can generate an extra file that
contains the line numbers on which the errors occurred. Lines with errors are not skipped, the
fields that have parsing errors, will be empty (null).
Error count
field name
Add a field to the output stream rows. This field contains the number of errors on the line.
Error fields
field name
Add a field to the output stream rows. This field contains the field names on which an error
occurred.
Error text
field name
Add a field to the output stream rows. T

This field contains the descriptions of the parsing errors that have occurred.
Warning files
directory
When warnings are generated, they are placed in this directory. The name of that file is <
Error files
directory
When errors occur, they are placed in this directory. The name of the file is <errorfile_dir>/
Failing line
numbers file
directory
When a parsing error occurs on a line, the line number is placed in this directory. The name of
Filters tab
The filters tab provides you with the ability to specify the lines you want to skip in the text file.
Filter string
Specify the string for which to search.
Filter
position
Specify the position where the filter string has to be at in the line. Zero (0) is the first position in
the line. If you specify a value below zero (0), the filter string is searched for in the entire string.
Stop on filter
Specify Y if you want to stop processing the current text file when the filter string is
encountered.
Positive
match
Includes the rows where the filter condition is found (include). The alternative is that those
rows are avoided (exclude).
Fields tab
The fields tab allows you to specify the information about the name and format of the fields
being read from the text file.
Name
Name of the field.
Type
Type of the field can be either String, Date or Number.
BMC Atrium Core 9.0
warning dir>/filename.<date_time>.<warning extension>.
filename.<date_time>.<errorfile_extension>.
that file is <errorline dir>/filename.<date_time>.<errorline extension> .
Page 779 of 2268
Home
Step

Field
Description
Format
Length
For Number: Total number of significant figures in a number.
For String: total length of string.
For Date: length of printed output of the string (e.g. 4 only gives back the year).
Precision
For Number: Number of floating point digits.
For String, Date, Boolean: unused.
Currency
Used to interpret numbers like $10,000.00 or E5.000,00
Decimal
A decimal point can be a "." (10;000.00) or "," (5.000,00)
Group
A grouping can be a dot "," (10;000.00) or "." (5.000,00)
Null If
Treat this value as NULL.
Default
Default value in case the field in the text file was not specified (empty).
Trim type
Type trim this field (left, right, both) before processing.
Repeat
If the corresponding value in this row is empty, repeat the one from the last time it was not
empty.
Get Data From XML allows you to read data from any type of XML file using XPath specifications. Get Data From
XML step can read data from 3 kind of sources (files, stream and url) in 2 modes (user can define files and urls at
static mode or in a dynamic way).
Get Data from
XML
Get Data from XML step fields and description (click to expand)
Field
Description
File tab
The Files tab is where you define the location of the XML files from which you want to read.
XML
source is
defined in a
field
Select if the previous step is giving XML data in a certain field in the input stream.
XML
source is
file name
Select if the previous step is giving filenames in a certain field in the input stream. These are
read.
Read
source as
Url
Select if the previous step is giving URLs in a certain field in the input stream. These are read.
Get XML
source from
a field
Specify the field to read XML, filename or URL from.
BMC Atrium Core 9.0
Page 780 of 2268
Home
Step

Field
Description
File or
directory
Specify the location and/or name of the input text file. Note: Click Add to add the file/directory/
wildcard combination to the list of selected files (grid) below.
Regular
Specify the regular expression you want to use to select the files in the directory specified in the
Expression
previous option.
Exclude
Regular
Expression
Selected
Files from where the data is pulled.
Files
Show
filename(s)
Contains a list of selected files (or wildcard selections) and a property specifying if file is
required or not. If a file is required and it is not found, an error is generated;otherwise, the file
name is skipped.
Content
tab
Loop XPath
For every "Loop XPath" location we find in the XML file(s), we will output one row of data. This
is the main specification we use to flatten the XML file(s). Click Get XPath nodes to search for
the possible repeating nodes in the XML document. Please note that if the XML document is
large that this can take a while.
Encoding
The XML filename encoding in case none is specified in the XML documents. (yes, those still
exist)
Namespace
Select to make the XML document namespace aware.
aware
Ignore
comments
Ignore all comments in the XML document while parsing.
Validate
XML
Validate the XML prior to parsing. Use a token when you want to replace dynamically in a Xpath
field value. A token is between @_ and - (@_fieldname-). Please see the Example 1 to see how
it works.
Use token
A token is not related tro XML parsing but to PDI.
Ignore
empty file
An empty file is not a valid XML document. Select this if you want to ignore those altogether.
Do not
raise an
error if no
files
Select if you don't want to raise an error if no files are found.
Limit
Limits the number of rows to this number (zero (0) means all rows).
Prune path
to handle
large files
Almost the same value as the "Loop XPath" property with some exceptions.
Include
filename in
output?
Select if you want to specify a field name to include the file name (String) in the output of this
step.
BMC Atrium Core 9.0
Page 781 of 2268
Home
Step

Field
Description
Rownum in
Select if you want to specify a field name to include the row number (Integer) in the output of
output?
this step.
Add files to
result
filesname
Adds the XML filenames read to the result of this transformation. A unique list is being kept in
memory that can be used in the next job entry in a job, for example in another transformation.
Fields tab
Name
The name of the output field.
XPath
The path to the element node or attribute to read
Element
The element type to read: Node or Attribute
Type
The data type to convert to
Format
The format or conversion mask to use in the data type conversion
Length
The length of the output data type
Precision
The precision of the output data type
Currency
The currency symbol to use during data type conversion
Decimal
The numeric decimal symbol to use during data type conversion
Group
The numeric grouping symbol to use during data type conversion
Trim type
The type of trimming to use during data type conversion
Repeat
Repeat the column value of the previous row if the column value is empty (null)
Excel Input step allows you to migrate data from Excel files into BMC Atrium CMDB.
Excel Input step fields and description (click to expand)
Excel Input

Field
Description
Files tab
File or
directory
Specify the file name from where you want to pull the data.
Regular
Expression
Specify the regular expression you want to use to select the files in the directory specified in the
previous option.
Exclude
Regular
Expression
Selected
Files
A list of files that will be used in this step, according to the criteria specified in the previous fields.
BMC Atrium Core 9.0
Page 782 of 2268
Home
Step

Field
Description
Accept
Select to retrieve a list of filenames from the previous step in this transformation. You must also
filenames
from
specify which step you are importing from, and the input field in that step from which you will
previous
step
retrieve the filename data. If you choose this option, the Show filename(s) option will show a
preview of the list of filenames.
Sheets tab
List of
sheets to
A list of worksheets that you want to use. If this remains empty, all worksheets in all specified
files will be selected. Rows and columns are numbered, starting with 0.
read
Get
sheetname
(s)
Click to retrieve a list of worksheets from all of the specified files and give you the option to
select some or all of them for this step.
Content
tab
Header
Select if there is a header row to skip in the selected worksheets.
No empty
row
Select if you want to remove empty rows from the output.
Stop on
empty row
Select if you want to stop reading from the current worksheet when an empty row is read.
Limit
Sets a static number of rows to read. If set to 0, there is no set limit.
Encoding
Specifies the text file encoding to use. Leave blank to use the default encoding on your system.
To use Unicode, specify UTF-8 or UTF-16. On first use, Spoon searches your system for
Spread
sheet type
(engine)
Specifies which spreadsheet format to expect from the file, regardless of its extension.
Add
filenames
to result
Select to pass the input filenames to the output.
Error
Handling
tab
Strict types
?
Select if you want PDI to report data type errors in the input.
Ignore
errors?
Select if you don't want no errors to be reported during input parsing.
Skip error
Select if you want PDI to skip lines that contain errors. These lines can be dumped to a separate
lines?
file by specifying a path in the Failing line numbers files directory field below. If this is not
selected, lines with errors appear as NULL values in the output.
Directory in which to create files that contain warning messages regarding input values for each
spreadsheet file read. These files will have the extension you specify here.
BMC Atrium Core 9.0
Page 783 of 2268
Home
Step

Field
Description
Warning
files
directory
Error files
directory
Directory in which to create files that contain error messages regarding input values for each
spreadsheet file read. These files will have the extension you specify here.
Failing line
Directory in which to create files that contain the lines that failed error checks during input
numbers
files
validation. These files will have the extension you specify here.
directory
Fields tab
Name
The name of the field.
Type
The field's data type; String, Date or Number.
Length
The length option depends on the field type.

Number: total number of significant figures in a number.
String: total length of a string.
Date: determines how much of the date string is printed or recorded.
Precision
The precision option depends on the field type, but only Number is supported; it returns the
number of floating point digits.
Trim type
Truncates the field (left, right, both) before processing. Useful for fields that have no static length
.
Repeat
If set to Y, will repeat this value if the next field is empty.
Format
The format mask (number type).
Currency
Symbol used to represent currencies.
Decimal
A decimal point; this is either a dot or a comma.
Grouping
A method of separating units of thousands in numbers of four digits or larger. This is either a dot
or a comma.
Additional
output
fields tab
Full
filename
field
The full file name plus the extension.
Sheetname
field
The worksheet name you're using.
Sheet row
nr field
The current sheet row number.
Row nr
written field
Number of rows written.
BMC Atrium Core 9.0
Page 784 of 2268
Home
Step

Field
Description
Short
filename
field
Extension
field
The three- or four-letter file type extension.
Path field
Output
AROutput is a BMC provided step. It allows you to export data onto AR system.
AROutput step fields and description (click to expand)
AROutput

Field
Description
General tab
Step name
Name of the step; this name has to be unique in a single

transformation.
Connection
Specify the the database connection to which data is written.
Form Name
Specify the AR form name where you want to push the data.
Batch Commit Size
Specify the amount of data you want to commit in one batch.
Fallback to single row commit if batch

commit fails
Select if you want to proceed with single row commit if batch

commit fails.
Duplicates tab
Duplicate Request Action
Select the data duplication conditions.
Match By Request ID
Select if you want to match the data and update by request ID.
Data Handling tab

Require Required Fields
Is selected by default if you select Match by Request ID.
Enforce Pattern Matching
Is selected by default if you select Match by Request ID.
Field Mapping tab

Merge Fields
Use to map the form field to stream field.
CMDBOutput is a BMC provided step. It allows you to load data into BMC Atrium CMDB.
CMDBOutput step fields and description (click to expand)
CMDBOutput

Field
Description
Step name
Name of the step; this name has to be unique in a single transformation.
BMC Atrium Core 9.0
Page 785 of 2268
Home
Step

Field
Description
Connection
The database connection to which data is written.
Class Name
Specify the CMDB form name from where you want to push the data.
NameSpace
Specify the BMC namespace. For example BMC.Core
Dataset ID
Specify the BMC dataset ID. For example, BMC.ASSET
CMI Commit Size

Qualification
String
Only insert new
Select if you want to update only new CIs.
CIs
Always insert CIs
Select if you want to transfer all source records to BMC Atrium CMDB without checking
for duplicates. See, Inserting or updating bulk records in BMC Atrium CMDB
Use Cache
Select if you want to insert or update bulk records in BMC Atrium CMDB. See, Increasing
cache size for Atrium Integrator.
Use CheckSum
Select if you want to use the CheckSum feature to update records in BMC Atrium CMDB.
See, Configuring the checksum value for loading data into BMC Atrium CMDB .
The key(s) to
lookup the value(s
)
Update fields
Edit Mapping
The Table output step allows you to load data into a database table.
Table Output
BMC supports selective vendor databases which include IBM DB2, MS SQL Server, Oracle, Sybase, and My
SQL.
Table Output step fields and description (click to expand)
Field
Description
Step name
Connection
Specify the database connection to which data is written.
Target
Schema
Specify the name of the Schema for the table to write data to. This is important for data
sources that allow for table names with periods in them.
Target table
Specify the name of the table to which data is written.
Commit size
Use transactions to insert rows in the database table. Commit the connection every N rows if
N is larger than zero (0); otherwise, don't use transactions. (Slower).
Note: Transactions are not supported on all database platforms.
Truncate table
BMC Atrium Core 9.0
Select if you want the table to be truncated before the first row is inserted into the table.
Page 786 of 2268
Home
Step

Field
Description
Note: Don't use this option when you are running the transformation clustered.
Main options
tab
Partition data
over tables
Use to split the data over multiple tables.
Use batch
Select if you want to use batch inserts. This feature groups inserts statements to limit round
updates for
inserts
trips to the database. This is the fastest option and is enabled by default. This feature is not
available under these conditions: If the transformation database is transactional, if you are
using Greenplum or PostgreSQL with error handling turned on, if you are using
auto-generated keys.
Is the name of
the table
defined in the
field?
Use these options to split the data over one or more tables; the name of the target table is
defined in the field you specify. For example if you store customer data in the field gender,
the data might end up in tables M and F (Male and Female). There is an option to exclude
the field containing the tablename from being inserted into the tables.
Return
auto-generated
key
Select if you want to get back the key that was generated by inserting a row into the table.
Name of
auto-generated
key field
Specifies the name of the new field in the output rows that contains the auto-generated key.
SQL
Generates the SQL to create the output table automatically.
Database
fields tab
Fields to insert
Add Mapping
The Text file output step is used to export data to text file format. This is commonly used to generate Comma
Separated Values (CSV files) that can be read by spreadsheet applications. It is also possible to generate fixed
width files by setting lengths on the fields in the fields tab.
Text File
Output
Text File Output step fields and description (click to expand)

Field
Description
File tab
The File tab is where you define basic properties about the file being created.
Step name
Filename
Specify the filename and location of the output text file.
Run this as a
command
instead?
Select if you want to "pipe" the results into the command or script you specify.
Select if you don't want to create the file until the end of the step.
BMC Atrium Core 9.0
Page 787 of 2268
Home
Step

Field
Description
Do not
create file at
start?
Extension
Adds a point and the extension to the end of the filename. (.txt)
Accept file
name from
Select if you want to specify the filename(s) in a field in the input stream.
field?
File name
field
When the previous option is enabled, you can specify the field that will contain the filename(s)
at runtime.
Include
stepnr in
If you run the step in multiple copies (Launching several copies of a step), the copy number is
included in the filename, before the extension.
filename
Include
partition nr in
filename?
Select if you want to includes the data partition number in the filename.
Include date
Select if you want to includes the system date in the filename.
in filename
Include time
in filename
Select if you want to includes the system time in the filename.
Specify date
format
Select if you want the filename to include a date and time stamp that follows the selection you
choose from the drop-down box. Selecting this option disables the previous two options.
Show
filename(s)
This option shows a list of the files that will be generated.
Add
filenames to
result
Select if you want to use the Filename field in constructing the result filename. If deselected,
the Filename field is ignored.
Note: This is a simulation and among others depends on the number of rows that will go into
each file.
Content tab
Append
Select if you want to append lines to the end of the specified file.
Separator
Specify the character that separates the fields in a single line of text. Typically this is ; or a tab.
Enclosure
A pair of strings can enclose some fields. This allows separator characters in fields. The
enclosure string is optional.
Force the
Select if you want to force all field names to be enclosed with the character specified in the
enclosure
around fields
Enclosure property above.
?
Disable the
enclosure fix
?
BMC Atrium Core 9.0
This is for backward compatibility reasons (since version 4.1) related to enclosures and
separators. The logic since version 4.1 is: When a string field contains an enclosure it gets
enclosed and the enclose itself gets escaped. When a string field contains a separator, it gets
Page 788 of 2268
Home
Step

Field
Description
enclosed. Check this option, if this logic is not wanted. It has also an extra performance burden
since the strings are scanned for enclosures and separators. So when you are sure there is no
such logic needed since your strings don't have these characters in there and you want to
improve performance, un-check this option.
Header
Select if you want the text file to have a header row. (First line in the file).
Footer
Select if you want the text file to have a footer row. (Last line in the file).
Format
This can be either DOS or UNIX. UNIX files have lines are separated by linefeeds. DOS files
have lines separated by carriage returns and line feeds.
Encoding
Specify the text file encoding to use. Leave blank to use the default encoding on your system.
To use Unicode specify UTF-8 or UTF-16. On first use, Spoon will search your system for
Compression
Allows you to specify the type of compression, .zip or .gzip to use when compressing the
output.
Note: Currently, only one file is placed in a single archive.
Right pad
fields
Select if you want to add spaces to the end of the fields (or remove characters at the end) until
they have the specified length.
Fast data
dump (no
formatting
Select if you want to improve the performance when dumping large amounts of data to a text
file by not including any formatting information.
Split every ...

rows
If this number N is larger than zero, split the resulting text-file into multiple parts of N rows.
Add Ending
line of file
Select if you want to specify an alternate ending row to the output file.
Fields tab
The fields tab is where you define properties for the fields being exported.
Name
Type
Type of the field can be either String, Date or Number.
Format
The format mask to convert with. See Number Formats for a complete description of format
symbols.
Length
The length option depends on the field type follows:

Number - Total number of significant figures in a number
String - total length of string
Date - length of printed output of the string (e.g. 4 only gives back year)
Precision
The precision option depends on the field type as follows:

Number - Number of floating point digits
String - unused
Date - unuse
Currency
Symbol used to represent currencies like $10,000.00 or E5.000,00
Decimal
A decimal point can be a "." (10,000.00) or "," (5.000,00)
BMC Atrium Core 9.0
Page 789 of 2268
Home
Step

Field
Description
Group
A grouping can be a "," (10,000.00) or "." (5.000,00)
Trim type
The trimming method to apply on the string. Trimming only works when there is no field length
given.
Null
If the value of the field is null, insert this string into the textfile.
Get
Click to retrieve the list of fields from the input fields stream(s)
Minimal
width
Alter the options in the fields tab in such a way that the resulting width of lines in the text file is
minimal. So instead of save 0000001, we write 1, etc. String fields will no longer be padded to
their specified length.
The Insert/Update step first looks up a row in a table using one or more lookup keys. If the row can't be found, it
inserts the row. If it can be found and the fields to update are the same, nothing is done. If they are not all the
same, the row in the table is updated.
Insert\Update
Note: If you have multiple rows with the same keys that match, only the first row found is compared. This may
lead to different results, depending on if the found row matches with given values or not. The update scenario
looks like this: If a difference is found in the case of multiple rows with the same key, an UPDATE statement is
fired against the database that updates all rows with the matching keys. This note also applies to the Update step
.
Insert\Update step fields and description (click to expand)
Field
Description
Step name
Connection
Specify the database connection to which data is written.
Target
schema
Specify the name of the Schema for the table to which data is written. This is important for
data sources that allow for table names with periods in them.
Target table
Name of the table in which you want to do the insert or update.
Commit size
The number of rows to change (insert / update) before running a commit.
Don't
perform any
updates
Select if you want the values in the database to be never updated and only inserts are
performed.
Key Lookup
table
Allows you to specify a list of field values and comparators. You can use the following
comparators: =, <>, <, <=, >, >=, LIKE, BETWEEN, IS NULL, IS NOT NULL
Note: Click Get fields to retrieve a list of fields from the input stream(s).
Update
Fields
Allows you to specify all fields in the table you want to insert/update including the keys. Avoid
updates on certain fields by specifying N in the update column.
Note: Click Get Update fields to retrieve a list of update fields from the input stream(s).
SQL button
Click SQL to generate the SQL to create the table and indexes for correct operation.
This XML Output step allows you to write rows from any source to one or more XML files.
BMC Atrium Core 9.0
Page 790 of 2268
Home
Step

XML Output step fields and description (click to expand)
XML Output
Field
Description
File tab
The file tab is where you set general properties for the XML output file format
Step name
Filename
Specify the file name and location of the output text file
Do not create
file at start
Extension
Adds a period and the extension to the end of the file name (.xml)
Include
If you run the step in multiple copies (see also Launching Several Copies of a step), the copy
stepnr in
number is included in the file name, before the extension
filename
Include date
in filename
Select if you want to include the system date in the file name
Include time
in filename
Select if you want to include the system date in the file name
Specify Date
time format
Select if you want the filename to include a date and time stamp that follows the selection you
Add
filenames to
result
Select if you want to use the Filename field in constructing the result filename. If deselected,
the Filename field is ignored.
Content tab
Zipped
Select if you want the XML file to be stored in a ZIP archive.
Encoding
The encoding to use. This encoding is specified in the header of the XML file.
Parent XML
element
The name of the root element in the XML document.
Row XML
element
The name of the row element to use in the XML document.
Split every ...

rows.
The maximum number of rows of data to put in a single XML file before another is created.
Omit null
values from
XML Output
Fields tab
Fieldname
Elementname
The name of the element in the XML file to use. Type: Type of the field can be either String,
Date, or Number.
Type
Type of the field can be either String, Date, or Number. Format mask from which to convert.
BMC Atrium Core 9.0
Page 791 of 2268
Home
Step

Field
Description
Length
The length option depends on the field type follows:

Number - Total number of significant figures in a number
String - total length of string
Date - length of printed output of the string (e.g. 4 only gives back year)
Note: the output string is padded to this length if it is specified.
Precision
The precision option depends on the field type as follows:

Number - Number of floating point digits
String - unused
Date - unused
Currency
Symbol used to represent currencies such as $10,000.00 or E5.000,00.
Decimal
A decimal point can be a "." (10,000.00) or "," (5.000,00).
Group
A grouping can be a "," (10,000.00) or "." (5.000,00).
Null
If the value of the field is null, insert this string into the textfile.
Get fields
Click to retrieve the list of fields from the input stream(s).
Minimal width
Alter the options in the fields tab in such a way that the resulting width of lines in the text file is
minimal; for example instead of save 0000001, "1" is written, and so on. String fields are not
padded to their specified length.
The Excel Output step allows you to write data to one or more Excel files.
Excel Output step fields and description (click to expand)
Excel Output

Field
Description
File tab
Filename
The name of the spreadsheet file you are reading from.
Do not
create file
at start
Extension
The three-letter file extension to append to the file name.
Include
stepnr in
filename
If you run the step in multiple copies (launching several copies of a step), the copy number is
included in the file name, before the extension.
Include
date in
filename
Select if you want to include the system date in the filename
Include
time in
filename
Select if you want to include the system time (24-hour format) in the filename
BMC Atrium Core 9.0
Page 792 of 2268
Home
Step

Field
Description
Specify
Select if you want the filename will to include a date and time stamp that follows the selection you
Date time
format
Show file
name(s)
Displays a list of the files that will be generated. This is a simulation and depends on the number
of rows that will go into each file.
Add
Select if you want to use the Filename field in constructing the result filename. If deselected, the
filenames
to result
Filename field is ignored.
Content
tab
Append
Select if you want to append lines to the end of the specified file. If the file does not exist, a new
one will be created.
Header
Select if you want a header to appear before the spreadsheet grid data.
Footer
Select if you want a footer to appear after the spreadsheet grid data.
Encoding
Specifies the text file encoding to use. Leave blank to use the default encoding on your system.
To use Unicode, specify UTF-8 or UTF-16. On first use, Spoon searches your system for available
encodings and populates this list accordingly.
Split
every ...
rows
Specify after how many rows, start a new spreadsheet file to continue data output.
Sheet
name
Specifies the name of the worksheet within the spreadsheet file.
Product
sheet?
Select if you want to enable password protection on the worksheet. You must also specify a
password in the Password field.
Auto size
columns
Select if you want to, automatically size the worksheet columns to the largest value.
Retain
NULL
values
Select if you want to preserve NULL values in the output. If deselected, NULLs are replaced with
empty strings.
Use
Template
Select if you want PDI to use the specified Excel template to create the output file. The template
must be specified in the Excel template field.
Append
to Excel
Select if you want append output to the specified Excel template.
Fields
tab
Name
Type
The field's data type; String, Date or Number.
Format
The format mask (number type).
Update is similar to the Insert/Update step except that updates only are performed. No inserts are performed.
BMC Atrium Core 9.0
Page 793 of 2268
Home
Step

Update step fields and description (click to expand)
Update
Field
Description
Step name
Connection
Specify the database connection to which data is written
Target
schema
Specify the name of the Schema for the table to which data is written. This is important for data
sources that allow for table names with periods in them.
Target
table
Name of the table in which you want to do the insert or update.
Commit
size
Specify the number of rows to change (insert / update) before running a commit.
Skip
lookup
Ignore
lookup
failure
Key
Lookup
table
Allows you to specify a list of field values and comparators. You can use the following
comparators: =, <>, <, <=, >, >=, LIKE, BETWEEN, IS NULL, IS NOT NULL
Note: Click Get fields to retrieve a list of fields from the input stream(s).
Update
Fields
Allows you to specify all fields in the table you want to update including the keys. Avoid updates
on certain fields by specifying N in the update column.
Note: Click Get Update fields to retrieve a list of update fields from the input stream(s).
SQL
button
Click SQL to generate the SQL to create the table and indexes for correct operation.
Transform
Adds constant values to the specified field in the destination data source. For example, Calbro Services can add
Disk drive as the Short Description value when transferring disc drive information from their SQL table to the
BMC_Disc Drive CI class.
Add
Constants
Add Constants step fields and description (click to expand)

Field
Description
Step
name
Fields
Specify the name, type, and value in the form of a string. Then, specify the formats to convert the
value into the chosen data type.
This Select values step is useful for selecting, renaming, changing data types and configuring the length and
precision of the fields on the stream. These operations are organized into different categories:
BMC Atrium Core 9.0
Page 794 of 2268
Home
Step

Select & Alter - Specify the exact order and name in which the fields have to be placed in the output rows
Remove - Specify the fields that have to be removed from the output rows
Meta-data - Change the name, type, length and precision (the meta-data) of one or more field
Select Values
Select Values step fields and description (click to expand)
Field
Description
Select &
Alter tab
Step name
Fields
Allows you to rename a field and specify the length and precision.
Get fields
Click to insert fields from all input steams to the step.
to select
Edit
Mapping
Click to open a mapping dialog to easily define multiple mappings between source and target
fields.
Note: Works if there is only one target output step.
Include
unspecified
fields,
ordered by
name
Select if you want to implicitly select all other fields from the input stream(s) that are not explicitly
selected in the Fields section
Remove
tab
This tab allows you to enter the fields that you want removed from the stream. You can also click
Get fields to remove to add all fields from the input stream(s). This makes it easier if you are
trying to remove several fields. After getting all fields, delete any of the fields that you do not
want remove from the stream.
Field name
Get fields
to remove
Click to add all fields from the input stream(s).
Meta-data
tab
This tab allows you to rename, change data types, and change the length and precision of fields
coming into the Select Values step. Click Get fields to import fields from previous steps.
A lot of data type conversions are also possible with this tab.
Fields to
alter the
meta data
for
Get fields
to change
The Sort rows step sorts rows based on the fields you specify and on whether they should be sorted in ascending
or descending order.
Sort Rows
Notes:
BMC Atrium Core 9.0
Page 795 of 2268
Home
Step

Kettle has to sort rows using temporary files when the number of rows exceeds the specified sort size (
default 1 million rows). When you get an out of memory exception (OOME), you need to lower this size of
change your available memory.
When you use multiple copies of the step in parallel (on the local JVM with "Change number of copies to
start" or in a clustered environment using Carte) each of the sorted blocks need to be merged together to
ensure the proper sort sequence. This can be done, be adding the Sorted Merge step afterwards (on the
local JVM without multiple copies to start or in the cluster on the master).
Sort Rows step fields and description (click to expand)
Field
Description
Step name
Sort
The directory in which the temporary files are stored in case when needed; the default is the
directory
standard temporary directory for the system
TMP-file
prefix
Choose an easily recognized prefix so you can identify the files when they show up in the temp
directory.
Sort size (
rows in
memory)
Free
memory
If the sort algorithm finds that it has less available free memory than the indicated number, it will
start to page data to disk.
threshold (
in %)
Note: This is not exact, because:

This is checked every 1000 rows. Depending on the row size and other steps within
complex transformations this could still lead to an OutOfMemoryError.
In a Java Virtual Machine it's not possible to know the exact amount of free memory. As
such BMC recommends you don't use this for very complex transformations with other
steps and processes that use up a lot of memory.
Compress
TMP Files
Select if you want to compress temporary files when they are needed to complete the sort.
Only pass
unique
rows?
Select if you want to pass unique rows only to the output stream(s).
Fields table
Specify the fields and direction (ascending/descending) to sort. You can specify whether to
perform a case sensitive sort (optional)
Get Fields
Click to retrieve a list of all fields coming in on the stream(s).
Provides you with predefined functions that can be executed on input field values. For example, Calbro Services
can calculate the total cost of the computer systems in all their sites and add that information to BMC Atrium
CMDB.
Calculator
For more information, see the
Using the Calculator step video.
Scripting
BMC Atrium Core 9.0
Page 796 of 2268
Home
Step
Modified Java
Script Value

Provides an expression-based user interface for building JavaScript expressions. Allows you to create multiple
scripts for each step. For example, Calbro Services can create an if/then/else statement to identify the operating
system of a computer based on its serial number. The script can also include the concatenate function, which
creates a work group by appending the virtual machine type to the operating system.
Modified Java Script Value step fields and description (click to expand)
Field
Description
Step
name
Java
This section provides a tree view of your available scripts, functions, input fields and output fields.
script
functions
Transformation Scripts: displays a list of scripts you have created in this step
Transformation Constants: a list of pre-defined, static constants including
SKIP_TRANSFORMATION, ERROR_TRANSFORMATION, and
CONTINUE_TRANSFORMATION
Transformation Functions: contains a variety of String, Numeric, Date, Logic and
specialized functions you can use to create your script. To add a function to your script,
simply double-click on the function or drag it to the location in your script that you wish to
insert it.
Input Fields: a list of inputs coming into the step. Double-click or use drag and drop to insert
the field into your script.
Output Fields: a list of outputs for the step.
Java
Script
This section is where you edit the script for this step. You can insert functions, constants, input
fields, etc. from the tree control on the left by double-clicking on the node you wish to insert or by
dragging the object onto the Java Script panel.
Fields
The Fields table contains a list of variables from your script including the ability to add metadata
like a descriptive name.
Get
Variables
Click to retrieve a list of variables from your script.
Test
Click to test the syntax of your script.
script
Flow
Allows you to filter rows based on conditions and comparisons. After this step is connected to a previous step,
you can click the "<field>", "=" and "<value>" areas to construct a condition.
Filter rows
Filter rows step fields and description (click to expand)

Field
Description
Step name
Send 'true' data to

step
The rows for which the condition specified is true are sent to this step.
The rows for which the condition specified are false are sent to this step
BMC Atrium Core 9.0
Page 797 of 2268
Home
Step

Field
Description
Send 'false' data to

step
The Condition
Click NOT to negate the condition.

Click <Field> to select from a list of fields from the input stream(s) to build your
condition(s).
Click <value> button to enter a specific value into your condition(s).
To delete a condition, right-click and select Delete Condition.
Add Condition
Click to add a condition
Implements the Switch/Case statement found in popular programming languages like Java. Pentaho routes rows
of data to one or more target steps based on the value encountered in a certain field.
Switch/Case
Switch/Case step fields and description (click to expand)

Field
Description
Step name
Field name to switch
Specify the field name that contains the value to use as a bases for the row routing.
Use string contains

Case value data type
Specify the data type of the values specified in this dialog
Case value conversion

mask
Specify the conversion mask of the values specified in this dialog (numeric / date
values)
Case value decimal

symbol
Specify the decimal symbol of the values specified in this dialog (numeric values)
Case value grouping
Specify the grouping symbol of the values specified in this dialog (numeric values)
symbol
Case values
Here you can specify a value-target step pair, one per row.
To specify a null value, simply leave the value column blank while entering a target
step.
Please note that it is possible to specify the same target step more than once.
Default target step
Select all the rows that don't match any of the case values above are sent to this
target step.
Identify last
row in a
stream
Lookup
This is a BMC provided step. Allows you to look up values in the BMC Atrium CMDB based on the primary key
that you specified. Lookup values are added as new fields onto the stream.
BMC Atrium Core 9.0
Page 798 of 2268
Home
Step

CMDB Lookup step fields and description (click to expand)
CMDBLookUp
Field
Description
Step name
Connection
Specify the database connection to the lookup table.
ClassName
Dataset ID
Enable
cache?
Select if you want to enable caching of database lookups. This means that once a key (or group
of key) has been looked up, the looked up values are stored, and returned again the next time
this key (or group of key) is being looked up (without incurring the cost of a database call).
Cache size
on rows
Specify the size of the cache (number of rows).
Load all
data from
table
Select if you want to pre-load the cache with all the data present in the lookup table. This can
improve performance by avoiding database calls.
However, if you have a large table, there is a risk of running out of memory.
Important
In memory look-ups can lead to different results because of the differences in the way your
database compares data. For example, if your database table allows case-insensitive
comparisons, you may get different results with this option. The same goes for data with trailing
spaces. Those are ignored in certain databases when using certain character data types.
The key(s)
to lookup
the value(s
)
The keys and conditions to perform the database lookup.
Values to
return from
the lookup
table
The fields from the lookup table to add to the output stream.
Do not
pass rows
if lookup
fails
Select to avoid passing a row when lookup fails.
Fail on
multiple
results
Select to force the step to fail if the lookup returns multiple results.
Order by
If the lookup query returns multiple results, the ORDER BY clause helps you to select the record
to take. For example, ORDER BY allows you to pick the customer with the highest sales volume
in a specified state.
BMC Atrium Core 9.0
New name: allows you to use a different name if the database column name is
inappropriate.
Default: is the value returned (instead of null) if the lookup fails. Note that enabling error
handling on the Database Lookup step will redirect all failed lookup rows to the error
handling step, instead of adding them to the main output steam with null/default values.
Type: is the type of the output field.
Page 799 of 2268
Home
Step

Field
Description
Get fields
Get lookup
fields
Looks up values in a database table. Lookup values are added as new fields onto the stream.
Database Lookup step fields and description (click to expand)
Database
Lookup

Field
Description
Step name
Connection
Specify the database connection to the lookup table.
Lookup
Schema
Specify the database schema containing the lookup table.
Lookup
table
Name of the database table used for the lookup.
Enable
cache?
Select if you want to enable caching of database lookups. This means that once a key (or group
of key) has been looked up, the looked up values are stored, and returned again the next time
this key (or group of key) is being looked up (without incurring the cost of a database call).
Cache size
on rows
Specify the size of the cache (number of rows).
Load all
data from
table
Pre-loads the cache with all the data present in the lookup table. This can improve performance
by avoiding database calls.
However, if you have a large table, there is a risk of running out of memory.
Important
In memory look-ups can lead to different results because of the differences in the way your
database compares data. For example, if your database table allows case-insensitive
comparisons, you may get different results with this option. The same goes for data with trailing
spaces. Those are ignored in certain databases when using certain character data types.
The key(s)
The keys and conditions to perform the database lookup.
to lookup
the value(s
)
Values to
return from
the lookup
table
The fields from the lookup table to add to the output stream.
New name: allows you to use a different name if the database column name is
inappropriate.
Default: is the value returned (instead of null) if the lookup fails. Note that enabling error
handling on the Database Lookup step will redirect all failed lookup rows to the error
handling step, instead of adding them to the main output steam with null/default values.
Type: is the type of the output field.
Select to avoid passing a row when lookup fails.
BMC Atrium Core 9.0
Page 800 of 2268
Home
Step

Field
Description
Do not
pass rows
if lookup
fails
Fail on
multiple
results
Select to force the step to fail if the lookup returns multiple results.
Order by
If the lookup query returns multiple results, the ORDER BY clause helps you to select the record
to take. For example, ORDER BY allows you to pick the customer with the highest sales volume
in a specified state.
Get fields
Click to return a list of available fields from the input stream(s) of the step.
Get lookup
fields
Click to return a list of available fields from the lookup table that can be added to the step's
output stream.
Jobs
Allows you to get the value of a variable. This step can return rows or add values to input rows.
Get variables
Allows you to set variables in a job or in the virtual machine. It accepts one (and only one) row of data to set the
value of a variable.
Set variables
Editing Atrium Integrator transformation steps

You can right-click on any step in your transformation and perform the actions described in the
following table.
Right-click options for transformation steps

Menu option
Action
Edit step
Opens the selected step so that you can edit it.
Edit step
description
Opens the Step description dialog box so that you can edit the description.
Data movement
Allows you to specify whether you want the selected step to copy all output rows to all target steps, or to
distribute the rows among the target steps.
Change number
of copies to start
from
Allows you to launch the selected step multiple times. For a database lookup step, this might improve
performance by reducing latency. For more information, see Launching several copies of a step in BMC
Copy to
clipboard
Copies the selected step to the clipboard so that you can use it again in the same transformation or a new
transformation.
BMC Atrium Core 9.0
Page 801 of 2268
Home
Menu option
Action
Duplicate step
Creates a duplicate of the selected step.
Delete step
Deletes the selected step.
Hide step
Hides the selected step.
Detach step
Deletes the hops to the selected step.
Show input fields
Determines all the fields and their origin by tracing the input streams back to their source.
Show output
fields
Determines all the fields and their origin by tracing the output streams back to their source.
Align/Distribute
Splits the transformation flow to multiple processing paths.
Check selected
Checks the selected step and displays any warnings and errors.
step
Define error
handling
Allows you to configure a step so that instead of halting a transformation when an error occurs, the rows that
Preview
Displays a list of all the steps in the current transformation.
caused an error are passed to a different step.
Editing Atrium Integrator transformation properties

Transformation settings are the collection of properties that describe the transformation and
configure its behavior.
To edit transformation properties

1. In the BMC Atrium Integrator Spoon window, open the transformation that you want to edit.
2. Select Edit > Settings.
The Transformation properties window appears.
Transformation properties window in BMC Atrium Integrator Spoon
BMC Atrium Core 9.0
Page 802 of 2268
Home
3. In the Transformation tab, edit the Transformation name, Transformation filename,

Description, and Extended description as required.
4. Specify the Status, Version, and Directory of the transformation.
The Created by and Created at fields display the user name of the person who created the
transformation in the Integration Builder wizard and the date and time at which it was created
.
The Last modified by and Last modified at fields display the user name of the person who
is editing the transformation and the date and time it was last modified.
5. Click the Logging tab.
Note
The Performance and Logging channels options on the left panel are not supported
.
6. To view the logging options for the transformation, click Transformation on the left panel:
The Log Connection field displays the host name of the BMC Remedy AR System
database.
BMC Atrium Core 9.0
Page 803 of 2268
6.
Home
The Log table name field displays the name of the table (UDM:TransformationLog) in
which the logs are stored.
The Fields to log area displays the list of fields for which you can enable logging.
In the Step name field, select the step
In the Line input field select the source step.
In the Line update, Line return, Line read, and Line output field, select the output
step name.
In the Line rejected field select the error logging step name.
7. To view the logging options for the steps, click Step on the left panel.
The Log Connection field displays the host name of the BMC Remedy AR System
database.
The Log table name field displays the name of the table (UDM:StepLog) in which the
logs are stored.
The Fields to log area displays the list of fields for which you can enable logging
8. In the Transformation Properties window, click the Dates tab.
9. Specify the date setting.
10. Click the Dependencies tab.
11. Enter the dependencies for the transformation.
For example, if a transformation depends on three lookup tables, ensure that the lookup
tables have not changed. If the values in these lookup tables have changed, extend the date
range to force a full refresh of the transformation. Dependencies allow you to determine if a
table has changed when you have a "data last changed" column in the table. Click Get
dependencies to detect dependencies automatically.
12. Click the Miscellaneous tab.
13. In the Number of rows in rowsets field, change the size of the buffers between the
connected steps in a transformation.
Do not change this parameter unless you are running low on memory, for example.
14. If you want to add a feedback entry into the log file while the transformation is running, select
the Show a feedback row in transformation steps check box.
By default, this feature is enabled and configured to display a feedback record every 5000
rows.
15. In the Feedback size field, enter the number of rows to process before entering a feedback
entry into the log.
Tip
Set this to a higher value when processing large amounts of data to reduce the
amount of information in the log file.
16.
BMC Atrium Core 9.0
Page 804 of 2268
Home
16. If you want to open one unique connection per defined and used database connection in the
transformation, select the Make the transformation database transactional check box.
Enabling this option is required to allow a failing transformation to be rolled back completely.
Enabling this option is also necessary when trying to alter connection settings before a query
using an Execute SQL script step.
17. In the Shared objects field, specify the location of the XML file used to store shared objects
like database connections or clustering schemas.
18. If you want to enable the internal logic for changing the Java thread priorities based on the
number of input and output rows in the rowset buffers, select the Manage thread priorities
check box.
This can be useful in some situations where the cost of using the logic exceeds the benefit of
the thread prioritization.
19. Click the Partitioning tab. The available database partitions are displayed.
20. To create a new partition, click the New button.
21. Click the Monitoring tab.
22. If you want to monitor each step of the transformation as it is running, select the Enable
step performance monitoring check box.
23. To generate the SQL code necessary for creating the logging table, click the SQL button.
The Simple SQL Editor appears, which allows you to execute an SQL statement against the
logging connection.
24. Click OK.
The selected transformation is updated according to the options that you set.
Verifying jobs
After you create your job that includes multiple transformations, you can use the following
procedure to verify all the transformations within a job.
To verify job
1. On the computer where you have the Atrium Integrator Spoon client installed, select Start >
BMC Software > Atrium Integrator > BMC Atrium Integrator Spoon .
BMC Atrium Core 9.0
Page 805 of 2268
Home
permissions.
d. Click OK.
4.
BMC Atrium Core 9.0
Page 806 of 2268
Home
The Repository explorer dialog box shows all the jobs and transformations in the BMC
Repository explorer window with sample jobs and transformations
5. From the Explorer locate the Transformations folder and navigate to the job for which you
want to verify the transformations.
6. Open the job and click the Check job icon (
), all the job transformations are verified one
by one and the verification results are displayed in a dialog box.
7. You can choose to show successful results by using the Show successful results check box.
8. Resolve the results marked as Error and Warning to fix the problems in the transformation.
You can ignore the results marked as Remark.
This verification of job described above does not include global verification such as log
connection.
BMC Atrium Core 9.0
Page 807 of 2268
Home
Launching several copies of a step in Atrium Integrator Spoon

In certain situations, launching multiple copies of a step improves performance. For example, if a
step uses a large amount of CPU (such as a JavaScript step) and you have multiple processor
cores in your computer, launching multiple copies of the step might improve performance. If a step
has to deal with network latencies (such as a database lookup step), launching the same step
several times keeps the database busy on different connections, which lowers the latency.
Recommendation
For all data transfer jobs created by using the Integration Job Builder wizard, the CMDBOutput
step is set to launch three times. Depending on the configuration of your computer, you can
increase the number of copies of the CMDBOutput step to increase the overall throughput of the
data transfer job. BMC recommends that you set the number of copies to no more than ten. You
can also use the following formula:
Number of copies=Number of CPUs x 3 threads
To launch several copies of a step

1. Right-click on the step that you want to launch multiple times, and select Change number of
copies to start.
The Nr of copies of step dialog box appears.
2. Enter the number of times you want to launch this step, and click OK.
The number of steps appears in the upper-left corner of the step icon.
The following figure shows how Atrium Integrator Spoon indicates that a step has been
launched multiple times.
Launching several copies of a step
Changing data mappings in Atrium Integrator Spoon

A data mapping defines how data in the source corresponds to data in the target and which actions
to take when transferring between them. When you created a job in the Integration Job Builder
wizard, you mapped key source columns to corresponding target columns. In Atrium Integrator
Spoon, you can change the data mapping-for example, add a new attribute to import to BMC
Atrium CMDB.
BMC Atrium Core 9.0
Page 808 of 2268
Home
To change data mapping

1. Open your transformation in Atrium Integrator Spoon. For more information, see Opening
Atrium Integrator job or transformation.
The CMDBOutput dialog box appears.
3. In the Update fields section, click in the Table field cell and select the target attribute that
you want to map.
4. In the Stream field cell, select the source field you want to map to the selected attribute.
5. In the Update cell, select Y.
6. Click OK.
The selected attribute is mapped to the specified source column.
Changing the field type in the XML or CSV step input in Atrium Integrator Spoon
By default, the type for all mapped fields that are listed in the XML or CSV step input is set to String
. Based on your requirements, you can manually change the type for specific fields.
To change the field type listed in the XML and XML or CSVstep input
2. Double-click the XML or CSV step input.
3. On the Fields tab, identify the field for which you want to change the type.
4. From the Type column, select the appropriate type.
For Datetype, select the appropriate date format. The date format must be as specified in
the XML file or CSV file.
5. Click OK.
For information about supported external data store types see, Atrium Integrator supported data
types.
Exploring a database connection in Atrium Integrator Spoon

You can explore configured database connections in Atrium Integrator Spoon.
To explore a database connection

2. Click
The Make your selection dialog box appears.
3.
BMC Atrium Core 9.0
Page 809 of 2268
Home
3. Select the database connection that you want to explore, and click OK.
The Database explorer on connection dialog box appears with a list of all the schemas,
tables, and views in the selected connection.
4. Select the table that you want to explore.The Action menu to the right provides quick access
to the following features for the selected table:
Button
What it does
Preview first 100 rows
Returns the first 100 rows from the selected table.
Preview first ... rows of...
Allows you to specify the number of rows to return from the selected table.
Number of rows
Returns the total number of rows that the selected table contains.
Show Layout
Displays a list of column names, data types, and so on from the selected table.
Generate DDL
Generates the DDL to create the selected table based on the current connection type.
Generate DDL for other

connection
Prompts you to select another connection, then generates the DDL to create the selected table
Open SQL
Launches the Simple SQL Editor for the selected table.
Truncate table
Generates a TRUNCATE table statement for the current table.
based on the selected connection type.
Note
For MSQL datastore connection with Window Authentication, you must update the
Domain parameter inside the Database Connection > Options tab. Then add Windows
user's credentials and test the MSQL connection.
Browsing source data in Atrium Integrator Spoon

In Atrium Integrator Spoon, you can browse the source data before running your job or
transformation.
To browse source data

2. Double-click the input step.
The input step dialog box appears.
3. Click Preview.
The Enter preview size dialog box appears.
4. Enter the number of rows of source data that you want to preview.
The Examine preview data dialog box appears with the specified number of rows of data
from the source table or file.
5. Click Show log to view the log file .
6. Click Close when you have finished previewing the data.
BMC Atrium Core 9.0
Page 810 of 2268
Home
Changing source configuration in Atrium Integrator Spoon

You can manipulate your source data in Atrium Integrator Spoon before transferring it to BMC
Atrium CMDB. For example, you can limit the number of records to be transferred on an initial run.
This is very useful for initial verification before bulk-loading data into BMC Atrium CMDB. You can
also write an SQL query to limit the data to be processed rather than processing all the data from
the source table.
To limit the number of rows for initial processing

2. Double-click the input step to open the input step dialog box.
3. In the Limit size field, enter the number of records to import to BMC Atrium CMDB.
4. Click OK.
When you run the transformation, only the specified number of records from the source table
are transferred to BMC Atrium CMDB.
Importing a subset of the data

2. Double-click the input step.
The input step dialog box appears.
3. Click Get SQL select statement.
4. Type an appropriate query.
5. Click OK.
When you run the transformation, records from the source table are transferred to BMC
Atrium CMDB depending on the query you specified.
Transferring source records to BMC Atrium CMDB without checking for duplicates
During initial data loading into BMC Atrium CMDB, you might want Atrium Integrator to create new
records in BMC Atrium CMDB for all source records without checking whether any of those records
already exist in BMC Atrium CMDB.
Using the Always Insert mode, you can create new a configuration item (CI) through Atrium
Integrator in BMC Atrium CMDB without checking whether CI records already exist in BMC Atrium
CMDB. When you use the Always insert mode, to avoid duplication, ensure that unique set of
records (CIs) are passed to CMDBOutput plugin.
Setting the Always Insert mode in Atrium Integrator is same as Create a record= Always in the
BMC Atrium Integration Engine.
BMC Atrium Core 9.0
Page 811 of 2268
Home
To transfer all source records to BMC Atrium CMDB without checking for duplicates
1. In Atrium Integrator Spoon, open the job you created.
3. Select Always Insert.
Note
After the initial data load job is complete, ensure that Always insert is not selected
to avoid creating duplicate records in BMC Atrium CMDB.
Inserting or updating bulk records in BMC Atrium CMDB

If you want to insert or update configuration items (CIs) in CMDB and if the source has bulk data,
you need to cache the source records. Atrium Integrator uses the cache to take insert or update
decisions.
Note
To set number of CIs you want to retain in the cache, update the InMemoryCache field in
the aiplugin.properties file located at: <AR install directory>/diserver/data-integration
/ngie/conf
When you are inserting or updating bulk records in BMC Atrium CMDB, consider the following:
To insert or update bulk records in BMC Atrium CMDB

1. In Atrium Integrator Spoon, open the job you created.
3. Select Use cache.
For jobs created through Atrium Integrator console, the Use Cache option is set by default.
4. Cache for each transformation is created in the $ATRIUMINTEGRATOR_HOME$/AIcache
folder.
Note
In Atrium Integrator server group enviornment, the cache is created on the the
server from where you execute a job. For example, if server A is the primary server
and server B is the secondary server, and if you execute the job from server B, the
cache will be created on server B. If you schedule a job on a server with the cache
BMC Atrium Core 9.0
Page 812 of 2268
Home
enabled and then schedule the same job on another server within the server group,
you must manually copy the cache to the second server to avoid a negative impact
on the performance.
5. Select Only insert new CIs.

6. If you don't select this option, a record in CMDB is updated only if that record is changed in
the source. This behaviour is similar to the CRC logic in Atrium Integrator Engine.
7. In the Update fields table, in the Update column select Y for columns you want to be
always updated in CMDB.
8. In Update column if you select N that column is not considered during updates.
Note
CIs are updated in CMDB only when they meets the qualification criteria.
Qualification criteria is similar to Update Query in Atrium Integration Engine.
Increasing cache size for Atrium Integrator

By default, each cache can hold maximum of 1 million records. You can increase this limit.
To increase the cache size

1. Open the ngie.properties file located in the following directory:
<ARInstallationDirectory>\diserver\data-integration\ngie\bin\conf
<ARInstallationDirectory>diserver\data-integration\ngie\conf
2. Add the MAX_DISK_ELEMENT = <the limit you want to set> field to the ngie.properties file
For example, if you set
MAX_DISK_ELEMENT =10000000 for 10 million cache limit size
The cache limit is set to 10 million instead of 1 million.
3. Save the file.
Configuring the checksum value for loading data into BMC Atrium CMDB
This topic provides instructions for configuring the checksum value for loading data:
About checksum value
Managing the checksum value of transformations migrated from BMC Atrium Integration
Engine
Configuring a transformation to use the checksum value
BMC Atrium Core 9.0
Page 813 of 2268
Home
About checksum value

Similar to BMC Atrium Integration Engine, in Atrium Integrator 8.1 and later, you can configure the
checksum value for a transformation to load data into BMC Atrium CMDB. You can configure a
transformation to use the checksum value by selecting the Use CheckSum option in the
CMDBOutput step of the transformation. The checksum value is populated in the CheckSum
Value field.
A checksum is a unique value generated by BMC Atrium CMDB when records from an external
data store are inserted into BMC Atrium CMDB. If you configure the checksum value, a checksum
value is calculated for each data transfer. It is then compared with the checksum value from the
previous transfer. This option specifies whether all target records are updated, or only those
records that have changed in the source as determined by the checksum calculated from the
values of all mapped fields. This option is available only when the direction of the data mapping is
External Data into CMDB.
In Atrium Integrator, the checksum value is calculated using the SHA (Secure Hash Algorithm) logic
and this value is calculated for all the fields you have mapped. Field-by-field comparison is not
done while updating records in BMC Atrium CMDB. Just by refering to the checksum value,
decision is made if the record needs to be updated or not. This reduces additional calls made to
CMDB to insert records which, also enhances Atrium Integrator's performance.
The following diagram illustrates the usage of checksum value.
BMC Atrium Core 9.0
Page 814 of 2268
Home
Managing the checksum value of transformations migrated from BMC Atrium Integration
Engine
When you are migrating transformations from BMC Atrium Integration Engine that use checksum,
consider the following:
If the checksum value is calculated for relationship mapping in BMC Atrium Integration
Engine The checksum settings for relationship mapping done in BMC Atrium Integration
Engine is not migrated to Atrium Integrator when you migrate data exchanges. You need to
configure the transformation to use checksum of relationship mappings manually in Atrium
Integrator Spoon.
If the checksum value is populated in different field In BMC Atrium Integration Engine you
might have configured a different field to populate the checksum value. When you migrate
such transformations to Atrium Integrator, by default the checksum value is populated in the
Checksum ID field. When you run the transformations for the first time, all the records are
updated in BMC Atrium CMDB. The checksum value is compared to load data into BMC
Atrium CMDB after the second run.
Configuring a transformation to use the checksum value

Unlike BMC Atrium Integration Engine, in Atrium Integrator checksum attribute is added only for the
BaseElement (CI mappings) and not for BaseRelationship (relationship mapping).
To set checksum for relationship mapping you need to manually add a character type attribute in
the BaseRelationship and then proceed with configuring the checksum.
Recommendation
You must configure the checksum value if the delta option is off and you are not aware of the delta
data changes.
To configure a transformation to use the checksum value

1. In Atrium Integrator Spoon, open the transformation you created.
3. Select Use CheckSum.
The checksum value is populated in the pre-defined CheckSumValue field.
4. (For Atrium Integrator 8.0.0 and earlier) If you are using a field other than Checksum ID to
populate the checksum, select that field from the Use Checksum drop-down list.
The checksum value is populated in the selected field.
5. Save and run the transformation.
If there is a change in the input, the checksum value is updated in the CheckSumValue field
and delta of the data is loaded into BMC Atrium CMDB.
(For Atrium Integrator 8.0.0 and earlier) If there is a change in the input, the checksum value
is updated in the selected field and delta of the data is loaded into BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 815 of 2268
Home
Mapping currency field

You can map currency using the CMDBOutput step in Atrium Integrator Spoon. You can map the
currency type and currency value in two separate fields or map both together in one field.
The following diagram illustrates how currency can be mapped in separate fields and in one field.
You can map currency field separately by mapping the currency value or denomination to
Currency Value field and mapping the type of currency (INR, USD etc.) to Currency Type
field.
You can map currency field to one field by mapping both the currency value and type
together to Currency field.
To map currency fields

2. Click Edit Mapping.
3. From the Target Field list you can select the following fields to map with source fields.
Currency: Use to map currency together
Currency Value: Use to map currency value separately
Currency Type: Use to map currency type separately
4. Click Add to map the target fields to the source fields.
5. Click OK. The mapping is displayed in the Update fields table.
6. Click OK to save the changes.
BMC Atrium Core 9.0
Page 816 of 2268
Home
Running an Atrium Integrator job
Schedule, run, and monitor jobs

If you created your job through the Integration Job Builder wizard, you can run it from the Atrium
Integrator console. If you created or edited your job in the Atrium Integrator Spoon application, you
can run it in Atrium Integrator Spoon.
Note
You cannot run a job simultaneously from Atrium Integrator Spoon and Atrium Integrator
console.

Running a job from the Atrium Integrator console
Running a job in Atrium Integrator Spoon
Managing Atrium Integrator job schedule
Running a job from the Atrium Integrator console

If you created your job using the Integration Job Builder wizard, you can run your job from the
Atrium Integrator console.
To run a job
1. In the Atrium Integrator console, select the job that you want to run from the job list on the
left panel.
2. Click Start Job
The selected job begins to be executed in the Carte server. The History tab displays the job
status as it runs.
To stop a job
1. In the Atrium Integrator console, select the job that you want to stop from the job list on the
left panel.
2. Click Stop Job
The selected job stops running.
BMC Atrium Core 9.0
Page 817 of 2268
2.
Home
When you run a job from Atrium Integrator console the Carte server logging is set
to Minimal.

If you edited or created your job in Atrium Integrator Spoon, you can run it in Atrium Integrator
Spoon.
To run a job in Atrium Integrator Spoon

1. Open your job.
For more information, see Opening Atrium Integrator job or transformation .
2. Click Run
The Execute a transformation window appears, as shown in the following figure.

3. Specify whether you want to run the job locally or remotely. If you want to run the job
remotely, specify the remote host.
4. Specify logging details.
BMC recommends that you set this to Rowlevel so that it is easy to find errors.
5. Click Launch.
The job begins running, and the details are displayed in the Executing Results section of
the Atrium Integrator Spoon window.
BMC Atrium Core 9.0
Page 818 of 2268
Home
Managing Atrium Integrator job schedule

You can add a schedule for a job when you are creating a job through the Integration Job Builder
wizard, or you can add or edit a schedule later in the Atrium Integrator console using the Manage
Job Schedule tool. In Atrium Integrator 9.0 and later, you can create a schedule only for the
selected job. You cannot create schedule for one job and then assign it to a different job.
configured in a particular server group and which Carte server is associated with each BMC
Remedy AR System server.
The UDM:PermissionInfo form contains information about jobs and the associated Carte servers
they run on.
To add a schedule
To edit a schedule
To delete a job schedule
Related topics
To add a schedule
1. In the Atrium Integrator console, select the job.
2. In the Atrium Integrator console, click Manage Job Schedule
3. On the Job Schedules page:

a. Select Active.
b. Select the Create new schedule option.
c. Enter a schedule name.
d. In Start Time, select the time (BMC Remedy AR System server time) at which you
want the job to first run.
e. In the Recurrence type area, specify how frequently you want the job to run.
Note
When you run reconciliation jobs, ensure that you do not run the
reconciliation jobs and Atrium Integrator jobs at the same time, because the
reconciliation jobs and Atrium Integrator jobs could query or update the
same data.
Job Schedules page
BMC Atrium Core 9.0
Page 819 of 2268
Home
4. Click Next.
The Summary page appears.
To edit a schedule
The Job Schedule window appears with the job name and directory displayed.
3. Select Edit Existing Schedule.
4. Select the schedule you want to edit from the Select Schedule drop-down list.
5. Select the Carte server on which you want to run the job.
Note
To run scheduled jobs if Atrium Integrator is configured in failover mode, you must
select the default Carte server (ojbect NGIECarteserver)
6. Edit the start time and recurrence type as required.

7. Click Save.
To delete a job schedule

The Job Schedule window appears with the job name and directory displayed.
3. Select Edit Existing Schedule.
4. Select the schedule you want to deletefrom the Select Schedule drop-down list.
5. Click Delete.
BMC Atrium Core 9.0
Page 820 of 2268
Home
Related topics
Scheduling and manually executing a transformation or job
Schedule Processor form
Monitoring jobs in Atrium Integrator
You can view the job details in the Atrium Integrator console.
Viewing Atrium Integrator job history
Viewing Atrium Integrator job details
Viewing job run details of jobs created in Atrium Integrator Spoon in Atrium Integrator
console
All jobs in the repository are displayed in the job catalog on the left side of the window, where you
can sort the jobs by name. The right side of the window displays the job information and run history
of the selected job.
BMC Atrium Core 9.0
Page 821 of 2268
Home
You can also view job details on the Carte server. For information about how to run the Carte
server, see To connect to the Carte server by using a browser .
Viewing Atrium Integrator job history

This topic provides instructions for viewing Atrium integrator job history:
To view job run details
To view logging details
To view transformation run details
The History tab displays the following information for the job selected in the job catalog (left side of
the window):
Name Job name
Status Running
, Completed
, or Failed
Job run details

Logging details
Transformation run details
Click
next to the job name to display the job history details.
To view job run details

1. Select a job from the job catalog on the left panel.
2. Select the History tab.
3. Click the Job Run Details bar to view the job run details.
4. The View Job Run Status link is activated while a job is running.
Note
The View Job Run Status link is visible only when the job is running.
To view job run status:

a. Click the View Job Run Status link.
The BMC Atrium Integrator Carte server login page is displayed
b. Log on to BMC Atrium Integrator Carte server as a AI Admin or AI User
c. The Job Status page is displayed.
You can view run time status of each transformation and the steps within.
5. The Job Run Details area displays the following details:
Batch id:
Status: Status of the job
Source Records: Number of input records in job
Records Rejected: Number of records failed to update in the target database
BMC Atrium Core 9.0
Page 822 of 2268
Home
Start Time: Start time of the job

End Time: Finish time of the job
Records Created: New records created in the target database
Records Updated: Records updated in the target database
To view logging details

3. Click the Logging Details bar to display log details.
4. In the Logging Details area, click View Log Details.
The log file appears. The log file displays the following information:
Time when job execution started
Time when job finished
Error messages
Details of records updated in CMDBOutput step
Details of records updated in CMDB Input
Details of records updated in CMDB Look up
5. To view detailed logging details, click Export to File.
The logging details are displayed according to the log level you have set.
6. Specify the file name and path for the log file.
7. Click Save.
The log file is saved.
To view transformation run details

3. Click the Transformation Run Details bar to display transformation details.
The Transformation Run Details area displays the following transformation statistics:
Transformation Name: Names of all the transformation in the job
Source Records: Number of records in the transformation
Records Created: Number of new records created in target database
Records Failed: Number of records that could not be pushed in target database
Records Updated: Number of records updated in target database
Start Time: Start time of the transformation
End Time: Finish time of the transformation
Viewing Atrium Integrator job details

You can view the details of a selected job.
To view job details

2.
BMC Atrium Core 9.0
Page 823 of 2268
Home
2. Select the Integration Job Details tab.

Integration Job Details area
The Integration Job Details area displays the following information for the selected job:
Job Id and Job Name
Created By User name of the person who created the job
Create Date Date on which the job was created
Modified By User name of the person who modified the job
Modified Date Date on which the job was modified
Source Type Source data store for the job
Target Type Target data store to which data is to be transferred (BMC Atrium
CMDB)
Directory Location where the job is saved in the repository
Job Description Description that was entered in the Integration Job Builder wizard
Job Schedule Start time of the job, recurrence type of the job, recurrence details,
and Carte server on which the job is running
Viewing job run details of jobs created in Atrium Integrator Spoon in Atrium
Integrator console
When you create a job in Atrium Integrator Spoon and try to open in Atrium Integrator console you
need to update the logging details for the transformation and job to view the job run details.
To view job runs details of jobs created in Atrium Integrator Spoon in Atrium Integrator console
1. To update the logging options for the transformation:
a. Right-click the transformation on the left panel.
b. Select Settings > Logging tab.
BMC Atrium Core 9.0
Page 824 of 2268
1.
b.
Home
In the Log Connection field select the name of the connection that you have
logged in through BMC Atrium Integrator Spoon.
In the Log table name field enter the name of the table (UDM:
TransformationLog) in which the logs are stored.
In the Fields to log area select the list of fields for which you want to enable
logging.
In the Step name field, select the step
In the Line input field select the source step.
In the Line update, Line return, Line read, and Line output field
select the output step name.
In the Line rejected field select the error logging step name.
2. To update the logging options for the steps, click the Step on the left panel.
In the Log Connection field select the host name of the BMC Remedy AR System
database.
In the Log table name field select the name of the table (UDM:StepLog) in which the
logs are stored.
In the Fields to log area select the list of fields for which you want to enable logging.
3. To update the logging options for the job:
a. Right-click the job on the left panel.
b. Select Settings > Logging tab.
In the Log Connection field select the name of the connection that you have
logged in through BMC Atrium Integrator Spoon.
In the Log table name field enter the name of the table (UDM:JobLog) in
which the logs are stored.
In Fields to log area select the list of fields for which you want to enable
logging.
4. To update the logging options for the job entry, click Job Entry on the left panel.
In Log Connection field select the host name of the BMC Remedy AR System
database.
In Log table name field select the name of the table (UDM:JobEntryLog) in which the
logs are stored.
In Fields to log area select the list of fields for which you want to enable logging.
Complex jobs in Atrium Integrator Spoon

The following topics provide information about various complex jobs that you can create by using
the Atrium Integrator Spoon:
Exporting web services data in Atrium Integrator Spoon
Creating a Atrium Integrator Delete job
Using Atrium Integrator sample jobs
Creating a job to migrate data from one BMC Atrium CMDB to another
Exporting XML data from BMC Atrium CMDB
Creating multiple mappings in Atrium Integrator Spoon
BMC Atrium Core 9.0
Page 825 of 2268
Home
Exporting data from AR System forms to external data stores
Exporting web services data in Atrium Integrator Spoon

Typically, you can export web services data using the Web services lookup step. However, there
are certain limitations with just using the Web services lookup plug-in. You need a use SOAP
interface and generate the XML you need and push that to the web service using the HTTP Post
step. For more information about limitations of the Web services lookup step refer to the Spoon
User Guide.
You can also refer to the following sample transformation to export web services data:
Annotated SOAP Web Service call.ktr
WebServicesMovieListingAsHTTP.ktr
These sample transformations are available in the Samples folder, which is located at the following
location:
<ARInstallationDirectory>\diserver\dataintegration\Sample
To export web services data

1. Using a SOAP interface, create an XML to get data from the web service.
2. Open a new transformation in Atrium Integrator Spoon.
3. Add the Fixed file input step.
a. Double-click the step. The Fixed Input dialog box appears.
b. In the Filename field, enter the location of SOAP XML file.
4. Add the Add constant step.
a. Double-click the step. The Add constant values dialog box appears.
b. In the Values column, enter the location of the web service.
5. Add the HTTP Post step.
a. Double-click the step. The HTTP Post web service dialog box appears.
b. Click the General tab.
c. In the URL field, enter the enter the location of the web service.
6. Add the Text file output step.
7. Save and run the job.
Creating a Atrium Integrator Delete job

If you select the Delete option in the Integration Job Builder wizard, a separate Delete
transformation is created as part of the job. The Delete transformation is triggered immediately after
the transformation that transfers the corresponding data to BMC Atrium CMDB is complete.
To create a Delete job that deletes a record from BMC Atrium CMDB only when that record is
deleted from the source data source, you must perform the following steps in BMC Atrium
Integrator Spoon.
BMC Atrium Core 9.0
Page 826 of 2268
Home
To create a delete job

2. In the Repository explorer dialog box, click the BMCSAMPLES folder to display the sample
jobs and transformations.
3. Open the BMC_Computer_System_Delete transformation and edit the steps within the
transformation based on your requirements.
4. Save the updated transformation with a different name.
5. Select File > New > Job to create a new job.
6. In the navigation panel, click General.
7. Click START and drag it to the canvas.
8. Click Transformation and drag it to the canvas.
9. Double-click the Transformation step.
10. In the Job entry details for this transformation dialog box, select the Specify by name and
directory option.
11. Browse to select the transformation that you saved in step 4 and click OK.
12. Create a hop between the START and Transformation steps.
13. Save the job.
Note
If the Enable Cache is on for a class when getting data into CMDB then set Enable
Cache =Yes in the CMDBInput step, because when a CI gets soft-deleted from
CMDB then it has to be removed from the cache as well.
Using Atrium Integrator sample jobs

You can use a sample job as a staring point while creating a complex job. Sample jobs and
transformations can be accessed from the BMC SAMPLES folder in BMC Atrium Integrator Spoon
or from the jobs list in the left panel in Atrium Integrator console.
Sample jobs are published only after BMC Atrium Core is installed. Sample jobs won't be published
if Atrium Integrator is installed without BMC Atrium Core.
The following table, lists the available sample jobs and their usage.
Sample job usage
Sample job
Usage
AISAMPLE_MachineOS _DELTA
Job: Use this job to capture data from CSV and populate it into CMDB. When you run
this job, for the first time, entire data from the CSV is populated in CMDB. Next time
when you run the job, only the delta is captured wherein, the data is populated
incrementally. This job also establishes parent-child relationships between the classes.
This sample is designed to capture data of Computersystem and
BMC Atrium Core 9.0
Page 827 of 2268
Home
Sample job
Usage
Operatingsystem classes and populate it into CMDB. A relationship is created
between both the classes and they are associated to the MachineOS class in
parent-child relationship.
AISAMPLE_Computersystem _DELTA
Transformation: These transformations capture data from CSV file and populate the
data into CMDB. When the transformations are executed, for the first time, entire data
from the CSV is populated in CMDB wherein, for the subsequent execution it is
incremental where only the delta is captured. These transformations function using the
NGIE: Delta form which, initially stores the record pertaining to the transformation
name and default time stamp i.e. 01/01/1970. When the transformations are executed,
they capture the max date from the source file and replace the existing timestamp in
the NGIE:Delta form. Next time when the transformations are executed, the ARInput
step reads the record and AROutput step fetches the time stamp from the NGIE: Delta
form. Only records created after the timestamp recorded in the NGIE: Delta form are
populated into CMDB.
AISAMPLE_Operatingsystem _DELTA (
incremental where only the delta is captured. These transformations function using the
NGIE: Delta form which, initially stores the record pertaining to the transformation
name and default time stamp i.e. 01/01/1970. When the transformations are executed,
they capture the max date from the source file and replace the existing timestamp in
the NGIE:Delta form. Next time when the transformations are executed, the ARInput
step reads the record and AROutput step fetches the time stamp from the NGIE: Delta
form. Only records created after the timestamp recorded in the NGIE: Delta form are
populated into CMDB.
non-delta transformation)
AISAMPLE_CompOS _DELTA
Transformation: This transformation creates relationship between both the child

classes and associate them to a parent class. This transformation associates child Computersystem and Operatingsystem class to parent MachineOS class. The
relationship source for this association is .csv file that stores the relationship
information available at:
diserver
data-integration
NGIESample
bmc_<classname>.csv
Job_Comp_Proc_RELATIONSHIPS
Job: Use this job to capture data from CSV and populate it into CMDB. When you run
this job, for the first time, entire data from the CSV is populated in CMDB. Next time
when you run the job, only the delta is captured wherein, the data is populated
incrementally. This job also establishes parent-child relationships between the classes.
This sample is designed to capture data of ComputerSystem CI then Processor CI.
And then a relationship is created between both the CIs under the
HostedSystemComponents class.
BMC_Computer_System_CSV
incremental where only the delta is captured.
BMC_Processor_CSV
incremental where only the delta is captured.
BMC_Comp_Rel_Processor
BMC Atrium Core 9.0
Page 828 of 2268
Home
Sample job
Usage
Transformation: This transformation captures the relationship between two or more

classes defined in a flat file source. This transformation uses CMDB lookup to lookup
the data in class tables. After getting a match, Instance ID from the tables are captured
. The parent Instance ID is loaded as SourceInstanceID and child's Instance ID is
loaded as DestInstanceID with other values.
Job_CSV_CMDB_COMPUTERSYSTEM
Job: Use this job to capture data from CSV and populate it into CMDB.
BMC_Computer_System_CSV
Transformation: This transformations capture data from CSV file and populate the data
into CMDB. When the transformations are executed, for the first time, entire data from
the CSV is populated in CMDB wherein, for the subsequent execution it is incremental
where only the delta is captured.
Job_XML_CMDB_MONITOR
Job: Use this job to capture data from XML and populate it into CMDB. This sample
job runs an XML transformation and populates BMC_Monitor Class.
BMC_Monitor_XML
Transformation: This transformation captures data from XML file and populates into
CMDB. This transformation takes care of the entire initial load of data.
Job_FileMetaLoader
Job: This job is run when you create a CSV or XML data store connection with a
remote Atrium Integrator Carte server. This job runs on the remote Atrium Integrator
Carte server. The job checks if the folder of files exists on the specified server. Based
on the file type identified, the job populates that information in ngie: file metadata.
You can use the logging information of this job to identify and troubleshoot issues
related to CSV and XML datastore connections to remote Atrium Integrator Carte
server.
Do not delete this job or you will not be able to create CSV or XML datastore
connection with remote Atrium Integrator Carte server.
Creating a job to migrate data from one BMC Atrium CMDB to another
You can create a job in Atrium Integrator Spoon to migrate data from the BMC Atrium CMDB on
your development server to the BMC Atrium CMDB on your production server.
To create a migration job

1. On the computer where the BMC Atrium Integrator Spoon client installed, select Start >
permissions.
d. Click OK.
4. In the Atrium Integrator Spoon window, select File > New > Transformation.
5. In the navigation panel, click Input.
6. Click CMDBInput step and drag it to the canvas.
7. Double-click the CMDBInput step.
8.
BMC Atrium Core 9.0
Page 829 of 2268
Home
8. In the Connection field of the CMDBInput dialog box, perform one of the following actions.
Select a connection to the BMC Atrium CMDB on your development server.
Create a new connection to the BMC Atrium CMDB on your development server by
performing the following steps:
a. Click New.
b. In the Server Name field of the Database Connection dialog box, type the
name of your BMC Remedy AR System server.
c. (optional ) Type the port number.
d. Type the user ID and password to log on to BMC Atrium CMDB.
e. Click Test to validate the connection.
f. Click OK.
9. In the Class Name field, click Browse to select the BMC Atrium CMDB class from which
you want to migrate data.
The NameSpace field displays the namespace for the selected class.
10. In the Dataset Id field, select the dataset from which you want to migrate data.
11. Click OK.
12. From the Output menu in the navigation panel, click the CMDBOutput step and drag it to
the canvas.
13. Repeat step 6 to step 9 to create a connection to the BMC Atrium CMDB on your server
through the CMDBOutput step.
14. In the key look up area, select Instance Id in the Table field column and type InstanceId in
the Stream field 1 column.
This mapping enables you to keep the same Instance Ids as you transfer data from the BMC
Atrium CMDB on your development server to the BMC Atrium CMDB on your production
server.
15. Create a hop from the CMDBInput step to the CMDBOutput step. For information about
creating a hop, see Connecting transformation steps or job entries in BMC Atrium Integrator
Spoon.
17. In the Transformation Properties dialog box, specify a name for the transformation.
18. Click OK.
You can run this transformation in Atrium Integrator Spoon. However, you must envelop this
transformation in a job to be able to monitor and run it from the Atrium Integrator console.
19. Select File > New > Job.
20. From the General menu in the navigation panel, select the Start step and drag it to the
canvas.
21. Click and drag the Transformation step to the canvas.
22. Double-click the Transformation step.
23. In the Name of transformation field, click
to select the transformation you had created
in step 16.
24. Click OK.
26.
BMC Atrium Core 9.0
Page 830 of 2268
Home
26. In the Job Properties dialog box, specify a name for the job.
27. Click OK.
The job is now displayed in the Atrium Integrator console.
Exporting XML data from BMC Atrium CMDB

You can export your XML data from BMC Atrium CMDB by using the
BMC_CMDB_CI_XML_EXPORT.ktr transformation. This transformation takes data from different
tables based on parent-child (one-to-many) relationships and populates in XML files with multilevel
hierarchy maintaining the parent-child relationship. To retrieve valid data, the parent's instance ID is
passed as a parameter from the child tables, which in turn provides the hierarchy of the parent-child
relationship.
To export XML data from BMC Atrium CMDB

1. Open the BMC_CMDB_CI_XML_EXPORT.ktr transformation.
2. To modify the parent CI, double-click the parent CI step .
a. In the Table input dialog box, modify the SQL query by providing information about
the new parent CI.
b. Click OK.
3. To modify the child relationship, double-click the child CI step .
a. In the Table input dialog box, modify the SQL query by providing information about
the new child CI.
b. Click OK.
4. Run the job.
For more information, see Running a job in BMC Atrium Integrator Spoon .
5. Double-click the Text file output step.
The Text File Output dialog box appears.
6. Verify the XML file.
BMC Atrium Core 9.0
Page 831 of 2268
Home
Creating multiple mappings in Atrium Integrator Spoon

Multiple mappings allows you to map multiple class configuration item (CIs) in a single
transformation. The primary class CI source table fetches relevant data from the secondary class
CI source table. You can map multiple secondary class CIs to a single parent class CI. In Atrium
Integrator, you can create multiple mappings through Atrium Integrator Spoon.
To create multiple mapping

1. Create the primary class CI mapping through Atrium Integrator console.
For more information, see Creating a job through the Integration Job Builder wizard .
2. Open the primary class CI mapping transformation in Atrium Integrator Spoon.
For more information, see Opening Atrium Integrator job or transformation .
3. Add the Database lookup step for secondary mappings connecting to the primary class CI
mapping.
Database lookup looks for the primary mapping value in the secondary mapping table.
For more information, see Adding intermediate steps to a Atrium Integrator transformation .
4. If the primary mapping value is present in the secondary mapping table, add the
CMDBOutput step for the secondary class CI mapping.
For more information, see Adding intermediate steps to a Atrium Integrator transformation .
5. Add the Error Logging step.
The following figure illustrates a multiple mapping transformation.
Multiple mapping
BMC Atrium Core 9.0
Page 832 of 2268
Home

Exporting data from AR System forms to external data stores

To export data from AR System forms to external data stores, you need to create and run the job
from Atrium Integrator Spoon. You cannot run this job from Atrium Integrator console. Jobs to
import data in to AR System forms are migrated using the AIE to AI Migration tool and can be run
from the Atrium Integrator console.
To export data from AR system forms to external data stores

1. Open a new transformation in Atrium Integrator Spoon.
2. Add the ARInput step.
a. Double-click the step. The AR Input dialog box appears.
b. Click the General tab.
c. In the Connection field, enter connection information.
d. In the Form Name field, select the AR form from which you want to transfer the data.
e. Click OK.
3. Add the Insert/Update step.
4. Add the Add constants step between the ARInput step and Insert/Update step.
a. Double-click the step. The Select/Rename Values dialog box appears.
b. Click the Select & Alter tab.
c. Verify the field mapping.
d. Click OK.
The following figure illustrates the transformation.
Transformation export data from AR system forms to external data stores
5.
BMC Atrium Core 9.0
Page 833 of 2268
Home
5. Save and Run the job.

Upgrading and migrating Atrium Integrator jobs

The following topics provide instructions for upgrading jobs to Atrium Integrator 8.1 and for
migrating jobs from one computer to another:
Upgrading jobs to Atrium Integrator by using the Atrium Integrator Maintenance Tool
Migrating Atrium Integrator jobs and transformations from one computer to another
Upgrading jobs to Atrium Integrator by using the Atrium Integrator Maintenance

Tool
When you upgrade to Atrium Integrator 9.0, most jobs are automatically upgraded. There be
situations where certain jobs are not upgraded, in which case, you can upgrade these jobs by using
the Atrium Integrator Maintenance Tool.
When upgrading jobs, BMC recommends that you first directly upgrade jobs from the backup folder
that is created during upgrade. You can access the backup folder from:
<AR installed directory>\AI7604RepositoryBackup
If you are not able to directly upgrade the jobs, you need to re-export the jobs from the backup
folder that was created for the earlier version of Atrium Integrator and then import the job by using
the Atrium Integrator Maintenance Tool. The backup folder for the earlier version of Atrium
Integrator is available in the installation folder. The backup folder is renamed with 7.6.04 suffix.
When you upgrade jobs to Atrium Integrator 9.0, the old jobs are moved from the database
repository to the form-based repository where the following modifications are made:
The connection is changed from database to AR System form.
For delta jobs the connection changes to AR System connection. If a transformation has a
delta step, then the transformation is modified as per the new design where changes are
from the database repository to the form-based repository.
The log name is changed to UDM:JobLog.
The log entry name is changed to UDM:JobEntryLog.
UDM:TransformationLog form is added. It provides details about transformation run.
UDM:StepLog form is added. It provide details about step run.
Note
Previous delta, schedule, and history information is not migrated when you upgrade jobs.
BMC Atrium Core 9.0
Page 834 of 2268
Home
Data store connection information from earlier versions of Atrium Integrator console is not upgraded
in the Atrium Integrator 9.0 console, Therefore this information can't be viewed from the Manage
Data stores dialog box. However, the connection information can be viewed from BMC Atrium
Integrator Spoon. You can manually create the connection information in the Atrium Integrator
console with the same alias name.
Note
Use Atrium Integrator Maintenance Tool only to upgrade jobs from 7.6.04 and not for
simple import.
The following figure illustrates the different stages in the process of upgrading jobs to Atrium
Integrator by using the Atrium Integrator Maintenance Tool.
Upgrading jobs by using the Atrium Integrator Maintenance Tool
To upgrade jobs by using the Atrium Integrator Maintenance Tool

1. Go to the backup folder of the earlier version of Atrium Integrator.
It is the earlier installation folder that is renamed with 7604 suffix.
2. To open Atrium Integrator Spoon, double-click spoon.bat.
a. Log on as follows:
In the Repository field, leave the default entry of NGIEREPD.
In the Login field, enter admin.
In the Password field, enter admin.
Click OK.
b. In the Atrium Integrator Spoon window, open the job.
c. Select File > Export to an XML file .
BMC recommends that you export each job individually instead of exporting the jobs
by using the Export all linked resources to XML option. If you export jobs by using
the Export all linked resources to XML option, after importing the jobs, you must
BMC Atrium Core 9.0
Page 835 of 2268
c.
Home
replace the data_path value with actual file path. You must make this change in the
Text Source, Error Logging, Modified Java Script Value, and Get Data from XML
step in BMC Atrium Integrator Spoon.
d. Save the job as a .kjb file, and the related transformation as a .ktr file.
Note
Do not add the .ktr and .kjb files to a zip file.
3. On the Atrium Integrator 9.0 server, import the jobs by using the Atrium Integrator
Maintenance Tool.
a. Navigate to the <AtriumIntegratorInstallationDirectory>\aint directory.
b. Open the Atrium Integrator Maintenance Tool:
Windows--Double-click AtriumIntegratorMaintenanceTool.cmd.
UNIX and Linux--Run ./AtriumIntegratorMaintenanceTool.sh.
c. In the Atrium Integrator Maintenance Tool, click the Load Content tab.
d. Provide the following BMC Remedy AR System information:
BMC Remedy AR System Administrator Name Specify an administrator
user name.
AR System Server Administrator Password Type the password for the
administrator user name.
AR System Server TCP Port If you specified a port number when installing
the BMC Remedy AR System server, type that number in this field. If the
server uses a portmapper to automatically select a port to use, leave this field
blank.
AR System Server Name Alias Type the computer name on which to import
the jobs.
e. Click Next.
f. Specify the JRE path that is used by the Atrium Integrator computer and click Next.
g. Specify the directory where the .kjb files are located.
h. Click Next to begin the import process.
The Atrium Integrator Content Loader Summary page indicates if the import
succeeded or failed.
i. (optional) Click View Log to find more details about the failure.
In the atriumintegrator_configuration_log.txt window, sort the messages by
severity.
Select a message to display the details at the bottom of the window.
You can access the log file from the TEMP directory on Windows or the /var/
tmp on UNIX.
4. On the Atrium Integrator 9.0 server, open BMC Atrium Integrator Spoon and confirm that the
jobs are successfully imported.
BMC Atrium Core 9.0
Page 836 of 2268
4.
Home
Note
When you import jobs, cache is disabled by default. After upgrading you must
manually enable the cache by using BMC Atrium Integrator Spoon.
Running migrated Atrium Integrator jobs

If you make any modifications to jobs created from 7.6.04 Atrium Integrator console, those jobs will
migrated as is to 8.0 Atrium Integrator. Such jobs are not upgraded but only migrated to 8.0. To run
such jobs you need to redesign the transformation.
Jobs migrated from Atrium Integrator 7.6.04 may not run as is in Atrium Integrator 8.0. To run the
job you must do the following:
When you upgrade Atrium Integrator 7.6.04 jobs, the connection details are migrated as is.
However, you may need update the server entry inside UDM:Rapp password form on the
target Atrium Integrator 8.0 server if it is not already updated for the respective host.
If you want run the job remotely from BMC Atrium Integrator Spoon, update the user name
and password in the Slave server dialog box.
Migrating Atrium Integrator jobs and transformations from one computer to another
You can migrate jobs from one computer to another using one of the following:
Migrating jobs using the Export Configuration tool
Migrating jobs using Development-to-Production command line utility
Migrating jobs using the Export Configuration tool

The Export configuration tool is available with BMC Atrium Core 8.1.02 and later versions. Export
Configuration tool allows you to migrate Atrium Integrator jobs from one computer to another
wherein, you can:
Migrate all or specific Atrium Integrator jobs.
Migrate Atrium Integrator job schedules.
Migrate 8.0 and later Atrium Integrator jobs to a computer where the higher version of Atrium
Integrator is installed. You will have to run the utility only from a computer where you have
BMC Atrium Core 8.1.02 or later version installed.
The target version must always be equal to or greater than the source.
Migrate job connections. Only the connections specific to the job are migrated.
Note
Unlike the Development-to-Production command line utility, when you migrate jobs using
the Export Configuration tool, you don't need a backup folder (staging area) for copying
the .kjb and .ktr files.
BMC Atrium Core 9.0
Page 837 of 2268
Home
To migrate jobs using the Export Configuration tool

1. Launch the Atrium Integrator console.
2. In the tool bar, click Export Configuration tool. The Export Configuration tool dialog box is
displayed.
3. Enter the source server details.
Server Name: Is auto populated
Server Port: Is auto populated
AI User: User name
Password: Password
Authentication: Client-provided authentication string, such as the domain.
4. Click Fetch Jobs.
All the jobs on the source server are displayed in Job List table.
Only the parent jobs are displayed in the Job List table. However, all the associated
sub jobs and transformations are also migrated.
For all the jobs that have a schedule, the Schedule check box is selected.
To troubleshoot: If you are running the Tomcat web server, the Atrium Integrator
console log files are located in the following directory on the computer where you
installed the mid tier: C:\Program Files\Apache Software Foundation\Tomcat 6.0\
logs\stdout_currentDate.log
5. Enter the target server details.
Server Name
Server Port
AI Admin User: Remedy Application Service
Password: Remedy application service user password
Authentication: Client-provided authentication string, such as the domain.
6. Click Test Target. Connection to the target server is tested.
To troubleshoot: If you are running the Tomcat web server, the Atrium Integrator
console log files are located in the following directory on the computer where you
installed the mid tier: C:\Program Files\Apache Software Foundation\Tomcat 6.0\
logs\stdout_currentDate.log
7. By default all the jobs are selected to be exported.
To export selected jobs:
a.
i. Uncheck the check box on the Job List table header.

ii. Select the jobs you want to export.
Similarly, you can also export specific schedules.
8. Click Export Jobs.

9. The job export status is displayed in the Export Status column.
10. To view the details of a failed job, click the Failed status link in the Export Status column.
The export job status dialog box is displayed.
11. In case of errors, fix the errors and re-export only the updated job.
12. All the successfully exported jobs are displayed in the Atrium Integartor console.
BMC Atrium Core 9.0
Page 838 of 2268
Home
Migrating jobs using Development-to-Production command line utility

When using the Development-to-Production command utility, consider the following:
Migrate jobs and transformations, only between the same version of Atrium Integrator 8.1 or
later.
The schedules are not migrated.
The development-to-production utility available at the following location:
Microsoft Windows:
<AR Installed Directory>\diserver\data-integration\ngie\bin\ devtoprod.cmd

UNIX:
<AR Installed Directory>\diserver\data-integration\ngie\bin\ devtoprod.sh

When migrating jobs, you can run the development-to-production utility from a development
computer, a production computer, or even from a computer where Atrium Integrator client is
installed. Ensure that you add the location of the folder from which you are running the utility in the
AISrcAndTargerARDetails.properties file.
When you migrate jobs and transformations from one computer to another, only the Run History is
modified.
To migrate jobs from one computer to another

1. Open the AISrcAndTargerARDetails.properties file from
<ARInstallationDirectory>\diserver\data-integration\ngie\conf
2. Provide the source BMC Remedy AR System Application Services credentials.
3. Provide the target BMC Remedy AR System Application Services credentials.
4. Provide the backup folder location for all the .kjb and .ktrfiles that are to be exported.
Note
On Windows, use double slash when you specify the backup folder location for all
the .kjb and .ktr files that will be exported.
Following is a snippet of the AISrcAndTargerARDetails.properties file:

# Fill Source AR Credentials
AR.SRC.SERVERNAME =
AR.SRC.TCPPORT =
AR.SRC.RPCPORT =
# Fill Source AR Remedy Application Services password
BMC Atrium Core 9.0
Page 839 of 2268
Home
AR.SRC.PASSWORD =
# Fill Target AR Credentials
AR.TARGET.SERVERNAME =
AR.TARGET.TCPPORT =
AR.TARGET.RPCPORT =
# Fill Target AR Remedy Application Services password
AR.TARGET.PASSWORD =
# Enter the Backup Folder Location FOR All the .KJB AND .KTR file
WHICH WILL get Exported
# For Windows use
for path separator
AI.SRC.REPO.BACKUP.FOLDER=
5. Save the changes.
6. Run the development-to-production utility.
7. Verify if the jobs are migrated on the target computer.
Migrating existing data exchanges to Atrium Integrator

The following topics provide information and instructions for migrating existing data exchanges to
Atrium Integrator:
Overview of the AIE to AI Migration Tool
Limitations of AIE to AI Migration Tool when migrating data exchanges
Planning the migration of BMC Atrium Integration Engine data exchanges to Atrium
Integrator
Data exchanges that are migrated to Atrium Integrator
Migration of data exchange parameters to Atrium Integrator
Migration of data exchange settings to Atrium Integrator
Migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator
Scenario for migrating data exchanges to Atrium Integrator
Note
BMC Atrium Integration Engine is being replaced with a new offering called Atrium
Integrator. The BMC Atrium Core version 8.1 is the last release that includes BMC Atrium
Integration Engine. No new versions (major or minor) of BMC Atrium Integration Engine
will be released after 8.1 .
The AIE to AI Migration Tool enables you to automate the migration of your existing BMC Atrium
Integration Engine data exchanges to corresponding jobs and transformations in Atrium Integrator.
For information about AIE to AI Migration Tool, see Overview of the AIE to AI Migration Tool .
BMC Atrium Core 9.0
Page 840 of 2268
Home
If you are using BMC Atrium Integration Engine in your production environment, you might have
configured multiple data exchanges to transfer data from external data stores to BMC Remedy AR
System forms or to BMC Atrium CMDB. To improve performance when transferring a large amount
of data, you might have also set up multiple instances of BMC Atrium Integration Engine. In Atrium
Integrator all migrated data exchanges run under a single carte server. For information about load
balancing in Atrium Integrator, see Improving performance of Atrium Integrator by load balancing .
After you have migrated the data exchanges to a single Atrium Integrator server, you can open
multiple sessions of BMC Atrium Integrator Spoon to run different jobs. Each BMC Atrium Integrator
Spoon session is a different processes. If you have multiple carte servers (server group installation)
, you can run the job pointing on a specific carte server. For more information see, Atrium Integrator
in a server group environment.
For information about how Atrium Integrator terminology and tasks correspond to BMC Atrium
Integration Engine terminology and tasks, see Mapping BMC Atrium Integration Engine tasks and
terminology to Atrium Integrator.
Overview of the AIE to AI Migration Tool

The AIE to AI Migration Tool enables you to automate the migration of your existing BMC Atrium
Integration Engine data exchanges to corresponding jobs or transformations in Atrium Integrator.
AIE to AI Migration Tool is installed out-of-the-box when you install the Atrium Integrator server or
Atrium Integrator client.
The following figure illustrates the AIE to AI Migration Tool workflow.
AIE to AI Migration Tool workflow
The data exchange migration by using the AIE to AI Migration Tool involves the following tasks:
1.
BMC Atrium Core 9.0
Page 841 of 2268
Home
1. Getting exchanges from the source BMC Atrium Integration Engine server
2. Testing connections with the target Atrium Integrator server
3. Migrating exchanges
The following table describes the stages for migrating existing data exchanges from BMC Atrium
Integration Engine to Atrium Integrator using the AIE to AI Migration Tool.
Stages in migrating data exchanges by using AIE to AI Migration Tool
Stage
Description
Before you begin
Become familiar the AIE to AI Migration Tool.

For information about the difference between BMC Atrium Integration Engine and Atrium
Integrator when migrating data exchanges, see Comparison between BMC Atrium Integration
Engine and Atrium Integrator.
For information about the data exchanges that are migrated to Atrium Integrator using the AIE
to AI Migration Tool, see Data exchanges that are migrated to Atrium Integrator.
For information about the limitations of the AIE to AI Migration Tool when migrating data
exchanges to Atrium Integrator, see Limitations of AIE to AI Migration Tool when migrating
data exchanges.
For information about the data exchange parameters and settings that are migrated to Atrium
Integrator using the AIE to AI Migration Tool, see Migration of data exchange parameters to
Atrium Integrator.
Planning migration of
Plan the migration. For information about planning migration of data exchanges, see Planning the
data exchanges to Atrium

Integrator
migration of BMC Atrium Integration Engine data exchanges to Atrium Integrator .
Migrating data exchanges

to Atrium Integrator
Perform a test migration.

For information about migrating data exchanges to Atrium Integrator using AIE to AI Migration
Tool, see Migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator .
For troubleshooting information, see Atrium Integrator jobs created in Windows with target
source connection as localhost do not run on UNIX or Solaris .
For a sample migration, see Scenario for migrating data exchanges to Atrium Integrator .
Verifying the migration
Verify the migrated data exchanges against corresponding jobs, see Viewing migrated data
exchanges in Atrium Integrator.
Limitations of AIE to AI Migration Tool when migrating data exchanges

The following table describes the limitations with the AIE to AI Migration Tool when you migrate
data exchanges from BMC Atrium Integration Engine to Atrium Integrator.
Limitations of AIE to AI Migration Tool
For a quick overview of limitations, see
Limitations of AIE to AI Migration Tool
Limitation
Impact/Workaround
The AIE_Configuration.arx file created from BMC Atrium Integration Engine export
utility is not migrated to Atrium Integrator.
Not supported.
BMC Atrium Core 9.0
video.
Page 842 of 2268
Home
Limitation
Impact/Workaround
Instance names for data exchanges from BMC Atrium Integration Engine are not
migrated to the corresponding jobs in Atrium Integrator.
In Atrium Integrator, all migrated data

exchanges run under a single carte
server. For information about load
balancing in Atrium Integrator, see
Improving performance of Atrium
Integrator by load balancing.
Relationship type of data exchange is migrated as a child transformation of CI Class.
Reconfigure the data exchange for which

you have configured the Relation Type
and Time Based option to To Be
Triggered option with parent CI Class.
If in BMC Atrium Integration Engine, if the data has two double quotes in any rule,
then that data is not recognized by Atrium Integrator. For example, the following data
will not be recognized by Atrium Integrator. STMT|IF $'HOST CITY'$ = ""UPS
To support the usage, modify the rule in

the Set Rules step in the transformation.
P0012 (NEW YORK, UNITED STATES)"" THEN VALUE = "NULL" ELSE

VALUE = "SUCCESS" ENDIF
The AIE to AI Migration Tool does not migrate data exchanges containing external
AIE to AI Migration Tool only migrates
data stores as flat files with .dat files.
external data stores as flat files with CSV

files. To migrate such exchanges before
migrating you need to convert the .dat file
to .csv.
To convert a .dat file to .csv:
1. Replace all back slashes in the .
dat file with comma.
2. Remove the first comma.
3. Add the field names from the .tbl
file to the .dat file as headers.
4. Save the .dat file as .csv.
If the Delete according to data mapping option is selected with Permanently delete
option, then the data exchange is migrated to Atrium Integrator with Soft delete option
.
Records won't be deleted physically from

the database. Atrium Integrator does not
support permanent (hard) delete.
Data types of fields in XML files are not migrated to Atrium Integrator.
By default the data type for XML files will

be a string. You need to modify the data
type in BMC Atrium Integrator Spoon. For
more information about data types, see
Atrium Integrator supported data types.
CMDB export (CMDB to external data stores) delete data exchanges are not migrated
to Atrium Integrator.
Create a new job in Atrium Integrator.

You can refer to the sample delete jobs.
AR System import (external data store into AR System) and AR System export (AR
System into external datastore) delete data exchanges are not migrated to Atrium
Integrator.
Not supported.
$SRC qualifiers in the mapping cannot be migrated for export type of data exchanges.
After you migrate the data exchange,

open the job in BMC Atrium Integrator
Spoon and modify the mapping.
$Key$=$KEYLIST$ qualifiers in the mapping cannot be migrated.
After you migrate the data exchange,

open the job in BMC Atrium Integrator
Spoon and modify the mapping.
BMC Atrium Core 9.0
Page 843 of 2268
Home
Limitation
Impact/Workaround
For CSV/XML export type of data exchanges, rules are migrated but, output value of
the rules are not mapped to any output field of CSV/XML.
Create new fields in the CSV/XML and

assign the value of the rules to that
output fields.
A chain (to be triggered) of the BMC Atrium Integration Engine relationship based
data exchanges is not migrated to Atrium Integrator. Only the first data exchange in
You can open a sub job in Atrium

Integrator and add transformations in a to
the chain is migrated.
be triggered relationship chain.
When you run an AR System or CMDB export type job for CSV and XML from BMC
Atrium Integrator Spoon, the updated record count is not displayed in the Updated
Column of the Step Matrix.
You can look for the updated records

information in the CSV or XML file. Or
you can also find this information in the
log file.
If a BMC Atrium Integration Engine data exchange is having a Class-based

relationship or Vendor-based relationship with delta and it is migrated, a query is
If secondary data exchange is non-delta

or if the delta information is not displayed
formulated in Table input with ModifiedDate field, which is not available in Table input
and thus the corresponding job may not run. However, if the secondary data
correctly, manually change the Table

input in the delta field in the relationship
exchange has delta then the data exchange is migrated and the corresponding job
runs correctly.
transformation with proper LMT field.
The AIE to AI Migration Tool does not migrate AR System type of data exchanges
with Delta setting.
Not supported.
The AIE to AI Migration Tool does not migrate data exchanges that use same class as
used in the Relationship. For example, if you create data exchange for class
BMC_ComputerSystem and create Relationship exchanges and mapping with same
class BMC_ComputerSystem and used this Relationship in To Be triggered mode
with exchanges, in this case, the data exchange is not migrated.
Not supported.
Checksum for relationship mapping is not migrated.
Manually add a character type attribute in

the BaseRelationship and then proceed
with configuring the checksum.
Planning the migration of BMC Atrium Integration Engine data exchanges to Atrium
Integrator
You must review the following topics:
Migration paths supported by the AIE to AI Migration Tool
Before migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator
To plan the migration of BMC Atrium Integration Engine data exchanges to Atrium Integrator
consider the following:
To begin with the planning, review the following:
Overview of the AIE to AI Migration Tool.
Data exchanges that are migrated to Atrium Integrator.
Limitations of AIE to AI Migration Tool when migrating data exchanges.
Migration of data exchange parameters to Atrium Integrator.
Review all data exchanges and ensure that the ones that need to be migrated are activated.
BMC Atrium Core 9.0
Page 844 of 2268
Home
Migration paths supported by the AIE to AI Migration Tool

The AIE to AI Migration Tool supports the migration of data exchanges from BMC Atrium
Integration Engine version 7.1.00 and later to Atrium Integrator version 8.0.
Before migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator
Before migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator, ensure that
you have completed the following prerequisites:
Basic configuration prerequisites
Prerequisites for different upgrade scenarios
Prerequisites related to external data storage
Basic configuration prerequisites

Perform the following steps before migrating BMC Atrium Integration Engine data exchanges to
Atrium Integrator:
1. Ensure that all BMC Atrium Integration Engine data exchanges are working correctly.
2. Ensure that the CI mappings are correct in BMC Atrium Integration Engine exchanges.
3. Ensure that you can access custom AR System server form while executing AR System
server exchange.
4. Ensure that server name, with alias or IP address, used as target server for Atrium Integrator
is working correctly or has appropriate entry in host file.
BMC Atrium Core 9.0
Page 845 of 2268
Home
Prerequisites for different upgrade scenarios

Consider the following scenarios if you have upgraded BMC Atrium CMDB or BMC Remedy Action
Request System from previous version to 9.0 version:
Scenario
Prerequisites
AIE 7.6.04 SP2 or AIE 8.1 installed

on a different computer
Do not uninstall the existing version of BMC Atrium Integration Engine

Install AI server along with its related content on integration or primary server
Do not stop the activities of the existing BMC Atrium Integration Engine
exchanges
Before migration, copy all BMC Atrium Integration Engine source files (csv and
XML) to a computer on which AR System server and AI server are installed
AIE 7.604 SP2 installed on a

primary or integration server
Upgrade the integration server to version 9.0

Do not uninstall the existing BMC Atrium Integration Engine
Do not stop the activities of the existing BMC Atrium Integration Engine
exchanges on AR System server 9.0
Migrate the existing BMC Atrium Integration Engine exchanges running on AR
System server to AI Repository
AIE 7.6.04 SP2 or AIE 8.1 installed

on a computer that has midtier
installed
Copy all BMC Atrium Integration Engine source files (csv and XML) to the AR
System server or the integration server on which you intend to install BMC
Install existing version (7.6.04 SP2 or 8.1, as applicable) of BMC Atrium
Integration Engine on the computer on which AR System server is installed
Ensure that BMC Atrium Integration Engine exchanges are running
Upgrade AR System server or Integration server to 9.0
Install AI server along with its related content on integration or primary server
Migrate the existing BMC Atrium Integration Engine exchanges running on AR
System server to Atrium Integrator Repository
Prerequisites related to external data storage

You must also complete the tasks listed in the following table
External
data store
Perform the following action
XML or
Comma
If BMC Atrium Integration Engine and Atrium Integrator are installed on different servers, manually copy the XML or
CSV files to the Atrium Integrator server. The location of the XML or CSV files on the Atrium Integrator server must
separated
value (CSV
be the same as the location that was specified for BMC Atrium Integration Engine. For example, if the XML files are
stored in the C:\AIE\XMLFiles directory, you must create the same directory structure on the Atrium Integrator
) flat file
server and copy the XML files to that location. If the directory path is different, update the directory path in the AIE to
AI Migration Tool in the File name/Table name column. For XML and CSV, before migration, create a connector
through AUI wizard. The same connector is used by AIE to AI Migration Tool to migrate the jobs.
DB2 UDB
For the data exchanges that connect to DB2 UDB data stores, you must add the instances and host names of those
DB2 UDB data stores to the db.properties file. The db.properties file is located in the following directory on the
Atrium Integrator server: ARInstallationDirectory\diserver\data -integration\ngie\conf
BMC Atrium Core 9.0
Page 846 of 2268
Home
External
data store
Perform the following action
Oracle
Server
For the data exchanges that connect to Oracle data stores, you must add the Oracle System ID (SID) and host
names of those Oracle data stores to the db.properties file. The db.properties file is located in the following
directory on the Atrium Integrator server: ARInstallationDirectory\diserver\data-integration\ngie\conf
Non-default
target AR
server
For a data exchange where the default destination server is set to No and a different CMDB other than the default
server is used, update the target connection of the data exchange with User Name: Remedy Application Service
and Password: RApp Password

The AIE to AI Migration Tool supports the migration of all BMC Atrium Integration Engine data
exchanges types (AR, CI Class, and Relationship Class) to Atrium Integrator. However, the AIE to
AI Migration Tool does not migrate the following data exchanges:
Event driven data exchanges are migrated as independent jobs. For more information see,
Setting up event-driven jobs in Atrium Integrator .
Note
A data exchange (AR, CI Class, and Relationship Class) for which you have configured
the To Be Triggered option is migrated as child of parent data exchange.
Data exchanges (Relationship Class) that are not triggered by other CI Class data
exchanges or are configured with the To Be Triggered option without a parent job
Data exchanges (Relationship Class) for which you have configured the Schedule Only
option
For information about how the supported data exchanges are migrated to Atrium Integrator, see
Migration of data exchange parameters to Atrium Integrator .

The following table describes the BMC Atrium Integration Engine data exchange parameters that
are migrated to Atrium Integrator by the AIE to AI Migration Tool.
BMC Atrium Integration Engine data exchange parameters
BMC Atrium
Integration
Engine data
exchange
parameter
In Atrium Integrator
Exchange Name
Exchange is migrated as is.
Instance Name
Instance names are not migrated to Atrium Integrator. All migrated data exchanges run under a single carte
server.
BMC Atrium Core 9.0
Page 847 of 2268
Home
BMC Atrium
Integration
Engine data
exchange
parameter
In Atrium Integrator
Data Exchange
Type
The AIE to AI Migration Tool supports all the data exchange types:
AR
CI Class
Relationship Class
The AIE to AI Migration Tool migrates only those Relationship Class data exchanges that are triggered
by other CI Class data exchanges.
External Data
Store
The AIE to AI Migration Tool supports the following external data stores:
Comma separated value (CSV) flat file
Oracle Server
SQL Server
XML
DB2
Direction
The AIE to AI Migration Tool supports the following external data stores:
External data into AR System
External data into CMDB
Execute
Exchange As
The AIE to AI Migration Tool supports the following methods of execution:

Schedule Only
Event Driven Only
Concurrent
Session Limit
Not applicable
Data in Target (
Insert/Update/
The AIE to AI Migration Tool migrates all the settings for this parameter. However, each setting does not
correspond to a specific setting in Atrium Integrator. If a record deleted from source option is set to Delete
Delete)
according to data mapping, that setting is migrated as a delete transformation within the corresponding Atrium
Integrator job.
Note: If the following Data in Target options are configured for a data exchange, that data exchange is
migrated as a delete job in Atrium Integrator.
Create a record option = Never
Update existing records = No
If a record is deleted from source option = Delete according to data mapping For more information, see
Mapping target attributes to source columns
Migration of data exchange settings to Atrium Integrator

In addition to migrating the BMC Atrium Integration Engine data exchange parameters, the AIE to
AI Migration Tool migrates most of the data exchange settings. All data exchanges in BMC Atrium
Integration Engine consist of the following settings:
Migration of data mappings to Atrium Integrator
BMC Atrium Core 9.0
Page 848 of 2268
Home
Migration of manage execution settings to Atrium Integrator

Migration of connection settings to Atrium Integrator
Migration of advanced settings to Atrium Integrator
For more information about each setting, see the BMC Atrium Integration Engine User Guide .
Migration of data mappings to Atrium Integrator

Migration of data mappings
Recommendation
To verify if rules are migrated correctly to Atrium Integrator
Migration of data mappings

Data mappings in BMC Atrium Integration Engine define how data in the source corresponds to
data in the target and which actions to take when transferring the data.
BMC Atrium Integration Engine enables you to specify multiple data mappings for a data
exchange. However, the AIE to AI Migration Tool migrates only the first main data mapping
that is defined for a data exchange. You must migrate data mappings one at a time.
The AIE to AI Migration Tool does not migrate the delete and response fields.
The AIE to AI Migration Tool does not migrate queries that are set for data mappings.
You can only map zero or one to a response field and not to any CMDB field. However,
mapping of other CMDB fields as response is possible through BMC Atrium Integrator Spoon
by modifying the UpdateResponse step.
In BMC Atrium Integration Engine data exchange, if the data set ID is not mentioned at the
main mapping level, the data set ID specified at the Data Field Mapping level is used. If the
data set ID is not mentioned even at the Data Field Mapping level, BMC.SAMPLE is used as
the data set ID.
The AIE to AI Migration Tool migrates a subset of the rules that can be defined for the data
mappings in BMC Atrium Integration Engine. However, if in BMC Atrium Integration Engine the rule
is disabled or if the syntax is wrong, then the AIE to AI Migration Tool does not migrate the
associated attribute.
The rules are migrated to Atrium Integrator as Java code. For example, if you have defined a rule
that uses the timestamp() function, the AIE to AI Migration Tool creates the following Java code
for that rule in Atrium Integrator:
public boolean processRow(StepMetaInterface smi, StepDataInterface sdi)
throws KettleException{
Object[] r = getRow();
if (r == null) {
setOutputDone();
BMC Atrium Core 9.0
Page 849 of 2268
Home
return false;
}
if (first){
first = false;
}r = createOutputRow(r, r.length+5);
String o = getData(r);
putRow(data.outputRowMeta, r);
return true;
}
private String getData(Object[] r) throws KettleException{
String rule1 = timestamp();
get(Fields.Out, "AssignedTo_100").setValue(r, rule1);
return null;
}
private static String concat(String[] strArray){
String str = "";
for(int i=0; i<strArray.length; i++){
str = str + strArray[i];
}return str;
}
For more information about the rule and function syntax in BMC Atrium Integration Engine and the
corresponding Java code in Atrium Integrator, see Mapping BMC Atrium Integration Engine rules
and function syntax with corresponding Java output in Atrium Integrator .
Recommendation
After migrating rules to Atrium Integrator, verify if rules are migrated correctly.

1. Open the transformation in Atrium Integrator Spoon.
2. Double-click the Set Rules step.
3. Click Test Class.
If there are any errors in the migrated rules an error occurs.
Migration of manage execution settings to Atrium Integrator

In Atrium Integrator 8.1 and later, when migrating schedules please consider the following:
In BMC Atrium Integration Engine, for Time-based (weekly) schedules, you can set
schedules at different times on different days. When you migrate such schedules to Atrium
Integrator, the schedule is set to same time on all the selected days. Wherein, the first time
specified in the schedule is selected.
For example,
BMC Atrium Core 9.0
Page 850 of 2268
Home
In BMC Atrium Integration Engine the schedule is set as:

- Monday: 11:00 AM
- Wednesday: 1:00 PM
- Friday: 10:00 AM
In Atrium Integrator the schedule will be set to 11:00 AM on all the selected days.
When you migrate Interval based schedules from BMC Atrium Integration Engine, the
minimum interval in Atrium Integration for a schedule can be set to 30 minutes. All the
schedules in BMC Atrium Integration Engine with interval less than 30 minutes will be set to
30 minutes by default in Atrium Integrator.
Job schedules report

ScheduleReport.txt report is generated for schedules migrated using the AIE to AI migration tool.
You can access the schedule report from the migration log location. The report provides following
information:
Exchange Name: Name of exchange in BMC Atrium Integration Engine
Job Name: Name of Job in Atrium Integrator
Job Directory: Atrium Integrator directory in which the job is migrated
AIE Exchange Schedule was as follows: Schedule time in BMC Atrium Integration Engine
AI Job Scheduled at time: Schedule time in time Atrium Integrator
AI Job Scheduled for weekday: Schedule day(s)
AI Job Scheduled on Carte Server: Atrium Integrator Carte server from where the job will run
Following is a snippet of the ScheduleReport.txt file:
Report of Job Schedules Exchange Name : TestComputer1 Job Name:
TestComputer1 Job Directory: /premq645_TestComputer1_BMC.SAMPLE AIE
Exchange Schedule was as follows: Thursday 1:25:42 PM
AI Job Scheduled at time: 2012/Jul/13 13:25:42
AI Job Scheduled for weekday: Thursday
AI Job Scheduled on Carte Server: vw-pun-atm-qa11
Migration of connection settings to Atrium Integrator

The connection settings that you specify for a data exchange enable BMC Atrium Integration
Engine to communicate with an external data store. You have to specify the connection settings for
every data exchange even if you are using the same external data store (Oracle Server or SQL
Server) for multiple data exchanges. However, in Atrium Integrator you need to specify the data
store connection settings only once by using the Manage Data Stores window, as shown in the
following figure. You can then select the appropriate data store connection when creating a job.
BMC Atrium Core 9.0
Page 851 of 2268
Home
When you migrate a data exchange for which the Oracle Server or SQL Server option is selected
as the external data store, the AIE to AI Migration Tool creates a record in the Manage Data Stores
window and associates that data store connection with the corresponding job in Atrium Integrator. If
the same connection settings have been specified for multiple data exchanges, the AIE to AI
Migration Tool creates only one data store connection record in the Manage Data Stores window in
Atrium Integrator.
Manage Data Stores window
Migration of advanced settings to Atrium Integrator

The AIE to AI Migration Tool does not migrate the advanced settings of the BMC Atrium Integration
Engine data exchanges to Atrium Integrator. However, you can modify these settings by modifying
the transformation in Atrium Integrator Spoon.
Advanced settings for the CI Class mappings are migrated as follows:
Only the checksum and retrieve delta information is migrated.
You can enable caching from Atrium Integrator Spoon.
If there are certain fields that cause problems during transfer, records with remaining fields
are transferred. If you do not want to transfer the remaining records, modify the
transformation in Atrium Integrator Spoon.
If a field contains only blanks, the field is migrated as is. If you want to transfer the field with
null value, modify the transformation in Atrium Integrator Spoon.
BMC Atrium Core 9.0
Page 852 of 2268
Home
While comparing, primary key's trailing blanks are considered for migration. If you want to
ignore trailing blanks, modify the transformation in Atrium Integrator Spoon.
Change history of fields is not migrated.
Migrating BMC Atrium Integration Engine data exchanges to Atrium Integrator

Perform the following steps to migrate your existing BMC Atrium Integration Engine data
exchanges to Atrium Integrator.
If something goes wrong while migrating the data exchanges, you must delete the newly created
jobs and connectors, make necessary changes and migrate again.
Note
Before you edit a data exchange, please make sure that the AIE to AI Migration tool is
closed.
AIE to AI Migration
To migrate BMC Atrium Integration Engine data exchanges to Atrium Integrator

1. On the computer on which the Atrium Integrator server is installed, click Start > Programs >
BMC Software > Atrium Integrator > AIE to AI Migration Tool to open the AIE to AI
Migration Tool, as shown in the following figure.
AIE to AI Migration Tool
BMC Atrium Core 9.0
Page 853 of 2268
Home
2. In the AIE Server Details area, specify the details about the server on which BMC Atrium
Integration Engine is installed:
a. In the Server Name field, enter the host name of the BMC Remedy AR System
server on which you have installed BMC Atrium Integration Engine.
b. In the TCP Port field, enter the port that you have configured for the BMC Remedy
AR System server.
c. In the Log on Name field, enter the user name for the BMC Remedy AR System
server.
d. In the Password field, enter the credentials for the BMC Remedy AR System server.
3.
BMC Atrium Core 9.0
Page 854 of 2268
Home
3. Click Get Exchanges to retrieve the data exchanges from the BMC Atrium Integration
Engine instance that you specified in step 2.
Note
The data exchanges that are triggered by another data exchange are automatically
migrated to the Atrium Integrator server when you migrate the data exchange that
triggers the data exchanges.
4. In the Target Server Details area, specify the details about the Atrium Integrator server to
which you want to migrate the data exchanges:
a. In the Server Name field, enter the host name of the BMC Remedy AR System
server on which you have installed the Atrium Integrator server.
b. In the TCP Port field, enter the port that you have configured for the BMC Remedy
AR System server.
c. In the Password field, enter the password of Remedy Application Service user.
5. Click Test Connection to confirm that you can successfully connect to the Atrium Integrator
server that you have specified in step 4.
6. Select the data exchanges that you want to migrate to the Atrium Integrator server.
You can edit the path of .csv and .xml file for the flat file or XML type of data
exchanges. Double-click the file name displayed in the File Name/Table Name
column and make the changes.
Note
Do not add extensions for file names.
The Migrated column in the AIE to AI Migration Tool displays the migration status of
the data exchanges.
7. Click Migrate to migrate the selected data exchanges to the Atrium Integrator server.
You can view messages related to the status of the migration process in the AIE to AI
Migration Tool window.
Note
On the target server in any directory of the repository, if a transformation has a
name similar to an existing date exchange (created through Atrium Integrator or
migrated from AIE to AI Migration Tool) then the migration status of the
transformation is displayed as Yes in the AIE to AI Migration Tool.
8.
BMC Atrium Core 9.0
Page 855 of 2268
Home
8. (optional) To clear the status messages that are displayed in the AIE to AI Migration Tool,
click Clear Messages.
After the migration process is complete, open the corresponding jobs in BMC Atrium
Integrator Spoon and verify that the job definition and settings have been successfully
migrated.
You can identify the migrated jobs as:
<Source AR system server><Parent job name><datasetID>
Note
If there are Delete only data exchanges in a migrated job then the job is created as
a separate job. Also, To Be Triggered mode is not set for Delete transformations
even if the corresponding data exchange was set to To Be Triggered mode in BMC
Atrium Integrator Engine. You must rearrange the Delete transformation at sub job
level according to the corresponding data exchange in BMC Atrium Integrator
Engine.
After the migration is complete, ensure that Atrium Integrator Pentaho repository is
created with the correct server name.
For instances of flat file migration, check the arcarte.log to ensure that Atrium
Integrator Carte Server has successfully migrated all the flat file entries under NGIE
:FileMetaData.
For more information, see Migration of data exchange parameters to Atrium Integrator .
Troubleshooting issues with the data exchange migration process

The Status messages area in the AIE to AI Migration Tool window displays messages related to the
status of the migration process. If there are errors in the migration process, you can view the
following files for detailed information:
MigrationInfo.txt
Migrationdbg.log
The log files are located in the following directory:
<ARInstallationDirectory>\diserver\data-integration\ngie\ngie\log
You can also click the View Log button on the AIE to AI Migration Tool window to view logging
details.
BMC Atrium Core 9.0
Page 856 of 2268
Home
For more troubleshooting information about data exchange migration, see Troubleshooting data
exchange migration issues.
Viewing migrated data exchanges in Atrium Integrator

This section provides information about how the different types of data exchanges in BMC Atrium
Integration Engine data are migrated to Atrium Integrator. You can use this information to verify that
your data exchanges have been successfully migrated to Atrium Integrator.
When you migrate data exchanges from BMC Atrium Integration Engine to Atrium Integrator and if
the jobs fail to publish, the .ktr files of the jobs are available:
(Microsoft Windows) %USERPROFILE%

(UNIX) the home directory
The AIE to AI Migration Tool migrates active and inactive data exchanges as corresponding jobs in
Atrium Integrator. However, all migrated jobs are active because Atrium Integrator does not have a
corresponding inactive status.
When the AIE to AI Migration Tool migrates CSV and XML data exchanges as jobs in Atrium
Integrator, if space is used in a field or column in the CSV or XML file, then the space is replaced
by an underscore.
The following table describes how data exchanges are migrated to Atrium Integrator.
Mapping data exchanges to jobs and transformations in Atrium Integrator
Data exchange type
Schedule
Only
Event
Driven Only
To Be
Triggered
Migrated to Atrium Integrator
Yes
No
Yes
Yes (as a transformation of the job that triggers

this data exchange)
Yes
No
No
Yes (as a standalone job)
No
Yes
Yes

this data exchange)
No
Yes
No
No
Yes
No
Yes

this data exchange)
Yes
No
No
No
No
Yes
Yes

this data exchange)
No
Yes
No
No
AR
CI Class
Relationship Class
BMC Atrium Core 9.0
Page 857 of 2268
Home
Scenario for migrating data exchanges to Atrium Integrator

Before you are migrate all your data exchanges from BMC Atrium Integration Engine to Atrium
Integrator, BMC recommends to do a test migration.
The following example shows how the Sample ITSM BusinessService data exchange and the
associated data mappings are migrated to Atrium Integrator as a job and transformation.
The following figure illustrates the start and end points of the migration process.
Sample migration of data exchanges to Atrium Integrator
To migrate Sample ITSM BusinessService data exchange and the associated data mappings
to Atrium Integrator
1. On the BMC Atrium Integration Engine server, verify if the Sample ITSM BusinessService
data exchange and the associated data mappings are fit for migration and make the
necessary changes if required.
For more information data exchanges and data mappings that are migrated to Atrium
Integrator see,
The following figure illustrates the Sample ITSM BusinessService data exchange in
the BMC Atrium Integration Engine
Sample ITSM BusinessService data exchange in the BMC Atrium Integrator
BMC Atrium Core 9.0
Page 858 of 2268
Home
2. On the target server where you have installed Atrium Integrator, open the AIE to AI Migration
Tool.
3. In the AIE Server Details area, specify the details about the server on which BMC Atrium
Integration Engine is installed.
4. In the Target Server Details area, specify the details about the Atrium Integrator server to
which you want to migrate the data exchanges.
5. Click Test Connection to confirm that you can successfully connect to the Atrium Integrator
server.
6. Select Sample ITSM BusinessService data exchange to migrate to the Atrium Integrator
server.
7. Click Migrate.
The following figure illustrates the successful migration of Sample ITSM BusinessService
data exchange to Atrium Integrator.
Successful migration of Sample ITSM BusinessService data exchange
BMC Atrium Core 9.0
Page 859 of 2268
Home
8. Verify if Sample ITSM BusinessService data exchange is now available as a job in Atrium
Integrator as shown in the following figure.
Sample ITSM BusinessService job in Atrium Integrator
BMC Atrium Core 9.0
Page 860 of 2268
Home
9. You can also verify the migration through BMC Atrium Integrator Spoon as shown in the
following figure.
Sample ITSM BusinessService job in BMC Atrium Integrator Spoon
BMC Atrium Core 9.0
Page 861 of 2268
Home
Mapping BMC Atrium Integration Engine and Atrium Integrator

The following topics provides mappings between BMC Atrium Integration Engine and Atrium
Integrator.
Mapping BMC Atrium Integration Engine tasks and terminology to Atrium Integrator
Mapping BMC Atrium Integration Engine rules and function syntax with corresponding Java
output in Atrium Integrator
Mapping BMC Atrium Integration Engine tasks and terminology to Atrium Integrator
This section describes Atrium Integrator terminology and tasks that correspond to BMC Atrium
Integration Engine terminology and tasks.
BMC Atrium Integration Engine tasks and Atrium Integrator terminologies

The following table describes Atrium Integrator terms that map to BMC Atrium Integration Engine
terms.
Mapping Atrium Integrator terms to BMC Atrium Integration Engine terms
BMC Atrium Integration Engine term
Corresponding Atrium Integrator term
data exchange
job
data mapping
transformation
BMC Atrium Integration Engine tasks and Atrium Integrator tasks

The following table describes Atrium Integrator tasks that map to BMC Atrium Integration Engine
tasks.
Mapping Atrium Integrator tasks to BMC Atrium Integration Engine tasks
BMC Atrium
Integration Engine
task
Corresponding Atrium Integrator task
Populate field menus
Create a data store connection so that the wizard can display source columns. For more information,
see Creating a new data store connection in Atrium Integrator .
Create a data mapping
Map target attributes to source columns in the CI Mapping page of the Integration Job Builder wizard.
for CI classes
For more information, see Mapping target attributes to source columns.
Create a data mapping

for relationship classes
Map target attributes to source columns in the Relationship Mappings page of the Integration Job
Builder wizard. For more information, see Defining relationship mapping for the CI types to transfer.
Define and execute a

data exchange
Schedule a job and execute it. For more information, see Creating a job schedule.
Define connection
settings to an external
database
Create a data store connection. For more information, see Creating a new data store connection in
Atrium Integrator.
Define rules
BMC Atrium Core 9.0
Page 862 of 2268
Home
BMC Atrium
Integration Engine
task
Corresponding Atrium Integrator task
Edit the job or transformations in Atrium Integrator Spoon. For more information, see Understanding
Atrium Integrator
Use multiple BMC
You can open multiple sessions of Atrium Integrator Spoon to run different jobs. Each Atrium Integrator
Atrium Integration
Engine instances for
Spoon session is a different process.
improving performance.
Use multithreading to
improve performance.
Launch several copies of the CMDBOutput step to increase the overall throughput of the data transfer
job. For more information, see Launching several copies of a step in BMC Atrium Integrator Spoon . For
information about editing CMDBOutput step, see Verifying jobs with table as input and BMC Atrium
CMDB as output.
View log files to debug

errors.
See errors directly in the Execution Results area of Atrium Integrator Spoon.
Mapping BMC Atrium Integration Engine rules and function syntax with
corresponding Java output in Atrium Integrator
The following table lists the rule and function syntax that the AIE to AI Migration Tool can migrate to
Atrium Integrator. For more information and examples about the rule and function syntax, see the
BMC Atrium Integration Engine User's Guide in PDFs and videos.

Rule syntax and functions that are migrated as Java code in Atrium Integrator
Rule
syntax in
Function in BMC Atrium

Integration Engine
Corresponding Java code in Atrium Integrator
constant
|
Not applicable
Not applicable
function
|
calc_token_id
public String calc_token_id(String[]
BMC
Atrium
Integration
Engine
strList) throws NoSuchAlgorithmException,

UnsupportedEncodingException
MessageDigest md;md =
MessageDigest.getInstance("MD5");byte[]
md5hash = new byte; //strList should
not be null if null then do not
implement this functionString text =
concat(strList);md.update
(text.getBytes("iso-8859-1"), 0,
text.length());md5hash =
md.digest();return convertToHex(md5hash);}
function
|
currentdate()
private static String

currentdate(){return
DateFormat.getDateInstance(DateFormat.LONG).
format(new Date());}
BMC Atrium Core 9.0
Page 863 of 2268
Home
Rule
syntax in
BMC
Atrium
Integration
Engine

Integration Engine
function
|
currenttime()
private static String currenttime()

{SimpleDateFormat sdf =
new SimpleDateFormat("hh:mm:ss")
;return sdf.format(new Date());}
function
|
date(timestamp)
private static String date(String date)
(where timestamp is a
constant, field name, or
function)
{String ret =null;SimpleDateFormat sdf =

new SimpleDateFormat
("EEEE, MMMM dd, yyyy hh:mm:ss aa");try
{ret = (DateFormat.getDateInstance
(DateFormat.MEDIUM).format
(sdf.parse(date.replace(".", ""))));}
catch (ParseException e) {e.printStackTrace()
;}return ret;}|
function
|
day(timestamp)
private static int day(String date)

function)
"EEEE, MMMM dd, yyyy hh:mm:ss aa")
;int day=-1;try
{day= (sdf.parse(date.replace(".", "")).getDate());
} catch (ParseException e)
{e.printStackTrace();}return day;}
function
hour(timestamp)
private static int hour(String date)
function)
{SimpleDateFormat sdf = new SimpleDateFormat

("EEEE, MMMM dd, yyyy hh:mm:ss aa")
;int hour=-1;try {hour=
(sdf.parse(date.replace(".", "")).getHours());} catch (
ParseException e) {e.printStackTrace();}return hour;}
function
|
timestamp
private static String timestamp()

{Calendar currentDate =
Calendar.getInstance();SimpleDateFormat
formatter= new SimpleDateFormat
("yyyy/MMM/dd HH:mm:ss")
;String dateNow = formatter.format
currentDate.getTime());return dateNow;}
function
|
time(timestamp)
private static String time(String date)
function)
{String ret =null;SimpleDateFormat

sdf = new SimpleDateFormat
;SimpleDateFormat sdf1 = new SimpleDateFormat
("hh:mm:ss");try
{ret = sdf1.format(sdf.parse(date.replace
(".", "")));} catch
(ParseException e) {e.printStackTrace();
}return ret;}
BMC Atrium Core 9.0
Page 864 of 2268
Home
Rule
syntax in
BMC
Atrium
Integration
Engine

Integration Engine
function
|
weekday(timestamp)
private static int weekday(String date)
function)
tmp=-1;try {tmp= (sdf.parse(date.replace(".", "")).getDay())+1;}
("EEEE, MMMM dd, yyyy hh:mm:ss aa");int

catch (ParseException e) {e.printStackTrace();}return tmp;}
function
|
year(timestamp)
private static String year(String date)
{String ret =null;SimpleDateFormat sdf =

function)
;SimpleDateFormat sdf1 = new SimpleDateFormat
("yyyy");try {ret = sdf1.format
(sdf.parse(date.replace(".", "")));}
catch (ParseException e)
{e.printStackTrace();}return ret;}
function
minute(timestamp)
private static int minute(String date)

;int tmp=-1;try
{tmp= (sdf.parse(date.replace(".", ""))
.getMinutes());} catch (ParseException e) {e.printStackTrace();}
return tmp;}
function
|
month(timestamp)
private static int month(String date)
function)
;int tmp=-1;try

{tmp= (sdf.parse(date.replace(".", ""))
.getMonth())+1;} catch (ParseException e) {e.printStackTrace();}
return tmp;}
function
|
second(timestamp)
private static int second(String date)
function
;int tmp=-1;try {tmp=
(sdf.parse
(date.replace(".", "")).getSeconds());}
catch (ParseException e)
{e.printStackTrace();}return tmp;}
function
|
concat(string,string
, string,...)
private static String concat
(where string is a constant,

field name, or function)
{String str = "";for
(String[] strArray)
(int i=0; i<strArray.length; i++){str = str + strArray
HTMLUATatriumcoreAIG:i;}return str;}
BMC Atrium Core 9.0
Page 865 of 2268
Home
Rule
syntax in
BMC
Atrium
Integration
Engine

Integration Engine
function
|
left(string,long)
private static String subStringLeft
(where string and long are

constants, field names, or
(String strMain, int numChar){return strMain.substring(0,numChar

);}
functions)
function
|
length(string)
private static int stringLength

(String strMain){return strMain.length();}
function
lower(string)
private static String lowerCase

(String strMain){return strMain.toLowerCase();}
function
lpad(string,long,
private static String leftPad
string)
(String strMain, int size, String padStr)

functions)
{if (strMain == null) {{}return null;}

if (padStr == null || padStr.length() == 0)
{padStr = " ";}int padLen = padStr.length()
;int strLen = strMain.length();int pads =
size - strLen;if (pads <= 0) {return strMain;}
if (pads == padLen)
{return padStr.concat(strMain);}
else if (pads < padLen)
{return padStr.substring
(0, pads).concat(strMain);}
else {char[] padding =
new charHTMLUATatriumcoreAIG:pads;char[] padChars =
padStr.toCharArray();for
(int i = 0; i < pads; i++)
{paddingHTMLUATatriumcoreAIG:i =
padCharsHTMLUATatriumcoreAIG:i %
padLen;}
return new String(padding).concat(strMain);}{}}
function
ltrim(string)
private static String leftTrim(String strMain){while(

strMain.startsWith(" ")){strMain = strMain.substring(1);}return

strMain;}
function
|
max(any,any,any,...)
public static Object max(Object[] numbers)
(where any is a constant,

{Object maxValue = null;if

(numbersHTMLUATatriumcoreAIG:
0 instanceof Integer)
{Integer[] intArray =
(Integer[])Arrays.copyOf
(numbers, numbers.length, Integer[].class)
;maxValue = max(intArray);}
if(numbersHTMLUATatriumcoreAIG:
0 instanceof String)
{String[] stringArray =
(String[])Arrays.copyOf
BMC Atrium Core 9.0
Page 866 of 2268
Home
Rule
syntax in
BMC
Atrium
Integration
Engine

Integration Engine
(numbers, numbers.length, String[].class)

;maxValue = max(stringArray);}
if(numbersHTMLUATatriumcoreAIG:
0 instanceof Double)
{Double[] doubleArray =
(Double[])Arrays.copyOf
(numbers, numbers.length, Double[].class)
;maxValue = max(doubleArray);}return maxValue;}
function
|
min(any,any,any,...)
public static Object min(Object[] numbers)
(where any is a constant,

{Object minValue = null;if

(numbersHTMLUATatriumcoreAIG:0 instanceof Integer)
{Integer[] intArray =
(Integer[])Arrays.copyOf(numbers, numbers.length, Integer[].
class);minValue = min(intArray);}
if(numbersHTMLUATatriumcoreAIG:0 instanceof String)
{String[] stringArray =
(String[])Arrays.copyOf
(numbers, numbers.length, String[].class)
;minValue = min(stringArray);}
if(numbersHTMLUATatriumcoreAIG:0 instanceof Double)
{Double[] doubleArray = (Double[])Arrays.copyOf(numbers,
numbers.length, Double[].class);minValue = min(doubleArray);}
return minValue;}
function
trunc(real)
public static int trunc(double Rval) {return (int)Math.floor(
(where real is a constant,

Rval);}
function
|
null()
Not applicable
function
|
replace(string,
string,string...)
private static String replaceString

String replaceWith)
(String strMain, String toReplace,

{return strMain.replace
(toReplace, replaceWith);}
function
|
right(string,long)
function
|
round(real)
function
|
rpad(string, long,
string)

(where real is a constant,


functions)
BMC Atrium Core 9.0
private static String subStringRight(String strMain, int numChar

){return strMain.substring(strMain.length()-numChar,
strMain.length());}
public static double round(double Rval) {return Math.round(Rval)
;}
private static String rightPad(String strMain, int size, String

padStr) {if (strMain == null) {return null;}if (padStr == null |
| padStr.length() == 0) {padStr = " ";}int padLen =
padStr.length();int strLen = strMain.length();int pads = size strLen;if (pads <= 0) {return strMain;}if (pads == padLen) {
Page 867 of 2268
Home
Rule
syntax in
BMC
Atrium
Integration
Engine

Integration Engine
return strMain.concat(padStr);} else if (pads < padLen) {return

strMain.concat(padStr.substring(0,pads));} else {char[] padding
= new charHTMLUATatriumcoreAIG:pads;char[] padChars =
padStr.toCharArray();for (int i = 0; i < pads; i++) {padding
HTMLUATatriumcoreAIG:i = padCharsHTMLUATatriumcoreAIG:i % padLen
;}return strMain.concat(new String(padding));}}
function
|
rtrim(string)
private static String rightTrim(String strMain){while(

strMain.endsWith(" ")){strMain = strMain.substring(0,
strMain.length()-1);}return strMain;}
function
|
status()
Not applicable The status () function is used only for response mapping. However,
function
|
strstr(string,
string)
in Atrium Integrator, Response will be indicated in the job results.

private static String subString(String strMain, int beginIndex){
return strMain.substring(beginIndex);}

function
|
substr(string,long,
HTMLUATatriumcoreAIG
private static String subString(String strMain, int beginIndex,

int endIndex){return strMain.substring(beginIndex, endIndex);}
:,long) (where string

and long are constants,
field names, or functions)
function
upper(string)
private static String upperCase(String strMain){return

strMain.toUpperCase();}
stmt|
Not applicable
Not applicable
Normalizing data
The process of normalization makes sure that product names and categorization are consistent
across different datasets and from different data providers.
Overview of normalization
Typical normalization setup
Optional normalization tasks
BMC Atrium Core 9.0
Page 868 of 2268
Home
Overview of normalization
The Normalization Engine is a policy enforcement engine installed with the BMC Atrium
Configuration Management Database (BMC Atrium CMDB) product. It enables you to centrally
define data policies and automatically enforce them throughout BMC Atrium CMDB.
The following topics provide information about how normalization works in BMC Atrium CMDB:
Normalization features
Normalization status
Normalization process
Normalization and NULL values for Model (Product Name) and ManufacturerName
Multitenancy support in the Normalization Engine
Normalization and software license management
Normalization and impact relationships
Normalization and best-practice relationship rules
Normalization and instance permissions
Normalization and custom rules
Normalization Failover - Scheduled Batch Jobs
Normalization use cases
Calbro scenario for normalization
When multiple sources provide data to BMC Atrium CMDB, data consistency problems such as the
following can occur:
Inconsistent categories and naming
Duplicate configuration items (CIs)
The Normalization Engine provides a centralized, customizable, and uniform way to overcome data
consistency problems. This consistency in BMC Atrium CMDB data enables consuming
applications to make good decisions. For example, BMC Asset Management can report on software
license usage appropriately.
You can normalize data before or after it is written to a dataset in BMC Atrium CMDB. With the
Normalization Engine, you can define what is normalized:
A specific dataset, such as BMC.ADDM
You can enable or disable normalization for each dataset, as well as configure other
normalization features.
A specific class to normalize, such as BMC_Product
You cannot choose to normalize specific classes in different datasets. Instead, you configure
classes across all datasets.
BMC Atrium Core 9.0
Page 869 of 2268
Home
Normalization features
The Normalization Engine includes normalization features that you can enable on individual
datasets. Some features enable you to define rules with conditions, actions to perform, and classes
to normalize.
Note
The Version Normalization and DML (Definitive Media Library) Based Instance
Normalization features are enabled for all datasets by default, and cannot be disabled or
configured for individual datasets.
Version Normalization Sets the MarketVersion attribute for instances to a common

value based on default or custom rules. This feature provides more accurate information for
managing licenses. For more information about the Version Normalization feature, see
Normalization and software license management.
DML Based Instance Normalization In conjunction with the BMC Atrium Product Catalog (
Product Catalog) application, normalizes the following attributes for hardware and software
products:
Product categorization attributes: Category, Type, and Item (CTI)
ManufacturerName
Model (the product name, applicable to software and hardware)
For more information about the DML Based Instance Normalization feature, see
Normalization and the Product Catalog.
Impact Normalization For relationships, sets the impact attributes based on the
out-of-the-box or custom impact rules for the relationship class and the source and
destination classes it relates to. (With version 7.6.03 and later, impact is represented as
attributes in a relationship class. The BMC_Impact class was deprecated.) For more
information about the Impact Normalization feature, see Normalization and impact
relationships.
Relation Name Normalization For relationships, replaces the existing names with the
BMC-recommended or custom names, based on the CI classes in the relationship. For more
information about the Relation Name Normalization feature, see Normalization and
best-practice relationship names.
Instance Level Permissions Sets the row-level permissions on CIs as defined by the CI
classes and additional qualifiers of the Instance attributes. For more information about the
Instance Level Permissions normalization feature, see Normalization and instance
permissions.
BMC Atrium Core 9.0
Page 870 of 2268
Home
Suite Rollup Normalization Allows you to define suites and their products and to identify
an instance as a suite, a suite component, or a standalone application. Allows more accurate
management of suite and individual licenses. For more information about the Suite Rollup
Normalization feature, see Normalization and software license management.
Custom Allows you to create custom rules when the out-of-the-box Normalization features
do not meet your requirements for normalizing data. You can create a custom rule for CI and
relationship classes to perform a set attribute action based on the conditions that you have
defined in a rule. For more information about the Custom Normalization feature, see
Normalization and custom rules.
Note
When you run a normalization job on a dataset, the normalization features that are
enabled for that dataset are run in the following order for a given class:
Version Normalization
DML Based Instance Normalization
Relation Name Normalization
Impact Normalization
Instance Level Permissions
Suite Rollup Normalization
Custom Normalization
The Relation Name Normalization and Impact Normalization features are
applicable to relationship classes only.
Each CI has a NormalizationStatus attribute to track the CI's stages of normalization. The
following table describes the possible values for NormalizationStatus.
NormalizationStatus values
Status value
Numeric
Value
Description
Not
Normalized
20
The default status of an instance is always Not Normalized.
Not
Applicable for
Normalization
30
The CI is not normalized but did not fail because for some classes, normalization is not applicable.
The Normalization Engine assigns this status to CIs with classes not configured for normalization. If
needed, you can configure the classes or remove them for normalization.
Normalization
Failed
40
The CI is not normalized because no Product Catalog entry is found for the CI.
50
The CI is normalized but not approved because the CI matched a Product Catalog entry that is not
approved.
BMC Atrium Core 9.0
Page 871 of 2268
Home
Status value
Numeric
Value
Description
60
The CI is normalized and approved because the following items are true:
Normalized
but Not
Approved
Normalized
and
Approved
The CI matched a unique entry in the Product Catalog.

The matching product is approved.
The CI did not match a Product Catalog entry and the Normalization Engine created a new
entry for it.
Note:
Normalization only creates entries in the Product Catalog if you have enabled Allow New
Product Catalog Entry for a dataset. By default, this setting is disabled.
Modified
After Last
Normalization
70
This status is set if the CI was normalized previously but has changed since it was normalized. This
can happen if the CI has been normalized but at least one attribute that can be normalized has been
modified.
Notes:
If the dataset is set to inline normalization, you might not see this status for a CI, as this status
appears only for continuous and batch mode normalization.
If you face data load or performance issues in Atrium Core for more information see,
Troubleshooting Data load or Performance Issue in Atrium Core .
Note
The NormalizationStatus attribute has an additional value Other. This value is for
future use.

As the following figure shows, the Normalization Engine is part of BMC Atrium CMDB and uses the
Product Catalog to normalize data before the Reconciliation Engine identifies and merges the data.
A Product Catalog entry is not a CI, but specifies the normalized attributes for a CI.
The Normalization Engine does not consider the Product Catalog CI Type field, which defines the
BMC Atrium CMDB class associated with a product, except to categorize instances on class (CTI
Only mode). When both the Model and ManufacturerName attributes are NULL and if the
Category, Type, and Item (CTI) values are populated, the Normalization Engine uses CI Type.
Otherwise, the CI Type is never compared against Product Catalog data.
In the Product Catalog, you can set several status options for each product. The Approved status
can affect normalization, depending on your settings. By default, all Product Catalog entries are
unapproved, and the Normalization Engine normalizes CIs with unapproved entries in the Product
BMC Atrium Core 9.0
Page 872 of 2268
Home
Catalog. In the Normalization console, you can disable the Allow Unapproved CI option to
normalize only approved products. The Definitive Media Library (DML) and Definitive Hardware
Library (DHL) are the approved software and hardware products in the Product Catalog.
For example, a dataset includes an instance of BMC_Product named Financial Advisor Pro 1.0
that Calbro manufactures, and the Calbro administrator uses the default to normalize approved and
unapproved CIs. The Product Catalog has a corresponding entry for that CI.
If the Product Catalog entry for Calbro Financial Advisor Pro 1.0 is approved, then the
Normalization Engine normalizes the CI's attributes and categorization based on the Product
Catalog entry and updates the CI's NormalizationStatus attribute to Normalized and
Approved.
If the Product Catalog entry for Calbro Financial Advisor Pro 1.0 is not approved, then the
Normalization Engine normalizes the CI and updates the CI's NormalizationStatus
attribute to Normalized and Unapproved.
The Managed status is used for tracking products in your organization. You can configure BMC
Atrium CMDB so that CIs for unmanaged products are deleted from the CMDB. In this way, you
can leverage the Managed status to purge unnecessary CIs that are populated in the BMC Atrium
CMDB datasets by discovery tools. For more information, see Using the Managed Product status to
delete unwanted CIs in bulk.
The other status options in the Product Catalog (Hide Product, Lifecycle, Blacklisted Product) do
not affect normalization.
For more information about product status options, see Product Catalog status options.
Normalization process and related components
BMC Atrium Core 9.0
Page 873 of 2268
Home
Normalization process
Normalization Engine works in the following ways:
Normalizes the CIs that have a status of Not Normalized or Normalization Failed or Modified
After Last Normalization.
Normalizes all the CIs, if you set the configuration value to Normalize all the instances.
This is useful when you make changes to product aliases or change the categories of the
products in the Product Catalog.
The Normalization Engine normalizes non-normalized and modified CIs by evaluating CIs using the
Product Catalog:
Product attributes The Model, ManufacturerName, MarketVersion, and (if available
in the CI) the MarketVersion, VersionNumber and PatchNumber attributes of the CI.
Normalization Engine currently uses only the product attributes for normalization.
Signature ID Stored in the Product Catalog and created by discovery tools for identifying
products. For more information about generating the Signature ID, see Using signatures to
identify products in the Product Catalog .
File name and size The name and size of the file.
Note
Signature ID and File name and size are used only with the Normalization Engine
Java API. For more information, see BMC Atrium CDMB Javadoc, which is
available from PDFs and videos.
BMC Atrium Core 9.0
Page 874 of 2268
Home
At every creation/update of the CI the Normalization Engine checks that the CI class is configured
for normalization.
If the class is configured, the Normalization Engine continues the process based on the
dataset configuration for mode of normalization (Inline or Continuous)
If the class is not configured, the Normalization Engine updates the NormalizationStatus
attribute to Normalization Not Applicable and ends the normalization process for the CI.
The Normalization process is as follows:
1. The Normalization Engine checks the Normalization Alias form for aliases for the
ManufacturerName and Model attributes.
2. The Normalization Engine applies Version Rollup rules and sets MarketVersion using the
Version Rollup rules. For information on Version Rollup, see Normalization and software
license management and Configuring Version Rollup normalization rules.
3. The Normalization Engine searches the Product Catalog for a product and its versions
based on Model and ManufacturerName.
Note
For versions 8.1.01 or later, if Model or ManufacturerName are NULL, you must
manually set the values of Model to BMC_UNKNOWN and ManufacturerName
to BMC_UNKNOWN in the Product Catalog. Set the values of Category, Type
and Item appropriately.
If the product is not found, it checks if the Allow New Product Catalog Entry option is
enabled.
4. Normalization Engine checks the product association with the Company populated in the CI.
If it is not associated, the Normalization Engine updates the CI's NormalizationStatus
attribute as Normalization Failed and ends the normalization process for the CI.
5. If version in the Product Catalog is 'Unknown' and version of the CI is NULL, the
Normalization Engine sets the NormalizationStatus and ends the normalization process
for the CI.
6. If MarketVersion is populated for a CI, the Normalization Engine searches the Product
Catalog for a product that matches the CI using ManufacturerName, Model, and
MarketVersion.
BMC Atrium Core 9.0
Page 875 of 2268
6.
Home
If it finds ManufacturerName, Model, and MarketVersion, the Normalization

7. If Normalization Engine does not find a match in the Product Catalog with
ManufacturerName, Model, and MarketVersion, and if VersionNumber is populated
for a CI, it searches the Product Catalog for a product that matches the CI using
ManufacturerName, Model, and VersionNumber.
If it finds a ManufacturerName, Model, and VersionNumber, the Normalization
8. If both, MarketVersion and VersionNumber are not populated for a CI, Normalization
Engine checks for match with ManufacturerName and Model. If it finds a match, the
Normalization Engine substitutes Category, Type, and Item attribute values from the
Product Catalog entry in to the corresponding CI attributes.
9. If the Normalization Engine does not find a Product Catalog entry with matching version, it
checks if the Allow New Product Catalog Entry option is enabled.
After data is normalized, it can be reconciled to the BMC Atrium CMDB production dataset.
Tip
You can use the Product Catalog Mapping Alias with datasets configured for
normalization to control automatic expansion of the Product Catalog. For example, a
Product Catalog Mapping Alias might map all of the data provider's default Tier 1, Tier 2,
and Tier 3 categorization to preferred categorization in the Product Catalog. The Allow
New Product Catalog Entry option is selected for the data provider's dataset in the
BMC Atrium Core 9.0
Page 876 of 2268
Home
Normalization console. So, every time a new product name and manufacturer combination
is discovered, a new Product Catalog entry is created, using the preferred three
categorization tiers and the discovered product name and manufacturer.
Related Topic
Normalization and NULL values for Model (Product Name) and ManufacturerName
The Normalization Engine handles CIs that do not have values for the Model and
ManufacturerName attributes in the following ways when the Normalization Type option is set to
CTI Only.
For each CI type, such as BMC_Product, BMC_OperatingSystem, and BMC_Patch, the Product
Catalog creates only one product entry with the value BMC_UNKNOWN, for both Model and
ManufacturerName attributes.
Note
In versions 8.1.01 or later, for each CI type, such as BMC_Product,
BMC_OperatingSystem, and BMC_Patch, if Model or ManufacturerName are NULL,
you must manually create an entry in Product Catalog, using the value BMC_UNKNOWN
for Model and ManufacturerName attributes. The Product catalog does not create the
entry automatically.
If the CI has no values for both Model and ManufacturerName attributes, the
Normalization Engine substitutes the BMC_UNKNOWN value for the attributes and then
sends a search request to the Product Catalog. If the product does not exist, the
Normalization Engine requests that the Product Catalog create an entry by using the
BMC_UNKNOWN values, and then normalizes the CI. Product creation fails if the CI does
not have values for the Category, Type, and Item attributes.
Note
In versions 8.1.01 or later, if the product does not exist in the Product catalog, you
must manually create an entry using the value BMC_UNKNOWN, for both Model
and ManufacturerName attributes. The Normalization Engine does not request
the Product Catalog to create the entry.
BMC Atrium Core 9.0
Page 877 of 2268
Home
If the CI has no values for both Model and ManufacturerName attributes, the
Normalization Engine substitutes the BMC_UNKNOWN value for the attributes and then
sends a search request to the Product Catalog. Product creation fails if the CI does not have
values for the Category, Type, and Item attributes.
If the CI has no values for either the Model or ManufacturerName attribute, you must
create a product categorization mapping before normalizing.
If a CI has an empty Model attribute, in the Discovery Product Categorization area of
the Catalog Mapping window, type BMC_UNKNOWN as a value for Product Name.
If a CI has an empty ManufacturerName attribute, in the Product Catalog Console,
create a new manufacturer named BMC_UNKNOWN. Then, in the Discovery Product
Categorization area of the Catalog Mapping window, select BMC_UNKNOWN for
Manufacturer Name.
In both cases, for the Mapped Product Categorization area of the Catalog Mapping
window, you can select an existing product or manufacturer name where available.
For more information, see Mapping product categorization aliases.
Multitenancy support in the Normalization Engine

Multitenancy enables a single Product Catalog shared among multiple companies, or tenants
to track the approved products for each company.
You cannot set the Normalization Engine to work differently for different tenants. The same
Normalization Engine configuration is used for all tenants.
However, when normalizing a CI, the Normalization Engine checks for a value of the CI's
AccountID attribute.
If the attribute has a value, the Normalization Engine uses it for the Alias Lookup.
If the attribute does not have a value, the Normalization Engine assumes that the product is
accessible to all companies in Product Catalog, and that multitenancy does not apply.
Normalization and software license management

For software license management, the Normalization Engine provides the Version Normalization
and Suite Rollup Normalization features.
Using the Suite Rollup feature to identify suites that are uninstalled or upgraded
Using Normalization for version and suite rollups
BMC Atrium Core 9.0
Page 878 of 2268
Home
BMC Atrium CMDB versions 7.6.03 and later include the MarketVersion attribute on the
BMC_BaseElement class. This allows you to set a common market version with which licenses are
associated. The VersionNumber attribute stores a full version number, such as 5.0.1.12, which
can change frequently with maintenance releases. To manage licenses more accurately, the
MarketVersion attribute stores a simpler string version, such as 5.0 or 2007. You can then
associate a license with the market version rather than with individual full version numbers.
For example, Calbro Services has multiple service packs and versions for Microsoft Excel:
11.0.5614.0, 11.0.6355.0, 11.0.7969.0, and 11.0.8173.0. However, Calbro Services tracks all of
these products with a MarketVersion of 2003. To do this, the Version Rollup tab of the
Normalization Features includes the following rule:
(ManufacturerName LIKE "Microsoft%") AND ((Model LIKE "%Excel%") AND (VersionNumber

LIKE 11.0.%))
For more information, see Configuring Version Rollup normalization rules.
Changes in BMC Atrium CMDB version 8.0

In earlier versions of BMC Atrium CMDB, Version Normalization was an optional feature that was
disabled by default. Also, if the MarketVersion attribute in the CI was NULL, by default the value
in the Market Version field in the Product Catalog took precedence over Version Rollup rules in
setting it.
In BMC Atrium CMDB version 8.0, Version Normalization is always enabled, and it runs before
DML Based Instance Normalization. Also, the Version Rollup rules take precedence over the value
in the Product Catalog in setting the value of the MarketVersion attribute in the CI.
For more information, see Normalization features and Normalization and software license
management.

Many software products, such as Microsoft Office, are licensed as a suite. To track software
licenses by product suite, you can use the Suite Rollup feature. This feature allows the
Normalization Engine to combine several software products into a single suite based on suite
definition rules. When a discovery tool finds the individual components of a suite, the Suite Rollup
feature according to the defined rules combines them into a suite, creates the suite CI (as
needed), and marks each component as belonging to that suite.
For example, Calbro Services must manage its licenses for a suite of graphic and web tools called
Cre8ive Design, which includes the following products:
BMC Atrium Core 9.0
Page 879 of 2268
Home
Cre8 HTML
Cre8 Studio
Cre8 Photo
Anim8 Studio
Andy Admin first creates the Product Catalog entries for these products, then creates a company
entry for Cre8ive Solutions in the Product Catalog, and finally creates a new suite definition in the
Suite Rollup tab:
Suite Name: Cre8ive Design
Manufacturer: Cre8ive Solutions
Market Version: 2010
Tier 1: Software
Product List: Cre8 HTML, Cre8 Studio, Cre8 Photo (all required)
Precedence: 50
Active: Yes
When the datasets are normalized with the Suite Rollup feature enabled, installations of the
Cre8ive Design suite are identified, and Calbro Services can accurately track their software
licenses. The rule is not applied if any one of the products defined for the Cre8ive Design suite
does not exist.
For more information, see Configuring Suite Rollup normalization rules.
Using the Suite Rollup feature to identify suites that are uninstalled or upgraded
If you upgrade a suite to a different version or edition or uninstall a required suite component on a
system, the Suite Rollup feature identifies the change and sets the appropriate values for the
ProductType attribute.
Identifying suites that are uninstalled on a system

If you uninstall a product from a system, the discovery tool sets the value of the MarkAsDeleted
attribute of that product to Yes. If the product that you have uninstalled is defined as a required
component of a suite, the Suite Rollup feature sets the ProductType attribute of that suite and the
other products that are part of the suite to Standard Product.
For example, Calbro Services creates a Suite Rollup rule in which the following products are
defined as required components of the Cre8ive Design suite:
Cre8 HTML
Cre8 Studio
Cre8 Photo
BMC Atrium Core 9.0
Page 880 of 2268
Home
If you uninstall Cre8 HTML on a system, the discovery tool sets the MarkAsDeleted attribute for
that Cre8 HTML product CI instance to Yes. When the discovered data is loaded into BMC Atrium
CMDB, the Suite Rollup feature sets the ProductType attribute of the Cre8ive Design suite CI
instance and the Cre8 Studio and Cre8 Photo product CI instances to Standard Product.
Identifying suites that are upgraded on a system

If you upgrade a suite on a system to a different version or edition, you must
Create a new suite rule for the upgraded version or edition of the suite
Set the precedence of the suite rule for the upgraded version or edition as higher than the
precedence of the suite rule for the original version or edition
When the discovery tool loads the system with the upgraded suite components into BMC Atrium
CMDB, the Suite Rollup feature initially applies the suite rules that have a higher precedence. The
Normalization Engine creates a new suite CI for the upgraded version or edition and marks the
component products as part of the upgraded suite. When the suite rule for the original version is
applied, the value of the ProductType attribute of that suite CI is set to Standard Product.
For example, Calbro Services upgrades Microsoft Office 2007 Standard Edition on the systems in
the production environment to Microsoft Office 2007 Professional Edition. Andy Admin creates a
new suite rule for Microsoft Office 2007 Professional Edition and adds the Microsoft Outlook
product as a required component along with the Microsoft Word, Microsoft Excel, and Microsoft
PowerPoint products. Andy Admin also sets the precedence for the Microsoft Office 2007
Professional Edition as higher than the Microsoft Office 2007 Standard Edition.
When the system CIs on which the upgraded Microsoft Office 2007 Professional suite is installed
are loaded into BMC Atrium CMDB, the new suite rule marks the Microsoft Outlook, Microsoft Word
, Microsoft Excel, and Microsoft PowerPoint as components of the Microsoft Office 2007
Professional Edition and creates a new Microsoft Office 2007 Professional Edition suite CI. The
Normalization Engine also sets the value of the ProductType attribute of the Microsoft Office
2007 Standard Edition suite CI to Standard Product.
Using Normalization for version and suite rollups

To use the Normalization Engine for version and suite rollups, you must complete the following
steps.
1. Define the rules for rolling up versions to the specified Market Version, as needed. (See
Configuring Version Rollup normalization rules.)
2. Create suites and the rules for identifying CIs as suites or components. (See Configuring
Suite Rollup normalization rules.)
3. For each dataset, enable the Suite Rollup feature. (See Normalization settings for datasets.)
Version Normalization is enabled for all datasets and cannot be disabled.
BMC Atrium Core 9.0
Page 881 of 2268
Home
Normalization and impact relationships

With 7.6.03 and later, the BMC_Impact relationship class was deprecated to help minimize
redundancy in data. The attributes that stored impact information for a relationship are now mapped
to the BMC_BaseRelationship class.
BMC Atrium CMDB allows you to automatically store the impact details for relationships based on
the best-practice impact rules that are shipped with the product. The best-practice impact
normalization rules are listed in the Impact Normalization tab of the Mapping Your Data to BMC
Atrium CMDB Classes document, available from PDFs and videos. You can also create additional
impact rules based on your requirements. For information about creating impact rules, see
Configuring impact normalization rules.
The Impact Normalization Feature option in the Normalization Engine is enabled for all datasets by
default. If you do not want to normalize impact relationships for an individual dataset, you can
disable the Impact Normalization Feature option for that dataset. For more information about how to
disable or enable impact relationship normalization, see Normalization settings for datasets.
The impact relationship rules are framed by using the following guidelines:
The rules are defined at the relationship class level. The rules defined for the class are
applied to every instance of the relationship class that you create.
The rules are defined in BMC Atrium CMDB depending upon the source class, destination
class, and the relationship class itself.
For example, for the BMC_HostedSystemComponents relationship class,
BMC_ComputerSystem source class, and BMC_DiskDrive destination class, a rule is
defined to set the HasImpact attribute to Yes and ImpactDirection attribute to
Destination-Source. This rule is defined to indicate non-availability of a system due to a hard
drive failure.
The rules are applicable to all datasets in BMC Atrium CMDB. You cannot configure a
separate rule for each dataset.
When rules are set for a relationship class at both parent and child class levels, the child
class rule overrides the parent class rule.
Apart from the regular attributes that are automatically set to be based on the relationship,
source, and destination classes, you can also specify additional qualification strings. There
the qualifier is used to determine whether the impact attributes should be applied on the CI
that is being processed.
The rules eliminate duplicated impact relationships by merging them into one when any two
given endpoints are impacting each other in one direction or another. If the Merge process
finds any matching Impact relationships when the rule is applied on a relationship instance,
the impact relationships are merged. The rules merge those instances of the
BMC_BaseRelationship class that have the same values for the Name, HasImpact,
ImpactPropagationModel, ImpactDirection, and ImpactWeight attributes.
BMC Atrium Core 9.0
Page 882 of 2268
Home
If you update the values of the HasImpact, ImpactDirection, ImpactWeight and

ImpactPropagationModel attributes of a relationship instance and then run the normalization
job, the Normalization Engine retains the modified values for these attributes by default. However,
you can configure the Normalization Engine to reset the values of these attributes based on the
best-practice impact normalization rules, each time you run a normalization job. For information
about configuring the Auto Impact Manual Edit setting, see Normalization settings for datasets.
Normalization and best-practice relationship rules

BMC Atrium CMDB allows you to normalize relationships along with CIs, based on the relationship
rules that are shipped with the product. You can also create additional rules for normalizing
relationships. The out-of-the-box rules are listed in the Relationship Normalization tab of the
Mapping Your Data to BMC Atrium CMDB Classes document, available at PDFs and videos. For
information about creating relationship rules, see Configuring rules for normalizing relationships.
You can use the inline, continuous, or batch modes of normalization for relationship names.
The Relation Name Normalization Feature option in the Normalization Engine is enabled for all
datasets by default. If you do not want to normalize relationship classes for an individual dataset,
you can disable the Relation Name Normalization Feature option for that dataset. For more
information about how to disable or enable relationship normalization, see Normalization settings
for datasets.
Warning
Although you can disable the Relation Name Normalization feature in the Configuration
Editor, BMC recommends that you do not disable the normalization of relationships based
on the out-of-the-box relationship rules that are shipped with the product. Other BMC
products that consume the configuration data in BMC Atrium CMDB reference the
out-of-the-box relationship rules and disabling the Relation Name Normalization feature
can result in errors in these products.
The out-of-the-box rules for relationship classes are framed using the following guidelines:
The rules can modify only the Name attribute for the relationship classes.
The rules are defined in BMC Atrium CMDB depending upon the source and destination
classes for a relationship.
For example, a rule can be defined to set the Name attribute of the relationship instance with
the value set to CONTAINEDDOMAIN if the relationship class is BMC_Component, the
source class BMC_AdminDomain, and destination class is also BMC_AdminDomain.
The rules are applicable to all datasets in BMC Atrium CMDB. To define a rule for a specific
dataset, include the datasetID attribute in the rule qualification.
BMC Atrium Core 9.0
Page 883 of 2268
Home
When rules are set for a relationship class at both parent and child class levels, the child
class rule overrides the parent class rule.
Normalization and instance permissions

Earlier than version 7.6.03, you could set row-level permissions by editing the CI, by applying
default class permissions when creating a CI, or by creating a custom workflow. You can now use
the Normalization Engine to set these permissions for specified classes and, with BMC Remedy AR
System qualifications, specific instances.
To use the Normalization Engine for instance permissions, you must complete the following steps:
1. Define the rules for setting the row-level permissions. (See Creating normalization rules to
set row-level permissions.)
2. For each dataset, enable the row-level security feature. (See Normalization settings for
datasets.)
In addition to the CMDB Data View and CMDB Data Change roles, users must also have row-level
access to instances. Each class has two attributes that specify users with read and write access to
the class instances.
CMDBRowLevelSecurity Users who are members of a group with row-level access
have permission to view the instance if they also have the CMDB Data View or CMDB Data
Change role.
CMDBWriteSecurity Users who are members of a group with write access have
permission to modify the instance if they also have row-level access and the CMDB Data
Viewer role. This permission is useful for giving someone write access to a specific instance
without giving write access to all instances with one of the CMDB Data Change roles.
You can define groups for the following permissions:
View Members of these groups and roles can view the attribute in the class form, but
cannot modify its value.
Change Members of these groups and roles can view and modify the attribute value.
For more information about permissions, see BMC Atrium Core permission roles within applications
.
Normalization and custom rules

The Normalization Engine provides many out-of-the-box normalization features to enable the
normalization of data in your production environment. For information about the out-of-the-box
normalization features, see Normalization features.
The out-of-the-box normalization features, however, might not meet all your requirements for
normalizing the configuration data. In this case, you can use the Custom Normalization feature to
create custom rules that perform set attribute actions based on the conditions that you have defined
BMC Atrium Core 9.0
Page 884 of 2268
Home
in a rule.
The following are a few scenarios in which you might want to create custom rules:
If you have extended the Common Data Model by adding a new attribute. You might want to
define custom rules for automatically populating this attribute based on specific conditions.
If you want to make sure that the value of an attribute is consistent across all CI instances in
a dataset. For example, you can specify that the value of the Name attribute of all virtual
systems (where ClassId =BMC_ComputerSystem and isVirtual =Yes ) must be stored
as uppercase.
You can create custom rules for CI and relationship classes. To apply the custom rule to specific
instances of the selected class, you can define the qualification criteria. When creating the custom
rule, you can also specify whether the rule should be applied to the subclasses of the CI or
relationship classes that you have selected. For each custom rule, you must define at least one set
attribute action. You can also define more than one attribute in each custom rule to set multiple
attribute values.
The Custom Normalization feature is not enabled for any dataset by default. If you enable the
Custom Normalization Feature option for an individual dataset, the Normalization Engine checks all
active custom rules. You cannot select particular rules to apply to individual datasets.
To use the Custom Normalization feature, you must complete the following steps.
1. Define the custom rules for normalizing CIs and relationships. (See Configuring Custom
normalization rules.)
2. For each dataset, enable the Custom Normalization feature. (See Normalization settings for
datasets.)
Normalization Failover - Scheduled Batch Jobs

Starting from Service Pack 1, the Normalization failover mechanism for batch jobs is implemented.
This topic describe the Normalization Failover mechanism. A server group consists of two or more
Normalization Engines that share the same database. In a server group environment, all the
Normalization Engines have identical installations. For example, BMC Remedy AR System, and
BMC Atrium CMDB Server.
The failover mechanism in a server group environment is applicable only for scheduled batch jobs.
The Normalization Engine schedules the jobs on the Normalization Engine that has the highest
rank. If the highest ranked Normalization Engine fails, the normalization jobs on the highest ranked
Normalization Engine are canceled and are rescheduled on the next highest ranking Normalization
Engine. When the highest ranked Normalization Engine recovers, the Normalization Engine
re-schedules the normalization jobs on the highest ranked Normalization Engine and cancels the
normalization jobs that are running on the other Normalization Engine.
BMC Atrium Core 9.0
Page 885 of 2268
Home
Before 9.0.01
If a Normalization Engine in the server group stops functioning, the jobs that are running on that
Normalization Engine are not picked up by any other Normalization Engine in the server group.
After 9.0.01
If a Normalization Engine in the server group stops functioning, then the jobs that are running on
that Normalization Engine are picked up by the Normalization Engine that has the highest rank in
the server group at that time.
Configure of Normalization Engine Rank

To check or change the Normalization Engine ranks, you should open the AR System Service
Failover Ranking form. Ranking in the form AR System Service Failover Ranking is populated by
setting the Rank in AR System Server Group Operation Ranking form. For more information, see
Service failover ranking entries.
Note
The normalization engines are assigned Rank 1, Rank 2, and so on, where Rank 1 is the
highest.
Normalization Engine Failover Scenario 1

Consider a scenario where you configure BMC Remedy Normalization Engines in a server group
environment, and one of the Normalization Engine stops functioning. The Normalization Engine that
is functioning and has the highest rank at that time picks up the normalization job.
The following image displays the Normalization Engine Failover mechanism in a server group with
three Normalization Engines. If all the Normalization Engines are working, then the Normalization
Engine that has the highest rank runs the jobs.
BMC Atrium Core 9.0
Page 886 of 2268
Home
Normalization Engine Failover Scenario 2

Consider a scenario where you configure BMC Remedy Normalization Engines in a server group
environment, the high ranked Normalization Engines are down. The Normalization Engine jobs are
picked up by the tertiary Normalization Engine that has the highest rank at that time.
BMC Atrium Core 9.0
Page 887 of 2268
Home
You can schedule a job on any Normalization Engine in the server group, but the Normalization
Engine that has the highest rank in the group, runs the job. For example: if you schedule a job on
Normalization Engine 3 in a server group of 1, 2, and 3, and the Normalization Engine 1 is the one
that has highest rank at that time, then the jobs are run by Normalization Engine 1.
Job schedule in a server group environment

In a server group of Normalization Engines 1, 2, and 3 where the ranks of the Normalization
Engines are 1, 2, and 3 respectively, and you have scheduled a batch job on the highest ranked
Normalization Engine 1 to start at 12.00 AM on March 1. At 12.20 AM if Normalization Engine 1
goes down, this batch job is picked up automatically at the next schedule by Normalization Engine
2. This means, at 12.00 AM on March 2 the batch job is picked up by Normalization Engine 2.
After Normalization Engine 1 goes down on March1 and before it is picked up by the second
highest ranked Normalization Engine on March 2, you can also manually start the job on the
second highest ranked Normalization Engine 2.
In the current implementation, we do not support failover for running jobs, which means
that, if a Normalization Engine goes down, any jobs that are run by that Normalization
Engine are not re-started on any other Normalization Engine. The scheduled jobs are
re-scheduled to run in the next schedule.
BMC Atrium Core 9.0
Page 888 of 2268
Home
Troubleshooting Aborted Jobs

In the current implementation, a single job can process a dataset at a time. If a Normalization
Engine that is running jobs, goes down, the active Normalization Engine releases the orphaned
locks not released by the Normalization Engine that went down. If the orphan locks for any specific
dataset are still not being released, then no other job can process that dataset. In such a case,
open the NE:ExclusiveLock form and delete the entry where the lockable field has contents
DATASET:<dataset-name> where dataset-name is the name of the locked dataset. For example
DATASET:BMC.SCCM.
Normalization use cases

This section describes different use cases for normalizing data. Each use case has a context and
an overview of the steps for normalizing data that see more detailed information in other sections.
Initial CI loading with batch normalization

When you initially load CIs from your data providers into BMC Atrium CMDB, BMC recommends
that you use the batch mode rather than inline or continuous mode.
Inline and continuous modes can take much longer for normalizing initial CI loading because these
modes process each CI as it is written or after it is written to a dataset. Batch mode normalizes all
of the CIs at one time. You can also schedule batch normalization to occur when users are least
affected.
1. Select the dataset to normalize, or configure system normalization. See Normalization
settings for datasets.
2. Define what classes to normalize. See Configuring classes for normalization.
3. Add a normalization job, and define when to run it. See Creating a normalization job and
schedule.
After this initial loading of CIs, you can then use the inline or continuous mode to update CIs
that exist in BMC Atrium CMDB but are not normalized.
BMC Remedy ITSM and category normalization

To normalize products for BMC Remedy IT Service Management (BMC Remedy ITSM) versions
earlier than version 7.1, you must specify the CTI Only value for the normalization type option so
that only the categories are normalized and not the product name.
Use the following guidelines for configuring BMC Remedy ITSM normalization:
1. Select the dataset to normalize for BMC Remedy ITSM. See Normalization settings for
datasets.
2. Create aliases for product and manufacturer names so that the product can be matched with
a Version Rollup rule (for software products), or found in the Product Catalog. See Mapping
product and manufacturer aliases.
3.
BMC Atrium Core 9.0
Page 889 of 2268
Home
3. Set the Normalization type option to CTI Only to normalize only product categorization.
4. In the BMC Atrium Product Catalog, create a Product Catalog Mapping Alias so that, if a
product is not in the Product Catalog, an entry can be created.
5. From the Catalog Mapping window, create product catalog mapping entries so that CIs are
updated with mapped categorization. See Mapping product categorization aliases.
Calbro scenario for normalization

The following common scenario is used to explain normalization features and processes throughout
the normalization documentation. This scenario builds on the Calbro Services scenario in How
Calbro Services planned normalization and Product Catalog implementation .
Calbro has four datasets that must be configured for normalization, each corresponding to a
different data provider, as illustrated in the following figure. To design the Calbro normalization
processes, Calbro staff are required to have the following roles:
Data modeler To answer questions about data requirements and the data model,
including Calbro customizations and extensions.
Software distribution engineer To decide what software is distributed electronically and to
decide what types of discovered products should be added to the Product Catalog.
Integration specialist To lead and design integrations and to make sure integration
architecture can be maintained and work with Calbro's architecture.
Process analyst To make sure that the normalization processes and decisions support
Calbro's business needs.
Calbro's data providers
BMC Atrium Core 9.0
Page 890 of 2268
Home
Calbro's staff has analyzed the company's needs and answered the normalization questions to
design its normalization processes.
Calbro's normalization analysis
Question
Calbro's answer
Must more than one dataset be
Yes Calbro has four different datasets that must be set up for normalization before they can
reconciled to the BMC.ASSET

production database?
be reconciled and added to BMC.ASSET.
Should discovered products

that do not exist in the Product
Catalog be added automatically
?
Yes Any instances in CALBRO.APPS should be used to create Product Catalog entries if
BMC Atrium Core 9.0
they do not exist. CALBRO.APPS contains a list of all the applications that Calbro has
developed. Calbro trusts this data because they created it manually and consistently.
Page 891 of 2268
Home
Question
Calbro's answer
Should data be normalized as it

is being written to BMC Atrium
CMDB (inline mode)?
Inline CALBRO.APPS is a list of Calbro applications which is updated with new versions
and patches. Because this data source has a high volume of changes, Calbro sets this dataset
to inline normalization so that, if needed, new Product Catalog entries can be created from
these instances.
Or, should data be normalized

after it is written to BMC Atrium
CMDB
Continuous Calbro initially normalizes CALBRO.DISC with a batch job and then sets to
continuous normalization after 20 modifications or creations. Because of the importance of
maintaining their e-commerce services, Calbro wants updated and new instances to be
normalized and reconciled as quickly as possible without a significant impact on other users
and processes.
and after a certain

number of changes have
been made, or after a
certain amount of time
Batch Because BMC.ADDM and BMC.IMPORT.BL have a large number of changes,

Calbro schedules normalization of these instances during off hours.
has passed (continuous

mode)?
at a scheduled time (
batch mode)?
Do any datasets not require

normalization?
No CALBRO.APPS contains a list of all the applications that Calbro has developed. Calbro
trusts this data because they created it manually and consistently. Calbro uses this dataset to
create Product Catalog entries.

Before setting up and running normalization, complete the following tasks:
Assign Normalization Engine permissions see, Normalization Engine permissions
Prepare the Product Catalog see, Preparing the Product Catalog and planning classes for
normalization
Configure Version Rollup rules as needed see, Configuring Version Rollup normalization
rules
If you plan to enable the Relationship Normalization, Impact Normalization, Instance Level
Permissions, Suite Rollup Normalization, or Custom features, you must also complete the following
tasks:
Create rules to set row-level permissions see, Creating normalization rules to set row-level
permissions
Configure relationship rules see, Configuring rules for normalizing relationships
Configure impact rules see, Configuring impact normalization rules)
Configure Suite Rollup rules see, Configuring Suite Rollup normalization rules
Configure custom normalization rules see, Configuring Custom normalization rules
Normalization Engine permissions

To configure and use the Normalization Engine, you must have the appropriate assigned
permission roles:
NE User
NE Administrator
BMC Atrium Core 9.0
Page 892 of 2268
Home
For more information about these roles and how to assign them, see BMC Atrium Core permission
roles within applications.
Preparing the Product Catalog and planning classes for normalization

Before you can normalize CIs, you must configure the Product Catalog:
1. Create Product Catalog entries for the class instances to be normalized.
The Normalization Engine normalizes any BMC.CORE:BMC_BaseElement child class
.
For classes that do not have Product Catalog entries, you can configure the product
categorization aliases to normalize CTI values.
You can add products for other classes to the Product Catalog in the following ways:
Import data from external files You can import data from an external file or
from staging forms. For more information, see Overview of importing custom
You can also import the Product Catalog data provided by BMC. Product
Catalog data updates are released on a regular basis. For more information,
see the BMC online documentation at http://docs.bmc.com.
Use the Normalization Engine to create entries You can configure the
Normalization Engine to create Product Catalog entries from the dataset. You
must configure this option before normalizing the dataset.
Create entries manually From the Product Catalog Console, you can
create new products, versions, and patches and define their status options.
Before you use the Normalization Engine to create Product Catalog entries,
consider the following information to avoid creating duplicate entries for a
product in the Product Catalog and to avoid adding unwanted Product Catalog
entries.
You can only set this option to create entries for a dataset, not for
specific classes or instances in a dataset.
To select only specific classes or CIs to use to create Product Catalog
entries, create a dataset containing only those CIs.
Verify that the CIs in the dataset contain values that you want to apply to
all discovered or imported instances of those classes and products. For
example, make sure that all CIs for a specific product have the same
ManufacturerName, Model (Product Name), Category, Type, and
Item categorization values. For more information about creating
Product Catalog entries by using the Normalization Engine, see
Normalization settings for datasets.
2.
BMC Atrium Core 9.0
Page 893 of 2268
Home
2. Approve the Product Catalog entries to define the Definitive Media Library (DML) and
Definitive Hardware Library (DHL). For more information about these steps, see Product
Catalog status options.
3. From the Product Catalog Console, use the Normalization Alias form to create product and
manufacturer aliases. For more information on aliasing, see Setting up aliases for
normalization and the Product name and manufacturer normalization aliases in the Product
Catalog.
4. For software license management or to use Version Rollup rules, set the Market Version
field for each product. For more information, see Version Normalization.
5. Create product categorization aliases. You can create these aliases from the Catalog
Mapping in the Normalization console. For more information, see Mapping product
categorization aliases.
Configuring Version Rollup normalization rules

Use Version Rollup rules to define a value to assign to the MarketVersion attribute and a
qualification to select the instances that are assigned the new value. The purpose is to normalize
multiple VersionNumber strings to a particular MarketVersion value.
By default, the Version Rollup feature is enabled for datasets and all active Version Rollup rules are
checked. You cannot disable the Version Rollup feature, and you cannot select particular rules to
apply to individual datasets.
Also by default, the MarketVersion value in the Version Rollup rules takes precedence over a
Product Catalog entry. You can change this configuration, as explained in Priority of Version Rollup
rules and Product Catalog entries.
The Normalization Engine includes Version Rollup rules for a number of products from
manufacturers such as Microsoft Corporation, Oracle Corporation, and Adobe Systems. You must
create rules for other products.
When you create new rules for the products, you can check if the Version Rollup rules already exist
for a product or a manufacturer using the search field available on the Version Rollup tab.
Important
Although you can edit or delete the Version Rollup rules that are shipped with the
product, BMC recommends that you do not edit or delete these rules.
Instead of editing a rule, create a new rule and copy the desired qualification and
other values to it. You can then modify this new rule.
BMC recommends that the Version Rollup rule should be based on Normalized
product names.
BMC Atrium Core 9.0
Page 894 of 2268
Home
When you search for existing version Rollup rules, the search results depend on
the case sensitivity of the underlying database. For example, for a case sensitive
database, if you enter a search string as "adobe", it treats "adobe" and "Adobe"
differently. Hence, the search result does not list the rules for "Adobe". However, if
the underlying database is case insensitive the search string "adobe" lists the rules
for "adobe" as well as "Adobe".
Version Rollup rules apply to CIs in the BMC_Product class. You can add more classes, as
explained in Adding CMDB classes to Version Rollup normalization .
If the Normalization Engine does not find a specific rule for a product, and if the CI does not have a
value for MarketVersion, the Normalization Engine uses a default rule to set MarketVersion to
the VersionNumber value. If the CI does have a value for MarketVersion, then the
Normalization Engine retains this value.
For more information about the Version Normalization feature, see Normalization and software
license management.
Note
You can use manufacturer aliases to reduce the number of Version Rollup rules
needed to match the ManufacturerName attribute within a CI. This is because
the Normalization Engine uses manufacturer aliases to look up matching Version
Rollup rules, as explained in Normalization process.
For more information on product and manufacturer name aliasing, see Setting up
aliases for normalization and Product name and manufacturer normalization
aliases in the Product Catalog.
To create a Version Rollup normalization rule

1. In the Normalization console, click Normalization Features.
2. On the Version Rollup tab, in the Search by Manufacturer Name/Product Name field
enter the Manufacturer Name or Product Name for which you want to create or edit a
Version Rollup rule.
This field allows you to search for existing Version Rollup Normalization rules for that
Manufacturer or Product. You can use % for wildcard search.
3. Click the Create New Rule icon to create a new rule.
4. In the New Rule for Version Rollup dialog box, configure the following parameters.
BMC Atrium Core 9.0
Page 895 of 2268
4.
Home
Active Select Yes to activate the rule so that the Normalization Engine applies the
rule on datasets.
Rule Name Define a descriptive name for the rule.
Class Name Select the name of the class for which the qualification returns
instances.
Precedence Enter a value to determine the rule's execution order. The value can
be 0 to 9999999, inclusive, with higher numbers determining a higher priority. If more
than one rule applies to an instance, the Normalization Engine applies the rules
sequentially from the highest precedence value to the lowest, until a match is found.
Qualifier Type the qualification or click
Use BMC Remedy AR System qualifications to define the CIs or relationships to
which the custom rule applies. For information about using the Qualification Builder,
see Building a qualification for a reconciliation activity .
The qualification can also be written using an alias name instead of using the
manufacturer or product name.
Manufacturer Name Specify a string to apply to the ManufacturerName attribute
.
If you are using manufacturer aliases, make sure that the value in this field is the
same as the value in the ActualName field in the Normalization Alias form. The value
in the ActualName field should in turn match the Manufacturer Name field in the
corresponding Product Catalog entry.
Product Name Specify a string to apply to the Model attribute.
Market Version Specify a value to apply to the MarketVersion attribute of the
instances that match your qualification. You can specify either an exact value, such
as 2003, or an expression that generates the MarketVersion value.
The following are examples of expressions that you can specify in the Market
Version field:
MAJOR($VersionNumber$) This expression extracts the major version from the
VersionNumber attribute of the qualified instances and applies that value to the
MarketVersion attribute. For example, if the VersionNumber attribute value is
11.5 or 11.7, this expression populates 11 as the value of the MarketVersion
attribute.
MAJORMINOR($VersionNumber$) This expression extracts the major and minor
version numbers from the VersionNumber attribute. For example, if
VersionNumber contains 5.1.2, this expression populates 5.1 as the value of the
MarketVersion attribute.
BMC Atrium Core 9.0
Page 896 of 2268
Home
$VersionNumber$ This expression applies the VersionNumber attribute value of

the qualified instances to the MarketVersion attribute. For example, if the
VersionNumber attribute value is 10.20.01, this expression populates 10.20.01 as
the value of the MarketVersion attribute.
5. Click OK.
Priority of Version Rollup rules and Product Catalog entries

You can configure whether a Version Rollup rule or the Product Catalog entry has priority in
normalizing the MarketVersion value.
By default, the Version Rollup rules have priority over the Product Catalog. This means that a
Version Rollup rule will be selected and applied to a CI, based on ManufacturerName and Model
, and then based on precedence. This rule will set the MarketVersion attribute in the CI, and
then ManufacturerName, Model and MarketVersion will be used to find a match in the
Product Catalog.
If you configure Product Catalog entries to have priority, the Normalization Engine uses the Market
Version field from the Product Catalog to update the CI's MarketVersion attribute, but only if the
MarketVersion attribute in the CI is NULL. If the MarketVersion attribute is already set in the
BMC Atrium Core 9.0
Page 897 of 2268
Home
CI, then the CI's value is retained. Also, if Product Catalog entries are configured to have priority
and the Market Version field has no value in the Product Catalog, then the Normalization Engine
checks the applicable Version Rollup rules.
Before changing the default configuration, consider that giving priority to the Version Rollup rules is
useful for several reasons:
If a CI has no corresponding Product Catalog entry, then the MarketVersion value is used
if the Allow New Product Catalog Entry option is enabled. For example, instead of creating
a product with the version 5.2.013.1, the Normalization Engine uses 5.2 as defined in a rule.
If a CI has a corresponding Product Catalog entry, the product might not have a
MarketVersion value.
The Product Catalog data provided by BMC assumes that the default behavior has not been
changed.
Important
If you are using the Product Catalog data provided by BMC, you should not change the
default priority setting. Only change this setting in situations where your environment
requires it based on certain customizations you have made, and those customizations do
not involve entries in the Product Catalog data provided by BMC.
To assign the Product Catalog a higher priority than the Version Rollup rules
1. In the <AtriumCore_install>\cmdb\plugins\ne directory on the BMC Atrium Core server,
open the com_bmc_ne_feature_VersionRollupFeature file in a text editor.
2. Change the RulePriority property to False.
3. Save the file.
The Market Version value in the Product Catalog takes precedence over the value in the
Version Rollup rules.
Adding CMDB classes to Version Rollup normalization

By default, Version Rollup rules apply to CIs in the BMC_Product class. Use the following
procedure to add other classes.
To add a CMDB class to Version Rollup normalization

1. Open the BMC.CORE.CONFIG:BMC_CMDBComponent form using the direct access URL,
and log on as an administrator:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/
BMC.CORE.CONFIG:BMC_CMDBComponent
2.
BMC Atrium Core 9.0
Page 898 of 2268
Home
2. Click the Custom tab.

3. Search for the record with the following value in the PropertyName field:
feature_def_com.bmc.ne.feature.VersionNormalizationFeature
4. In the PropertyValue field, expand the edit box.
5. Locate the tag for the BMC_Product class:
<supportedClass nameSpace="BMC.CORE" className="BMC_Product"
applicableToChildren="false">
6. Immediately below the </supportedClass> tag, add a new tag for the class you want to add.
For example, add the BMC_SystemSoftware class, like this:
<supportedClass nameSpace="BMC.CORE" className="BMC_SystemSoftware"
applicableToChildren="false"> <attribute> <name> MarketVersion </
name> </attribute> </supportedClass>
7. Click Ok.
8. Save the record and close the form.
Creating normalization rules to set row-level permissions

Use Row Level Security rules to set the instance permissions. For more information, see
Normalization and instance permissions.
Before You Begin

In the Dataset Configuration, you must enable the Instance-Level Permissions feature so that the
Normalization Engine can apply the row-level permission rules to the selected datasets. For more
information, see Normalization settings for datasets.
To create normalization rules for row-level permissions

2. In the Row Level Security tab, click Create New Rule.
BMC Atrium Core 9.0
Page 899 of 2268
Home
3. In the Row Level Security Rule dialog box, configure the following parameters.
Active Click to activate the rule so that the Normalization Engine can apply the
rule on datasets.
Class Type Select whether rule applies to CIs or Relationships.
For relationships, click Details to create the required qualifications.
In Relationship Details, configure the following parameters:
Source Class Select the parent class in the relationship.
Destination Class Select the child class in the relationship.
to build qualifications
interactively in the Qualification Builder. Use BMC Remedy AR System

qualifications to define the CIs or relationships to which the custom rule applies
. For information about using the Qualification Builder, see Building a
qualification for a reconciliation activity.
Class Name Select the class to create a rule for.
Rule Name Enter a descriptive name for the rule.
BMC Atrium Core 9.0
Page 900 of 2268
Home
. Use BMC Remedy AR System
qualifications to define the CIs or relationships to which the rule applies. For
information about using the Qualification Builder, see Building a qualification for a
reconciliation activity.
4. In the Row Permission table, for each group, click the View and Change check boxes to
enable or disable read and write permissions.
5. Click OK.
The rule is available for normalization.
Configuring rules for normalizing relationships

BMC Atrium CMDB provides recommended relationships rules based on which you can normalize
relationships in all datasets. You can also create additional rules for normalizing relationships
based on your requirements.
To create a relationship normalization rule
BMC Atrium Core 9.0
Page 901 of 2268
Home
To edit a relationship normalization rule

To delete a relationship normalization rule
To enable or disable relationship rules for a dataset
For more information about recommended relationship rules, see Normalization and best-practice
relationship rules.
Important
Although you can edit or delete the recommended relationship rules that are shipped with
the product, BMC recommends that you do not edit or delete these rules. Other BMC
recommended relationship rules, and editing or deleting these rules can result in errors in
these products.
To create a relationship normalization rule

2. In the Relationship tab, click Create New Rule.
3. In the New Relationship Rule dialog box, configure the following parameters:
rule on datasets for which the Relation Name Normalization feature is enabled.
4.
BMC Atrium Core 9.0
Page 902 of 2268
Home
4. In the Conditions area, configure the following parameters:

Class Name Select the relationship class for which you want to create a rule.
(Optional) Apply to Subclasses Select this check box if you want to apply the rule
to all subclasses of the selected relationship class.
Note
When rules are set for a relationship class at both parent and child class
levels, the child class rule overrides the parent class rule.
(Optional) Qualifier Type the qualification or click

Note
The relationship rules are applicable to all datasets in BMC Atrium CMDB.
To define a rule for a specific dataset, include the datasetID attribute in
the rule qualification.
5. In the Relationship Details area, configure the following parameters:

Source CI Class Select the source class in the relationship.
Destination CI Class Select the destination class in the relationship.
to all subclasses of the source and destination CI classes.
(Optional) Qualifier Use BMC Remedy AR System qualifications to define the CIs
in the source and destination classes to which the rule applies.
6. In the Attribute Values area, type the value that the Normalization Engine should apply to the
Name attribute of the relationship.
You can also use the Attribute Expression Builder to build an expression that provides the
value that the Normalization Engine should apply to the Name attribute of the relationship.
For more information see Building an attribute expression for relationship and custom
normalization rules.
BMC Atrium Core 9.0
Page 903 of 2268
Home
7. To save the relationship rule, click OK.
To edit a relationship normalization rule

2. In the Relationship tab, select a relationship rule and click Edit Selected Rule.
Important
BMC recommends that you do not edit the best-practice relationship rules that are
shipped with the product. Other BMC products that consume the configuration data
in BMC Atrium CMDB reference the best-practice relationship rules, and editing
these rules can result in errors in these products.
3. In the Edit Relationship Rule dialog box, modify the parameters that you have specified for
the relationship rule.
Note
You cannot modify the class name of an existing relationship rule.
BMC Atrium Core 9.0
Page 904 of 2268
Home
4. To save changes, click OK.
To delete a relationship normalization rule

2. In the Relationship tab, select a relationship rule and click Delete Selected Rule.
Important
BMC recommends that you do not delete the best-practice relationship rules that
are shipped with the product. Other BMC products that consume the configuration
data in BMC Atrium CMDB reference the best-practice relationship rules, and
deleting these rules can result in errors in these products.
3. To delete the relationship rule, click OK in the Delete Relationship Rule dialog box.
To enable or disable relationship rules for a dataset

1. In the Normalization console, click Edit Configuration.
2. In the Normalization Features column on the Dataset Configuration tab, click the ...
button.
3. In the Configure Normalization Features dialog box, click the check box to enable or disable
the Relation Name Normalization feature.
Note
Only rules that are active are executed.
4. Click OK.
Configuring impact normalization rules

BMC Atrium CMDB provides out-of-the-box impact rules that the Normalization Engine uses to
populate the HasImpact and ImpactDirection attributes for relationships in all datasets. You
can also create additional rules for populating the ImpactWeight and
ImpactPropagationModel attributes for relationships based on your requirements.
To create an impact normalization rule
To edit an impact normalization rule
To delete an impact normalization rule
To enable or disable impact rules for a dataset
BMC Atrium Core 9.0
Page 905 of 2268
Home
For more information about out-of-the-box impact rules, see Normalization and impact relationships
.
Important
Although you can edit or delete the out-of-the-box impact rules that are shipped with the
product, BMC recommends that you do not edit or delete these rules. Other BMC
out-of-the-box impact rules, and editing or deleting these rules can result in errors in these
products.
To create an impact normalization rule

2. In the Impact tab, click Create New Rule.
3. In the New Impact Rule dialog box, configure the following parameters:
rule on datasets for which the Impact Normalization feature is enabled.
4. On the Conditions tab, configure the following parameters:
Class Name Select the relationship class for which you want to create an impact
rule.
BMC Atrium Core 9.0
Page 906 of 2268
4.
Home
to all subclasses of the selected relationship class.

5. In the Relationship Details area, configure the following parameters:
Source CI Class Select the parent class in the relationship.
Destination CI Class Select the child class in the relationship.
to all subclasses of the source and destination CI classes.

6. On the Action tab, specify the values that the Normalization Engine should apply to the
impact attributes (HasImpact, ImpactDirection, ImpactWeight and
ImpactPropagationModel ) of the relationship.
For information about the impact attributes, see the BMC Atrium CMDB Data Model Help .
7.
BMC Atrium Core 9.0
Page 907 of 2268
Home
7. To save the impact rule, click OK.
To edit an impact normalization rule

2. In the Impact tab, select a relationship rule and click Edit Selected Rule.
3. In the Edit Impact Rule dialog box, modify the parameters that you have specified for the
impact rule.
Note
You cannot modify the class name of an existing impact rule.
To delete an impact normalization rule

2. In the Impact tab, select an impact rule and click Delete Selected Rule.
3. To delete the impact rule, click OK in the Delete Impact Rule dialog box.
To enable or disable impact rules for a dataset

button.
the Impact Normalization feature.
Note
You can also edit an additional parameter that will affect the Impact Normalization feature.
The additional normalization impact mode settings are given below:
Auto
Impact
Manual
Edit
Preserve
Manual
Edits
(Default) Retains any manual edits that you have made to the HasImpact and
ImpactDirection impact attributes of the relationship instances, instead of reapplying the
values that are defined in the best-practice impact normalization rules.
For more information about the best-practice relationship instances, see Normalization and impact
relationships.
BMC Atrium Core 9.0
Page 908 of 2268
Home
Apply
Overwrites any manual edits that you have made to the HasImpact andImpactDirection
Rule
Always
impact attributes of the relationship instances with the values that are defined in the best-practice
impact normalization rules.
For more information about the best-practice relationship instances, see Normalization and impact
relationships.
4. Click OK.
Configuring Suite Rollup normalization rules

This topic provides information and instructions for configuring Suite Rollup normalization rules:
Purpose and behavior of Suite Rollup normalization
Default configurations
Recommendations
Before You Begin
To create a Suite Rollup normalization rule
To enable or disable suite rollup for a dataset
Purpose and behavior of Suite Rollup normalization

Use Suite Rollup rules to create a new suite definition in the Product Catalog, to set the products
that are members of a suite, and to set the ProductType attribute for instances:
If the Normalization Engine identifies an instance as part of a suite, it sets that CI's
ProductType attribute to Component.
If the Normalization Engine identifies an instance as a suite, it sets that CI's ProductType
attribute to Composite Product.
The instances for which the ProductType attribute is not set to Composite Product or Component
are considered to be standalone products.
When you select products as part of a suite, the suite rule applies only if all the required
components are found with a relationship to the same system. If they are not, the rule does not
apply.
Default configurations
The Normalization Engine includes example Suite Rollup rules for Microsoft and Adobe products.
You must create rules for other suites.
Note
You cannot define composite suites that contain other suites.
BMC Atrium Core 9.0
Page 909 of 2268
Home
By default, the Suite Rollup feature is not enabled for datasets. If you enable the Suite Rollup
Normalization Feature option for an individual dataset, the Normalization Engine checks all active
Suite Rollup rules. You cannot select particular rules to apply to individual datasets.
Note
Suite Rollup rules do not run if the MarketVersion, Model (Product Name), and
ManufacturerName attributes are not normalized.
You can use Suite Rollup with batch and continuous normalization jobs: It does not work with inline
normalization.
Note
If you enable the continuous normalization mode and then create a new Suite Rollup rule,
that rule is applied only to new or updated product CIs related to the systems that are
pushed to BMC Atrium CMDB. To apply the new Suite Rollup rule to the previously
normalized data, you must rerun the continuous normalization job with the Normalize All
Instances option selected.
For more information, see Suite Rollup Normalization.
Recommendations
Before enabling the Suite Rollup Normalization feature or continuous normalization mode, do
the following:
Verify that the Product Catalog contains trusted product entries for normalizing CIs,
and that product and manufacturer aliases have been defined as needed.
Create and enable Version Rollup rules as needed.
With trusted Product Catalog entries, aliases, and Version Rollup rules in place,
create Suite Rollup rules to take advantage of the normalized Model,
ManufacturerName, and MarketVersion attributes.
If you modify the Product Catalog data, add aliases, or add new custom Version Rollup rules
after running a batch job, enable the Normalize All Instances option and run the batch job
again.
Before You Begin

Know what values to use for the Suite Name, Manufacturer, Market Version, Category,
Type, and Item.
Products must already exist in the Product Catalog. You cannot define new products in the
Suite Rollup rule.
BMC Atrium Core 9.0
Page 910 of 2268
Home
The Suite Rollup Normalization feature works on non-normalized data, and because it is an
optional feature, it must be enabled.
To create a Suite Rollup normalization rule

2. In the Suite Rollup tab, click Create New Rule.
3. In the Suite Information screen, define the suite to create in the Product Catalog, and click
Next.
Suite Name Enter the name of the suite to create in Product Catalog.
Manufacturer Select from a list of manufacturers that are defined in the Product
Catalog.
If needed, you can create a new manufacturer in the Product Catalog. For more
information, see Creating custom Product Catalog entries.
Market Version Select from a list of Market Versions that are defined in the
Product Catalog. If needed, you can create a Market Version by typing the value.
Model/Version Enter the VersionNumber attribute value for the suite.
Tier 1 (Category) Enter the Category attribute value for the suite.
Tier 2 (Type) Enter the Type attribute value for the suite.
Tier 3 (Item) Enter the Item attribute value for the suite.
BMC Atrium Core 9.0
Page 911 of 2268
Home
4. In the Product List screen, select the products to include in the suite, and click Next.
a. Search for products by the following methods. You can include the % wildcard.
By product name Click Product, and enter a value for Name.
By product version Click Product, and enter a value for Version.
By products in existing suites Click Suite, and enter a suite name for
Search.
Note
Searches are case sensitive.
b. To add a product to the suite, select it from the Product Catalog list, and click the >
button.
c. To designate a required product in the suite, in the Product List, click the Reqd
check box.
5. In the Suite Summary screen, review the suite definition and set the following options, and
click Next.
Active Click to activate the rule so that the Normalization Engine applies the rule
on datasets.
BMC Atrium Core 9.0
Page 912 of 2268
Home
The Create New Suite Wizard adds a new suite in the Product Catalog with the
defined Suite Name, Manufacturer, Version and Product List information. It also
creates a NE Suite Rule with the Suite Id, Active and Precedence values.
6. In the Finish screen, review for errors.
If the wizard successfully creates the new suite, click Finish.
If the wizard encountered errors, click Back to review and make changes.
The new suite appears in the Current Suites list of Suite Rollup tab.
To enable or disable suite rollup for a dataset

button.
the Suite Normalization feature.
Note
4. Click OK.
5. In the Configuration Editor, click Save.
Configuring Custom normalization rules

You can create custom rules when the out-of-the-box Normalization features do not meet your
requirements for normalizing data. The custom rules perform set attribute actions based on the
conditions that you have defined in a rule. For more information, see Normalization and custom
rules.
To create a custom normalization rule
To edit a custom normalization rule
To delete a custom normalization rule
To enable or disable custom rules for a dataset
To create a custom normalization rule

2. In the Custom tab, click Create New Rule.
BMC Atrium Core 9.0
Page 913 of 2268
Home
3. In the New Custom Rule dialog box, configure the following parameters:
rule on datasets for which Custom Normalization is enabled.
Note
If inactive, the custom rule is not applied, even if Custom Normalization is
enabled for a dataset.
(Optional) Group Name Enter a group name for the rule. For example, you can
create an Asset Management group that includes all the custom rules related to
computer systems, disk drives, and database applications.
4. On the Conditions tab, configure the following parameters:
a. Class Type Select whether the rule applies to CI or relationship classes.
b. Class Name Select the CI or relationship class for which you want to create a
custom rule.
c. (Optional) Apply to Subclasses Select this check box if you want to apply the
custom rule to all subclasses of the selected class.
d.
BMC Atrium Core 9.0
Page 914 of 2268
Home
d. (Optional) Qualifier Type the qualification or click

e. Relationship Details If you select Relationship as the Class Type, you have to
define the following additional parameters:
Source CI Class Select the parent class in the relationship.
Destination CI Class Select the child class in the relationship.
(Optional) Apply to Subclasses Select this check box if you want to apply
the custom rule to all subclasses of the selected source and destination
classes.
(Optional) Qualifier Use BMC Remedy AR System qualifications to define
the CIs in the source and destination class to which the custom rule applies.
5. On the Action tab, perform the following actions:

a. From the Available Attributes list, select the attribute on which the Normalization
Engine should perform the set attribute action, and click Add.
To filter the attributes by name, type in the filtering field. Filtering displays all results
containing the filter text.
Note
BMC Atrium Core 9.0
Page 915 of 2268
Home
The Available Attributes list on the Action tab does not display all the
attributes of the CI or relationship class that you have selected on the
Conditions tab. The Attributes list includes only those attributes for which
you can specify an action.
b. In the Attribute Expression Builder dialog box, build an expression that provides the
value that the Normalization Engine should apply to the selected attribute, and click
OK. For more information, see Building an attribute expression for relationship and
custom normalization rules.
c. (Optional) To append the value that is defined in the Attribute Expression Builder
dialog box, to the existing value of the selected attribute, select the Append check
box in the Selected Attribute Expressions list.
The original and appended values of the attribute are separated by a semicolon (:).
The value that is defined in the Attribute Expression Builder dialog box is appended to
the existing value of the selected attribute only if the two values are different.
Note
If you change the CI or relationship class on the Conditions tab after you
have created the attribute expressions on the Action tab, the actions that
you have specified are cleared.
BMC Atrium Core 9.0
Page 916 of 2268
Home
6. To save the custom rule, click OK.
To edit a custom normalization rule

2. In the Custom tab, select a custom rule and click Edit Selected Rule.
3. In the Edit Custom Rule dialog box, modify the parameters that you have specified for the
custom rule.
Note
You cannot modify the class type and class name of an existing custom rule.
To delete a custom normalization rule
Note
When you delete a custom rule, the attribute values that were updated by that rule are not
reset to the original value. If you want to change the attribute values that were set by the
custom rule, you must update the custom rule, run the normalization job, and then delete
the custom rule.
BMC Atrium Core 9.0
Page 917 of 2268
Home

2. In the Custom tab, select a custom rule and click Delete Selected Rule.
3. To delete the custom rule, click OK in the Delete Custom Rule dialog box.
To enable or disable custom rules for a dataset

button.
the Custom Normalization feature.
Note
4. Click OK.
5. In the Configuration Editor, click Save.
Building an attribute expression for relationship and custom normalization rules

This topic provides instructions for building an attribute expression for relationship and custom
normalization rules:
Attribute Expression Builder functions
To create an attribute expression using the Attribute Expression Builder dialog box
When creating a relationship rule or a custom rule, you can use the Attribute Expression Builder
dialog box to build an expression that provides the value that the Normalization Engine should
apply to the selected attribute.
For example, Calbro Services has to create a custom rule to make sure that the OwnerName and
ShortDescription attributes of their computer system CIs are consistent. To do that, Calbro
Services creates custom rules for the BMC_ComputerSystem class and specifies the following
attribute expressions:
CONCAT($Name$,$CITag$) The value that is populated for the ShortDescription
attribute is a concatenation of the Name ( Calbro ) and CITag ( LT30795 ) attribute values (
CalbroLT30795 ).
UPPER($OwnerName$) The value of the OwnerName attribute is populated as uppercase
. For example, if the value that is discovered for the OwnerName attribute is in the lowercase
(for example, finance ), this expression changes the attribute value to uppercase ( FINANCE
).
BMC Atrium Core 9.0
Page 918 of 2268
Home

The following table contains descriptions of CONCAT(n1,n2), UPPER(n1), and all Attribute
Expression Builder functions.
Function
Description
CLASSNAME(n1
)
Extracts the class name of the current CI. For example, CLASSNAME($ClassId$) looks up the class name
CONCAT(n1,n2
)
Concatenates two strings. For example, if Name = Calbro and CITag = LT30795, then CONCAT($Name$,$
LOWER(n1)
Converts the value to lowercase. For example, if OwnerName contains Finance, LOWER($OwnerName$)
using the ClassId.
CITag$) returns CalbroLT30795, the concatenation of Name and CITag.
returns finance.
MAJOR(n1)
Gets the major version number. For example, if VersionNumber contains 5.1.2, MAJOR($VersionNumber$)
returns 5.
MAJORMINOR(
n1)
Gets the major and minor version numbers. For example, if VersionNumber contains 5.1.2, MAJORMINOR($
REPLACEALL(
n1,n2,n3)
Replaces all occurrences of a string value with another string value. For example, REPLACEALL($Hostname$
REPLACEFIRST
(n1,n2,n3)
Replaces first occurrence of a string value with another string value. For example, REPLACEFIRST($
SUBSTRING(n1
,begin,end)
Extracts a substring from the attribute. For example, SUBSTRING($Hostname$,4,8) returns the string
VersionNumber$) returns 5.1.
," ","_") replaces all blank characters in Hostname with the underscore character.
Hostname$," ","_") replaces the first blank character in Hostname with the underscore character.
beginning with the fourth character and ending with the eighth character. If end is 0, then the rest of the string
from begin is returned. For any error condition, the complete attribute string is returned.
TRUNCATE(n1,
n2)
Truncates the string value to specified length. For example, if ShortDescription contains a 20 character
UPPER(n1)
Converts the value to uppercase. For example, if OwnerName contains Finance, LOWER($OwnerName$)
string, TRUNCATE($ShortDescription$,10) shortens it to the first 10 characters.
returns FINANCE.
To create an attribute expression using the Attribute Expression Builder dialog box
1. To open the Attribute Expression Builder dialog box, perform one of the following actions:
In the New Relationship Rule dialog box, click
In the New Custom Rule dialog box, select the Action tab and from the Available
Attributes list, select the attribute on which the Normalization Engine should perform
the specified action.
2. Build an attribute expression in the Attribute Expression area:
To add an attribute, select an attribute from the*Attributes* list and click Insert
Attribute.
Note
BMC Atrium Core 9.0
Page 919 of 2268
Home
The Attributes list displays only those attributes for which you can specify
an action.
To add a function, select the appropriate function from the Functions list and click
Insert Function.
If required, select the appropriate operator.
3. To clear the expression that you have built in the Attribute Expression area, click Clear.
4. To save the attribute expression, click OK.
Typical normalization setup

Recommendations
In a server group environment, you do not need to duplicate normalization configurations for
primary and secondary servers, which use the same database. The normalization configurations
are saved to the database. The Normalization Engine runs on every server in the group but the
normalization jobs are scheduled only on the primary server.
Do not run a batch normalization job simultaneously on the same dataset on the primary and
secondary servers to avoid possible errors.
Note
Normalization engine does not support failover mechanism.
BMC Atrium Core 9.0
Page 920 of 2268
Home
To set up normalization
1. Configure each dataset for normalization. See Normalization settings for datasets.
2. Add any custom classes that you have created. See Configuring classes for normalization.
3. Simulate normalization for selected datasets, and fix any errors. See Simulating
normalization.
4. Set up aliases for normalization. See Setting up aliases for normalization.
5. Select the mode (inline, continuous, and batch) for when to normalize datasets. See
Normalization modes.
6. View normalization job history and details. See Monitoring normalization jobs.
Normalization settings for datasets
A dataset is a collection of CIs and relationships, and each data provider has its own dataset. You
can configure the default normalization settings that are applied as datasets are created.
You also have the option of applying these defaults to datasets that are already configured.
These settings include the option of full or incremental normalization. All of the other default
settings can also be defined for each dataset.
In the Calbro example, the system configuration is set first to the most common values:
Both product names and categories are normalized.
Products are normalized as the datasets are updated (inline mode).
Products with errors are not updated.
Discovered products that are not found in the Product Catalog are not created.
Then, the Calbro staff configures the individual datasets that need to be configured differently from
the system configuration. For example, for CFS.APPS, any new products found there are created
The following table describes the settings that you can configure for normalization, either for
individual datasets or as a system default.
Dataset and system normalization settings

Setting
Value
Description
Normalization
Type
CTI Only
(Default) Only the categories (Category, Type, and Item attributes) for a CI are normalized,
but the Model and ManufacturerName attributes are not. For more information about using
CTI Only, see BMC Remedy ITSM and category normalization.
BMC Atrium Core 9.0
Page 921 of 2268
Home
Setting
Value
Description
If this option is selected, you can map the categorization of the provider's data to the Product
Catalog categorization. For more information, see Exporting and importing normalization
configurations. If there is no mapping, the Normalization Engine tries to create an entry with the
categories that the data provider supplies.
Name & CTI
The product name, model, manufacturer name, CTI attributes, and categories are normalized.
Lookup
Inline
Disabled
(System Configuration only) Normalization is turned off.
Deselected
(Default) Normalize data in the continuous mode (if enabled) or, if defined, as scheduled.
Normalization
For more information, see Configuring inline normalization.
Selected
Normalize data as it is created or modified.

For more information, see Normalization modes.
Allow
Unapproved
CI
Selected
(Default) If the product is unapproved in the Product Catalog, the Normalization Engine
normalizes the CI and sets its NormalizationStatus attribute to Normalized and Not
Approved.
Deselected
If the product is unapproved, the Normalization Engine does not normalize the CI or, if the Allow
New Product Catalog Entry option is enabled, does not create a Product Catalog entry.
Allow New
Product
Catalog Entry
Selected
If no entry for a CI is found in the Product Catalog, then a new product entry is created in the
Product Catalog, using the attributes of the discovered product.
The created Product Catalog entry is flagged as Approved. You can review and change the
status of these entries in the Product Catalog. See the BMC Product Catalog and DML Guide
and Preparing the Product Catalog and planning classes for normalization .
Enabled (
Deselected
(Default) If no entry for a CI is found in the Product Catalog, no entry is created in the Product
Catalog, and NormalizationStatus for the product is set to Normalization Failed.
Selected
(Default) Normalization is turned on for the dataset to run all Normalization Features enabled for
the dataset.
Deselected
Normalization is turned off for the dataset.
Selected
All instances in datasets with normalization enabled are normalized, including instances that
have been previously normalized.
Deselected
(Default) Only new instances in datasets with normalization enabled are normalized. This is an
incremental normalization.
Relation
Name
Normalization
Feature
For relationships, replaces the existing names with the BMC-recommended or custom names,
based on the CI classes in the relationship.
Dataset
Configuration
only)
Normalize All
Instances (
System
Configuration
only)
Normalization
features (
Dataset
Configuration
only)
BMC Atrium Core 9.0
For more information, see Normalization and best-practice relationship rules and Configuring
rules for normalizing relationships.
Page 922 of 2268
Home
Setting
Value
Description
Impact
Normalization
Feature
Sets the HasImpact, ImpactDirection, ImpactPropagationModel, and ImpactWeight

impact attributes on the relationship classes based on the defined rules.
For more information, see Normalization and impact relationships and Configuring impact
Suite Rollup
Normalization
Define suites and their products and identify an instance as a suite, a suite component, or a
standalone application. This allows more accurate management of suite and individual licenses.
Feature
For more information, see Normalization and software license management and Configuring
Suite Rollup normalization rules.
Version
Roll product versions (the MarketVersion attribute) to the highest version with which the
Normalization
Feature
licenses are associated. This provides more accurate version information for managing licenses.
For more information, see Normalization and software license management and Configuring
Version Rollup normalization rules.
Note
The Version Normalization Feature is enabled by default.
Auto Impact
Manual Edit
Instance
Level
Permissions
Feature
Sets the row-level and attribute-level permissions on CIs as you define them.
Custom
Normalization
Feature
Sets attribute values of CIs and relationships based on the custom rules that you have defined.
Preserve
Manual Edits
(Default) Retains any manual edits that you have made to the HasImpact and
For more information, see Normalization and instance permissions and Creating normalization
rules to set row-level permissions.
For more information, see Normalization and custom rules and Configuring Custom
ImpactDirection impact attributes of the relationship instances, instead of reapplying the

values that are defined in the best-practice impact normalization rules.
For more information about the best-practice relationship instances, see Normalization and
impact relationships.
Apply Rule
Always
Overwrites any manual edits that you have made to the HasImpact and ImpactDirection
impact attributes of the relationship instances with the values that are defined in the
best-practice impact normalization rules.
For more information about the best-practice relationship instances, see Normalization and
impact relationships.
Configuring classes for normalization
You select the classes to normalize. By default, only a subset of class attributes from the Product
Catalog can be used for normalization.
BMC Atrium Core 9.0
Page 923 of 2268
Home
In the Mechanism List, the methods for normalizing the class attributes are automatically selected.
DML Uses the Product Catalog interfaces to find normalized attributes.
Alias Lookup Uses the CI name and dataset ID to check the alias lookup table.
Notes
You cannot set the class normalization for a particular normalization job or dataset
because the settings are global.
You can configure normalization for custom classes that use BMC.CORE:
BMC_BaseElement or one of its child classes as its superclass. However, you
cannot select custom attributes for normalization: you must use the standard
normalization attributes. BMC Atrium CMDB must have completed synchronization
for the custom class, and the class status is Active.
In the CALBRO.BANKING namespace, Calbro created a new class Calbro_ATMSystem for their
ATMs, which is based on the BMC_ComputerSystem class. To normalize instances of
Calbro_ATMSystem, Calbro must add the class in the Class Configuration tab. Also, in the
Product Catalog, Calbro must create product entries for the products and versions and must
approve them as needed so that the CIs can be normalized.
To add classes for normalization

2. In the Class Configuration tab, click New.
Tip
You might need to scroll to the bottom of the table to see the New Class
Configuration Area.
3. In the New Class Configuration area, select from the Class Name list.
4. Click Save.
Simulating normalization
You can use the Normalization Simulation utility to preview normalization for a specific dataset and
class. This topics provides instructions for simulating normalization:
BMC Atrium Core 9.0
Page 924 of 2268
Home
Before you begin

To run the normalization simulation
To view the simulation results
You can use this utility to improve the number of CIs that are normalized and the quality of data
created in the Product Catalog.
For CIs that fail to normalize, verify and correct their Model and ManufacturerName
values.
For new Product Catalog entries, verify that it contains the desired data.
After you execute the utility, you can see the following information:
The total number of CIs for the specified dataset and class
Number of CIs that failed normalization
These are CIs that would have a NormalizationStatusvalue of Normalized Failed. In the
output file, failed CIs can have the following status:
Failed (Manufacturer is NULL) The Manufacturer attribute is NULL, and the
Normalization Engine could not find a Product Catalog entry.
Failed (Model is NULL) The Model attribute is NULL, and the Normalization
Engine could not find a Product Catalog entry.
Failed (No CTI values) The Normalization Engine cannot even create the product
because the Category, Type, and Item attributes have no values.
Number of CIs that successfully normalized
Depending on the dataset's normalization settings, these are CIs that would have a
NormalizationStatus value of Normalized and Approved and Normalized and Unapproved.
Number of new products created in the Product Catalog
If you enabled the Allow New Product Catalog Entryoption, this number represents how
many new entries the Product Catalog creates from the CIs. In the output file, new products
can have the following status:
New Product (Name) A regular product is created.
New Product (CTI) Only categorization attributes are normalized because both
Model and ManufacturerName attributes are NULL.
The simulation results do not include information for any CIs that would have a
NormalizationStatus value of Normalization Not Applicable, which includes CI classes that are
not configured for normalization.
Before you begin

Configure the dataset for normalization.
Update or add class configurations as needed for the dataset.
Populate the dataset with representative data.
BMC Atrium Core 9.0
Page 925 of 2268
Home
Verify that the Product Catalog is updated and configured as required for your business
needs.
To run the normalization simulation

1. On the BMC Atrium CMDB server, change to the directory where the simulation utility batch
file (nesim.cmd) or shell script (nesim.sh) is located:
<AtriumHome>/cmdb/sdk/bin
2. Open the nesim.cmd or nesim.sh file in the edit mode and specify the appropriate value for
the ATRIUM_HOME and JAVA_HOME variables. For example:
set ATRIUM_HOME="C:\Program Files\BMC Software\AtrimCore"
set JAVA_HOME="C:\Program Files\Java\jdk1.6.0_25"
3. Run the batch file or shell script with the following syntax:
<scriptBatchFileName> <hostname> <portNumber> <username> <password> <
datasetID> [HTMLUATatriumcoreNRG:<className> <classID>] <chunksize>
Note
Chunksize is the number of CI's that you want to process in chunks during
simulation. If you do not specify a chunk size, the default value of 100 CIs per
chunk is taken.
Example:
nesim.cmd w3k-labtest-vm1 1190 AndyAdmin andyPwd Calbro.disc BMC_Product
BMC_PRODUCT 200
The arguments in brackets [HTMLUATatriumcoreNRG: ] are optional. If you specify <
className> you must to specify <classID>. If you do not specify a class, the utility
simulates for all configured classes in the dataset. If <username> does not have the
password, then specify 0 for <password>. For <portNumber>, specify the BMC Remedy
AR System server port number or 0 for no port number.
4. From the command window, check the simulation results.
5. Run the utility for each class in the dataset.
To view the simulation results

For each simulation, the utility produces a text file with more detailed results. The file is named <
className_datasetID>_NESimulation.txt.
1.
BMC Atrium Core 9.0
Page 926 of 2268
Home
1. In the location where you ran the script or batch file, open the text file.
To import the file into a spreadsheet application, use the pipe ( | ) character as a field
delimiter.
2. In the Status column, look for CIs marked as Failed.
Check that the Model and ManufacturerName attributes have values. The Normalization
Engine uses these attributes to find Product Catalog entries. If they have values, you might
need to create aliases. For more information, see Mapping product and manufacturer aliases
.
3. In the Status column, look for CIs marked as New Product.
Review the attribute values that the new product entry will have. You can modify the CIs, or you
might need to modify the Category, Type, and Item values. For more information, see Working
with normalization modes and options.
After you have corrected the issues, you can set up a normalization job for the dataset.
Setting up aliases for normalization
After simulating normalization, you can reduce failures by creating product and manufacturer
aliases or mapping product categorizations.
Mapping product and manufacturer aliases
Mapping product categorization aliases
To map discovery categorization to product categorization
Mapping product and manufacturer aliases

In BMC Atrium Product Catalog, you can create an alias for the Model or ManufacturerName
attribute for a discovered or imported CI so that the Normalization Engine can find the product in
the Product Catalog and normalize the CI.
In the normalization process, the Normalization Engine always checks for a Model or
ManufacturerName alias. If the CI has a Model or ManufacturerName alias, the Normalization
Engine replaces the CI's Model or ManufacturerName attribute value with the alias and searches
for an entry in the Product Catalog.
The Version Normalization feature also uses manufacturer aliases to look up a matching Version
Rollup rule for a CI. For more information, see Normalization and software license management
BMC Atrium Core 9.0
Page 927 of 2268
Home
and Configuring Version Rollup normalization rules.

For more information about product and manufacturer aliases, see Product name and manufacturer
normalization aliases in the Product Catalog .
Mapping product categorization aliases

From the Product Catalog Alias Mapping form, you can map incoming CI categorizations for a
discovered or imported CI to preferred categorizations for different reasons.
First, the product categorization aliases provide the correct categorizations either when the CI's
Category, Type, and Item attributes have no values or when they do not match those in the
corresponding Product Catalog entry.
Note
To create aliases for the Model or ManufacturerName attributes, use the Normalization
Alias form in the Product Catalog, even though the Catalog Mapping window allows you to
map aliases in the Product Name and Manufacturer Name fields. The Normalization
Engine always checks the Normalization Alias form in the first step in the normalization
process.
Unlike with the product and manufacturer aliases, the Normalization Engine does not always check
for product categorization aliases. Instead, it checks the categorization aliases for any of the
following conditions:
If the combination of the values of Category, Type, Item, Model, and
ManufacturerName is not in the Product Catalog data.
If the combination of values is in the Product Catalog but is not related to the company for
whom the CI is being submitted.
For example, if you specify Desktop in the Category field in the Discovery Product Categorization
area and Hardware in the Category field in the Mapped Product Categorization area, any incoming
CI that has a value of Desktop for the Category attribute is saved as Hardware for Category.
Second, you should also create product categorization aliases for CIs where the Model or
ManufacturerName attribute has no value. For more information, see Normalization and NULL
values for Model (Product Name) and ManufacturerName .
Third, when the Allow New Product Catalog Entry option is enabled, the Normalization Engine
uses the product categorization aliases to create a Product Catalog entry when it does not find one
for the CI.
BMC Atrium Core 9.0
Page 928 of 2268
Home
To map discovery categorization to product categorization

1. In the BMC Atrium Core Console, click Application Launcher > Applications >
Normalization.
2. In the Normalization console, click Catalog Mapping.
3. From the CI Class list, select the class for which you want to create the product alias
mapping.
4. In the Discovery Product Categorization section, select the categorization values of
discovered products for the CI class you selected.
5. Specify a name for the product in the Product Name field.
6. In the Mapped Product Categorization section, select the categorization values that are
applied to the discovered product when it is normalized.
7. Click Save.
Normalization modes
This topic discusses normalization modes:

Working with normalization modes and options
Configuring inline normalization
Configuring continuous normalization
Creating a normalization job and schedule
You can normalize using these different modes: inline, continuous, and batch.
Inline (realtime) CIs are normalized any time that they are created or modified in BMC
Atrium CMDB. In this mode, CIs are normalized before they are saved in BMC Atrium CMDB
. For more information, see Configuring inline normalization.
Continuous In this mode, CIs are normalized after they are saved in BMC Atrium CMDB
based on changes to the CIs, not to the dataset. When CIs are added or changed, BMC
Atrium CMDB notifies the Normalization Engine which then checks and normalizes the
modified CIs.
You must configure both of the following conditions for continuous normalization, which
starts when one of the conditions is met.
When a specified number of creation and modification events occurs
After a specified interval of time
For more information, see Configuring continuous normalization.
Batch (scheduled) In this mode, CIs are normalized after they are saved in BMC Atrium
CMDB based on a schedule for a dataset, unlike the Continuous mode which is based on
individual CIs. For more information, see Initial CI loading with batch normalization.
Important
BMC Atrium Core 9.0
Page 929 of 2268
Home
When normalizing a large amount of data, use the batch mode, and schedule it to run
outside of heavy use hours to minimize the impact on users. You can use the continuous
mode for dataset updates.
Do not run more than one BMC Atrium Integration Engine, Normalization Engine, or
Reconciliation Engine job at the same time because they might query or update the same
data.
Batch normalization normalizes product attributes, including categories, regardless of the

normalization type setting for CIs with a NormalizationStatus of Not Normalized and Not
Approved.
You define a schedule when you create a normalization job. See Creating a normalization job and
schedule.
If a normalization job in batch mode is interrupted, the Normalization Engine tracks the classes that
were normalized before the interruption and resumes with the class that was being normalized. If a
class that was normalized before the interruption has a changed or new CI, the Normalization
Engine does not scan for changes. Instead, the next job normalizes the changes.
The following figure shows an example of an interrupted normalization job. Classes 1A and 2B
were completed before the interruption. Normalization resumes with class 3C, and the
normalization job is not aware of new or modified CIs in the completed classes.
Interrupted normalization
The following figure shows the difference between inline and continuous normalization. With inline
normalization, CIs are normalized before they are written to BMC Atrium CMDB datasets. With
continuous normalization, CIs are written to a dataset before they are normalized.
In this example, Calbro uses inline normalization on CALBRO.APPS because it is not frequently
updated. Normalizing CIs one at a time would have minimal performance impact on users. Calbro
uses continuous normalization on the CALBRO.DISC dataset for specific reasons. First, Calbro
BMC Atrium Core 9.0
Page 930 of 2268
Home
completed a bulk normalization with a batch job. Second, because the discovery tool typically adds
or changes few CIs in the dataset, Calbro sets this to continuous mode. Calbro staff also sets
normalization to start when 10 CIs are changed or created or when five minutes have elapsed since
the previous normalization.
Inline and continuous normalization

The normalization batch (scheduled) mode is enabled by default, and it can be scheduled or started
manually from the Normalization console. Inline and Continuous modes are disabled by default. To
enable them, you must enable the system and dataset configuration options.
The normalization options listed in Normalization status vary depending on the normalization
mode.The batch mode normalizes all supported attributes, including categorization attributes,
regardless of the normalization type setting.
Normalization modes
Normalization mode
Off setting
Everything On setting
CTI Only setting
Inline
Off
Everything On
CTI Only
Continuous
Off
Everything On
CTI Only
Batch
Everything On
Everything On
Everything On

Use the following procedure to select inline normalization, which does not require creating a
normalization job. Normalization for the selected dataset starts when instances are created or
modified.
BMC Atrium Core 9.0
Page 931 of 2268
Home
To configure inline normalization for a dataset

2. In the Dataset Configuration tab, click Inline Normalization for the desired dataset.
3. Click Save.

Use the following procedure to create a normalization job and to define the condition for starting it.
The possible conditions are the following:
When a specified number of events occurs
The Normalization Engine checks both conditions and, when either condition is met, normalizes CIs
saved in BMC Atrium CMDB that have been created or modified since the previous normalization.
These conditions are defined globally and cannot be defined for specific datasets. To enable or
disable continuous mode, set it in the normalization job.
Note
The continuous normalization jobs are not automatically restarted when the BMC Remedy
AR System server restarts. You must manually restart the continuous normalization jobs
when the BMC Remedy AR System server restarts.
After you start a continuous job, two job runs are created:
One job normalizes the newly created or modified CIs of the configured dataset immediately.
Another job continues to run and normalize the CIs as they are created based on the event
and time conditions. You can stop this job at any time from the Normalization console.
A dataset that is configured for continuous mode can also be configured for inline mode.
Note
The inline normalization mode always takes precedence over the continuous mode or a
schedule.
Before you begin

If you are using the continuous mode, define the conditions. See Configuring continuous
normalization.
BMC Atrium Core 9.0
Page 932 of 2268
Home
Check that the dataset specified in the normalization job has normalization enabled in the
Dataset Configuration. By default, only CTI is normalized. See Normalization settings for
datasets.
To define continuous normalization settings

2. In the System Configuration tab, expand Continuous Mode Settings to define the
following settings.
Events
Threshold
The number of events that must occur continuous normalization starts. An event is when a CI is
updated or created. The default is 10.
Time Threshold
(Sec)
The number of seconds that define the interval when continuous normalization starts. The default is
180.
To create a continuous normalization job

1. In the Normalization console, click Create Job.
2. Enter a unique name for the job.
3. From the Dataset ID list, select the dataset to normalize.
4. Click Continuous Job.
Checked--Normalize CI instances in BMC Atrium CMDB based on time or on defined
number of events, and sets the NormalizationStatus attribute.
To define the time and event settings, see Configuring continuous normalization.
For information on possible NormalizationStatus values, see Normalization
status.
Unchecked--Uses the system normalization mode. See Normalization settings for
datasets.
5. (Optionally) Select Auto Start Job. This setting enables you to keep the job continuously
running even after AR server is restarted.
6. Click Save.
7. In the Normalization console, select the continuous job, and click Start Job.
When started, a continuous job continues to run until you stop the job.

To set up batch normalization, you must create a normalization job. For more information about
batch normalization, see 81707.
Recommendation
BMC Atrium Core 9.0
Page 933 of 2268
Home
data. Avoid overlapping the importing, normalizing, and reconciling of CIs. Reconciling
related CIs, such as a system and its components, can cause errors if all the related CIs
and relationships do not exist when reconciliation starts.
Before you begin

Check that the dataset specified in the normalization job has normalization enabled in the Dataset
Configuration. By default, only CTI is normalized. See Normalization settings for datasets.
To create a batch normalization job

4. Specify values for the following settings.
Start Time
Select a time of day that the job starts.
Recurrence
Type
Select the interval at which the job executes.
Recurrence
Details
For Monthly and Weekly intervals, select the days of the week or of the month. You can select more
than one day.
5. Click Save.
After you create a batch job, you do not need to start the job. It runs automatically at the
scheduled time. However, when you need a job to run immediately, you can select the job in
Normalization console and click Start Job.

The normalization batch (scheduled) mode is enabled by default, and it can be scheduled or started
manually from the Normalization console. Inline and Continuous modes are disabled by default. To
enable them, you must enable the system and dataset configuration options.
The normalization options listed in Normalization status vary depending on the normalization
mode.The batch mode normalizes all supported attributes, including categorization attributes,
regardless of the normalization type setting.
Normalization modes
Normalization mode
Off setting
CTI Only setting
Inline
Off
Everything On
CTI Only
Continuous
Off
Everything On
CTI Only
BMC Atrium Core 9.0
Page 934 of 2268
Home
Normalization mode
Off setting
CTI Only setting
Batch
Everything On
Everything On
Everything On
Related topics
Normalization modes
Use the following procedure to select inline normalization, which does not require creating a
normalization job. Normalization for the selected dataset starts when instances are created or
modified.
To configure inline normalization for a dataset

2. In the Dataset Configuration tab, click Inline Normalization for the desired dataset.
3. Click Save.
Related topics
Normalization modes

Use the following procedure to create a normalization job and to define the condition for starting it.
The possible conditions are the following:
When a specified number of events occurs
The Normalization Engine checks both conditions and, when either condition is met, normalizes CIs
saved in BMC Atrium CMDB that have been created or modified since the previous normalization.
These conditions are defined globally and cannot be defined for specific datasets. To enable or
disable continuous mode, set it in the normalization job.
BMC Atrium Core 9.0
Page 935 of 2268
Home
Note
The continuous normalization jobs are not automatically restarted when the BMC Remedy
AR System server restarts. You must manually restart the continuous normalization jobs
when the BMC Remedy AR System server restarts.
After you start a continuous job, two job runs are created:
One job normalizes the newly created or modified CIs of the configured dataset immediately.
Another job continues to run and normalize the CIs as they are created based on the event
and time conditions. You can stop this job at any time from the Normalization console.
A dataset that is configured for continuous mode can also be configured for inline mode.
Note
The inline normalization mode always takes precedence over the continuous mode or a
schedule.
Before you begin

If you are using the continuous mode, define the conditions. See 85447.
Check that the dataset specified in the normalization job has normalization enabled in the
Dataset Configuration. By default, only CTI is normalized. See Normalization settings for
datasets.
To define continuous normalization settings

2. In the System Configuration tab, expand Continuous Mode Settings to define the
following settings.
Events
Threshold
The number of events that must occur continuous normalization starts. An event is when a CI is
Time Threshold
The number of seconds that define the interval when continuous normalization starts. The default is
180.
(Sec)
updated or created. The default is 10.
To create a continuous normalization job

4.
BMC Atrium Core 9.0
Page 936 of 2268
Home
4. Click Continuous Job.

Checked--Normalize CI instances in BMC Atrium CMDB based on time or on defined
number of events, and sets the NormalizationStatus attribute.
To define the time and event settings, see 85447.
For information on possible NormalizationStatus values, see Normalization
status.
Unchecked--Uses the system normalization mode. See Normalization settings for
datasets.
5. (Optionally) Select Auto Start Job. This setting enables you to keep the job continuously
running even after AR server is restarted.
6. Click Save.
7. In the Normalization console, select the continuous job, and click Start Job.
When started, a continuous job continues to run until you stop the job.
Related topics
Normalization modes

To set up batch normalization, you must create a normalization job. For more information about
batch normalization, see 81707.
Recommendation
data. Avoid overlapping the importing, normalizing, and reconciling of CIs. Reconciling
related CIs, such as a system and its components, can cause errors if all the related CIs
and relationships do not exist when reconciliation starts.
Before you begin

Check that the dataset specified in the normalization job has normalization enabled in the Dataset
Configuration. By default, only CTI is normalized. See Normalization settings for datasets.
To create a batch normalization job

2.
BMC Atrium Core 9.0
Page 937 of 2268
Home

4. Specify values for the following settings.
Start Time
Select a time of day that the job starts. The selected time is the server time.
Recurrence
Type
Select the interval at which the job executes.
Recurrence
Details
For Monthly and Weekly intervals, select the days of the week or of the month. You can select more
than one day.
5. Click Save.
After you create a batch job, you do not need to start the job. It runs automatically at the
scheduled time. However, when you need a job to run immediately, you can select the job in
Normalization console and click Start Job.
Note
Normalization Engine does not allow you to edit the job type and change it to a different
job type. For example, you cannot edit a batch job to change it to a continuous job. To
change a batch job to a continuous job, you are required to create a new job.
Related topics
Normalization modes
Configuring normalization settings for datasets

This topic provides instructions for configuring normalization settings for datasets:
Before You Begin
To configure normalization settings across all datasets
To configure normalization settings for individual datasets
You can configure normalization for datasets in the following ways:
Configure default normalization of CIs across all datasets.
These settings are the default normalization settings for all datasets, but these settings do
not override the individual dataset configurations unless you select Apply Default Settings
to all Datasets.
BMC Atrium Core 9.0
Page 938 of 2268
Home
Customize normalization for each dataset.

The dataset normalization settings override the system defaults.
Note
The Version Normalization and DML Based Instance Normalization features are
enabled for all datasets by default and cannot be disabled or configured for
individual datasets.
By default, all datasets also have the Relation Name Normalization and Impact
Normalization features enabled. The Normalization Type set to CTI Only.
Before You Begin

You must create a job to normalize the datasets.
Enable inline or continuous normalization for a dataset to normalize when CIs are created.
Create a batch job to normalize CIs that are created when normalization is stopped, such as
during upgrades.
For more information, see Normalization modes.
To configure normalization settings across all datasets

2. In the System Configuration tab, expand Default Dataset Normalization Settings.
3. Select the values for the normalization settings.
For more information about the settings and values, see Normalization settings for datasets.
4. To apply the change to all datasets including currently configured datasets, select Apply
Default Settings to all Datasets.
5. Click Save.
To configure normalization settings for individual datasets

2. In the Dataset Configuration tab, set the normalization settings for each Dataset ID.
For more information about the settings and values, see Normalization settings for datasets.
BMC Atrium Core 9.0
Page 939 of 2268
Home
3. To enable or disable the Normalization Features, click the ... button in the Normalization
Features column.
4. Click Save.
Monitoring normalization jobs
The History tab displays the job run information for batch and continuous normalization.
You can also display jobs with a specific status or jobs that executed within a range of dates.
Name The name assigned to the job when it was created. You can click the name of a job
to view all of its past and current executions. For each job run, you can view its details,
including processed CIs and classes, logging information, and the reason for an aborted run.
Status One of the following states:
Started The job is currently in progress.
Completed The job finished successfully.
Failed The job could not finish and error messages were logged.
Start time Job start time.
End time Job end time.
You can expand each job history entry to view its details.
Job Run ID
Status
Start time
End time
Is full run
Reason for abort
BMC Atrium Core 9.0
Page 940 of 2268
Home
Number of classes processed

Total number of classes
Total number of CI processed
Current class being processed
Total number of CIs processed in current class
Total number of CIs in current class
Log file name
Optional normalization tasks

You can configure system parameters for the Normalization Engine to improve performance and to
configure logging information.
Configuring RPC ports and threads for the Normalization Engine
Configuring Normalization Engine logging
Disabling normalization for all datasets
Exporting and importing normalization configurations
Configuring RPC ports and threads for the Normalization Engine

Because the Normalization Engine is multithreaded, you can configure it to improve performance.
The number of threads available to the Normalization Engine is determined by settings for the BMC
Remedy AR System server where it is installed. The Normalization Engine maintains a pool of
connections to the BMC Remedy AR System server so that it can reuse the existing connections.
To set RPC ports and threads for the Normalization Engine

2. In the System Configuration tab, expand RPC Queue to define the following parameters.
AR RPC
Queue
RPC queue for BMC Remedy AR System API calls back to BMC Remedy AR System. Select from any of the
possible values: 390600, 390621-390634, 390636-390669, and 390680-390694. The default is 0.
CMDB
RPC
Queue
RPC queue for BMC Atrium CMDB API calls back to BMC Remedy AR System server. The possible values
are 390698 or 390699. The default is 0.
3. Expand Threads and Connections to define the following parameters.

Threads In
Batch Pool
Threads In
Continuous
Pool
Maximum number of threads in the thread pool for batch jobs. The Normalization Engine checks whether
batch jobs need to be started. If so, a new thread is spawned from the batch normalization thread pool for
normalization If a batch job is normalizing a dataset and a new job requests to run the batch for that
dataset again, that request is aborted. The default is 4.
Maximum number of threads in the thread pool for continuous mode. The continuous threads check
whether the continuous normalization needs to be started. If so, a new thread is spawned from the
continuous normalization thread pool. When the threads in the pool have been exhausted, the
Normalization Engine queues any further requests to wait for an available thread The default is 10.
BMC Atrium Core 9.0
Page 941 of 2268
Home
Configuring Normalization Engine logging

The Normalization Engine provides logging information in different areas.All types have different
contexts and can occur simultaneously.
For example, BMC Atrium CMDB has three datasets (A,B, and C) configured for normalization. The
logging details of these datasets are as follows:
Dataset A is normalized once a week as a batch job, so its logging information is saved to
the NE.datasetA.<nnn>.log file.
Dataset B is normalized in continuous mode, and its logging data is saved to the
neContinuous.log file.
Dataset C is configured for weekly batch normalization using the Normalization API, so it has
more detailed logging information about the API events in the neApi.log file.
Logging details for different types of normalization jobs are summarized in the table below:
Job Type
Log File Location
Default
Notes
Log Level
Batch
normalization
<AtriumCore_install>\logs\
Information
The job ID is available in the Normalization console.
Continuous
normalization
neContinuous.log
Warning
Normalization
API
neApi.log
Warning
If discovery products use normalization APIs, use this log file to

diagnose problems. This log file contains information for inline
normalization.
neJob.<dataSetId>.<jobID>.
log
To configure Normalization Engine logging

2. In the System Configuration tab, for each type of logging (Batch, API, and Continuous),
click on Click to launch Plugin Server Configuration (Select Normalization Engine) .
3. A Plugin Server Configuration form opens in a window. From the Plugin Server Instance
drop-down list, select plugin server with port number 9555.
4. Click Plugin Configuration tab to view the configured shared plugins.

a. Click Plugin Server Configuration tab and modify the following settings:
BMC Atrium Core 9.0
Page 942 of 2268
4.
Home
a.
Field
Action
Enable
Plugin
Log
Select True to enable logging for the plugin server.
Log level
Select the log level option based on what type of information you want to save in the log file. For
more information about log levels, see Understanding Log Levels.
Log file
This defines the path on the server where the log file is saved.
Maximum
Log File
Size
When the log file reaches the file size limit, it is renamed and a new log file is created. The older
Log
History
Specify a value to keep a history of number of log files to be maintained as a backup.
files are not automatically deleted. For example, if the log file is named neJob.BMC.ASSET.0001.
log, the older files are named neJob.BMC.ASSET.0001.log.1 andneJob.BMC.ASSET.0001.log.2
.
5. Click Apply
6. Close.
Note
The modified settings are not applied to current normalization jobs, but future jobs use the
modified values.
Manually stopping a normalization job

You can stop a normalization job during its current run.
To stop the current run of a normalization job

1. In the Normalization Console, select the job for which you want to stop the current run.
2. Click Stop Job Run.
Disabling normalization for all datasets

You can disable normalization by default for all datasets.
For each dataset, you can enable normalization. See Normalization settings for datasets.
To disable normalization globally

2. In the System Configuration tab, expand Default Dataset Normalization Settings.
3. For Normalization Type, select Disabled.
4. To apply the change to all datasets, including currently configured datasets, select Apply
Default Settings to all Datasets.
5.
BMC Atrium Core 9.0
Page 943 of 2268
Home
5. Click Save.
Exporting and importing normalization configurations

This topic discusses exporting and importing normalization configurations
Normalization Engine import options
To export normalization settings
To import normalization settings
When migrating (for example, from a development to production environment), you can export and
import the following normalization settings:
Dataset normalization settings
BMC Atrium CMDB class settings
Job schedules
Product Catalog alias mapping
The settings for Normalization System Configuration are not exported, including logging, RPC
Queue, and Threads and Connections settings.
Important
Do not save the file using Microsoft Notepad because it does not save the carriage returns
and line feeds (CR+LF) correctly. Use a plain text editor that retains CR+LF. Otherwise,
importing the definitions fails.
The normalization configuration is saved as XML to your computer's clipboard, which you can then
paste into a file.
Normalization Engine import options

In case of duplicate entries, the Normalization Engine provides the following import options:
Import options for duplicate entries

Import
option
Description
Discard
Duplicate
Entries
Any configuration settings in the imported data that match existing settings are not imported. All other imported
settings overwrite existing ones. If settings are the same in the imported and existing configurations, the existing
settings are used.
Replace
Duplicate
Entries
If settings are the same in the imported and existing configurations, the imported settings are used.
BMC Atrium Core 9.0
Page 944 of 2268
Home

1. In the Normalization console, click Export Configuration.
2. In Select Export Options, click options to exclude or include in the XML.
The XML is automatically generated.
3. Click Save to copy the XML configuration information to your system clipboard.
4. Open or create a file in a text editor, and paste the copied XML data.

1. From a saved file or from the Export Normalization Configuration dialog box, copy the
XML configuration data.
2. In the Normalization console, click Import Configuration.
3. In Select Import Option for Duplicate Entries , select the appropriate option.
For more information about the import option for duplicate entries, see Normalization Engine
import options.
4. In the XML input for Import text box, paste the XML data.
5. Click Import.
6. When the import message appears, click Close.
Reconciling data
The following topics introduce functionality available through the Reconciliation Engine, a
component of the BMC Atrium CMDB that reconciles data from multiple sources and performs
other maintenance functions on datasets:
Reconciliation in a server group
Reconciliation IDs
Reconciliation jobs
Reconciliation Identify and Merge activities
Additional reconciliation activities
Namespaces and reconciliation
Reconciliation configuration
BMC Atrium Core 9.0
Page 945 of 2268
Home
Reconciliation Identify activity
When multiple data providers load data into multiple datasets of BMC Atrium CMDB, you need a
reconciliation process to enable you to compare data from different data sources and to create one
complete and correct production dataset.
The Reconciliation Engine is a component of BMC Atrium CMDB that performs the following
important reconciliation activities:
Identifies class instances are the same entity in two or more datasets
Merges CI attributes from a dataset to a production dataset
The reconciliation job is a container for reconciliation activities, which themselves can have different
components. The primary activities are Identify and Merge. A reconciliation job can have one or
more activities, each of which defines one or more datasets and rules for that activity. In addition,
you can use a Qualification Set to restrict the instances participating in a reconciliation activity.
You can choose several methods for starting a reconciliation job, including manually, scheduled
jobs, a continuous job, BMC Atrium API, or a Run Process Workflow.
Structure of a reconciliation job
Jobs can use standard or customized rules. Standard rules use defaults for Identify and Merge
activities and automate the creation of reconciliation jobs. You can also create custom jobs that
include all of the different activities and for which you can modify the default settings.
Note
BMC Atrium Core 9.0
Page 946 of 2268
Home
BMC recommends reconciling only CIs that have been normalized or that do not require
normalization. To reconcile the appropriate CIs, enable the Process Normalized CIs
Only option in the Job Editor.
A reconciliation job can include activities other than Identify and Merge. For more information, see
Normalizing data.
Reconciliation Engine permissions

To configure and use the Reconciliation Engine, you must have the appropriate assigned
permission roles. These roles include:
CMDB RE User
CMDB RE Definitions Admin
CMDB RE Manual Identification
For more information about these roles and how to assign them, see BMC Atrium Core permission
roles within applications.
Reconciliation Identify activity

Before you can merge different versions of instances, you must determine that they represent the
same entity. Identification accomplishes this matching by applying rules against instances of the
same class in two or more datasets.
For example, a rule intended to identify computer system instances might specify that the IP
addresses of both instances be equal. When the rules find a match, both instances are tagged with
the same reconciliation identity, an extra attribute showing that they each represent the same item
in their respective datasets.
You can also manually identify instances that failed to be identified by the rules in an Identify
activity.
Note
An instance must be identified before it can be compared or merged.

Merging takes two or more datasets and creates a composite dataset according to precedence
values specified at the dataset, class, and attribute levels.
Merging is essential for producing a single valid configuration when different discovery applications
provide overlapping data about the same items, or when you need to commit changes that were
BMC Atrium Core 9.0
Page 947 of 2268
Home
made in your sandbox dataset as a test. To take advantage of the areas of strength in each dataset
, you create precedence values that favor those strengths. This gives you one CI instance with the
best of all discovered data.
You give an overall precedence value to each dataset, but you can override that value for particular
classes and attributes in each dataset. Whichever dataset has the highest precedence value for a
given attribute has its value for that attribute placed in the target dataset. A precedence value for a
class also applies to its subclasses unless the subclasses have their own precedence values.
When an instance is added or updated in a dataset, BMC Atrium CMDB sets the
ReconciliationMergeStatus attribute of that instance to Ready to Merge. The Merge activity
considers only those instances that have been given an identity and for which the
ReconciliationMergeStatus attribute is set to Ready to Merge. After merging a CI, the
Reconciliation Engine updates the value of the ReconciliationMergeStatus attribute from
Ready To Merge to Merge Done.
Reconciliation in a server group

The Reconciliation Engine automatically executes reconciliation jobs on a primary or secondary
server in a server group in response to server status changes. A server group is two or more
servers that share the same database that provide failover operations.
The BMC Remedy AR System server notifies the Reconciliation Engine of a status change. If the
primary server has a suspended status, the Reconciliation Engine stops reconciliation jobs on the
primary server and resumes them on another server from the point where they stopped on the
primary server. If the primary server status changes to running, reconciliation jobs on secondary
servers are paused and resumed on the primary server.
With BMC Atrium Core 7.6.03 and later, the Reconciliation Engine assigns the SGPPaused status
when a job is paused while the job switches from one server to another in the server group. For
example, when a job is running on one server (server 2) and higher ranking server (server 1)
comes up, the Reconciliation Engine pauses the job on server 2 and updates the job run status to
SGPaused.
Prior to BMC Atrium Core 7.6.00, the Reconciliation Engine did not transfer jobs among servers
based on server group ranking. For example, a server group includes server A with the
Reconciliation Engine configured and with other applications on server B. Before 7.6.00, when
server A was stopped, server B never automatically picked up and completed any running
reconciliation jobs.
Note
BMC Atrium Core 9.0
Page 948 of 2268
Home
If you want to exclude a server that has no rank assigned or a user facing server
from running reconciliation jobs, you must comment the Reconciliation Engine entry
(arrecond.exe) in the armonitor.cfg file.
If you want to exclude a ranked server from running reconciliation jobs, you must
the remove rank of the server and comment the Reconciliation Engine entry (
arrecond.exe) in the armonitor.cfg file.
The BMC Remedy AR System server transfers control from one server to another depending on
the Rank value specified in the AR System Group Operation Ranking form. The Reconciliation
Engine takes three iterations of 60 seconds (180 seconds total) to transfer a job from one server to
another so that the first server properly pauses the running job(s) and the second server resumes
the. job(s). This process avoids running the same job on both servers simultaneously.
For more information about installing BMC Atrium Core in a server group, see Installing BMC
Atrium Core in an AR System server group .
For more information about BMC Remedy AR System and server groups, see the BMC Remedy
Action Request System documentation.
Reconciliation IDs
The Identify activity can review all incoming data, determine similar CIs across more than one
dataset, and mark where these dataset instances seem to be the same CI.
The Reconciliation Engine marks CI and relationship instances with Reconciliation IDs that are
unique to individual CIs within a dataset.
This initial marking step is critical to enabling the compare and Merge activities without causing
conflicts from overlapping data that could potentially corrupt your CMDB with unreliable CI data.
After identification has occurred, you can move to the next step and determine how to interpret and
combine this data.
Important
Do not change the value for unidentified and identified CIs or relationships. The
Reconciliation Engine looks for a value of 0 for unidentified CIs. Changing this value to
NULL or some other character causes identification to fail.
The Reconciliation ID is stored in the ReconciliationIdentity attribute of BMC_BaseElement

and BMC_BaseRelationship.
You can use the following settings to modify the Reconciliation ID:
BMC Atrium Core 9.0
Page 949 of 2268
Home
Generate IDs (in Dataset Configuration) When the source dataset does not already have
an identity, you can assign an automatically generated identity to instances in the dataset in
the Identification set. See Creating a reconciliation Identify activity.
Generate IDs (in Additional Parameters) If this option is enabled, the Reconciliation
Engine searches for CIs in the production dataset that have a Reconciliation ID of 0 and sets
the ID to a nonzero value that is unique across all datasets. See Creating a reconciliation
Identify activity.
Reconciliation jobs
The following topics explain how to create and manage reconciliation jobs:
Preparing data for reconciliation
Creating a standard reconciliation job
Starting and stopping a reconciliation job
Viewing reconciliation job status, results, and history
Creating and editing a customized reconciliation job
Ignoring multi-matched CIs during reconciliation
Enabling the progress bar display for reconciliation Identification and Merge jobs
Monitoring reconciliation jobs using the Fail safe feature
Performing reconciliation jobs health check
Preparing data for reconciliation

Before running reconciliation jobs, you should observe the following guidelines to prepare data for
successful identify and merge.
Make sure that each data provider has its own import dataset. For more information about
datasets, see Overview of datasets.
Verify that CI attributes used for identification have unique values and are populated
consistently. If you use a standard job or the standard identification rules, you can look at the
classes and identifying attributes in the Standard Rules Editor.
For example, the Name attribute is used to identify instances of most classes. For some classes,
the rules include other attributes. For example, the standard rules identify instances of
BMC_DiskDrive based on Name and SerialNumber.
Note
Do not populate the TokenID attribute unless you know the formulas that BMC discovery
products use to populate it. Some BMC discovery applications use TokenID.
BMC Atrium Core 9.0
Page 950 of 2268
Home
Creating a standard reconciliation job

For most reconciliation jobs, the Standard Identification & Merge Job uses default settings to
simplify creating jobs.
Determining when to use standard reconciliation jobs and rules
Standard reconciliation identification and merge job settings
The standard job contains the most common reconciliation activities:
Identifying class instances that are the same entity in two or more datasets.
Merging class instances from one dataset (such as discovery) to another dataset (by default,
the production BMC.ASSET dataset).
All the identification and merge settings use automated values, which you can modify from the Job
Editor.
Note
By default, a standard job identifies and merges CIs that have not been normalized. To
reconcile only CIs that have been normalized, enable the Process Normalized CIs Only
option in the Job Editor.
Recommendations
To get the most use out of discovered data, after discovering data Normalize the data,
reconcile it into your production dataset immediately after your discovery application loads
data into BMC Atrium CMDB.
Do not create jobs that simultaneously identify the same dataset or merge data into the
same target dataset. Simultaneous reconciliation can either overwrite data you wanted to
keep from the other job or create duplicate CI instances.
If you need to create multiple jobs to merge data into the same production dataset, use the
Execute activity to run the jobs sequentially or set the jobs as continuous and run them in
parallel with the Look Into Other Datasets for Parallel Continuous Jobs option selected.
For information about configuring Look Into Other Datasets for Parallel Continuous Jobs
option, see Configuring Reconciliation Engine system parameters.
Do not run the BMC Atrium Integration Engine, Normalization Engine, or Reconciliation
Engine at the same time because they this may have an impact on system resources
availability.
For a large amount of data, such as an initial load, run separate identify and merge jobs to
allow for better diagnostics.
BMC Atrium Core 9.0
Page 951 of 2268
Home
For incremental updates, run identify and merge activities in one job. For new CIs, the
identify and merge activities are run. For modified CIs, the identify activity runs quickly
because the CIs have reconciliation IDs, and the merge activity runs.
Consider indexing attributes used in identification rules. Consult your DBA to determine what
indexes would help you.
Do not rename the OOTB Reconciliation jobs, as other products could be using the names
given to those jobs.
Before you begin

Verify that the default identification and merge settings for a standard job. See Standard
identification and precedence rules for reconciliation jobs .
To create a standard reconciliation job

1. In the Reconciliation console, click Create Standard Identification & Merge Job.
2. For Name, type a short unique name for the job.
The name must be unique, and cannot contain any characters that are not allowed in
filenames for the operating system of your server. For example, on a Windows server your
job name cannot contain the following characters: \ / : * ? " < > |.
3. Select the Source Dataset from which data is copied and merged with the production
dataset.
4. Click Save.
Determining when to use standard reconciliation jobs and rules

In most cases, you can use a standard job or the standard rules to identify and merge your data.
BMC recommends that you start with a Standard Identification & Merge Job and customize the job
or rules as needed. Unless you need different identification or precedence (merge) rules, you can
use a Standard Identification & Merge Job and modify the activity options while using the standard
rules.
If you have custom classes or attributes, you can modify the standard identify and
precedence rules, and use a Standard Identification & Merge Job.
You can create and modify a Standard Identification & Merge Job that uses the standard
rules for the following customizations:
If you need to change the production dataset in an identify activity
If you need to change the Generate IDs or Exclude Subclasses options in an
identify activity
If you need to change the source and target datasets in a merge activity
If you need to change the Include Unchanged CIs option or the Merge Order option
in a merge activity
If you have one dataset that needs to have different identify or precedence rules, first, see if
you can modify the standard identify or precedence (merge) rules without affecting the
existing rules. If you cannot, then you might have to create a custom job, disable the
BMC Atrium Core 9.0
Page 952 of 2268
Home
standard rules, and create custom identify or precedence rules.

With merges, you can set a precedence value for a dataset, or, if needed, you can assign a
precedence value to a particular class or attribute in a specific dataset. For example, Calbro
wants to keep the default precedence value of 800 for BMC_Product in the BMC
Configuration Import dataset, but they want to assign a higher precedence value to
BMC_Product in the CALBRO.APPS dataset because it is an import of software products
that they consider more accurate.
For identification, you cannot specify a rule for a particular dataset, but you can check if
adding an attribute at a lower priority can address the needs of a specific dataset. For
example, if Calbro knows that for the CALBRO.APPS dataset, the TokenID, Name, and
SerialNumber attributes are not sufficient to identify some instances. Calbro can add the
custom CalbroID attribute that identifies those instances in that dataset. By setting it to a
priority of 3, the default rules work for most datasets, but for CALBRO.APPS, after the
priority 1 and 2 attributes fail to identify instances, the Reconciliation Engine uses the
CalbroID attribute.
Standard reconciliation identification and merge job settings

The standard reconciliation job is configured by default.
You can modify these settings as needed. The following table describes the default settings for
identification in the standard job.
Default identification settings
Setting
Description
Default value
Status
Defines whether the Identify activity can execute (Active or Inactive).
Active
Continue on
Specifies whether the Identify activity continues to run if an error occurs in this activity.
No Note:This is
Error
automatically set to Yes if

Continuous is selected.
Production
Dataset
Specifies the dataset with instances used to identify matching instances in other
datasets. Note:The production dataset is typically the same as the target dataset in a
Merge activity.
BMC.ASSET
Generate
IDs
For CIs in the production dataset that have a Reconciliation ID of 0, specifies whether
to assign an ID.
No
Exclude
Subclasses
Defines whether to use explicit identification rulesets for each class.
No
Yes Requires that an identification ruleset be specified for every class and
subclass.
No Applies the identification ruleset for a class to all of its subclasses. You
can still specify individual rulesets for any class.
Source
Dataset
Specifies the dataset with instances compared to those in the production dataset.
BMC Atrium Core 9.0
Defined by you during job

creation
Page 953 of 2268
Home
Setting
Description
Default value
Qualification
Set
Specifies the qualifications that restricts the instances participating in a reconciliation

activity. An instance that meets one or more of the qualifications in the set participates
in an activity where that set is used.
Empty
The following table describes the default settings for merging in the standard job.
Default merge settings

Setting
Description
Default value
Status
Defines whether the Merge activity can execute (Active or Inactive).
Active
Continue on
Error
Specifies whether the Merge activity continues to run if an error occurs in this activity.
No
Precedence
Association
Defines the precedence values for classes and attributes.
Generated
Include
Unchanged
CIs
Defines whether to perform an incremental merge on attributes.
No
Yes Merges all attributes even if their value has not changed in the source dataset since
the last time this Merge activity ran.
No Merges only the attributes that changed value in the source dataset since the last
run and instances that were created in the source dataset since the last run. To improve
performance, select this option.
Target
Dataset
Specifies the dataset into which data is updated from the source dataset in a Merge activity. Note:
The target dataset is typically the same as the production dataset in an Identify activity.
BMC.ASSET
Dataset
Specifies the dataset from which data is used to update the target dataset in a Merge activity.
Defined by
you during job
creation
Qualification
Set
Specifies the qualifications that restricts the instances participating in a reconciliation activity. An
instance that meets one or more of the qualifications in the set participates in an activity where
that set is used.
Empty
Defer if Null
Determines whether a NULL value in the highest-precedence source dataset is merged to the
target dataset. See Creating a reconciliation Identify activity.
Yes
Append To
Lists
Specifies whether the list values from the source dataset overwrite the list in the target dataset.
No
Dataset
Precedence
Value
Specifies the overall precedence assigned to a dataset.
Defined in
standard rules
.
Require
Explicit
Precedences
Specifies whether to require explicit Precedence entries for attributes or to apply the class
precedence to attributes that have no assigned precedence.
No
Precedence
Value
Specifies a precedence for a particular class or attribute.
Defined in
standard rules
.
BMC Atrium Core 9.0
Page 954 of 2268
Home
Starting and stopping a reconciliation job

You use different methods to start reconciliation jobs, and you can use more than one method with
the same job.
Creating a reconciliation job schedule
Creating a continuous reconciliation job
Manually starting a reconciliation job
Using a BMC Atrium CMDB API program to run a reconciliation job
Using a Run Process workflow action to run a reconciliation job
Pausing and resuming reconciliation jobs
Manually stopping a batch or continuous reconciliation job
Creating a reconciliation job schedule

Use job schedules to run a job at regular intervals.
You select a time and days of the week for the job to run. One job can have multiple schedules.
Recommendation
When reconciling a large amount of data, create a job schedule to run outside of heavy
use hours to minimize the impact on users. You can use the continuous mode in case you
want to update a limited number of CIs or when there is less load. Generally, while
dealing with large data, the batch mode is used.
To create a reconciliation job schedule

1. In the Reconciliation console, select a job and click Edit Job.
2. In the Schedule area of the Job Editor, click New.
3. In the time field, define the time of day to execute the job.
4. Select the days of the week to execute the job.
5. In the Schedule area, click Save.
6. In the Job Editor, click Save, and then click Close.
Creating a continuous reconciliation job

You can configure reconciliation jobs to execute after a specified interval. If you specify the interval
as 5 minutes, the job executes after 5 minutes. If a job takes 8 minutes to finish, then the next job
starts immediately after the preceding job ends.
Recommendations
To create a continuous reconciliation job
BMC Default Continuous reconciliation job
Configuring a continuous single reconciliation job
BMC Atrium Core 9.0
Page 955 of 2268
Home
Before you begin

To configure a continuous single reconciliation job
For more information about setting the interval, see Configuring Reconciliation Engine system
parameters.
You can set any job as continuous and multiple jobs can be in the continuous mode at a given time.
If the continuous jobs are running in parallel on the same production dataset, you must configure
the continuous jobs to run the identify activity on all the source datasets in addition to the
production dataset. For more information, see Configuring Reconciliation Engine system
parameters.
Recommendations
When reconciling a large amount of data, create a job schedule to run outside of heavy use
hours to minimize the impact on users. You can use the continuous mode for dataset
updates.
In a standard reconciliation job, the identify and merge activities are run sequentially.
Because of this, the instances start being merged into the target dataset only after all
instances are identified. For a large amount of data, you can create separate identify and
merge jobs and configure the merge job to run in a continuous mode. When the continuous
merge job runs at the specified interval, all identified instances with the
ReconciliationMergeStatus attribute set to Ready to Merge are merged into the target
dataset.
To create a continuous reconciliation job

2. In the Schedule area of the Job Editor, click Continuous
3. In the Job Editor, click Save, and then click Close.
BMC Default Continuous reconciliation job

Included with the Reconciliation Engine installation, the BMC Default Continuous job executes
other reconciliation jobs and allows data providers to create reconciliation jobs.
It also adds activities to execute them in the BMC Default Continuous job. By default, the BMC
Default Continuous job has no activities.
For example, when you install BMC Atrium Discovery and Dependency Mapping, the installer adds
jobs with Identify and Merge activities for each BMC ADDM server and adds an Execute activity for
each job in the BMC Default Continuous job.
You can also execute custom or standard reconciliation jobs from this default job.
Important
BMC Atrium Core 9.0
Page 956 of 2268
Home
Do not delete this job because other BMC applications that add reconciliation jobs during
installation use the BMC Default Continuous job.
The purpose of the BMC Default Continuous job is to reconcile a small but critical set of data that
needs to be updated frequently. For large updates or initial loads, create a scheduled job to
minimize the impact on users.
The activities in the BMC Default Continuous job do not run in parallel or simultaneously but run
sequentially.
Configuring a continuous single reconciliation job

In earlier versions, the Reconciliation Engine system parameters were global--your settings affected
the entire server. You could not configure the Continuous Job Interval at an individual job level. You
can now set this for individual jobs. In the ContinuousJobInterval field on the Job Information
window, you can configure a single reconciliation job to execute after a specified interval.
You can expect the following behavior:
If you configure a continuous job interval as 300 seconds, only that job executes after 300
seconds.
If the job is continuous but there is no particular setting or if the setting is 0 seconds, then the
job interval reverts to the global setting.
If you try to set the field to some lower number less than 120 seconds (for example, 60
seconds), the system defaults to 120 seconds.
For example, three reconciliation jobs are set as follows:
The first continuous job has the ContinuousJob set to Yes and the ContinuousJobInterval
field set to 300 seconds.
The second continuous job is not set at the individual job level, but the global interval for the
server is set to 600 seconds.
The third continuous job has the ContinuousJob set to Yes and the
ContinuousJobInterval field set to 900 seconds.
As a result, the first job executes every 5 minutes, the second job executes every 10 minutes, and
the third job executes every 15 minutes.
Before you begin

This feature applies only when the ContinuousJob field is set to Yes.
To configure a continuous single reconciliation job

1. Open the RE:Jobs form using the direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/RE:Jobs
2.
BMC Atrium Core 9.0
Page 957 of 2268
Home
2. Enter the name of the job, and optionally select the Job Status.
3. Click Search.
4. Set ContinuousJob to Yes.
5. In the ContinuousJobInterval field, enter an interval number equal to or greater than 120 (
seconds).
6. Click Save.
Manually starting a reconciliation job

You can start a job at any time, even if it is scheduled.
To run a reconciliation job manually

1. In the Reconciliation console, select a job.
2. Click Start Job.
The job status changes to Started.
Using a BMC Atrium CMDB API program to run a reconciliation job

The BMC Atrium CMDB APIs have functions for starting and canceling job runs. This is one method
of performing event-driven reconciliation.
For information about using these functions, see the Reconciliation Engine information in Types of
BMC Atrium CMDB C API functions . You can use these functions to dynamically substitute
datasets or qualifications as described in Dynamic dataset and qualification values in event-driven
Note
When you start a job using a BMC Atrium CMDB API program, the Last Activity Time is
neither read nor updated. This means that you cannot use this method to perform an
incremental merge. Also, all Qualification Sets defined within the job are ignored, even if
you did not dynamically specify qualifications.
Using a Run Process workflow action to run a reconciliation job

You can use a Run Process action with an active link, filter, or escalation. This is one method of
performing event-driven reconciliation.
The Application-Command Reconciliation command enables you to run jobs from the command line
.
You can use the command parameters to dynamically substitute datasets or qualifications as
described in Dynamic dataset and qualification values in event-driven reconciliation jobs .
Use the following syntax:
BMC Atrium Core 9.0
Page 958 of 2268
Home
Application-Command Reconciliation <action> -o "<job_name>" -l "-c

<classID> -q <qualification>";[...];"-w <workingDatasetName> -d
<definedDatasetName>";[...];
The <action> initiated by the command can be:

Trigger-Job Starts the specified job.
Cancel-Job Cancels the specified job if it is running.
Pause-Job Pauses the specified job if it is running.
Resume-Job Resumes the specified job if it is paused.
The following table describes the parameters used with the Application-Command Reconciliation
command.
Application-Command Reconciliation command parameters

Parameter
Description
-o
Name of the job to start, cancel, create, pause, or resume. This option is required.
-l
Marks the beginning of any inputs for the command, as specified by the remaining parameters.
-c
ID of a specific class for the job.
-q
Qualification that limits the scope of the job.
-w
Source dataset name. Pair this parameter with the -d parameter.
-d
Target dataset name. Pair this parameter with the -w parameter.
For example, to start a job named Merge Datasets, use the following command:
Application-Command Reconciliation Trigger-Job -o "Merge Datasets"
You can enter multiple class-qualification pairs and dataset pairs. For example, if the Merge
Datasets job is defined to merge the BMC Configuration Import dataset into the BMC Asset dataset
but you want to run it using the TestSource and TestTarget datasets, respectively, you would use
the following command:
Application-Command Reconciliation Trigger-Job -o "Merge Datasets" -l "-w TestSource -d

BMC Configuration Import";"-w TestTarget -d BMC Asset"
Qualifications must be specified in BMC Remedy AR System internal representation. To convert a

qualification string into an internal representation, you can use the Application-Parse-Qual-L
Run Process command.
BMC Atrium Core 9.0
Page 959 of 2268
Home
For more information about dynamic dataset or qualification substitution, see Dynamic dataset and
qualification values in event-driven reconciliation jobs. For more information about Run Process
commands, see Using Run Process and $PROCESS$ commands in the BMC Remedy Action
Request System online documentation.
Note
When you start a job using a Run Process action, the Last Activity Time is neither read
nor updated. This means that you cannot use this method to perform an incremental
merge. Also, all Qualification Sets defined within the job are ignored, even if you did not
dynamically specify qualifications.
Dynamic dataset and qualification values in event-driven reconciliation jobs

When you execute a reconciliation job from either a BMC Atrium API program or a Run Process
workflow action you have the option of dynamically specifying datasets, class qualifications, or both
for the job.
Substituting datasets
Substituting qualifications
Substituting datasets
Substituting datasets works for any reconciliation activity type, and for any dataset specified in the
activity. You specify pairs of dataset IDs, where one represents the defined dataset that is saved in
the activities in the job and the other represents the working dataset to use in place of the defined
dataset during this run. You can specify as many dataset pairs as you want for a job run.
For example, you have a job that includes an Identify activity identifying Dataset 1 against Dataset
2 and Dataset 3, and a Merge activity that merges Dataset 1 and Dataset 2 into Dataset 3. On
certain occasions, you want to use the Identification rules and Precedence sets defined in these
activities to identify and merge source datasets 4 and 5 into the same target, or you want to merge
the original sources into a different target. The following figure illustrates these scenarios.
Recommendation
Consider using this feature when working with overlay datasets. For example, you can
use it to test the reconciliation of several different test states, merging from a different
overlay source dataset into a different overlay target dataset for each job run.
Dynamic dataset substitution
BMC Atrium Core 9.0
Page 960 of 2268
Home
Note
If you use dynamic dataset substitution on a job containing a Merge activity, the dataset
ID stored in the AttributeDataSourceList attribute is that of the defined dataset, not
the working dataset. For more information about AttributeDataSourceList, see
Merging datasets into a reconciled target dataset .
Warning
Any dataset pair you supply when executing a job must be valid for every activity in the
job. If you supply a pair with a defined dataset that is not used in one or more activities,
the entire job run fails.
If you have jobs that contain several different datasets, consider breaking them up into multiple jobs
to avoid the requirement that a defined dataset must exist in every activity. When you need to use
dynamic dataset substitution, you can then call the jobs separately and pass appropriate dataset
pairs. When you do not need this flexibility, schedule an umbrella job that calls each piece with an
Execute activity.
For instructions for using this feature with workflow, see Executing workflow against instances after
a reconciliation Compare activity. For instructions for using this feature with an API program, see
the Reconciliation Engine functions in Types of BMC Atrium CMDB C API functions .
Substituting qualifications
When you substitute a qualification, it replaces all Qualification Sets used in the job. This allows
you to run a job against a different subset of data each time. You specify each substitute
qualification for a particular class, and can specify as many as you want for a job run.
BMC Atrium Core 9.0
Page 961 of 2268
Home
Recommendation
Consider using this feature when you've created or modified a small number of instances
in a provider dataset. After creating or modifying the data, you can run your usual
reconciliation job that identifies and merges the dataset, but substitute qualifications that
restrict the job to only the data you just worked with.
For example, you have a job that identifies and merges all active CIs in two datasets, then
copies some of that data to a third dataset. You've just discovered several new computer
systems and printers, or perhaps just computer systems, and want to reconcile them the
same way. The following figure illustrates qualification substitution for both scenarios.
Dynamic qualification substitution
Pausing and resuming reconciliation jobs

You can pause and resume reconciliation jobs, including jobs that were interrupted or that stopped
responding.
BMC Atrium Core 9.0
Page 962 of 2268
Home
The Reconciliation Engine tracks the status of each job as Current Activity, such as Identification
and Merge. When a job is paused or interrupted, the job's status is the activity in which it was
engaged.
When the job is resumed, the Reconciliation Engine starts the job at the point at which it was
interrupted. For example, if a job was interrupted during the Identification activity, it does not restart
with the Purge activity but continues with the Identification tasks.
The following table shows an example of how resuming a paused job works during different
activities.
Resuming reconciliation jobs

When the
job is
Where the Reconciliation Engine resumes the job
paused
In Purge
The Reconciliation Engine starts the job with the Purge activity as if a new job is started. It completes the Purge,
Identification, and Merge activities.
In
Identification
The Reconciliation Engine restarts identification from the beginning. If you added new records while the job was
paused, all of those records are identified and merged. The Reconciliation Engine does not perform the Purge
activity.
In Merge
After merging a CI, the Reconciliation Engine updates the value of the ReconciliationMergeStatus attribute
from Ready To Merge to Merge Done. The Reconciliation Engine only considers the CIs for which the
ReconciliationMergeStatus attribute value was Ready to Merge when the job was paused. It does not
perform Purge and Identification activities.
Note:
The In Merge functioanlity is available only if the Merge Orger in the Merge activity is set to By class in seperate
transactions.
Manually stopping a batch or continuous reconciliation job

You can stop a batch or continuous reconciliation job during its current run, or you can stop the job
completely.
To stop the current run of a reconciliation job

1. In the Reconciliation Console, select the job for which you want to stop the current run.
2. Click Stop Job Run.
To stop a reconciliation job completely

1. In the Reconciliation Console, select the job you want to stop completely.
2. Click Edit Job.
3. From the Status list, select Inactive.
4. Click Save.
BMC Atrium Core 9.0
Page 963 of 2268
Home
Viewing reconciliation job status, results, and history

Viewing reconciliation job information
Reconciliation event descriptions
Pruning reconciliation job run records
In the Reconciliation Engine UI, select the reconciliation job that is running to see the detailed
statistics about the job runs and the processing instances. The History tab and the Administrative
tab are described below.
History tab
To view the job run details
Administration tab
History tab
The History tab displays all the job runs of the job selected from the list of Reconciliation jobs
available in the left pane. By default the job runs for last 1 week or 7 days are displayed. If you
have a large list of job runs displayed to can change the start date and end date to select lesser
duration. This will help the job run list to load faster. The job run list displays the start time and end
time for that particular job execution.
You can choose to display job runs as per the status given below:
Job runs include the following information, which you can view from the History tab:
Start time Job start time
End time Job end time
Status One of the following values:
Queued The job is waiting to start.
Started The job is currently in progress.
Canceled A user canceled the job before it could finish.
Aborted The Reconciliation Engine process was stopped while the job was
running.
Success The job finished successfully.
Failed The job could not finish and error messages were logged.
Paused The job has been paused and can be resumed. When you select a job,
the following progress information is displayed:
To view the job run details

1. Click on the arrow to expand the job run that is displayed.
The list of activities executed during the job run and the list of events generated are
displayed.
2. Click Activities to view the following information:
Name - Displays the name of the activity
BMC Atrium Core 9.0
Page 964 of 2268
2.
Home
Status - Displays the status of the activity. The in-progress jobs and successfully
completed jobs are displayed in green. Failed jobs or paused jobs are displayed in red
. If you move the mouse pointer over the over the status bar, different statuses are
displayed as explained in the table below.
Status
Description
Total number of records
Displays the total number of records.
Number of records
Displays the total number of processed records.
processed
Number of records failed
Displays the total number of failed records.
Number of records
Displays the total number of successfully processed records.
successful
Last updated time
Displays the time and date with the time zone applied when the last record was
processed.
Start time - Displays the activity execution start time.

End Time - Displays the activity execution end time.
3. On the Events pane the following information is displayed:
Name - Displays the name of the activity carried out and the log file name and
location.
Description - Gives a detailed information of the events listed in the Name column. It
displays the number of records found, modified, or failed to identify. It also displays
the location where the logs are stores.
Administration tab
The Administration tab gives information on the following:
Reconciliation ID
Job assigned to
Job modified by
Date the job was modified
Job created by which user
Date the job was created
The change history of the job.
The Activities pane displays the details of the activities defined in the respective job. The following
details are displayed:
Activity name
Type of activity, for example, merge, execute, identify and so on.
Status of the activity if active or inactive
The sequence in which the activity is run.
The Schedule pane displays the day and time when the job is supposed to run.
BMC Atrium Core 9.0
Page 965 of 2268
Home
Viewing reconciliation job information

You can view the details for a selected job in the Administrative Information tab.
Job ID
Modification information
Creation information
Activities in the job, including name, type, status and sequence
Job schedule
Reconciliation event descriptions

Each run of an Identify, Merge, Copy, Compare, Delete, or Purge activity creates an Information
event to provide statistical results. Each job run also creates an event. This section explains how to
interpret those results.
Activity statistics
Job statistics
Activity statistics
Events pertaining to an activity can contain these headings.
Number of records found: <number> The number of instances found for reconciliation.
This is usually fewer than the total number of instances in the dataset against which the
activity operated, because certain options restrict the number of instances processed. For
example, setting Include Unchanged CIs to No for a Merge activity or setting Identity
Required to Yes for a Copy activity reduces the number of instances processed by the
activity.
For a Merge, Copy, or Compare activity, this number reflects instances in both the source
and target datasets. If an instance exists only in the source dataset before the activity run, it
adds 1 to the number of records found. If it exists with the same reconciliation ID in both
datasets, it adds 2 to this number.
Note
The number of records found includes both CI and relationship instances.
Records created: <number> The number of instances created in the target dataset by a
Merge or Copy activity.
Records modified: <number> The number of instances modified in the target dataset by a
Merge or Copy activity.
Duplicate records not copied: <number> The number of instances that were not copied by
a Copy activity because the Collision Resolution option is set to Display Error.
Number of instances deleted: <number> The number of instances that were deleted by a
Delete or Purge activity.
BMC Atrium Core 9.0
Page 966 of 2268
Home
Comparison Report The report generated by a Compare activity that has no attached
Workflow Execution ruleset. For more information, see Comparing datasets by using the
Reconciliation Engine.
Job statistics
Each job run creates an event with these headings.
Number of log files created: <number> The number of log files written for the job. When
the amount of data logged for a job run exceeds the maximum log file size you specify,
another log file is created. For example, if your maximum log file size is 20 KB and you run a
job that logs 50 KB of data, three log files are written.
Log File Path The absolute path to the directory on the BMC Atrium CMDB server where
the log files were written.
<First>/<Last> Log File Name The name of the first or last log file written for the job run.
Files are named for the job with a numerical suffix. For example, the first run of My Job might
write the log files My Job_1.log and My Job_2.log, and a later run writes My Job_3.log.
Pruning reconciliation job run records

After your reconciliation jobs have run many times, you might not want to view the results of earlier
runs in the History tab any longer.
You can delete these records so that they no longer appear in the History tab.
To delete reconciliation job run records

1. Open the RE:Job_Events form using the direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/RE:Job_Events
3. Click Search to find all records in the form.
4. In the results pane, select the event with records you want to delete.
5. Select Actions > Delete, and then click OK in the confirmation dialog box.
Creating and editing a customized reconciliation job

After you have created a job and defined its schedule, you must create activities and relate them to
the job. These activities run when the job runs. After the job runs, you can view its history.
Recommendations
To create a customized reconciliation job
Related topics
Recommendations
If you are going to include Identify and Merge activities in a job, create a standard job with
the automated defaults. You can then edit and customize the standard job.
BMC Atrium Core 9.0
Page 967 of 2268
Home
Create small jobs, containing the fewest number of activities that must always run together in
a given order. This allows you the flexibility of reusing jobs in different combinations using
any of the methods described in Starting and stopping a reconciliation job .
Do not create jobs that simultaneously identify the same dataset or merge data into the
same target dataset. Simultaneous reconciliation can either overwrite data you wanted to
keep from the other job or create duplicate CI instances.
If you need to create multiple jobs to merge data into the same production dataset, use the Execute
activity to run the jobs sequentially or set the jobs as continuous and run them in parallel with the
Look Into Other Datasets for Parallel Continuous Jobs option selected. For information about
configuring Look Into Other Datasets for Parallel Continuous Jobs option, see Configuring
Reconciliation Engine system parameters.
data.
For a large amount of data, such as an initial load, run separate identify and merge jobs to
allow for better diagnostics.
For incremental updates, run identify and merge activities in one job. For new CIs, the
identify and merge activities are run. For modified CIs, the identify activity runs quickly
because the CIs have reconciliation IDs, and the merge activity runs.
In a standard reconciliation job, the identify and merge activities are run sequentially.
Because of this, the instances start being merged into the target dataset only after all
instances are identified. For a large amount of data, you can create separate identify and
merge jobs and configure the merge job to run in a continuous mode. When the continuous
merge job runs at the specified interval, all identified instances with the
ReconciliationMergeStatus attribute set to Ready to Merge are merged into the target
dataset. This ensures that identified instances can start being merged into the target dataset
while the Identify activity is still running on the remaining unidentified instances.
To create a customized reconciliation job

1. In the Reconciliation console, click Create Job.
To open an existing job, select it and then click Edit Job.
2. For Name, type a short unique name for the job.
The name must be unique, and cannot contain any characters that are not allowed in
filenames for the operating system of your server. For example, on a Windows server your
3. From the Job Status list, select Active. You can later disable the activity by changing this
setting to Inactive.
4. To use the standard identification and precedence rules, select Use standard rules for
participating datasets.
For more information, see Standard reconciliation identification and merge job settings .
5.
BMC Atrium Core 9.0
Page 968 of 2268
Home
5. To identify and merge only CIs that have been successfully normalized, enable Process
normalized CIs only.
The Reconciliation Engine processes CIs with the following status:
Normalized and Approved
Not Applicable For Normalization
Normalized and Not Approved
For more information, see Normalization status.
6. Create activities for the job.
Note
Activities cannot be reused between jobs. If you delete a job, all its activities are
also deleted. Also, when you remove an activity from a job, it is deleted and cannot
be used in other jobs.
7. Create a schedule for the job, or start the job as needed. See Starting and stopping a
reconciliation job.
8. Select Exclude Orphaned weak CIs if you do not want to reconcile weak CIs. This is
applicable for Identification and Merge activities only.
9. Click Save, and then click Close.
Related topics
Matching instances across datasets by using a reconciliation Identify activity
Merging datasets into a reconciled target dataset
Deleting data by using the Reconciliation Engine
Purging soft-deleted data by using the Reconciliation Engine
Comparing datasets by using the Reconciliation Engine
Copying datasets by using the Reconciliation Engine
Renaming datasets by using the Reconciliation Engine
Executing workflow against instances after a reconciliation Compare activity
Ignoring multi-matched CIs during reconciliation

During the identify process when multiple CIs from the BMC.Asset dataset match with a CI in the
source dataset, the reconciliation process is unable to assign a reconciliation ID to such
multi-matched CI in source datasest. As a result these multi-matched CIs remain unidentififed in the
source dataset and are processed in every consequent run of the identification activity; thus
affecting performance. The Ignore MultiMatch feature allows you to mark these multi-matched CIs
so that they can be ignored during the next identify activity.
The IgnoreMultiMatchInstances field on the RE:Job form indicates whether a multi-matched CI
should be ignored in the next Identification Activity run for a Reconciliation Job. The
IgnoreMultiMatchInstances field takes the following values:
BMC Atrium Core 9.0
Page 969 of 2268
Home
Yes Ignores multi-matched CIs in the next identification run

No (Default) Considers multi-matched CIs in the next identification run
When the IgnoreMultiMatchInstances field is set to Yes, the
ReconciliationIdentificationError attribute is modified. The
ReconciliationIdentificationError attribute is an attribute in the BMC_BaseElement and
BMC_BaseRelationship classes. The ReconciliationIdentificationError attribute
indicates whether a CI has been multi-matched.
The ReconciliationIdentificationError attribute can take the following values:
NULL (Default) Indicates that the CI is not multi-matched
Multi-Matched Indicates that the CI is multi-matched
If you modify a multi-matched CI, an internal CMDB workflow resets the
ReconciliationIdentificationError attribute to NULL.
To enable ignore multi-matched CIs during reconciliation

This is a multi-step procedure in which you need follow the sequence given below:
Setting the IgnoreMultiMatchInstances field to active
Clear the cache in the BMC Remedy-Configuraton Tool
Make the changes to your reconciliation jobs to ignore multi matched CIs
Setting the IgnoreMultiMatchInstances field to active

1. Log on to BMC Remedy Developer Studio.
2. Click File > Switch Mode > Base Development .
3. In the AR System Navigator explorer, expand the list and navigate to All Objects folder.
4. Double-click on Forms to open Filtering Options pane on the right.
5. Click on Filtering Options to expand it.
6. Search for the "RE:Job" string in the Display items where field, press enter.
7. In the Name column, locate the RE:Job form, and double-click to open it.
(If required you should select the "Default Admin view" tab to view the
IgnoreMultiMatchInstances field.)
8. In the RE:Job form navigate to the IgnoreMultiMatchInstances field. By default this field is
inactive.
BMC Atrium Core 9.0
Page 970 of 2268
8.
Home
9. To activate the IgnoreMultiMatchInstances field, click this field in the Properties pane on
the right navigate to Display and expand this attribute.
10. For the attribute Visible in the Value column set the value to True.
The IgnoreMultiMatchInstances field is now set to active.
Repeat the above steps to make the Job Name field active.
11. Select File > Save All, and close the BMC Remedy Developer Studio.
Clear the cache in the BMC Remedy-Configuraton Tool

1. Start the BMC Remedy-Configuraton Tool for example, give the URL like this to start the tool
- http://<midTierServer>:<portNumber>/arsys/shared/config/config.jsp
2. Click Cache Settings, then click the Flush Cache button and log out.
3. Close the browser instance.
Make the changes to your reconciliation jobs to ignore multi matched CIs
1. In a new instance of your web browser open the RE:Job form. Use the following syntax in
your browser:http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/RE:
Job.
2. In the Job Information page, give an unqualified search by clicking Search.
Check that the AR Server Configuration allows unqualified searches.
3. Scroll to the bottom of the browser to view the list of jobs.
4. Select the job for which you want to change the *IgnoreMultimatchInstances *setting.
5. Change the IgnoreMultimatchInstances value to Yes to turn on the feature for the job and
No to turn off the feature.
Yes Ignores multi-matched CIs in the next identification run
No Considers multi-matched CIs in the next identification run
6. Click Save to save the changes.
Repeat step 4 to 6 for other job(s).
BMC Atrium Core 9.0
Page 971 of 2268
Home
Reverse the changes made to activate the IgnoreMultiMatchInstances feature

After you complete making changes to all your reconciliation jobs to ignore multi matched CIs, you
should inactivate the IgnoreMultiMatchInstances feature.
1. Change the IgnoreMultiMatchInstances field to inactive
2. Change the Job Name field to inactive.
3. Clear the cache in the BMC Remedy-Configuraton Tool
Enabling the progress bar display for reconciliation Identification and Merge jobs
For a continuous Identification and Merge job, the progress bar indicating the status of the job is
disabled by default. For a batch Identification and Merge job, the progress bar remains enabled by
default.
Before executing the batch Identification and Merge jobs, BMC recommends that you can disable
the progress bar. Disabling the progress bar enhances the performance of the job.
You can choose to display (enable) or hide (disable) the progress bar for reconciliation jobs. By
default the Disable Progress Bar in UI during Job Execution check box is selected for all user
created reconciliation jobs. This hides (disables) the progress bar that shows the progress of the
For Continuous Identification and Merge jobs this option is permanently disabled and you cannot
enable the progress bar. For OOTB (Out Of The Box) jobs the progress bar is displayed (enabled)
by default, you can choose to hide (disable) the progress bar.
Before executing the batch Identification and Merge jobs, BMC recommends that you keep the
progress bar disabled. Disabling the progress bar enhances the performance of the job.
Note
The progress bar functionality available through the Launch Legacy Reconciliation
Console icon disables the progress bar by default for a continuous Identification and
Merge job. The progress bar remains enabled by default for a batch Identification and
Merge job.
To enable or disable a progress bar

1. In the Reconciliation Engine, click the Job Editor icon.
a. In the Job Editor screen, select the Disable Progress Bar in UI during Job
Execution checkbox to hide (disable) the progress bar for the given reconciliation job.
b. In the Job Editor screen, clear the Disable Progress Bar in UI during Job
Execution checkbox to display (enable) the progress bar for the given reconciliation
job.
2.
BMC Atrium Core 9.0
Page 972 of 2268
Home
2. Click Save.
Monitoring reconciliation jobs using the Fail safe feature

The Fail safe feature in the reconciliation engine monitors the progress of all the running jobs (
scheduled/ continuous / non continuous). When it comes across a non-responding job, it
automatically restarts the job.
For the non-continuous jobs, this feature stops the current run and starts a new run. For continuous
jobs, it stops the current run and lets the next run start when the continuous interval of that job has
elapsed.
For example, if the job idle time is configured to 60 minutes; the Fail safe feature monitors all the
jobs after every 60 minutes. If the Fail safe feature detects a job that is not responding (not
processing a CI) for more than 60 minutes, it restarts the non-responding job.
This feature logs all the traces in the arrecond.log file. Locate the log file if you have configured it
to reside in a particular directory. Usually, this log file resides in the installation directory. For
example, \Program Files\BMC Software\AtriumCore\Logs.
You should consider the following while working with the Fail safe feature:
The time interval for which a job can remain idle is configurable.
The configured time interval is in minutes.
The default job idle time is 60 minutes.
The job idle time can be specified in the range between 60 to 720 minutes.
To configure the above settings, use the configuration options provided in Server Configuration.
From Service Pack 1 onward, this feature is available only when you configure a value for the Job
Idle Time (Minutes) parameter.
Performing reconciliation jobs health check

The Reconciliation Engine Health Checker utility enables you to verify the status of the
reconciliation jobs that are run during a specific duration. The Reconciliation Engine Health
Checker utility captures the details of all the failed reconciliation jobs during the specified duration
and generates a healthcheck.csv report. The report contains the following details of the failed jobs
:
Job name
Job run instance ID
Start time
End time
Job run status
Processing rate, in case of running jobs
BMC Atrium Core 9.0
Page 973 of 2268
Home
Following is a sample snippet of health check report:

<Need snippet from Neelam >
To run the Reconciliation Engine Health Checker utility
Note
The Reconciliation Engine Health Checker utility usage is supported only with local BMC
1. Open the command prompt, on the computer where you have installed BMC Atrium Core.
2. Go the BMC Atrium Core installation directory and open the Reconciliation Engine Health
Checker utility.
The Reconciliation Engine Health Checker utility is available at the following location:
On Windows:
<install directory>\BMC Software\AtriumCore\atriumcore\
healthcheckerutility.bat
On UNIX:
<install directory>/BMC Software/AtriumCore/atriumcore/healthcheckerutility.sh
3. (Optional) Update the duration.
a. Open the Reconciliation Engine Health Checker utility using Notepad.
b. Update the -d parameter that specifies the duration in minutes. Default value is 60
minutes.
c. Save the file.
4. Run the Reconciliation Engine Health Checker utility.
<There could be some additional steps here depending on how the utility is delivered: Need
inputs from Neelam.>
5. The healthcheck.csv report is generated at the following location:
On Windows:
<install directory>\BMC Software\AtriumCore\atriumcore\healthcheck.csv
On UNIX:
<install directory>/BMC Software/AtriumCore/atriumcore/healthcheck.csv
Reconciliation Identify and Merge activities

Each reconciliation job must have at least one activity. Each activity has components that must be
defined. The following topics provide information and instructions for these activities:
Using Qualification Sets in reconciliation activities
Building a qualification for a reconciliation activity
BMC Atrium Core 9.0
Page 974 of 2268
Home
Using Qualification Sets in reconciliation activities

In each type of activity, you have the option of using a Qualification Set, which is a set of
qualifications that restrict the instances participating in a reconciliation activity. An instance that
meets one or more of the qualifications in the set participates in an activity where that set is used.
Multiple activities can use the same Qualification Set.
To create or modify a Qualification Set
To use an existing Qualification Set
Recommendation
To validate reconciliation jobs with a small amount of data, use qualifications to restrict the
CIs that are used in the activity.
For example, in the BMC.IMPORT.BL dataset, Calbro has thousands of CIs, but they do
not want to reconcile all of them to validate their reconciliation jobs. Instead, Calbro
restricts the CIs to a instances of different classes.
For BMC_ComputerSystem, Calbro administrator staff uses the Qualification
Builder to restrict the CIs to those with the VirtualSytemType attribute set to
VMware. Because they are tracking virtual machines for the first time, they want to
include these CIs in testing reconciliation.
To test dependencies, the Calbro staff also includes qualified instances of
BMC_SoftwareServer, where the Model attribute is Weblogic, because some
instances of Weblogic are installed on VMWare virtual machines.
To create or modify a Qualification Set

1. From the Activities area in the Job Editor, click New, or select an existing activity and click
Edit Activity.
2. Clear the Use all classes and instances check box in the Qualification area.
3. Click New/Edit Qualification Set.
4. Enter the following required information:
a. In the Set field, enter the name of the Qualification Set.
b. From the Namespace list, select a namespace.
For more information, see Dynamic dataset and qualification values in event-driven
5. In the Qualifications area, click Add Rule, or select an existing set and click Edit Rule.
6. For Name, enter the name of the qualification.
7. (Optional ) For Description, enter a description of the qualification.
8.
BMC Atrium Core 9.0
Page 975 of 2268
Home
8. From the Status list, select Active.

You can later disable the activity by changing this to Inactive.
9. From the Class list, select the name of the class for which the qualification returns instances
.
10. If you want the qualification to return CIs based on attribute values in related child CIs, select
a class name from the Related Child Class list.
When you select a related child class, the qualification uses the attributes of a child CI to
return a source CI. For example, if your Class Name is BMC_ComputerSystem, you might
specify BMC_DiskDrive in the Related Child Class field. This enables you to match
computer systems based not on their own attributes, but on the size of their disk drives.
A referring class qualification only matches when the instance of the class in the Related
Child Class field is the child member of a relationship to the instance of the Class field. It
does not match when the Related Child Class instance is the source.
11. In the Qualification field, type your qualification or click Build Qualification to build it
interactively.
For more information, see Building a qualification for a reconciliation activity .
12. Click Done, and then click Save.
To use an existing Qualification Set

Edit Activity.
3. From the Qualification Set list, select an existing Qualification Set.
4. Click Done, and then click Save.
Building a qualification for a reconciliation activity

You can use the Qualification Builder to build qualifications interactively instead of typing them. It is
accessible from any window in the Reconciliation console that has a Qualification field and works
similarly to the Advanced Search Bar in BMC Remedy AR System.
Qualification conventions for reconciliation activities
Creating qualifications for reconciliation activities
Qualification conventions for reconciliation activities

When building qualifications, the easiest way is to select the fields, keywords, and values from the
Qualification Builder. You can also create the qualification manually. If you select this option,
observe the following conventions.
For more information about keyword definitions, relational operators, and advanced search bar
conventions, see Building qualifications and expressions in the BMC Remedy Action Request
System online documentation.
BMC Atrium Core 9.0
Page 976 of 2268
Home
Enclose attribute names in single quotation marks.

Enclose nonnumeric values (including time, selection, and currency values) in double
quotation marks.
Example: 'VirtualSystemType' = "VMWare"
In the current (source) dataset, this qualification finds all instances of
BMC_ComputerSystem where the VirtualSystemType attribute has a value of VMWare.
For currency fields, you must enclose one of the following items in single quotation marks:
The name or ID of the currency field.
Example: 'Currency Field' = $NULL$
The name of the currency field, followed by a period, followed by a specific portion of
the currency field's value.
Example: 'Currency Field.VALUE' < 5000
Use keywords anywhere that you can enter character values. The most commonly used
keywords are $DATE$, $NULL$, $TIME$, $TIMESTAMP$, $USER$, and $WEEKDAY$.
Note
Keywords are case-sensitive. Use only UPPERCASE.
To restrict a reconciliation activity to a particular CI class, you must include the following
qualification rules:
Namespace
Class
Qualification
If the class is a CI
BMC.CORE
BMC_BaseElement
$ClassId$ = "<CLASSNAME>"
If the class is a relationship

BMC.CORE
$ClassId$
= "<CLASSNAME>"
Where <CLASSNAME> is the class to which you want to restrict the reconciliation activity to.
After creating a qualification for a field in a given class, the CIs are restricted within that class
and all other classes are merged indiscriminately. For example, the following qualification
restricts only CIs with the BMC_ComputerSystems class. All other classes are processed
as a normal reconciliation job.
BMC Atrium Core 9.0
Page 977 of 2268
Home
Namespace
Class
Qualification
BMC.CORE
BMC_ComputerSystems
$EnvironmentSpecification$ = "ASTAttribute"
Creating qualifications for reconciliation activities

You can create a qualification to limit instances that a reconciliation activity processes.
To create a qualification
Edit Activity.
3. Click the ... button.
4. Select a set from the Set List.
5. In the Qualifications area, click Add Rule, or select an existing rule and click Edit Rule.
6. From the New/Edit Rule area, click Build Qualification.
7. In the Attribute list, select a class attribute, and click From Current Dataset.
8. To add an operator, place your cursor in the expression, and click the appropriate operator.
9. To select a value to use, select an attribute from the Attribute list, and click From Target
Dataset.
10. To add a keyword, double-click the appropriate item in the Keyword list.
11. To change the qualification manually, click Allow Manual Edit, and modify the expression.
12. Click Save.

the following topics provide information and instructions for matching instances across datasets by
using a reconciliation identity activitiy:
Reconciliation Identify activity overview
Creating a reconciliation Identify activity
Creating an Identification ruleset for reconciliation
Relating datasets and Identification rulesets for reconciliation
Manually identifying data by using the Reconciliation console
You create an Identify activity to establish a common identity for instances in two or more datasets,
confirming that they are the same real-life configuration item (CI).
The identity is stored as the ReconciliationIdentity attribute in each instance.
The identity of an instance in the production dataset for that activity is copied to matching instances
in the other datasets. The production dataset is typically the same dataset that is the target of your
Merge activities. If you plan to use independent Merge activities to merge each of your source
BMC Atrium Core 9.0
Page 978 of 2268
Home
datasets into the target, also use independent Identify activities, each of which identifies one
dataset against that target.
An Identify activity assigns identity to an instance according to one of the following scenarios:
If one or more instances match an instance in the production dataset that already has an
identity, that identity is applied to the other instances.
If one or more instances match an instance in the production dataset that does not already
have an identity, the Reconciliation Engine automatically generates an identity and applies it
to the matching instances in the other datasets, and can optionally also apply it to the
instance in the production dataset.
If an instance does not match any instance in the production dataset and its own dataset is
marked for automatic identification, the Reconciliation Engine automatically generates an
identity for the instance.
If an instance does not match any instance in the production dataset and its own dataset is
not marked for automatic identification, the instance remains unidentified.
Unidentified instances cannot participate in Merge or Compare activities, so you should manually
identify them. For information and procedures, see Manually identifying data by using the
Reconciliation console.
Reconciliation Identify activity overview

To add an Identify activity to a reconciliation job, follow the process outlined in the following steps.
Each step represents a procedure. In the sections that relate to this process, the graphic is
repeated, and the related step is highlighted.
1. Create a job to hold the Identify activity, if no job exists. See Creating and editing a
customized reconciliation job.
2. Create an Identify activity which stores the rules and datasets for identification. See Creating
a reconciliation Identify activity
Note
Activities cannot be reused between jobs. If you delete a custom job, all its
activities are also deleted. If you delete a a standard job, all its activities and
identification and precedence rulesets are also deleted.
3. Create Identification rulesets, each of which has rules that match instances between two
datasets. See Creating an Identification ruleset for reconciliation.
4. Select the datasets to identify. See Relating datasets and Identification rulesets for
reconciliation.
5.
BMC Atrium Core 9.0
Page 979 of 2268
Home
5. (Optional ) Select or create a Qualification set to define which instances participate in the
activity. See Using Qualification Sets in reconciliation activities .
Creating a reconciliation Identify activity

An Identify activity identifies CIs in one or more datasets based on the Identification rulesets
contained in it.
Identify activities connect an Identification ruleset with an import dataset. This enables the qualified
CIs to be identified by searching for matching attribute values in the dataset defined in each
identification rule.
Before you begin
To create a reconciliation Identify activity
Recommendations
Consider indexing attributes used in identification rules. Consult your DBA to

determine what indexes would help you.
After your initial data load into BMC.ASSET, perform an Identify activity on the data
, selecting the Generate IDs option to assign unique Reconciliation IDs to
production dataset instances with an ID of 0. This makes sure that your production
data has an identity the first time it is identified against another dataset.
Before you begin

Check whether you can use a Standard Job.
Make sure identifying attributes are defined as keys so the database can find CIs quickly in
the Identify activity.
Make sure all Identification attributes are non-NULL and unique as much as possible before
running a reconciliation job.
To create a reconciliation Identify activity

1. In the Reconciliation console, click Create Job or open an existing reconciliation job. See
Creating and editing a customized reconciliation job .
2. In the Activities area, click New to define a new Identify activity.
3. For Type, select Identify.
4. Complete the following fields:
Name
following characters: \ / : * ? " < > |.
Namespace
BMC Atrium Core 9.0
Page 980 of 2268
Home
Select a namespace using the controls with the Namespace field. Only classes in the selected
namespaces can participate in the activity. For more information, see Dynamic dataset and qualification
values in event-driven reconciliation jobs.
Status
Select Active. You can later disable the activity by changing this to Inactive.
Continue on
Error
Define whether the job continues if the activity has an error.

Checked A job containing this activity continues to run if an error occurs in this activity.
Unchecked A job containing this activity terminates if an error occurs in this activity
Sequence
Specify in what order you want this activity to run relative to other activities in a job. For example, if this
activity has a value of 2 it runs before an activity with a value of 3. The sequence can be 0 to 1000,
inclusive.
Use all
classes and
instances
Select to run an unqualified Identify activity so that all classes and instances are included. To restrict the
classes and instances, remove the check.
Qualification
Set
Select a qualification that restricts the classes and instances used in the activity.
If Use all classes and instances is unchecked, select from the Qualification Set list.
To create a Qualification Set, click New. For more information, see Using Qualification Sets in
reconciliation activities.
Production
Select the dataset to use with the Generate IDs feature. This setting does not affect the Identify Against
Dataset
dataset selected in the Identification rules.
Generate
IDs
For the selected Production Dataset, define how to handle any instances that have not been identified (or
have a Reconciliation ID of 0).
Checked Unidentified instances in the selected Product Dataset are assigned a nonzero
Reconciliation ID.
Unchecked Unidentified instances in the selected Product Dataset are not assigned a nonzero
Reconciliation ID. These instances retain a Reconciliation ID of 0.
Exclude
Subclasses
Defines whether to use explicit Identification rulesets for each class.

Yes Requires that an Identification ruleset be specified for every class and subclass.
No Applies the Identification ruleset for a class to all of its subclasses. You can still specify individual
rulesets for any class.
5. If you did not select Use standard rules for participating datasets for the job, create an
Identification ruleset. To create a ruleset, see Creating an Identification ruleset for
reconciliation.
6. If you selected Use standard rules for participating datasets, you do not need to create an
Identification ruleset. For more information, see Standard identification and precedence rules
for reconciliation jobs.
7. To select a source dataset and, if applicable, relate it to an Identification ruleset, click Add
Dataset Identification Group Association. For more information, see Relating datasets
and Identification rulesets for reconciliation.
8. To save the activity, click Done.
BMC Atrium Core 9.0
Page 981 of 2268
Home
Creating an Identification ruleset for reconciliation

An Identification ruleset is a set of prioritized rules that define how CI instances in different datasets
are identified as the same entity, such as comparing serial numbers and product names.
Each Identification ruleset applies its rules to specific classes. Unless an activity using the ruleset
has its Exclude Subclasses selected, the ruleset also applies to subclasses of the specified class,
so you can use inheritance to minimize the number of Identification rulesets you create.
The rules are executed according to an Execution value, where the lowest execution-order rule is
processed first. After an instance is identified, the remaining rules in the ruleset are not processed.
An Identification ruleset is paired with a particular dataset in an Identify activity. It uses a sequence
of rules to identify instances from that dataset against those from other datasets in a particular
order.
Before you begin
To create an Identification ruleset
Note
In an Identify activity, each participating dataset except the production dataset must be
paired with an Identification ruleset. If the activity involves three or more datasets,
including the master dataset, each dataset's Identification ruleset must include
Identification rules comparing it to all the other datasets. Without these rules, a job that
includes this activity will not run.
For instance, in an Identify activity involving datasets BMC Atrium Explorer, BMC Sample,
and BMC Asset where BMC Asset is the master, the Identification ruleset paired with
dataset BMC Atrium Explorer must have a rule that identifies its instances against BMC
Asset first and then BMC Sample, and the ruleset paired with BMC Sample must have a
rule identifying against BMC Asset first and then against BMC Atrium Explorer.
BMC Atrium Core 9.0
Page 982 of 2268
Home
Recommendations
Use the highest class level possible to take advantage of inheritance and to use the
Identification ruleset with multiple classes.
Always put the most specific identification rules first in the Identification ruleset
execution order, so the best match is identified first.
After the production dataset is initially populated, set Generate IDs to No in the
dataset and Identification ruleset entry. This helps prevent duplicate records by
requiring a BMC Atrium CMDB administrator to manually identify new configuration
items.
You can use multiple Identification rulesets in an Identify activity to identify multiple
classes in one reconciliation job.
Regularly review your identification rules to make sure they are still appropriate for
your environment and spot check instances to confirm that they are being identified
properly.
Consider indexing attributes used in identification rules. Consult your DBA to
determine what indexes would help you.
BMC Atrium Core 9.0
Page 983 of 2268
Home
The standard identification rules use the following guidelines for identifying physical
and virtual servers. If you create identification rules, consider these attributes to
distinguish between physical and virtual servers and to uniquely identify each. You
can use the standard rules as a guide to creating custom identification rules for
servers.
For physical servers, BMC recommends that data providers populate the
TokenID attribute with a concatenation of the host name and domain name.
For virtual servers, BMC recommends that data providers set the following
attributes:
Set Name to the name of the virtual machine.
Set isVirtual to Yes.
Set TokenID to <prefix>:<uniqueID>, which is a concatenation of the virtual
machine prefix and unique ID.
Typically, virtual machines have a unique identifier, which does not change
when the virtual machine is moved to a new host. For example, the
TokenID for a VMware virtual machine is VI-UUID:123456789.
Before you begin

Plan how many rules are needed in what order.
Know what dataset to use as reference in each rule.
To create an Identification ruleset, clear the Use standard rules for participating datasets
option for the job. Otherwise, your Identify activity uses the standard rules. See Standard
reconciliation identification and merge job settings.
To create an Identification ruleset

1. In the Activities area, click New.
2. For Type, select Identify.
3. Click New/Edit Identification Ruleset to define identification rules.
If you selected Use standard rules for participating datasets for the job, Create Identification
Ruleset is not available.
4. Enter the following required information.
Field
Description
Set
The name of the ruleset.
Class
From the appropriate namespace, select the namespace and class to identify.
BMC Atrium Core 9.0
Page 984 of 2268
Home
Field
Description
Namespace
The namespace is selected with the class. Only classes in the selected namespaces can participate in the
activity.
For more information, see Dynamic dataset and qualification values in event-driven reconciliation jobs.
5. Click Add Rule.

You need one Identification Rule for each dataset against which you want to identify the
dataset this ruleset is paired with.
6. Enter the following required information:
Field
Description
Identify
Select the dataset where you want to find a match. This is often the production dataset, such as
Against
BMC.ASSET.
Execution
Order
Select or type a number to identify this rule's position in the ruleset execution order (0 to 1000).
All rules in the ruleset are processed according to this order.
Namespace
Use the same Namespace that you specified for the Identification ruleset.
Class
Use the same class that you specified for the Identification ruleset.
Qualification
Type the criteria that match the class between datasets, or click Build Qualification to create the criteria
with a tool.
Use dollar signs ($) to enclose attribute names from the dataset that is paired with this Identification
ruleset in an Identify activity, and use single quotes (') to enclose attribute names from the dataset in the
Find in Dataset field.
Example: 'IP Address' = $IP Address$,
The example qualification identifies instances of the class when they share the same IP address.
7. Click OK.
8. In the Set Editor, click Save.
Relating datasets and Identification rulesets for reconciliation

After you define how to identify instances with identification rules, you must select the dataset to
identify.
To assign an Identification ruleset to a dataset

1. In the New Activity area, click Add Dataset Identification Group Association to relate a
dataset with an Identification ruleset.
2. From the Dataset list, select a dataset to identify.
This is a source dataset that has CI instances that need to be identified against a master, or
production dataset. If the desired dataset is not available, see Creating datasets in the
3.
BMC Atrium Core 9.0
Page 985 of 2268
Home
3. From the Identification Ruleset list, select the Identification ruleset that contains the rules
for identifying the dataset's data.
The Identification rulesets are listed by the class that was selected when the ruleset was
created.
4. If you want instances from the dataset paired with the ruleset to be assigned an
automatically generated identity when the source dataset does not already have an identity,
select the Generate IDs check box next to the Identification ruleset.
For example, if you set Generate IDs to No on an Identification ruleset defined for
BMC_ComputerSystem, BMC_DiskDrive CIs and other component CIs that are
destinations of a weak relationship with the computer system do not get automatically
generated identities.
5. Click Save.
You have added an Identify activity to a reconciliation job, which you can now run and
monitor.
For more information about starting jobs, see Starting and stopping a reconciliation
job.
For more information about monitoring jobs, see Viewing reconciliation job status,
results, and history.
Manually identifying data by using the Reconciliation console

You can manually identify instances if the Reconciliation Engine cannot find a match for an object
instance after applying all the identification rules, or if the instance is part of an Identification ruleset
that you did not specify to be auto-identified.
To manually identify instances

1. In the Reconciliation console, click Manual Identification.
2. In the Unidentified Instances table, select the instance you want to identify.
3. In the Identified Instances table, select the instance to supply an identity for the unidentified
instance.
4. Click Apply Identification.

The following topics provide instructions for merging data into a reconciled target dataset:
Independent reconciliation Merge activities and AttributeDataSourceList
Handling NULL values in reconciliation Merge activities
Overview of the Reconciliation Merge process
Creating a reconciliation Merge activity
Defining a Precedence Association Set for reconciliation Merge activities
BMC Atrium Core 9.0
Page 986 of 2268
Home
After you have identified your data, you can merge it from one or more source datasets into one
target dataset to create a reconciled view of that data.
Using the standard or custom precedence rules, you set a precedence value for each dataset that
participates in the merge, including the target, and then create individual values for any classes or
attributes in those datasets that should be higher or lower. These precedence values determine
which dataset, including the target if needed, supplies the data that is written to the target dataset
for each class and attribute.
Only instances that have reconciliation identities and for which the
ReconciliationMergeStatus attribute is set to Ready to Merge can participate in a merge. For
more information about identification, see Matching instances across datasets by using a
reconciliation Identify activity. After an instance is merged into the target dataset, the
ReconciliationMergeStatus attribute is set to Merge Done.
Independent reconciliation Merge activities and AttributeDataSourceList

Though you can merge multiple datasets at once, you also have the flexibility of using separate
Merge activities to achieve a merge between multiple datasets.
Each Merge activity writes an extra attribute named AttributeDataSourceList to each
instance in the target dataset. This attribute lists each other attribute of the class and the source
dataset that supplied its value.
The next Merge activity that uses the same target dataset compares its source dataset with the
highest precedence value for an attribute against the dataset that provided the value currently in
the target dataset. If the latter's precedence value is higher, no value is written for that attribute.
This allows several vendors to separately install reconciliation definitions for their products, such as
discovery applications, that provide data to the BMC Atrium CMDB. None of them need to know
which other products are present or create a Merge activity that includes them all. Each
Precedence Association set and Merge activity can operate independently, because their
precedence value for any given attribute is weighed against the highest precedence value that
supplied data to the target dataset.
For a comparison of using a single Merge activity versus independent Merge activities, see Using a
single Merge activity and Using independent Merge activities.
Note
BMC Atrium Core 9.0
Page 987 of 2268
Home
When a Merge activity compares the precedence value for an attribute in a source dataset
against the precedence value for the dataset that last supplied the attribute to the target
dataset, that target precedence value is taken from the Precedence Association set
selected for the Merge activity. Whichever Precedence Association is paired with the "
stored" source dataset in that Precedence Association set supplies the precedence value
for the attribute.
Handling NULL values in reconciliation Merge activities

The Defer if Null option, which you can set both for a Precedence Association set and for class
and attribute precedences within that set, determines whether a NULL value in the
highest-precedence source dataset should be merged to the target dataset.
Both settings for this option have benefits and pitfalls.
Defer if Null = "Yes"

This means a NULL value is ignored and the Reconciliation Engine uses the highest-precedence
non-NULL value it finds for that attribute. This ensures that even if only one of your discovery
applications finds a particular value, that value is merged to your target dataset regardless of the
precedence value of the source that provided it.
On the negative side, it prevents you from intentionally setting values to NULL in the target dataset,
which is necessary for the MarkAsDeleted attribute. BMC products set MarkAsDeleted to either
"Yes" or NULL. Therefore, after an instance has been marked as deleted in your target dataset, any
source dataset with Defer if Null set to "Yes" cannot unmark it as deleted in the target. Their NULL
value is ignored by a Merge activity.
Note
Though you cannot merge a NULL value, you can work around this in character attributes
by using blanks. This visually clears an existing value from an attribute, but can cause
confusion if you are using that attribute in Identification rules or performing Compare
activities. Blanks also cannot be used in the MarkAsDeleted attribute because it is a
selection, not character, attribute.
Defer if Null = "No"

This means the source dataset with the highest precedence value for an attribute merges its
attribute value to the target dataset, even if that value is NULL. This allows you to intentionally set a
NULL value in the target dataset, and therefore is useful with the MarkAsDeleted attribute.
On the negative side, if your highest-precedence dataset has this option, any NULL values created
by that dataset can never be overwritten, which can cause valuable data to sit in other source
BMC Atrium Core 9.0
Page 988 of 2268
Home
datasets unseen while your target dataset has the same instances populated with NULL values.
This is the case with the BMC.ASSET.SANDBOX dataset that ships with BMC Remedy Asset
Management. It has a precedence value higher than the datasets for other BMC products to allow
changes made in the BMC Remedy Asset Management interface to be merged to the BMC.ASSET
dataset. But if someone manually creates a CI using BMC Remedy Asset Management and leaves
most fields empty, then after reconciliation merges the CI to BMC Asset before non-NULL values
are available for it in another dataset, those NULL values can only be removed from BMC.ASSET
by manually editing the CI again.
Overview of the Reconciliation Merge process

To add a Merge activity to a reconciliation job, follow the process outlined in the following steps.
Each step represents a procedure.
1. Create a Merge activity and select source and production sets to merge. See Creating a
reconciliation Merge activity.
Note
Activities cannot be reused between jobs. If you delete a job, all its activities are
also deleted.
2. Create Precedence Association Sets, which have the following parts.

Define precedence values for a dataset and its classes and attributes. See Creating a
Precedence set for reconciliation Merge activities.
Assign a Precedence set to each dataset participating in the Merge activity. See
Creating a Precedence Association for reconciliation Merge activities .
3. (Optional ) Create a Qualification set to define which instances participate in the Merge
activity. See Using Qualification Sets in reconciliation activities .
Creating a reconciliation Merge activity

A Merge activity merges identified CIs in a source datasets into a single set of CI data, typically the
production dataset or an intermediate dataset.
Before you begin
To create a reconciliation Merge activity
Important
Do not merge one source dataset into more than one target dataset. To merge to two
target datasets, create two merge activities--one to merge the source dataset to an
intermediate target dataset and then a second job to merge the first target dataset into
another target dataset, such as BMC.ASSET.
BMC Atrium Core 9.0
Page 989 of 2268
Home
Recommendations
To avoid redundant processing, make all Merge activities incremental by clearing

the Include Unchanged CIs option.
Use only one source dataset for each Merge activity, and pair the Identify and
Merge activities for each source dataset in the job. For example, identify and merge
dataset 1, then identify and merge dataset 2, and so on. This ensures that
attributes required for Identify activities are merged into the target dataset in the
right order.
Instead of merging multiple discovery sources directly into your production dataset,
merge them into a "consolidated discovery" dataset first. You can compare this
against your production dataset, and use the results to generate change requests
or exception reports for any discrepancies.
Before you begin

Check whether you can use a Standard Job.
Make sure the Production Dataset has no orphan components, such as BMC_Processor
CIs all named CPU0 with no host computer system to qualify them. Otherwise, the
reconciliation job has poor performance because the orphan components are returned in
one query result when trying to identify each component CI.
To create a reconciliation Merge activity

1. In the Reconciliation console, click Create Job or open an existing reconciliation job.
Tip
Create and edit a Standard Job so that you can take advantage of the standard
rules as much as possible. For more about Standard Jobs and their defaults, see
Standard identification and precedence rules for reconciliation jobs .
See Creating and editing a customized reconciliation job .

2. In the Activities area, click New to define a new Merge activity.
3. For Type, select Merge.
Field
Description
Name
BMC Atrium Core 9.0
Page 990 of 2268
4.
Home
Field
Description
Namespace
Status
Continue on
Error
Unchecked A job containing this activity terminates if an error occurs in this activity.
Sequence
inclusive.
Qualification
Select a qualification that restricts the classes and instances used in the activity. If the Use all classes
and instances is unchecked, select from the Qualification Set list.
To create a Qualification Set, click New/Edit Qualification Set. For more information, see Using
Qualification Sets in reconciliation activities.
Name
5. Define the datasets that are part of the data merge.

a. From the Dataset list of the New Activity, select a source dataset for the merge.
b. From the Target Dataset list, select the dataset into which to merge the data.
6. If you did not select Use standard rules for participating datasets for the job, select a
Precedence Association Set.
To create a set, see Defining a Precedence Association Set for reconciliation Merge
activities
If you use the Standard Rules, you do not need to create a Precedence Association Set. For
more information, see Standard identification and precedence rules for reconciliation jobs .
7. In the Additional Parameter area, select the status for Include Unchanged CIs.
Checked Merge all attributes even if their value has not changed in the source
dataset since the last time this Merge activity ran.
Unchecked Merge only the attributes that changed value in the source dataset
since the last run and instances that were created in the source dataset since the last
run. To improve performance, you should usually select this option. It is also known
as incremental merge.
Note
BMC Atrium Core 9.0
Page 991 of 2268
Home
Use the IncludeUnchangedCI option only if the changed and unchanged

CIs need to be processed for Merge. Using this functionality makes the
Pause and Resume functionality ineffective. Also, when you run the ID and
merge jobs in parallel, Merge picks up all the CIs in all continuous runs thus,
impacting the performance.
8. From the Merge Order list, select one of the following options:
Field
Description
By class in
Merges only the instances specified by the attached Qualification Set (default option).
separate
transactions
Related CIs
in separate
transactions
Merges instances specified by the attached Qualification Set, destination CIs in weak relationships with
those instances, and the relationships themselves. This option treats composite objects as one entity. For
example, if your Qualification set selects a computer system instance, it and its components would all be
merged. The individual CIs and relationships are merged in separate database transactions.
Related CIs
in one
transaction
Merges composite objects as one database transaction. If an error occurs with any instance in a
composite object, all instances in that object are rolled back. This option provides maximum data integrity
in the event of an error, but takes much longer to complete than Related CIs in separate transactions.
9. Save the activity.

10. Save the job.
When you have added activities to a job, you can execute the job manually or with a
schedule. See Starting and stopping a reconciliation job .
Defining a Precedence Association Set for reconciliation Merge activities

To merge instances that have been identified as matches, you must use a Precedence Association
set.
Creating a Precedence Association Set for a reconciliation Merge activity
To edit or view existing Precedence association set
To delete existing Precedence association set
A Precedence Association set has the following parts:
Precedence Set Defines precedence values at the dataset, class, and attribute levels.
Precedence Sets can be used with multiple datasets. For more information, see Creating a
Precedence set for reconciliation Merge activities.
Precedence Association Links a source dataset with a Precedence Set. For more
information, see Creating a Precedence Association for reconciliation Merge activities .
Before you begin
BMC Atrium Core 9.0
Page 992 of 2268
Home
Before creating a Precedence Association set, check if you can use the Standard
identification and precedence rules for reconciliation jobs shipped with the product.
To fill out the Job Editor window options see, Creating and editing a customized
reconciliation job. After completing the steps given in that topic, move to the procedure
described below.
Creating a Precedence Association Set for a reconciliation Merge activity

New Precedence Set
1. In the Precedence area for a new precedence association, click on the New Precedence
Association Set icon
.
2. The New Precedence Association Set window displays a popup that has a list of available
datasets from which you can choose to create a Precedence Association set. Select the
datasets that you want and click apply.
Earlier, if you have selected the Source Datasets and Target Datasets in the Dataset
Configuration area in the New Activity window, those datasets are pre-populated in
the New Precedence Association Set window.
3. In the name field add the name you would like to give this Precedence Association set.
4. Click the Show All classes and attributes icon to get a complete list of classes and attributes
available across all namespaces.
5. Double click in the cell where you want to enter the precedence value for the related class or
attribute of the dataset.
6. Move the inline slider to select the precedence value that you require. Alternatively, you can
also type in the value and press enter to confirm.
7.
BMC Atrium Core 9.0
Page 993 of 2268
Home
7. To enter more details such as Defer if Null, Append To Lists, or Active; click the arrow at the
right corner to display these checkboxes.
These Options are described in detail in the table below.
Defer If Null
Define how to handle empty, or NULL, attributes in the dataset associated with the Precedence Set. The
Defer if Null setting at the Precedence set level is overridden by the same setting in any Precedences
defined for the set.
Checked If the value of an attribute in this dataset is NULL and this precedence value is the highest,
defer to the dataset with the next highest precedence value. Do not write NULL to the production dataset
.
Unchecked Apply the precedence value for this dataset regardless of whether an attribute value is
NULL.
Append to
Lists
Set whether list values from all source datasets are appended to list-formatted Character attributes in the
production dataset. Duplicate entries are not appended to the list. A list-formatted attribute is a Character
attribute that is intended to hold a list of values according to a specified format. The Append to Lists
setting at the Precedence set level is overridden by the same setting in any Precedences defined for the
set.
Checked If this Precedence set has the highest precedence value for a list-formatted Character
attribute in a Merge activity, the list values from all source datasets are appended to the list in the target
dataset. If some other set has the highest precedence value for the attribute, the Append to Lists option
for that set determines whether values are appended.
Unchecked If this Precedence set has the highest precedence value for a list-formatted Character
attribute in a Merge activity, the list values from the source dataset paired with this set overwrite the list
in the production dataset.
Active
Specifies the status of the activity for class or attribute.
Require
This option appears at the dataset precedence level. You can specify whether to define precedences for
all classes or attributes. Select this option to require explicit Precedence entries for classes and
attributes. You must add precedence rules for the classes and attributes. Clear this option to apply this
Precedence set to all classes and attributes for which a Precedence is not defined.
Explicit
Precedences
8. Click Save to save the newly created precedence set.

The Dataset Order pane gives you a list of datasets in the order of precedences in ascending order.
To edit or view existing Precedence association set

1. In the Precedence area to edit or view a precedence association click on the View/Edit
Precedence Association Set
icon.
2. The Precedence Association Set window displays a list of datasets present in the
precedence set.
If you want to edit the Precedence Association Set, carry out steps 4 to 8 described above.
BMC Atrium Core 9.0
Page 994 of 2268
Home
To delete existing Precedence association set

1. In the Precedence area, from the drop-down list select the Precedence Association Set that
you want to delete.
2. Click Delete Precedence Association Set
icon.
3. Click Yes to delete the Precedence Associate Set.
All associated rules get deleted along with the Precedence Association Set.
Creating a Precedence set for reconciliation Merge activities

A Precedence set defines the precedence value for a dataset in a Merge activity. Each source
dataset is paired with one, and that Precedence set serves as the default precedence value for all
classes and attributes in that dataset. The highest value among all source datasets determines the
data that is written to the target dataset.
Within a Precedence Set, you can specify individual Precedences for either a class or an attribute,
assigning them a precedence value higher or lower than that of the dataset. This prevents one
source dataset from providing all the data in a merge. Class-level Precedences apply to all
attributes of the class.
When the Merge activity is run, the precedence value specified at the most granular level is used
for a given attribute.
Warning
If used incorrectly, the Defer if Null option can cause instances that cannot be deleted.
For information about this, see Handling NULL values in reconciliation Merge activities .
Recommendations
Use the highest class level possible to take advantage of inheritance.

A Precedence set does not have to be used exclusively with one dataset. It can be
paired with different datasets in different activities. Likewise, a given dataset can be
paired with different Precedence Association Sets in different activities. Therefore,
design your Precedence Association Sets for flexibility. You need fewer of them.
Note
Precedence values are not applicable for the CMDB internal core attributes.
BMC Atrium Core 9.0
Page 995 of 2268
Home
For example:
AssignedTo, AttributeDataSourceList, ClassId, CMDBRowLevelSecurity,
CMDBWriteSecurity, CreateDate, DatasetId, InstanceId, LastModifiedBy, ModifiedDate,
NormalizationStatus, ReconciliationIdentity, ReconciliationMergeStatus, Submitter are
some CMDB internal core attributes and precedence values are not applicable for these
attributes.
Before you begin

Before creating a Precedence set, check if you can use the Standard identification and precedence
rules for reconciliation jobs shipped with the product.
Check that you cannot use the standard rules for merge precedence. See Standard identification
and precedence rules for reconciliation jobs.
To create a Precedence Set for a reconciliation Merge activity

1. In the Precedence area for a Merge activity, click the ... button.
2. In the Precedence Association Set Editor, click New/Edit Precedence Set.
3. In the New/Edit Precedence Set area, enter the following required Precedence set
information.
Set
Type a unique name for the Precedence Set. The name cannot contain any characters that are not
allowed in file names for the operating system of your server. For example, on a Windows server, your
Namespace
Defer If Null
Define how to handle empty, or NULL, attributes in the dataset associated with the Precedence Set. The
Defer if Null setting at the Precedence set level is overridden by the same setting in any Precedences
defined for the set.
Checked If the value of an attribute in this dataset is NULL and this precedence value is the highest,
defer to the dataset with the next highest precedence value. Do not write NULL to the production dataset
.
Unchecked Apply the precedence value for this dataset regardless of whether an attribute value is
NULL.
Append to
Lists
Set whether list values from all source datasets are appended to list-formatted Character attributes in the
production dataset. Duplicate entries are not appended to the list. A list-formatted attribute is a Character
attribute that is intended to hold a list of values according to a specified format. The Append to Lists
setting at the Precedence set level is overridden by the same setting in any Precedences defined for the
set.
Checked If this Precedence set has the highest precedence value for a list-formatted Character
attribute in a Merge activity, the list values from all source datasets are appended to the list in the target
dataset. If some other set has the highest precedence value for the attribute, the Append to Lists option
for that set determines whether values are appended.
BMC Atrium Core 9.0
Page 996 of 2268
Home
Unchecked If this Precedence set has the highest precedence value for a list-formatted Character
attribute in a Merge activity, the list values from the source dataset paired with this set overwrite the list
in the production dataset.
Precedence
Value
Enter or select a value for the dataset that uses this Precedence Set. The weight is 0 to 1000, inclusive,
with higher numbers meaning a higher priority. The Precedence Value is overridden by the value in any
Precedences defined for the set.
Require
Explicit
Define whether to define precedences for all classes or attributes. Select this option to require explicit
Precedence entries for classes and attributes. You must add precedence rules for the classes and
attributes. Clear this option to apply this Precedence set to all classes and attributes for which a
Precedence is not defined.
Precedences
4. Click Add Rule.

5. Enter the following required Precedence rule information:
Status
Class
Select the class to which this Precedence applies.
Namespace
Attribute
If the Precedence is for an attribute, select it from the Attribute list.
Precedence
Type or select a value from 0 to 1000, inclusive. Data with higher numbers have a higher priority.
6. Click OK to add the rule.

7. Click Save to save the Precedence Set, and then click Close.
You can now relate the Precedence set to a dataset by creating a Precedence Association.
Creating a Precedence Association for reconciliation Merge activities

A Precedence Association links a dataset with a Precedence set and is reusable among Merge
activities.
Each Merge activity is linked to one Precedence Association that determines the precedence for
each dataset that participates in the activity.
Note
If you have upgraded to version 8.1.00, consider the following notes.
You are no longer required to explicitly create precedence associations. These
associations are handled intenally when you add precedence values to the
datasets and their respective classes or attributes.
In the user Interface the concept of tiebreaker is not valid. You cannot define
multiple precedence sets for the same dataset.
BMC Atrium Core 9.0
Page 997 of 2268
Home
If you have upgraded from a previous version to version 8.1.00 or later If there is a
tie for the highest precedence value between Precedence Sets, the dataset and set
with the higher Tiebreaker Value takes precedence in the User Interface. Other
precedences sets with lower tiebreaker values do not get reflected in the new UI.
They are ignored.
For changes related to Precedence Set editor and Standard Rules Editor see,
Reconciliation Engine enhancements in version 8.1.00 .
To create a Precedence Association

1. In the Precedence area of the Merge activity, click the ... button.
2. In the Precedence Association Editor, enter a name for the association.
3. Click Add Precedence Association.
4. From the Dataset list, select a source dataset.
5. From the Precedence Set list, select an existing Precedence Set.
6. Select a Tiebreaker Value for this pairing within the set.
If there is a tie for the highest precedence value between Precedence Sets, the dataset and
set with the higher Tiebreaker Value takes precedence in merges.
7. Click Save.
Additional reconciliation activities

Each reconciliation job must have at least one activity. Each activity has components that must be
defined. Most reconciliation jobs use only Identify and Merge activities. However, you can include
other activities in a reconciliation job.
Compare activity
Rename activity
Copy activity
Delete activity
Purge activity
Execute activity
Related topics
Reconciliation job with additional activities
BMC Atrium Core 9.0
Page 998 of 2268
Home
Compare activity
The Compare activity operates against instances in two datasets and either produces a report or
executes workflow based on the comparison results.
The report shows those instances that appear in only one of the datasets and details the
differences between instances that appear in both.
The Compare activity lets you compare an expected configuration against an actual one, which you
could use for more than one purpose. You might use comparison to alert you that something has
changed in a configuration that you expected to remain static. Alternatively, if you have a change
request in progress, you might use comparison to verify that the configuration reaches its expected
new state.
Only instances that have been given an identity can be compared, and they are compared only
against other instances with the same identity. If you choose to execute workflow as a result of the
comparison instead of creating a report, that workflow can execute against instances from either
dataset but not both.
For more information, see Executing workflow against instances after a reconciliation Compare
activity.
BMC Atrium Core 9.0
Page 999 of 2268
Home
Note
An instance must be identified before it can be compared or merged.
For more information about the Compare activity, see Comparing datasets by using the
Rename activity
You use the Rename activity to rename a dataset. Renaming a dataset does not change the
DatasetId, so all reconciliation definitions that include the dataset still work with the new name.
For more information, see Renaming datasets by using the Reconciliation Engine .
Copy activity
You use the Copy activity to copy instances from one dataset to another. You can set options to
determine which relationships and related CIs are copied along with the selected instances.
For more information, see Copying datasets by using the Reconciliation Engine .
Delete activity
You use the Delete activity to delete instances from one or more datasets. This activity does not
delete the dataset itself.
For more information, see Deleting data by using the Reconciliation Engine .
Purge activity
You use the Purge activity to delete instances that have been marked as deleted from one or more
datasets. You can opt to have it verify that each instance has also been marked as deleted in
another dataset before deleting it. This option is useful when you are purging data from a discovery
dataset but only want to purge instances that are marked as deleted in your production dataset.
For more information, see Purging soft-deleted data by using the Reconciliation Engine .
Execute activity
You use the Execute activity to execute a reconciliation job. This activity is useful when you want to
execute one reconciliation job immediately before or after another.
For more information, see Executing reconciliation jobs.
Related topics
Qualification sets for reconciliation activities
Defining a Workflow Execution ruleset in a reconciliation Compare activity
BMC Atrium Core 9.0
Page 1000 of 2268
Home

Executing reconciliation jobs
Qualification sets for reconciliation activities

For most reconciliation activities, you can specify a qualification set for the purpose of restricting the
instances that participate in an activity. Qualification sets, which are reusable between activities,
are qualification rules that each select certain attribute values. Any instance that matches at least
one qualification in a set can participate in an activity that specifies the qualification set.
For example, you might create a qualification set that selects instances that were discovered within
the last 24 hours and have the domain "Frankfurt" if your company just opened a Frankfurt office
and you are reconciling its discovered CIs for the first time.
For more information, see Using Qualification Sets in reconciliation activities .

For a given Compare activity, you can specify a Workflow Execution ruleset that can contain
multiple Workflow Execution rules. Each rule operates against only one BMC Atrium class, and
contains a qualification specifying criteria that executes an action.
The qualification can compare attributes from both datasets. When the Compare activity runs and
the qualification is met, a code you created for the rule is written to the CompareActionCode
attribute in the instance you specify, either in the left dataset or the right dataset.
All BMC Atrium class forms have a preinstalled filter at execution order 0 named OBJSTR:
Instance_REEscapeToCompareFilters that executes when the CompareActionCode attribute is
changed. This filter skips over other workflow to execution order 1000, ensuring that any filters not
related to Compare activities are skipped.
Warning
Do not modify the OBJSTR:Instance_REEscapeToCompareFilters filter, and do not create
any other filters on class forms at execution order 0.
You must create a filter at execution order 1000 that performs the workflow you want for this class.
If the necessary workflow can't be contained in one filter, you can use the filter at execution order
1000 to launch a filter guide containing multiple filters.
BMC Atrium Core 9.0
Page 1001 of 2268
Home
Note
You do not need a filter to create a Compare activity or a reconciliation job that includes it.
You only need the filter to create a Workflow Execution rule for that activity. For
information about creating a Compare activity, see Creating a Compare reconciliation
activity.
You can specify multiple Workflow Execution rules against a given class, each with different
qualifications. If you do this, you should have the same number of filters at execution order 1000,
each matching a particular action code and performing the appropriate filter actions.
After you create the Workflow Execution ruleset, you must use BMC Remedy Developer Studio to
create a filter.
Warning
BMC recommends that you create or modify objects in Best Practice Customization mode.
If you create or modify objects in Base Development mode, they might not survive
application and server upgrades. For more information, see the BMC Remedy Action
Request System online documentation.
Defining a Workflow Execution ruleset in a reconciliation Compare activity

This topic provides instructions for executing a workflow.
Recommendations
Because each Workflow Execution rule queries the database for each instance
being compared, it can result in slower performance, especially when run against a
large number of instances. Avoid creating a large number of Workflow Execution
rules on a class with a large number of instances to compare.
When creating the filter in BMC Remedy Developer Studio, use Best Practice
Customization Mode.
To define a Workflow Execution ruleset in a Compare activity

1. In the Reconciliation console, create or edit a Compare activity for a reconciliation job.
See Comparing datasets by using the Reconciliation Engine .
2. Enable the Use Workflow Execution Group option.
3. To create or edit a Workflow Execution ruleset, click the ... button.
4.
BMC Atrium Core 9.0
Page 1002 of 2268
Home
4. In the Set Editor window, complete the following fields.

Set Type a unique name for the Workflow Execution ruleset. The name cannot
contain any characters that are not allowed in file names for the operating system of
your server. For example, on a Windows server, your job name cannot contain the
Namespace Select a namespace using the controls with the Namespace field.
Only classes in the selected namespaces can participate in the activity.
5. Click Add Rule, or select a rule and click Edit Rule.
6. In the New/Edit Rule area, specify the following parameters.
Class
Specifies the single class against which the rule operates; when building the Qualification, you can use
attributes from only this class.
Execution
Side
Determines whether the Execution Code is written to the instance in the Left or Right dataset. Left refers
to the Dataset 1 specified for a Compare activity, and Right refers to Dataset 2.
Execution
Code
Specifies the unique string that is written to the CompareActionCode attribute when the Qualification is
Execution
Order
Determines when this rule is executed in relation to the other rules in this set.
Qualification
Causes this rule to execute workflow. To use an attribute from the Left dataset, enclose it in single
quotes ('). To use an attribute from the Right dataset, enclose it in dollar signs ( $).
met; has a maximum of 128 characters long.
For example, the qualification to find a CI where the instance in Dataset 1 has an earlier installation date
than the instance in Dataset 2 is as follows:
'InstallationDate' < $InstallationDate$
Click Advanced Qualification to build it interactively.
For more information about the Advanced Qualification Builder, see Relating datasets and Identification
rulesets for reconciliation.
7. Click OK.
8. In the New/Edit Workflow Execution Set area, click Save and then click Close.
10. In the Job Editor, click Save.
11. In BMC Remedy Developer Studio in Best Practice Customization mode, create one filter for
each Workflow Execution rule that you created. The filters must have these characteristics:
Execution order 1000
Form Name The join form for the class used in your Workflow Execution rule.
For example, if the rule operates on the BMC_ComputerSystem class, select the
BMC.CORE:BMC_ComputerSystem form.
Execute On Modify
Run If 'CompareActionCode' = <ExecutionCode>
<ExecutionCode> represents the value that you typed in step 6 and is different for
every Workflow Execution rule you created.
BMC Atrium Core 9.0
Page 1003 of 2268
Home
If Actions The filter actions that should be performed for a particular Execution
Code or, if one filter cannot encompass this workflow, a Call Guide action to call a
filter guide that contains appropriate filters.
12. Attach your new Workflow Execution ruleset to one or more Compare activities.
For more information, see Creating a Compare reconciliation activity.

You can copy instances from one dataset to another. You might do this to create baselines,
snapshots, archives, future states, or other types of datasets.
Option combinations for Copy activity
Creating a Copy reconciliation activity
The Copy activity has interdependent options. Option combinations for Copy activity shows the
Copy activity's behavior for each possible combination of options. The options are:
Copy Relationships Determines whether to restore direct relationships to instances in
the target dataset. This means that when a copied CI is a member of a relationship in the
source dataset, and the other member exists in the target dataset without the relationship,
the relationship instance is copied to restore the connection between the CIs in the target
dataset. The other member is not copied, and the action is not recursive.
A setting of Copy All restores direct relationships, and a setting of By Qualifier does not.
Use the Copy Relationships settings in these situations:
Scenario
Set Copy
Relationships
to
Notes
You are not using a Qualification Set.
By Qualifier
Using Copy All can cause the job to take longer because it
copies the entire dataset.
You are using a Qualification Set

.
You want only weak relationships
and relationships that match the
Qualification set to be copied.
By Qualifier
You are using a Qualification Set

.
You want to copy the CIs
specified by the qualification set,
plus all related CIs.
Copy All
This is a time and CPU intensive process.

After the Job copies all CIs in the Qualification Set, it
performs a GraphQuery API call against each CI that
was copied to find and copy the relationships over.
Collision Resolution Determines whether to overwrite matching instances in the target

dataset. Instance matching is done by reconciliation identity, so unidentified instances in the
source dataset do not cause a collision with instances in the target dataset, and are
therefore copied even if you select Display Error. This can overwrite instances in the source
BMC Atrium Core 9.0
Page 1004 of 2268
Home
dataset. You can prevent it by selecting Yes for the Identity Required option.
A setting of Overwrite overwrites matching instances, and a setting of Display Error writes
an error message to the Reconciliation Engine log instead.
Include Child CIs Determines whether to copy composite objects. This means that where
the CI included in the Qualification set is the source member of a weak relationship, the
destination member and the relationship between them are also copied. The action is
recursive so that all weak relationships and their members below the original CI are copied.
If a copied CI has weak relationships below it in the target dataset but not in the source
dataset, those relationships and their members are marked as deleted in the target dataset.
A setting of Yes copies composite objects, and a setting of No does not.
Identity Required Determines whether to copy instances that have not been given a
reconciliation identity. This option overrides the others: if you specify Yes, an instance with
no identity is not copied, regardless of whether any other option you specified would cause it
to be copied.
A setting of Yes copies only identified instances, and a setting of No also copies unidentified
instances.
Option combinations for Copy activity

The following table describes the behavior of the Copy activity for each combination of options.
Option combinations for the Copy activity

Settings
used
Behavior
Copy
Relationships
Only instances with a reconciliation identity are copied, and they replace existing instances. Only CIs and
relationships in the Qualification set are copied.
: By
Qualifier
Collision
Resolution:
Overwrite
Include Child
CIs: No
Identity
Required:
Yes
Copy
Relationships
Only instances with a reconciliation identity are copied, and they replace existing instances. In addition to
instances in the Qualification Set, the copy includes relationships to copied CIs where the other member exists in
: Copy All
the target dataset.
Collision
Resolution:
Overwrite
Include Child
BMC Atrium Core 9.0
Page 1005 of 2268
Home
Settings
used
Behavior
CIs: No
Identity
Required:
Yes
Copy
Only instances with a reconciliation identity are copied, unless they match existing instances, in which case an
Relationships
error is written. Only CIs and relationships in the Qualification set are copied.
: By
Qualifier
Collision
Resolution:
Display
Error
Include Child
CIs: No
Identity
Required:
Yes
Copy
Relationships
: Copy All
Collision
Resolution:
error is written. In addition to instances in the Qualification Set, the copy includes relationships to copied CIs
where the other member exists in the target dataset.
Display
Error
Include Child
CIs: No
Identity
Required:
Yes
Copy
Relationships
instances in the Qualification Set, the copy includes all weak relationships and CIs below them.
: By
Qualifier
Collision
Resolution:
Overwrite
Include Child
CIs: Yes
Identity
Required:
Yes
Copy
Relationships
: Copy All
Collision
Resolution:
instances in the Qualification Set, the copy includes all weak relationships and CIs below them, and relationships
to copied CIs where the other member exists in the target dataset.
Overwrite
Include Child
BMC Atrium Core 9.0
Page 1006 of 2268
Home
Settings
used
Behavior
CIs: Yes
Identity
Required:
Yes
Copy
Relationships
error is written. In addition to instances in the Qualification Set, the copy includes all weak relationships and CIs
below them.
: By
Qualifier
Collision
Resolution:
Display
Error
Include Child
CIs: Yes
Identity
Required:
Yes
Copy
Relationships
: Copy All
Collision
Resolution:
error is written. In addition to instances in the Qualification Set, the copy includes all weak relationships and CIs
below them, and relationships to copied CIs where the other member exists in the target dataset.
Display
Error
Include Child
CIs: Yes
Identity
Required:
Yes
Copy
Relationships
Instances with and without a reconciliation identity are copied, and they replace existing instances. No instances
beyond those in the Qualification set are copied.
: By
Qualifier
Collision
Resolution:
Overwrite
Include Child
CIs: No
Identity
Required: No
Copy
Relationships
Instances with and without a reconciliation identity are copied, and they replace existing instances. In addition to
instances in the Qualification Set, the copy includes relationships to copied CIs where the other member exists in
: Copy All
Collision
Resolution:
the target dataset.
Overwrite
Include Child
CIs: No
Identity
Required: No
BMC Atrium Core 9.0
Page 1007 of 2268
Home
Settings
used
Behavior
Copy
Instances with and without a reconciliation identity are copied, except identified instances that match existing
Relationships
instances, in which case an error is written. No instances beyond those in the Qualification set are copied.
: By
Qualifier
Collision
Resolution:
Display
Error
Include Child
CIs: No
Identity
Required: No
Copy
Relationships
: Copy All
instances, in which case an error is written. In addition to instances in the Qualification Set, the copy includes
relationships to copied CIs where the other member exists in the target dataset.
Collision
Resolution:
Display
Error
Include Child
CIs: No
Identity
Required: No
Copy
Relationships
instances in the Qualification Set, the copy includes all weak relationships and CIs below them.
: By
Qualifier
Collision
Resolution:
Overwrite
Include Child
CIs: Yes
Identity
Required: No
Copy
Relationships
: Copy All
Collision
Resolution:
instances in the Qualification Set, the copy includes all weak relationships and CIs below them, and relationships
to copied CIs where the other member exists in the target dataset.
Overwrite
Include Child
CIs: Yes
Identity
Required: No
Copy
Relationships
: By
instances, in which case an error is written. In addition to instances in the Qualification Set, the copy includes all
weak relationships and CIs below them.
Qualifier
Collision
Resolution:
Display
BMC Atrium Core 9.0
Page 1008 of 2268
Home
Settings
used
Behavior
Error
Include Child
CIs: Yes
Identity
Required: No
Copy
Relationships
instances, in which case an error is written. In addition to instances in the Qualification Set, the copy includes all
weak relationships and CIs below them, and relationships to copied CIs where the other member exists in the
: Copy All
Collision
Resolution:
target dataset.
Display
Error
Include Child
CIs: Yes
Identity
Required: No
Creating a Copy reconciliation activity

This topic provides instructions for creating a Copy activity. You cannot use a Qualification set with
the Copy activity.
Recommendations
Do not use a Copy activity to put data into the production dataset. Use the Copy
activity to create snapshots, baselines, archives or future states of the production
dataset in a regular or overlay dataset.
Use a Qualification set to get a subset of the source dataset. If you need to copy
the entire dataset, do not select Include Child CIs to avoid the overhead of graph
query during the copy operation.
To create a Copy reconciliation activity

1. In the Reconciliation console, click Create Job or open an exist reconciliation job.
2. In the Activities area, click New to define a new Copy activity.
3. For Type, select Copy.
Field
Description
Name
BMC Atrium Core 9.0
Page 1009 of 2268
Home
Field
Description
Namespace
Status
Continue
on Error

Sequence
inclusive.
5. From the Source Dataset and Target Dataset lists, select datasets to use in the Copy
activity.
6. For Copy Relationships, select which relationship instances to copy.
By Qualifier Copy only the relationships included in the Qualification Set.
Copy All Copy relationships included in the Qualification Set, and also restore
direct relationships to instances in the target dataset.
7. For Collision Resolution, select how to handle matching instances in the source and target
databases.
Overwrite Replace the existing instance in the target dataset with the instance from
the source dataset.
Display Error Write an error message to the activity log file and not copy the
instance.
8. For Include Child CIs, select whether to copy weak destination CIs.
Unchecked Copy only the CIs included in the Qualification Set.
Checked Copy CIs included in the Qualification Set, CIs related as destination
members in a weak relationship, and those relationships. This option preserves
composite objects.
9. For Identity Required, select whether to copy instances without a reconciliation identity.
Checked Copy only identified instances.
Unchecked Copy identified and unidentified instances.

The Reconciliation Engine works with logical dataset names, each corresponding to a dataset ID.
The dataset ID is what is stored with instance data. This allows you to rename a dataset without
modifying the dataset ID of every instance in the dataset.
BMC Atrium Core 9.0
Page 1010 of 2268
Home
A Rename activity changes only the logical name of the dataset you select. It retains the old logical
name in a new dataset with a GUID as its dataset ID.
To create a Rename reconciliation activity
To update job definitions
Important
When you rename a dataset, you should manually update all job definitions, components,
and applications with
the new dataset name. Otherwise, the job fails to execute.
Some of the job definitions, applications, and components include:
Reconciliation jobs (OOTB as well as Customized)
Atrium Integrator Engine \ Atrium Integrator jobs (OOTB as well as Customized)
Normalization Engine jobs (OOTB as well as Customized)
Cloud Lifecycle Management jobs (OOTB & Customized)
Workflows (OOTB as well as Customized) provided by different applications like
ITSM.
Discovery tools like ADDM\Blade.
Existing CIs populated in the particular dataset.
To create a Rename reconciliation activity

3. For Type, select Rename.
Name
Namespace
Status
Continue
on Error

BMC Atrium Core 9.0
Page 1011 of 2268
Home
Sequence
inclusive.
5. From the Dataset to rename list, select the dataset to rename.

6. In the New Dataset Name field, enter a new name for the selected dataset.
7. Click Done.
After renaming the reconciliation activity, you need to update the job definitions for those jobs that
referred the older dataset name or are standard ID merge jobs.
To update job definitions

1. From the Reconciliation menu click Edit Job.
2. In the Job Editor window, select the Identification activity and click Edit Activity.
In the Edit Activity pane, select the old dataset displayed under Dataset Configuration pane
and click Delete.
3. From the Job Editor window seelct the merge activity and click Edit.
4. From the Dataset Configuration pane select the new dataset from the Source Dataset
column.
5. Click the Launch Legacy Reconciliation Console icon on the Reconciliation menu.
6. In the Jobs pane, select the rename job, the Related Activities pane displays the related
activities.
7. Select the merge activity and click View.
8. From the Merge tabbed page, delete the old dataset.
9. From the Configuration Console, in the Show drop-down list select BMC Default Dataset
Merge Precedence Set.
10. Select the BMC Default Merge Precedence Set, delete the old dataset name from the
dataset list displayed below.
11. From the Activity Type window, on the Rename Dataset tabbed page delete the old
dataset name from the drop-down list in the Dataset field, click Save.
Executing reconciliation jobs

You create an Execute activity to run other reconciliation jobs. A job can contain multiple Execute
activities, allowing you to create umbrella jobs that call several other jobs.
To execute jobs in continuous reconciliation, you can use the BMC Default Continuous job. For
more information, see The BMC Default Continuous reconciliation job .
BMC Atrium Core 9.0
Page 1012 of 2268
Home
Warning
Do not use an Execute activity to run the same job of which it is a member. This creates
an endless loop.
To create an Execute reconciliation activity

1. In the Reconciliation console, click Create Job or open an existing reconciliation job.
3. For Type, select Execute.
Name
Description
Name
Namespace
Status
Continue
on Error

Sequence
Specify the order in which to run this activity relative to other activities in a job. For example, if this activity
has a value of 2, it runs before an activity with a value of 3. The sequence can be 0 to 1000, inclusive.
5. For Job to Execute, select an existing reconciliation job.


You can delete instances from one or more datasets using a Delete activity. The Delete activity
performs a physical delete, not a soft delete, and deletes instances regardless of whether they are
soft deleted.
You optionally restrict the instances to be deleted by using a Qualification Set. You can also choose
to delete only identified instances.
The Delete activity is similar to the Purge activity. For information about the Purge activity, see
Purging soft-deleted data by using the Reconciliation Engine .
BMC Atrium Core 9.0
Page 1013 of 2268
Home
To create a Delete reconciliation activity

2. In the Activities area, click New to define a new activity.
3. For Type, select Delete.
Field
Description
Name
Namespace
Status
Continue
on Error

Sequence
inclusive.
5. From the Dataset list, select the datasets from which you want to delete data.
6. In the Additional Parameters area, select one of the following options.
Identified & Unidentified Both identified and unidentified instances are deleted.
Identified Only identified instances are deleted.
Unidentified Only unidentified instances are deleted.
7. In the Qualification area, define which classes and instances to compare.
a. For Use all classes and instances, select to enable or disable.
Checked Compares all classes and instances without restrictions.
Unchecked Allows you to restrict the Compare activity using a qualification set.
b. From the Qualification Set list, select a qualification set.
c. To create a qualification set, click New/Edit Qualification Set. For more information,
see Using Qualification Sets in reconciliation activities .
BMC Atrium Core 9.0
Page 1014 of 2268
Home
Note
When you disable the progress bar, number of CIs deleted by RE is displayed.
When you enable the progress bar, you get a more accurate count of deleted CIs that
includes CIs as well as their strong relationships.

You can use a Purge activity to physically delete only instances that have been marked as deleted,
or soft deleted. You can optionally further restrict the instances to be purged by using a
Qualification Set.
The Purge activity is similar to the Delete activity, which removes instances regardless of whether
they are soft deleted. For information about the Delete activity, see Deleting data by using the
Recommendations
If you are purging data from datasets that also serve as source datasets in a Merge
activity, you can choose to only delete instances that have also been soft deleted in
the target dataset. This helps prevent "orphan" instances in the target dataset that
would never get marked as deleted because no source ever merges with them.
To ensure that users have a chance to review soft-deleted records, make Purge
activities part of a stand-alone job that is executed manually or by workflow events.
To create a Purge reconciliation activity

2. In the Activities area, click New to define a new activity.
3. For Type, select Purge.
Name
Description
Name
Namespace
BMC Atrium Core 9.0
Page 1015 of 2268
Home
Name
Description
Status
Continue
on Error
Sequence
inclusive.
5. From the Datasets list, select a dataset from which you want to purge data.
6. From the Purge Instanceslist, select one of the following options.
Identified & Unidentified Both identified and unidentified instances are purged.
Identified Only identified instances are purged.
Unidentified Only unidentified instances are purged.
7. For Verify in Target Dataset, select one of the following values:
Checked An identified instance is only purged from one of the datasets in the
Datasets table if an instance with the same reconciliation identity in the Target
Dataset is also marked as deleted. Unidentified instances are deleted.
Unchecked The target dataset is ignored, and both identified and unidentified
instances are deleted.
This list is disabled if you selected Unidentified in the previous step because there is
no way to verify an unidentified instance across datasets.
8. If Verify in Target Dataset is enabled, select a dataset against which to validate the
instances to be purged.
Note
When you disable the progress bar, number of CIs purged by RE is displayed.
When you enable the progress bar, you get a more accurate count of purged CIs that
includes CIs as well as their strong relationships.
Service Pack 1 and later
BMC Atrium Core 9.0
Page 1016 of 2268
Home
Prior to 8.1 Service Pack 1, the reconciliation engine used to exclude all the relationships
during purge activity. As a result, if the relationship between the strong and weak CI got
deleted then the weak CI would become orphan. To avoid such data integrity issues,
relationships were excluded during the purge activity. However, from Service Pack 1
onwards the strong relationship (as defined in Common Data Model) can be purged safely
, without causing any data integrity issues. For details about Relationships refer the data
model, Relationships in the data model.

You can compare identified data in two datasets, which is useful for things such as validating
expected data versus discovered data or testing a new reconciliation process.
You can create a Compare activity to compare the data between two datasets. This activity either
creates a comparison report detailing the differences between datasets or executes workflow based
on values in compared instances. For more information about executing workflow, see Executing
workflow against instances after a reconciliation Compare activity .
A comparison report displays instances present in only one of the two datasets, and also shows
differences between the attributes of instances that are in both datasets. The report is an
attachment to an Information event. Only instances that have reconciliation identities are compared.
Creating a Compare activity in a reconciliation job
Viewing a compare activity report
For more information about identification, see Matching instances across datasets by using a
reconciliation Identify activity. You can also exclude individual attributes from being compared.
Creating a Compare activity in a reconciliation job

A Compare activity in the reconciliation compare job compares instances in one or more datasets,
excluding any classes, instances, or attributes you specify. You can compare datasets only if you
have assigned a Reconciliation ID to the CIs.
Before you begin

If needed, create a qualification ruleset to restrict the instances and classes that are
compared.
If needed, create a Workflow Execution ruleset.
BMC Atrium Core 9.0
Page 1017 of 2268
Home
To create a Compare activity in a reconciliation job

2. In the Activities area, click New to define a new Compare activity.
3. For Type, select Compare.
Name
Namespace
Status
Continue
on Error

Sequence
inclusive.
5. From the Dataset 1 and Dataset 2 lists, select the datasets to compare.
6. In the Qualification area, define which classes and instances to compare.
a. For Use all classes and instances, select to enable or disable.
Checked Compares all classes and instances without restrictions.
Unchecked Allows you to restrict the Compare activity using a qualification set.
b. From the Qualification Set list, select a qualification set.
c. To create a qualification set, click New/Edit Qualification Set. For more information,
see Using Qualification Sets in reconciliation activities .
7. To execute a workflow from this activity instead of generating comparison reports, click Use
Workflow Execution Ruleset and select a ruleset from the Workflow Execution Ruleset
list.
The ruleset specifies criteria for running workflow based on results of the comparison.
Note
If you select a Workflow Execution ruleset, no comparison report is generated by
this activity. A Compare activity can either generate reports or execute workflow.
BMC Atrium Core 9.0
Page 1018 of 2268
Home
To create a Workflow Execution ruleset, click New/Edit Workflow Execution Set. For more
information, see Executing workflow against instances after a reconciliation Compare activity
.
8. To exclude attributes from being compared, click Add Rule. If not, skip to step 9.
a. From the Class list, select the class containing the attribute to exclude from the
comparison.
b. From the Attribute list, select the attribute to exclude.
c. Click Save. The Exclusion rule appears in the Exclusion Rules table.
d. Repeat step a through step c for each attribute to exclude.
9. Click Done.
Note
To run the compare activity that you created above, from the list of jobs displayed in the
Reconciliation UI, select the compare job and click the Start Job icon.
Viewing a compare activity report

After you run a compare activity to compare CIs between 2 different datasets the compare activity
report is generated. In addition to other information this report displays information related to the
common CIs that it finds in the datasets that are compared.
The common CIs names are displayed with their instance ID, which helps you to quickly identify the
common CIs in both datasets.
Note
The common CIs are those which have the Reconciliation ID in both of the datasets which
are compared.
To view the compare report

1. From the Reconciliation Engine run the Compare job.
2. In the right pane, expand the completed compare activity.
3. Click the Events slider bar and scroll to the compare report cell.
4. Click on the show report icon next to the Comparision Report row to view the report.
The compare activity reports displays the following information:
Job name
Activity name
Date
Dataset names that are compared
BMC Atrium Core 9.0
Page 1019 of 2268
Home
Total classes compared

The compare activity reports displays the following details about the CIs being compared:
Class name to which the CI belongs to
Qualification
Number of matching instances in 1st dataset
Number of matching instances in 2nd dataset
Number of instances in 1st dataset, not in 2nd dataset
Number of instances in 2nd dataset, not in 1st dataset
Number of instances common to both datasets
If the compare activity finds a common CI in both datasets, the following information of those CI is
displayed:
Instance ID and Name of the CIs
The attributes which doesn't match in these common CIs
Based on the above difference in attributes the number of records which differ in these
common CIs
Namespaces and reconciliation

Almost all reconciliation definitions operate only on classes within a particular namespace. Even if
an instance matches the qualifications that you specify (see Using Qualification Sets in
reconciliation activities), if its class is not in the specified namespace it cannot participate in
reconciliation.
When you customize activities, you can specify multiple namespaces or even select an option that
lets a definition operate in all namespaces. This gives you maximum flexibility when working in a
CMDB that has several data model extensions installed, each using its own namespace. You can
reconcile only CDM classes, only the classes from a particular extension, or any combination
thereof.
Warning
Inheritance of reconciliation definitions by a subclass happens only within the
namespaces specified for the definition. This can be important if you use BMC Atrium
Core with other BMC products that extend the CDM.
For example, in a Precedence set, you might set an attribute precedence on the
MarkAsDeleted attribute of BMC.CORE:BMC_BaseElement because it is the base
class from which all others inherit so you can change the precedence value of
BMC Atrium Core 9.0
Page 1020 of 2268
Home
MarkAsDeleted for all classes with one definition. If you define this attribute precedence
for the BMC.CORE namespace, it does not apply to subclasses of BMC_BaseElement
that were created by other BMC products with a different namespace, and Merge activities
that use this precedence set will have unpredictable results.
Reconciliation configuration
The following topics provide configuration information for functionality available through the
Reconciliation Engine, a component of the BMC Atrium CMDB that reconciles data from multiple
sources and performs other maintenance functions on datasets.
Server settings and threads for the Reconciliation Engine
Configuring Reconciliation Engine system parameters
Standard identification and precedence rules for reconciliation jobs
Exporting reconciliation definitions
Importing reconciliation definitions
Reconciliation IDs in a distributed environment
Configuring reconciliation IDs in a distributed environment
Server settings and threads for the Reconciliation Engine

By default, the Reconciliation Engine is installed in the following locations:
(Microsoft Windows) C:\Program Files\BMC Software\AtriumCore\cmdb\server\bin

(UNIX) /opt/bmc/AtriumCore/<serverName>/cmdb/server/bin/
The Reconciliation Engine is managed by armonitor and is stopped and started with the BMC
Remedy AR System server. You can modify your Reconciliation Engine server configuration and
set the number of threads.
The Reconciliation Engine is multithreaded, which improves its performance. The number of
threads available to the Reconciliation Engine is determined by settings for the BMC Remedy AR
System server where it is installed.
The BMC Remedy AR System server has Fast and List server queues defined, and a maximum
number of threads is specified for each. By default, the maximum number of threads for the
Reconciliation Engine is the higher of these two numbers. You can also directly specify a maximum
. Access the AR System Administration Console to modify the threads.
Recommendation
BMC Atrium Core 9.0
Page 1021 of 2268
Home
Take advantage of Reconciliation Engine multithreading by breaking up large jobs into

smaller ones and running them concurrently, but limit your number of concurrent threads
to twice the number of CPUs in the server. The following factors must be considered while
breaking down RE jobs:
Whether AR and database are installed on the same machine
Number of CPUs
Available memory
Existing load during RE job run
Also, overlapping two jobs from a single CI must be avoided to ensure that there is no
data conflict when initial data load is huge.
Configuring Reconciliation Engine system parameters

You can define system parameters for the Reconciliation Engine.
To modify the Reconciliation Engine system parameters

1. From the Reconciliation console, click Edit Server Configuration.
2. In the Server Configuration Editor, enter values for the following parameters:
Parameter
Name in the AR
Configuration ( ar.cfg or
ar.conf) file
Description
Definition
Check
Interval (
Seconds)
RE-Defn-Check-Interval
An expiration, in seconds, of the Reconciliation Engine's cache of job definitions.

The default is 300. For example, if you change job, activity, precedence, or merge
definitions, and then run a job, you might not see the results after the cache expires
. Setting an expiration for the cached definitions helps to improve performance and
reduce log size.
Polling
Interval (
Seconds)
RE-Polling-Interval
The polling interval in seconds. The Reconciliation Engine "sleeps" until the next
job is scheduled to run or for this interval whichever occurs first. Polling interval is
Continuous
Job
Interval (
Seconds)
RE-Cont-Job-Interval
The execution interval of a continuous job. The default value is 1800 seconds (30
minutes). If you set this value to less than 120 seconds (2 minutes), then the
Reconciliation Engine converts that value to 120 seconds (2 minutes). For more
information, see Creating a continuous reconciliation job.
RPC
Socket
RE-RPC-Socket
The BMC Remedy AR System server RPC socket that the Reconciliation Engine
uses for processing. You can specify only 390698 or 390699, which are the ports
reserved for the Reconciliation Engine. Because the Reconciliation Engine uses
many API calls for BMC Atrium CMDB, you should use only those ports reserved
for BMC Atrium CMDB and not ports that BMC Remedy AR System can use.
used only when the dispatcher does not send a signal to the Reconciliation Engine.
The default is 18000 seconds (5 hours).
If you use a port other than the reserved ports, the Reconciliation Engine displays a
warning that the port in invalid. This can be used to specify a maximum number of
threads. For more information, see Server settings and threads for the
BMC Atrium Core 9.0
Page 1022 of 2268
Home
Parameter
Name in the AR
Configuration ( ar.cfg or
ar.conf) file
Description
Log File
Path
RE-Log-File-Location
Location of log files. The default location is <installDir>\Logs.
Logging
Level
RE-Debug-Leve l
Amount of information to log. The following levels are available:

Error Error and warning messages including context such as instance, class,
and dataset IDs. This level is the default.
Info All information included in the Error option plus job name and start and
finish times; activity name and other activity information; dataset and class being
processed; class statistics; and activity statistics such as the number of records
identified and merged.
Debug All information included in the Info option plus trace messages.
Note: When the logging level is set to Error, the Reconciliation Engine creates a
new 0 byte log file for each run of a reconciliation job, even when the job is
successful. You can choose to configure the deletion of 0 byte log files for
individual reconciliation jobs. For more information, see Configuring the deletion of
Reconciliation Engine job log files.
Maximum
Job Log
RE-Max-Log-File-Size
This option is used to control the size of the job log files. When the log file reaches
its maximum size, it is renamed using the <jobName><n> file name syntax, and
File Size (
KB)
log messages continue to be written to the original file, which is now empty. A value
of zero indicates no maximum file size. The default is 300KB.
Look Into
Other
Datasets
for Parallel
Jobs
RE-Parallel-Job-Run
Select this option if you have configured jobs that are running in parallel. When this
option is selected, the jobs run the identify activity on the source and target
datasets that are configured for the jobs and on all the other datasets. This ensures
that the same Reconciliation ID is assigned to identical CIs in all the datasets and
the data integrity is maintained.
Maxmium
RE-Arrecond-Max-Log-Size
This option is used to control the size of the arrecond process log file. When the log
file reaches its maximum defined size, it is renamed to arrecond_ n.log and the
logging is continued in the arrecond.log. A value of zero indicates that the limit on
the maximum file size is not specified. In that case, the log file takes the default
value. The default size is 20480KB. You can specify a value in the range of 0 to
2097152 KB. For more information on how to use this parameter see, Restricting
the Reconciliation Engine log file size.
RE-Job-Idle-Time
This is the time interval for which a job can remain idle. The default idle time is 60
minutes. You can specify a value in the range of 60 to 720 minutes. When the job
idle time is set to 60 minutes, the fail safe mechanism in the reconciliation engine
monitors all the running jobs at an interval of 60 minutes. If the fail safe feature
detects a job, which is not responding not processing a CI for more than 60 minutes
, the fail safe feature restarts the non-responding job. For detailed information on
the fail safe feature see, Monitoring reconciliation jobs using the Fail safe feature.
ARRecond
Log File
Size (KB)
Job Idle
Time (
Minutes)
For Service Pack 1 and later, the feature is disabled by default and the value is set
to 0 minutes.
Standard identification and precedence rules for reconciliation jobs

Configuring standard identification rules for reconciliation
BMC Atrium Core 9.0
Page 1023 of 2268
Home
Configuring standard precedence rules for reconciliation

Standard identification and precedence rules can simplify the process of creating reconciliation jobs
.
These standard rules work with all classes in the Common Data Model (CDM) and BMC extensions
. They identify each class using attributes that typically have unique values, and they merge based
on precedences set for BMC datasets. Standard reconciliation jobs always use these standard
rules, but you can also use them when you create a custom reconciliation job.
The standard identification rules use BMC.ASSET as the production dataset, and they assign a
priority level to one or more unique attributes for each class. If the Reconciliation Engine cannot
match a CI based on the first attribute, then it uses the secondary attributes. If a class has no
standard identification rule, the Reconciliation Engine uses the BMC_BaseElement attributes.
For example, for the BMC_Product class, TokenId is the primary attribute used to identify
identical CIs in different datasets. If the Reconciliation Engine cannot find a match among CI
instances using the TokenId attribute, the Reconciliation Engine uses Model and
MarketVersion. If no match is found using the Model and MarketVersion attributes, the
Reconciliation Engine uses VersionNumber and Name.
Examples of attribute priorities
Attribute
Priority
TokenId
Model
MarketVersion
VersionNumber
Name
Using BMC.ASSET as the production dataset, the standard precedence rules assign a precedence
of 100 for each BMC dataset and, for some datasets, set precedences for specific classes and
attributes. For every attribute during a Merge activity, the Reconciliation Engine compares the most
specific precedence from each dataset.
For example, in the BMC Configuration Import dataset, the BMC_Memory class has a precedence
of 800. Because all datasets have a precedence of 100 and no other dataset has a precedence
defined for BMC_Memory, data from BMC Configuration Import overwrites data from other
datasets when merging BMC_Memory instances.
Configuring standard identification rules for reconciliation

You can modify the standard identification rules, or you can add new rules.
For example, if you have created class or attribute, you can add a rule for it. If you have multiple
BMC Atrium Core 9.0
Page 1024 of 2268
Home
datasets with the same classes, you can specify that the class attributes for one dataset has higher
precedence than those class attributes in other datasets.
When you modify the standard identification rules, you change the rules for all datasets and all jobs
that use the standard identification rules.
Before you begin

Understand how the priority is used in identification rules.
For any new classes, determine the attributes that uniquely identify instances of the class.
To edit or add identification rules for reconciliation

1. From the Reconciliation console, click Standard Rules Editor.
2. In the Identification Rules tab, you can modify existing rules.
a. Expand a class and a priority, then select an attribute.
b. Select a new value from the Priority list.
3. To create a new rule, click Add Rule.
4. Select from the Class, Namespace, Attribute, and Priority lists to define a new
identification rule.
5. Click Save.
Configuring standard precedence rules for reconciliation

Standard precedence rules define precedence values for CDM classes and attributes. You can
modify the standard precedence rules, or you can add new rules. For example, if you have created
class or attribute, you can add a precedence for it. When you modify the standard precedence rules
, you change the rules for all datasets and all jobs that use the standard precedence rules.
Before you begin

Understand how precedence values are used in Merge activities for more information see,
Standard identification and precedence rules for reconciliation jobs .
You can edit, add, or delete precedence rules for reconciliation using one of the following options:
Using the Standard Rules Editor
Using the Merge Precedence Set Editor
Using the Standard Rules Editor

New Precedence set
BMC Atrium Core 9.0
Page 1025 of 2268
Home
1. From the Reconciliation console, click Standard Rules Editor.

2. In the Precedence tab, click Add or Remove Datasets from the Columns icon on the right
to select the datasets that you would like to be displayed in the columns.
3. Select the check box against the datasets that you would like to view, and close the box.
4. If you are unable to locate the required class/attribute click on the Show All Classes and
Attributes icon to display all the classes and attributes from all namespaces.
5. From the Precedence Object column, navigate to the class or attribute to which you want to
set a precedence rule.
a. To add a rule - In the dataset column, double click the cell where you want to add the
rule.
b. To edit a rule - In the dataset column, double click the cell where you want to edit the
existing rule.
c. To delete a rule - In the dataset column, double click the cell where you want to edit
the existing rule. Delete the value entered in the cell.
6. To add or edit numeric value use the input slider, click 'X' to confirm the input and close.
Alternatively, you can also type the numeric value in the cell and press enter.
The precedence rule is displayed in the cell that you added or modified.
BMC Atrium Core 9.0
Page 1026 of 2268
Home
Note:
If you click on any class or attribute displayed in the Precedence Object column, the
Dataset order pane displays the datasets in which that class or attribute appears in the
order of precedence.
Using the Merge Precedence Set Editor

1. From the Reconciliation console, select the required dataset, and then click Edit Job.
2. Select the Merge activity and then click Edit Activity.
3. In the Job Editor window, click View/Edit Preference Set.
4. From the Precedence Object column, navigate to the class or attribute to which you want to
set a precedence rule.
a. To add a rule - In the dataset column, double click the cell where you want to add the
rule.
b. To edit a rule - In the dataset column, double click the cell where you want to edit the
existing rule.
c. To delete a rule - In the dataset column, double click the cell where you want to edit
the existing rule. Delete the value entered in the cell.
5. To add or edit numeric value use the input slider. Alternatively, you can also type the
numeric value in the cell and press enter. You can click the down arrow to select the
following options:
a. Defer if Null (For a detailed conceptual information on this feature see, Handling
NULL values)
b. Append to Lists
c. Active
6.
BMC Atrium Core 9.0
Page 1027 of 2268
Home
6. Click 'X' to confirm the input and close.

You can export reconciliation definitions from one server and import them on another server.
The settings are saved in an .arx structure to the clipboard, which you must save to a text file. You
can export two types of information:
Reconciliation job definitions You must save each job to a separate file. This data
includes all the settings for the jobs, activities, and qualifications.
Dataset For each dataset, you can export the accessibility, account ID, security settings,
dataset type, creation and modification data, normalization status, identification status,
reconciliation ID, and other information.
To import the settings and jobs to a Reconciliation Engine on another server, you must use the
BMC Remedy Data Import CLI. For more information, see Importing reconciliation definitions.
Note
and line feeds (CR+LF) properly. Use a plain text editor that retains CR+LF. Otherwise,
To export reconciliation jobs and datasets

1. From the Reconciliation console, click Export.
2. Perform one of the following steps:
a. In the Export Jobs tab, select a job.
b. In the Export Dataset Editor tab, select a dataset.
3. Click Copy to Clipboard.
4. In a text editor, paste the copied job settings.
5. Save the text file with an .arx extension.

You import reconciliation definitions by using the BMC Remedy Data Import CLI.
Note
BMC Atrium Core 9.0
Page 1028 of 2268
Home
Before using the CLI on UNIX for the first time, you must add an entry to your library path.
The CLI also has several other options not described in the following procedure, some of
which might be necessary depending on your AR System server environment. For more
information about these topics, see the BMC Remedy Action Request System online
documentation.
To import reconciliation definitions

1. Open a command prompt.
2. If using Microsoft Windows, change to the directory where BMC Data Import tools are
installed.
The default directory is <BMCinstall>\AR System\<serverName> \dataimporttool.
3. Enter the command:
dataimport.bat -x <serverName> -u <userName> -p <password> -a

<port> -o <importFile> -l <logFile> -e 179 -D 4
For <importFile>, specify the full path to the file containing the exported definitions from the
procedure Exporting reconciliation definitions.
Specifying a log file is optional, but recommended in case there are any errors with the import. If
you are not using portmapper, you can specify the port for the server with the optional -a
parameter.
The -e 179 option enables you to verify whether a definition you are importing already exists. This
check is performed based on the globally unique identifier (GUID) values.
Specifying the -D4 option updates an entry if a match is found. If no match is found, a new entry is
created. For more information about the various options for the dataimport.bat utility, click Help in
BMC Remedy Developer Studio and search for the command.
Reconciliation IDs in a distributed environment

In a distributed environment, you might have two or more BMC Atrium CMDB installations that
interact with each other. In this environment, you must ensure that each configuration item (CI) is
assigned the same Reconciliation ID in both BMC Atrium CMDB instances. To do this, you can
distribute the management of Reconciliation IDs across BMC Atrium CMDB instances by setting
each BMC Atrium CMDB instance to manage the IDs by class.
The BMC_BaseElement and BMC_BaseRelationship classes have the following new attributes:
ReconciliationIdType Defines the status of the reconciliation ID for a CI or
relationship.
NULL (Default) Indicates that the reconciliation ID has not been set.
BMC Atrium Core 9.0
Page 1029 of 2268
Home
Authorized Indicates that the reconciliation ID has been assigned and that the
CMDB instance that is the authority for the CI's class has confirmed the reconciliation
ID.
Suggested Indicates that the reconciliation ID has been assigned but that the
CMDB instance that is the authority for the CI's class has not confirmed the
reconciliation ID.
ReconciliatonIdChange Indicates that the reconciliation ID has changed.
In the RE:ReconIDAuthority form, classes are selected for which the BMC Atrium CMDB instance is
the authority for assigning reconciliation IDs. All classes must be assigned among the BMC Atrium
CMDB instances, but a class cannot be set to more than one instance of BMC Atrium CMDB.
During reconciliation on each instance, the Reconciliation Engine identifies and sets the
reconciliation IDs for CIs. It also checks the RE:ReconIDAuthority form:
If the BMC Atrium CMDB instance is set as the authority for a CI's class,
ReconciliationIdType is set to Authorized.
If it is not the authority for the class, then ReconciliationIdType is set to Suggested.
BMC Remedy Distributed Server Option (DSO) keeps the data synchronized and current between
the BMC Atrium CMDB instances. DSO monitors when CIs change in BMC Atrium CMDB and
copies them to the other. When the reconciliation job runs again, it checks the RE:
ReconIDAuthority form to see if it is the authority for the CI's class.
If it is the authority, the Reconciliation Engine updates the reconciliation ID on the CI in the
source dataset to the value assigned for the CI in BMC.ASSET. The Reconciliation Engine
then sets ReconciliationIdType to Authorized and ReconciliatonIdChange to Yes.
If it is not the authority, the Reconciliation Engine updates the reconciliation ID on the CI in
BMC.ASSET with the value assigned to the CI in the source dataset.
For example, the following figure shows two BMC Atrium CMDB instances, each of which is the
authority for managing the Reconciliation IDs for specific classes.
A computer system CI is present in both instances. Instance 1 is the authority for reconciliation IDs
for the BMC_ComputerSystem class, and Instance 2 is not. On both BMC Atrium CMDB instances,
reconciliation jobs identify the computer system CI but assign it different reconciliation IDs.
BMC Atrium Core 9.0
Page 1030 of 2268
Home
Distributed Reconciliation ID
On Instance 2, a reconciliation job identifies the computer system CI and assigns it a

reconciliation ID of OI-4192b0b3. It also sets the ReconciliationIdType attribute to
Suggested.
DSO detects changes on Instance 2 and propagates them to Instance 1. The computer
system CI is added to a source dataset on Instance 1 with the reconciliation ID of OI4192b0b3.
On Instance 1, a reconciliation job identifies the computer CI in BMC.ASSET with a
reconciliation ID of OI-0241a09c7.
The Reconciliation Engine checks the authority table and verifies that Instance 1 is
the reconciliation ID authority for the BMC_ComputerSystem class.
The Reconciliation Engine on Instance 1 changes the reconciliation ID for the
computer system CI in the source dataset from OI-4192b0b3 to OI-0241a09c7.
It also changes ReconciliationIdType from Suggested to Authorized and sets
the ReconciliatonIdChange attribute to Yes.
DSO detects changes on Instance 1 and propagates them to a source dataset on Instance 2
.
On Instance 2, when the reconciliation job runs, it identifies the update computer system CI.
The Reconciliation Engine checks the authority table and verifies that it is not the
authority for the BMC_ComputerSystem class.
The Reconciliation Engine updates the reconciliation ID (OI-4192b0b3) on the CI in
BMC.ASSET with the value assigned to the CI in the source dataset (OI-0241a09c7).
BMC Atrium Core 9.0
Page 1031 of 2268
Home
Related Topic

To configure Reconciliation IDs for a distributed environment, you need to complete the following
tasks:
Before you begin
To set Reconciliation ID authority
To enable of Reconciliation ID authority
Recommendation
In an Identify activity, disable Generate IDs in Data Configuration (which finds CIs with a
reconciliation ID of 0 and sets it to a nonzero value) to improve performance, unless it is
required. (By default, Generate IDs is disabled, and the Identify activity does not assign
reconciliation ID for CIs created directly in the BMC.ASSET dataset.)
Before you begin

If you are not using BMC Cloud Lifecycle Management, you must create DSO mappings and
filters, and then create an extension loader to run in the BMC Atrium Core Maintenance Tool
. You cannot use the default extension loader definitions, which are specifically created for
BMC Cloud Lifecycle Management.
In BMC Cloud Lifecycle Management, the DSO is configured during the installation, and this
procedure is not required. However, if the destination server or its DSO password has
changed, you need to run the extension loader.
In BMC Remedy Developer Studio, open the RE:Jobs form, and make the
InvokeSpecialIDActivity field visible if you want to enable it for each job, or set the default
to Yes. In BMC Cloud Lifecycle Management, InvokeSpecialIDActivity is set to Yes by
default, so this preparation is not required.
To set Reconciliation ID authority

In BMC Cloud Lifecycle Management, the class authority is set during the installation, so this
procedure is not required.
Note
BMC Atrium Core 9.0
Page 1032 of 2268
Home
All classes must be set in the RE:ReconIDAuthority form of one BMC Atrium CMDB
instance so that the reconciliation IDs can be synchronized. Classes must also be
exclusively set: A class cannot be set in the form for more than one BMC Atrium CMDB
instance to avoid a loop in which the reconciliation ID for CIs are updated.
1. Open the RE:ReconIDAuthority form using the direct URL:

http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/RE:
ReconIDAuthority
2. Specify the namespace of the class, such as BMC.CORE.
3. Enter the Class Name, such as BMC_ComputerSystem.
Note
You must specify classes one at a time.
4. Enter the Class ID, such as BMC_COMPUTERSYSTEM.

5. Click To enable of Reconciliation ID authority.
The Reconciliation Engine is configured to assign the authoritative reconciliation ID for all CIs of the
specified class. You must enable the InvokeSpecialIDActivity option on each reconciliation job.
To enable of Reconciliation ID authority

In BMC Cloud Lifecycle Management, the InvokeSpecialIDActivity parameter is enabled by
default on all reconciliation jobs, so this procedure is not required.
If you edited the RE:Jobs form in BMC Remedy Developer Studio and set
InvokeSpecialIDActivity to Yes by default, this procedure is not required.
1. Open the RE:Jobs form using the direct URL:
http://<midTierServer>:<portNumber>/arsys/forms/<arSystemServer>/RE:Jobs
2. Search for an existing reconciliation job.
3. Enable the InvokeSpecialIDActivity parameter.
4. Click Save.
BMC Configuration Drift Management

This topic describes how to use the BMC Configuration Drift Management application. This
application runs on the BMC Remedy AR System platform and consumes data from the BMC
Atrium Configuration Management Database (CMDB) application. Drift Management also integrates
with the BMC Remedy IT Service Management (ITSM) solution, specifically with the BMC Remedy
Change Management application, and the BMC Remedy Incident Management application.
BMC Atrium Core 9.0
Page 1033 of 2268
Home
Audience
This topic is intended for the following IT professionals:
Configuration managers
System administrators
Network managers
Related topics
Installing BMC Configuration Drift Management
Drift Management known and corrected issues
Understanding Drift Management

BMC Configuration Drift Management is built on the BMC Remedy AR System and is a consumer
of the configuration data that is discovered by your discovery applications and stored in your BMC
Atrium CMDB.
Using the configuration management data in your BMC Atrium CMDB, Drift Management focuses
on the auditing, verification, and management of infrastructure changes in your data center IT
environment. The auditing activities provided by Drift Management assist you in keeping your data
center operationally compliant with the business rules of your IT environment.
Drift Management also integrates with other BMC applications, such as BMC Remedy Change
Management and BMC Remedy Incident Management, to provide the initial steps toward the
automation of data center operations. Integration with BMC Remedy Change Management plays an
important role in the automation of these operations by linking changes in the data center
environment to approved change requests. Integration with BMC Remedy Change Management
and BMC Remedy Incident Management also facilitates quick resolution of infrastructure changes
by manually or automatically creating incident requests, or by manually creating change requests
from Drift Management.
Drift Management architectural overview
BMC Atrium Core 9.0
Page 1034 of 2268
Home
See the following video for an overview on BMC Configuration Drift Management.
BMC Configuration Drift Management overview
This section include the following topics:
What is drift?
Drift Management and ITIL
Basic concepts
Drift workflow
Common scenarios
What is drift?
Simply stated, a drift is a change in your IT environment. Drift is the difference between the current
physical state of your IT environment and the expected or correct state of your environment. At a
more granular level, a drift is a change in a configuration item (CI), a CI attribute, or a relationship
as defined in your BMC Atrium Configuration Management Database (CMDB).
A drift is caused by adding, removing, or modifying CIs, CI attributes, or relationships between CIs.
BMC Atrium Core 9.0
Page 1035 of 2268
Home
Note
BMC assumes you are familiar with basic configuration management and BMC Atrium
CMDB concepts such as CIs and the BMC Asset dataset. For more information, see
Related documentation.
BMC Atrium CMDB represents the correct or current states of your data center configuration items.
Sometimes, however, real-world issues appear in the form of new releases, upgrades, new
equipment, and unauthorized changes. After using your discovery mechanism to scan your
environment and to update BMC Atrium CMDB, use Drift Management to monitor and detect
changes in the state of your CIs.
Drift Management is a consumer of, and works entirely from, the data in BMC Atrium CMDB. Drift
Management is not a discovery tool, instead it relies upon a discovery application to update BMC
Atrium CMDB.
Drift Management and ITIL

Drift Management supports the verification and audit activities of configuration management as
defined by the IT Infrastructure Library (ITIL ).
According to ITIL, periodic audits of your IT environment should be conducted to verify that the
BMC Atrium CMDB is up to date. The reverse is also true. Periodic audits of your physical
environment should be conducted to verify that the physical environment has the correct and
approved CIs as defined in BMC Atrium CMDB.
For example, suppose you want to verify that all security servers have the same CIs and
configuration attributes. With Drift Management, you can establish a baseline using a known
security server that is in your BMC Atrium CMDB and that has the appropriate configuration. You
can then compare all other security servers (target servers) with the baseline to detect whether any
changes (drift) have occurred. The drift might be due to the addition, removal, or modification of CIs
or attributes on your target servers.
With Drift Management, you can perform the audit and verification process as needed or on a
regular audit schedule. For example, you might want to audit the servers most critical to your
business on a daily or weekly basis and the less critical servers on a monthly basis. If drift is
detected, Drift Management enables you to take corrective action (after proper research for the root
cause) either by using a change request or by correcting the target computer using an incident
request.
ITIL makes the following recommendations for when you should do a configuration audit in your IT
environment:
Shortly after implementation of a new Configuration Management system
BMC Atrium Core 9.0
Page 1036 of 2268
Home
Before and after major changes to the IT infrastructure

Before a software release or installation
At random intervals
At regular intervals
When all is back to normal after a disaster recovery
When any unauthorized CIs are detected
Basic concepts
This topic describes the basic Drift Management concepts required to understand how to detect a
drift.
Comparison job
You detect drift by creating and running a comparison job. A comparison job compares a baseline
set of CIs and a target set of CIs in BMC Atrium CMDB and identifies differences between the sets.
A comparison job contains the following components:
A baseline
A target
The type of comparison to perform
A schedule for running the comparison job (optional)
The automatic creation of an incident request ticket (optional)
Baseline
A baseline is a set of CIs and their associated attributes, having a known state, used as the basis
for comparison. You can view a baseline within Drift Management as a saved BMC Atrium CMDB
query that identifies the CIs that you want to use as your baseline CIs
A baseline is created using the Drift Management Baseline Wizard and contains the following
components:
A source dataset of CIs (for example, the BMC Asset dataset)
A qualification set (to narrow the number of CIs in the baseline)
An include set of attributes to use in the comparison (optional)
An exclude set of attributes to exclude from the comparison (optional)
Target
A target is a set of CIs that you compare with the baseline. These CIs are the items in your IT
environment, as they currently exist, that you want to audit to verify that they are at the correct state
of configuration.
Like a baseline, you can view a target as a saved query that identifies the CIs that you want to use
BMC Atrium Core 9.0
Page 1037 of 2268
Home
as your target CIs.

A target is created using the Drift Management Target Wizard and contains the following
components:
A source dataset of CIs
A qualification set (to narrow the number of CIs in the target)
Source dataset
The source dataset is the location of the CIs that you want to use for your baseline or target.
For a baseline, the source dataset can be:
A snapshot (copy) of your BMC Atrium CMDB at a point in time. You can apply qualifications
to select the specific CIs that you want to copy into your baseline.
A regular dataset, which is typically BMC Asset. You can apply qualifications to the dataset
to select the specific CIs you want to use in your baseline.
Snapshot
A snapshot is a copy of a subset of CIs from a source dataset to another dataset (the destination
dataset).
A snapshot is created using the Drift Management Snapshot Job Wizard and contains the following
components:
A source dataset of CIs
A destination dataset
A qualification set (to narrow the number of CIs copied to the destination dataset)
Options for copying CIs and their relationships
A schedule (optional)
You can create multiple (daily or monthly) snapshots of a particular set of CIs and use these
snapshots to determine whether the configuration of the CIs has changed.
Qualification set
A qualification set is a query used to select the specific CIs that you want to use in your baselines,
targets, or snapshot jobs. A qualification set is required when you create a snapshot, a baseline, or
a target.
BMC Atrium Core 9.0
Page 1038 of 2268
Home
Include set
An include set defines CI attributes that you want to include in a comparison job to determine
whether the CI attribute value has changed or is not set at the correct value. An include set can
provide greater granularity during comparison because of its variety of comparison operators (EQ,
GT, LT, LE, and so on) and the ability to specify attribute values (for example, a standard value) to
compare against. Using an include set is optional.
Exclude set
An exclude set defines CI attributes that you want to exclude or ignore when doing a comparison.
Using an exclude set is optional.
Drift workflow
Data from a discovery application is reconciled by the BMC Atrium CMDB Reconciliation Engine
and placed in the BMC Asset dataset. This discovered data is then used by Drift Management.
Drift Management workflow
Common scenarios
This topic describes the most common scenarios for using Drift Management.
BMC Atrium Core 9.0
Page 1039 of 2268
Home
Comparison of the current state of BMC Atrium CMDB with a snapshot

You want to determine whether drift has occurred over a period of time. You make a
snapshot of BMC Atrium CMDB at a given point in time (this becomes your baseline) and
later (a day, a week, or a month, for example) compare the current state (your target) with
the baseline.
For more information about using Drift Management for this scenario, see Getting Started.
The Getting Started helps you to become familiar with the Drift Management workflow when
creating a comparison job.
Comparison with a standard (for compliance)
You compare the state of BMC Atrium CMDB with a baseline to ensure that the physical
state is not drifting from the declared standard.
This scenario is commonly called the golden server or golden CI. Within BMC Atrium CMDB,
you have the CIs for a crucial business service (for example, security) configured exactly as
needed. The golden CIs are the baseline with which the other security servers (targets) are
compared to verify that they are configured to match the declared standard (the baseline).
A golden CI is configured exactly as needed and is used as a basis of comparison with your
target CIs.
Comparison between a test dataset and BMC Atrium CMDB
You want to define a test or sandbox dataset on top of another dataset to determine the
impact of potential modifications in the test dataset on BMC Atrium CMDB. In this scenario,
BMC Atrium CMDB is the baseline and the test dataset is the target. The comparison uses
the BMC Atrium CMDB API to view the equivalent of a merge between the two datasets.
Managing Drift Management permissions

This topic explains how to set up permissions for the BMC Configuration Drift Management
application, including access to different functions of Drift Management.
Drift Management Permission groups
Understanding instance permissions
Creating users with Drift Management permissions
Creating groups to use with Drift Management
Using the Application Administration Console
Drift Management Permission groups

Understanding Drift Management permission groups
Drift Management default permission groups
Permission groups for BMC Change Management and BMC Incident Management
Understanding Drift Management permission groups

The following points explain the Drift Management permissions groups:
BMC Atrium Core 9.0
Page 1040 of 2268
Home
Drift Management offers a flexible permissions model that lets you grant role-based
permission to specific areas of Drift Management functionality.
Permission groups are used to grant users access to specific consoles and modules within
Drift Management. They are also used for notifications. In addition to inheriting the instance
access within BMC Atrium CMDB, Drift Management lets you specify access to various Drift
Management components (drift reports, baselines, targets, jobs, qualification sets, include
sets and exclude sets) on the basis of group membership.
To give users access to Drift Management, you first must create a BMC Remedy AR System
user for each of them on the BMC Remedy AR System server where Drift Management is
installed. You can then make those users members of multiple groups and assign those
groups to roles that allow them access to different parts of the application and its data.
Drift Management default permission groups

The following table lists the default permission groups available for Drift Management.
Drift Management permission groups
Permissions
Description
group
Drift Master
Grants full access to Drift Management with additional access to the following Drift Management consoles,
independent of any functional roles or support group affiliations:
Authoring Console (edit or view access)
Job Console (edit or view access)
Drift Console (edit or view access)
Drift Dashboard (select or view access)
Note: This permission supersedes the Drift Admin and Drift Viewer permission groups.
Drift Admin
Grants execution and management access to Drift Management with access to the following Drift Management
consoles, independent of any functional roles or support group affiliations:
Authoring Console (view access)
Job Console (edit or view access)
Drift Console (edit or view access)
Note: This permission supersedes the Drift Viewer permission group.
Drift Viewer
Grants view access to Drift Management. With view access, users can view reports on the Drift Console. These
permissions also grant you access to the following consoles:
Authoring Console (view access)
Job Console (view access)
This permission is superseded by the Drift Master and Drift Admin permission groups.
Public
If guest users are configured in the BMC Remedy AR System server, the Public role grants select or view access
to the Drift Dashboard, as part of the BMC Remedy AR System Public group. With select or view access to the
Drift Dashboard, you can perform the following tasks:
Change the date range to refresh the charts.
BMC Atrium Core 9.0
Page 1041 of 2268
Home
Permissions
group
Description
Select Business Services that you have permission to view.

Select baselines that you have permission to view.
For more information about the Public group and its role in BMC Remedy AR System, see the Key
concepts in BMC Remedy AR System online documentation.
For information about creating users and working with groups and roles, see the Creating users,
groups, and roles in BMC Remedy AR System online documentation.
BMC Configuration Drift Management integrates with BMC Change Management and BMC Incident
Management. Application roles and permissions for integration are also provided to control who can
create BMC Change Management and BMC Incident Management forms and submit change
requests or incident requests.
The following table lists BMC Remedy ITSM permission groups that are important for integrating
Drift Management with BMC Change Management and BMC Incident Management.
Note
Use the BMC Remedy ITSM Application Administration Console to grant these
permissions to users. For more information, see Configuring after installation in BMC
Remedy IT Service Management online documentation.
Permissions
group
Description
Form access
Infrastructure
Change
Master
For integration between Drift Management and BMC Remedy Change Management. Grants
access to BMC Remedy Change Management with additional privileges to modify
infrastructure change requests and tasks independent of any functional roles or support
group affiliations. This permission group also grants access to users to create and modify
approval mappings. This permission supersedes the Infrastructure Change User and
Infrastructure Change Viewer permission groups. Requires an application fixed or floating
license.
Provides access to:
Infrastructure
For integration between Drift Management and BMC Remedy Change Management. Grants
Provides access to
Change User
general access to open, query, submit, and modify change requests in BMC Remedy
Change Management.
the Infrastructure
Change form.
Infrastructure
Change form
Approval
Mappings
form
Note: Modification access can be restricted through the additional use of functional roles
and support group relationships.
This permission is superseded by the Infrastructure Change Master permission group and
supersedes the Infrastructure Change Viewer permission group. Requires an application
fixed or floating license.
BMC Atrium Core 9.0
Page 1042 of 2268
Home
Permissions
group
Description
Form access
Incident
For integration between Drift Management and BMC Remedy Incident Management. Grants
Provides access to
Master
access to BMC Remedy Incident Management, with additional privileges to modify incidents
independent of any functional roles or support group affiliations. This permission
the Incident form.
supersedes the Incident User, Incident Submitter, and Incident Viewer permission groups.
Requires an application fixed or floating license.
Incident User
For integration between Drift Management and BMC Remedy Incident Management. Grants
Provides access to
access to open, query, submit, and modify incidents in BMC Remedy Incident Management
.
the Incident form.
Note: Modification access can be restricted through the additional use of functional roles
and support group affiliations.
This permission is superseded by the Incident Master permission group and supersedes the
Incident Viewer permission group. Requires an application fixed or floating license.
For troubleshooting the issues encountered during automatic incident creation from Drift
Management, see Automatic incident creation issues.
Understanding instance permissions

Multitenancy enables you to control which records and configuration data are exposed to a user,
based on the user's membership in a company, business unit, or other group. To support
multitenancy, Drift Management offers a flexible permissions model that lets you grant read
permission to instances of drift data in the Drift Console.
Within BMC Atrium CMDB, multitenancy means that one BMC Atrium CMDB holds data about the
IT environments of multiple companies, usually in the case of an IT service provider, and each
company has access only its own data. Each company's data is represented in the BMC Atrium
CMDB as an account.
For each class in each account, you can specify default read and write permissions to be applied to
newly created instances. You can also specify default permissions to be applied to all classes that
do not have specific permissions defined. You can override these default permissions for a
particular instance by specifying permissions for the instance.
Important
Drift Management inherits the instance access as currently defined within BMC Atrium
CMDB. Drift Management does not make any changes to this level of access.
BMC Atrium Core 9.0
Page 1043 of 2268
Home
To have read or write access to drift components, users must belong to the appropriate base
groups (Drift Master, Drift Admin, or Drift Viewer) and belong to at least one of the groups identified
by the Drift Master when the component is being created or modified.
Drift Management provides the ability to control who can view and modify the following Drift
Management components:
Drift Reports
Snapshot or comparison jobs
Authoring components: baselines, targets, qualification sets, include sets and exclude sets
The Drift Master defines instance access to the Drift Management components when the
components are created, by using the Accessible To field. This field is on all Drift Management
wizards, authoring components, and job components.
Defining instance permissions

In the Accessible To field, the Drift Master selects the groups that can have access to that data.
More than one group can have permission to view instances in Drift Management components.
To define instance permissions

1. As a Drift Master, open one of the Drift Management wizards, authoring components, or job
components.
2. Use the Accessible To field to select the groups who can have access permission.
3. Continue defining the Drift Management components.
Important
Be careful when deleting groups from the Accessible To field for a comparison job,
because you might lose permissions to the underlying baselines and targets.
Examples of Drift Management instance permissions

Access to specific Drift Management components is defined when the Drift Master creates a new
job, baseline, or target. This section provides examples of how Drift Management roles work in
conjunction with instance permissions. The examples use the users and group memberships
shown in the following table.
Example Drift Management permission groups
User
Belongs to these groups
Frank Field
Drift Master, Cisco, Juniper
Tom Target
Drift Master, AMD, Intel, IT
BMC Atrium Core 9.0
Page 1044 of 2268
Home
User
Belongs to these groups
Betty Baseline
Drift Master, Cisco
Johnny Job
Drift Admin, Cisco
Colin Column
Drift Admin, Juniper
Jennifer Java
Drift Viewer, Cisco
Cheryl Change-Request
Juniper, Intel, Cisco, IT, AMD
Jessica
Drift Admin, AMD
Example 1
When creating a baseline, Drift Master Frank Field grants the Cisco and Juniper groups data
access to the baseline.
Question: From the list of users, who can view and modify the baseline?
Answer: Frank and Betty. Tom has Drift Master permission, but no permission to Cisco and Juniper
. Betty has Drift Master and Cisco permission. Johnny Job has Cisco permission, but belongs to the
Drift Admin (not Drift Master) group.
Example 2
When creating a target, Tom provides access to the AMD group.
Question: Who can view and modify the target?
Answer: Tom, Cheryl, and Jessica.
Example 3
Frank and Betty want to create a comparison job.
Question: When using the Comparison Job Wizard, will they see the target listed in the target
library that Tom created?
Answer: No. Although Frank and Betty are Drift Masters, Frank and Betty do not belong to the
same groups as Tom. They do not have AMD, Intel, or IT permissions.
Example 4
Frank and Betty create a job and select Cisco as the access group.
Question: Who can execute the job?
Answer: Frank, Betty, and Johnny
BMC Atrium Core 9.0
Page 1045 of 2268
Home
Question: Who can view the Drift Reports created by the job?
Answer: Frank, Betty, Johnny, and Jennifer
Example 5
Tom creates a job and selects AMD as the Accessible To group.
Question: Who can execute the job?
Answer: Only Tom and Jessica can execute the job.
Question: Who can view the Drift Reports created by the job?
Answer: Only Tom and Jessica can view the Drift Reports. Cheryl only has access to the Drift
Dashboard.
Creating users with Drift Management permissions

If you do not have BMC Remedy Change Management or BMC Remedy Incident Management
installed, create Drift Management users in the User form.
If you do have BMC Remedy Change Management or BMC Remedy Incident Management
installed, create Drift Management users in the People form through the Application Administration
Console.
If you have any of the BMC Remedy ITSM application installed, you should always configure users
by opening the People form from the Application Administration Console. Information that you add
or modify on the People form automatically updates the User form, but information updated on the
User form does not update the People form.
Warning
Do not modify the Demo user's Fixed Write license or Administrator group membership
until you have created another Administrator user first, or you will lose administrator
privileges.
To create a user with Drift Management permissions in the User form

1. Using BMC Remedy User or a browser, log in to BMC Remedy AR System as an
administrator.
2. From the AR System Administration Console, select Application > Users/Groups/Roles >
Users.
The User form opens in Search mode.
3.
BMC Atrium Core 9.0
Page 1046 of 2268
Home
3. Select Actions > New to switch to New mode.

4. Enter information in the appropriate fields, including required fields.
5. Depending on the user's role in the company, specify the appropriate license type.
6. From the Group List field, make sure that the user is a member of the group that is mapped
to the role, or map one of the user's existing groups to the role.
For example, the Drift Master role requires that you assign that person to the Drift Master
group. This individual can also be assigned to other groups.
If adding the user causes you to exceed your license limit, an error message appears.
Note
For more information about the User form, see the User forms in BMC Remedy AR
System online documentation. For more information about BMC Remedy AR
System application roles and computed groups, see the Administering in BMC
To create users with Drift Management permissions in the People form
Note
The application administrator must have a BMC Remedy AR System license. You can log
in as appadmin to define the application administrator.
1. Open the Application Administration Console.

2. From the Standard Configuration tab, select the appropriate company.
3. Click the Create link next to Step 4 People.
The People form appears.
4. Enter all the required information, as marked by bold field labels.
5. Depending on the user's role in the company, specify his or her license type.
6. Click the Login/Access Details tab.
a. In the Unrestricted Access field, select Yes.
b. In the Application Permission area, click Update Permission Groups.
The Permission Group dialog box appears.
c. In the Permission Group field, select each appropriate permission group to which this
user should belong.
d. Select a license type.
e. Click Add/Modify for each permission group, as needed.
For example, the Drift Master role requires that you assign that person to the Drift
Master group.
7.
BMC Atrium Core 9.0
Page 1047 of 2268
Home
7. To enable this user to create change requests (with the Drift Management integration), add
the user to the Change Master or Change User permission group.
8. To enable this user to create incident requests (with the Drift Management integration), add
the user to the Incident Master or Incident User permission group.
9. Click Close.
The application administrator's information is stored in the User form and the application People
form.
If adding the user causes you to exceed your license limit, an error message appears. In this case,
either reassign existing licences or contact BMC for additional licenses.
Note
For more information about the People form, see the Configuring after installation in BMC
Remedy IT Service Management online documentation.
Creating groups to use with Drift Management

This section briefly describes how to create BMC Remedy AR System access control groups to use
in conjunction with Drift Management. If you want Drift Management to support multitenancy
without using BMC Remedy Change Management and BMC Remedy Incident Management, you
might want to create a group to represent each company.
If you need more detailed information about creating BMC Remedy AR System groups, see
Creating and managing groups in BMC Remedy AR System online documentation.
The groups you create here are in addition to the default groups provided with Drift Management.
For more information, see Drift Management permission groups.
To create groups to use with Drift Management

1. Using BMC Remedy User or a browser, log in to BMC Remedy AR System as an
administrator.
2. From the AR System Administration Console, select Application > Users/Groups/Roles >
Groups.
3. Open the Group form in New mode.
4. Enter information for the following fields:
Group form fields for Drift Management
Field
Description
Group
Name
BMC Atrium Core 9.0
Page 1048 of 2268
Home
Field
Description
Name of the access control group. Use this name in the Group list field in the User form and in the
Permission and No Permission lists when you are defining object permissions. Every group name should be
different. For example, if you want to create a group that represents a company, you could use the company
name in Group Name.
Group ID
Integer ID that uniquely identifies the group. Select an ID within the range of 1000-14999. If you use the same
ID with multiple group names, you must also use the same group type for each name because you are
creating aliases for the same group.
Group
Type
Maximum permission type intended for the group:

None (no access)
View (view field contents)
Change (modify field contents).
For Drift Management, select View or Change.
Long
Group
Additional information about a group. The text should be descriptive of the group because it appears by
default in the Results pane in BMC Remedy User when listing groups.
Name
Group
Category
The BMC Remedy AR System group category, such as Regular, Dynamic, or Computed. For Drift
Management, select Regular.

6. In the User form, assign users to the group that you created.
Using the Application Administration Console

If you have BMC Remedy Change Management or BMC Remedy Incident Management installed,
configure Drift Management permissions by using the Application Administration Console. The
configuration forms are available only to BMC Remedy AR System administrators and application
administrators.
Important
Always open forms from the console . If you open the forms directly from the object list in
BMC Remedy User, you might not see all the information that you need, or you might
experience unexpected results.
Use the forms accessed from the Custom Configuration tab to go beyond the standard
configuration.
Application Administration Console--Custom Configuration tab
BMC Atrium Core 9.0
Page 1049 of 2268
Home
For information about configuration, see the Installing BMC Configuration Drift Management and
Configuring after installation in BMC Remedy IT Service Management online documentation.
Getting started with Drift Management

This topic provides instructions for accessing Drift Management and a sample scenario for
detecting drift.
To quickly walk you through a common scenario for detecting drift, the sample scenario introduces
you to the Drift Management workflow and Drift Management components that detect drift. Detailed
steps are provided in later sections. The scenario does not use and explain every feature of the
Drift Management components.
Read Basic concepts before beginning the quick start.
BMC Atrium Core 9.0
Page 1050 of 2268
Home
Important
You must have Drift Master access privileges to perform the tasks. Drift Master gives you
full access to Drift Management features, including the Authoring items. For information
about setting up Drift Master access privileges, see Managing Drift Management
permissions.

Accessing Drift Management
Example scenario
Accessing Drift Management

After you install the BMC Remedy AR System, BMC Atrium CMDB, and Drift Management
applications, and they are running on the host computers, you can access Drift Management using
the following methods:
Using a browser
Using BMC Remedy User
Note
When accessing Drift Management for the first time, no data is displayed in the Drift
Dashboard or the Drift Console.
To access Drift Management using a browser

1. Launch your browser and enter the following URL in to your browser's address bar:
http:// (http://)<web_server>:<port>/arsys
<web_server> is the fully qualified name of the BMC Remedy Mid Tier server, specified in
the format <server_name>.company.com.
<port> is an optional port number, which is needed if the web server is not on the default
port (port 80).
2. Enter your user name and password, and then click Login.
The BMC Remedy AR System home page appears.
3. From the navigation pane, locate BMC Configuration Drift Management and select Drift
Console.
Navigation pane
BMC Atrium Core 9.0
Page 1051 of 2268
Home
To access Drift Management from BMC Remedy User

1. Open BMC Remedy User.
The Login dialog box appears.
2. Enter your user name and password, and then click OK.
The BMC Remedy AR System home page form is displayed. If the home page does not
appear:
a. Select Tools > Options.
b. In the Options dialog box, click the Home page tab.
c. Select the check box to open the home page automatically.
3. Click one of the Drift Management links in the navigation pane: Drift Dashboard or Drift
Console.
Example scenario
You want to know whether your hardware or software assets (CIs) are the same today as they were
last week. You want to determine whether drift has occurred.
To do this, you first create a snapshot (copy) of your BMC Asset dataset at a point in time, for
example, Monday morning. This snapshot is used to create a baseline.
At a later time (for example, Friday morning), you create a target using the current state of your
BMC Asset dataset. This data becomes your target.
You then create and run a comparison job to compare the current state of your BMC Asset dataset
(target) with the Monday morning snapshot (baseline) to determine whether changes occurred
during the week (drift).
Step 1: Create a snapshot job
Step 2: Create a baseline
Step 3: Create a target
Step 4: Create a comparison job
BMC Atrium Core 9.0
Page 1052 of 2268
Home
Step 5: View detected drifts
Step 1: Create a snapshot job

Use the Snapshot Job Wizard to make a copy (snapshot) of part of your BMC Asset dataset (
source) and store in a destination dataset. You reduce the number of CIs that are copied from the
BMC Asset dataset source to the destination dataset by applying a qualification set to the source
data. This is accomplished by using the Drift Management Qualification Builder, which is included in
the Snapshot Job Wizard workflow. At the end of this step, you will have a copy of your assets (CIs)
at a given point in time.
Important
For this quick start, unless otherwise specified, use the default options provided.
For more information about creating snapshots, see Creating snapshots.
To create a snapshot
1. From the Drift Management navigation pane, select Management > Job Console.
2. From the Job Console, click Create.
3. For Specify Type of Job, select Snapshot Job.
The Snapshot Job Wizard appears.
4. From the Specify General Information pane, specify a name (for example, MySnapshotJob)
and description for the snapshot job.
5. Click Next.
6. From the Specify a Destination Dataset pane, select Create to create a destination dataset (
for example, MySnapshotDataset), and then click Next.
This is the dataset to which you will copy your BMC Asset data.
7. From the Specify Source Dataset pane, select a source dataset (BMC Asset), and then click
Next.
8. From the Select Source Qualification Set pane, specify a qualification set to apply to the
source dataset to narrow the number of CIs to be copied. (At this point, you do not have any
existing qualification sets to select, so you need to create one.)
a. Click Create.
The Qualification Builder is displayed.
b. Specify a name (for example, MySnapshotQualification) and description for the
qualification set.
c. For Qualification Set, select Custom Qualification Set from the menu.
d. From the Select Class Name menu, select BMC_ComputerSystem.
Selecting a class for a qualification set
BMC Atrium Core 9.0
Page 1053 of 2268
d.
Home
This narrows the data by selecting one class from BMC Asset.
e. Click Save & Close.
The Qualification Builder closes and the details of the qualification set you created are
displayed on the Snapshot Job Wizard pane.
f. Click Next.
9. Click Done to skip setting a schedule for the job. (Later, you are instructed to start the job
manually from the Job Console after the snapshot job is created.)
The Job Console appears and your newly created snapshot job is listed.
10. Select the job and click Start Job.
11. On the Job Console, click Refresh to view the status of the job in the Job Run History pane.
You have completed creating a snapshot and have copied a class of CIs from BMC Asset
into My Snapshot Dataset. You do not need to wait for the snapshot to complete, before
continuing to the next step.
Step 2: Create a baseline

When you use the Baseline Wizard, the snapshot of data you created (My Snapshot Dataset)
becomes the source for the baseline you must create for the comparison job.
In addition, by using the Qualification Builder, which is in the Baseline Wizard workflow, you can
further refine the number of CIs by adding additional qualifications and defining which CI attributes
to compare (exclude and include sets).
Important
For more information about creating a baseline, see Creating baselines.
To create a baseline
1. From the Drift Management navigation pane, select Authoring > Baselines.
The Baselines List of Items appears. (This pane is empty until you create and save some
baselines.) After you create a baseline, it is saved in a baseline library, available for use in
other comparison jobs.
2. Click Create.
The Baseline Wizard is displayed.
3. Specify a name (for example, MyBaseline) and description for your baseline, and then click
Next.
4. Select a source dataset to use for the baseline, and then click Next.
Use the My Snapshot Dataset you created in Step 1: Create a snapshot job .
5.
BMC Atrium Core 9.0
Page 1054 of 2268
Home
5. Provide a qualification set to apply to My Snapshot Dataset.

a. Click Create.
b. Provide a name (for example, MyBaselineQualification) and description for the
qualification set.
c. Accept all defaults, including All Objects.
All Objects means all CIs in the My Snapshot Dataset are used in the comparison job.
d. Click Save & Close.
The Qualification Builder closes and the details of the qualification set you created are
displayed on the Baseline Wizard pane.
e. Click Next.
6. Click Next to skip Specify an Include Set.
7. Click Done to skip Specify an Exclude Set. The Baselines List of Items appears and your
newly created baseline is listed.
You will use this baseline later when creating a comparison job. If you select Authoring >
Qualification Sets, you will see My Baseline Qualification listed.
Step 3: Create a target

Use the Target Wizard to create a target set of CIs of your configuration data in its current state.
This target is later used in a comparison job.
You can refine your target by creating qualification sets using the Qualification Builder in the Target
Wizard workflow.
Important
For more information about creating a target, see Creating targets.
To create a target
1. From the navigation pane of Drift Management, select Authoring > Targets.
The Targets List of Items appears. (This pane is empty until you create and save some
targets.) After you create a target, it is saved here in a target library, available for use in
other comparison jobs.
2. Click Create.
The Target Wizard is displayed.
3. Provide a name (such as MyTarget) and description for your target, and then click Next.
4. Specify a source dataset, and then click Next.
Select the BMC Asset dataset to compare your configuration data in its current state to a
prior state (the snapshot data created in a previous step that is now your baseline).
5.
BMC Atrium Core 9.0
Page 1055 of 2268
Home
5. Provide a qualification set for the target.

a. Click Select.
The Qualification Sets List of Items is displayed.
b. Highlight MySnapshotQualification, and then click Select Item.
Details of the qualification set you selected are displayed on the Target Wizard pane.
6. Click Done. The Targets List of Items pane appears and your newly created target is listed.
You are now ready to compare your two sets of CIs, using a comparison job, your target (
MyTarget) to your baseline (MyBaseline).
Step 4: Create a comparison job

To assure you will see drift at the end of the quick start, before beginning the steps to create a
comparison job, follow the steps in the following section.
Before continuing the quick start

Because you are probably doing this quick start in one session, before continuing you must make a
change to a CI to assure a drift is visible at the end of this exercise. You will simulate a CI change
by changing the owner of a CI instance in the BMC_ComputerSystem class. For more information
about Atrium Explorer, see Using.
To modify a computer system CI

1. Access the BMC Atrium Core Console.
2. Open Atrium Explorer.
3. Open the Find section of the navigation pane to view the Query list.
4. In the Query list, select the arrow next to Computers.
A list of variable qualifications expands.
5. Click Search.
6. From the list of query results, drag a CI to the display pane.
7. BMC Asset is not an editable dataset. BMC Atrium CMDB provides a sandbox dataset that
allows you to make changes before propagating those changes to BMC Asset.
a. In the display pane, right-click the CI and select Copy to Sandbox.
b. In the Select View dialog box, leave the default values and click OK.
A new view containing the CI is opened in the display pane.
8. Right-click the CI and select Edit.
The BMC_ComputerSystem class form opens in a new window.
9. Change the value of the OwnerName attribute to BMC Quick Start.
11. In Atrium Explorer toolbar, click the Promote Sandbox Changes icon.
A Reconciliation Engine job propagates the change in the Sandbox dataset to the BMC
Asset dataset.
12. After the promote action has completed, click OK in the dialog box, and then close Atrium
Explorer.
You can now continue the quick start and create a comparison job.
BMC Atrium Core 9.0
Page 1056 of 2268
Home
Creating a comparison job

Use the Comparison Job Wizard to create a comparison job to compare MyBaseline and MyTarget.
If the comparison job detects any additions, deletions, or modifications of the target CIs, as
compared to the baseline CIs, a Drift Report is generated and displayed on the Drift Console. If no
drift is detected, a Drift Report is not generated.
From the Comparison Job Wizard, you determine the type of comparison to apply to the CIs in the
baseline and target: 1:1, 1:many, compare normal, or compare recursive. In a 1:1 comparison,
each CI in the target is compared against the corresponding CI in the baseline.
Important
For more information about creating jobs and the comparison types, see Creating and managing
comparison jobs.
To create a comparison job

1. From Drift Management, select Management > Job Console.
2. From the Job Console, click Create.
3. For Specify Type of Job, select Comparison Job.
The Comparison Job Wizard appears.
4. For General Information, do the following steps:
a. Enter a job name (such as MyComparisonJob) and description.
b. Verify that the Comparison Type options are not selected.
The default values, which are not visible on the pane, are one-to-one and compare
regular.
c. Click Next.
5. Select a target for the comparison job.
a. On the Specify a Target pane, click Select Target.
b. From the Targets List of Items, highlight MyTarget and click Select Item.
The target pane appears, displaying the details of MyTarget.
c. Click Next.
6. Select a baseline for the comparison job.
a. On the Specify a Baseline pane, click Select Baseline.
b. From the Baseline List of Items, highlight MyBaseline and click Select Item.
The baseline pane appears, displaying the details of MyBaseline.
c. Click Next.
7. Click Next to skip Specify an Incident Template.
8. Click Done to skip Schedule.
The comparison job you created is displayed on the Job Console under Jobs.
9. Select the comparison job and click Start Job.
10.
BMC Atrium Core 9.0
Page 1057 of 2268
Home
10. On the Job Console, click Refresh to view the status of the job in the Job Run History pane.
The Status Description column displays the current status of the job. Upon successful
completion of the job, a message is displayed, indicating a Drift Report was generated and
the number of CIs affected.
11. To view the Drift Report, click View Drift.
The Drift Console is displayed, showing details about the detected drift.
Step 5: View detected drifts

When the comparison job detects a difference between the baseline and target CIs, this is a drift.
All detected drifts are displayed in the Drift Console.
To view drifts
To view drifts using the Drift Console, select Management > Drift Console.
For information about viewing the displayed drift data from the Drift Console, see Viewing
Drift Reports or read Help.
To view drifts using the Drift Dashboard, select Management > Dashboard > Executive
Overview.
For information about viewing the displayed drift data from the Dashboard, see Viewing Drift
Reports from the Drift Dashboard or read Help.
Creating snapshots
This topic describes how to use the Drift Management Snapshot Job Wizard to create a snapshot (
copy) of your configuration management data directly from BMC Atrium CMDB.
About snapshots
Overview of snapshot steps
Creating a snapshot job
Modifying or deleting a snapshot job
About snapshots
A snapshot is a full or partial copy of CIs and their relationships from one dataset to an auxiliary or
destination dataset. A snapshot can be used to store the current state of the production dataset (for
example, BMC Asset) at a particular point in time. You can create multiple snapshots of the
production dataset over a period of time. The snapshot is usually stored in its own dataset within
BMC Atrium CMDB. This captured data is later used, depending on your particular scenario for
detecting drift, as your baseline or target data in a comparison job.
For a scenario about how to use snapshots, see Getting started with Drift Management.
Important
BMC Atrium Core 9.0
Page 1058 of 2268
Home
You must have Drift Master privileges to create, edit, and delete snapshot jobs.
Using an existing destination dataset

The destination dataset is where you want to copy the snapshot data.
When copying to an existing destination dataset that contains data from a previous snapshot job,
use the following guidelines:
Existing CIs that match the currently used qualification set are overwritten.
If a CI matching the qualification set does not exist in the destination dataset, the CI is added
to the dataset.
The remaining CIs are untouched. They are not removed from the destination dataset.
You also have the option of using the BMC Atrium CMDB Delete Dataset or Purge Dataset
activities to clean out the destination dataset before running the next snapshot job. For more
information, see Administering.
Creating a snapshot guidelines

The Drift Management snapshot function copies your configuration data using the following
guidelines:
If the Copy Child CIs option is selected on the Snapshot Job Wizard, the parent CI and only
weak relationships are copied.
This means if the CI is the source member of a weak relationship, the destination member
and the relationship between them are also copied. Because this action is recursive, all
weak relationships and their members below the selected CI are copied.
If the Copy Child CIs option is not selected, only the CIs selected by the qualification set (
created in Qualification Builder) are copied.
If the All Objects option is specified in the qualification set, all CIs including weak and strong
relationships, are copied from the source dataset to the destination dataset. When the All
Objects option is selected, the Copy Child CI option on the Snapshot Job Wizard becomes
irrelevant.
If the Custom Qualification Set option is specified in the qualification set, only the selected
CIs are copied. If the Copy Child CI option is selected, on the Snapshot Job Wizard, weak
relationships are copied as well.
The snapshot function copies all CIs, including those that have not been given a
reconciliation identity.
Overview of snapshot steps

You create a snapshot of your configuration data by creating a snapshot job using the Snapshot
Job Wizard. An overview of the steps for creating a snapshot job follows. Each step is described in
detail in subsequent sections.
1.
BMC Atrium Core 9.0
Page 1059 of 2268
Home
1. Using the Drift Management Snapshot Job Wizard, provide general information (such as
name, description, status, and permissions) about your snapshot job.
2. Create or select a destination dataset to which you want to copy your snapshot data.
3. Provide a source dataset from which you copy the configuration data CIs of interest and their
relationships.
4. Create or select a qualification set to narrow the number of CIs in the snapshot. To do this,
use the Drift Management Qualification Builder, which is included in the Snapshot Job
Wizard workflow.
5. (Optional) Assign a schedule for running the snapshot job.
Creating a snapshot job

A Snapshot Job Wizard is provided for easy creation of snapshot jobs and is accessed through the
Drift Management Job Console. The Job Console is described in About the Job Console.
To access the Snapshot Job Wizard

1. From the Drift Management navigation pane, click Job Console.
The Job Console is displayed.
2. Click Create.
3. From the Specify Type of Job dialog box, select Snapshot Job.
The Snapshot Job Wizard appears.
To create a snapshot job

1. Provide the following general information about the snapshot job, and then click Next.
General information options for snapshot job
Field
Description
Name and
Description
Provides a meaningful name and description for the job.
Status
Indicates if the job can be executed. Two options exist:

Active (default)--Choose Active if you want the job to run. The job can be submitted manually (Start
Job) or set to run on a schedule.
Inactive--Choose Inactive if you do not want the job to run. For example, you might make a job
inactive after several runs, but you want to keep it around for historical or record keeping purposes.
If later you need to run the job, you can change the status to Active.
For information about modifying a job, see Modifying or deleting a snapshot job.
Accessible
To
Specifies the permission group(s) that can see the job on the Job Console. In conjunction with role
permissions, this field determines who can view, execute, modify, and delete the job. For example, if this
field is set to Drift Master, all users belonging to the Drift Master group can see the job and only they have
execution privileges. ( Execution privileges are controlled by who can see the job. If you do not see a job
displayed, you do not have permission to execute the job.) More than one group can be specified. You can
delete the default (Public). For more information about Drift Management roles and permissions, see
Managing Drift Management permissions.
Copy Child
CIs
Copies the selected CI (parent) and all weakly related child CIs.
2.
BMC Atrium Core 9.0
Page 1060 of 2268
Home
2. From the Specify Destination Dataset pane, provide a dataset to which to copy your
snapshot data, and then click Next.
a. Select an existing destination dataset or create a new destination dataset.
If you select an existing dataset, the Dataset Name menu is populated from
BMC Atrium CMDB and the dataset names displayed depend on your Drift
Management permissions.
If you create a new dataset, enter the dataset name. The destination dataset is
created when the snapshot job runs (not when the snapshot job is created) and
is saved in BMC Atrium CMDB for reuse in a future run of the snapshot job.
There are no special constraints when naming datasets, however, it is
suggested you follow BMC Atrium CMDB naming conventions.
b. In the Accessible To: field, specify the permission groups who can see the destination
dataset.
More than one group can be specified. You can delete the default (Public).
Permissions to see the contents of the destination dataset are controlled by BMC
Atrium CMDB permissions and any additional permissions you applied using instance
permissions, as described in Managing Drift Management permissions .
3. From the Specify Source Dataset pane, provide a source dataset from which to copy your
snapshot data, and then click Next.
Your source dataset can come from a variety of data sources: BMC Asset, BMC
Configuration Import, BMC Topology Import, a backup or archive, or another snapshot
dataset. Only datasets you have permission to view are displayed.
Warning
If you create a dataset, using the Reconciliation Console, to use as the source
dataset for a snapshot, baseline, or target, you must add Drift Master permissions
to the CMDBRowLevelSecurity attribute of the dataset for the dataset to be visible
from the Snapshot Job, Baseline, or Target Wizards.
The menu is populated from BMC Atrium CMDB, which has a list of all available datasets.
The dataset names displayed are based on your Drift Management permissions. As a result,
different users might see different dataset names.
4. From the Specify Source Qualification Set, specify a qualification set to apply to the source
dataset to narrow the number of CIs of interest. Perform one of the following actions:
Creating or specifying a qualification set
Action
Instruction
Create a
new
qualification
set
Use the Qualification Builder Help or follow the instructions in Creating qualification sets and include and
exclude sets to create a new qualification set to apply to the source dataset. Saving the qualification
returns you to the Select Source Qualification Set pane and the details of the qualification set are
displayed.
BMC Atrium Core 9.0
Page 1061 of 2268
Home
Action
Instruction
Select an
existing
The List of Items displays the available qualification sets. Select the qualification set you want to use and
click Select Item. The Select Source Qualification Set screen appears and the details of the qualification
qualification
set
are displayed.
5. (Optional) Assign a schedule for running the snapshot job by clicking Time Driven and
specifying the days of week and time.
Skip this step if you are not providing an automatic run schedule for the job. After the job is
created, you can manually start the job from the Job Console by clicking Start Job.
Important
If you assign a schedule, the destination dataset is overwritten with each job run.
6. Click Done.
The job you created appears in the Job Console.
Modifying or deleting a snapshot job

You must be the owner of the job or have the appropriate role and group permissions to modify or
delete a snapshot job.
You can quickly modify or update the components of an existing snapshot job instead of creating a
new job from scratch.
If you modify a job and run it, the job runs using the access permissions of the owner. These
permissions may not be consistent with your permissions and the job may fail or the job results may
vary.
Note
Deleting a snapshot job deletes only the job information from the Drift Job Console,
including all previous runs of the job from the Job Run History pane. Deleting the
snapshot job does not delete the destination dataset created by the snapshot job. For
more information about the destination dataset, see Using an existing destination dataset.
To modify a snapshot job

1. Select Job Console > Jobs, and then select the snapshot job you want to modify.
2. Click Edit.
3. Using the Snapshot Job Wizard, make your changes. The Job Console Details pane is
updated to display the date the job was last modified and who made the modification.
BMC Atrium Core 9.0
Page 1062 of 2268
Home
To delete a snapshot job

1. Select Job Console > Jobs, and then select the snapshot job you want to delete.
2. Click Delete.
A confirmation dialog box appears.
Creating baselines
To determine whether drift has occurred in your IT environment, you compare two sets of CIs and
their attributes. One set of CIs is identified as a baseline representing a known or correct state and
the other set of CIs is identified as targets that you compare to the baseline.
This section describes how to create a baseline.
About baselines
Overview of baseline steps
Creating a baseline
Modifying or deleting a baseline
About baselines
A baseline, according to ITIL , is the recorded state of something at a specific point in time. This
baseline is the correct configuration for your IT infrastructure. For Drift Management, a baseline
defines a set of CIs, their relationship across classes and associated attributes, used as the basis
for comparison to detect drifts in your IT environment. Simply stated, a baseline is the basis for
comparison with other CIs.
Baselines are stored in BMC Remedy AR System tables, not in BMC Atrium CMDB.
Important
You must have Drift Master privileges to create, edit, and delete baselines.
Overview of baseline steps

An overview of the steps required for creating a baseline follows.
1. Using the Drift Management Baseline Wizard, associate a name, description, and access (
permission) groups for your baseline.
2. Specify the name of the source dataset that contains your designated baseline CIs.
3. Specify a qualification set to narrow the number of CIs in the baseline. To do this, use the
Drift Management Qualification Builder, which is included in the Baseline Wizard workflow.
4.
BMC Atrium Core 9.0
Page 1063 of 2268
Home
4. (Optional) Specify include and exclude sets to be used as the basis for comparing CI
attributes. You will use the Drift Management Qualification Builder, which is included in the
Baseline Wizard workflow.
Drift Management uses a Qualification Builder to build qualifications that narrow a subset of CIs.
Drift Management also enables you to group several qualifications into a qualification set, and
provides the ability to select a set of CIs based on a relationship. For example, you can select the
CIs of computer systems that are related to a particular business service.
Creating a baseline
Use the Baseline Wizard to create a baseline of CIs.
To access the Baseline Wizard

1. From the navigation pane of Drift Management, select Authoring > Baselines.
The Baselines List of Items appears. If you have not yet created and saved a baseline, the
List of Items is empty.
2. In the List of Items pane, click Create.
The Baseline Wizard is displayed.
To create a baseline
1. Provide the following information about the baseline you are creating, and then click Next.
Name and Description: A meaningful name and description.
Accessible To: Controls who can see the baseline you are creating.
Note
The access or permission groups assigned through the Accessible To: field
only allow you to view the baseline in a list, not the data contained in the
baseline. Permissions to view the contents of the baseline are controlled by
BMC Atrium CMDB permissions and any additional permissions you applied
using instance permissions as described in Managing Drift Management
permissions.
2. Select a dataset or a snapshot of a dataset, which you previously created using the
Snapshot Job Wizard, and then click Next.
This dataset can be BMC Asset (accessing directly from BMC Atrium CMDB) or any auxiliary
datasets, or it can be a dataset you created when running a snapshot job. Which dataset you
use depends on your particular scenario for detecting drift. Only datasets you have
permission to view are displayed.
Warning
BMC Atrium Core 9.0
Page 1064 of 2268
Home
If you create a dataset using the Reconciliation Console console to use as the
source dataset for a snapshot, baseline, or target, you must add Drift Master
permissions to the CMDBRowLevelSecurity attribute of the dataset for it to be
visible from the Snapshot Job, Baseline, or Target Wizards.
3. Specify the qualification set to apply to the baseline, and then click Next.
You can do this in one of the following ways:
Click Create to create a new qualification set.
The Qualification Builder appears. Use Help or follow the instructions in Creating
qualification sets and include and exclude sets .
Click Select to use an existing qualification set.
The Qualification Sets List of Items appears.
a. Highlight the qualification set you want to use.
Details about the qualification set are displayed, as well as other Drift components
using the qualification set.
b. Click Select Item.
You return to the Specify Qualification Set pane and the details of the selected
qualification set are displayed.
4. (Optional) From the Specify Include Set pane, specify an include set to use with the
qualification set, and then click Next.
Provide an include set by either creating a new set or selecting an existing set.
a. To create a new include set, click Create.
The Qualification Builder appears. Use help or follow the instructions in Creating
qualification sets and include and exclude sets .
b. To use an existing include set, click Select Item.
The Include Sets pane appears.
c. Highlight the include set you want to use.
Details about the include set are displayed as well as other baselines in which the
include set is used.
d. Click Select Item.
You return to the Specify Include Set screen and the details of the selected include
set are displayed.
5. (Optional) From the Specify Exclude Set pane, specify an exclude set to use with the
qualification set, and then click Next.
Specify an exclude set by either creating a new set or selecting an existing set.
a. To create an exclude set, click Create.
Use Help or follow the instructions in Creating qualification sets and include and
exclude sets.
b. To use an existing exclude set, click Select Item.
The Exclude Sets List of Items appears.
c.
BMC Atrium Core 9.0
Page 1065 of 2268
Home
c. Highlight the exclude set you want to use.

Details about the exclude set are displayed, as well as other baselines in which the
exclude set is used.
d. Click Select Item.
You return to the Specify Exclude Set pane and the details of the selected exclude set
are displayed.
6. Click Done.
You return to the Baseline List of Items pane where the baseline you just created is listed.
Modifying or deleting a baseline

To modify or delete a baseline, you must be the owner of the baseline or have the appropriate role
and group permissions. For more information about roles and permissions, see Managing Drift
You can modify the components of an existing baseline instead of creating a baseline from scratch.
You can modify all components of the baseline.
To delete a baseline, you must either delete all jobs using the baseline or modify the jobs to use a
different baseline. You can see which jobs use the baseline in the Job Membership table in the
Baselines List of Items.
To modify a baseline
1. From the navigation pane of Drift Management, select Authoring > Baselines.
2. From the Baselines List of Items pane, select the baseline to modify.
3. Click Edit.
4. Using the Baseline Wizard, make your changes. All console detail screens are updated to
display the date the baseline was last modified and who made the modification.
To delete a baseline
1. From the navigation pane of Drift Management, select Authoring > Baselines, and then
select the baseline you want to delete.
2. Click Delete.
A confirmation dialog box appears.
Creating targets
This section describes how to create a target that you want to compare with a baseline.
About targets
Overview of target steps
Creating a target
Modifying or deleting a target
BMC Atrium Core 9.0
Page 1066 of 2268
Home
About targets
A target defines the set of CIs that you want to compare with a baseline. The target CIs can be
accessed directly from BMC Atrium CMDB or they can be in an auxiliary dataset you created when
running a snapshot job.
Important
You must have Drift Master privileges to create, edit, and delete targets.
Overview of target steps

You create a target using the Target Wizard. Each step is described in detail in subsequent
sections.
1. Using the Target Wizard, provide a name, a description, and access permissions for the
target.
2. Select a source dataset name containing your target CIs.
3. Specify a qualification set to narrow the CIs of interest in the target, using the Drift
Management Qualification Builder, which is included in the Target Wizard workflow.
Important
Include and exclude sets are selected only in the Baseline Wizard.
Creating a target
The steps for creating a target are similar to the steps used to create a baseline. For targets, you
are primarily interested in the current state of your CIs. When defining your target, select items that
are consistent with the baseline. For example, do not try to compare a Windows computer in a
target with UNIX computers in a baseline.
To access the Target Wizard

1. From the left navigation pane of Drift Management, select Authoring > Targets.
2. On the Target List of Items, click Create.
The Target Wizard is displayed.
To create a target
1. Provide the following information, and then click Next.
Name and Description--A meaningful name and description for the target set of CIs
you are defining.
BMC Atrium Core 9.0
Page 1067 of 2268
1.
Home
Accessible To--Controls who can later view, execute, modify, and delete the target.
Note
Groups assigned using the Accessible To: field allow you to see only the
target listed, but not the target contents. Permissions to see the contents of
the target are controlled by BMC Atrium CMDB permissions and any
additional permissions you applied using instance permissions as described
in Managing Drift Management permissions.
2. From the Select a Dataset pane, select a dataset, and then click Next.
This dataset can be BMC Asset (accessing directly from BMC Atrium CMDB) or any auxiliary
datasets, or it can be a dataset you created when running a snapshot job. Which dataset you
use depends on your particular scenario for detecting drift. Only datasets you have
permission to view are displayed.
Warning
If you create a dataset, using the Reconciliation Console, to use as the source
dataset for a snapshot, baseline, or target, you must add Drift Master permissions
to the CMDBRowLevelSecurity attribute of the dataset for it to be visible from the
Snapshot Job, Baseline, or Target Wizards.
3. From the Specify a Qualification Set pane, specify a qualification set to apply to the target.
Do one of the following actions:
To create a new qualification set, click Create.
The Qualification Builder appears. Use the Qualification Builder help or follow the
instructions in Creating qualification sets and include and exclude sets to create a
new qualification set to apply to the target.
Saving the qualification returns you to the Specify a Qualification Set pane and the
details of the qualification set are displayed.
To select an existing qualification set, click Select.
The List of Items displays the available qualification sets.
Select the qualification set you want to use and click Select Item.
The Specify a Qualification Set screen appears and the details of the Qualification set
are displayed.
4. Click Done.
You return to the Targets List of Items and the target you created is listed.
BMC Atrium Core 9.0
Page 1068 of 2268
Home
Modifying or deleting a target

You must be the owner of the target or have the appropriate role and group permissions to modify
or delete a target. For more information, see Installing BMC Configuration Drift Management.
You can quickly modify or update the components of an existing target instead of creating a new
one from scratch. You can modify all components of the target.
A target can be deleted easily if it is not used in a comparison job. To delete a target that is part of
a job, you must either delete all jobs using the target, or modify the jobs to use a different target.
You can view the job in which the target is used from the Job Membership pane in the Targets List
of Items.
To modify a target
1. From the navigation pane of Drift Management, select Authoring > Targets, and then select
the target you want to modify.
2. Click Edit.
3. Using the Target Wizard, make your changes. All screens are updated to display the date
the job was last modified and who made the modification.
To delete a target
1. From the navigation pane of Drift Management, select Authoring > Targets, and then select
the target you want to delete.
2. Click Delete.
Creating qualification sets and include and exclude sets

This topic describes how to use the Qualification Builder to create qualifications sets, exclude sets,
and include sets.
About Qualification Builder
About qualification sets
Include and exclude sets
About include sets
About exclude sets
About Qualification Builder

The Qualification Builder is the Drift Management tool used to interactively create queries in the
form of qualifications sets, include sets, and exclude sets.
Qualification sets allow you to specify a single CI or groups of CIs and are used in snapshot jobs,
baselines, and targets. When a qualification set is applied to a dataset specified for a snapshot job,
BMC Atrium Core 9.0
Page 1069 of 2268
Home
all CIs matching the query are included in the snapshot. When a qualification set is applied to a
dataset of CIs specified for a baseline or target, all CIs matching the query are included in the
comparison job that uses the baseline or target.
Include sets enable you to specify attributes that should be included in the Drift Report if drift is
detected. Include sets are managed as part of the baseline.
Exclude sets allow you to specify which attributes should not be included in the Drift Report if drift is
detected. Exclude sets are also managed as part of the baseline. The use of include and exclude
sets is optional.
Each qualification, include, and exclude set you create is saved in BMC Remedy AR System data
forms.
Important
You must have Drift Master privileges to create, edit, and delete qualification sets, include
sets, and exclude sets.

Accessing Qualification Builder
Creating a qualification set
AND or OR
Guidelines for qualification set option selection
Accessing Qualification Builder

Access Qualification Builder from the Authoring menu item of Drift Management by choosing any
one of the following options: Qualification Sets, Include Sets, or Exclude Sets.
The Qualification Builder is also accessible from the Snapshot Job, Baseline, and Target Wizards,
allowing you to create qualification, include, and exclude sets as part of the wizard workflow.
Using the Authoring menu item gives you the option of creating your qualification, include, or
exclude sets before using the Snapshot Job, Baseline, and Target Wizards.
To access Qualification Builder for qualifications sets

1. Select Authoring > Qualification Sets.
The Qualification Sets List of Items is displayed. This is a library of previous created and
saved qualifications sets that you can reuse.
BMC Atrium Core 9.0
Page 1070 of 2268
Home
The Details pane displays information, such as the owner of the qualification set and what
group can access or view the qualification.
The Baseline, Target, and Job Membership pane shows which baseline, target, or snapshot
job uses the qualification set.
2. Click Create.
Creating a qualification set

With Qualification Builder, you can create a qualification set containing several selected classes,
related classes, and their attributes. To support this functionality, a qualification set can be
comprised of one or more qualifications. In turn, each qualification can contain one or more
qualification entries. A qualification entry consists of a class name, and may include related classes
and attributes.
This section provides a quick introduction to the Qualification Builder by describing how to:
Create a qualification set using the All Objects option. This option specifies that all classes,
all CI instances, and all attributes in your snapshot job, baseline, or target source datasets
should be used.
Create a qualification set using the Custom Qualification option. This option allows you to
specify which CI instances you want to use in your source datasets based on a qualification.
To create a qualification set using the All Objects option

1. Provide a meaningful name and description for the qualification set.
2. Specify the access groups that can use this qualification set.
3. For Qualification Set, select All Objects.
All Objects is the default qualification build method. The qualification set is defined.
4. Click Save & Close.
The new qualification set is displayed on the Qualification Sets List of Items pane. Later
when you build a baseline, target, or snapshot job, you can apply this qualification to the
dataset you are using for your baseline, target or snapshot CIs.
To create a qualification set using the Custom Qualification Set option

1. Provide a name and description for the qualification set.
2. Specify the access groups that can use this qualification set.
3. For Qualification Set, select Custom Qualification Set.
4. From the Select Class Name field, select a class.
When a class is selected, other options are made available from the Select Action field, for
example, Add Attribute and Add Related Class.
The options displayed depend on the item that is selected, which is marked by a green
highlight.
5. From the Select Action field, select Add Attribute.
6.
BMC Atrium Core 9.0
Page 1071 of 2268
Home
6. From the Select Attribute Name field, select an attribute, provide an operator, and enter a
value.
7. Add additional classes and attributes and related classes to your qualification.
8. When your qualification set is defined, click Save & Close.
Your new qualification set appears in the Qualification Sets List of Items.
AND or OR
In a qualification set, the AND conjunction is used between a class and its related classes and
attributes.
The OR conjunction is used between the main classes in the qualification. In the preceding
example, the main classes are BMC_ComputerSystem and BMC_Application.
Guidelines for qualification set option selection

Be aware of the following option selection behavior when using the Qualification Builder. Similar
behavior is provided for include and exclude sets.
The Delete Selected Class option is only available if there is more than one main class
because a qualification must have at least one class. This option is always available for a
related class, whether it is selected or not.
The Add Attribute and Add Related Class options are not available until the class is selected.
The Delete Selected Attribute option is always available, whether an attribute is selected or
not.
About qualification sets

The Qualification Builder uses a dynamic tree-like structure for selecting classes and attributes.
You can create multiple levels of classes and each class can have multiple related classes.
Note
Related classes only apply to qualification sets.

Using classes
Guidelines for using classes
Guidelines for using attributes in a qualification set
Best practice
Using classes
The following scenarios are supported.
BMC Atrium Core 9.0
Page 1072 of 2268
Home
Scenario A
Class A has two related classes: Class B and Class C
CLASS A
RELATED TO Class B
RELATED TO Class C
You could also say, Class B and Class C are related to Class A.
Scenario B
Class A has one related class, which in turn, has its own related class.
CLASS A
RELATED TO Class B
RELATED TO Class C
Class A has one related class, Class B and Class B has one related class, Class C.
Scenario C
This scenario is a combination of scenario A and B.
CLASS A
RELATED TO Class B
RELATED TO Class C
RELATED TO Class D
RELATED TO Class E
Class A has two related classes, Class B and Class D, which in turn have their own
related classes.
Guidelines for using classes

Keep the following guidelines in mind when using classes in a qualification set:
Classes can be added in any order.
A new related class can be added anywhere in the tree, but the related class is always
added as the last child of its parent.
Note
You can not reorder classes.
BMC Atrium Core 9.0
Page 1073 of 2268
Home
From each class and related class, any number of attributes, attribute values, and conditions
can be specified.
Related classes apply only to qualifications sets.
When a related class is added to a selected class, the comparison service checks for a
relationship between the two classes. If there is no specific relationship between the two
classes, the comparison service uses the Base Relationship class.
Guidelines for using attributes in a qualification set

Be aware of the following guidelines when using attributes in a qualification set:
A newly added attribute, like related class, is always added as the last child of its parent
class.
The attribute name, operator, and value are mandatory.
The value entered for an attribute must be appropriate for the selected operator.
Valid operators for attributes in a qualification set are as follows.
Operators in a qualification set
Attribute operator
Description
==
equal to, numeric or a string
!=
not equal to, numeric or a string
<
less than, numeric only
>
greater than, numeric only
<=
less than or equal to, numeric only
>=
greater than or equal to, numeric only
LIKE
numeric
string
supports SQL %
IN or NOT IN
numeric
string
comma delimited list
range--the range operator is .. with no spaces before or after. For example, 10..50.
Note
These attribute operator values are only valid in a qualification set. Different
operators are used in an include set.
BMC Atrium Core 9.0
Page 1074 of 2268
Home
Best practice
When creating qualifications sets for the BMC_Product class, be sure to qualify the baseline and
target with the name of the product. Using the name of a product prevents the comparison of unlike
products, for example, comparing Adobe Acrobat Reader with Windows Word.
Qualifications on other CI types should follow a similar approach.
Include and exclude sets

It is important to understand the distinction between qualifications sets and include or exclude sets.
Qualifications are used to narrow the CIs in the baseline or target to a given subset of CIs instances
. These instances reflect the classes and attributes you specified in the qualification set and are
later compared using a comparison job.
Include and exclude sets apply only to CI attributes. Includes and excludes allow you to specify the
attributes that should be included or excluded, thus filtering the number of attributes that are to be
considered for comparison when the comparison job runs.
About include sets

Include sets allow you to manage the results of a comparison job as follows:
Limits the display of drifts detected to only those attributes selected in the include set.
Allows the default comparison operator EQ (equality) to be overridden. When a baseline and
target are compared by the comparison job, the default comparison operator is EQ (equality)
. If the target attribute value does not equal the baseline attribute value, the attribute is
flagged as a drift.
Allows the value of the target attribute to be compared against a value entered by you in the
include attribute fields. By default the target attribute is compared with the baseline attribute.
You can override the default by supplying a value to compare the target attribute with
instead of the baseline attribute value.
Guidelines for using attributes in an include set

Be aware of the following guidelines when using attributes in an include set:
The attribute name and operator are mandatory.
The attribute value is optional. When used, the value must be appropriate for the selected
operator.
The operator options for include sets are: EQ, NE, GT, LT, GE, LE, IN, NOT IN.
If the Boolean expression to evaluate two attributes returns TRUE, then no drift is detected.
If the expression returns FALSE, then the comparison service flags this as a drift and the
attribute is displayed in the Drift Report.
Creating an include set

This section describes how to use the Qualification Builder to create an include set.
BMC Atrium Core 9.0
Page 1075 of 2268
Home
To create an include set

1. Select Authoring > Include Sets.
2. When the Include Set List of Items displays, click Create.
The Qualification Builder for an include set appears.
3. In the Select Class Name field, select a class name.
4. Click Show to display the attributes for this class.
5. Select the attributes to include in the include set, overriding the default comparison operator
and attribute value as needed.
6. Click Close to save the attributes.
7. Click Save & Close to save the include set.
Your new include set appears in the Include Sets List of Items.
Examples
This section provides examples showing how to customize an include set.
Default behavior
Select Class = BMC_ComputerSystem, Attribute = memory, Operator = EQ
The default operator (EQ) is selected. The comparison service compares the memory value of the
target CI to the memory value of the baseline CI. If the values are not equal, the attribute has
drifted and it is displayed in a Drift Report on the Drift Console.
Overriding the default operator

Select Class= BMC_ComputerSystem, Attribute = memory, Operator = LT
The selected operator LT (less than) overrides the default operator (EQ). The comparison service
compare the memory value of the target CI to the memory value of the baseline CI. If the target
attribute value is not less than the baseline attribute value, the attribute is flagged as a drift.
Overriding the default operator and attribute value

Select Class= BMC_ComputerSystem, Attribute = diskcapacity, Operator = GT, Value=20
The selected operator GT (greater than) overrides the default operator (EQ). The user-supplied
Value (20) overrides the baseline value, which means the comparison service uses this value
instead of the baseline value. If the target attribute value is not greater than 20, the attribute is
flagged as a drift.
About exclude sets

Exclude sets are much simpler than include sets. Any attribute selected in an exclude is not
displayed in the Drift Report, thus allowing you to filter the drift results to show only those attributes
of interest. When a comparison job runs and compares the CIs in the baseline and target, excluded
attributes are not used in the comparison.
BMC Atrium Core 9.0
Page 1076 of 2268
Home
Scenario
The following scenario illustrates when using an exclude set would be useful. When you are
comparing your business criteria computers (targets) to a computer (baseline) that is configured
exactly as needed for the business, the computer name of each target differs from the computer
name of the baseline. This is flagged as a drift. Excluding the computer name attribute would filter
its display as a drift in the Drift Report.
Creating an exclude set

This section describes how to use the Qualification Builder to create an exclude set.
To create an exclude set

1. Select Authoring > Exclude Sets.
2. When the Exclude Set List of Items displays, click Create.
The Qualification Builder for an exclude set is displayed.
3. Select a class name.
4. Click Show, to see a list of all the attributes for the class.
5. Select the attributes to exclude, and then click Close.
You can add additional classes to your exclude set with attributes selected for exclusion.
6. When finished, click Save & Close.
Guidelines for exclude sets

Keep the following guidelines in mind when creating an exclude set:
Use an exclude set when you want to include most attributes but not all in the comparison.
You can specify which attributes to ignore (exclude) by using an exclude set.
Using only an exclude set (no include set) to specify the attributes to be displayed in the Drift
Report, is equivalent to including all attributes but excluding what is specified.
An exclude set takes precedence over an include set. For example, if you are using both an
include set and an exclude set and the exact same attribute is specified in both, the result is
that no attribute is selected.
For an exclude set, selecting attributes is optional. If no attributes are selected for an
exclude, then no attributes for the class are used in the comparison.
Creating and managing comparison jobs

This topic describes how to create, view, and manage comparison jobs.
About the Job Console
About comparison jobs
Before creating a comparison job
Managing comparison jobs
BMC Atrium Core 9.0
Page 1077 of 2268
Home
About the Job Console

The Job Console is the primary interface for creating new snapshot and comparison jobs, and
checking on existing jobs. It provides a listing of all jobs that have been created.
Job Console
When you select a job in the Jobs pane, details about the job are displayed in the Details and Job
Run History panes.
The Details pane shows information about the job, including the name of the baseline and target
used by the comparison job, date last modified, the current run schedule for the job (if not manual),
and other job actions.
The Job Run History pane displays the run history of the job. You can view more details about a
selected job by clicking the View Log button.
To view details on a detected drift in a job run, you can access the Drift Console from the Job Run
History pane by clicking the View Drift button.
Important
You must have Drift Master or Drift Admin privileges to use the Job Console. Drift Admin
can create and modify jobs, and view and use the authoring items (baseline, target, and
so on). Only Drift Master can create or modify authoring items.
BMC Atrium Core 9.0
Page 1078 of 2268
Home
About comparison jobs

A comparison job identifies and compares the CIs in your target with the CIs in your baseline. The
comparison job identifies which baseline CIs and target CIs to use based on the qualification sets
you provided in the baseline and target that you created earlier. After the CIs for the baseline and
target are uniquely identified, the comparison job compares a list of attributes based on the exclude
and include sets you defined in your baseline. The actual comparison of CIs is performed by
comparing the target CIs and their attributes with the baseline CIs.
In addition to comparing CI attributes, a comparison job can be configured to identify drift in a
relationship between CIs by comparing your target set of CIs with your baseline set of CIs.
This section provides the following topics:
Comparison service
Types of comparisons
Combining comparison types
Output of a comparison job (Drift Reports)
Drift types
Comparison service
For detailed information about how the comparison job, and the underlying comparison service,
identifies and compares CIs, see Comparison service.
Types of comparisons
The comparison job performs the following types of comparisons:
Compare Regular (default) - Compares the top level CIs only.
Note
This comparison type is not displayed on the Comparison Job Wizard pane.
Compare Recursively - Compares the top level CIs and their children CIs until there are no
more CIs to compare.
Compare CI Relationships- Compares relationships between target CIs with the
relationships between CIs in the baseline.
Only outward relationships from the source of the relationship to the destination of the
relationship are tracked.
Only relationships of the BMC_BaseRelationship class are compared.
These comparisons can be enhanced by specifying one of the following types of
cardinality for the compare:
BMC Atrium Core 9.0
Page 1079 of 2268
Home
One-to-one (default) - A one-to-one comparison of CIs from the baseline and the target. For
a one-to-one comparison, all CIs must have a ReconciliationIdentity attribute that is
created during a BMC Atrium CMDB reconciliation process. CIs without this attribute are
ignored during a one-to-one comparison.
If comparing relationships between CIs, only one level of relationships are compared.
Note
This cardinality type is not displayed on the Comparison Job Wizard pane.
Many-to-one - A many-to-one comparison of the target CIs with a single CI in the baseline.
You use this option if, for example, you are comparing many CIs with a standard or golden
CI to which all other CIs must conform. For a many-to-one comparison, the CIs are identified
using the Reconciliation Engine rules. If you have more than one CI in the baseline, a
many-to-one comparison will fail.
If comparing relationships, all levels of relationships are compared.
Important
The default comparison performed by Drift Management is a one-to-one
comparison of the top level CIs only.
Combining comparison types

You can combine comparison types in a single comparison job to provide more detailed information
about a drift. For example, you might create a comparison job that combines a Compare
Recursively type with a Compare CI Relationships type to create a very detailed report about the
drift between the CIs and relationships in your target.
Output of a comparison job (Drift Reports)

Any difference in the target as compared with the baseline is considered to be a drift. All drifts
detected by a comparison job are presented as a Drift Report on the Drift Console. A Drift Report
can have one or more drifted CIs. If the comparison job did not detect drift, a Drift Report is not
generated.
All CIs and their relationships that are modified, added, or removed are considered to be detected
drifts and are displayed, depending on the comparison type chosen, as Drift Reports on the Drift
Console as output of a comparison job.
Drift types
A detected drift is classified as one of the following types:
BMC Atrium Core 9.0
Page 1080 of 2268
Home
Added - CI exists in the target dataset of CIs but does not exist in the baseline. A drift of this
type can be the result of the addition of new hardware to the network, addition of memory
added to a computer, or the addition of new software.
Modified - CI in the target has a different attribute value as compared with the attribute
value in the baseline. A drift of this type can be the result of the change in an attribute value.
Removed - CI does not exist in the target set of CIs but does exist in the baseline, for
example, the removal of hardware or memory.
RelationshipDrift - A change in the relationship between CIs in the target set as compared
with the relationship between the same CIs in the baseline set.
In addition, each RelationshipDrift has an associated Drift Type of added, modified, or
removed to show exactly what caused a drift in the relationship.
Before creating a comparison job

Before creating a comparison job, you must create a baseline and a target, using the Baseline and
Target Wizards as described in the following sections:
Creating baselines
Creating targets
After you have created a baseline and target, you wrap the baseline and target together in a
comparison job, select the type of comparison to perform, and add a run schedule (and other
possible job actions), as described in Creating a comparison job.

A Comparison Job Wizard is provided so you can easily create comparison jobs.
To access the Comparison Job Wizard

1. From Drift Management, select Management > Job Console.
2. Click Create.
3. From the Specify Type of Job dialog box, select Comparison Job.
The Comparison Job Wizard is displayed.
To create a comparison job

1. Provide the following general information about the comparison job, and then click Next.
General information options for comparison job
Field
Description
Name and
Description
Provides a meaningful name and description for the comparison job.
Priority
Defines the fix priority for drifts detected by the job. The priority selected here is displayed on the Drift
Console for each Drift Report resulting from a run of this job.
Status
Indicates if the job can be executed. Two options exist:
BMC Atrium Core 9.0
Page 1081 of 2268
Home
Field
Description
Active (default)--Use active if you want the job to be executed. The job can be submitted manually
(Start Job) or set to run on a schedule using the Comparison Job Wizard.
Inactive--Use inactive if you do not want the job to be executed. For example, you might make a
job inactive after several runs, but you want to keep it around for historical or record-keeping
purposes. If later you need to run the job, you can change the status to active and submit.
Compare
Recursively
Compares the top level CIs and their children CIs until there are no more CIs to compare. The default
comparison type is Compare Regular, not shown on the wizard pane, which only compares the top level
CIs.) For additional information about compare recursively and one-to-many, see Types of comparisons .
Many-to-One
Provides a many-to-one comparison of CIs from the target to the baseline. The default cardinality is a
one-to-one comparison (not shown on the wizard pane.)
Compare CI
Relationships
Compares the relationship between CIs. For additional information about comparing CI relationships, see
Types of comparisons and Combining comparison types.
Accessible
To
Specifies the groups that can have access to this job. For more information about permissions, see
Managing Drift Management permissions .
2. Select a target for the comparison job, and then click Next.
Note
If you have not created a target for this job, do so now as described in Creating
targets .
a. From the Target pane, click Select Target.

b. From the Targets List of Items, highlight the target you want to use.
In the Details and Job Membership panes, details about the target are displayed, as
well as a list of other jobs using this target.
c. Click Select Item.
The target pane of the wizard appears, displaying the details of the target you
selected.
3. Provide a baseline for the comparison job, and then click Next.
Note
If you have not created a baseline set of CIs for this job, do so now as described in
Creating baselines.
a. From the Baseline pane, click Select Baseline.

b. From the Baselines List of Items, select the baseline you want to use, and then click
Select Item.
4.
BMC Atrium Core 9.0
Page 1082 of 2268
Home
4. (Optional) Create an (automatic) incident request ticket.

If you want the comparison job to create an incident request ticket (if drift is detected), enter
the following information, and then click Next. Otherwise, just click Next to continue.
a. From the Incident pane, click Select Incident Template.
b. Select the appropriate template (software or hardware), and then click Select.
The Comparison Job Wizard Incident pane appears, displaying the details of the
incident template you selected.
5. (Optional) Assign a schedule for running the job.
If you do not want to provide an automatic run schedule for the job, you can skip this step. (
After the job is created, you can manually start the job from the Job Console by clicking Start
Job.)
6. Click Done.
The job appears on the Job Console as the first entry in the Jobs pane list.
Managing comparison jobs

After a comparison job is created, the job is displayed on the Job Console. This section describes
the tasks you can perform from the Job Console.
Canceling a job
Checking the status of a job
Modifying or deleting a job
Scheduling a job
Viewing job details
Viewing job history, job logs, and Drift Reports
Canceling a job
To cancel a job, select the job from the Jobs pane and click Cancel Job. A job must be running to
cancel it.
Checking the status of a job

Check the status of a job in the Jobs pane. Click Refresh to refresh the Jobs pane.
The Last Job Run Status column displays one of the following job run statuses: canceled, failed,
running, successful.
Modifying or deleting a job

To modify or delete a job or job run, you must be the owner of the job or have the appropriate role
and group permissions. For more information about roles and permissions, see Managing Drift
If you modify a job and run it, the job runs using the access permissions of the owner. These
permissions may not be consistent with your permissions and the job may fail or the job results may
vary.
BMC Atrium Core 9.0
Page 1083 of 2268
Home
Deleting a job deletes all job runs and Drift Reports generated by the job. This action does not
delete the baseline, target, or qualification sets associated with the job because those might be
used in another job.
To modify a job
1. On the Job Console, select the job you want to modify, and then click Edit.
2. Using the Comparison Job Wizard, make your changes, and then click Done. You can
modify the information on all screens including the addition of a job schedule to a job that did
not have one previously.
The Job Console Details pane is updated to display the date the job was last modified and
who made the modification.
To delete a job
On the Job Console, select the job you want to delete, and then click Delete.
To delete a job run

On the Job Console, select the job run in the Job Run History pane and click Delete.
This action deletes the job run and the Drift Report, if any, associated with the job run.
Scheduling a job
You can schedule a comparison job using one of the following methods:
Manually
Time Driven
Manually
If you did not configure the job to run automatically, you can start the job manually from the Job
Console by clicking Start Job.
Time driven
When using a time driven schedule, the job is triggered based on the time zone of the BMC
Remedy AR System server host computer. If the BMC Remedy AR System client is running in a
different time zone, the time you specify is adjusted accordingly.
Viewing job details

From the Job Console, select the job you want to view. The details of the job are displayed in the
Details pane.
Details pane
BMC Atrium Core 9.0
Page 1084 of 2268
Home
The Details pane shows information about the job, including the target and baseline used by the job
. You can view those in more detail by selecting View Target or View Baseline.
Viewing job history, job logs, and Drift Reports
Note
You can use the Job Run History options with Drift Viewer privileges.
1. From the Jobs pane, select a job.

Previous runs of the job are displayed in the Job Run History pane.
Job Run History pane
2. Select the job run.

3. To view the Drift Reports created by a comparison job, click View Drift.
The View Drift button is available only if a snapshot job is selected.
The Drift Console displays the Drift Reports associated with the job run.
4. To view the comparison job log, click View Log, and then select the status Log file and click
Display or Save to Disk.
Viewing Drift Reports

This topic describes how to view Drift Reports and their associated details using the Drift Console.
About the Drift Console
Viewing the Drift Console data
Viewing the details of a Drift Report
Managing or remediating drifts
BMC Atrium Core 9.0
Page 1085 of 2268
Home
About the Drift Console

The Drift Console is the primary interface for viewing and taking actions to manage or resolve drifts.
The console is used by the individual responsible for maintaining the data center environment, or
their portion of it, at a known or correct state. The Drift Console might also be used to view the
details of a drift displayed in the Drift Dashboard.
The Drift Console provides drift information at a more detailed level than the Drift Dashboard by
listing detailed information about each drift, such as, the type and priority of the drift and the
number, name, and attributes of the CIs affected by the drift.
When you access the Drift Console, all detected drifts from all of your comparison jobs are
displayed. Each time you refresh the Drift Console, any new Drift Reports created by running
comparison jobs are displayed.
Viewing the Drift Console data

When a comparison job runs, and if drift is detected, the results are presented as a Drift Report on
the Drift Console. One Drift Report is generated per comparison job. A Drift Report shows details
about the detected drift, such as the number of CIs and attributes affected and the type of drift
detected. In addition, if you are using BMC Remedy Change Management or BMC Remedy
Incident Management, detailed information correlating a drift to a change request or incident is also
shown.
A Drift Report is created only if a drift is detected. If you run a comparison job and no drifts were
detected, there is no Drift Report.
Important
You must have Drift Master, Drift Admin, or Drift Viewer privileges to use the following
features: View Details, View Job, View Baseline, and View Target.

Searching Drift Reports and Drift Report details
Viewing Comparison Job details
Viewing Baselines and Targets
Deleting a Drift Report
Refreshing the data
Drift Reports in the Drift Console
BMC Atrium Core 9.0
Page 1086 of 2268
Home

The Drift Reports pane displays a list of Drift Reports detected by comparison jobs.
The Priority field displays the priority that should be used when remediating the drift and is
assigned when the comparison job is created or modified. The actions that should be taken are
determined by your organization.
Searching Drift Reports and Drift Report details

You can search for specific Drift Reports or Drift Report Details or you can filter the number of
reports displayed on the Drift Console. The search categories are populated from data stored in the
BMC Remedy AR System tables. For example, the baselines displayed in the search selection list
are the same baselines displayed in the Authoring > Baselines > List of Items table.
To search or filter Drift Reports or Drift Report Details

1. Do one of the following actions:
On the Drift Console, from the Search Drift Reports By menu, select a search
category.
On the Drift Report Details pane, from the Search Drift Details By menu, select a
search category.
2. From the displayed Selection list dialog box, select a specific search item, and then click
Search.
If you are searching for a change or incident request, you are prompted for the change or
incident ID number.
Only Drift Reports or Drift Report Details for the selected search category are displayed.
BMC Atrium Core 9.0
Page 1087 of 2268
Home
Viewing Comparison Job details

To quickly research the details of a comparison job that generated a Drift Report, select a Drift
Report and take the following actions:
Click View Job to view only that job in the Job Console with associated details.
Click View Baseline to view details about the baseline used in the job.
Click View Target to view details about the target used in the job.
Viewing Baselines and Targets

The View Baseline and View Target panes display details (for example, date created, dataset name
, access groups, and last modified date) about the baseline or target used in the comparison job
selected from the Drift Console.
The name of the qualification set, and optionally include and exclude sets, included in the baseline
or target are listed and low-level details (classes, attributes, and logic) can be viewed by clicking
the View link.
Job Membership lists all other comparison jobs using this baseline.
Deleting a Drift Report
Important
To delete a Drift Report, you must have Drift Master or Drift Admin privileges.
Deleting a Drift Report also deletes all job runs, and associated drift information, for that report.
To delete a Drift Report from the Drift Console, click Delete.
Refreshing the data

The Drift Console is not updated automatically. To refresh the data displayed, click Refresh.
Viewing the details of a Drift Report

You can view the details of a Drift Report in the following ways:
Highlight an entry in Drift Reports. Additional details about the Drift Report are displayed in
the smaller panes at the bottom.
Click the View Details button. The Drift Report Details for the highlighted Drift Report is
displayed.
Viewing Configuration Items
BMC Atrium Core 9.0
Page 1088 of 2268
Home
Viewing the CI in BMC Atrium CMDB

Viewing CI Attributes
To view CI attributes
Viewing drifts on relationships
To view relationship drifts
Viewing business services affected by a drift
Viewing change requests correlated with a drift
To view change requests correlated to a drift
Viewing incident requests correlated to a drift
To view incident requests correlated to a drift
Customizing the Drift Console
Drift Report Details
Viewing Configuration Items

You can view details about CIs showing drift.
1. In the Drift Reports pane of the Drift Console, highlight an entry.
The CIs showing drift are displayed in the Configuration Items (CIs) pane.
2. On the Drift COnsole, click View Details.
The Drift Report Details for the highlighted Drift Report is displayed, showing an expanded
view of the CIs showing drift.
The following table describes the column names and associated data for the CIs pane.
BMC Atrium Core 9.0
Page 1089 of 2268
Home
Description of the CI data

Column
Description
Name
Name of the CI showing drift.
Computer
System
Name
Name of the parent computer system. For example, if a product CI is reflecting drift, this tells you which
computer the product is on.
Drift Type
Determined by comparing the target CI or attribute with the baseline CI or attribute. The types of drift are:
Added--CI is present in the target but not in the baseline.
Removed--CI is present in the baseline but not in the target.
Modified--An attribute value on the target does not match the value in the baseline.
RelationshipDrift--One or more relationships between CIs has changed.
CI
Instance
Class Id
Data model class type of the drifted CI. If a Drift Report shows two CIs named Setting, this column tells you
which class the CIs belong to. For example, one CI belongs to the Class Apache Setting and the other CI
belongs to the Class VMWare Setting.
Viewing the CI in BMC Atrium CMDB
Important
You must have Drift Master or Drift Admin privileges to view the CI in BMC Atrium CMDB.
You can view additional details about the CI showing drift by viewing the CI directly from the BMC
Atrium Core Console. Highlight a CI, and then click View CI in CMDB.
Viewing CI Attributes
When defining your baseline, if you specified CI attributes to be included in the comparison using
the include set, only those attributes showing drift are displayed. If you used the exclude set, only
those attributes not excluded are shown (if they show drift). If you did not specify an include or
exclude set, all attributes showing drift are displayed.
To view CI attributes
1. From the Drift Console, highlight a Drift Report.
2. Click the View Details button.
The Drift Report Details pane is displayed. From the CI Attributes tab, the CI attributes
showing drift are displayed.
The following table describes the column names for attribute data.
Description of Attributes data
Column
Description
Name
Name of the CI attribute that has changed.
Baseline
Value
Expected or correct value of the CI attribute.
BMC Atrium Core 9.0
Page 1090 of 2268
Home
Column
Description
Operator
The comparison operator used to compare attributes. This operator was defined by you in the include set. If
an include set was not defined, then the default operator (EQ) is shown.
Observed
Value of the CI attribute detected by the comparison job.
Value
Status
For each CI attribute showing drift, the status can be one of the following values:
New--The drift is new and cannot be correlated to a change request created from Drift Management. If
the drift is correlated to a change request created outside of Drift Management, the results are shown
in the Change Requests tab.
Addressed--The change request correlated with the drift was created, within Drift Management, to
resolve the drift when found in a previous comparison job.
Acknowledged--The drift is acknowledged using the Drift Console Acknowledge option. For more
information about acknowledging drifts, see Acknowledging a drift.
Viewing drifts on relationships

You can view details about the change in the relationships between CIs. For more information
about relationship drift, see Drift types.
To view relationship drifts

1. From the Drift Console, highlight a Drift Report.
2. Click the View Details button.
The Drift Report Details pane is displayed. From the Relationships tab (lower left), the CI
relationships showing drift are displayed.
Note
The View Details button for relationship drifts is active only when a modified
relationship drift type is selected.
The following table describes the column names for relationship data.
Description of Relationships data
Column
Description
Source Name
The name of the source CI.
Source Class Id
The class to which the source CI belongs.
Destination Name
The name of the destination CI for which a relationship has been added, modified, or removed.
Destination Class Id
The class to which the destination CI belongs.
Relationship Name
The name of the relationship added, modified, or removed.
Relationship Class
Id
The class to which the relationship belongs.
BMC Atrium Core 9.0
Page 1091 of 2268
Home
Column
Description
Drift Type
The type of drift, either Added, Modified, or Removed.
Viewing business services affected by a drift
Important
You must have Drift Master, Drift Admin, or Drift Viewer privileges to view Business
Services.
When drift is detected on a CI, or any of the child CIs, the comparison job looks for a business
service associated with the CI.
To view business services that are affected by a drift, from the Drift Console or the Drift Reports
Detail screen, click the Business Services tab.
Viewing change requests correlated with a drift

You can view change requests that might be correlated to a drift or change requests submitted to
take action on a drift.
Important
You must have Drift Master, Drift Admin, or Drift Viewer privileges to view change request
information. To view Details, in addition to Drift Management privileges, you must have
Change Master or Change User privileges.
Change requests associated with a drift
To view change requests correlated to a drift

1. From the Drift Console or the Drift Reports Detail screen, select the Change Requests tab.
The following table describes the columns for change request data.
BMC Atrium Core 9.0
Page 1092 of 2268
1.
Home
Description of change request data

Column
Description
Change ID
The ID of the change request.
Correlation
When a change request is correlated with a drift, the change request can have one of the following
Type
correlation types:
Manual-Change request was submitted, within Drift Management, to take action on the drift.
Automatic-Change request (submitted independent of Drift Management) is related to as the
possible cause of the drift.
Status
The status of the change request used by Drift Management to filter the display of correlated change
requests. For more information, see Filtering displayed change requests.
2. To view the change request, click Details. For more information about correlating a drift to a
change request, see Correlating a drift with a change request .
Viewing incident requests correlated to a drift
Important
You must have Drift Master, Drift Admin, or Drift Viewer privileges to view incident
requests. To view Details, in addition to Drift Management privileges, you must have
Incident Master or Incident User privileges.
To view incident requests correlated to a drift

1. From the Drift Console or the Drift Reports Detail screen, select the Incidents tab.
The Incident Number and Correlation Type are displayed.
2. Click Details.
Customizing the Drift Console

You can customize the panes in the Drift Console by:
Sorting by a column
Rearranging the column order by dragging and dropping
Warning
You can customize the form using the BMC Remedy Developer Studio, but do so at your
own risk. Do not remove existing columns due to underlying associated workflow.
Managing or remediating drifts

See the following actions to address or remediate a detected drift from the Drift Console:
BMC Atrium Core 9.0
Page 1093 of 2268
Home
Creating a change request from the Drift Console

Creating an incident request
Acknowledging a drift
Remediating drifts
This topic describes how to determine what caused a drift and what actions you can take to
acknowledge or remediate the drift.
Determining what caused a drift
Correlating a drift with a change request
Remediating a drift
Determining what caused a drift

A drift is caused by one of the following events:
An unauthorized change, such as changing a configuration setting from the business
required value, installing unauthorized software, or removing or adding hardware from a
computer without prior approval.
For any of these situations, you would research if the drift can be correlated to a change
request as described in Correlating a drift with a change request .
If a drift cannot be correlated to a change request and if it would be appropriate to do so, you
can create a change request or an incident request as described in Remediating a drift.
An authorized change initiated through a BMC Remedy Change Management Change
Request form can cause drift if the baseline of the comparison job is outdated. A scenario
describing how this could occur and how to correlate a drift with a change request is
explained in Correlating a drift with a change request .
Correlating a drift with a change request

A drift displayed on the Drift Console might be the result of a change request that has been
submitted, as described in the following scenario.
At your company, a newly approved business standard requires all laptops in the Technical Support
Group to be upgraded from 1 GB of memory to 4 GB. Change request 007 for the installation of the
additional memory was submitted, approved, and implemented. Your daily discovery application
scanned the laptops and updated the memory attribute of the CIs for those laptops in BMC Atrium
CMDB. A few days later, an existing comparison job, scheduled to run periodically, checks all
laptops against a baseline defining the memory standard to be 1 GB memory. Drift is detected by
the comparison job for all the Technical Support laptops because BMC Atrium CMDB shows a
value of 4 GB in the CI memory attribute. The comparison job detects this change as a drift
because the baseline that the comparison job is using is outdated. In this case, the baseline was
not updated to reflect the new memory standards.
BMC Atrium Core 9.0
Page 1094 of 2268
Home
How is a drift correlated with a change request?

A comparison job detects and displays all drifts regardless of whether the drift is due to an
approved (also called trusted change) or unapproved change. An approved change is one that has
been submitted, approved, and implemented through the BMC Remedy Change Management
change request process.
To determine whether a drift is due to an approved change request, the Drift Management change
request correlation service compares all CIs that show drift to all change requests in the BMC
Remedy Change Management database containing that CI.
The change correlation service only considers the CIs associated with a change request and the
tasks associated with a change request pertaining to a CI.
If the change request is referencing a CI that has drifted, then you know the drift can be correlated
to a change request. This checking applies to all drift types: modified, added, and deleted.
Configuring drift correlation with a change request

You can configure how change correlation relates a drift with a change request in the following
ways:
Configure relationship types in the change request that are related to a CI. For details, see
Configuring drift correlation to a change request relationship .
Configure how long a change request is eligible for correlation to a drift. For details, see
Time window.
Viewing drifts correlated with a change request

After a comparison job detects a drift, the Drift Management change correlation service checks if
the drift can be related to a change request. Any change request correlated to a drift is displayed on
the Drift Console > View Details screen.
Change requests associated with a drift
BMC Atrium Core 9.0
Page 1095 of 2268
Home
For each drift correlated to a change request, the following information is provided:
Status (displayed in the Attributes pane)
Change request ID, correlation type, and change request status (displayed under the
Changes Request tab)
Status
The following table describes the Status field.
Status of a drift correlated with a change request
Status
Description
New
The drift is new and cannot be correlated to a change request created from Drift Management. If the drift is
correlated to a change request created outside of Drift Management, the results are shown in the Change
Requests tab.
Addressed
The change request correlated with the drift was created, within Drift Management, to resolve the drift when
found in a previous comparison job.
Acknowledged
The drift is acknowledged using the Drift Console Acknowledge option. For more information about
acknowledging drifts, see Acknowledging a drift.
BMC Atrium Core 9.0
Page 1096 of 2268
Home
Change request ID, correlation type, and change request status

The change requests displayed under the Change Requests tab can be filtered depending on how
you configured the correlated drift to the change request status (using Preferences > Change
Status Filter).
For example, if you have configured for the change request statuses of Scheduled and Completed,
only change requests in Scheduled and Completed status are displayed.
Important
Only drifts with a Status of New are displayed.
For more information about the change request ID, correlation type, and change request status,
see Viewing change requests correlated with a drift .
To view the change request form in detail, go to Drift Console > View Details > Change Requests
tab > click Details.
Within the Change Request form, select the Relationships tab. You will see the same CIs that are
displayed in the Drift Reports Detail window.
Remediating a drift
Remediating a drift involves one of the following scenarios:
You create an incident request to investigate why a drift occurred.
You create a change request to change BMC Atrium CMDB to the correct baseline state.
You can acknowledge or begin the process of remediating an unapproved drift in one of the
following ways:
You can choose to acknowledge a drift and defer taking any remediation action in the following
scenarios:
In your IT environment, you can perform pre-approved changes, such as weekly scheduled
upgrades or patches, without initialing a change request. The upgrade or patch changes are
scanned into BMC Atrium CMDB. Drift is detected when a regularly scheduled comparison
job runs.
BMC Atrium Core 9.0
Page 1097 of 2268
Home
Due to an off-hours escalation, a patch to a server had to be quickly applied without a

change request.
Important
You must have Drift Master or Drift Admin privileges to acknowledge a drift.
To acknowledge a drift
1. You can acknowledge drifts in one of the following ways:
From the Drift Console, select the Drift Report containing the drifts you want to
acknowledge
From the Drift Report Details pane
2. Click Acknowledge.
3. Select a CI or a group of CIs.
4. Click Acknowledge. From the Attributes pane of the Drift Report Details screen, you can see
the Status column shows a status of Acknowledged.
Note
The attribute status of Acknowledged is overwritten by the next run of the
comparison job. To avoid seeing these drifts again with the next comparison job
run, you must update the baseline of the job to reflect the current state of BMC
Atrium CMDB. For the off-hours escalation scenario, create a change request (to
make an approved change) and update the baseline of the comparison job.

You can create a change request directly from the Drift Console. The advantage of creating a
change request from the Drift Console is that the CIs experiencing drift are automatically related to
the change request.
Using BMC Remedy Change Management directly, you must manually associate each CI to the
change request.
Important
Before creating a change request
BMC Atrium Core 9.0
Page 1098 of 2268
Home
Important
You must have Change Master or Change User and Drift Master or Drift Admin
privileges to create a change request.
Only a Change Manager, or users with Change Configuration permissions, can
create change templates for their support group. See Managing Drift Management
permissions for instructions on how to set up these permissions.
Drift Management does not support a change request template in which the Timing
field is set to Expedited. All other Timing field values are supported.
Before creating a change request, ensure the following:

A change request template must exist before you can create a change request through Drift
Management. You do not need to create a new template if existing templates are available.
Auto Assignment is configured for your company or as -Global- in the Change Management
Rules. You can do this configuration using the Application Administration Console link on the
IT Home page. This ensures that the Change Manager Group is assigned automatically if
the templates consumed by Drift are not populated with the assignment information.
Assignment Engine Integration is enabled in Change Management Rules. For steps to
enable Assignment Engine Integration, see Configuring change rules .
To create a change request template

To create a change request template, use the following procedure.
1. From the home page, log in to the Application Administration Console.
2. Click the Custom Configuration tab.
3. From the Application Settings list, select Change Management > Template > Template, and
then click Open.
The Change Template form appears in New mode.
4. Press F2 to open the form in Create mode.
The Infrastructure Change Templates form appears.
5. After configuring all your settings, click Save to add the new template to the list of available
change templates. For more information, see Configuring change templates in BMC Remedy
IT Service Management online documentation.
To create a change request from the Drift Console

1. From the Drift Console, highlight the Drift Report for which you want to create a change
request.
2. Select the Change Requests tab, and then click Create Change.
The CIs displayed in the Specify CIs pane of the change request are the same CIs displayed
on the Configuration Items (CIs) pane of the Drift Console.
3.
BMC Atrium Core 9.0
Page 1099 of 2268
Home
3. Select a Change Template.

4. From the Specify CIs pane, select the CIs for which you want to create a change request.
You can select multiple CIs at the same time.
Warning
When selecting CIs, select only CIs with a drift type of Added or Modified to place
in a single change request. CIs with a drift type of Removed must be placed in a
separate change request and not combined with CIs of drift type Added or Modified
. This is because, depending on the drift type, a different dataset (baseline or target
) is used.
5. Click Create.
After a few moments, a change request ID is created and displayed.
6. Click OK.
The change request, with a status of Draft, is created.
7. To see the CIs associated with this change request, click the Relationships tab.
8. Click Close. The change request you created using Drift Management goes through the
standard process flow for a new change request.
Sometime after the change request is implemented, if you run the same comparison job, you
will see a different status on the Drift Console for that particular attribute. The status will be
Addressed instead of New.
Important
You must have Incident Master or Incident User and Drift Master or Drift Admin
privileges to create an incident request.
To ensure that the incident is created successfully, the templates must be created
by a user having an entry in the CTM: People form.
To create an incident request from the Drift Console

1. From the Drift Console, highlight the Drift Report for which you want to create an incident
request.
2. Choose the Incidents tab (lower right pane), and then click Create Incident.
The CIs displayed in the Specify CIs pane are the same CIs displayed on the Configuration
Items (CIs) pane of the Drift Console.
3.
BMC Atrium Core 9.0
Page 1100 of 2268
Home
3. Select an Incident Template.

4. From the Specify CIs pane, select the CIs for which you want to create an incident request.
You can select multiple CIs at the same time.
5. Click Create.
After a few moments, an incident request ID is created and displayed.
6. Click OK.
The incident request, with a status of Assigned, is created.
7. To see the CIs associated with this incident request, select the Relationships tab.
8. Click Close.
The incident request you created using Drift Management goes through the standard process flow
for a new incident request.
Incident request creation does not affect the status of a drift
Viewing Drift Reports from the Drift Dashboard

This section describes the Drift Dashboard and how to view or customize the displayed data.
About the Drift Dashboard
Viewing the data
Customizing the data display
About the Drift Dashboard

The Drift Dashboard provides a high-level view of current Drift Report data for individuals requiring
a quick status about their data center environment.
Use the Executive Overview to monitor drift in the business services having the most impact on the
overall business or on critical business units. The overview shows the number of Drift Reports by
business service, priority, and compliance to business baselines. The number of Drift Reports
generated per day is also displayed. The dashboard data is the output of comparison jobs that have
detected drift. If a comparison job does not detect drift, a Drift Report is not generated.
Drift Dashboard Executive Overview
BMC Atrium Core 9.0
Page 1101 of 2268
Home
The following table describes the dashboards available on the Executive Overview
Flashboards on the Executive Overview
Flashboard
Description
Drift
Reports by
Business
Service
The number of Drift Reports per business service for a maximum of three business services. In the previous
example, the business service is payroll service and is the only service selected for display. This business service
shows six Drift Reports. By default, randomly any three business services in your organization are displayed
spanning the last 30 days. The displayed data is filtered by access permissions of the viewer. As a result, you may
not be able to see all Drift Reports due to access permissions to the business service.
Drift
The number of Drift Reports per baseline for a maximum of three baselines. In the previous example, the Security,
Reports by
Baseline
Unix Servers, and Installed Products baselines show three, thirteen, and eight Drift Reports respectively. By
default, randomly any three baselines are displayed spanning the last 30 days. The displayed data is filtered by
access permissions of the viewer. As a result, you may not be able to see all Drift Reports due to access
permissions to the baseline.
Drift
Reports by
Priority
The number of Drift Reports by fix priority. The fix priority level is assigned when the comparison job is created or
modified. In the previous example, eight Drift Reports show a fix priority of Urgent, 16 Drift Reports show a fix
priority of Medium, and 3 Drift Reports show a fix priority of Low. The displayed data is system-wide data and is not
filtered by access permissions of the viewer.
Drift
Reports per
Day
The number of Drift Reports generated each day for the last seven days. The displayed data is system-wide data
and is not filtered by access permissions of the viewer.
Related topics
Viewing the data
Viewing the data

You can refresh or refine the data displayed on the dashboard. You can also view the details of a
Drift Report by drilling down to the Drift Console from the dashboard.
BMC Atrium Core 9.0
Page 1102 of 2268
Home
Viewing the most recent Drift Report activity

By default, the data displayed in the flashboards is for the past thirty days. The Last Refresh field
shows the date and time of the last refresh. The dashboard is not automatically refreshed. To view
the most recent activity, click Refresh.
Viewing Drift Report activity within a specific date interval

You can change the date interval on the Drift Dashboard to narrow or expand the data displayed.
To view Drift Report activity within a specific date interval

1. Click the Start Date calendar icon and enter a new start date.
2. Click the End Date calendar icon and enter a new end date.
3. Click Refresh. The new date interval is applied to all flashboards except the Drift Reports per
Day.
Viewing bar chart data in text format

To view the bar chart data in text format, hover the cursor over a bar. Placing the cursor on a
different bar of the chart displays results pertaining to that bar.
Viewing Drift Report details

To view the details of a Drift Report, you can access the Drift Console from the Drift Dashboard.
Note
The Drift Reports per Day flashboard does not support this feature.
To view the details of a Drift Report

1. Click on any bar within the bar chart.
The Drift Console is displayed showing a summary of all associated Drift Reports for the
selected bar.
Clicking on a different bar of the chart displays different results.
2. From the Drift Console, click View Details to view details about the drifted CIs listed in the
Drift Report.
The Drift Report Details pane displays information about the CIs showing drift.
For information about the fields displayed in the Drift Console and Drift Report Details panes,
see Viewing the Drift Console data.
BMC Atrium Core 9.0
Page 1103 of 2268
Home

You can customize the dashboard to display specific business services and baselines for which you
want to view drift activity. You can also change the schedule for the job supporting the Drift Reports
per Day flashboard.
See the following topics:
Selecting business services to view
Selecting baselines to view
Changing Drift Reports per Day schedule
Selecting business services to view

For the Drift Reports by Business Service flashboard, you can specify which business services to
view.
If a Drift Report does not have any business services associated with it, the Drift Report does not
show up in the flashboard data.
To select business services

1. Click the Select Business Services link under the Drift Reports by Business Service
flashboard.
2. From the dialog box displayed, select the Business Services for which you want to view
potential drift events.
3. Click Close.
Selecting baselines to view

For the Drift Reports by Baseline flashboard, you can specify which baselines to view. This is
particularly useful if you want to monitor that your business-critical computers do not drift from a
defined business requirement configuration. This business requirement configuration is defined in a
baseline that has been created and used in a comparison job. The baseline is stored in your BMC
To select baselines
1. Click the Select Baselines link under the flashboard.
2. From the dialog box displayed, select the baselines you want to display on the flashboard.
3. Click Close.
BMC Atrium Core 9.0
Page 1104 of 2268
Home
Changing Drift Reports per Day schedule

The Drift Reports per Day flashboard is scheduled to run daily at 11:59 P.M. Using BMC Remedy
Developer Studio, you can change this schedule by modifying the Flashboard variable on the
underlying BMC Remedy AR System form. For more information, see Adding a flashboard to a
BMC Remedy AR System form in BMC Remedy AR System online documentation.
Using preferences
This section describes how to set Drift Management preferences for selected functions.
About preferences
Configuring the comparison or snapshot service for better performance
Filtering displayed change requests
Configuring drift correlation to a change request relationship
Changing the default BMC Remedy AR System Administrator password
About preferences
You can set application preferences for certain functions of Drift Management. As these
preferences are application preferences, not user preferences, any changes made affect the Drift
Management application for all users.
Important
You must have Drift Master or Drift Admin privileges to set preferences.
Configuring the comparison or snapshot service for better performance

To improve the performance of a comparison or snapshot job, you can configure the following
parameters:
Number of CIs retrieved (with one call) from BMC Atrium CMDB for initial loading into
memory
Number of CIs that are compared or copied at a time
Number of processor threads to use
Note
For a detailed description of the comparison service, see Comparison service.
BMC Atrium Core 9.0
Page 1105 of 2268
Home
To configure the comparison or snapshot service

1. From Drift Management, select Preferences, and then click the General tab.
2. If necessary, adjust the default values as described in the following table.
Comparison and snapshot service performance options
Option
Description
Chunk size
during
Specifies the number of CIs retrieved from BMC Atrium CMDB in one call when the comparison or
snapshot job performs an initial load of CIs into memory. The CIs that are loaded into memory are those
initial
loading
that match the qualifications applied to the baseline and the target. In the case of a snapshot job, the
qualification applied to the source dataset. If you see database query timeouts, and then lower the size.
Note:An initial load loads each CI with only three attributes ( ClassId, InstanceId, and
ReconciliationIdentity ).
Chunk size
during
Specifies the number of CIs retrieved from BMC Atrium CMDB in one call after a determination is made
regarding which CIs are eligible for comparison. The eligible CIs are reloaded into memory with all
comparison
attributes needed for comparison.
Number of
Specifies the number of comparison threads that can be active at the same time. During the initial load of
threads
CIs, two threads were used: one to load the baseline CIs and one to load the target CIs.
3. Click Save Preferences.

The new preferences take effect in the next job run.
Filtering displayed change requests

You can configure Drift Management to filter the display of change requests correlated with a drift.
This filtering is based on the status of the change request. For example, you want to see the
change requests correlated with a drift that are in Completed status only. You can filter on this
status and only those change requests are displayed on the Drift Console Change Request tab.
The default filtering displays change requests with the following statuses:
Implementation In Progress
Pending
Completed
Important
This filtering applies only to New drift that is detected. It does not apply to Addressed drifts
.
To filter by a change request status

1. Select Preferences, and then click the Change Status Filter tab.
2. Add a status by selecting the status in the left pane, and then click Add.
3.
BMC Atrium Core 9.0
Page 1106 of 2268
Home
3. Remove a status by selecting the status in the right pane and click Remove.
The Active status indicates which filters are selected.
Your changes are saved when you click Add or Remove.
Configuring drift correlation to a change request relationship

A change request can be related to several different objects. Because Drift Management works
only with BMC Atrium CMDB data, when the Drift Management correlation service correlates a drift
to a change request, only the change request relationship with a CI is considered.
You can refine how the correlation service correlates drifts to a change request by:
Using the CI relationship type, for example, Related To, Upgrades, and Repairs.
Specifying a time window for defining how long (in days) a completed change request is
eligible for correlating to a drift.
Use this configuration option when you want a more accurate and detailed view of the correlation of
change requests to a drift. For example, consider a scenario in which you created a change request
to add a new printer to your network. Under the Relationships tab on the change request, you can
select the new CI (printer) and a relationship type indicating that this CI is a new installation.
In Drift Management, you can indicate the same relationship. The correlation service uses this
information when correlating the drift to the change request, providing a more detailed view of the
drifts correlated to a change request. The following table lists the out-of-the-box configurations for
relationships with drift types:
Drift types and relations
Drift type
Related to
Added
Upgrades, Impacts, Installs, and Changes
Modified
Upgrades, Repairs, Impacts, Moves, and Changes
Removed
Changes and Removes
A change request can also have associated tasks which defines the relationship with certain types
of objects in the parent change request, such as Configuration Item, LDAP Object, and Software
Library Item. The type of relationship is limited to Related To, but you can specify more attributes
for the relationship, such as Attribute Type which can be Source or Target, Action Attribute such as
Install or Uninstall. This information is used in the change request correlation service.
Use the following guidelines when correlating relationships at the task level:
Relationships at the Task Level are considered only for ADDED and REMOVED drifts.
BMC Atrium Core 9.0
Page 1107 of 2268
Home
ADDED CIs that have a relationship at the Task Level, must have an Attribute Type of
TARGET and an Attribute Action of INSTALL to qualify for the correlation list.
REMOVED CIs that have a relationship at the Task Level, must have an Attribute Type of
SOURCE and an Attribute Action of UNINSTALL to qualify for the correlation list.
To configure drift correlations to a change request relationship

1. Select Preferences, and then click the Change Correlation Filter tab.
2. Select the change request relation, for example, Installs.
3. Click the appropriate CI relationship button, for example, CI Added.
4. To remove a relationship, select the relationship and click Remove.
Your changes are saved when you click the buttons (CI Added, CI Modified, CI Removed, and
Remove.)
Time window
You can also specifying a time window for defining how long (in days) a change request is eligible
for correlation to a drift. In the Time Window field, enter the number of days after a change request
has reached Completed status that it should still be considered as a possible source for drift.
Changing the default BMC Remedy AR System Administrator password

Because Drift Management uses BMC Remedy AR System, you need an underlying administrator
user to communicate with the BMC Remedy AR System server when running comparison or
snapshot jobs. A default BMC Remedy AR System Administrator User and password,
DCA_Drift_Job_Mgr, is provided with Drift Management.
BMC recommends changing the default password.
Important
This option is available only to a user with BMC Remedy AR System Administrator
privileges. The Job Manager Password (tab) is hidden for all other users.
To change the BMC Remedy AR System Administrator password

1. Select Preferences, and then click the Job Manager Password tab.
2. Enter the new password.
The password cannot be greater than 30 characters in length.
3. Click Change Password.
Warning
No password verification exists so take care when entering the new password.
BMC Atrium Core 9.0
Page 1108 of 2268
Home
Comparison service
This section provides details about the comparison service, which is the execution engine
supporting a comparison job.
Overview
Initial loading of CIs
Identifying CIs for comparison
Performing the last load and comparing attributes
Tagging CIs with detected drift
Overview
When you create a comparison job, you provide a baseline and a target both with a qualification set
. Optionally, for the baseline, you can provide an include and exclude set that dictates which
attributes of a CI to include in the comparison and which attributes to exclude. You also provide
information about the type of comparison that should be performed: a one-to-one comparison or a
many-to-one comparison; a compare or a compare recursively. With this information, the
comparison job contains the details of the comparison that needs to be performed.
All of the comparison job information is stored in Drift Management-specific BMC Remedy AR
System forms. When you start a comparison job, the job manager is activated. The job manager is
a BMC Remedy AR System plug-in that manages the running, cancelling, and querying of jobs.
After some background processing by the job manager, the comparison service is called to do the
following tasks:
Initial load of the CIs from the source dataset
Identify the CIs to be compared
Load the matched CIs with attributes
Perform the comparison
Identify if drift has occurred between qualifying CIs
Each of these tasks are described in the following sections.
Initial loading of CIs

The first task the comparison service performs is to get a list of all the CIs that match the
qualification set you applied to the baseline and target source datasets. During the initial loading
into memory, the qualified CIs are fetched with only three core attributes: ClassId, InstanceId, and
ReconciliationIdentity. Because the loading of the baseline CIs and the target CIs can be done
separately, the comparison service creates two separate processing threads to load the CIs.
BMC Atrium Core 9.0
Page 1109 of 2268
Home
Processing qualification sets

Qualification sets can have zero (All Objects option of Qualification Builder) or more qualifications (
Custom Qualification Set option of Qualification Builder). If there are no qualifications (All Objects)
to be applied to the source dataset, all CIs specified in the baseline or target are included.
If qualifications are to be applied, the comparison service creates a query that is applied to the
BMC Atrium CMDB. (When there are no qualifications, the query is null.) The BMC Atrium CMDB
API returns a set of CIs matching the criteria in the qualification.
The result is the identification of two sets (baseline and target) of CIs for comparison. The baseline
and target CIs are stored in memory ordered by ClassID.
Processing related classes

One of the distinguishing features of Drift Management is the ability to select a set of CIs based on
relationships. This feature is very useful when the selected CIs are logically related to other CIs.
For example, you can select computer systems related to a particular business service or select
products related to a computer system. The product CIs are only used to filter the computer system
CIs. The product CIs do not take part in the comparison.
Warning
The Drift Management Qualification Builder allows arbitrary levels of nesting of related
classes. This is an I/O intensive operation, with more levels of nesting resulting in longer
execution of the query takes.
Processing exclude and include sets

After the qualified CIs are loaded into memory, the comparison service addresses the exclude and
include sets.
Included and excluded attributes are uniquely identified by a class-attribute combination.
The excluded attributes are used to ignore attributes, thus making the comparison quicker and the
Drift Report more relevant. For example, if you are comparing a set of servers against a golden
server, you would likely exclude the host name attribute because it is different from the golden
server.
The included attributes identify the attributes to be included in the comparison and the conditions
that define a drift. The conditions are designated by the comparison operator and value entered for
BMC Atrium Core 9.0
Page 1110 of 2268
Home
each included attribute. With included attributes, you can override the default comparison of
equality (==) with other comparisons, such as LT (less than) and GT (greater than). In addition, you
can override the baseline attribute value with your own value against which to compare the target
attribute.
Identifying CIs for comparison

After the initial loading and setup of the CIs is completed, the next step is to identify the CIs to be
compared. The comparison service performs two types of comparisons: compare regular and
compare recursive. These comparisons are further enhanced by specifying the cardinality for the
compare: one-to-one and many-to-one.
Each of the comparisons and how they work together is described.
Compare regular
A compare regular refers to the comparison of top level CIs only. No other related CIs are
compared.
Compare recursive
A compare recursive compares the top level CIs and their weakly related children. The qualification
set you apply to your baseline or target, only selects the top-level CIs. The comparison service
loads all the weakly-related children for a CI and compares them as well. All child CIs, at all levels,
are loaded.
One-to-One
The comparison service must identify which two CIs (one from the baseline and one from the target
) represent the same instance. To do this, the comparison service uses the ReconciliationIdentity
attribute created by the Reconciliation Engine. Any CIs in the baseline or target that have not been
identified by the Reconciliation Engine are not compared. The comparison service stores this new
set of matching CIs in memory.
A one-to-one comparison can be combined with a compare regular and a compare recursive.
Many-to-One
A many-to-one comparison is used when you want to check a pre-defined configuration (golden
server) against all CIs of the same kind. For example, you might want to perform a comparison to
verify all your web servers have the same standard configuration.
With a many-to-one comparison, you compare many target CIs with one baseline CI. Each CI in the
target is compared with the single CI in the baseline. The number of CIs in the baseline cannot be
more than one. If the qualification set you apply to the baseline evaluates to more than one CI, the
comparison service stops execution and displays the following error message:
Many to one specified: Baseline must have a single CI. This baseline has _<NN>_
CIs.
BMC Atrium Core 9.0
Page 1111 of 2268
Home
There are no restrictions on the number of CIs in the target.

The difficulty with a many-to-one comparison is identifying the CIs instances. The
ReconciliationIdentity attribute cannot be used in a many-to-one comparison because the same
CI instances are not being compared.
Instead, the top-level CI is identified by class type. For example, if the baseline CI belongs to the
BMC_ComputerSystem class, then all CIs in the target are compared for that class. All others are
ignored.
Unfortunately, if the compare recursive option is selected when creating a comparison job, the
same logic cannot be used to identify the child CIs. To correctly identify the child CIs, the
comparison service uses the Reconciliation Identification Rules located in the RE:Identify_Rules
form. These rules specify the attributes per class that need to match to be identified. For example,
the Reconciliation Engine rule states that for products the class type, the name, and the version
number must match.
Performing the last load and comparing attributes

Although CIs have been identified for comparison, because those CIs were initially loaded with just
three attributes, the comparison service needs to reload the CIs with all the attributes needed for
comparison. Based on the include and exclude attribute set, the comparison service launches
multiple threads to load and compare the attributes needed for each class. The baseline and target
CIs are loaded in parallel and another thread compares the CIs. By default, 500 CIs are loaded at
time, but you can configure this number from the Preferences menu option of Drift Management.
The Compare thread performs the comparison of attributes values based on the comparison
operator specified, for example, NE, EQ, GT, LT.
Tagging CIs with detected drift

The comparison service compares the CIs as defined by the comparison job and if any of the CIs
fail to meet the comparison criteria, this failure (change) is flagged as a drift. A drift is defined in one
of the following ways:
All unmatched CIs in the baseline are tagged with drift type Removed.
All unmatched CIs in the target are tagged with drift type Added.
The remainder of the CIs that are matched by the ReconciliationIdentity attribute are
compared. If any CI fails the operation comparison, the CI is tagged as drift type Modified.
A Drift Report for the job is written to an BMC Remedy AR System form that the Drift Console and
Dashboard can display and query. Each drift can contain drift details showing the attributes of a CI
that failed to meet the comparison criteria.
For all CIs with detected drift, the comparison service identifies all the business services that are
affected by the drift as well.
BMC Atrium Core 9.0
Page 1112 of 2268
Home
Using server groups with Drift Management

Important
There is an open issue (SW00278808) with the server group implementation of Drift
Management. If the primary server goes down, all scheduled jobs fail, even though you
expect that the secondary server should pick up all the pending jobs.
In a server group environment, two or more AR System servers point to the same database. This is
often done for load balancing or high availability issues. For example, if one of the AR System
servers goes off-line, the other AR System server is still available to process transactions. Because
both servers use the same database, there are no database synchronization problems.
To use a server group, the AR System server must first be configured to support this type of
environment. For information about installing the AR System server for a server group environment
and for supporting multiple servers, see Installing a server group in BMC Remedy AR System
online documentation.
This section describes how to use Drift Management in an existing AR System server group
environment.
Important
Perform the following procedure on every secondary server after you finish a standard
installation, as described in Installing BMC Configuration Drift Management in BMC
Remedy ITSM Deployment documentation. For example, if you have one primary server
and three secondary servers in your server group, you must apply this procedure to each
secondary server.
To use server groups with Drift Management

1. Stop the AR System server.
2. From the primary server, copy the following folders to the <AR_Server_Install_Dir>\
pluginsvrfolder that will be used for your secondary server.
<Drift_Install_Dir>\Common_Components\java-plugin-libs\common
<Drift_Install_Dir>\Common_Components\java-plugin-libs\<platform> (Windows
or Solaris)
3.
BMC Atrium Core 9.0
Page 1113 of 2268
Home
3. Create a directory to store your Java plug-ins.

This will be your <Drift_Install_Dir_secondary_server> in the following example.
You should create the same directory structure on the secondary server that was used with
the primary server.
4. From the primary server, copy the following folders to the new Java plug-ins directory that
will be used for your secondary server.
<Drift_Install_Dir>\BMC_Configuration_Drift_Management\ar\java-plugins
5. Use your favorite text editor to open the pluginsvr_config.xml file in the <
AR_Server_Install_Dir_secondary_server>\pluginsvr folder used for your secondary
server.
6. From the pluginsvr_config.xml file copy the plugin details from primary server for Drift
Management to the pluginsvr_config.xml file on the secondary server. You should copy
the entire xml snippet that resides in the <plugin> and </plugin> tags. After copying this
snippet, verify that the directory structure matches to the one created on the secondary
server as described in step 2 and step 3.
<plugin>
<code>JAVA</code>
<filename>< _Drift_Install_Dir_secondary_server_>\
BMC_Configuration_Drift_Management\ar\javaplugins\jobmanager\jobmgmt.jar</
filename>
<pathelement type="location"><Drift_Install_Dir_secondary_server>\
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\common-2.5r87.jar</
pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\io-2.3r7.jar</
pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\jta.jar</
pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\quartz.jar</
pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\rulemgmt.jar</
pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\tools-config-2.2r6.
jar</pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\tools-logs-2.2r6.
jar</pathelement>
BMC_Configuration_Drift_Management\ar\javaplugins\job-manager\tools-regex-2.0r2.
jar</pathelement>
<pathelement type="location"><AR_Server_Install_Dir_secondary_server>\pluginsvr\
arapi.jar</pathelement>
arutil.jar</pathelement>
BMC Atrium Core 9.0
Page 1114 of 2268
Home
cmdbapi.jar</pathelement>
Logger.jar</pathelement>
marimba.zip</pathelement>
<classname>com.bmc.apps.dsm.plugin.arfilterapi.JobMgrFilterAPIPlugin</classname>
<type>FilterAPI</type>
<name>JOBMGR.FILTERAPI</name>
<userDefined>
<plugindir><Drift_Install_Dir_secondary_server>\
BMC_Configuration_Drift_Management\ar\java-plugins\jobmanager</plugindir>
</userDefined>
</plugin>
Note
Make sure that you replace <Drift_Install_Dir> and <AR_Server_Install_Dir> with
the appropriate values for your system.
7. Open the ar.cfg (or ar.conf) file and append the following two lines:
Server-Plugin-Alias: JOBMGR.FILTERAPI JOBMGR.FILTERAPI <

AR_Server_Name_secondary_server>:<Java_Plugin_Port_secondary_server>
Note
Make sure that you replace <AR_Server_Name_secondary_server> and <
Java_Plugin_Port_secondary_server> with the appropriate values for your system.
8. Edit the armonitor.cfg (or armonitor.conf ) file to include the heap size -Xmx768m in the
java plugin startup line (if it is not already there).
9. Make sure the PATH environment variable points to right location. (Windows only)
For example:
C:\Program Files\AR System\<_AR_SERVER_NAME_>\pluginsvr;C:\Program Files\AR

System\<_AR_SERVER_NAME_>;
10. Edit the ar.host and ar.port key values in the properties.txt file to point to the local server.
The file is located by default in the <Drift_Install_Dir_secondary_server>\
BMC_Configuration_Drift_Management\ar\java-plugins\data folder.
11. Restart the AR System server and the BMC Remedy Mid Tier.
BMC Atrium Core 9.0
Page 1115 of 2268
Home
Configuring federated data in BMC Atrium

CMDB
The following topics are provided :
Opening Federation Manager
Overview of plugins and adapters for federated data
Managing federated data stores
You can configure BMC Atrium Configuration Management Database (BMC Atrium CMDB) to
display federated data. You can configure federation through the retrieval and launch methods. The
retrieval method enables you to view federated data as if it were stored in BMC Atrium CMDB. The
launch method enables you to view federated data through another application, such as a BMC
Remedy AR System form.
The following example illustrates when you might federate data. Calbro Services stores service and
maintenance records for their printers in a Microsoft SQL Server database. Allen Allbrook, a BMC
Atrium CMDB administrator at Calbro Services, knows that only core data for a Configuration Item (
CI) should be stored in BMC Atrium CMDB. Detailed and related data for those CIs should be
federated to help organize CIs and make the BMC Atrium CMDB more efficient.
Allen determines that the service and maintenance database stores information that is related to
CIs in the BMC Atrium CMDB, and makes that data available using the retrieval method of
federation. The federated data is then available to be viewed from within the BMC Atrium CMDB
through BMC Atrium Explorer.
Allen completes the following tasks to enable BMC Atrium CMDB to display the federated service
and maintenance data on the Microsoft SQL Server database:
Create a plugin for the new Microsoft SQL Server database, as described in Creating plugins
for federated data.
Create a data store to represent the incident database, as described in Managing federated
data stores.
Create a federated data class for the specific incident data to federate, as described in
Creating or editing a federated data class .
Create a federated relationship class that defines how the federated incident data is related
to CIs stored in BMC Atrium CMDB, as described in Creating or editing a federated
relationship class.
For more information about when to federate data, see Federated data model and Planning to use
federated data.
BMC Atrium Core 9.0
Page 1116 of 2268
Home
Opening Federation Manager

Use the Federation Manager application to manage all of the external data stores that you want to
be available through BMC Atrium Configuration Management Database (BMC Atrium CMDB). An
external source of data is most often a database, a CMDB compliant with the CMDBf standard, or
forms on a BMC Remedy AR System server. External sources of data are represented in
Federation Manager as data stores.
To open Federation Manager and view classes

<midTierServer> is the name of the web server where BMC Remedy Mid Tier is
installed.
2.
3.
4.
5.
6.
<port> is the port number of the web server where BMC Remedy Mid Tier is installed,
which is required only if the web server is not using the default port (80 if using
Microsoft IIS or 8080 if using Apache Tomcat).
In the login page, specify the following details:
administrator)
Click Login.
In the AR System Home page, select Atrium Core > Atrium Core Console .
A bar at the top of BMC Atrium Core Console displays the name of the current user. The
Click the Application Launcher.
Mouse over Applications, and then select Federation Manager.
The navigation pane in the Federation Manager lists all of the external data stores that you have
configured. When you select a data store, details for the federated data available from that data
store appear in the display pane.
The display pane contains tabs that provide access to different information for the selected data
store:
General Lists the name and description of the selected data store.
Retrieval Definitions Enables you to administer the federated data classes and federated
relationship classes associated with the selected data store. Retrieval definitions enable you
to view federated data as if it were stored in BMC Atrium CMDB. For more information, see
Retrieval method of federation.
BMC Atrium Core 9.0
Page 1117 of 2268
Home
Launch Definitions Enables you to administer launch interfaces and launch links, which
launch federated data using a method that you configure. For more information, see Launch
method of federation.
Overview of plugins and adapters for federated data

The following topics are discussed in this section:
Federated data plugins
Registering a federated data adapter with BMC Remedy AR System
Federation Manager plugins and adapters provide the mechanism to connect the master BMC
Atrium Configuration Management Database (BMC Atrium CMDB) to external sources of data,
federating data from different types of repositories. The following figure illustrates the concept of
federation between BMC Atrium CMDB and a federated Oracle database.
Federation between BMC Atrium CMDB and federated database
BMC Atrium Core 9.0
Page 1118 of 2268
Home
BMC Atrium Core 9.0
Page 1119 of 2268
Home
The following table explains these federation concepts.

Important federation concepts explained
Federation
concept
Description
Core BMC
Atrium CMDB
classes
Store Configuration Item (CI) instances (for example, BMC_ComputerSystem from the Common Data Model).
Federated
data classes
Represent data that is stored externally (for example, data in an Oracle database). In the retrieval method of
federation, you can use BMC Atrium Explorer to view or query this data in the context of the data model.
Federated
relationships
Join the core BMC Atrium CMDB classes with the federated data classes.
Adapter
Provides the code-level connectivity between BMC Atrium CMDB and an external source of data. It enables you
to federate data from various external data sources (for example, the Oracle adapter connects to a
JDBC-compliant Oracle database).
Plugin
Provides access to an external source of data. The plugin uses an adapter and other information, such as the
user name and password required to access a database.
Database
Contains the data (for example, incidents or change requests) in database tables that you do not want to store
directly in the BMC Atrium CMDB.
As shown by the downward arrows in the illustration , BMC Atrium CMDB can establish links from
its own data to the external data source, but the external source cannot establish links to BMC
Atrium CMDB. Federated data is not bidirectional.
You can use any adapter in one or more plugins. For example, you might use a single JDBC
adapter to configure two different plugins, with each plugin configured to connect with a different
external database. BMC Atrium CMDB includes three adapters at installation:
JDBC Enables you to federate data from any JDBC-compliant database. For more
information, see Creating a JDBC plugin.
CMDBf Enables you to federate data from any CMDBf-compliant CMDB. If you have
third-party CMDBs in your environment, you can use the CMDBf adapter. For more
information, see Creating a CMDBf plugin.
AR Enables you to federate data from forms on any BMC Remedy AR System servers.
For more information, see Creating an AR plugin.
BMC Atrium Core 9.0
Page 1120 of 2268
Home
If you want to connect to an external data source of a different type, you must first create a new
adapter. For more information, see Registering a federated data adapter with BMC Remedy AR
System.
Federated data plugins

Plugins use adapters to connect an external source of data to BMC Atrium Configuration
Management Database (BMC Atrium CMDB). If you want to federate data on a JDBC-compliant
database, a CMDBf-compliant CMDB, or the forms residing on a BMC Remedy AR System server,
you can create a plugin using an adapter that is installed with BMC Atrium CMDB.
For specific adapters, see:
Creating a JDBC plugin
Creating a CMDBf plugin
Creating an AR plugin
The following figure illustrates how plugins and adapters work with two federated Oracle databases.
You can use any adapter for one or more plugins. For example, you might use a JDBC adapter to
configure two different plugins, with each plugin configured to connect with a different external
database.
Using plugins and adapters with federated databases
BMC Atrium Core 9.0
Page 1121 of 2268
Home
Important federation concepts explains the federation concepts illustrated in the above figure.
Note
You only need to create plugins with the retrieval method of federation, not the launch
method.

The following procedure includes an example for a Calbro Services administrator who wants to
create a custom plugin for a CMDBf-compliant CMDB. You have already located the Access Point
URL and the WSDL URL to the CMDB.
Use the CMDBf plugin only for federated repositories that are other third-party CMDBs. The
combination of the master BMC Atrium Configuration Management Database (BMC Atrium CMDB)
instance with the secondary CMDB instances constitutes a logical CMDB known as the
Configuration Management System (CMS) in IT Infrastructure Library (ITIL) V3.
BMC Atrium Core 9.0
Page 1122 of 2268
Home
Note
Do not use the CMDBf plugin to connect one BMC Atrium CMDB storing one type of data
(for example, Asset Management data) to another BMC Atrium CMDB storing another
type of data (for example, Change Management data). Only one BMC Atrium CMDB
should function as the single source of reference for all Configuration Items (CIs) in your
IT environment.
To create a CMDBf plugin

1. Open Federation Manager.
2. In the toolbar, click Configure Repository Plugins and Adapters.
3. In the Configure Repository Plugins and Adapters dialog box, click New.
4. In the General tab of the Details section, enter the following information for the CMDBf
plugin:
Parameters for creating CMDBf plugin
Field
Description
Adapter
Select CMDBf from the list of available adapters.
Plugin
Name
Unique name for the plugin. This name cannot change after you save the plugin. To make the name
descriptive in a meaningful, consistent way, consider using the following naming convention: <
databaseType><databaseName>_PLUGIN<hostName>
User
Name
User name to access the external source of data.
Password
Password to access the external source of data.
Access
Point
URL
URL of the service access endpoint, formatted as follows: * http://<hostName>:<port>/<servicePortName>*
WSDL
URL of the service WSDL, formatted as follows: * http://<hostName>: <port>/<servicePortName>?wsdls*
URL
For example, Allen, the Calbro Services administrator, would select the CMDBf adapter,
name the new plugin CMDB_PLUGIN_CalbrSJ, and enter the user name and password to
the CMDB. He would then enter an Access Point URL of *http://goldserver:9090/axis2/
services/ThirdPartyCMDB_porttype*, and a WSDL URL of *http://goldserver:9090/axis2/
services/ThirdPartyCMDB_porttype?wsdl*.
BMC Atrium Core 9.0
Page 1123 of 2268
Home
5. Click Add.
The Loaded column in the Configure Repository Plugins and Adapters dialog box reads No
for the new plugin.
6. In the list of repository plugins, select the new plugin.
7. Click Show XML.
8. In the Plugin XML dialog box, copy all of the text from <plugin> to <\plugin>, including
those tags.
9. On the plugin server computer, open the pluginsvr_config.xml file for editing.
By default, the pluginsvr_config.xml file is in the <installDir>\BMC Software\AtriumCore\
cmdb\plugins\shared directory.
10. In the <pluginsvr_config> section of the pluginsvr_config.xml file, paste the <plugin
> text that you copied from the Plugin XML dialog box in step 8 as a new <plugin> entry.
11. Save and close the pluginsvr_config.xml file.
The Loaded column in the Configure Repository Plugins and Adapters dialog box displays
No when you first create the new plugin.
12. Click Refresh.
The Loaded column in the Configure Repository Plugins and Adapters dialog box now
should display Yes for the new plugin.
If the Loaded column continues to display No, one of the following conditions exists:
An error occurred in connecting to the external data source. Examine the
AtriumPluginSvr.log file for errors. By default, the AtriumPluginSvr.log file is in the
<installDir>\BMC Software\AtriumCore\Logs directory.
The external data source returns no external tables. No errors are logged in this case.
13. If your BMC Atrium CMDB environment uses a server group, make sure the same plugin is
configured on all servers in the server group. Repeat the following steps for each server:
a. Copy the same plugin configuration information in the pluginsvr_config.xml file for
each server. Make the appropriate changes in the <filename> and <pathelement
> tags to correct the jar paths for the local server if required.
b. Copy and paste the Server Plugin Alias entry in the ar.cfg file. Change the
server name to the local server.
c. Restart the server.
14.
BMC Atrium Core 9.0
Page 1124 of 2268
Home
14. Close the Configure Repository Plugins and Adapters dialog box.
You now must create a data store to represent the external data in your CMDBf-compliant
CMDB. For more information, see Managing federated data stores.
Creating a JDBC plugin

create a custom JDBC plugin for a Microsoft SQL Server database that contains workgroup and
data transfer information about computer system Configuration Items (CIs).
The JDBC plugin requires a database driver. If you do not want to use one of the drivers (SQL
Server, Oracle, IBM DB2, or Sybase) that BMC provides, you must use your own. Many drivers are
available on the internet.
Note
If your BMC Atrium Configuration Management Database (BMC Atrium CMDB)
environment uses a server group, you must install that driver in the same directory path
on each server in the group.
To create a JDBC plugin

1. On the left side of the BMC Atrium Core Console, click the Application Launcher.
2. Mouse over Applications, and then select Federation Manager.
3. In the toolbar, click Configure repository plugins and adapters.
Configure Repository Plugins and Adapters dialog box
BMC Atrium Core 9.0
Page 1125 of 2268
Home
5. In the General tab of the Details section, enter the following information for the JDBC plugin:
Parameters for creating JDBC plugin
Field
Description
Adapter
From the list of available adapters, select JDBC.
Database
Type
Select a database from the list (for example, SQL Server). To select a different type of database (for
example, MySQL), select Other from the Database Type list. You must then specify the parameters for the
database, including login information, JDBC URL, and so on.
Plugin
Name
Unique name for the plugin. This name cannot change after you save the plugin. To make the name
descriptive in a meaningful, consistent way, consider using the following naming convention: <
databaseType><databaseName>_PLUGIN<hostName>
Host
Name
Actual name of server hosting your database (for example, Calbro_server_SJ). Note: Do not use
localhost.
Database
Name
Name of the particular database to be used (for example, Northwind). For DB2, enter a schema name. The
schema name is case-sensitive and must be specified in uppercase characters (for example, MYSCHEMA ).
Service
Name (
Oracle
only)
Alias to an Oracle instance
Port
Number
BMC Atrium Core 9.0
DB2 50000
Oracle 1521
SQL Server 1433
Sybase 5001
Note: These port numbers are the default values for the respective databases. You could use a
different port number for your database.
Page 1126 of 2268
Home
Field
Description
User
Name
User name to log on to the database (for example, sa).
Password
Password to log on to the database.
JDBC
URL (
Other only
)
The JDBC connection information to the database. You must enter the proper values for your particular
JDBC
The full name of the JDBC driver class. You must enter the proper values for your particular database. For
Driver (
Other only
example, the MySQL database: com.mysql.jdbc.Driver
database. For example, the MySQL database: jdbc:mysql://localhost:3306/mysql

For specific information about constructing JDBC URLs, see the documentation for your specific database.
For example, Allen, the Calbro Services administrator, selects the JDBC adapter and SQL
Server database type, names the new plugin SQLServer_Northwind_CalbroSJ, and enters
the remaining parameters for the Microsoft SQL Server server database.
6. (optional) Click the Filter Options tab of the Details section.
a. Select the source of the data that you want to fetch.
By default, the JDBC Adapter fetches data from tables only. You can fetch the data
from views only, or both tables and views.
Filter options to limit the data returned
b. For performance reasons, enter a pattern to filter the tables returned.

For example, if you enter Ab%, only the tables starting with the Ab pattern are
retrieved from the database.
7. Click Add.
for the new plugin.
9. Click Show XML.
those tags, and then close the dialog box.
11.
BMC Atrium Core 9.0
Page 1127 of 2268
Home
14. Click Refresh.
should display Yes for the new plugin. If the Loaded column continues to display No, one of
the following conditions exists:
15. If your BMC Atrium CMDB environment uses a server group, make sure the same plugin is
configured on all servers in the server group. Repeat the following steps for each server:
You now must create a data store to represent the external data in your database. For more
information, see Managing federated data stores.
create a custom AR plugin for the form on the BMC Remedy AR System server used to store
printer service records. In this case, creating an AR plugin instead of a JDBC plugin is easier for
federation because form names are typically easier to read than table names from the AR System
database.
To create a plugin using the AR adapter

4. In the General tab of the Details section, enter the following information:
Parameters for creating AR plugin
BMC Atrium Core 9.0
Page 1128 of 2268
4.
Home
Field
Description
Adapter
Select AR from the list of available adapters.
Plugin
Unique name for the plugin. You cannot change this name after you save the plugin. To make the name
Name
descriptive in a meaningful, consistent way, consider using the following naming convention: <arServer>
PLUGIN<hostName>
User
Name
User name to access the BMC Remedy AR System server.
Password
Password to access the server.
AR
Name of the server.
Server
Port
Port number of the specified server.
For example, Allen, the Calbro Services administrator, would select the AR adapter, name
the new plugin ARServer_PLUGIN_CalbroSJ, and enter the user name, password, server
name, and port of the BMC Remedy AR System server.
5. (optional) Click the Filter Options tab of the Details section to fetch the data from a
particular type of form on the BMC Remedy AR System server.
You can retrieve data from the following forms:
Form types from which you can retrieve data
Form
Description
Regular Forms
Default setting.
Specified Forms
Enter the form in the Form Name field.
All Forms
Includes all form types.
Join Forms
Includes all join forms.
View Forms
Includes all view forms.
Join Forms that depend on
Includes all join forms that depend on the form specified in the Form Name field.
Join Forms that are depended on by
Includes all join forms that the form specified in the Form Name field depend on.
Dialogs
Includes all dialog forms.
BMC Atrium Core 9.0
Page 1129 of 2268
Home
Form
Description
Forms with Data
Includes all forms with data in them.
Vendor Forms
Includes all vendor forms.
6. In the Changed since field, enter the date and time to limit the forms to those modified after
the specified time.
7. In the Include Hidden Forms field, specify whether to include hidden forms (the default
value) or not.
8. Click Add.
for the new plugin.
10. Click Show XML.
those tags.
15. Click Refresh.
should display Yes for the new plugin. If the Loaded column continues to display No, one of
the following conditions exists:
16. If your BMC Atrium Configuration Management Database (BMC Atrium CMDB) environment
uses a server group, make sure the same plugin is configured on all servers in the server
group. Repeat the following steps for each server:
17.
BMC Atrium Core 9.0
Page 1130 of 2268
Home
You now must create a data store to represent the external data in your BMC Remedy AR
System form. For more information, see Managing federated data stores.
Registering a federated data adapter with BMC Remedy AR System

If you want to federate data on an external source of data other than a JDBC-compliant database,
CMDBf-compliant CMDB, or BMC Remedy AR System server, you must register an adapter to
work with BMC Remedy AR System. For example, you could create a web services adapter or any
application-specific adapter such as an SAP adapter, an LDAP adapter, and so on. In BMC
Remedy AR System, these are known as ARDBC plugins. For more information about creating
ARDBC plugins, see ARDBC plug-ins introduction.
After you have created the adapter, you must register the adapter through the Federation Manager.
To register an adapter
3. In the Configure Repository Plugins and Adapters dialog box, click the Adapter
Registration tab.
4. Click New.
5. In the General tab of the Details section, enter the following information:
Parameters for registering a custom adapter
Field
Description
Name
A unique name for the adapter.
File Name
The location of the .jar file that defines the adapter.
Entry Class
The main entry class in the .jar file.
Path
The paths to the .jar file and all its supporting files, separated by semicolons.
Registering a custom adapter
6. (optional) In the More Information tab of the Details section, enter the following information:
More Information parameters
BMC Atrium Core 9.0
Page 1131 of 2268
6.
Home
Field
Description
Author
The name of the person or organization that wrote the adapter.
Description
A description of the adapter, such as its purpose.
7. Click Register.
The adapter is now available to be used by a plugin. The Other Properties tab appears
when you create plugins using the new adapter. You can click inside the cells in the Name
and Value columns to add a new properties and values for your custom adapter. Click Add
or Delete to add properties.
Managing federated data stores

A data store can represent multiple sources of external data. For example, a data store can
represent data from databases (retrieval type) or launch in context links. You can use the
Federation Manager to federate external data through a data store, making that data available to
view and query with BMC Atrium Configuration Management Database (BMC Atrium CMDB) tools,
such as BMC Atrium Explorer.
After you have created a data store, you can configure federated definitions using the retrieval and
launch methods.
Method
Steps
Retrieval
1. Create a federated data store.
2. Create a federated class.
3. Create a federated relationship.
Launch
1. Create a federated data store.
2. Create a launch interface.
3. Create a launch link.
create a new data store for the computer system information stored on a Microsoft SQL Server
database. You have already created a plugin for this database, as described in Creating plugins for
federated data.
To create or modify a data store

Federation Manager interface
BMC Atrium Core 9.0
Page 1132 of 2268
Home
2. In the toolbar, click Manage data stores and definitions.

3. In the Data Store dialog box, perform one of the following actions:
Action
Steps
Create a new data store
a. Select Create new Data Store.

b. Enter a name that briefly describes the data store.
c. Provide a full description of the data store.
d. Click Next.
The new data store is created after you click Next.
Modify an existing data store
a. Click Edit to modify the name or description of the data store.

b. Click Update to save your changes.
For example, the Calbro Services administrator would select Create new Data Store,
provide a name of Federated Weight Data for Banking Servers, describe the data store as
Microsoft SQL Server database for Banking Servers, and then click Next.
4. Select a federation method, and then click Next.
For example, the Calbro Services administrator would select Retrieval.
5. Proceed to one of the following sections, depending on the type of federation you selected:
If you selected
Proceed to
Retrieval
Retrieval method of federation (for conceptual overview)

Creating or editing a federated data class
Editing a federated data class
Launch
Launch method of federation (for conceptual overview)

Creating a launch interface

With the retrieval method of federation, you create BMC Atrium Configuration Management
Database (BMC Atrium CMDB) classes to represent data that is stored externally. The following
topics enable you to view the relationships between federated data and BMC Atrium CMDB data
through such tools as BMC Atrium Explorer and BMC Atrium Impact Simulator.
Creating or editing a federated relationship class
BMC Atrium Core 9.0
Page 1133 of 2268
Home
Supported data types in federation

As part of the process of creating a federated data class, BMC Atrium CMDB creates attributes to
represent the fields on the external repository. The data type of each attribute must be one of the
types supported by BMC Remedy AR System.
The BMC Remedy AR System data type of each attribute depends on the native data type on the
external repository. For example, Double fields on a JDBC-compliant repository are created as
BMC Remedy AR System Real fields in the federated data class. String fields on a
CMDBf-compliant external repository are created as BMC Remedy AR System character fields in
the federated data class.
Data types on the external repository do not change. The mapping occurs in BMC Atrium CMDB as
part of creating the federated data class.
For more information about BMC Remedy AR System data types, see Database data types for
view forms in the BMC Remedy Action Request System online documentation.
The following table lists the supported JDBC data types and their mapped BMC Remedy AR
System data types. Only the listed data types are created as attributes in BMC Atrium CMDB
federated data classes.
Supported data types for JDBC-compliant repositories
JDBC data type
BMC Remedy AR System data type
Bigint
Integer
Bit
Character
Boolean
Character
Char
Character
Clob
Character
Date
Date
Decimal
Decimal
Double
Real
Float
Real
Integer
Integer
Longvarchar
Character
Numeric
Decimal
Real
Real
Smallint
Integer
Time
Time
Timestamp
Date/Time
BMC Atrium Core 9.0
Page 1134 of 2268
Home
JDBC data type
Tinyint
Integer
Varchar
Character
The following table lists the supported CMDBf data types and their mapped BMC Remedy AR
System data types. Only the listed data types are created as attributes in BMC Atrium CMDB
federated data classes.
Supported data types for CMDBf-compliant repositories
CMDBf data type
String
Character
Decimal
Decimal
Integer
Integer
Date
Date
Time
Time

As part of the process of configuring the retrieval method of federation, you must define a federated
data class in the BMC Atrium Configuration Management Database (BMC Atrium CMDB) data
model. The federated data class represents a set of information about the external source of data (
such as a table on a database), so that data can be viewed within the context of the data model.
Federated data classes that you create are subclasses of the BMC_FederatedBaseElement
class.
The following topics provide information about creating or editing a federated data class:
Creating a federated data class
To edit a federated data class
To edit an attribute of a federated data class
Creating a federated data class

The following procedure includes examples for a Calbro Services administrator who wants to create
a new federated data class for computer system information stored on a Microsoft SQL Server
database. Specifically, you want to federate information for name, workgroup, last data transfer,
and so on. You have already created a plugin and data store for this database.
After you have created a federated data class, you must verify the new federated class and its
attributes.
BMC Atrium Core 9.0
Page 1135 of 2268
Home
To create a federated data class

1. In Federation Manager, open the External Data Repository page by using one of the
following methods:
As part of the procedure to create a new data store, as described in Managing
federated data stores.
In the navigation pane, select an existing data store. Then in the Retrieval
Definitions tab, click New next to the Federated Data Classes table.
Create launch interface method
Method
Creating a new data store
Steps
a. Create a new data store. For more information, see Managing
b. On the Federation Definition Method page, select Retrieval.
c. Click Next.
Create launch definition in an existing

data store
a. In Federation Manager, select a data store from the list.

b. Click the Retrieval Definitions tab.
c. Click New next to the Federated Data Classes table.
2. From the Repository list on the External Data Repository page, select the plugin that you
want to use to connect to the data store.
For example, the Calbro Services administrator would select the banking server plugin, as
created in Creating plugins for federated data.
Note
If you defined a plugin alias in the ar.cfg file that is different from the plugin name,
the alias is listed in the Repository field.
3. From Available Tables, select a table that you want to access on the external data
repository, and then click Next.
For example, the Calbro Services administrator would select the BankingServers table.
4. On the Federated Data Class General Information page, review or provide the following
information, and then click Next:
A namespace for the new federated data class.
By default, new federated data classes are in the BMC.FED namespace. For more
information, see Namespaces and partitioning the data model .
(optional) A valid name for the class. You can use only the following characters: a-z,
A-Z, 0-9, and a period. By default, the Name field is auto-filled, based on the table
you selected previously.
(optional) The name of the person or company creating this class.
BMC Atrium Core 9.0
Page 1136 of 2268
Home
(optional) A description of the class.

For example, the Calbro Services administrator would select the BMC.FED
namespace and name the class CAL_BankingServers.
If your organization follows particular naming conventions when extending the data
model, apply those conventions to this class.
5. On the Field Selection page, select the data fields on the external data source that you want
to make available through federation:
a. From the Fields Available in the External Table list, select a field, and then click
Add.
b. Continue adding fields to the Attributes in the CMDB Federated Class list until you
have added all of the fields that you want to be available in the new class.
c. Use the Key Attribute menu to select a field in the new federated data class as the
key identifier for the class.
Note
Select a field that contains a unique value for each instance in the table. The
key identifier should be either a character or integer field on the external
source of data. When you submit the federated data class, the key field is
created in BMC Atrium CMDB as a character field. When the underlying
vendor form that represents the federated data class is created, the key
identifier field is internally mapped to the Request ID field (field ID 1).
d. Click Next.
For example, the Calbro Services administrator would add the PrimaryKey, Name,
Priority, LastDataTransfer, and Workgroup fields as attributes in the new federated
data class, and would specify PrimaryKey as the key attribute.
6. Review or assign Hidden and Visible permissions for the new class, and then click Next.
For more information about BMC Atrium CMDB permissions, see BMC Atrium CMDB data
permissions for classes and attributes and Setting class permissions in the Class Manager .
7. On the Summary page, review the details for the federated data class, and then perform one
of the following actions:
Action
Create the federated data class and then start the
process of creating a federated relationship class.
Steps
a. Select Create the Data Class and Continue with
Relationship Class Creation.
b. Click Next.
c. If the federated data class is successfully created, click OK
to close the SUCCESS dialog box.
d. Create the federated relationship class.
For more information about creating a federated
relationship class, see Creating or editing a federated
relationship class.
Create the federated data class only.
BMC Atrium Core 9.0
a. Select Create the Data Class and then Exit.
b.
Page 1137 of 2268
Home
Action
Steps
b. Click Finish.
To verify the new federated class and its attributes

2. Select the BMC_FederatedBaseElement class.
Your new federated class is displayed as a subclass next to it.
3. Double-click the federated class to open the CI Class dialog box.
4. Review the general properties of the federated class.
5. Click the Attributes tab and review the fields that you selected from your external data
repository.
These are listed as attributes in your federated class.
6. Click OK.
To edit a federated data class

As your installation of BMC Atrium CMDB matures, you might want access to a different set of data
than you originally made available through a federated data class. For example, a database might
have new information about banking servers that you want to associate with Configuration Items (
CIs) in BMC Atrium CMDB.
Note
You cannot modify the plugin name, table name, or key attribute associated with a
federated data class.
1. In Federation Manager, select the data store containing the federated data class that you
want to edit.
2. In the Retrieval Definitions tab, select the federated data class you want to edit, and then
click Edit.
3. In the General tab of the Edit Federated Data Class dialog box, verify the setting for the
Allow Unqualified Queries check box.
By default, the field is not selected, forcing you to enter a qualification when querying for
data in this class. If you want users to be able to submit unqualified queries for this class,
select the check box.
4. If necessary, change the Visible and Hidden permissions for the class.
5. Click the Attributes tab.
6. Click Add or Remove to configure which fields on the external table are included as
attributes of the federated data class.
BMC Atrium Core 9.0
Page 1138 of 2268
6.
Home
Note
Do not remove the key attribute from the federated data class.
7. Click OK.
To edit an attribute of a federated data class

Attributes for federated data classes function well without editing. However, you can change some
characteristics of the attributes. For example, you might want an attribute to have a name different
from the one used on the external source of data.
1. In Federation Manager, open the federated data class that you want to edit.
2. In the Edit Federated Data Class dialog box, click the Attributes tab.
3. In the list of attributes used in the federated class, click the edit button next to the attribute
that you want to edit.
4. In the Attribute - Edit dialog box, edit values for any of the following fields:
Attribute Name
Namespace
Any field that controls the storage capacity for the attribute (such as Max Length)
5. Click OK to save the changes to the attribute.
6. In the Edit Class dialog box, click OK.
Creating or editing a federated relationship class

To establish relationships between Configuration Items (CIs) stored within BMC Atrium
Configuration Management Database (BMC Atrium CMDB) and external data, you must configure a
federated relationship class in the data model. Federated relationship classes that you create are
subclasses of the BMC_FederatedBaseRelationship class. The source class of the
relationship must be in the BMC_BaseElement hierarchy of classes, and the destination class of
the relationship must be a federated data class. For more information about relationships between
CIs, see Relationships among CIs in a CMDB .
The following topics provide information about creating or editing a federated relationship class:
Recommendations
Creating a federated relationship class
To edit a federated relationship class
Recommendations
Create a federated relationship that links the CI class to your federated data class. Define a
qualification that specifies which instances from the source class are related to data in the
destination class. This qualification requires matching an attribute in the federated data class to an
attribute in the CI class (for example, matching IDs between two sets of CIs).
BMC Atrium Core 9.0
Page 1139 of 2268
Home
For best performance with your production system, remember that the more federated data that
you pull in with your qualification, the more likely you will experience poor performance from the
BMC Remedy AR System server. Your qualification should return only a limited result set from the
federated repository.
Creating a federated relationship class

The following procedure includes examples for a Calbro Services administrator who wants to create
a new federated relationship class that enables users to see federated data that is related to
computer system CIs stored in BMC Atrium CMDB. You have already created a plugin and data
store for this database, and has created a federated data class for the incident information.
After you have created a federated relationship class, you must verify the new federated
relationship class and its attributes
To create a federated relationship class

1. In Federation Manager, open the Federated Relationship Class dialog box by using one of
the following methods:
As part of the procedure to create a new data store and federated data class, as
described in Managing federated data stores and Creating or editing a federated data
class.
On the Retrieval Definitions tab, select an existing federated data class to be the
destination class, and then click New next to the Federated Relationship Classes
table.
2. In the Namespace field, select a namespace for the new federated data class.
By default, new federated data classes are in the BMC.FED namespace. For more
information, see Namespaces and partitioning the data model .
3. In the Name field, enter a name for the class.
For example, the Calbro Services administrator would name the class
CAL_FederatedBankingServersData.
If your organization follows particular naming conventions when extending the data model,
apply those conventions to this class.
4. (optional) Enter the following information, and then click Next:
Author
The person or provider that created this class.
Description
The purpose of the class, such as the CI and federated data classes that it relates.
5. In the Source and Destination Classes page, select a source CI class for the relationship.
By default, the current federated data class appears as the destination class.
For example, the Calbro Services administrator would select a source class of
BMC_ComputerSystem.
6.
BMC Atrium Core 9.0
Page 1140 of 2268
Home
6. Click Qualification Builder to create the qualification.

Create a qualification for the relationship to specify which instances of the source class are
related to the data in the destination class. Creating a valid qualification is necessary to
create the link between the CI instance and the external data in the federated class.
a. Select an attribute from the source class. Attributes for the source class are
automatically enclosed in single quotation marks.
b. Select an operator.
c. Select an attribute from the destination class. Attributes for the destination class are
automatically enclosed in dollar signs.
Qualification Builder
For example, the Calbro Services administrator would build the following qualification
to relate computer systems to external information about the banking servers:
'Name'=$Name$
d. Click OK.
7. Click Next.
8. Assign Hidden and Visible permissions for the new class, and then click Next.
For more information about BMC Atrium CMDB permissions, see Class permissions on BMC
Atrium CMDB data.
9. Review the details for the federated relationship class.
10. If you are satisfied with the details, click Finish.
11. If the federated relationship class is successfully created, click OK to close the SUCCESS
dialog box.
If you created a successful match between records from the CI class and the federated class
, you can view them in BMC Atrium Explorer. For example, see Viewing federated data in
To verify the new federated relationship class and its attributes

2.
BMC Atrium Core 9.0
Page 1141 of 2268
Home
2. Select the BMC_FederatedBaseRelationship class.

Your new federated relationship class is displayed as a subclass next to it.
3. Double-click the federated relationship class to open the Relationship Class dialog box.
4. Review the general properties of the federated relationship class.
5. Click the Attributes tab and review the source and destination attributes.
6. Click OK.
To edit a federated relationship class

As you change the amount and type of data that you store in BMC Atrium CMDB and external
sources of data, you might need to modify the federated relationship class that relates CIs to
federated data. For example, if you increase the number of fields stored as attributes of a federated
data class, you should alter the qualification in the federated relationship class.
1. In Federation Manager, select the data store containing the federated relationship class that
you want to edit.
2. In the Federated Data Classes table of the Retrieval Definitions tab, select the federated
data class associated with the federated relationship class that you want to edit.
3. In the Federated Relationship Classes table, select a class, and then click Edit.
4. In the Edit Federated Relationship Class dialog box, modify the qualification that relates
instances of this class to instances of a CI in the BMC Atrium CMDB.
5. If necessary, change the Visible and Hidden permissions for the class.
6. Click OK.

With the launch method of federation, you define the method of viewing the data (such as opening
the data on a BMC Remedy AR System form), and then you create a federated link between that
data and Configuration Items (CIs) in BMC Atrium Configuration Management Database (BMC
Atrium CMDB).
Following are the high-level steps for setting up the launch method of federation. You can also refer
to the scenario that demonstrates how to use the launch method of federation .
1. Create a federated data store that defines an external source of data related to CIs.
Data stores are also known as federated products.
2. Create a federated launch interface that specifies a method of getting the data from a
federated product.
Launch Definitions tab in Federation Manager
BMC Atrium Core 9.0
Page 1142 of 2268
Home
Launch interfaces are also known as federated interfaces.

3. Create a federated launch link that connects one or more CIs to the federated data by using
the method specified by a federated interface.
Launch links are also known as federated links.
For example, you could use the AR System query method to access data from a BMC Remedy AR
System form. You could also use the URL method to access any website to which you allow
browser access.
Users can view the data using the access method that you specified by clicking Open launch in
context menu in BMC Atrium Explorer. For more information about viewing federated data through
BMC Atrium Explorer, see Viewing federated data in BMC Atrium Explorer .
Note
BMC Remedy IT Service Management uses the launch method to integrate its application
suite out-of-the-box with BMC Atrium CMDB. For example, you can select a CI in BMC
Atrium Explorer and then click Open launch in context menu to view related change
requests or related incidents.

A launch interface (also known as a federated launch interface) specifies the method for accessing
a particular type of federated data from a specified federated product. It is the connection between
Configuration Items (CIs) and the federated data about them.
Launch interfaces can link to either a specific CI or a set of CIs. This gives you the ability to create
one launch interface at design time instead of having to create a new interface every time you
create an instance of the CI class.
BMC Atrium Core 9.0
Page 1143 of 2268
Home
For more information, see also Classes or CIs linked to a federated interface .
A class-level launch interface uses either attribute substitution or foreign key substitution to access
its federated data in the context of a given CI. For more information about these concepts, see
Federation methods in BMC Atrium CMDB .
A launch interface uses one of these access methods to launch its federated data store:
AR A query to a BMC Remedy AR System form. You specify the server, form, view, and
query string, and select whether to launch the query in a web client.
URL A Uniform Resource Locator (URL) for accessing websites.
Run Process An executable on the BMC Atrium Configuration Management Database (
BMC Atrium CMDB) server computer. You can specify parameters in the access string.
Manual Instructions for finding data manually.
To create a launch interface

1. In Federation Manager, create a new launch interface by one of the following methods:
Create launch interface method
Method
Creating a new data store
Steps
a. Create a new data store. For more information, see Managing
b. On the Federation Definition Method page, select Launch.
c. Click Next.
The Launch Interface Definition page appears.
Create launch definition in an existing

data store
a. In Federation Manager, select a data store from the list.

b. Click the Launch Definitions tab.
c. Click New.
The Launch Interface Definition page appears.
Creating new federated launch interface
BMC Atrium Core 9.0
Page 1144 of 2268
Home
2. In the Name field, type a name for this launch interface.

3. In the Description field, type a description for this launch interface.
4. In the Access Method list, select the method that you want to use.
Access
method
To define the access method
AR
a. In the Access Method list, select AR.

b. In the Launch Methodlist, select the launch method that you want to use when the interface is
launched:
Native Launch the query in a browser form if you use BMC Atrium Explorer. Otherwise, launch
the query in BMC Remedy User if you are viewing the current UI from BMC Remedy User. (BMC
Remedy User is discontinued in the 8.0.00 release of the BMC Remedy AR System.)
Web Launch the query in a browser.
c. In the Server Name field, type the name of the server containing the form.
d. In the Form Name field, type the name of the BMC Remedy AR System form that you want to query.
e. (optional ) In the View Name field, type the view of the form to display.
f. (optional ) In the Queryfield, type the qualification that you want to use. Enclose field names in single
quotation marks ('). You can use any combination of the following keywords:
$<attributeName>$ Value of any specified attribute of the instance from which this interface is
launched in context. Use this keyword for attribute substitution.
$#KEY#$ Value of the foreign key on the relationship between the federated product being
launched in context and the instance from which it is being launched. Use this keyword for
foreign key substitution.
$#WEBPATH#$ Default web path for this BMC Remedy AR System server.
$#CLASSNAME#$ Class name of the instance from which this interface is launched in context.
$#CLASSNAMESPACE#$ Namespace of the class of the instance from which this interface is
launched in context.
URL
a. In the Access Method list, select URL.
BMC Atrium Core 9.0
Page 1145 of 2268

b.
Home
Access
method
To define the access method
b. Type the URL that you want to use in the Access String field. For example:
* http://<computerName>/SDE/default.asp?ModSeq=15&Sequence=$Sequence$&FormSeq=15*You
can substitute any value in the URL with an attribute from the CI in BMC Atrium CMDB. You can also
use any of the keywords listed for the Query field of the AR access method.
Note: You can enter a maximum of 254 characters in the Access String field.
For more information (including a helpful use case), see Using the launch method of federation.
Run
a. In the Access Method list, select Run Process.
Process
b. Type the path to the executable in the Access String field. For example:
"C:\Program Files\Adobe\Acrobat 7.0\Reader\AcroRd32.exe"
c:\www5_toysrus_com_Our.pdf
The executable runs only if it exists on the client computer. If you want the executable to run on a
remote server computer, place the executable on a shared network drive, and specify a Run Process
path that uses the shared drive. You can use any of the keywords listed for the Query field of the AR
access method. For more information about Run Process actions, see Run Process action.
Note: Browsers cannot launch federated data using the Run Process access method.
Manual
a. In the Access Method list, select Manual.

b. Type informative text in the Access String field. For example:
To find the master password for all accounts, open the company safe deposit box.
5. Click Next.
Defining row-level security access to federated launch definition
6.
BMC Atrium Core 9.0
Page 1146 of 2268
Home
6. In the Row Level Security window, select which groups and roles should have row-level
access for the federated launch interface.
The Public group is selected by default. This means that any user who can access the UI
can launch this federated interface. To view or modify a specific launch interface, you must
also have row-level access to that instance. For more information, see Roles, instance
permissions, and row-level access.
7. Click Finish.
The launch interface appears in the table.
Classes or CIs linked to a federated interface

A launch link connects a launch interface to a CI or class. A class-level link can optionally include a
qualification that selects which of its instances are linked.
Linking by instance
Linking at the instance level creates a relationship between one instance in BMC Atrium CMDB and
an interface to a particular piece of federated data. You must create a separate link for each
instance from which you want to access federated data. This type of launch link is useful when you
want to restrict access to the federated data. For example, if your CEO has the only monitor in your
environment for which an extended warranty was purchased, you might create a link from that
monitor instance in BMC Atrium CMDB to information about the extended warranty.
Linking by class
Linking at the class level enables you to specify one link that connects, for example, all computer
systems in your environment to the incident records that pertain to them. You can optionally specify
that the link applies to only a subset of computer systems by adding a qualification. Linking at the
class level creates a relationship between one BMC Atrium CMDB class and an interface to a
particular piece of federated data. This method is recommended in most cases.
Note
Launch links are not bidirectional. They allow you only to access external data from BMC
Atrium CMDB. Though some BMC applications provide links to data in BMC Atrium
CMDB and you could create such links from third-party applications, these capabilities are
independent of the federation features of BMC Atrium CMDB.
Where to go next
Creating launch links
BMC Atrium Core 9.0
Page 1147 of 2268
Home

You use Federation Manager to create a launch link that connects a launch interface to a
Configuration Item (CI) or class.
Creating a federated launch link
To create a launch link

1. In Federation Manager, select a federated data store.
2. Click the Launch Definitions tab.
3. Select a federated launch interface.
4. In the Federated Launch Links area, click New.
5. In the Link Description field, type a general description for this launch link.
6. In the Link Destination section, review or enter the following information:
Link To (read-only)
Name
Description
7. In the Link Source section, select one of the following series of steps.
Tip
BMC Atrium Core 9.0
Page 1148 of 2268
7.
Home
A Class link is usually better than an Instance link because it allows multiple
instances to access external data from a single launch link, rather than requiring a
link for each instance.

Link
from
source
Steps
Class
a. In the Link From field, select Class.

b. In the Class Name field, select a class (for example, BMC_CORE:BMC_ComputerSystem ).
c. Click Qualification Builder to create the qualification to specify which instances of the Source class
are linked. For example, build the qualification 'MarkAsDeleted' = $NULL$ to restrict the link to
instances that have not been soft deleted.
If you do not add a qualification, all instances of the Source class are linked. Because the launch
interface is an instance of the BMC.CORE.CONFIG:BMC_FederatedInterface class, the Class
Type, Namespace, and Class Name fields are preset and disabled. For more information about using
the Qualification Builder, see Creating or editing a federated relationship class.
Instance
a. In the Link From field, select Instance.

b. In the Class Name field, select a class (for example, BMC_CORE:BMC_ComputerSystem ).
c. In the Instance ID field, type the ID of the BMC Atrium Configuration Management Database (BMC
Atrium CMDB) instance.
d. In the Dataset ID field, type the ID of the dataset where the instance resides.
8. When you finish providing details for the launch link, click Next.
9. In the Row Level Security window, select which groups and roles should have row-level
access for the federated launch link.
The Public group is selected by default. This means that any user who can access the UI
can launch this federated link. To view or modify a specific launch link, you must also have
row-level access to that instance. For more information, see Roles, instance permissions,
and row-level access.
10. Click Finish.
The launch link appears in the table.
Using the launch method of federation

The following scenario demonstrates how to leverage federation links within Federation Manager by
selectively launching a URL that accesses the attribute values of a Configuration Item (CI) and
uses them in the URL (in this case, the URL to launch BMC Service Desk Express).
In BMC Atrium Configuration Management Database (BMC Atrium CMDB), Computer
System CIs contain specific attribute data for each of the configuration item records inside
the CMDB (for example, Name, Type, Item, and so on).
Note
BMC Atrium Core 9.0
Page 1149 of 2268
Home
To integrate BMC Atrium CMDB with BMC Service Desk Express for this use case, the
Computer System class was extended and new attributes were added (for example,
Sequence )
In BMC Service Desk Express, configuration item records are stored within BMC Service
Desk Express itself. You can reference them by a unique sequence number. A formatted
URL string contains all the necessary information to launch the correct record. For example:
* http://<computerName>/SDE/default.asp?ModSeq=15&Sequence=1002&FormSeq=15*
When formatting the URL, BMC Service Desk Express lets you open any record by
identifying its:
Related module (represented by the ModSeq value)
Records sequence (represented by the Sequence value)
Form sequence number (represented by the FormSeq value)
Including these values in the URL launches the correct record within BMC Service
Desk Express and automatically opens it in a browser.
Before you begin

Review the following sections:
Classes or CIs linked to a federated interface
You must create or use a federated data store, as shown in the following figure.
Federated data store
For more information, see Managing federated data stores.
To use the launch method of federation

1. In Federation Manager, select the federated data store.
2. Click the Launch Definitions tab.
3.
BMC Atrium Core 9.0
Page 1150 of 2268
Home
3. Define the federated launch interface.

You start by modifying the URL string that launches your application. For example, you
would modify the following URL used to access CI records in BMC Service Desk Express:
* http://<computerName>/SDE/default.asp?ModSeq=15&Sequence=1002&FormSeq=15*
When you modify the formatted URL access string for use with the launch method, you can
substitute any value in the URL with an attribute from the CI in BMC Atrium CMDB.
Note
In a localized environment, using the attribute ID works with all languages.
For example, the $Sequence$ keyword is substituted for the sequence ID number (1002) in
the URL. The launch interface now contains the following formatted URL access string:
*http://<serverName>/sde/default.aspx?ModSeq=158&Sequence=$Sequence$&FormSeq=
11*
When you launch the URL, $Sequence$ is replaced with the actual value of the Sequence
attribute.
This string is added to all CI records, represented as an attribute of the CI. In this example,
the hardcoded value for the sequence number (1002) is replaced with the appropriate
attribute name that references the CI record in BMC Service Desk Express. This attribute
must be available within BMC Atrium CMDB to replace the $Sequence$ variable with the
correct CI record sequence number when the Federated Launch Link is used.
Defining the federated launch interface
4. Define the federated launch link.

You use launch links to filter or create specific qualifications for the CI records that the
launch link applies to. In the following example, the business requirement is to limit the
federated launch link to another web-based application for those CIs that are specified.
You must create a qualification that controls which records the federated launch links can
BMC Atrium Core 9.0
Page 1151 of 2268
Home
access by class (BMC.CORE:BMC_ComputerSystem):

'Manufacturer' = "DELL" AND 'Type' = "LAPTOP"
With this qualification, you specify that you want only Dell laptop Computer System CIs to
have launch links.
Defining the federated launch link
5. Search in your dataset for the Computer System CI.

The Federated Launch Link is accessible within BMC Atrium Explorer. If the CI meets the
link qualifications, you can open the Launch-method federated links for the selected instance
. For example, you can now launch the BMC Service Desk Express application URL defined
in the federated launch interface, as shown in the following figure.
Launching BMC Service Desk URL from the instance
BMC Atrium Core 9.0
Page 1152 of 2268
Home
The Launch Link Interface uses the Sequence attribute value in the BMC Atrium CMDB CI
record and substitutes it in the URL string to launch the correct CI record in the web-based
BMC Service Desk Express application.
Launching federated CI in web-based application
BMC Atrium Core 9.0
Page 1153 of 2268
Home

The Extension Loader feature enables you to install BMC Atrium Configuration Management
Database (BMC Atrium CMDB) classes from one server to another. Use the Extension Loader
either to extend the BMC Atrium CMDB or to install an extension pack. The Extension Loader can
also install objects other than the data model extensions. However, this section covers only the
instructions for installing class and attribute extensions including:
Accessing the Extension Loader
Manually creating BMC Atrium CMDB extensions
Installing BMC Atrium CMDB extensions
Verifying your installed extensions
You can generate class extensions by using the following methods:
Create installer action files manually (see Manually creating BMC Atrium CMDB extensions )
and install new extensions (see Installing BMC Atrium CMDB extensions). BMC
recommends that you use this method.
Package the extension files (see Packaging BMC Atrium CMDB extensions). These files are
not in the proper format and you must use the Extension Loader to convert them.
For more information about extending the CDM, see Creating, modifying, or deleting classes with
the Class Manager. If you encounter errors when using the Extension Loader to install the
extensions, see:
Extension loader not responding
Other common extension loader issues
Accessing the Extension Loader

The Extension Loader is part of the BMC Atrium Core Maintenance Tool, which is installed with
BMC Atrium CMDB.
To access the extension loader

1. Depending on your environment, perform the following steps to access the Extension Loader
:
Microsoft Windows
From <bmcInstallDir>\BMC Software\AtriumCore\atriumcore, double-click
UNIX
Navigate to your installation directory and run ./AtriumCoreMaintenanceTool.sh.
2. Click the Configuration tab to install the extensions.
BMC Atrium Core 9.0
Page 1154 of 2268
Home
Manually creating BMC Atrium CMDB extensions

You can create the new extension manually in an XML file, which has several sections that
correspond to the installer action files in Packaging BMC Atrium CMDB extensions.
When you have defined the XML file for the new extension, see Installing BMC Atrium CMDB
extensions.
Extension registration and dependency
Extension Loader instructions
Extension order commands
Extension registration and dependency

This section of the XML file defines the registration and dependency information for the extension.
The registration information defines the extension that you are creating. When the extension loader
runs, it stores the extension registration values that you specify in the package.xml file, such as
the extension name, version, and GUID in the SHARE:Application_Properties form.
A GUID is a unique ID for the extension. This ID is used by the extension loader program to
determine if an extension is already installed. After you create an extension with a specific GUID,
you can only change the version number to update the extension. The GUID remains the same for
the life span of an extension.
"<stage level=""RegisterExtensions"">
<rik_command>
<subcommand>appinfo</subcommand>
<log_dir>$BMC_CMDB_EXTENSIONS_DIRECTORY$</log_dir>
<log_name>BMCCMDBExtensionLoader</log_name>
<guid>ID00C04FA081BAg7YTQwYNXncALwcA</guid>
<property_name>Name</property_name>
<mode>ITSM-CMDB extension #1</mode>
<property_status>0</property_status>
<server_info_parameter>set</server_info_parameter>
<no_output_to_console/>
<no_new_log/>
<note>Installing ITSM-CMDB extension #1</note>
</rik_command>
<rik_command>
<subcommand>appinfo</subcommand>
<guid>ID00C04FA081BAg7YTQwYNXncALwcA</guid>
<property_name>Version</property_name>
<mode>7.0</mode>
<property_status>0</property_status>
<server_info_parameter>set</server_info_parameter>
<no_output_to_console/>
<no_new_log/>
BMC Atrium Core 9.0
Page 1155 of 2268
Home
</rik_command>
</stage>
Define the version of BMC Remedy AR System:
<ar_version_condition operation="GREATER_THAN_OR_EQUALS_TO" version_operand="7.6"/>
Define the minimum and maximum version of BMC Atrium CMDB:
"<version_condition guid=""OB00C04FA081BABZlxQAmyflAg1wEA""operation=""
GREATER_THAN_OR_EQUALS_TO""version_operand=" "1.0""/>
<version_condition guid=""OB00C04FA081BABZlxQAmyflAg1wEA"" operation=""LESS_THAN_OR_EQU
ALS_TO""version_operand=""9.0""/>"
Extension Loader instructions

Define the instructions for the Extension Loader to perform an action.
Workflow command commands

"
<rik_command>
<subcommand>loadapp</subcommand>
<file_name>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$600-CDMExtensions$/$100workflow-RIK.xml</file_name>
<component_mask>0</component_mask>
<mode>newall</mode>
<output_to_console/>
<no_new_log/>
</rik_command>"
cmdbdriver commands
"
<cmdb_driver_command>
<file_name>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$600-CDMExtensions$/$200CDMExtensions-OSD.txt</file_name>
<output>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$DriverLog</output>
</cmdb_driver_command>"
BMC Remedy AR System driver script commands

"
<driver_command>
BMC Atrium Core 9.0
Page 1156 of 2268
Home
<file_name>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$800-SIMWorkflow$/$800SIM-Workflow-ARD.txt</file_name>
<output>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$DriverLog</output>
<note>Installing SIM: CMDB Workflow</note>
</driver_command>"
Commands for importing data into BMC Remedy AR System forms

"
<rik_command>
<subcommand>dataimp</subcommand>
<log_dir>$BMC_CMDB_EXTENDION_LOADER_OUTPUTDIR$</log_dir>
<file_name>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$502-TDONLY$/$501-
tdonly-datasets-IMP.arx</file_name>
<mode>newall</mode>
<server_info_parameter/>
<output_to_console/>
<no_new_log/>
<note>Installing TD ONLY for Reconciliation Engine</note>
</rik_command>"
Extension order commands

<stage_group dir="$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$600CDMExtensions" env="$BMC_UTILITY_ENVIRONMENT_VARIABLE$" name="600CDMExtensions">
Installing BMC Atrium CMDB extensions

You can install BMC Atrium CMDB extensions in the following ways:
From the BMC Atrium CMDB Maintenance Tool (see Installing extensions with the Extension
Loader)
With the silent installer (see Installing extensions with silent installer (command line) )
When you have completed installing the extensions, see Verifying your installed extensions.
Possible outcomes of extension installations

When you install an extension, the following outcomes are possible:
Passed The execution of XML was successful.
Failed The execution of the extension caused an error.
Extension upgraded = The version of the extension in the file is greater than that found in the
BMC Remedy AR System server, the extension in the file is executed and installed.
Extension already exists The version of the extension in the file is same as that found in
the BMC Remedy AR System server.
BMC Atrium Core 9.0
Page 1157 of 2268
Home
New Version of Extension already exists The version of the extension in the file is smaller
than that found in the BMC Remedy AR System server.
Extension already failed An installation of the extension you are trying to install has
already failed. You are unable to complete the extension installation. Contact BMC
Customer Support to resolve the issue.
Extension in running state A previous installation of the extension is already running, such
as when you stop the extension installation before it has completed. You are unable to
complete the extension installation. Contact BMC Customer Support to resolve the issue.
Dependency Failure The version conditions mentioned in the XML file (such as <
ar_version_condition> and <version_condition>) do not comply with that of BMC Remedy
AR System server.
Installing extensions with the Extension Loader

You can install extensions of BMC Atrium CMDB classes created on another server or install an
extension pack from a valid XML file. The extension file is validated before it is executed.
Before you begin

You must have a valid XML extension file (for example, ExtensionLoader.xml ).
You must have server and administrative logon information to BMC Remedy AR System.
To install extensions
1. From the Configuration tab, select Run Extensions.
2. Click Browse to locate and select the ExtensionLoader.xml XML file with the extension
data.
3. Click Next.
4. Provide the following BMC Remedy AR System information, and then click Next:
Field
Description
User
Name
Specify an administrator user name.
Password
Type the password for the administrator user name.
Port
Number
If you specified a port number when installing the BMC Remedy AR System server, type that number in this
field. If the server uses a portmapper to automatically select a port to use, leave this field blank.
AR Server
Host
Name
Type the BMC Remedy AR System server on which you want to install the extensions.
5. Click Run.
An installation summary indicates if the generation succeeded or failed, including a brief
reason for the failure, such as:
The structure of the XML is not proper. Please ensure tags are
closed properly.
6. For a failure, click View Log to find details.
a.
BMC Atrium Core 9.0
Page 1158 of 2268
Home
6.
a. In the atriumcore_configuration_log.txt window, sort by Severity.

b. Look for SEVERE messages highlighted in red.
c. Select a message to display the details at the bottom of the window.
7. To return to the initial generation view, click Done.
Installing extensions with silent installer

For installing extensions, an alternative to the BMC Atrium CMDB Maintenance Tool is a
command-line interface. Installed with BMC Atrium CMDB, cmdbExtLoader.jar is a file to use with
Java, and it requires an .ini file which specifies the parameters for connecting to BMC Remedy AR
System and for installing extensions.
Before you begin
To create and edit the initialization file
To run the silent installation
Initialization file template for the silent installation of extensions
Before you begin

You must have JRE 1.5 or later installed, which is included with the BMC Atrium CMDB.
You must have a valid XML extension file (for example, ExtensionLoader.xml).
You must have BMC Remedy AR System logon and server information.
To create and edit the initialization file

1. In a text editor, copy the content provided in Initialization file template for the silent
installation of extensions.
2. To specify the BMC Remedy AR System user name, remove the # for the following line, and
replace <AR System Admin User> with the user name.
BMC_AR_USER=<AR System Admin User>
3. To specify the password for the user name, remove the # for the following line, and replace
<AR System User Password> with the user password.
BMC_AR_PASSWORD=<AR System User Password>
4. To specify the name of the BMC Remedy AR System server, remove the # for the following
line, and replace <Server Alias> with the server name.
BMC_AR_SERVER_NAME=<Server Alias>
5. To specify the port for the BMC Remedy AR System server, remove the # for the following
line, and replace <AR System TCP Port> with the port number.
BMC_AR_PORT=<AR System TCP Port>
6. Remove the # for the following line.
#BMC_CMDB_EXTENSIONS_FILE=<full_path_ to_
the_extension_loader_xml_file_including_the_file_name>
7.
BMC Atrium Core 9.0
Page 1159 of 2268
Home
7. Replace the <

full_path_to_the_extension_loader_xml_file_including_the_file_name>
line with the path and name of the XML file with the extensions.
Note
On Microsoft Windows, you must use double slashes in the path.
For example:
C:\\Program Files\\ExtLoader\\ExtensionLoader.xml
8. Save the file with a .ini extension.
To run the silent installation

1. If needed, create a directory for the log file.
2. Run the following command and parameters:
java -cp <bmcInstallDirectory>/cmdb/sdk/bin/cmdbExtLoader.jar
com.bmc.install.product.atriumfoundation.ExtLoaderRunTaskCmdLine input_file <fullPathToiniFile> -outputlog <fullPathToDirectory>
3. To review the status messages when the installation is complete, open the summary.txt log
file in the specified directory.
For more information about the status information you can find in the summary.txt file, see
Possible outcomes of extension installations.
Initialization file template for the silent installation of extensions

The following text is a template for the initialization file that is required for the silent installation of
extensions.
##################################################################
# Options File
#
# Product Name: BMC Atrium Core
# Product Version: 7.5.00
#
# Utility: cmdbExtLoader
# To invoke the utility in silent mode with an options file:
##################################################################
##################################################################
# AR Server Properties
# AR user. Uncomment the below line and replace the <AR System Admin User> with the AR
Username
#BMC_AR_USER=<AR System Admin User>
BMC Atrium Core 9.0
Page 1160 of 2268
Home
# AR password. Uncomment the below line and replace the <AR System User Password> with
the AR Password
# AR server Name. Uncomment the below line and replace the <Server Alias> with the AR
Server Name
#BMC_AR_SERVER_NAME=<Server Alias>
# AR port. Uncomment the below line and replace the <AR System TCP Port> with the AR
Server Port No:
##################################################################
# Extension Loader Properties
# <full_path_ to_ the_extension_loader_xml_file_including_the_file_name> with the
Extension Loader XML file
# Please note that the windows file path must be specified as C:\\Program Files\\
ExtLoader\\extLoader.xml"
#BMC_CMDB_EXTENSIONS_FILE=<full_path_ to_
the_extension_loader_xml_file_including_the_file_name>
Verifying your installed extensions

If your extensions are successfully installed on the server, you can view an entry for the application
that added the extensions in the SHARE:Application_Properties form (the following figure).
SHARE:Application_properties form example
To verify installed extensions

1. Log on to the BMC Remedy AR System server on which you installed the extensions using a
web browser.
2.
BMC Atrium Core 9.0
Page 1161 of 2268
Home
2. Open the SHARE:Application_Properties form.

Use the following direct access URL:
http://<_midTierServer_>:<_port_>/arsys/forms/<_arSystemServer_>/SHARE:
Application_Properties
3. Make sure that the form is in Search mode.
4. Click Search.
A list of entries for various applications that are installed on the server is displayed in the
result section of the SHARE:Application_Properties form.
5. Click the entry that pertains to the application for which you installed the extension.
6. Verify the details of the extension such as Name and Version.

You can migrate data from one BMC Atrium Core server to another. The most common reason to
migrate data from one server to another is to move your BMC Atrium Core implementation into
production.
When you install BMC Atrium Core, you first work on a development server to design your system.
After you refine and test your system on the development server, you migrate BMC Atrium Core to
a production server. The production server is a copy of the development server that is ready for
your users.
Before migrating your BMC Atrium Core data, make sure both your BMC Atrium Core servers are
configured and running.
When migrating BMC Atrium Core, migrate the components in the following order so that the
correct dependencies are in place.
1) Migration of BMC Remedy AR System support data from source servers to target servers
2) Migrating BMC Atrium CMDB class definitions and instances
3) Migration of Product Catalog data
4) Migration of normalization jobs and settings
5) Migration of reconciliation jobs and dataset settings
6) Manual configuration of federated data on your production server
Note
These procedures cover the steps for migrating only BMC Atrium Core settings and data.
If you have other BMC applications installed on your development server that integrate
with BMC Atrium Core, such as BMC Remedy Asset Management, you must migrate that
data separately.
BMC Atrium Core 9.0
Page 1162 of 2268
Home
Related topics
BMC Remedy Migrator process overview
Migrating delta data after an upgrade
Migrating BMC Remedy AR System support data from source

servers to target servers
When you migrate your work from development to production, use BMC Remedy Data Import to
move all customized data from the Group, User, and Roles forms on the source server to the target
server. Without these records, users logged in to the production environment neither have proper
access to different applications in BMC Atrium Core nor access to application roles, class and
attribute permissions, and instance permissions, as you configured and tested in the development
environment.
For more information, see Migrating data.
Migrating BMC Atrium CMDB class definitions and instances

Migrating your BMC Atrium CMDB from a development server to a production server requires the
following high-level steps.
Step
Task
Migrating class definitions with BMC Remedy Migrator CLI
Logging in to the cmdbdriver program
Exporting class instances with cmdbdriver
Importing class instances with cmdbdriver

BMC Remedy Migrator CLI
CMDB metadata
BMC Atrium CMDB instructions examples of data migration
BMC Remedy Migrator CLI command examples for BMC Atrium CMDB
BMC Atrium Core 9.0
Page 1163 of 2268
Home
BMC Remedy Migrator CLI

The BMC Remedy Migrator CLI program is a standalone application that delivers BMC Remedy
Migrator functionality without a graphical interface. The BMC Remedy Migrator CLI also provides
BMC Atrium CMDB support that enables you to supply a class name, from which BMC Remedy
Migrator can determine the required data and BMC Remedy AR System objects that make up that
class name.
There are many examples of BMC Atrium CMDB migration scenarios (for example, the CMDB
migration for a single class or the migration and comparison of all classes).
The executable file for the BMC Remedy Migrator CLI application is migratorcli.exe and is stored
in the same directory as the BMC Remedy Migrator product at installation (by default, C:\Program
Files\BMC Software\Migrator\migrator ).
The BMC Remedy Migrator CLI uses four types of XML files as instruction sets to identify migration
options and execute the migration or reporting specified. These files are included in the
command-line sequence. You can use third-party XML editors to work with these files. The
following table lists and describes these files.
Note
The source and destination are not stored in any of these XML files. As a result, these
files can be reused as needed for comparisons or difference reporting.
XML files used in BMC Remedy Migrator CLI

XML file
Migrator CLI function
Package
Can be used to assemble multiple sets of instructions within one migration.
Configuration
Specifies migration, logging, mask, differences, change history, backup, and prefix options. For more information
about options, see Options. When migrating BMC Atrium CMDB classes, use the supplied
CMDBConfiguration.xml file. This file is identical to the Migration Configuration file, with some different
configuration options.
Instruction
Contains a single set of instructions for a migration. With the compare command, this file also can contain
multiple named sets where the name is used to name the result file as well as the difference file.
Difference
Enables migration of all objects found to be different or missing between source and destination.
Metadata
mapping
Used for migrations that include the BMC Atrium CMDB.

CMDBMetaData.xml --When this file is used, extra attributes and indexes that are not found on the source
are not deleted on the destination.
CMDBMetaDataEnableDelete.xml --When this file is used, BMC Remedy Migrator performs a full
synchronization of source and destination, deleting any extra attributes and indexes on the destination that
that are not found on the source.
BMC Atrium Core 9.0
Page 1164 of 2268
Home
For more information about BMC Remedy Migrator CLI, see Migrating using command-line
interface.

You use the BMC Remedy Migrator CLI to set migration options, migrate objects and data,
compare information between migrations, and generate difference reports.
The executable file for the BMC Remedy Migrator CLI application is migratorcli.exe and is stored
in the same directory as the BMC Remedy Migrator product at installation (by default, C:\Program
Files\BMC Software\Migrator\migrator).
Before you begin

You must know the form name, unique field ID, and field IDs for each class to be migrated. For
more information about unique indexes in BMC Remedy AR System forms, see Indexing AR
System tables.
To migrate BMC Atrium CMDB class definitions

1. Open a copy of ExampleCMDBInstruction.xml in a text or XML editor.
2. After the <special-instructions> element, create an entry for each class that you want
to migrate, using the following syntax. .
<special type="meta-data" name="<className>" owner="CMDB" enabled="
true"/>
You can create instructions that meet your business needs. For example, you can use the
BMC Remedy Migrator CLI to import classes or the workflow attached to CMDB class forms,
after you create, modify, or delete the class model on the development server and then you
want to import this model into the production server. You also can use the BMC Remedy
Migrator CLI if you have added BMC Remedy AR System workflow to the CMDB forms.
For more information, see BMC Atrium CMDB instructions examples of data migration .
3. Run the migratorcli command and specify the CMDBMetaData.xml,
ExamplePackage.xml, and CMDBConfiguration.xml files.
migratorcli -m -s Source -d Destination -x "ExamplePackage.xml" -metatype "CMDB" -y "CMDBMetaData.xml" -g "CMDBConfiguration.xml" -u
Demo
You can run different versions of the migratorcli command to meet your business needs.
For more information, see BMC Remedy Migrator CLI command examples for BMC Atrium
CMDB.
CMDB metadata
This topic uses sample entries to explain the metadata XML document structure:
meta name
form name
object type
BMC Atrium Core 9.0
Page 1165 of 2268
Home
one-to-many form
many-to-one form
one-to-one form
many-to-many form
The main root element can contain multiple <meta> items for each major metadata type, such as
CMDB.
<meta-data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:
noNamespaceSchemaLocation="Migration Meta Data.xsd">
Note
In normal situations, do not modify the CMDBMetaData.xml files.
meta name
<meta name="CMDB" identifier-form="OBJSTR:Class" description="This is the
meta-data for the CMDB application design">
The root element for a specific metadata design such as CMDB and contains all the form and
object mappings that are specific to this element.
meta name The name of the metadata item. It is used as the "owner" within the instruction
XML document when attempting to migrate or compare metadata items within special items.
identifier-form The main form that contains the true name of the metadata. For
CMDB, this is the form that contains the class name. This is known as the root form from
which all other forms are mapped.
description Text that describes the document.
form name
<form name="OBJSTR:Class" unique-field-id="1" name-field-id="8"
extends-form="form-name">
Used to identify a specific form and how the data on that form relates to other defines forms and/or
to AR System Object(s).
form name The name of the form on the AR System server.
unique-field-id The unique identifier for the field. By default, 1 is used.
name-field-id The field that contains the unique name of the entry. It is typically used
only when the mapping item is the main identifying form. This is the field that is searched
when a name is specified within the instruction document.
extends-form The name of the base form. Entries are mapped using the unique IDs of
this form and the form mapping that is defined for the extends form.
BMC Atrium Core 9.0
Page 1166 of 2268
Home
object type
<object type="Form" cascade="all">
For AR System object mapping, this element and its children are used to identify the object to
which this form mapping maps.
object type The AR System object that does not include metadata.
cascade The action to take if the parent entry is deleted. Options are:
all Perfoms both creation and deletion of entries.
create-orphan Creates only entries found on the source but are missing from
the destination. Does not delete extra entries found on the destination.
delete-orphan Deletes extra entries found on the destination but not on the
source. Does not create extra entries found on the source.
<field id="1"/> and <text value=":"/>
These items are contained within the <object> element and are used to identify the
fields and text that make up the name of the AR System object. The name is built
based on the contents of the fields and the text value.
one-to-many form
<one-to-many form="formName" local-key-id="3" foreign-key-id="2" cascade=
"all">
One-to-many mapping is used when a single entry in the main form is related to many entries within
the specified form.
one-to-many form The name of the external form where many entries match one entry
locally.
local-key-id The field ID of the local key used in the external form to make multiple
entries from the local form.
foreign-key-id The unique field ID used on the remote form. It is not required,
because the unique-field-id defined on the form can be used.
Cascade The action to take if the parent entry item is deleted. Options are:
all
create-orphan (not currently supported)
delete-orphan
The{{<local-keys>}} and <foreign-keys> can be used if multiple fields are used for
each corresponding attributes. These elements override the corresponding attributes.
BMC Atrium Core 9.0
Page 1167 of 2268
Home
many-to-one form
<many-to-one form="formName" local-key-id="3" foreign-key-id="2">
This mapping type is used to define mapping of multiple entries in the local form to a single entry in
the foreign form. Because this mapping has no cascade option, deleting or creating entries in this
form does not affect the external form.
many-to-one form The name of the external form, where one entry matches many
local entries.
foreign-key-id The unique field ID used on the external form. This ID is not required
because the unique-field ID defined on the form can be used.
one-to-one form
<one-to-one form="formName" local-key-id="" foreign-key-id="">
In this mapping, every entry in the local form maps to one entry within the specified external form.
Cascade is not defined for this mapping type.
one-to-one form The name of the external form where one entry matches one entry
locally
because the unique-field ID defined on that form can be used.
many-to-many form
<many-to-many form="formName" local-key-id="3" foreign-key-id="5"
mapping-form="" source-field-id="2" destination-field-id="1">
This mapping allows mapping of multiple entries in the local form to multiple entries in the external
form. This mapping uses an intermediate form, in which the unique fields from the local form are
mapped to the unique fields on the external form.
many-to-many form The name of the external form where many entries matches many
local entries
because the unique-field ID defined on that form can be used.
BMC Atrium Core 9.0
Page 1168 of 2268
Home
mapping-form The name of the intermediate form used in the mapping.

source-field-id The field ID in the mapping form that contains the value of the
unique-field ID of the source entry. This value comes either from the local-key-id field or the
unique-field-id.
destination-field-id The field ID in the mapping form that contains the value of the
unique-field-id of the destination entry. This value comes either from the foreign-key-id field
or the unique-field-id of the external form.
The <source-fields> and <destination-fields> can be used to override the attributes and
where multiple fields can be defined for each. The source and destination field IDs must be defined
for the mapping to succeed.
BMC Atrium CMDB instructions examples of data migration

In an instructions file, such as ExampleCMDBInstruction.xml, you can specify the BMC Atrium
CMDB classes and the activity performed on them. After the <special-instructions> element
, create an entry for each class to migrate using the following syntax.
<special type=" <instruction>" name=" <className>" owner="CMDB" enabled="true"
/>
The special type=" <instruction>" element defines the activity, where can be "meta-data" or
"difference", for example.
CMDB instructions for a single class

The following example specifies only one class ( BMC_Person ), which you can migrate or compare
within BMC Atrium CMDB. You must also set type to "meta-data".
For an example of the command used with this instruction, see Migration and comparison of a
specified class, in which you must include the CMDBMetaData.xml mapping file.
<?xml version="1.0" encoding="UTF-8" ?>

- <instructions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:
noNamespaceSchemaLocation="Migration Instructions.xsd">
- <instruction enabled="true" name="ExampleCMDB">
- <special-instructions>- 
<special type="meta-data" name="BMC_Person" owner="CMDB" enabled="true" />

</special-instructions>
</instruction>
</instructions>
BMC Atrium Core 9.0
Page 1169 of 2268
Home
CMDB instructions for multiple classes

The following example specifies several classes for migration. You must specify each class its own
<special> element and set type to "meta-data".
For an example of the command used with this instruction, see Migration of multiple classes.
<?xml version="1.0" encoding="UTF-8"?>

<instructions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:

<instruction enabled="true" name="ExampleCMDB">
<special-instructions>
<special type="meta-data" name="BMC_Person" owner="CMDB" enabled="true"/>
<special type="meta-data" name="BMC_Patch" owner="CMDB" enabled="true"/>
<special type="meta-data" name="BMC_Application" owner="CMDB" enabled="true"/>
</instruction>
</instructions>
CMDB instructions for using difference report files as input

After you compare classes, you can use the difference report in Specified Object
Comparison.xml to migrate only the differences. You can modify Migration Instructions.xml as
shown in the following example. You must set name to the path and name of the comparison file,
and set type to "difference".
For an example of the command used with this instruction, see Migration differences using
difference report files as input.

<instructions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:
<instruction enabled="true" name="example">
<special-instructions>

<special type="difference" name="C:\Program Files\
BMC Software\Migrator\migrator\Specified Object Comparison.xml"/>
</instruction>
</instructions>
BMC Atrium Core 9.0
Page 1170 of 2268
Home
BMC Remedy Migrator CLI command examples for BMC Atrium CMDB
In each of the following compare ( -c ) examples , a comparison result report is generated named
Specified Object Comparison.xml:
Migration and comparison of all classes
Migration and comparison of a specified class
Migration of multiple classes
Migration differences using difference report files as input
Difference reports created in HTML format
Migration of a class to a file
If you do not include the --<object type> command, the example is an all object migration/
comparison, and the name of the comparison result file is All Object Comparison.xml.
Warning
If the comparison result file already exists, it is overwritten with the new file.
Migration and comparison of all classes

The following command migrates and compares all classes in BMC Atrium CMDB.
Note
In this command sequence, --metatype is required because it defines the mapping to

use within the mapping file CMDBMetaData.xml.
migratorcli -m -s Source -d Destination --classname "" --metatype "CMDB"

-y "CMDBMetaData.xml" -g "CMDBConfiguration.xml" -u Demo
migratorcli -c -s Source -d Destination --classname "" --metatype "CMDB"
-y "CMDBMetaData.xml" -g "CMDBConfiguration.xml" -u Demo
To migrate and compare all classes in a specific namespace (for example, BMC.CORE), add the -namespace parameter:
migratorcli -m -s Source -d Destination --classname "" --namespace "
BMC.CORE" --metatype "CMDB" -y "CMDBMetaData.xml" -g "
CMDBConfiguration.xml" -u Demo
BMC Atrium Core 9.0
Page 1171 of 2268
Home
Migration and comparison of a specified class

The following command migrates or compares a specified class in BMC Atrium CMDB. Define the
class to migrate in an instructions file, as described in CMDB instructions for a single class .
Note
In this command sequence, --metatype is required, because it defines the mapping to

use within the mapping file CMDBMetaData.xml file.
migratorcli -m -s Source -d Destination --classname "BMC_Person" -namespace "BMC.CORE" --metatype "CMDB" -y "CMDBMetaData.xml" -g "
migratorcli -c -s Source -d Destination --classname "BMC_Person" -namespace "BMC.CORE" --metatype "CMDB" -y "CMDBMetaData.xml" -g "
Migration of multiple classes

The following command migrates or compares several classes within BMC Atrium CMDB. Define
the classes to migrate in an instructions file, as described in CMDB instructions for multiple classes.
MigratorCLI -m -s Source -d Destination -y "CMDBMetaData.xml" -g "
CMDBConfiguration.xml" -i "Migration Instructions.xml" -u Demo
Note
You no longer need to define metadata mappings with the BMC Remedy Migrator CLI; it
defaults to the CMDBMetaDataEnableDelete.xml mapping document. Otherwise, use
the -y parameter to specify the CMDBMetaData.xml mapping document.
Migration differences using difference report files as input

The following command migrates only the differences between classes. For an example of the
instruction used with this command, see CMDB instructions for using difference report files as input
.
MigratorCLI -m -s Source -d Destination -y "CMDBMetaData.xml" -g "
CMDBConfiguration.xml" -i "Migration Instructions.xml" -u Demo
BMC Atrium Core 9.0
Page 1172 of 2268
Home
Difference reports created in HTML format

By default, the difference report is generated in XML, but you can create it in HTML format with the
following command using -xslt parameter.
MigratorCLI -c -s Source -d "Destination" --classname "BMC_Person" -namespace "BMC.CORE" --metatype "CMDB" -y "CMDBMetaData.xml" -g "
CMDBConfiguration.xml" -u Demo --xslt "DiffToHtml.xslt"
Migration of a class to a file

You can migrate classes to a .migrator file. You can use this file to recover metadata and class
definitions in case of any failure during migration. You can migrate destination classes to a .
migrator file before migration so that, in case of any failure, you can recover class definitions and
metadata by migrating this .migrator file to the destination server.
MigratorCLI -c -s Source -d "FilePath" --classname "BMC_Person" -namespace "BMC.CORE" --metatype "CMDB" -y "CMDBMetaData.xml" -g "

The cmdbdriver program is the CLI for the BMC Atrium CMDB C API. Use the following
instructions to start the cmdbdriver program:
To log on to the cmdbdriver program

1. Start the cmdbdriver program using the following steps based on your platform:
Windows
Navigate to C:\Program Files\BMC Software\AtriumCore\cmdb\sdk\bin .
Double-click cmdbdriver.exe.
UNIX
Navigate to /usr/arsystem/ServerName/cmdb/sdk/bin .
Type the cmdbdriver command.
2. Type the init command to initialize the driver.
3. Type the log command to log onto your development server.
You are prompted to specify several parameters one at a time. You must enter the following
parameters:
Type a valid user name and password.
Type the name of your server.
You can leave the other parameters blank. After you specify the login parameters, the
command prompt appears.
4. Type the abbreviation of the function and provide the appropriate input parameter values.
For example, for importing class definitions, type impdf at the prompt. Use the help
command (h or ? ) to display the cmdbdriver commands. When you are finished using the
cmdbdriver, type e or q to exit the program.
BMC Atrium Core 9.0
Page 1173 of 2268
Home

You must export both CI and relationship configuration data from your development server.
To export instance data for a class

1. Log on to your development server.
2. Start the cmdbdriver program and specify your user credentials.
For more information about starting the cmdbdriver program, see Logging in to the
cmdbdriver program.
3. Type the xexpdt command to export instance data from the BMC Atrium CMDB.
4. At the Export instance data from all classes? (F): prompt, type T to export all
instance data.
If you press Enter to accept the default value of F, you must specify the namespace, class,
and attribute details for which you want to export the class definitions.
5. At the Dataset ID (): prompt, type the dataset ID from which you want to export the
instance data.
6. At the Filename for exported data: prompt, specify the file name in which to save
the exported instance data.
Make sure you specify the exact path for the file name, for example, C:\
ExportedInstanceData\CoreInstanceData.xml. If you specify a file name that already
exists, the contents of the file is overwritten.

You must import the CI and relationship instances from the export files, which contain the class and
instance data you exported in Step 1 and 2 of this procedure, to your production server.
To import instances of a class or classes

1. Log on to your production server.
For more information about logging in to the cmdbdriver program, see Logging in to the
cmdbdriver program.
3. Type the impdt command to import instance data into the BMC Atrium CMDB.
4. Type any of the following import options to specify the action to take when an instance to be
imported has the same Instance ID as an existing instance in the BMC Atrium CMDB:
1 (Error on dup) If the instance already exists with the same Instance ID,
generate an error message and do not import the instance.
2 (Generate new ID on dup) If the instance already exists with the same
Instance ID, generate a new Instance ID and import the instance.
3 (Merge on dup) If the instance already exists with the same Instance ID,
merge the new instance and the existing instance.
4 (Generate new ID for all) Create a new Instance ID for the instance to
import even if the new instance is not a duplicate.
5.
BMC Atrium Core 9.0
Page 1174 of 2268
Home
5. Type the directory path and the file name where the import data is located, for example, C:\
ExportedInstanceData\CoreInstanceData.xml.
The data is imported into the BMC Atrium CMDB.
Migrating Product Catalog data

You can export and import Product Catalog entries in bulk to and from external files or staging
forms.
Exporting data from the Product Catalog
Importing Product Catalog data
Before attempting to export or import the data, you must understand what data is required and how
this data is represented on the Product Catalog Console. The Product Catalog consists of a
collection of products and suites. Software products are composed of one or more files. Each
product entry contains information, such as the name, the manufacturer, and the version number of
the application. Suites are composed of one or more products. A suite is technically a product that
is identified as having a relationship to one or more other applications.
For complete information, see Populating the Product Catalog.
BMC Atrium Core 9.0
Page 1175 of 2268
Home
Exporting data from the Product Catalog

When migrating Product Catalog data, you must export the form data from the staging forms on the
pre-production server. These staging forms are listed in Required forms for importing custom
entries into the Product Catalog.
When an alias is defined for the form, you must use the alias to open the staging form in your
browser.
Before you begin
Before you begin

Create a new report of BMC Remedy AR System type for each staging form. When designing this
report, include all the fields. You use this report to export the data in .arx format.

1. With your web browser, log on to the BMC Remedy ITSM server as an administrator.
2. Use one of the following methods to open the appropriate staging form:
Enter the direct access URL.
http://<midTierServer>:<port>/arsys/forms/<arSystemServer>/<yourForm>
For example, to open the PDL:ESIDversioninfoCustom form:
http://CalbroServer:8080/arsys/forms/SanJoseServer/PDL:ESIDversioninfoCustom
Open the Object List to search for the form.
http://<midTierServer>:<port>/arsys/forms
If the form has an alias, you must search for the alias. Otherwise, search for the form
name. If you see two versions of the form listed, select the object listed as a Form,
and not the Join Form.
For more information about creating reports and configuring the object list, see
Creating reports and Using the Object List.
3. Make sure the form is in Search mode.
4. Search for all records in the form--or for just the subset that you want to export.
To search for all records, leave the form blank and click Search.
If you get an error when performing an unqualified search or if your query hits the 1000record query limit, perform the following steps:
a. Open the IT Home page.
b. Open the AR System Administration Console for the BMC Remedy ITSM server.
c. Select System > General > Server Information.
d. On the AR System Administration: Server Information form, click the Configuration tab
.
e. Click Allow Unqualified Searches.
f.
BMC Atrium Core 9.0
Page 1176 of 2268
Home
f. In the Server Table Field Chunk Size field, enter a different value (for example, 0,
for unlimited records returned in the query). This setting can result in slower
performance.
g. Click OK.
You can then return to the form and perform the search.
5. Create reports to export the data from the staging forms.
a. Select all the records returned in the search.
b. Click Report.
When the Reporting Console opens, reports that are associated with the form and
that you have permission to access appear in the list. The list can include reports of
type AR System, BIRT, and Crystal. If no reports appear in the Reporting Console list,
you must create a new report of type AR System.
c. To generate .arx output, select an AR System type report, as identified in the Report
Type field.
All the records that you selected are passed to the report.
If no reports appear in the Reporting Console list, then either there is no report
associated with this form, or you do not have permission to access it. In that case,
you must create a new report of type AR System.
d. In the Destination field, select File.
e. In the Format field, select AR Export.
f. Enter a name for your report.
Change the file name to the form name, without using illegal characters.
g. Click Run.
6. Repeat this procedure for each staging form that you are exporting.
Object
Form name
Description
Console area
Version Info
This table contains information about the

custom version of the data to be imported.
You must create an entry in this table because
the entry identifies the set of custom data
being imported.
Version Info is not displayed on

the Product Catalog Console.
Manufacturer
PDL:
This table contains information about the
The manufacturer name is
ESIDmanufacturerCustom
application manufacturers. You must create

an entry in this table.
displayed in Area 1 of the

console. Specific information
about a manufacturer is on the
COM:Company form.
File
PDL:ESIDfilesCustom
This table contains information about each file.
File information is not displayed

on the console, but you can view
it by clicking View in Area 3.
Application
PDL:ESIDappsCustom
BMC Atrium Core 9.0
Page 1177 of 2268
Home
Object
Form name
Description
Console area
This table contains information about each

application.
Application information is
displayed in Area 1.
Application
to File
relationship
This table maps files to the applications to

which they are associated. Each application
consists of a single main executable and zero
or more support files.
Files that are related to an

application are displayed in Area
3.
Suite
This table contains information about suites.
Suites are displayed in Area 1 if
Suites are collections of applications identified

by a combination of the applications and an
the Suite field for the product

entry is set to Yes.
identifying GUID.
Suite to
Application
relationship
This table contains information that relates

suites to applications.
Area 2 displays either of the

following items:
The products that are part
of the suite
The suite to which the
product is associated.
Signature
Signature to
product
relationship
PDL:
ESIDsignatureProductCustom
This table contains information about a
Signatures are not displayed on
product signature.
the Product Catalog Console.
This table contains information about

signature product association records.
Signature data is not displayed

on the Product Catalog Console.
Importing Product Catalog data

To import Product Catalog Data
You can import custom data into the Product Catalog by performing the following steps.
1. Create the data by loading it into the appropriate staging forms.
For more information, see Creating the custom Product Catalog data .
2. Validate the data.
For more information, see Validating the custom Product Catalog data .
3. Import the data from the staging forms to the Product Catalog forms.
For more information, see Importing the custom Product Catalog data .
Note
For importing data that is located in a different location into staging forms, use the Data
Import utility. For more information, see Importing data into BMC Remedy AR System
forms.
Related topics
BMC Atrium Core 9.0
Page 1178 of 2268
Home
Migrating normalization jobs and settings

Exporting and importing normalization settings
Exporting and importing normalization settings

When migrating (for example, from a development to production environment), you can export and
import the following normalization settings:
Dataset normalization settings
CMDB class and attribute settings
Job schedules
Product Catalog alias mapping
The settings for Normalization System Configuration are not exported, including logging, RPC
Queue, and Threads and Connections settings.
The normalization configuration is saved as XML to your computer's clipboard, which you can then
paste into a file.
Import options for duplicate entries
Import
option
Description
Discard
Duplicate
Entries
Any configuration settings in the imported data that match existing settings are not imported. All other imported
settings overwrite existing ones. If settings are the same in the imported and existing configurations, the existing
settings are used.
Replace
Duplicate
Entries
If settings are the same in the imported and existing configurations, the imported settings are used.

1. In the Normalization console, click Export Configuration.
2. In Select Export Options, click options to exclude or include in the XML.
The XML is generated automatically.
3. Click Save to copy the XML configuration information to your system clipboard.
4. Open or create a file in a text editor, and paste the copied XML data.

1. From a saved file or from the Export Normalization Configuration dialog box, copy the XML
configuration data.
2.
BMC Atrium Core 9.0
Page 1179 of 2268
Home
2. In the Normalization console, click Import Configuration.

3. In the XML input for Import area, paste the XML data.
4. Click Import.
5. When the import message appears, click Close.
Migrating reconciliation jobs and dataset settings

You can export reconciliation definitions from one server and import them on another server.

You can export reconciliation definitions from one server and import them on another server. The
settings are saved in an .arx structure to the clipboard, which you must save to a text file. You can
export two types of information:
Reconciliation job definitions You must save each job to a separate file. This data
includes all the settings for the jobs, activities, and qualifications.
Dataset For each dataset, you can export the accessibility, account ID, security settings,
dataset type, creation and modification data, normalization status, identification status,
reconciliation ID, and other information.
To import the settings and jobs to a Reconciliation Engine on another server, you must use the
dataimport.bat command. For more information, see Importing reconciliation definitions.
Note
and line feeds (CR+LF) correctly. Use a plain text editor that retains CR+LF. Otherwise,
To export reconciliation jobs

2. In the Export Jobs tab, select a job.
3. Click Save to Clipboard.
5. Save the file with an .arx extension.
To export reconciliation datasets

2. Click the Export Datasets tab.
3.
BMC Atrium Core 9.0
Page 1180 of 2268
Home
3. From the list of datasets, select one.

4. Click Save to Clipboard.
6. Save the file with an .arx extension.

You import reconciliation definitions by using the BMC Remedy Data Import CLI.
Note
Before using the CLI on UNIX for the first time, you must add an entry to your library path.
The CLI also has several other options not described in the following procedure, some of
which might be necessary depending on your AR System server environment. For more
information about these topics, see Migrating using command-line interface.
To import reconciliation definitions

1. Open a command prompt.
2. For Microsoft Windows, change to the directory where BMC Data Import tools are installed.
The default directory is:
<bmcInstall>\AR System\dataimporttool
3. Enter the command:
dataimport.bat -x <serverName> -u <userName> -p <password> -a <
portNumber> -o <importFile> -l <logFile> -e 179 -D 4
For <importFile>, specify the full path to the file containing the exported definitions from the
procedure Exporting reconciliation definitions. Specifying a log file is optional, but recommended in
case there are any errors with the import. If you are not using portmapper, you can specify the port
for the server with the optional -a parameter.
The -e 179 option enables you to verify whether a definition you are importing already exists. This
check is performed based on the globally unique identifier (GUID) values. Specifying the -D4 option
updates an entry if a match is found. If no match is found, a new entry is created. For more
information about the various options for the dataimport.bat utility, see Enabling the Data Import
utility.
Manual configuring federated data on your production server

You must manually configure federated data on your production server. Make sure you configure
the following components on your production server:
Federation plugins and adapters Includes editing the pluginsvr_config.xml file with the
various plugins (for example, JDBC) for the federated data
BMC Atrium Core 9.0
Page 1181 of 2268
Home
Data stores
Retrieval methods
Launch methods
For more information, see Managing permissions.

You can configure BMC Atrium Explorer in several ways. You can restrict the relationships that are
displayed by number of levels and other criteria, show specific icons and tooltips for a given CI
class, determine which attributes appear for Quick Edit, and set the number of CIs that cause an
instance-group icon to appear.
The following topics provide information and instructions for configuring BMC Atrium Explorer:
Control of the layout of class forms
Setting the cache refresh interval
Setting the DSO option for BMC Atrium CMDB
Changing the default CI editor in BMC Atrium Explorer
Configuring how layers are displayed in BMC Atrium Explorer
Notification of BMC Atrium CMDB events
Control of the layout of class forms

The following topics are discussed in this section:
Modification of the views of forms in BMC Atrium CMDB
Modifying views of forms in BMC Remedy IT Service Management applications
Generating forms for other applications
Synchronizing CMDB class forms for BPCU-created overlays
The default view in the join form for a new regular class is generated by using the form for its
superclass as a basis. The forms for CDM classes also have more usable views, using panel fields
to organize content instead of placing all attribute fields in one column.
BMC Atrium CMDB provides the following layout algorithms:
Built-in CMDB logic that controls the default layout for all CMDB forms and extensions.
Utility that updates third-party application forms.
These application forms are not actually CMDB forms but can mirror them by mapping to the
CMDB form. For example, BMC Remedy Asset Management has its own form for a
Computer System class. This utility can automatically update the BMC Remedy Asset
Management form to reflect any changes to the CMDB BMC_ComputerSystem class.
BMC Atrium Core 9.0
Page 1182 of 2268
Home
Both of these algorithms place new attributes in a custom tab. When a custom tab runs out of
space to hold more attributes, CMDB creates additional custom tabs. For CMDB forms, the
maximum number of custom tabs is 20. For cmdb2asset forms, the maximum number of custom
tabs is 50.
In addition, the position of the attributes within the custom tab might be reshuffled by the CMDB
layout. One notable difference between the two algorithms is how the custom tab appears. For
CMDB forms, the custom tab is visible by default when you add a new attribute. For cmdb2asset
forms, they are hidden. If you change the visibility, in the next data model change the visibility might
revert to the default.
For more information about BMC Remedy AR System views, see Defining and managing form
views.
Warning
Do not modify the ObjectStoreView view (ID 399999100) of the class form for any
class in the BMC.CORE or BMC.CORE.CONFIG namespaces. Your changes could be
overwritten by future releases of patches to the BMC Atrium CMDB. Instead, copy
ObjectStoreView to a new view for that form and modify the new view. There is no risk
to modifying the ObjectStoreView view of class forms in other namespaces.
Modification of the views of forms in BMC Atrium CMDB

You can modify the view of any class form by using BMC Remedy Developer Studio.
How class form modification affects subclasses
Algorithm for adding attributes to views
Views for new base classes
How class form modification affects subclasses

Modifying the view of a class form does not affect views for its existing subclasses, but the new
view becomes the default view for new subclasses.
Algorithm for adding attributes to views

When you create a new attribute for a class, it is added to the class form's view using the following
algorithm:
1. The field is placed on the panel field named Custom0, following the last existing field on the
page. If this panel field does not exist, it is created on the page holder field that has field ID
300025400. If no page holder field with this ID exists, the panel field cannot be created.
2.
BMC Atrium Core 9.0
Page 1183 of 2268
Home
2. If no space remains on the Custom0 page for the new field, a Custom1 page is created and
the field is placed at the top of it. This automatic creation of panel fields can continue up to a
maximum of 50 panel fields.
3. If 50 panel fields are full, or if a page holder with field ID 300025400 does not exist, fields are
stacked in the upper left corner of the view. Stacked fields might be obscured by each other.
Note
Panel fields created by this process, and any attribute fields placed in the upper left
corner of the view, are created as Hidden. This prevents users from seeing the new
attributes until you have had the opportunity to place them in the location that you
want. To allow users to see the new attributes, move them off the panel field or
make hidden fields visible.
Views for new base classes

If you create a new class that has no superclass, it cannot inherit a view template. The new class
form is arranged according to the default view template.
Default view template for new base classes
Attributes represented by BMC Remedy AR System core fields are placed in a single column at the
top of the view, and attributes that you create are placed in panel fields below. As with any other
BMC Atrium Core 9.0
Page 1184 of 2268
Home
class form, you can modify the view to suit your needs, and any subclasses of this class that you
create inherit that modified view.
Modifying views of forms in BMC Remedy IT Service Management applications

If you have BMC Remedy IT Service Management 7.0 or later applications installed and want their
forms to reflect changes that you have made to the BMC Atrium CMDB data model, perform this
procedure.
To duplicate data model changes in BMC Remedy ITSM forms

1. Log on to the server where BMC Atrium CMDB and BMC Remedy ITSM are installed.
2. Open the BMC Remedy AR System Administration Console.
3. Select Administration Console > Application Administration Console.
4. Click the Custom Configuration tab.
5. From the Application Settings, select Asset Management.
6. From Advanced options select Sync Asset UI with CMDB, and then click Open.
7. This opens the SHR:SchemaNames form in Search mode (which appears as Schema
Names in the Object List), and then query for the form for which you want to generate a new
view.
For example, the BMC Remedy Asset Management form corresponding to the
BMC_ComputerSystem class is AST:ComputerSystem.
8. Select the record for the form that you need, and then click Update Asset UI.
The BMC Atrium CMDB generates a new version of the form that you selected.
If you extend the BMC Atrium CMDB and the parent class has categorization subclasses,
you can ignore any warnings in the log files that certain fields could not be created or found.
For example:
[Tue Apr 14 2009 12:38:26.6834] [HTMLUATatriumcoreAG:WARNING] [TID:
000002] : Could not create Field: SubnetMask on form: AST:DLCI on
server: myserver
[Tue Apr 14 2009 12:38:26.6836] [HTMLUATatriumcoreAG:WARNING] [TID:
000002] : Message: Field does not exist on current form - 260140107
You see these warnings because the BMCSynchronizeUI process finds fields on the
parent form for categorization subclasses. But because these attributes are not derived from
the class in question, they should not be created on the UI forms.
Generating forms for other applications

Some BMC Remedy AR System applications, such as BMC Remedy Asset Management, use their
own forms as an interface to BMC Atrium CMDB data. These forms are typically self-joins, where a
BMC Atrium CMDB class form is both the primary and secondary form. If you have developed such
an application, you can let BMC Atrium CMDB generate those forms for you. This method of
generation keeps them synchronized with extensions that you make to the data model.
You must configure the generation of forms in advance to specify how you want them created, and
then, after modifying the data model, launch form generation.
BMC Atrium Core 9.0
Page 1185 of 2268
Home
To configure form generation for another application

To launch form generation
To configure form generation for another application

1. Using BMC Remedy Developer Studio, create a companion form for each class in the data
model for which you want to generate forms.
2. Create a form to specify information about the classes for which you want to generate forms.
Each entry in the form corresponds to one class. The form must have the following character
fields, all with a maximum input length of 80 characters:
Class Keyword
Form Name
Primary Join Form
Secondary Join Form
3. Create entries in the new form for each class for which you want to generate a form, entering
this information:
Class
Keyword
The class ID of the class for which a form is generated. This field is required. The class ID is case sensitive
, and might not be the same as the class name. For example, the class with a name of
BMC_ComputerSystem has a class ID of BMC_COMPUTERSYSTEM. For more information about the
class ID of a specific class, see the BMC Atrium CMDB Data Model Help.
Form
Name
The name of the companion form that your application uses for the class. This form is modified if it exists
and created if it does not exist. This field is required.
Primary
Join Form
(optional) If you specify a form name here, the form generated is a join of this form as the primary join form
and the BMC Atrium CMDB class form as the secondary join form. This field must be blank if a secondary
join form is specified.
Secondary
Join Form
(optional) If you specify a form name here, the form generated is a join of the BMC Atrium CMDB class
form as the primary join form and this form as the secondary join form. This field must be blank if a primary
join form is specified.
Forms are not necessarily generated for every entry in this form when the form generation
utility runs. You specify the forms that are generated for each run of the utility with
parameters explained in the following procedure.
Note
If you do not specify a primary join form or secondary join form, the form generated
is a self-join of the BMC Atrium CMDB class form as both the primary and
secondary join forms. Unless you have other data you want to display with BMC
Atrium CMDB data, you should leave both fields blank.
To launch form generation
1.
BMC Atrium Core 9.0
Page 1186 of 2268
Home
1. Wait until synchronization completes and no classes are in the Change Pending state.
If any classes are still in the Change Pending state, the form generation utility aborts with an
error.
2. Create an entry in the Application Pending form, specifying the following field values:
Category CMDB
Command Sync-UI
Other Short <commandSyntax>
<commandSyntax> must include these required parameters:

Parameter
Description
-f <
The name of the form created in step 2.
configFormName>
-g <
The field ID of the Form Name field on the form created in step 2.
formNameFieldID>
-c <
The field ID of the Class Keyword field on the form created in step 2.
classKeywordFieldID
>
-C <classID>
The class ID of the class for which a form is generated. You must provide either this
parameter or -t, but not both.
Note
The class ID is case sensitive, and might not be the same as the class name.
For example, the class with a name of BMC_ComputerSystem has a class ID
of BMC_COMPUTERSYSTEM. For more information about the class ID of a
specific class, see the BMC Atrium CMDB Data Model Help.
-t <timeStamp>
A UNIX epoch time value. Forms are generated only for classes modified after this time
and all of their subclasses. You must provide either this parameter or -C, but not both.
<commandSyntax> can also include these optional parameters:

Parameter
Description
-R
Specifies that forms are also generated for all subclasses of the class
specified with -C.
-p <
primaryJoinFormNameFieldID>
The field ID of the Primary Join Form field on the form created in step 2. If
you populated the Primary Join Form field, you must specify this parameter.
-s <
The field ID of the Secondary Join Form field on the form created in step 2.
secondaryJoinFormNameFieldID
>
If you populated the Secondary Join Form field, you must specify this
parameter.
-D
Enables debugging for this operation. Debugging increases the details that
are written to the log file.
Log messages for each form generation are written to one of the following locations:
On Windows: <arServerInstall>\Arserver\Db\CMDBSynchronizeUI.log
BMC Atrium Core 9.0
Page 1187 of 2268
Home
On UNIX: <arServerInstall>/Db/CMDBSynchronizeUI.log
Note
You can use workflow to create these Application Pending entries, but as mentioned in
step 1, it cannot be executed while any classes are in Change Pending state.
Synchronizing CMDB class forms for BPCU-created overlays

If you used the Best Practice Conversion Utility (BPCU) to create overlays on a custom class form,
perform this procedure to synchronize the BMC Atrium Core class forms with the forms in other
applications (for example, BMC Remedy Asset Management). For more information, see Using
BPCU to generate overlays for modified legacy objects .
Note
If you created overlays on a custom class form, perform these steps before you upgrade
the AR System server, so that your customizations are preserved after the upgrade is
finished.
To synchronize CMDB class forms

1. Log on to the server where BMC Atrium CMDB and BMC Remedy ITSM are installed.
3. Open the Server Information window and make sure that Cache All Display Properties is
set.
4. Open the CMDB class form in Developer Studio, and verify that the class forms that start
with BMC.CORE, BMC.MAINFRAME, BMC.AM, and BMC.SIM which are out-of-the-box
classes and other custom CMDB classes are in Unmodified state. Make sure there are no
overlays present.
5. If the class form is in Custom state, complete the procedure described in Converting custom
objects to origin objects to convert custom objects .
6. Open the Application Administration Console.
a. From the Application Administration Console, click the Custom Configuration tab.
b. From the Application Settings list, choose Asset Management > Advanced Options
> Sync Asset UI with CMDB, and then click Open.
c. On the Sync Asset UI with CMDB form, click Class Name, and then select the BMC
Asset Inventory form (Class Name) to synchronize with BMC Atrium CMDB.
From this form you can call the CDMB2ASSET function.
d. Click Update Asset UI and the system will generate or update Asset UI for the CMDB
class and any subclasses of it.
The class and its subclasses will be updated with any changes in the BMC Atrium
BMC Atrium Core 9.0
Page 1188 of 2268
d.
Home
CMDB.
For more information, see Synchronizing the BMC Asset Inventory forms with BMC
Atrium CMDB.
7. Verify that a record is created in the Application Pending form.
This action starts the Sync-UI action.
Setting the cache refresh interval

The BMC Atrium CMDB caches metadata to provide faster performance. This data includes
classes, attributes, indexes, datasets, and federated links.
Updates that you make to datasets and federated links by using their BMC Remedy AR System
forms or the BMC Atrium Core Console are not available in BMC Atrium CMDB until the cache is
refreshed.
Updates that you make to classes, attributes, and indexes by using the Class Manager are
automatically cached when updates finish synchronizing with the BMC Remedy AR System.
Updates that you make to any of these types of metadata by using API calls are automatically
cached and available immediately.
By default, the cache is refreshed every five minutes. You can set this interval by editing a line in
the BMC Remedy AR System configuration file, as described in the following procedure. When one
server in a server group is updated, other servers in the group are not updated until the refresh
interval is reached.
To set the cache refresh interval

1. Open for editing the configuration file for the BMC Remedy AR System server where BMC
Atrium CMDB is installed.
On Windows, this file is <arServerInstall>\CONF\ar.cfg.
On UNIX, this file is <arServerInstall>/conf/ar.conf.
2. On the CMDB-Cache-Refresh-Interval line, set the value in seconds for the interval at
which the cache is refreshed.
For example, to refresh the cache every two minutes, set the line to read
CMDB-Cache-Refresh-Interval: 120
If this line does not exist, create it.
Setting the DSO option for BMC Atrium CMDB

After you have installed BMC Atrium CMDB, perform the following steps to import the
DistributedCMDBTemplates to set the Distributed Server Option (DSO) for BMC Atrium CMDB.
For more information about distributed BMC Atrium CMDB, see Implementing Distributed BMC
Atrium CMDB.
BMC Atrium Core 9.0
Page 1189 of 2268
Home
To set the DSO option for BMC Atrium CMDB

1. Apply the DSO license to the source and destination servers.
2. Set the DSL Local Password on the DSO Server tab in BMC Remedy AR System (
Administration Console > System > General > Server Information > Connection
Settings ).
3. Uncomment the following lines in the armonitor.cfg file:
"C:\Program Files\BMC Software\ARSystem\serverds.exe" -i
"C:\Program Files\BMC Software\ARSystem" -m
5. From the BMC Software\AtriumCore\<computerName>\cmdb\en\workflow\
DistributedCMDBTemplates directory, open the src_distcmdb.def file.
6. Search for the text string to-server : DESTINATION-SERVER in the destination
mappings.
7. Replace all 80 instances in the destination mappings with the name of the destination server.
For example:
to-server : vw-sjc-bsm-vm17
Note
Make sure that you do not replace DESTINATION-SERVER in the filter names.
8. Save and close the file.

9. Using BMC Remedy Developer Studio, import the workflow from the src_distcmdb.def file
to the source and destination servers.
Changing the default CI editor in BMC Atrium Explorer

The default CI editor in BMC Atrium Explorer depends on which BMC applications are installed on
your system.
If the BMC Remedy IT Service Management applications are installed, BMC Atrium Explorer
opens the Asset view of the instance. For example, if you edit a computer system CI, the
Computer System form (AST:ComputerSystem) is displayed.
Otherwise, BMC Atrium Explorer opens the instance in its class form. For example, if you
edit a computer system CI and no BMC Remedy IT Service Management application is
installed, the BMC.CORE:BMC_ComputerSystem class form is displayed.
If you have BMC Remedy IT Service Management applications installed, you can change the
default CI editor that appears in BMC Atrium Explorer.
BMC Atrium Core 9.0
Page 1190 of 2268
Home
To change the default CI editor

1. In the Atrium:Explorer form, you can create Set Fields active link workflow in BMC Remedy
Developer Studio to set the values of the Default attribute in the Precedence field.
2. To specify the default CI editor for your environment, set the Default attribute in the
Precedence field to ITSM or CMDB.
3. If you created a new class in the Class Manager that has been synchronized with with the
BMC Remedy AR System forms and workflow, set the Has Asset UI field in the SHR:
SCHEMANAMES form to Yes.
This enables you to edit the instance of that class in an Asset view.
Configuring how layers are displayed in BMC Atrium Explorer

To make the graphical map more predictable in BMC Atrium Explorer, the Layered view follows
pre-defined best practices when displaying your service model.
CIs in service model displayed by layers
Out-of-the-box, CI layers are displayed according to their relative type in BMC Atrium Explorer. You
can customize how layers are displayed by updating the ComponentString attribute in the
BMC Atrium Core 9.0
Page 1191 of 2268
Home
BMC_UIComponent form. The ComponentString attribute for the layers of CIs is defined in
multiples of 10. The top layer is 10, the second layer is 20, the third layer is 30, and so on. As a
result, if you want to move BMC_ApplicationInfrastructure from the third layer to the
second layer, set the ComponentString attribute to 20.
To configure how layers are displayed in BMC Atrium Explorer

http://<midTierServer>:<port>/arsys/forms/<arSystemServer>/BMC.CORE.CONFIG:
BMC_UIComponent
attributes:
ComponentType Select GraphLayer.
ComponentRelatedClassId Type the class ID of the class that this layer
represents. The class ID is case sensitive, and might not be the same as the class
name. For example, the class with a name of BMC_ComputerSystem has a class ID
of BMC_COMPUTERSYSTEM. For more information about the class ID of a specific
ComponentString ---(required) Type a number to designate the relative position of
the layer.
Attributes that define relative position of the layer
ComponentRelatedClassId
Component
(under Base Class in BMC Atrium Explorer)
ComponentString
ID
BMC_BUSINESSSERVICE
Business Service
10
Note
This component has a special function
in CI layers. Business Services are
always at the top, automatically
arranged in layers based on their
relationship to other Business Services
. Changing its value here makes no
difference in the graph display.
BMC_ACTIVITY
Activity
20
Transaction
Business Process
BMC_APPLICATION
Application
20
BMC_OFFERING
BMC_ServiceOffering
20
Note
BMC Atrium Core 9.0
Page 1192 of 2268
Home
Component
ComponentString
ID
Not currently used in BMC Atrium

Explorer
BMC_WAN
20
WAN
BMC_ADMINDOMAIN
Admin Domain
30
NT Domain
BMC_APPLICATIONINFRASTRUCTURE
Application Infrastructure
30
BMC_APPLICATIONSYSTEM
Application System
30
BMC_LAN
LAN
30
BMC_LOGICALCOMPONENT
Logical System Component
30
BMC_PHYSICALLOCATION
Location
30
BMC_SERVICELEVELTARGET
BMC_Cost
30
BMC_Price
BMC_Service_Offering_Instance
BMC_SYSTEMSERVICE
Application Service
30
BMC_CLUSTER
Cluster
40
BMC_DATABASE
Database
40
BMC_DOCUMENT
Document
40
BMC_GENERICGROUP
Concrete Collection
40
Connectivity Segment
IP Connectivity Subnet
IPX Connectivity Network
LNs Collection
Organization
Role
User Community
BMC_OPTION
BMC_Option
40
BMC_SOFTWARESERVER
Software Server
40
BMC.CORE:BMC_TAG
BMC_Tag
50
BMC_ASSETBASE
Base Element
50
BMC_COMPUTERSYSTEM
BMC_StorageSubsystem
50
Computer System
Mainframe
Printer
BMC_EQUIPMENT
Equipment
50
BMC_IPENDPOINT
IP Endpoint
50
BMC_OPTIONCHOICE
BMC_OptionChoice
50
BMC Atrium Core 9.0
Page 1193 of 2268
Home
Component
BMC_SYSTEM
Admin Domain
ComponentString
ID
50
Application System
Cluster
Computer System
BMC.CORE:BMC_SETTINGS
Resource Allocation Settings

Data
60
Virtual System Setting Data,

BMC_ACCESSPOINT
Communication Endpoint
60
IP Endpoint
LAN Endpoint
Protocol Endpoint
BMC_ACCOUNT
Account
BMC_LOGICALSYSTEMCOMPONENT
BIOS Element
60
60
BMC_LogicalDisk
Database Storage
Disk Partition
File System
Local File System
Logical Component
Operating System
Package
Product
Remote File System
Resource Pool
Share
Storage Extent
Storage Volume
System Resource
System Software
Virtual System Enabler,
BMC_PERSON
Person
60
BMC_HARDWARESYSTEMCOMPONENT
Hardware Package
70
BMC_PATCH
Patch
70
BMC_SYSTEMCOMPONENT
Card
70
CDROM Drive
Chassis
Diskdrive
Floppy Drive
Hardware Component
Keyboard
Media
Memory
Monitor
Network Port
Pointing Device
BMC Atrium Core 9.0
Page 1194 of 2268
Home
Component
ComponentString
ID
Processor
Rack
Tape Drive
UPS

New and changed layers are available to BMC Atrium Explorer within ten minutes. To make them
available sooner, restart the mid tier. After waiting ten minutes or restarting the mid tier, reopen
Notification of BMC Atrium CMDB events

Note
The CMDB:Events form will be deprecated from an upcoming BMC Atrium Core release in
favor of Event Channels. See Receiving CI change events with Event Channels for more
information.
BMC Atrium CMDB can notify users when instances are created, deleted, or modified. You can
create a BMC Remedy AR System filter to push an entry to the CMDB:Events form when a
particular change occurs, and then query the form at intervals to monitor for those events.
The CMDB:Events form stores the following information for each event instance:
Event Type--A value that you define for the purpose of categorizing the events that you
publish.
Event Name--A name that you give the event.
Event ID--A globally unique identifier (GUID) for the event instance.
Change Type--The BMC Remedy AR System operation run against the BMC Atrium CMDB
instance that triggered the event instance. It can be CREATE, SET, or DELETE.
Instance ID--The ID of the BMC Atrium CMDB instance that triggered the event instance.
Class ID--The ID of the class for the BMC Atrium CMDB instance that triggered the event
instance.
Reconciliation Identity--The reconciliation identity of the BMC Atrium CMDB instance that
triggered the event instance.
Last RE Job Run ID--The ID of the most recent reconciliation job that processed the BMC
Atrium CMDB instance that triggered the event instance.
Attribute Values--A list of attribute names and values for the BMC Atrium CMDB instance
that triggered the event instance. You define which attributes are included.
BMC Atrium Core 9.0
Page 1195 of 2268
Home
Publishing a BMC Atrium CMDB event
Note
information.
An event is a type of change to instances of a specified class or classes. For example, you can
publish an event that occurs whenever an instance of BMC_Printer is modified. You can also
further restrict an event so that it occurs only if attribute values match a specified qualification. For
example, you can publish an event that occurs only when an instance of BMC_Printer is modified
and its Availability is Low. An event is inherited by all subclasses of the class on which it is
published.
When an event is published, any instance of it that occurs is written to the CMDB:Events form.
Note
A sample filter named CMDB:EventGenerator is included with BMC Atrium CMDB. This
filter creates event instances when the Availability attribute is set to Low. You can
modify it to fit your needs or save a copy to use as a template. The sample filter is
disabled and attached to a sample form named CMDB:Sample:EventNotification
that has fields identical to those on the class form for BMC_BaseElement. You must
attach the filter to a BMC Atrium CMDB class form and enable it.
For more information about filters, see Filters in the BMC Remedy Action Request System online
documentation.
To publish an event
1. In BMC Remedy Developer Studio, select File > New Filter.
2. In the New Filter dialog box, select the server where BMC Atrium CMDB is installed, and
then click Finish.
3. In the Untitled Filter window, enter the following information:
Associated
Form
The form or forms corresponding to the class or classes for this event. For example, to publish an event
for BMC_Account and its subclasses, select the BMC.CORE:BMC_Account form.
Execution
Options
The operations that you want to trigger this event. Select one or more of Submit, Modify, and Delete.
Run If
Qualification
BMC Atrium Core 9.0
Page 1196 of 2268
Home
Any BMC Remedy AR System qualification that you want to put on this event. For example, to generate
an event instance when the Availability attribute value is Low, type the qualification 'Availability' =
"Low".
4. In the If Action section, create an If action with the following characteristics:

Filter
field
name
Value
New
Action
Set Fields
Server
Name
CURRENT TRANSACTION
Read
CURRENT TRANSACTION
Value
for
Field
From
Field
Name
zTmpOSCharl
Field
Value
"$FieldID1$[;$FieldID2$]..." This is a semicolon-delimited list of the field IDs of each attribute for
which a value should be logged with an instance of the event. The entire string must be enclosed in double
quotes so that the IDs are not expanded into values. For example, to log the Item and NameFormat attributes,
this string is:"$200000005$;$301089100$"
5. Create another If action with the following characteristics:

Filter field name
Value
New Action
Push Fields
Server Name
The current server name
Push Value To
CMDB:Events
Push Field If
1 = 0
If No Requests Match
Create a New Request
If Any Requests Match
Modify All Matching Requests
Custom
Selected
Matching Ids
Not selected
Field Name:
Field Value:
EventAction
$OPERATION$
EventName
The name that you give this event
Event_Type
The type that you give this event
Event ID
$PROCESS$ Application-Generate-GUID EVT
ClassID
$ClassId$
Event_InstanceID
$InstanceId$
BMC Atrium Core 9.0
Page 1197 of 2268
Home
Filter field name
Value
Event_AttributeValues
"["
ReconciliationIdentity
$ReconciliationIdentity$
Event_LastREJobRunId
$LastREJobrunId$
zTempFormName
$SCHEMA$
zTempAttributeValues
$FieldID1$ [+ " ;" + $FieldID2$...] + " " This is a semicolon-delimited list of

the field IDs of each attribute that should be included in the event. While the string of these
IDs used in the Set Fields action passes the IDs themselves, in this case the IDs are
expanded into field values. In our sample filter, which includes the Item and NameFormat
attributes, this string is:$Item$ + " ;" + $NameFormat$ + " "
zTemp
$zTmpOSChar1$
6. Click Save.
7. Open the filters named CMDB:Event_SeparateListOfValues and CMDB:
Event_SeparateListOfValuesCallGuide.
8. In both windows, select Enable and save the filters.
When the new filter runs, these two filters convert the attribute field IDs to field names and format
those in pairs with their values, placing the resulting string into the Event_AttributeValues field.
Here is an example Event_AttributeValues value for the sample filter:
[HTMLUATatriumcoreAG:Item, My item ; NameFormat, This format ]
Notifications by polling for instances of an event
Note
information.
To be notified when an event occurs, you must poll the CMDB:Events form.
http://<midTierServer>:<port>/arsys/forms/<arSystemServer>/CMDB:Events
You can poll with a web browser, BMC Remedy AR System client, or a BMC Remedy AR System
API program at any interval. Query the form for events that match specific criteria, and use the
results as you want.
Results of a query on CMDB:Events form
BMC Atrium Core 9.0
Page 1198 of 2268
Home
Viewing CI status in context of installed

applications
Within companies, different organizations maintain and track different aspects of the business. For
example, one organization might be responsible for incident management, and another might
handle service requests for providing access to all business applications within the company.
However, people working in the IT service request organization might not have access to incident
management information. Without correct information about services and service owners, the
different organizations might find it challenging to determine the health of a particular business
service or the negative impact on the overall business if the service is out of order.
BMC Atrium Core 9.0
Page 1199 of 2268
Home
BMC Atrium Service Context enables you to easily view critical information about a business
service and its performance. This information, such as related incidents, changes, and
configuration items, is displayed in a summarized format that employees across your organization
can access.
The following topics describe the key attributes that are displayed in BMC Atrium Service Context
and how to configure them:
Overview of BMC Atrium Service Context
Applications that interact with BMC Atrium Service Context
Attributes that are displayed in BMC Atrium Service Context
Configuring BMC Atrium Service Context cache and data retrieval settings
For information on using BMC Atrium Service Context, see Viewing business service CI information
by using BMC Atrium Service Context .

BMC Atrium Service Context collects key attributes from several BMC applications and provides
that information in a consistent and summarized format. The user interface consists of two
components, the Service Context Administration window and the Service Context Summary
window.
You use the Service Context Administration window (as shown in Service Context Administration
window) to enable key attributes that you or your organization might want to view for a business
service, and for the services, applications, and servers related to it. These key attributes are
available to you depending on the BMC applications that are currently installed and running in your
environment.
For any business service they select in BMC Atrium Explorer, users can open the Service Context
Summary window (as shown in Service Context Summary window) to display data related to the
key attributes that have been configured. Employees in different functional areas in your
organization can also launch this window within various BMC applications to display the same
information about the business service.
BMC Atrium Service Context architecture
BMC Atrium Service Context required components

BMC Atrium Service Context is installed as an adapter (or plug-in) with BMC Atrium Core, as
shown in the following figure. This adapter collects attributes and data from compatible BMC
applications by using web services that those applications have published in a web services
BMC Atrium Core 9.0
Page 1200 of 2268
Home
registry.
Attributes collected from various BMC applications appear in the Service Context Administration
window, where they can be configured for display in the Service Context Summary window. The
BMC Atrium Service Context adapter contains its own cache that helps to manage the flow of
attributes and data to the user interface.
The BMC Atrium Service Context adapter cache uses an internal BMC Atrium Service Context user
to access attributes and related data. This user can be any BMC Remedy AR System user with
administrator permissions and a fixed license.
When you install a BMC application or suite, you can provide information needed by BMC Atrium
Service Context. In this case, the installer program registers the web service and configures the
BMC Atrium Service Context user for you. You can also perform these steps after installation, or
change the settings later. For more information, see Configuring BMC Atrium Service Context for
BMC Remedy ITSM applications or the online documentation for your BMC application, located at
http://docs.bmc.com.
BMC Atrium Core 9.0
Page 1201 of 2268
Home
BMC Atrium Service Context required components

The following components are required for BMC Atrium Service Context to function. BMC Atrium
Service Context architecture shows the relationships among these components.
For an overview of post-installation setup steps required for BMC Atrium Service Context, which
includes many of these components, see Setting up BMC Atrium Service Context .
Note
You cannot use BMC Atrium Service Context in BMC Atrium Explorer if you do not
complete the BMC Remedy Mid Tier and AR System server configuration steps explained
in Initial setup steps for BMC Atrium Service Context . Likewise, BMC Atrium Service
Context might not behave as expected in BMC applications if you do not complete the
setup steps required for these applications.
BMC Atrium Core 9.0
Page 1202 of 2268
Home
Component
Purpose
BMC Remedy Mid Tier_(required to install BMC Atrium Core)_
Provides web-based user interface
BMC Atrium Core includes the following sub-components:

Provides BMC Atrium CMDB, which stores
BMC Atrium CMDB
BMC Atrium Service Context adapter
business services, related CIs, and their

attributes
BMC Atrium Service Context cache

Service Context Administration window
Provides the BMC Atrium Service Context

adapter, cache, and user interface
UDDI (installed with BMC Atrium Web Services Registry)

(Available with BMC Atrium Core installation program)
Provides the location of web services used by BMC

Atrium Service Context to access attributes and data
from BMC applications
BMC applications must register their web services to
interact with BMC Atrium Service Context.
BMC Atrium Service Context user(s)

(Not shown in BMC Atrium Service Context architecture)
BMC applications
(Must be compatible with BMC Atrium Service Context)
For information about compatible versions, see the BMC Atrium
Core 8.1 Compatibility Matrix.

For information about attributes provided by each application, see
Attributes that are displayed in BMC Atrium Service Context .
For information about launching BMC Atrium Service Context
within BMC applications, see the online documentation for your
BMC applications at http://docs.bmc.com.
Not the end user, but a special internal user

that is set up for each BMC application
Works behind the scenes to load attributes and
data from BMC applications into cache
Supply application-specific attributes and data

to BMC Atrium Service Context
Provide various launch points for the Service
Context Summary window

To configure and use BMC Atrium Service Context, you must have the appropriate assigned
permission roles.
For more information about assigning BMC Atrium Core permissions, see BMC Atrium Core
permission roles within applications.
BMC Atrium Service Context permission roles
Name
Applications
CMDB SC Admin
Service
Context
CMDB SC User
BMC Atrium Core 9.0
Service
Context
Users with this role can
Configure attributes and other settings in the Service Context Administration window
Use the Service Context Summary window to view CIs, attributes, and related data
Use the Service Context Summary window to view CIs, attributes, and related data
Page 1203 of 2268
Home
Note
In addition to the roles above, users and administrators must have view permissions for
the business service CI from which they launch the Service Context Summary window.
They must also have view permissions for each related CI to see details about those CIs.
Applications that interact with BMC Atrium Service Context

BMC applications provide data to BMC Atrium Service Context, and also allow users to launch the
Service Context Summary window. These applications include:
BMC Atrium Core
BMC Remedy IT Service Management Suite (BMC Remedy ITSM Suite), including:
BMC Remedy Asset Management
BMC Remedy Change Management
BMC Service Desk
BMC Atrium Service Level Management
BMC Server Automation
BMC ProactiveNet Performance Management (SP1)
Important
To use BMC Atrium Service Context with BMC applications, the most recent versions of
these applications must be installed. For more information about versions, see the
Compatibility Matrix, which is available in the BMC Remedy Product Compatibility section
of the Product Availability and Compatibility site, located at http://www.bmc.com/support/
product-availability-compatibility.
For more information about the data provided by each application or suite, see Attributes that are
displayed in BMC Atrium Service Context .
Attributes that are displayed in BMC Atrium Service Context

Information for attributes that are displayed in the Service Context Summary window is collected
and compiled from BMC applications that are running in your environment. In the Service Context
Administration window, you can add or remove attributes, or change the order in which they appear
to the user, as explained in Configuring attributes in the Service Context Administration window .
BMC Atrium Core 9.0
Page 1204 of 2268
Home
As shown in the following tables, some attributes such as Name and Services and CIs, are
required by BMC Atrium Service Context. These attributes cannot be removed or moved in their
order of appearance. Other attributes are added automatically by default, and you can remove
them or change their order.
You decide the kinds of attributes that you want to display in the Service Context Summary window
for the service, application, and server CIs that are related to a business service. Certain attributes,
as explained in the following tables, can only be configured for related service or server CIs, and
not for related application CIs.
The following attributes appear in the top portion of the Service Context Summary window as
header data. You can enable up to five attributes for each CI type.
Attributes displayed at the top of the Service Context Summary window
BMC Atrium Core 9.0
Page 1205 of 2268
Home
Name
Source application
Name (Required)
BMC Atrium Core
Owner (Added by default)
BMC Atrium Core
Description (Added by default)
BMC Atrium Core
Owner Contact Information (Service CIs only)
BMC Atrium Core
Location (Server CIs only)
BMC Atrium Core
Priority
BMC Atrium Core
Status (Required)
BMC ProactiveNet Performance Management
The following attributes appear in the Related Information section of the Service Context Summary
window, with one or more results for which users can view details. You can enable up to six
attributes for each CI type.
Attributes displayed as Related Information
Name
Source
application
Details
Services and CIs

(Required)
BMC Atrium
Core
Name, CI Type, Status, Relationship
Deployed
BMC Server
Automation
Job Name, Job Type, Change Type, Number of Changes, Status, Date/Time (End Date
field)
BMC Server
Automation
Job Name, Number of Changes, Status, Date/Time (End Date field)
BMC Remedy
Asset
Management
Parent ID (ID of the parent request, such as the Change ID or Incident ID), Summary,
Completed
Changes
BMC Remedy
Change ID, Summary, Priority, Impact, Urgency, Status, Date/Time ( Submit Date field)
Incidents
BMC Service
Desk
Incident ID, Summary, Priority, Impact, Urgency, Status, Date/Time ( Submit Date field)
SLM
Agreements (
Service CIs only)
BMC Atrium
Service Level
Management
Agreement Name, Review Period (Daily, Weekly, Monthly, or Quarterly), Status (At Risk,
Breached, Met), Type (Service Level Agreement, Operational Level Agreement, or
Underpinning Contract)
SLM Service
Targets (Service
CIs only)
BMC Atrium
Service Level
Management
Service Target Name, Goal Type (Request-Based or Performance Monitoring), Status (

worst-case, such as Met or Missed), Related Agreement
Work Orders
BMC Service
Request
Management
Work Order ID, Summary, Priority, Status, Date/Time ( Submit Date field)
Changes
(Server CIs only)
Detected
Changes
(Server CIs only)

Outage Records
BMC Atrium Core 9.0
Outage Class, Outage Type, Priority, Date/Time ( Actual Start Date field)
Change
Management
Page 1206 of 2268
Home
Configuring attributes in the Service Context Administration

window
This topic provides instructions for configuring attributes for services in the Service Context
Admnistration window:
Before you begin
To open the Service Context Administration window
To enable attributes in the Service Context Administration window
To change the order in which attributes appear
To configure time limits for certain attributes
To view key attributes for services in the Service Context Summary window, you must first enable
them in the Service Context Administration window. The attributes that you can enable depend on
the BMC applications and suites that are running in your environment. For example, the
Completed Change Requests attribute is available for you to enable if you are running BMC
Remedy Change Management. Certain attributes, such as Name and Owner, are required by BMC
Atrium Service Context, and you cannot disable them.
In the Service Context Administration window, enable attributes separately for services,
applications, and servers, and then decide the order in which those attributes appear. This allows
users to see unique details about the services, applications, and servers that are related to the
business service they selected when launching the Service Context Summary window.
The Service Context Administration window has tabs labeled Service CIs, Application CIs, and
Server CIs, as shown in the following figure. Each tab relates to one of the following classes in the
BMC Atrium CMDB Common Data Model: BMC_BusinessService, BMC_Application, and
BMC_ComputerSystem. Attributes appear on these tabs according to the CI class to which each
applies. For example, the Description attribute applies to all three CI classes. Therefore, it is
available on all three tabs. In contrast, the Location attribute only applies to the
BMC_ComputerSystem class, so it only appears on the Server CIs tab.
For some attributes, a time limit is set that determines the results that are displayed in the Service
Context Summary window. The time limit is calculated based on the value in the Submit Date field.
Each of these attributes (shown in the following table) is set to a default time limit that you can
change in the Advanced Settings tab.
Attributes with configurable time limits

Name
Default time limit
Incidents
Last 2 hours
Completed Changes
Last 1 day
BMC Atrium Core 9.0
Page 1207 of 2268
Home
Name
Default time limit
Work Orders
Last 1 day
Open Problems
Last 8 hours
This attribute is for internal use by BMC applications.
For example, for the Completed Change Requests attribute, change requests submitted within the
last day appear by default. You can change this setting to show change requests submitted within
the last hour, the last 7 days, and so on.
For other ways to manage results, see Configuring BMC Atrium Service Context cache and data
retrieval settings.
For a list of all available attributes, their source applications and other details, see Attributes that
are displayed in BMC Atrium Service Context .
Before you begin

For specific attributes to appear in the BMC Atrium Service Context user interface, BMC
applications that provide those attributes might require additional setup steps. For example,
you might need to register the web service for a BMC application, or enter information by
clicking Configure on the Advanced Settings tab in the Service Context Administration
window.
For troubleshooting tips, see Troubleshooting BMC Atrium Service Context.
In addition, you cannot use BMC Atrium Service Context in BMC Atrium Explorer if you do
not complete required post-installation steps for BMC Remedy Mid Tier and the AR System
server.
For more information about setting up BMC Atrium Service Context, see Setting up BMC
Atrium Service Context, Configuring BMC Atrium Service Context for BMC Remedy ITSM
applications, and the online documentation for BMC applications, located at http://
docs.bmc.com.
Attributes and related data, as well as date and time information, are displayed in BMC
Atrium Service Context according to user preference settings. If no preference is set, default
locale settings on the server are used.
For more information about user preferences, see Setting user preferences in the BMC Remedy
To open the Service Context Administration window

1. In a browser, go the following URL address:
2. Log on.
3.
BMC Atrium Core 9.0
Page 1208 of 2268
Home
3. Select BMC Atrium Core > Service Context Administration .

The Service Context Administration window is displayed, as shown in the following figure.
Service Context Administration window
To enable attributes in the Service Context Administration window

1. Open the Service Context Administration window.
2. Select the tab for the Common Data Model (CDM) class for which you want to enable
attributes.
For example, if you want to enable attributes for a BMC_ComputerSystem CI, click Server
CIs.
3. Select the attribute name that you want to enable and click Add.
For each tab, you can configure up to five attributes to show as header data, and up to six
attributes to show in Related Information. For more information about attributes, see
Attributes that are displayed in BMC Atrium Service Context .
4. To remove an attribute, select the attribute name in the list and click Remove.
Note
Required attributes (that is, those attributes with Yes in the Reqd column) cannot
be removed or moved in the Service Context Administration window.
BMC Atrium Core 9.0
Page 1209 of 2268
Home
5. Repeat step 2 to step 4 for each of the CI types for which you want to enable attributes.
To change the order in which attributes appear

1. In the Service Context Administration window, select the tab for the CDM class for which you
want to change the order of an attribute.
For example, if you want to change the order of attributes for a BMC_ComputerSystem CI,
click Server CIs.
2. Select an attribute that is enabled and click Up or Down.
Note
Required attributes (that is, those attributes with Yes in the Reqd column) cannot
be removed or moved in the Service Context Administration window.
To configure time limits for certain attributes

1. In the Service Context Administration window, select the Advanced Settings tab.
All available attributes for which you can set a time limit are displayed in the table, even if
they are not enabled in the other tabs. Attributes for which you can set a time limit are listed
in the following table. The attributes that are available depends upon the applications that
are running in your environment, as explained in Attributes that are displayed in BMC Atrium
Service Context.
2. For each attribute, specify a time limit, such as Last 8 hours, or Last 2 days.
This determines the amount of history for results shown in the Service Context Summary
window. To show more history, select a longer time limit.
Configuring BMC Atrium Service Context cache and data

retrieval settings
You can configure some BMC Atrium Service Context behaviors by using a plug-in provided with
the BMC.CORE.CONFIG:BMC_UIComponent form. This form also allows you to disable or enable
caching, and to configure certain data retrieval settings. You make changes to the plug-in by editing
configuration strings in the ComponentString field.
Configuration parameters
To configure BMC Atrium Service Context cache and data retrieval settings
BMC Atrium Core 9.0
Page 1210 of 2268
Home
Configuration parameters
The following table describes the BMC Atrium Service Context configuration parameters and their
default settings.
BMC Atrium Service Context configuration parameters

Parameter name
Description
config_refresh_interval
The interval (in seconds) when configuration data is refreshed. Changes you make to
parameters take affect at the next refresh interval. The default value is 300 seconds.
allow_attribute_delete
Determines whether attributes belonging to a BMC application are deleted from BMC
Atrium Service Context if the application is uninstalled or its web service is unpublished
. For example, the Work Orders attribute belongs to the BMC Service Request
Management application, so this parameter determines whether Work Orders is
deleted from BMC Atrium Service Context if BMC Service Request Management is
uninstalled. If this parameter is set to false, the attributes are not deleted. If it is set to
true, the attributes are deleted. The default setting is false. For information about
attributes and their source applications, see Attributes that are displayed in BMC
Atrium Service Context.
class_update_interval
The interval (in seconds) when BMC Atrium Service Context is updated with new
attributes deployed by BMC applications. The default is 300 seconds. For example,
after BMC Service Level Management is installed or its web service is published, this is
the amount of time until the SLM Agreements and SLM Service Targets attributes
become available for configuration in the Service Context Administration window.
disable_sc_cache
Enables or disables caching of data from service providers. By default, BMC Atrium
Service Context only retrieves data from service providers when the data is requested,
and only if the data is not already in cache. Frequently accessed CIs will load more
quickly than CIs that have not been accessed. If caching is disabled, BMC Atrium
Service Context retrieves data from service providers at every request. For example, if
caching is disabled and you click Refresh in the Service Context Summary window,
data is retrieved directly from service providers. Caching is enabled when this
parameter is set to false. Caching is disabled when this parameter is set to true. The
default value is false. Disabling caching might result in delayed response times.
max_search_related_levels
The number of levels BMC Atrium Service Context searches to find related CIs. The
default value is 3 levels.
wsapi_timeoutIntervalInSeconds
The amount of time (in seconds) within which BMC Atrium Service Context tries to
retrieve data from service providers. If a provider does not respond within this time,
there is a timeout error. Some service providers might consistently require more time.
In this case, you can increase this value. The default value is 240 seconds.
Note
The following parameters are used internally and you should not change their default
values:
cache_timeToLiveSeconds
cache_timeToIdleSeconds
BMC Atrium Core 9.0
Page 1211 of 2268
Home
preload_sc_cache
To configure BMC Atrium Service Context cache and data retrieval settings
1. Open the BMC.CORE.CONFIG:BMC_UIComponent form using the direct access URL:
*http://<midTierServer>:<port>/arsys/forms/<arSystemServer>/BMC.CORE.CONFIG:
BMC_UIComponent*
3. In the ComponentType field, select FederationPluginConfig.
4. Click Search.
5. In the search results, select the instance named ID_BMCSERVICECONTEXT_PLUGIN.
6. Click the edit button next to the ComponentString field.
7. In the edit window, enter or modify configuration settings by using the following syntax,
including angle brackets and forward slashes as shown:
<UserDefined> <parameter1>value</parameter1> <parameter2>value</
parameter2> ... </UserDefined>
For example, to change the value of the max_search_related_levels parameter to 2,
enter:
<max_search_related_levels>2</max_search_related_levels>
For an explanation of each configuration parameter, see the following table.
8. Click OK in the edit window.
9. Save the instance.
Your changes take effect according to the configuration refresh interval specified in the
configuration settings (default 5 minutes). You do not need to restart the BMC Remedy AR
System Server service.
Configuring BMC Atrium Service Context for BMC Remedy

ITSM applications
To enable BMC Atrium Service Context in BMC Remedy ITSM applications, and in the BMC
Service Level Management and BMC Service Request Management applications, you must ensure
that you have completed the following setup steps:
Setup step
For more information, see...
BMC Atrium Core components required by BMC Atrium

Service Context are installed and configured
Configuring BMC Remedy AR System to support BMC Atrium Service

Context
Note: You can ignore this step if the AR System server

is already configured in the BMC Remedy Mid Tier.
Web services are registered
BMC Atrium Core 9.0
Registering the Service Context web service for BMC applications
Page 1212 of 2268
Home
Setup step
For more information, see...
A user with administrative permissions has been

identified with BMC Atrium Service Context
Configuring authentication for BMC Atrium Service Context
Users who will access the Service Context Summary
In the context of BMC Remedy IT Service Management, the BMC
window in BMC Remedy IT Service Management have

the correct permissions
Atrium Service Context permissions are rolled up in the BMC Asset

For information on BMC Remedy IT Service Management
permissions, see User permissions.
For more information on BMC Atrium Service Context
permissions, see BMC Atrium Service Context permissions.
BMC Atrium Service Context has been configured to

display the information you want

Configuring BMC Atrium Service Context cache and data retrieval
settings
Configure the Owner field
Setting up the Owner field
Troubleshooting
If you have problems configuring Service Context, see

Troubleshooting BMC Atrium Service Context.
For other BMC applications, see the online documentation for the application at http://
docs.bmc.com.
Registering the Service Context web service for BMC applications

BMC Atrium Service Context sends and receives data through the Mid Tier. Therefore, to share
data with BMC Atrium Service Context, each BMC application must register a web service in the
Atrium web services registry.
BMC AR System based applications use the AR System Web Services Registry form.
Other applications, use the web services registry client APIs.
For BMC Remedy IT Service Management (BMC Remedy ITSM), BMC Service Request
Management, and BMC Atrium Service Level Management, web services are registered by using
the AR System Web Services Registry form. When you install one of these products, a
ServiceContext web service record is created in this form. To register the web service, update this
record with information specific to the BMC application or suite.
You can register web services only for BMC Remedy ITSM, BMC Service Request Management,
and BMC Atrium Service Level Management applications from here. You cannot register web
services for BBPM or BMC Bladelogic applications.
Note
Only a user with AR admin rights can register and verify web services for BMC
applications.
BMC Atrium Core 9.0
Page 1213 of 2268
Home
To register the Service Context web service for BMC applications

1. From IT Home, go to Applications > BMC Atrium Core > Service Context Administration
console > Advanced Settings.
2. Click the Configure button next to Configure provider endpoints. The AR System Web
Services Registry form is displayed.
4. Modify the service context record as follows:
a. In the Business Name field, type BMC.
b. In the Web service field, type ServiceContext.
c. In the WSDL URL field, modify the value with the Mid Tier server name, port number,
and context path to reflect your current configuration.
Example syntax for ITSM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_itsm?
wsdl
Example syntax for SLM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_slm?
wsdl
Example syntax for SRM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_srm?
wsdl
d. In the End Point URL field, modify the value with the Mid Tier server name, port
number, and context path to reflect your current configuration.
Example syntax for BMC Remedy ITSM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_itsm
Example syntax for SLM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_slm
Example syntax for SRM:
http://<midtierServer>:<portNumber>/arsys/services/servicecontext_attr_srm
5. In the Publish To Registry? field, choose Yes.
6. Click Save.
To verify the Service Context web service registration for a BMC application
1. From IT Home, go to Applications > BMC Atrium Core > Service Context Administration
console > Advanced Settings.
2. To configure provide endpoints, click the respective Configure button. The AR System Web
Services Registry form is displayed
3. From the results list, select the ServiceContext web service record for your BMC application
.
The BMC application name appears in the Application Name field as ITSM, SRM, or SLM.
4.
BMC Atrium Core 9.0
Page 1214 of 2268
Home
4. Verify that the WSDL URL and End Point URL fields are populated with valid URLs that
reflect your current configuration.
For example URL syntax, see step 5 in "To register the ServiceContext web service for a
BMC application", which precedes this procedure.
5. If you cannot find the ServiceContext web service for your BMC application, or if the URLs
are not correct, follow the steps to register or re-register the web service .
Related topic
For more information on web services in BMC Remedy AR System, see BMC Remedy AR System
web services architecture
Configuring authentication for BMC Atrium Service Context

For BMC Remedy ITSM, BMC Service Level Management, and BMC Service Request
Management, BMC Atrium Service Context is authenticated by any BMC Remedy AR System user
with administrator permissions. Configuring this user enables BMC applications to share data with
BMC Atrium Service Context.
Information about the BMC Atrium Service Context user is stored in the Service Context
Authentication Info Console. You can access this form by clicking the Configure button on the
Advanced Settings tab in the Service Context Administration window.
Before you begin
To configue authentication for BMC Atrium Service Context
To delete a BMC Atrium Service Context user
Before you begin

Create a fixed-license account that is assigned to the Administrator group. You can use the same
account for authenticating all applications with BMC Atrium Service Context. For more information,
see Managing permissions in BMC Atrium Core .
To configue authentication for BMC Atrium Service Context

You can add, edit, and delete BMC Atrium Service Context users from the Service Context
Authentication Info Console directly. By default, BMC applications create an entry in the Service
Context Authentication Info Console, but you must provide the authentication information.
Important
When you install each BMC application or suite, a record is created in the CMDB.SC:
ServiceContextAuthenticationInfo form, even if you choose not to configure a BMC Atrium
Service Context user during the installation process.
Therefore, even if you are configuring the BMC Atrium Service Context user for the first
time, you must search the Service Context Authentication Info Console for an existing
record to modify.
BMC Atrium Core 9.0
Page 1215 of 2268
Home

2. Select the Advanced Settings tab.
3. Click Configure corresponding to Configure authentication information.
The Service Context Authentication Info Console opens.
Service Context Authentication Info Console
4. To modify an existing user:

a. Select the record that pertains to the BMC application for which you want to configure
the BMC Atrium Service Context user.
b. Enter or modify the values in the authentication fields.
Service Context authentication fields
The following table lists the fields in the Service Context Authentication Info Console.
Important
Make sure that the values you enter in the User Name, Password, and
Authentication String fields exactly match an existing BMC Remedy AR
System administrator user. If you change that user's password or implement
an authentication string, you must update the corresponding user
configuration in the Service Context Authentication Info Console.
BMC Atrium Core 9.0
Page 1216 of 2268
Home
Name
Value
Business
Name
BMC
(do not
modify)
Service Name
ServiceContext
(do not
modify)
Application
Name
ITSM, SRM, or SLM
(do not
modify)
Server Name
The name of the BMC Remedy AR System server as it appears in the Mid Tier Configuration
Tool.
User Name
By default, the user name is <Administrative User>.

You must replace this dummy value with the name of the BMC Remedy AR System user that
you want to register as the BMC Atrium Service Context user. This user must have
administrator permissions and a fixed license.
You can configure the same BMC Remedy AR System user for all of your BMC applications.
For information about BMC Remedy AR System users, see Creating and managing users.
Password
The password (if any) of the BMC Remedy AR System user that you want to register as the
BMC Atrium Service Context user.
Authentication
String
The authentication string (if any) for the BMC Remedy AR System user that you want to
register as the BMC Atrium Service Context user. For information about authentication strings,
see Authentication String Alias introduction.
Do not modify values in the Business Name, Service Name, or Application Name
fields. These values are used internally by BMC Atrium Service Context.
5. If an entry for an application is not available, configure a new user:
a. Click Add New.
b. Enter the values in the fields as shown in the Service Context authentication fields
table.
6. Save the record and close the form.
To delete a BMC Atrium Service Context user

2. Select the Advanced Settings tab.
3. Click the Configure button corresponding to Configure authentication information.
The Service Context Authentication Info Console opens.
All the existing records for each installed BMC application are displayed in a table.
4. Select the record that pertains to the BMC application for which you want to delete the BMC
Atrium Service Context user.
5. Click Delete.
BMC Atrium Core 9.0
Page 1217 of 2268
Home
Testing connectivity with BMC Atrium Service Context providers

When you configure BMC Atrium Service Context, multiple providers are configured in the UDDI
registry. You might want to verify if the providers are configured correctly and can be connected.
To test connectivity with BMC Atrium Service Context providers

1. Go to BMC Atrium Core > Service Context Administration .
2. Click the Test Connections tab.
3. Click Test.
4. The following information is displayed:
All the Service Context providers from the UDDI repository are displayed.
The Attribute Loading Test Result section lists each of the providers with the
following details:
Application: From where the attributes are loaded
URL: URL of the providers web service
Result: If connection failed or succeeded
Number of attributes loaded: Number of attributes loaded from the
application
Attribute names: Names of attributes loaded from application
The Data Loading Test Result section lists each of the providers with the following
details:
Application: Name of application from you want to read data
URL:URL of the providers web service
Result: Status of attributes from which it was possible to read data.
Setting up the Owner field

The Owner field appears in the information panel by default.
BMC Atrium Core 9.0
Page 1218 of 2268
Home
However, before the Owner field can display information, a system administrator must enter the
owner information into the Owner Name and Owner Contact fields when creating a computer
system CI. For more information, see Creating a Computer System CI.

Packaging your BMC Atrium Configuration Management Database (BMC Atrium CMDB) extensions
requires the following high-level steps:
1. Export the class definitions with cmdbdriver (see Exporting class definitions by using
cmdbdriver).
2. Create the package.xml file (see Creating the package.xml file).
3. Create an installation activity file (see Creating an installation activity file).
4. Convert the extension files (see Converting the extension files).
5. Validate the extension files (see Validating the extension file).
BMC Atrium Core 9.0
Page 1219 of 2268
Home
When you have completed packing the extensions, see Installing BMC Atrium CMDB extensions.
Exporting class definitions by using cmdbdriver

Before you create the extension package, you must export your class or attribute definitions by
using the cmdbdriver expdf command. The expdf command creates several XML files that
contain the class definition information for the specified class.
To export class definitions

1. Create an extension subdirectory.
This directory will contain all the extension loader files.
Microsoft Windows
a. Navigate to C:\Program Files\AR System Applications\BMC Atrium CMDB\
sdk\bin.
b. Double-click cmdbdriver.exe.
UNIX
a. Navigate to /usr/arsystem/ServerName/cmdb/sdk/bin .
b. Type the command cmdbdriver.
3. Type the command init to initialize the driver.
4. Type the command log to log onto your server.
You are prompted to specify several parameters one at a time. You must enter the following
parameters:
Type a valid user name and password.
Type the name of your server.
You can leave the other parameters blank. After you specify the logon parameters the
command prompt appears.
5. Type the xexpdf command.
6. At the Export all class? (F): prompt, type T to export all class definitions from BMC Atrium
CMDB.
If you press Enter to accept the default value of F, you need to specify the namespace,
class, and attribute details for the class definitions you want to export.
7. At the Export all attributes with classes? (T): prompt, press Enter to accept the default value
of True.
8. At the Filename for exported data: prompt, specify the file name in which to save the
exported definitions.
Make sure you specify the exact path for the file name, for example, C:\
ExportedClassDefinitions\CoreClassDefinitions.xml. If you specify a file name that
already exists, the existing file is overwritten.
BMC Atrium Core 9.0
Page 1220 of 2268
Home
Creating the package.xml file

After you export class definitions, you create the package.xml file. The package.xml file contains
the registration and dependency information for the extension. The registration information defines
the extension that you are creating. When the extension loader runs, it stores the extension
registration values that you specify in the package.xml file, such as the extension name, version,
and GUID in the SHARE:Application_Properties form.
To create the package.xml file
GUIDs, extensions, and the package.xml file
To create the package.xml file

1. Depending on whether you are creating a new extension or modifying an existing extension,
perform one of the following steps:
If you are creating a new extension, generate a GUID using the cg command of the
cmdbdriver program.
If you are modifying an existing extension, skip to step 2.
2. Specify values for the following elements in the package.xml file:
Registration information Specify the following registration information for the
extension:
<name>
The name of the extension.
<guid>
The GUID of the extension. For new extensions, specify the GUID that you created in step 1. For
existing extensions, specify the currently existing GUID.
<
version
>
The version number of the extension. Modify the version number only if you are modifying an
extension.
Dependencies Specify the following dependency information for the extension:

<
applications
>
The applications that the extension depends upon. The applications specified here can be
other extensions, BMC Remedy AR System applications, or the BMC Remedy AR System
Server on which you want to install the extension.
<version>
The version number of the application specified in the <application> element. You can
either specify a value for the <version> element, which indicates the exact version number
required for the application, or you can specify values for the <minversion> and <
maxversion> elements, which indicate the range of permissible version numbers for the
application.
Note
The <minversion> and <maxversion> elements are optional. Use them
to restrict the extension up to a specific existing application version, and do
not use version numbers that do not exist, such as BMC Atrium CMDB
99.99.9.
BMC Atrium Core 9.0
Page 1221 of 2268
Home
3. Save the package.xml file under the extension subdirectory you created in Exporting class
definitions by using cmdbdriver
GUIDs, extensions, and the package.xml file

In the the package.xml file, a GUID is a unique ID for the extension. This ID is used by the
extension loader program to determine if an extension is already installed. After you create an
extension with a specific GUID, you can only change the version number to update the extension.
The GUID remains the same for the life span of an extension.
Example: package.xml
<?xml version="1.0" standalone="yes" ?>

<package>

<name> ComSys Hardware Component</name>
<guid>OS005056C0000898YWQgUsMLAAKwAA</guid>
<version>1.0</version>
<dependencies>
<applications>
<list>cmdb</list>

<cmdb>
</cmdb>
</applications>
</dependencies>
</package>
This package.xml example instructs the extension loader program to install the ComSys Hardware
Component class extension version 1.0. The first line of code is an XML version tag that is required
for all XML files.
Note
When you specify a GUID for the BMC Atrium CMDB dependency in your package.xml
file, make sure you use the same GUID as shown in the example. This is the GUID stored
in the SHARE:Application_Properties AR System form for the BMC Atrium CMDB.
Creating an installation activity file

After you create the package.xml file, you create an installation activity file. The installation activity
file contains information about the type of activity that you want to perform with the extension loader
program, such as importing or exporting class definitions. Based on the activity description provided
in the activity file, the extension loader performs a specified task.
BMC Atrium Core 9.0
Page 1222 of 2268
Home
To create an installation activity file

Naming conventions in installation activity files
To create an installation activity file

1. Open an empty file in a UNIX text editor, such as the vi text editor.
You must create the activity file in UNIX format for running it on the UNIX platform.
Note
If you create the activity file in Windows format, make sure you use the DostoUnix
command to convert the file from Microsoft Windows format to UNIX before you run
it.
2. Type oout and the OSDriver.out output file name in the beginning of the file as shown in the
previous example.
You must specify the oout command and the OSDriver.out output file for the activity script.
The extension loader program generates an error if you skip this line in the activity file.
Note
You must name the output file for the oout command as OSDriver.out. If you
specify any other file name, the extension loader program generates an error.
3. Specify the type of activity the extension loader must perform, such as ARD or OSD.
4. Specify the number of class definitions or instance data objects you want to export or import.
5. Specify the class name and namespace for the OSD activity.
6. Specify if you want to export or import the metadata or instance data.
You can use the cmdbdriver program for the import and export function parameters.
7. Save the activity file under the extension subdirectory you created in step 1 with an .xml, .txt
, or any other type of extension, depending on the activity type.
For more information about the activity file extensions, see Creating an installation activity
file.
The Extensions subdirectories will now contain a package.xml file, an installation activity file
, and the XML files, which were created when you exported your classes using the
cmdbdriver program.
Naming conventions in installation activity files

An installation activity file uses the following naming convention:
<install-order>-<name><type>.<suffix> where:
BMC Atrium Core 9.0
Page 1223 of 2268
Home
<install-order> is a three-digit number from 000 to 999. The <install-order> instructs the
extension loader to install the objects in the Extensions directory in ascending order.
Therefore, you must specify a lower <install-order> for the object that you want to install first.
For example, if you have two extension subdirectories, 650-EXClass and 655-EXClass, the
650-EXClass subdirectory will be installed first.
<name> is an alphanumeric name for the extension. Do not use spaces, quotation marks, or
wildcard characters in the <name> element.
<type> instructs the extension loader to perform an action based on a specific value. The
options for the <type> parameter include:
IMP Import data into an BMC Remedy AR System form
ARD BMC Remedy AR System driver script
OSD cmdbdriver script
RIK Remedy Installation Kit
<suffix> is the file extension for the installation activity file. The file extensions for the activity
file include:
XML The file extension for the RIK file must be .xml.
Other types The file extension for all other activities (IMP, ARD, and OSD) can be of
any type such as .txt.
An example of an activity file name is 500-CLASS-OSD.txt.
Every installation activity file you create must contain the oout and cout commands.
The oout command instructs the extension loader to log the script actions. You must
specify the OSDriver.out output file name with the oout command, as illustrated in
the example, to save the script actions.
After the script stops executing the activity file, the extension loader reads these log
comments to verify whether the script execution was successful. The cout command
closes the log entry file.
Example: Activity file
oout
OSDriver.out
imp //activity type
1 // Number of class or instance definitions to import
TEST // Class name
SampleClass // Namespace
1 // metadata or instance data choice. 1 indicates metadata.
.
cout
term
q
When the extension loader executes the activity file shown in this example, the class definitions for
the Test class will be imported. You can specify multiple cmdbdriver commands in your activity
file, for example, your script file can contain both export and import commands.
BMC Atrium Core 9.0
Page 1224 of 2268
Home
Converting the extension files

After you create an installation activity file, you convert the extension files. After exporting the class
extensions and creating the required files, you must convert them to the new format, which creates
the ExtensionLoader.xml file. This file contains the commands and parameters needed to install
the extensions. The generated file is saved as ExtensionLoader.xml in the specified directory.
Before you begin

You must have exported the class extensions and created the package.xml and installation activity
files.
To convert the extension file

1. From the Configuration tab, select the Generate Extensions XML File tab.
2. Click Browse to locate and select a directory in which to save the generated XML file.
3. Click Next, and then click Generate.
A generation summary indicates if the generation succeeded or failed, including a brief
reason for the failure, such as The structure of the XML is not proper. Ensure
tags are closed correctly.
5. Click Done to return to the initial generation view.
Validating the extension file

After you convert the extension file, you validate the extension file. Perform this step before
installing extensions or after generating an extension file to find the following errors:
The file has no unmatched XML tags, such as a missing </stage> tag.
The file does not have more than one stage group with the same name.
The extension files exist with the proper command arguments for each.
Before you begin

You must have an XML extension file and the directories with the exported class and attribute
definitions.
To validate the extension file

1. From the Configuration tab, select the Validate Extensions XML File tab.
2. Click Browse to locate and select the XML file with the extension data.
3.
BMC Atrium Core 9.0
Page 1225 of 2268
Home
3. Click Next, and then click Validate.

A validation summary indicates if the validation succeeded or failed, including a brief reason
for the failure, such as The structure of the XML is not proper. Please
ensure tags are closed properly.
5. Click Done to return to the initial validation view.
Triggering jobs to import data into BMC Atrium

CMDB
Related discussion on BMC Communities
To import data from an external data source into the BMC.Asset dataset (production dataset), a
record is processed sequentially by Atrium Integrator, Normalization Engine, and Reconciliation
Engine jobs. However, the sequential job execution offers the following challenges:
Each of these jobs can have independent schedules but, must run sequentially.
These can be long running jobs and you may need to predict the end time of a job run in
order to schedule the next one in the sequence. This creates an issue in lining up schedules
for jobs because it is not possible to predict when a job earlier in the chain will finish.
This leads to time gaps between subsequent runs or overlapping runs, which can result in
inefficient utilization of the system or undesired results.
With the triggering mechanism, you need to schedule only the first job in the sequence and the
subsequent ones are triggered upon completion of the previous one. You don't need to track the
schedules for Normalization Engine, and Reconciliation Engine jobs when they are run sequentially
.
The following diagram illustrates how using the triggering mechanism you can reduce manual
monitoring to sequentially run Atrium Integrator, Normalization Engine, and Reconciliation Engine
jobs.
BMC Atrium Core 9.0
Page 1226 of 2268
Home
To trigger jobs to import data in BMC Atrium CMDB

You need to:
1. Schedule the Atrium Integrator job
2. Trigger the Atrium Integrator job.
3. Trigger the Normalization Engine job.
4. Trigger the Reconciliation Engine job.
You have to perform these steps once. After you configure the triggers, the Normalization and
Reconciliation jobs will be triggered automatically every time the scheduled Atrium Integrator job
runs.
Step1: Schedule the Atrium Integrator job

1. Schedule the Atrium Integrator job. See, Managing Atrium Integrator job schedule.
2. Create an event driven Atrium Integrator job by using the Application Pending form. To
create a request on the Application Pending form, see Setting up event-driven jobs in Atrium
Integrator.
BMC Atrium Core 9.0
Page 1227 of 2268
Home
Step2: Set up a trigger for the Atrium Integrator job

Perform the following steps, to ensure that after the job is completed, an entry is created in the
UDM:JobLog form with the status as END. This is required to trigger the Normalization Engine Job.
2. Click Edit > Settings. The Job Properties dialog box is displayed.
3. Click the Log tab.
4. Click Job.
5. Enter the <AR server name> in the Log Connection field.
6. Enter UDM:JobLog form name in the Log table field.
7. Click Job Entry.
9. Enter UDM:JobEntryLog form name in the Update Log table field.
10. Click OK.
If you have created the job in Atrium Integrator Spoon, the job is history is not displayed
and you need to perform the workaround discussed in the Job fails to run in Atrium
Integrator console topic.
Step 3: Trigger the Normalization Engine job

After the job is completed an entry is created in the NE:JobRun form with job status as Complete.
This is required to trigger the Reconciliation job.
1. Download the runNEandREJob.def and netrigger.zip files. Click the links to download the
attachments.
2. Extract the contents of the netrigger.zip file in the BMC Atrium Core installation directory.
3. Import the runNEandREJob.def file into BMC Remedy Developer Studio. For information
about how to import object definitions, see Importing object definitions.
This creates the RunNEJob filter.
4. Open the RunNEJob filter. Under IfAction>RunProcess, update the following variables in
the command line as needed:
a. batchFilePath Enter the complete path of the batch file (after extracting)
b. NE_JobName Enter the name of the job that you want to execute.
5. Save the filter.
Step 4: Trigger the Reconciliation Engine job

Once the Normalization Engine job is complete, the RunREJob filter runs automatically and triggers
the reconciliation engine job.
BMC Atrium Core 9.0
Page 1228 of 2268
Home
By default, the Atrium Explorer - Identification and Merge reconciliation job is triggered. If you want
to change the Reconciliation job you want to trigger, you must update the command option in the
runNEandREJob.def file and perform steps mentioned in Step 3.
Configuring Data Archiving

The data archiving policy for Reconciliation Engine and Normalization Engine data is available
starting from Service Pack 1 and later. In the event where various engines, especially the
Normalization Engine and the Reconciliation Engine generate large number of records in the
respective forms related to job run history, it is desirable that the history of records is retained that
can be quickly accessed. With this implementation a Configuration Administrator or a Configuration
Manager will not have to go back and look at data from an historical perspective on these forms,
but can access the retained history whenever needed to investigate execution history and success.
When the Reconciliation Engine and the Normalization Engine runs, there are jobs that run and
every time a job runs on a particular CI, there is an entry that is made to the job runs form.
The Archive Manager runs once in 24 hours. This is configurable.

For CMDB (Reconciliation Engine and Normalization Engine) job run history forms,
the default age of data that will be archived is 90 days. This is configurable and can
be modified from the AR Archive Manager Console.
Data Archiving Policy for Reconciliation Engine

The archiving policy of type Copy to an archive form and delete from source is defined for the
Reconciliation Engine where all the records with last modified date earlier than 90 days are
considered for archiving. The archived data is pushed to the RE:JobRuns_Archive form where it
can be searched.
Data Archiving Policy for Normalization Engine

The archiving policy of type Copy to an archive form and delete from source is defined for the
Normalization Engine where all the records with last modified date earlier than 90 days are
considered for archiving. The archived data is pushed to the NE:JobRuns_Archive form where it
can be searched. As an exception for Normalization Engine, the data for continuous jobs is not
archived.
BMC Atrium Core 9.0
Page 1229 of 2268
Home
Related records
The RE:JobRuns and the RE:Job_Events forms are associated. When you archive the data from
the RE:JobRuns form, the data in the RE:Job_Events form related to the JobRuns instance ID is
also archived based on the defined association. For more information on Associations, see
Associations Overview. For information on archiving, see Archiving data.
Viewing Archived records

You can view the archived records by opening the following forms in Midtier:
RE:Job_Runs_Archive
RE:Job_Events_Archive
NE:JobRun_Archive
Archiving Benefits
The following are the benefits of CMDB data Archiving feature:
Reduces the size of production data sets
Improves overall system performance (for example, searches run more quickly, because
they look only at production data and not at archived data)
BMC Atrium Core 9.0
Page 1230 of 2268
Home
Developing
This section guides developers and application programmers through the process of developing or
customizing a BMC Atrium Core application.
REST API
BMC Atrium CMDB C API features and components
C API functions
cmdbdriver program

The BMC Atrium Configuration Management Database (BMC Atrium CMDB) product provides an
application programming interface (API) suite that allows you to work with class definitions,
instance data, federation, reconciliation, audit, and other functions.
The BMC Atrium CMDB API suite is composed of the C, Java, web services, RESTful APIs.
BMC Atrium CMDB Java API package
BMC Atrium Core web services API overview
The C, Java, and web services APIs provide similar data structures and functions to encapsulate
information and functionality. Additionally, the web services API provides a set of
platform-independent operations that communicate with your applications to retrieve and send data.
BMC Atrium Core 9.0
Page 1231 of 2268
Home
For more information about the BMC Atrium CMDB C API, see BMC Atrium CMDB C API
features and components, C API data structures, C API functions, and C API Query
functions overview.
For more information about the BMC Atrium CMDB Java API, see BMC Atrium CMDB
Javadoc Help.
For more information about the BMC Atrium CMDB RESTful API, see REST API
For more information about web services APIs, see Web Services API data structures and
Web Services API functions.
As shown in the following figure, BMC Atrium Core components, such as BMC Atrium Explorer and
BMC Atrium Core Console, use the Java API to control the flow of data, whereas the external data
consumers and data providers can communicate using either the web services API or Java API.
BMC Atrium CMDB API architecture
BMC Atrium CMDB Java API package

The BMC Atrium Configuration Management Database (BMC Atrium CMDB) Java application
programming interface (API) is a collection of Java classes and methods that provide the C API
functionality in a Java development environment. For example, use the Java API if you write
server-side web applications that you access through the Java Server page (JSP) or Java servlets
web tier layer.
BMC Atrium Core 9.0
Page 1232 of 2268
Home
The Java API provides an object model of BMC Atrium CMDB. Because the Java APIs provide
classes and methods that are similar to the C API functions and data structures, you will find it
easier to use the Java API if you are already familiar with the C API.
For more information about the Java API, see BMC Atrium CMDB Javadoc Help, which is located
in the cmdb/sdk/javadoc/cmdbapi/ subdirectory of your BMC Atrium Core installation directory.
To access BMC Atrium CMDB Javadoc Help, open the index.html file.
For detailed information about the Java API changes in this release, see the
JavaAPI_Overview.html file of BMC Atrium CMDB Javadoc Help.
BMC Atrium Core web services API overview

BMC Atrium Core Web Services, which conforms to Simple Object Access Protocol (SOAP) and
Web Services Description Language (WSDL) standards, provides a standard interface for
interacting with BMC Atrium Core. You can use the web services application programming interface
(API) to integrate BMC Atrium Configuration Management Database (BMC Atrium CMDB) data with
other applications, for example, BMC Atrium Discovery and Dependency Mapping, BMC Remedy
Change Management, or any other third-party application.
BMC Atrium Core Web Services APIs consist of operations and data structures. For more
information about the available operations, see Web Services API data structures and Web
Services API functions.
The BMC Atrium Web Services Infrastructure component has been divided into the components
shown in the following table.
BMC Atrium Web Services Infrastructure components

Component
Includes
Web Services
Infrastructure
The modified Apache Axis2 stack. For more information about the modifications, see Apache Axis2
WAR Distribution modifications.
BMC Atrium Core Web
BMC Atrium Core web services
Services
By default, Username and Password authentication is the only enabled Web Services
security policy. Other security policies are available but are not enabled. For more
information on security policies, see BMC Atrium Core Web Services security.
Apache jUDDI is used to publish web services, and for clients to find and invoke the services
. It is implemented as a collection of web services and is deployed as a WAR file ( uddi.war)
on the web application server.
BMC Atrium Core 9.0
Page 1233 of 2268
Home
REST API
Representational State Transfer (REST) API is a simple stateless architecture that is used to create
scalable web services. RESTful APIs usually communicate over Hypertext Transfer Protocol (
HTTP). The BMC Atrium Core uses JavaScript Object Notation (JSON) format to transmit data
between a server and a web application. The advantage of REST is having a limited number of
operations for the interactions between clients and services.
The REST API uses the base URI for the web service, such as https://<localhost>:<port>
/api/{namespace}/{version}
api - is the default prefix.
namespace - is used to help separate the different APIs.
version - is the version used for particular REST API.
Note
The root URL path for REST API in BMC Atrium Core is https://<localhost>:<
port> /api/cmdb/v1.
Any partial URLs, for example, /instance/{datasetId}/{namespace}/{
className} referred to in this documentation are assumed to have this prefix.
An API is a web service that conforms to the architectural principles of REST. Each API is called by
issuing a standard HTTP request method: POST, GET, PUT, or DELETE (more commonly known
as the CRUD operations: Create, Read, Update, and Delete).
The client creates new instances by issuing POST requests. The details of an individual instance or
list of instances is retrieved using a GET request. The client issues PUT requests to modify an
instance object. When an instance object is no longer needed, the client issues a DELETE request
to remove an instance.
The following topics provide details about the BMC Atrium Core REST API:
Understanding JSON
Tools for testing the REST API
Login information
Operations on instance objects
API use cases
BMC Atrium Core 9.0
Page 1234 of 2268
Home

Supported operations
Common parameters
HTTP status codes
Related topics
Supported operations
The following table explains the HTTP methods used in BMC Atrium Core:
Operation
Description
URL
HTTP
method
Equivalent API
call
Get an
instance
Returns the details of an instance in

a particular class.
/instance/{datasetId}/{namespace}/{
className}/{instanceId}
GET
GetInstance
Get multiple
instances
Returns the details of all the

instances in a particular class.
className}
GET
GetMultipleInstance
Create an
instance
Creates new instance in a particular

class.
className}
POST
CreateInstance
Modify an
instance
Updates a single instance in a

particular class.
PUT
SetInstance
Delete an
instance
Deletes an instance in a particular

class.
DELETE
DeleteInstance
Common parameters
The following table explains the list of parameters commonly used in the REST operations
Name
Description
Example
fields
Returns only selected attributes of an instance.
/instance/BMC.ASSET/BMC.CORE/
BMC_ComputerSystem/
AGGDR4WABLJOBAN1WGQ9AAAE7FEADK
?fields=category,token,type
Sends a search qualification.

Use a URL-encoded value for the search qualification.
offset
Specifies the number (non-negative integer) of instances to offset the

results by. Used for paginating results.
BMC_ComputerSystem?q='dataSet'
="BMC.ASSET"
offset=50
Offsets the result by 50 instances
limit
Specifies the number (non-negative integer) of instances to limit the

results by. Used for paginating results.
limit=10
Gets no more than 10 instances
sort
BMC Atrium Core 9.0
sort=Status.asc,Create
Date.desc
Page 1235 of 2268
Home
Name
Description
Example
Sorts result on a search by field name and direction. Multiple field

names can be used, separated by commas. The direction, is indicated
Sorts first by Status in ascending order
by appending .asc for ascending and .desc for descending after the
field name.
datasetMask
Used to specify the dataset type and to indicate if the overlay behavior
of a given dataset should be executed. Based on the datasetId, the
instances are retrieved from the given dataset. The dataset can be the
current dataset or overlay+original dataset.
and then by Create Date in descending

order.
BMC_ComputerSystem?datasetMask
=0
Value 0 indicates that instance should be
searched in underlay dataset if it is not
found in the overlay dataset.
Value 1 indicates that instance should be
searched in current dataset only.
HTTP status codes

When responding to requests, the REST API uses some of the HTTP status codes. The following
table gives a summary of the different status codes that are returned. Each operation specifies the
response code you receive on successful calls or errors.
Code
Name
Usage
200
OK
This code is the default response for a successful API call. If the documentation does not specify a HTTP
status code that is returned on a successful call, it is assumed to be 200.
201
Created
This code is used when you create new resources. The REST response includes the Link header in the
response body which denotes where the new resource is found.
204
No Content
This code is similar to 200, but with no response body. This code is commonly used for DELETE
operations.
400
Bad Request
This code is used if the request body is not correct. For example, a JSON document is sent but it is not
the correct format or the client sends a date value in the wrong format.
401
Unauthorized
This code is used if the user is not authenticated.
403
Forbidden
This code is used when the call is authenticated, but the user does not have access to the resource. For
example, an entry operation on a class to which the user does not have permission.
404
Not found
This code is used when the specified resource does not exist.
500
Internal
Server Error
This code is the default response for any error that occurs when an API call is being processed.
JSON representation of an error

The HTTP status codes are the response that classify the failure of the request. The HTTP status
code is provided in the response header, whereas, the additional information for the error is
provided in the response body. The following code sample represents the format of the message
you receive when you encounter an error:
[
{
BMC Atrium Core 9.0
Page 1236 of 2268
Home
"messageType": "ERROR",
"messageText": "Class does not exist on the server",
"messageAppendedText": "someClassName",
"messageNumber": 303
}
...
]
Name
Data
type
Description
messageType
String
Type of message returned. For example, OK, ERROR, WARNING, FATAL, BAD STATUS.
messageText
String
The actual text of the error message.
messageAppendedText
String
The text that augments the error message.
messageNumber
Integer
The error number associated with the error message.
Related topics
REST API
API use cases
Login information
/instance/{datasetId}/{namespace}/{className}
The following operations are available on the resource:
GET multiple instances
POST
Create an instance
Create an instance with attachments
OPTIONS
Related topics
GET multiple instances

This operation allows you to get multiple instances. The details of the GET operation are tabulated
below:
Description
Gets multiple instances from the Class.
URL
Qualifier
/instance/{datasetId}/{namespace}/{className}?param=value
datasetId - Dataset Id under which the instances needs to retrieved. You can set this value to 0 if you do not want
to specify a particular dataset.
namespace - Namespace of the class.
className - The class for which an Instance to be read.
param=value - values of the instances to be retrieved
Method
GET
BMC Atrium Core 9.0
Page 1237 of 2268
Home
Header
Parameters
Header
Value
Authorization
token
Name
Description
fields
Returns parts of the instance object (for example, ?fields= ReconciliationIdentity,TokenId,Name )
Search qualification in URL-encoded form (for example, q=%27dataSet%27%3D%22BMC.ASSET

%22%27dataSet%27%3D%22BMC.ASSET%22 )
ids
Returns instances that have specified InstanceId (for example, ?ids=

AGGDR4WABLJOBAN1WGGIAAADWTEACB,AGGDR4WABLJOBAN1W23JAAA0DUEA7G)
offset
Offset for the instance to return, used in conjunction with limit. Default offset value is 0
limit
Number of instance to limit the result to. Default limit value is 500.
sort
order to sort the results in (for example, ?sort=submitDate.desc)
datasetMask
value to indicate if the data should be pulled from Overlay OR base dataset
0 Retrieves instances from the base dataset, if the instances are not found in the overlay
dataset.
1 Retrieves instances from overlay dataset only.
Returns
An array of instance objects in JSON format.
Errors
Error code 400 (Bad request) is returned if you pass q and ids parameters together.
Notes
Do not use q and ids parameters together.

If you don't specify any of those parameters, then CMDB server considers it as a getListInstances operation with no
qualification and returns all instances of given class.
POST
This operation is used to create an instance. The details of the Create operations are tabulated
below:
BMC Atrium Core 9.0
Page 1238 of 2268
Home
Create an instance
Description
Creates a new instance.
URL qualifier
datasetId - Dataset ID under which an instance is to be created
namespace - Namespace of the class
className - The class for which an instance is to be created.
Method
POST
Headers
Header
Value
Authorization
token
Content-type
application/json
Request Body
An instance object in a JSON format
Returns
No request body content, but returns one of status codes:

HTTP status code 201 with the Location header set to the URL of the new instance resource
HTTP status code 204
Errors
If the request is not successful, one of the following status codes is returned:
401 - Unauthorized
403 - Forbidden
500 - Internal Server Error
For more information, see HTTP status codes
BMC Atrium Core 9.0
Page 1239 of 2268
Home
Create an instance with attachments

Description
Creates a new instance with attachments.
URL
qualifier
datasetId - Dataset ID under which an instance is to be created
className - The class for which an instance is to be created.
Method
Headers
Request
Body
POST
Header
Value
Authorization
token
Content-type
multipart/form-data
A multipart/form-data entity. Each part of a multipart entity has a name, a Content-Type and the value.
There is one part named as instance with Content-Type as application/json and the value is a JSON entry. There
are 0 or more parts with names like attach-{fieldName} with any Content-Type and any value. The name is a prefix
indicating that it is an attachment binary data, the part after the hyphen is the name of the attachment field. This
creates an instance with attachment data.
Returns
No request body, but returns one of status codes:

HTTP status code 201 with the Location header set to the URL of the new instance resource
HTTP status code 204
Errors
If the request is not successful, one of the following error codes are returned
401 - Unauthorized
403 - Forbidden
500 - Internal Server Error
For more information, see HTTP status codes
OPTIONS
Description
Shows options available for the particular instance
URL qualifier
datasetID - Dataset ID under which the instance(s) needs to retrieved
instanceId - The instance ID.
Parameters
Returns
Name
Description
fields
CMDB attributes to return (e.g. ?fields=InstanceId1,InstanceId2)
HTTP status 204 to indicate successful deletion.
BMC Atrium Core 9.0
Page 1240 of 2268
Home
Related topics
Login information
/instance/{datasetId}/{namespace}/{className}/{instanceId}
The following operations are available on the resource:
GET single instance
PUT
Update an instance
Update an instance with attachments
DELETE
Related topics
GET single instance

The GET operation is used to get an instance from the class. The details of the GET operation are
tabulated below:
Description
Get an instance from a particular class.
URL
Qualifier
namespace - Namespace of the Class
className - Class for which an Instance to be read.
instanceId - values of the instances to be retrieved
Method
Headers
Parameters
GET
Header
Value
Authorization
token
Name
Description
fields
Returns parts of the instance object (for example, ?fields= ReconciliationIdentity,TokenId,Name )
datasetMask
Used to specify if the instance should be fetched from overlay OR base dataset.
dataset.
Returns
A single instance object.
Notes
The instance object will contain attributes to which the user has permission.
BMC Atrium Core 9.0
Page 1241 of 2268
Home
PUT
The PUT operation allows you to modify an instance in a class. The PUT operation also allows you
to modify an attachment for a particular instance or from list of instances. The details of the PUT
operation are tabulated below:
Update an instance
This operation updates a single instance in a class
Description
Update an instance from a particular class.
URL
Qualifier
datasetID - Dataset ID under which the instance(s) needs to updated. You can set this value to 0 if you do not want
className - The class for which an Instance to be updated.
Method
Header
PUT
Header
Value
Authorization
token
Content-type
application/json
Request
Body
An instance object in a JSON format
Returns
HTTP status code 204 to indicate a successful update.
Update an instance with attachments

This operation updates a instance in a class.
Description
Updates an instance with an attachment
URL
Qualifier
datasetID - Dataset ID under which the instance(s) needs to updated.
className - The class for which an Instance to be updated.
Method
PUT
Header
BMC Atrium Core 9.0
Page 1242 of 2268
Home
Request
Body
Header
Value
Authorization
token
Content-type
multipart/form-data
A multipart/form-data entity. Each part of a multipart entity has a name, a Content-Type and the value.
There is one part named as instance with Content-Type as application/json and the value is a JSON entry. There
are 0 or more parts with names like attach-{fieldName} with any Content-Type and any value. The name is a prefix
indicating that it is an attachment binary data, the part after the hyphen is the name of the attachment field. This
updates an instance with attachment data.
Returns
HTTP status code 204 to indicate a successful update.
DELETE
The DELETE operation allows you to delete an instance in a particular class. The details of
DELETE operation are tabulated below:
Description
Delete an instance from a particular class.
URL Qualifier
datasetID - Dataset ID under which the instance(s) needs to retrieved.
Method
DELETE
Header
Returns
Header
Value
Authorization
token
No request body content, but HTTP status 204 to indicate successful deletion.
Related topics
Login information
/instance/{datasetId}/{namespace}/{className}/{instanceId}/graph
The following operation is available on the resource:
BMC Atrium Core 9.0
Page 1243 of 2268
Home
Graph Walk
Description
Graph walk API is used to query CI and get the result as graph data format. The result either contains the complete
data or URI to the resource, this is based on the graph query parameters passed as query parameter.
URL
Qualifier
/instance/{datasetId}/{namespace}/{className}/{instanceId}/graph?rel=({namespace}, {className}, {direction})&cl

=({namespace}, {className})&mode={mode}&level={level}&datasetMask={datasetMask}
namespace - namespace of the class that is starting node of graph walk
className - name of the class that is starting node of graph walk .
instanceId - actual instanceId which is the starting node of graph walk
Method
Header
Parameters
GET
Header
Value
Authorization
token
Name
Description
rel
Used to specify the relationships to traverse. Additional details like className, classNamespace,
and direction are also specified along with this parameter, where direction can have the following
three values:
0 - query traverses from the source to the destination
1 - query traverses from the destination to the source
2 - query traverses the relationship, irrespective of direction
cl
Returns comma separated values for c lassName and classNamespace
mode
Used to specify the end point for graph walk, where mode can have the following three values:
0 - stop traversing at the point where the first non-matching result is found
1 - stop traversing at the point where the first matching result is found
2 - walk the entire graph, irrespective of matching and non-matching results
level
Specifies number of graph levels to traverse .
datasetMask
Used to specify if the instance should be fetched from overlay or base dataset.
dataset.
Returns
Returns list of relationships and classes walked during the search.
Related topics
Login information
BMC Atrium Core 9.0
Page 1244 of 2268
Home
API use cases

In this section you will find some practical examples on how to use the REST operations with
Postman - REST Client.
Before you begin
To create an instance
To retrieve an instance
Related topics
Before you begin

1. Open Google Chrome.
2. Install the Postman plug-in to test the REST operations.
For more information to install Postman, see https://chrome.google.com/webstore/detail/
postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?utm_source=chrome-ntp-launcher
3. From the Google Chrome tool-bar, click Apps.
4. Click Postman - REST Client to launch the application.
To create an instance
1. Open the Postman - REST Client.
2. Create a token. For more information, see Creating a token.
3. Set Request URL as: http://<midtier>:<port>/api/cmdb/v1/entry/
RESTSampleForm
4. Select Operation as POST.
5. Click Headers.
6. Enter the following data as key value pair in the header:
Key
Value
Authorization
AR-JWT <token generated>
Content-Type
application/json
7. Select raw.
8. From the list, select JSON.
9. Enter the JSON input for creating entry.
10. Click Send to send the request.
11. Click Headers.
12. The plugin returns an URL in the Location section for the newly created entry.
To retrieve an instance
1. Open the Postman - REST Client.
2. Create a token. For more information, see Creating a token.
3.
BMC Atrium Core 9.0
Page 1245 of 2268
Home
3. Set Request URL as: http://<midtier>:<port>/api/cmdb/v1/entry/

RESTSampleForm
4. Select the operation as GET.
5. Click Headers.
6. Enter the following data as key value pair in the header:
Key
Value
Authorization
AR-JWT <token generated>
7. Click Send.
8. Click Body and verify the details of the Request ID.
Related topics
REST API
Login information
BMC Atrium CMDB C API features and

components
A BMC Atrium Configuration Management Database (BMC Atrium CMDB) client can use the C
application programming interface (API) to create, modify, delete, and query class definitions,
instance data, federation, reconciliation, and other functions. The BMC Atrium CMDB C API:
Contains data structures that store both simple and complex information. A simple data
structure serves as the primary building block for a complex data structure.
Includes a set of free functions that you can use to deallocate memory.
Includes a set of copy functions that you can use to make copies of BMC Atrium CMDB C
API structures.
Provides server-access information with every call in the control parameter of the function.
BMC Atrium CMDB C API features

You can use the C API functions to perform the following operations:
Create, modify, retrieve, delete classes.
Create, modify, retrieve, delete attributes
Create, modify, retrieve, delete instances
GraphWalk/GraphQuery
QueryByPath
Import/Export class/attributes/instances
Start/cancel/get RE jobs
BMC Atrium Core 9.0
Page 1246 of 2268
Home
Retrieve/activate federation
Supported BMC Atrium Core C API platforms

BMC Atrium Core C API supports the following 32-bit and 64-bit platforms:
Supported 32-bit platform
Supported 64-bit platforms
Microsoft Windows
Microsoft Windows
Oracle Solaris
Oracle Solaris
IBM AIX
IBM AIX
Hewlett Packard HP-UX
Hewlett Packard HP-UX
Hewlett Packard HP-Itanium
Hewlett Packard HP-Itanium

Linux
BMC Atrium CMDB C API components

The BMC Atrium CMDB C API consists of a set of functions and data structures, most of which
perform a specific operation against BMC Atrium CMDB or a federated data store. For example,
you can use a function to retrieve information about a particular BMC Atrium CMDB class.
Most of the BMC Atrium CMDB C API functions accept BMC Atrium CMDB C API data structures
as parameters that qualify the action to perform, such as the type of class to create, the
qualification for an instance to retrieve or delete, or the class name to modify.
The sdk/samples/driver subdirectory in your BMC Atrium CMDB installation directory contains the
source code for the cmdbdriver program. This program provides a command-line interface for
calling C API functions. The cmdbdriver program also includes print routines for every data
structure in the API, making it a useful debugging tool.

The following topics provide the information that you need to get started with developing your BMC
Atrium Configuration Management Database (BMC Atrium CMDB) application programming
interfaced (API):
BMC Atrium CMDB Java API requirements and package contents
BMC Atrium Core Web Services API components
BMC Atrium CMDB API compatibility
BMC Atrium CMDB C API requirements and package contents
Sample BMC Atrium Core API code
BMC Atrium CMDB API and SQL views
BMC Atrium CMDB API print.c routines
API version requirements for BMC Atrium CMDB client-server connections
BMC Atrium Core 9.0
Page 1247 of 2268
Home
Comparison between BMC Atrium CMDB API programming and using the BMC Atrium Core
Console
BMC Atrium CMDB Java API requirements and package

contents
The Java application programming interface (API) package includes several header files and library
files. When you install the BMC Atrium Core solution, the Java API is also installed.
BMC Atrium CMDB Java API requirements
BMC Atrium CMDB Java API library files
BMC Atrium CMDB Java API header files
BMC Atrium CMDB Java API configuration file
For detailed information about the Java API, see BMC Atrium CMDB Javadoc Help, which is
located in the cmdb/sdk/javadoc/cmdbapi/ subdirectory of your BMC Atrium Core installation
directory
BMC Atrium CMDB Java API requirements

To build and run a Java API program on either Windows or UNIX, you need the following
environment components:
J2SE Software Development Kit (SDK), version 1.5.0_11 or later.
GNU Standard C++ Library version 3 Release 5 or libstdc++5 package. This requirement
also applies to other BMC applications that use the BMC Atrium Configuration Management
Database (BMC Atrium CMDB) software development kit (SDK).
BMC Atrium CMDB Java API library files

When you install BMC Atrium Core, a list of BMC Atrium CMDB Java API library files is installed
with the application. For more information about these library files, see "Installation and deployment
" of the JavaAPI_Overview.html file of BMC Atrium CMDB Javadoc Help.
BMC Atrium CMDB Java API header files

The following table lists the header files that are installed with the BMC Atrium CMDB Java API.
Header files for BMC Atrium CMDB programs

Header file name
Description
com.bmc.arsys.api.;*
BMC Remedy AR System API functions
com.bmc.cmdb.api.;*
CMDB API functions
java.util.;*
Java utilities library
BMC Atrium Core 9.0
Page 1248 of 2268
Home
BMC Atrium CMDB Java API configuration file

The cmdbapi.properties file contains configuration settings for properties, such as API timeout,
minimum RPC Version, and Java Proxy connections. You can modify these configuration settings
to increase the server response time when you execute your BMC Atrium CMDB Java program.
For more information about how to configure these settings, see Java API configuration properties.
BMC Atrium Core Web Services API components

The BMC Atrium Core Web Services application programming interface (API) includes two
components: the BMC Atrium Web Services Infrastructure and the BMC Atrium Web Services
Registry. To work with the BMC Atrium Core Web Services API, you must register your services,
understand how to locate your services, how to publish and find interfaces, and how to configure
your BMC Atrium Core Web Services.
For more information about using BMC Atrium Core Web Services API, see Web Services API data
structures and Web Services API functions.
BMC Atrium Core Web Services Infrastructure overview
BMC Atrium Core Web Services Registry overview
BMC Atrium Core Web Services Infrastructure overview

BMC Atrium Core Web Services Infrastructure allows the integration of BMC Software products
across a network in a service-oriented architecture. This is an Apache Axis2 installation that
includes modified and BMC-specific modules. The modifications also include changes for managing
runtime and archive configurations with the AtriumProperties.xml file and the atriumwsutil utility.
For more information about the modules and administration procedures, see Getting started with
BMC Atrium Core Web Services.
BMC Atrium Web Services Infrastructure also includes the BMC Atrium Core web services that
clients can invoke.
BMC Atrium Core Web Services Registry overview

The BMC Atrium Core Web Services Registry allows clients to obtain information about available
services. The services registry is compliant with the Universal Description, Discovery and
Integration (UDDI) standard.
BMC Atrium Core Web Services Registry provides an easy way to register a BMC Remedy AR
System web service and other web services with this registry. When you register your BMC Atrium
Core Web Services, you must specify a URL for the access point and, optionally, a URL for the web
services description language (WSDL).
BMC Atrium Core 9.0
Page 1249 of 2268
Home
BMC Atrium CMDB API compatibility

This topic provides backward and forward application programming interface (API) compatibility
information for BMC Atrium Configuration Management Database (BMC Atrium CMDB).
The following table provides a compatibility matrix for versions of BMC Atrium CMDB and BMC
Remedy AR System servers. The supported combinations are listed with the assumption that the
platform version (including operating system and either 32-bit or 64-bit architecture) of the BMC
Atrium CMDB server must be the same as the BMC Remedy AR System server.
For example, the 32-bit Linux version of BMC Atrium CMDB cannot be installed with the 64-bit
Linux version of BMC Remedy AR System. Use this table if you are using or planning to use the
BMC Remedy AR System API.
Note
BMC Remedy AR system server and BMC Atrium CMDB server and client are supported
as of 7.5. Prior versions are not supported.
Compatibility between BMC Atrium CMDB and BMC Remedy AR System servers
BMC Atrium CMDB server
Supported?
8.1.00
8.1.00
Yes
8.1.00
8.0.00
Yes
8.1.00
7.6.04
Yes
8.1.00
7.6.03
Yes
8.1.00
7.6.00
Yes (Not supported on 64-bit Windows platform).
8.1.00
7.5.00
8.0.00
8.0.00
Yes
8.0.00
7.6.04
Yes
8.0.00
7.6.03
Yes
8.0.00
7.6.00
8.0.00
7.5.00
7.6.04
7.6.04
Yes
7.6.04
7.6.03
Yes
7.6.04
7.6.00
7.6.04
7.5.00
BMC Atrium Core 9.0
Page 1250 of 2268
Home
BMC Atrium CMDB server
Supported?
7.6.03
7.6.03
Yes
7.6.03
7.6.00
Yes (Not supported on 64-bit Windows platform)
7.6.03
7.5.00
Yes (Not supported on 64-bit Windows platform)
7.5.00
7.6.04
No
7.5.00
7.6.03
No
7.5.00
7.6.00
Yes
7.5.00
7.5.00
Yes
A BMC Atrium CMDB client is any application that uses the BMC Atrium CMDB API. If you plan to
develop a BMC Atrium CMDB client, reference the following table, which provides a compatibility
matrix for versions of BMC Atrium CMDB servers and clients. The platform version (including
operating system and either 32-bit or 64-bit architecture) of the BMC Atrium CMDB client is
independent of the BMC Atrium CMDB server.
For example, the 32-bit Windows version of the client can communicate with the 64-bit Linux
version of the server. The supported combinations listed apply to all platforms.
Compatibility between BMC Atrium CMDB clients and servers

BMC Atrium CMDB Server
BMC Atrium CMDB Client
Supported?
8.0.00
8.0.00
Yes (Backwards compatibility provided by CMDB client)
7.6.04
8.0.00
7.6.03
8.0.00
7.6
8.0.00
7.5
8.0.00
8.0.00
7.6.04
Yes (Backwards compatibility provided by CMDB server)
7.6.04
7.6.04
Yes
7.6.03
7.6.04
7.6.00
7.6.04
7.5.00
7.6.04
8.0.00
7.6.03
7.6.04
7.6.03
7.6.03
7.6.03
Yes
7.6.00
7.6.03
7.5.00
7.6.03
8.0.00
7.6.00
BMC Atrium Core 9.0
Page 1251 of 2268
Home
BMC Atrium CMDB Server
BMC Atrium CMDB Client
Supported?
7.6.04
7.6.00
7.6.03
7.6.00
7.6.00
7.6.00
Yes
7.5.00
7.6.00
8.0.00
7.5.00
7.6.04
7.5.00
7.6.03
7.5.00
7.6.00
7.5.00
7.5.00
7.5.00
Yes
BMC Atrium CMDB C API requirements and package contents

The BMC Atrium CMDB C application programming interface (API) package includes header files,
library files, and source code for the cmdbdriver sample program. When installing the BMC
Atrium Core solution, you also install the C API.
BMC Atrium CMDB C API requirements
Compiler preparation for the BMC Atrium CMDB C API
C API header files
C API library files
BMC Atrium CMDB C API requirements

To build and run a C API program on Linux, you must install the GNU Standard C++ Library version
3 Release 5 or libstdc++5 package.
Compiler preparation for the BMC Atrium CMDB C API

Before you write C API programs, make sure that the following software programs are installed or
configured on your system:
For Microsoft Windows 32-bit you need Microsoft Visual C++ version 7.0 or later. For
Microsoft Windows 64-bit, you need Microsoft Visual C++ 9.0. to compile your C API
programs.
Structure member alignment: 8 bytes (default)
Set code generation to Multithreaded DLL, not DebugMultithreaded DLL. Where other
included libraries cause conflicts, add /nodefaultlib:"MSVCRTD" to the project options
to avoid using the Debug C runtime library. If your program references this library at runtime,
memory management errors will occur when memory pointers are referenced by both the
Debug and Release C runtime libraries.
ANSI standard C or C++ compiler (for UNIX)
BMC Atrium Core 9.0
Page 1252 of 2268
Home
Note
If you develop C++ clients that run on HP computers using the BMC Atrium Configuration
Management Database (BMC Atrium CMDB) C API, compile your code with the _
HPACC_THREAD_SAFE_RB_TREE flag enabled. This operation is necessary because the
libraries that the tree header file uses, which includes tree.cc, are not thread safe.
C API header files

The following table lists the C application programming interface (API) header files installed in the
include directory of your BMC Atrium Core installation.
C API header files

File name
Contents
ar.h
BMC Remedy AR System API data type and structure definitions, size limits, and constant definitions.
cmdb.h
BMC Atrium Core C API data type and structure definitions, size limits, and constant definitions.
arerrno.h
Error code definitions.
arextern.h
External declarations for the API functions, specified with and without prototypes for use with standard C, ANSI C,
or C++ compilers.
arfree.h
External declarations for the FreeAR functions. These functions recursively free all allocated memory associated
with a particular data structure.
cmdbfree.h
External declarations for the FreeCMDB functions. These functions recursively free all allocated memory associated
with a particular data structure.
arstruct.h
Core and reserved subclasses ID definitions, database separator characters, and labels for exporting structure
definitions.
C API library files

To display error messages correctly, you must have arcatalog_eng.dll in your path at runtime, and
make sure the lib directory contains the BMC Atrium Configuration Management Database (BMC
Atrium CMDB) C application programming interface (API) library files listed in the following table.
To load dynamic libraries on Solaris and Linux, include the -ldl link flag in the link command. For
more information about linking and compiling your code, see the driver sample makefile in the sdk\
samples\driver subdirectory of the BMC Atrium Core installation.
Note
The SDK folder in your installation directory contains several files. Not all files are required
for C API programs. To successfully compile your C API program, you need only the
library files listed in the following table.
BMC Atrium Core 9.0
Page 1253 of 2268
Home
C API library files

Platform
32-bit files
64-bit files
Microsoft Windows
arapi90_build002.dll
arapi90_build002_win64.dll
arcatalog_eng.dll
arcatalog_eng.dll
arrpc90_build002.dll
arrpc90_build002_win64.dll
arutl90_build002.dll
arutl90_build002_win64.dll
cmdbapi90.dll
arxmlutil90_build002_win64.dll
icudt32.dll
cmdbapi90_win64.dll
icuinbmc32.dll
icudt32.dll
icuucbmc32.dll
icuinbmc32_win64.dll
mfc71.dll
icuucbmc32_win64.dll
msvcp71.dll
msvcr71.dll
Oracle Solaris
libcmdbapi90.so
libcmdbapi90_solsp64.so
libjlicapi90_build002.so
libicudatabmc.so.32
libicudatabmc_solsp64.so.32
libicui18nbmc.so.32
libicui18nbmc_solsp64.so.32
libicuucbmc.so.32
libicuucbmc_solsp64.so.32
libcmdbapi90.a
libcmdbapi90_build002_aixp64.a
libicudatabmc32.a
libicudatabmc_aixp6432.a
libicui18nbmc32.a
libicui18nbmc_aixp6432.a
libicuucbmc32.a
libicuucbmc_aixp6432.a
libjlicapi90_build002.a
libjlicapi90_build002.a
libicudatabmc.sl.32
libicudatabmc_hppa64.sl.32
libicui18nbmc.sl.32
libicui18nbmc_hppa64.sl.32
libicuucbmc.sl.32
libicuucbmc_hppa64.sl.32
libcmdbapi90.sl
libcmdbapi90_hppa64.sl
libjlicapi90_build002.sl
libjlicapi90_build002.sl
libicudatabmc.so.32
libicudatabmc_lx64.so.32
libicui18nbmc.so.32
libicui18nbmc_lx64.so.32
libicuucbmc.so.32
libicuucbmc_lx64.so.32
libarjni90_build002.so
libcmdbapi90_lx64.so
libarutiljni90_build002.so
IBM AIX
HP-UX
Linux
libcmdbapi90.so
libcmdbjni90.so
HP-Itanium
BMC Atrium Core 9.0
32-bit (for client-side programs)
64-bit (for server-side programs)
libicudatabmc_hpia32.sl.32
libicudatabmc_hpia64.sl.32
libicui18nbmc_hpia32.sl.32
libicui18nbmc_hpia64.sl.32
libicuucbmc_hpia32.sl.32
libicuucbmc_hpia64.sl.32
libcmdbapi90_hpia32.sl
libcmdbapi90_hpia64.sl
Page 1254 of 2268
Home
Platform
32-bit files
64-bit files
libjlicapi90_build002_hpia32.sl
libjlicapi90_build002_hpia32.sl
Sample BMC Atrium Core API code

The sdk/samples/driver/cmdbdriver subdirectory in the BMC Atrium Configuration Management
Database (BMC Atrium CMDB) installation directory includes the source code for a sample
cmdbdriver program. A compiled version of the cmdbdriver program is located in the sdk/bin
directory. For more information about the cmdbdriver program, see cmdbdriver program.
After compiling the source code or locating the prebuilt program supplied with the
application programming interface (API), you can use cmdbdriver to:
Identify function input parameters, and load them with appropriate values.
Examine the content and structure of function output parameters.
Experiment with different parameter values.
BMC Atrium CMDB API and SQL views

SQL views are available to facilitate data access to BMC Atrium Core from third-party database
clients. These views provide direct access to the database tables for BMC Remedy AR System
forms, including forms for BMC Atrium Core classes.
For each database table (except for the attachment tables), a corresponding SQL view is created
automatically. These views, which have the same name as their underlying forms, are created
using the following naming rules:
Alphabetic and numeric characters remain as defined.
Colons, periods, and other special characters are replaced by underscores.
For example, the SQL view for the BMC.CORE:BMC_BaseElement form is named
BMC_CORE_BMC_BaseElement.
If the name contains a database reserved word, _x is appended to the name.
View names are limited to 30 characters. When a form name exceeds the limit, the
corresponding view name is truncated to 27 or 28 characters. A schema ID is appended to
the view name to differentiate between any other view that was truncated to the same string.
Because schema IDs vary from one system to another, these view names cannot be
formulated in advance. For example, the view of the BMC.CORE.CONFIG:
BMC_ConfigBaseRelationship form might be named
BMC_CORE_CONFIG_BMC_ConfigB131 or BMC_CORE_CONFIG_BMC_Config2131e.
For more information about SQL views and table naming conventions, see Understanding the
relationship between forms and database tables in the BMC Remedy Action Request System
online documentation.
BMC Atrium Core 9.0
Page 1255 of 2268
Home
BMC Atrium CMDB API print.c routines

The set of print routines for the cmdbdriver program are located in the print.c file. These routines
enable you to print the contents of any data structure in the application programming interface (API)
. The routines provide code examples for accessing the various structures. Printing the contents of
a structure before and after an API call is useful for debugging.
The print.h file contains a complete list of these routines. See the function definitions in print.c to
determine the specific parameters and their types for these routines.
API version requirements for BMC Atrium CMDB client-server

connections
You can prevent earlier versions of BMC Atrium Configuration Management Database (BMC Atrium
CMDB) clients from connecting to a later version of the server. To specify the minimum API version
with which the server can communicate, configure the Minimum-CMDB-API-Version parameter
in the ar.cfg (Microsoft Windows) or ar.conf (UNIX) file. The default value for this setting is 3.
For example, if you set Minimum-CMDB-API-Version to 4, clients earlier than version 2.1.00
cannot communicate with the server. For more information about the ar.cfg or ar.conf
configuration file, see ar.cfg or ar.conf in the BMC Remedy Action Request System online
documentation. The following table provides the BMC Atrium CMDB releases and their
corresponding API versions.
BMC Atrium Core releases and corresponding API versions

BMC Atrium CMDB release
API version
BMC Atrium CMDB 8.1.00
10
10
BMC Atrium CMDB 2.0.x
BMC Atrium Core 9.0
Page 1256 of 2268
Home
Comparison between BMC Atrium CMDB API programming

and using the BMC Atrium Core Console
The BMC Atrium Configuration Management Database (BMC Atrium CMDB) application
programming interface (API) allows you to interact with BMC Atrium CMDB programmatically and to
integrate BMC Atrium CMDB functionality into your applications. API programming gives you the
flexibility to customize your applications, but it is also more complex to design, implement, and
maintain. If you do not need this flexibility or would like to interact with the BMC Atrium CMDB user
interface, consider using the BMC Atrium Core Console.
When to use the BMC Atrium CMDB API and the BMC Atrium Core Console
BMC Atrium Core Console and BMC Atrium CMDB API terminology
The BMC Atrium Core Console provides an easy-to-use graphical user interface for performing
BMC Atrium CMDB tasks, such as creating classes, CIs, and relationships, and viewing instance
history. For more information about performing BMC Atrium Core Console tasks, see:
BMC Atrium Core Administering information For administrator tasks such as using
creating or modifying classes and attributes, and creating federated data.
Normalization and Reconciliation information For setting up normalization and
reconciliation tasks.
BMC Atrium Core Using information For user tasks, such as viewing CI history, viewing
CI and relationship classes, and comparing instances.
When to use the BMC Atrium CMDB API and the BMC Atrium Core Console
The following table outlines the scenarios in which you should use APIs or the BMC Atrium Core
Console.
API programming and BMC Atrium Core Console scenarios
Scenario
API programming or BMC

Atrium Core Console
To modify the CDM manually.
To access multiple BMC Atrium CMDB components at the same time or integrate with
programs or data outside the BMC Atrium Core Console.
API programming
To create, delete, or search for BMC Atrium CMDB classes manually.
To perform complex operations that involve multiple objects.
API programming
To create, delete, or search BMC Atrium CMDB relationships manually.
To create a two-way interface (or gateway) between BMC Atrium CMDB and another
application.
API programming
BMC Atrium Core 9.0
Page 1257 of 2268
Home
BMC Atrium Core Console and BMC Atrium CMDB API terminology
The BMC Atrium Core Console and the APIs use different terms for specific tasks, as shown in the
following table.
BMC Atrium Core Console and API terminology
BMC Atrium Core Console term
API term
search/find
getList/find/query
create
create
modify
set/update
view/display
get
Getting started with BMC Atrium Core Web

Services
This section provides the information that you need to get started with the BMC Atrium Web
Services and Infrastructure.
For more information on the BMC Atrium Web Services architecture, see BMC Atrium Core Web
Services architecture.
Topic
Description
Apache Axis2 and BMC Atrium Core Web
Describes the BMC Atrium Core Web Services Infrastructure which uses
Services
Apache Axis2, including modifications.
BMC Atrium Core UDDI Registry Server

functionality and supported features
Describes the BMC Atrium UDDI Registry which uses Apache jUDDI, including
modifications, enhancements, and unsupported features.
Working with the BMC Atrium Core Web

Services infrastructure
Explains how to do the following tasks:

Locate and configure BMC Atrium Core Web Services.
Publish web services to the BMC Atrium UDDI Registry .
Managing the BMC Atrium UDDI Registry administrator, publishers,
inquirers, and userstores.
Backing Up and Restoring Data in the BMC

Atrium Core UDDI Registry Server
Describes how to back up and restore the BMC Atrium UDDI Registry.
BMC Atrium Core Web Services security
Describes the default security settings for BMC Atrium Core Web Services,
which you can customize for secure data transmission.
BMC Atrium Core Web Services and the BMC

Remedy AR System Web Services
Explains the relationship between the BMC Atrium Core Web Services and the
BMC Remedy AR System Web Services.
Guidelines for using the BMC Atrium Core Web

Services Registry and interfaces
Provides guidelines for creating interfaces and publishing to the BMC Atrium
UDDI Registry.
CMDBWS support
BMC Atrium Core 9.0
Page 1258 of 2268
Home
Topic
Description
Describes the deprecated Web Services that was released in BMC Atrium
CMDB 2.1.
BMC Atrium Core Web Services and the BMC Remedy AR

System Web Services
The BMC Atrium Core Web Services and the BMC Remedy AR System Web Services are not the
same features and do not serve the same purpose. BMC Remedy AR System enables AR
applications to provide access and control to their forms through web services by exposing and
managing a form through web services.
BMC Remedy AR System uses Apache Axis whereas BMC Atrium Core Web Services uses
Apache Axis2. You can register BMC Remedy AR System Web Services if the BMC Atrium Core
UDDI registry is installed and its information is configured in BMC Remedy AR System. For more
information, see Integrating in the BMC Remedy AR System documentation.
BMC Atrium Core Web Services are based on Axis2 version 1.5 and expose all (or almost all) the
public APIs available from BMC Atrium Core, including reconciliation, normalization, and BMC
Atrium CMDB APIs. BMC Atrium Core Web Services also exposes other web services that register
with the Apache jUDDI Registry Server, such as Impacted Services.
Apache Axis2 and BMC Atrium Core Web Services

The BMC Atrium Core Web Services Infrastructure uses Apache Axis2, and the BMC Atrium Core
Registry is the Apache jUDDI Server. Apache Tomcat hosts the BMC Atrium Web Application
Archive and the BMC Atrium Web Services Archive.
Apache Axis2 WAR Distribution modifications
Apache Rampart modifications
Apache WSS4J modifications
Atrium Web Services Archive and exposed web services
BMC Atrium Web Application Archive and Axis2 modifications

The BMC Atrium Web Application Archive (BMC Atrium WAR) is installed as the atriumws90.war
file that includes the following distributions.
Modified JAR and MAR files include BMCSoftwareModified-atriumws90 in the file names. For
example, rampart-1.5.mar is renamed to rampart-1.5-BMCSoftwareModified-atriumws90.mar.
Applied solution 4.2 as defined in Apache Axis2 Security Advisory (CVE-2010-1632). All
occurrences of axis2.xml are modified as per solution specifications.
BMC Atrium Core 9.0
Page 1259 of 2268
Home
Apache Axis2 WAR Distribution version 1.5.1 This distribution has no direct modification
in the source code. The modifications are limited to the WEB-INF/conf/axis2.xml and
WEB-INF/axis2.xml files. For more information, see Apache Axis2 WAR Distribution
modifications.
Apache Rampart version 1.5 This distribution (rampart-1.5BMCSoftwareModified-atriumws90.mar ) has several direct modifications to the source to
overcome unwanted behaviors when using Rampart Basic configuration. For more
information, see Apache Rampart modifications.
Apache WSS4J version 1.5.8 Normally, WSS4J 1.5.8 is included as a part of Apache
Rampart 1.5. However, the included Apache WSS4J distribution (wss4j-1.5.8BMCSoftwareModified-atriumws90.jar ) has source code modifications in a few specific
areas to overcome non-compliant behaviors in the formation of wsu:Id attributes during the
formation of SOAP responses. For more information, see Apache WSS4J modifications.
Bouncy Castle Crypto APIs for Oracle Java version 1.4.5 This binary distribution is
included without modifications. It replaces Bouncy Castle Crypto APIs for Java version 1.4,
which is distributed with the binary distribution of Rampart version 1.5. That version is not be
included in the BMC Atrium WAR.
The atriumws90.war file also includes the following custom modules:
BMCAtriumWSEncryptionEnforcer This module enforces encryption of the wsse:
UsernameToken element at the element level and the SOAP:Body element at the content
level.
BMCAtriumWSSignatureBlocker This module blocks any messages that have been
signed using an unaccepted key and algorithm pair.
This module prevents a SOAP:Request from being executed when the security policy
for encrypting responses is enabled and when the private key that the client uses to
sign its requests is of DSA type. BMC Remedy IT Service Management Web Services
only supports encryption of the SOAP:Response using the public certificate that the
client uses to sign his SOAP:Request. The public certificate is included with the
SOAP:Request. Because a DSA key cannot be used to encrypt a SOAP response
using the available RSA key wrap algorithms in signing the response, this attempt
fails in these particular combination of circumstances.
However, a request signed with a DSA key does not always fail. If the policy for
encrypting the SOAP:Response is not enabled, requests signed with a DSA signature
are acceptable, and this module does not block the DSA signature.
This module also prevents the use of unsupported algorithms for signatures. Only
RSA-SHA1 and DSA-SHA1 algorithms are allowed. Any signature algorithm that does
not match these is blocked. DSA-SHA1 is also blocked if outgoing encryption of the
SOAP:Response is enabled
BMCAtriumWSResponseRepair When referenced at a context level that affects the
service and operation in question, such as the Configuration context ( axis2.xml ) or the
Service context (services.xml ), this module attempts to repair any and all outgoing
messages by ensuring that the xsi namespace is defined at the top level in the SOAP:
BMC Atrium Core 9.0
Page 1260 of 2268
Home
Envelope element. This prevents potential errors with messages secured by encryption from
failing to be unwrapped by specific clients (such as WSS4J-based clients) when the wsi
namespace declaration is contained with encrypted elements but not in an exposed plaintext
parent element.
Apache Axis2 WAR Distribution modifications

The Axis2 WAR is the primary component of the BMC Atrium Web Application Archive and has the
following modifications:
WEB-INF/web.xml Modified to remove access to the Axis2 Administration Console that
the BMC Atrium WAR does not use.
The <servlet> element for AxisAdminServlet has been commented out.
The <servlet-mapping> element for AxisAdminServlet has been commented out.
WEB-INF/conf/axis2.xml Modified to fit the wanted operational configuration for BMC
Atrium Web Services
The userName and password parameters have been commented out. With the
WEB-INF/web.xml changes, these parameters are not necessary.
The hotupdate parameter changed from false to true. This change supports the ability
to deploy this archive, the parameter for which (hotdeploy) is already enabled in the
axis2.xml file. The combination of these two allow repackaging and redeploying the
BMC Atrium WAR programmatically without the need to restart the Tomcat server.
The sendStacktraceDetailsWithFaults and DrillDownToRootCauseForFaultReason
parameters both changed from false to true. These changes enable detailed stack
traces accompanying faults to be sent with the SOAP fault responses at runtime.
The messageBuilder class name, where contentType is application/xml, is
changed from ApplicationXMLBuilder to SOAPBuilder. For more details about this
change, see section 4.2 defined in Apache Axis2 Security Advisory (CVE-2010-1632)
.
The disableREST and disableSOAP12 parameters changed from false to true. BMC
Atrium Web Services does not support Axis2's REST option to send and receive
responses without the SOAP envelope, and only SOAP 1.1 is currently supported in
SOAP requests and responses.
The existing HTTP transportReceiver is replaced with a transportReceiver declaration
absent a declaration for the HTTP port. Additionally, an HTTPS transportReceiver is
added absent a declaration for the HTTPS port. Both of these are mapped to the
AxisServlet class. These sections indicate that the BMC Atrium WAR depends on the
Tomcat configured connectors.
New security phases (BMCPreSecurityPhase and BMCPostSecurityPhase) are added
to both the InFlow and OutFlow phaseOrder declarations. BMCPreSecurityPhase is
added directly before the Security phase of both phaseOrder declarations, and
BMC Atrium Core 9.0
Page 1261 of 2268
Home
BMCPostSecurityPhase is added directly after the Security phase of both phaseOrder

declarations. These new phases position execution of BMC-authored security
modules to process messages before and after the Rampart-based security modules
handle the incoming and outgoing secured SOAP messages.
A new custom phase (BMCPrerequisitesPhase) is added to the InFlow phaseOrder
declaration immediately before the BMCPreSecurityPhase. The
BMCAtriumWSPrerequisiteChecker custom module uses BMCPrerequisitesPhase to
order the prerequisite checks before security phases are encountered.
Apache Rampart modifications

Apache Rampart distribution is included as part of BMC Atrium WAR with several direct
modifications to the source. The modifications made to this distribution are intended to overcome
unwanted behaviors when using Rampart Basic configuration. The following are descriptions of the
files added or changed in the Rampart distribution:
META-INF/module.xml This is a configuration file that is modified and replaces the
existing module.xml file in the existing rampart.mar file.
The handler declaration contained within the OutFaultFlow section is commented out to
prevent Rampart (signed or encrypted) from processing outgoing faults. This is to allow the
Axis2-based implementation of BMC Atrium Web services to behave similarly to the previous
implementation, which only returned faults without security processing.
com/bmc/atrium/ws/rampart/BMCRampartBasicUtil.java This implementation class is
added to the Rampart distribution that is distributed with BMC Atrium WAR. It is compiled as
a .class file and part of the existing rampart-core-1.5.jar file.
This file provides a method (isBMCUtilEnabled ) to determine if the BMC-authored
path through Rampart Basic Configuration has been enabled. This method returns
true if the bmc.atrium.wssecurity.rampart.bmcutil parameter must be set to ON in a
context accessible to the web service that will employ these changes (such as in the
axis2.xml file for the global configuration context or in the services.xml file contained
within the .aar file for the local service context). If this parameter is absent or is
present but is not set to ON, this method returns the value of false.
Another set of provided methods (both called validateReceiverResults)
validates the received SOAP requests to determine if they fit the action set defined in
the Rampart Basic configuration that is retrieved from the context of the invoked
service. These methods are intended to be a less stringent alternative to the
checkReceiverResults method inherited from the AbstractHandler class in the WSS4J
distribution, and they allow the new Axis2-based BMC Atrium Web Services to be
more in line with the previous implementation of BMC Atrium Web Services. The new
method validates based on the following rules:
All elements expected in the actions list are encountered in the message except for
Encryption, which is treated as optional when specified.
- Unexpected but harmless elements like Timestamp are allowed to be passed in
without a declaration in the actions list.
BMC Atrium Core 9.0
Page 1262 of 2268
Home
- Unexpected UsernameToken, Signature, and Encryption are disallowed if not

declared in the actions list.
- Signature and Encryption are encountered in the same order as in the actions list (
with the caveat that Encryption is still treated as optional).
An added method (throwWSSEFault) allows the throwing of a fault that is more
inline with the WS-Security standard than faults typically thrown when using Rampart
Basic configuration.
org/apache/rampart/handler/WSDoAllReceiver.java This class from the Rampart 1.5
source distribution has been modified, compiled into a .class file, and placed into the
existing rampart-core-1.5.jar file, replacing the previous class file. The class includes the
The BMCRampartBasicUtil.validateReceiverResults method executes in
place of the AbstractHandler.checkReceiverResults method when the
BMCRampartBasicUtil.isBMCUtilEnabled method returns true.
Fault messages are more traditional and human readable without reference to the
controlling class in the main error message. Also, fault messages are thrown to be
more compliant with WS-Security in the wsse namespace when the
org/apache/rampart/handler/WSDoAllSender.java This class from the Rampart 1.5
source distribution has been modified, compiled into a .class file, and placed into the existing
rampart-core-1.5.jar file, replacing the previous class file. The class includes the following
modifications:
Fault messages are more traditional and human readable without reference to the controlling
class in the main error message. Also, fault messages are thrown to be more compliant with
WS-Security in the wsse namespace when the
All but the first of these Apache Rampart modifications are optional to any Axis2-based Web
Service archive (.aar file) that runs in the BMC Atrium WAR.
The bmc.atrium.wssecurity.rampart.bmcutil parameter must be set to ON in a context
accessible to a web service that intends to employ these changes (such as in the axis2.xml
file for the global configuration context or in the services.xml file contained within the .aar
file for the local service context). If this parameter is absent or if it is present but not set to
ON, the Rampart distribution should behave as the unmodified Rampart 1.5 distribution
when using Rampart Basic configuration.
Apache WSS4J modifications

Normally, WSS4J 1.5.8 is included as a part of Apache Rampart 1.5. However, the Apache WSS4J
distribution included in the Atrium WAR has been modified in the source code in a few specific
areas. The modifications overcome non-compliant behaviors in the formation of wsu:Id attributes
during the formation of SOAP responses. WSS4J includes the following changes:
BMC Atrium Core 9.0
Page 1263 of 2268
Home
org/apache/ws/security/WSSConfig.java This class from the WSS4J 1.5.8 source

distribution. has been modified, compiled into a .class file, and placed into the existing
wss4j-1.5.8.jar file in the Rampart 1.5 distribution, replacing the original class file. The class
includes the following modification:
The default implementation of the WsuIdAllocator interface as declared in the static final
instance DEFAULT_ID_ALLOCATOR, has been modified to always include the BMC-prefix.
If no other prefix is passed in to one of the available methods, that will be the only prefix
included. If another prefix is also passed in, it will be included as an additional prefix. For
example, if no prefix is passed into a request to generate a wsu:Id value, the value returned
will begin with a BMC- prefix and then the generated sequential ID or secure GUID. If,
however, ID- were passed in as well, the value returned will begin with a BMC-ID- prefix and
then the generated sequential ID or secure GUID. This is to prevent an issue in WSS4J in
which some wsu:Id values were being returned beginning with a number, which does not
meet the definition as provided in the XSD specification for either the ID type or the NCName
type. Functionally this means that all wsu:Id values generated in a SOAP response will begin
with the BMC- prefix.
org/apache/ws/security/message/WSSSecEncryptedKey.java This class from the
WSS4J 1.5.8 source distribution has been modified, compiled into a .class file, and placed
into the existing wss4j-1.5.8.jar file in the Rampart 1.5 distribution, replacing the original
class file. The class includes the following modifications:
The wsu:Id for the BinarySecurityToken was being generated without a prefix and
without the use of the default implementation of the WsuIdAllocator interface as
contained in the WSSConfig class. This led to BinarySecurityToken elements
containing a wsu:Id that began with a number, which does not meet the definition as
provided in the XSD specification for either the ID type or the NCName type. A
modification was made to include the prefix BinSecTok- and to generate the ID from
the default WsuIdAllocator implementation's security ID generation method. This
means that all wsu:Id values generated for a BinarySecurityToken will begin with the
prefix BMC-BinSecTok- and then contain the generated secure GUID.
The wsu:Id for the EncryptedKey portion of the encryption elements of the SOAP
response was being generated without the use of the default implementation of the
WsuIdAllocator interface as contained in the WSSConfig class. A modification to
generate the ID from the default WsuIdAllocator implementation's security ID
generation method using the same prefix that had been previously appended to such
values, for example, EncKeyId-. This means that all wsu:Id values generated for the
EncryptedKey elements will begin with the prefix BMC-EncKeyId- and then contain
the generated secure GUID.
Atrium Web Services Archive and exposed web services

As part of the BMC Atrium Core installation, the BMC Atrium WAR file includes a BMC Atrium Web
Services Archive configured for default security settings. When executed, this archive exposes the
web services described in the following table. For SOAP responses, no WS-Security policies are
enabled by default.
BMC Atrium Core 9.0
Page 1264 of 2268
Home
Default BMC Atrium Web Services Archive

Web service and description
Endpoint
WSDL
atrium_serviceconfig Exposes operations for the handling
https:// hostname: sslport /
of runtime configuration of the Web services. See the

chapter on runtime configuration for a more complete
atriumws90/services/
atrium_serviceconfig
atrium_serviceconfig.wsdl
atrium_audit Exposes operations for BMC Atrium

Configuration Management Database (BMC Atrium CMDB)
auditing.

atrium_audit

atrium_audit.wsdl
atrium_businessobjects_20 Exposes operations for BMC
Atrium CMDB-based USM activities.
atrium_businessobjects_20
atrium_businessobjects_20.wsdl
atrium_businessobjects (deprecated) Exposes operations

for BMC Atrium CMDB-based USM activities.

atrium_businessobjects

atrium_businessobjects.wsdl
atrium_classes Exposes operations query, creation, and

modification of BMC Atrium CMDB schema elements, such
as classes and attributes.

atrium_classes

atrium_classes.wsdl
atrium_classicfederation Exposes operations for classic

BMC Atrium CMDB federation.


atrium_classicfederation
atrium_classicfederation.wsdl
atrium_classicreconciliation Exposes operations for the

management of classic reconciliation engine jobs.

atrium_classicreconciliation

atrium_classicreconciliation.wsdl
atrium_cmdbf_query Exposes operations for federated
CMDB graph queries.
atrium_cmdbf_query
atrium_cmdbf_query.wsdl
atrium_cmdbf_config Exposes operations for configuring

and loading CMDBf settings.

atrium_cmdbf_config

atrium_cmdbf_config.wsdl
atrium_datasets Exposes operations for querying, creating,

and modifying BMC Atrium CMDB datasets.

atrium_datasets

atrium_datasets.wsdl
atrium_graphquery Exposes operations for graph queries

to BMC Atrium CMDB.

atrium_graphquery

atrium_graphquery.wsdl
atrium_graphwalk Exposes operations for graph queries.

atrium_graphwalk

atrium_graphwalk.wsdl
atrium_instances Exposes operations for the retrieving,

creating, modifying, and deleting instances.

atrium_instances

atrium_instances.wsdl
explanation.
atrium_normalization Exposes operations for the CMDB

Normalization Engine.
BMC Atrium Core 9.0
Page 1265 of 2268
Home
Web service and description
Endpoint
WSDL


atrium_normalization
atrium_normalization.wsdl
atrium_notifications_pull Exposes operations for retrieving

pull based events from the Notification Engine.

atrium_notifications_pull

atrium_notifications_pull.wsdl
atrium_notifications_subscribe Exposes operations for
subscribing to events from the Notification Engine.
atrium_notifications_subscribe
atrium_notifications_subscribe.wsdl
atrium_query_20 Exposes operations for querying

instances and relationships by path.

atrium_query_20

atriumws90/services/atrium_query
_20.wsdl
atrium_query (deprecated) Exposes operations for

querying instances and relationships by path.


atrium_query
atrium_query.wsdl


atrium_reconciliation
atrium_reconciliation.wsdl
atrium_serviceimpact Exposes an operation to trace

business services impacted by specific CIs.

atrium_serviceimpact

atrium_serviceimpact.wsdl
atrium_versions Exposes an operation to retrieve
components registered in BMC Atrium CMDB and their

versions.
atrium_versions
atrium_versions.wsdl
atrium_reconciliation Exposes operations for the CMDB

Working with the BMC Atrium Core Web Services infrastructure

To work with the BMC Atrium Core Web Services infrastructure, you must understand how to locate
and configure your BMC Atrium Core Web Services.
To make your own web services available for consumption, you must understand how to publish
your web services to the BMC Atrium Core Web Services Registry.
Web Services Registry and web service registration
BMC Remedy AR System Web Service Registry form
Managing web services with the Web Service Registry API
Modifying the BMC Atrium UDDI Registry administrator username and password
Changing the special BMC Remedy AR System publisher
Enabling or disabling BMC Remedy AR System administrators as publishers
Enabling or disabling BMC Remedy AR System users as inquirers
Changing the BMC Remedy AR System server used as a userstore
Disabling the use of a BMC Remedy AR System server as a userstore
BMC Atrium Core 9.0
Page 1266 of 2268
Home
Web Services Registry and web service registration

All BMC web services, including BMC Atrium Core, BMC Remedy AR System, and other web
services, must manage their registrations during their life cycle.
To register all BMC Remedy AR System web services, see BMC Remedy AR System Web
Service Registry form
To register all other web services, see Managing web services with the Web Service
Registry API
When published with the WSRegistryAPI, each BMC web service is published to the registry with
the following information:
Service Name the name of the service
Service Version the official version of the service
Business Name the name of the business entity
Application Name the name of the Application area, such as BMC Remedy IT Service
Management
Service Description a description for the service
Access Point URL Specifies the URL of the service access endpoint
WSDL URL Specifies the URL of the service web services description language (WSDL)
When you register your BMC Atrium Core Web Services, you must specify a URL for the access
point and, optionally, a URL for the WSDL. The access point URL is formatted as follows:
https://<hostname>:<portNumber>/<servicePortName>
Where
Description
hostname
Server computer name.
portnumber
Server port number.
service_port_name
The service port name format depends on the type of Web Service implementation that you have. The
following service port name values are provided as an example:
atriumclasses_porttype
atriuminstances_porttype
atriumdatasets_porttype
atriumquery_porttype
atriumgraphwalk_porttype
atriumreconciliation_porttype
atriumnormalization_porttype
atriumbusinessobjects_porttype
atriumbusinessimpact_porttype
atriumversions_porttype
atriumclassicfederation_porttype
atriumclassicreconciliation_porttype
atriumserviceconfig_porttype
BMC Atrium Core 9.0
Page 1267 of 2268
Home
Where
Description
For example, to specify the URL for the versions Web Service:
http://goldserver:9090/atriumversions_porttype
The WSDL URL is formatted as follows:
https://<hostname>:<portNumber>/<servicePortName>?wsdl
For example, to specify the URL for the versions Web Service WSDL:
http://goldserver:9090/atriumversions_porttype?wsdl
BMC Remedy AR System Web Service Registry form

You can use BMC Remedy AR System to manage your BMC Remedy AR System web services
registration.
For information about how to register BMC Remedy AR System web services using the BMC
Remedy AR System Web Registry form, see Integrating in the BMC Remedy AR System
documentation.

You can use the following Web Service Registry API sample scripts to register, unregister, and find
your BMC Atrium Core Web Services:
publish
unpublish
find
These scripts can be modified to meet the needs of your company using the WSRegistry Java API.
To use the Web Service Registry sample scripts

1. Open a command window.
2. Navigate to the Atrium Core Installation directory.
For example, in a Windows environment, the default location is:
<ATRIUMCORE_INSTALL_DIRECTORY>\wsc\wsregistryapi\conf
ATRIUMCORE_INSTALL_DIRECTORY example, C:\Program Files\BMC Software\AtriumCore\<
ARserverHostname>.
(The <ARserverHostname> is optional depending, on the installation directory and
server group option)
BMC Atrium Core 9.0
Page 1268 of 2268
Home
3. In registryserver.properties, modify the server name and port number of the UDDI server.
4. Verify that the following values are defined correctly in env.cmd (located in <
ATRIUMCORE_INSTALL_DIRECTORY>\wsc\wsregistryapi\scripts\ ):
JAVA_HOME ( example, <ATRIUMCORE_INSTALL_DIRECTORY>/jdk1.6.0_29/jre)
CLIENT_HOME (example, (i.e. <<ATRIUMCORE_INSTALL_DIRECTORY>/wsc/
wsregistryapi)
UDDI username
UDDI password
5. Edit the scripts below to provide the required parameters:
publish
{ServiceName} {ServiceVersion} {BusinessName} {ServiceDescription} {
AccessPointUrl} {WSDLUrl}
unpublish {ServiceName} {ServiceVersion} {BusinessName}
unpublish {ServiceName} {ServiceVersion} {BusinessName}
findsvc
{ServiceName} {ServiceVersion} {BusinessName} {ApproximateMatch}
Parameter name
Description
ServiceName
Name of the service
ServiceVersion
Version of the service
BusinessName
Name of the BusinessEntity
ServiceDescription
Description of the service
AccessPointUrl
URL of the service access point. For example: http://goldserver:9090/atriumversions_porttype
WSDLUrl
URL of the service WSDL if this is a WSDL service. For example: http://goldserver:9090/
atriumversions_porttype?wsdl
ApproximateMatch
Whether to do approximate matching.

Y calls findServices()
N calls findService()
For example, you can execute the following command to register the IIWS 1.0 service:
ServicePublisher publish IIWS 1.0 BMC MyIIWS http://myhost:6070/imapi http://myhost:

6070/imapi?WSDL
For example, you can run the following command to find the IIWS Web Service:
TestUDDIRegistry findsvc IIWS 1.0 BMC Y
BMC Atrium Core 9.0
Page 1269 of 2268
Home
Modifying the BMC Atrium UDDI Registry administrator username and password
To apply correct security for your application after installation, you should perform the steps in this
topic on a periodic basis.
Recommendations
Changing the root user's password
Changing the root user's username
The default username and password is admin/admin.
Recommendations
Make all changes to the backup of the Tomcat layout in <ATRIUMCORE_HOME>/wsc/bmcuddi/
tomcat file first. Then, copy the files to the running Tomcat instance.
Warning
Do not change the following items when working with these files: The
bmc.juddi.auth.localuser.user property in the <ATRIUMCORE_HOME>/wsc/
bmcuddi/tomcat/webapps/uddi/WEB-INF/classes/bmcauth.properties file. The
juddi.root.publisher property in the <ATRIUMCORE_HOME>/wsc/bmcuddi/
tomcat/webapps/uddi/WEB-INF/classes/juddiv3.properties file.
Warning
Do not rename or modify any of the files under <ATRIUMCORE_HOME>/wsc/bmcuddi/
tomcat/webapps/uddi/WEB-INF/classes/juddi_custom_install_data.
Changing the root user's password

1. In a command-line interface (CLI), go to <ATRIUMCORE_HOME>/wsc/wsregistryapi/
scripts.
2. Start the password utility:
For Microsoft Windows, enter encryptpswd.cmd.
For UNIX/Linux, enter ./encryptpswd.
3. Type in the new password when prompted.
The encrypted password is returned.
4. In the <ATRIUMCORE_HOME>/wsc/bmcuddi/tomcat/webapps/uddi/WEB-INF/classes/
bmcauth.properties file, assign the bmc.juddi.auth.localuser.passwd property its
value the encrypted password.
5. Stop the Tomcat server that hosts BMC Atrium Core UDDI Registry Server.
6.
BMC Atrium Core 9.0
Page 1270 of 2268
Home
6. To overwrite the existing file, copy the <ATRIUMCORE_HOME>/wsc/bmcuddi/tomcat/

webapps/uddi/WEB-INF/classes/bmcauth.properties file to the TOMCAT_HOME/
webapps/uddi/WEB-INF/classes directory.
7. Start the Tomcat server.
Changing the root user's username

1. In a text editor, open the bmcauth.properties file in <ATRIUMCORE_HOME>/wsc/
bmcuddi/tomcat/webapps/uddi/WEB-INF/classes/ .
2. For the bmc.juddi.auth.localuser.alias property, specify the new user name for the
root user.
By default it is unassigned (which means the server defaults the local user name to the value
assigned to the bmc.juddi.auth.localuser.name property).
3. Stop the Tomcat 6 server that hosts BMC Atrium Core UDDI Registry Server.
webapps/uddi/WEB-INF/classes directory .
5. Start the Tomcat 6 server.
Changing the special BMC Remedy AR System publisher

One BMC Remedy AR System user is designated to have publishing privileges. The installer sets
this by deafult to the BMC Remedy AR System administrator user that you specified during
installation to enable it to perform administrator operations. However, you can change to another
BMC Remedy AR System user. This BMC Remedy AR System user can be any that you choose to
designate as a special publisher for the UDDI server, regardless of its privileges in the BMC
Warning
Do not change the following items when working with these files:
The bmc.juddi.auth.localuser.user property in the <ATRIUMCORE_HOME>/
wsc/bmcuddi/tomcat/webapps/uddi/WEB-INF/classes/bmcauth.properties file.
The juddi.root.publisher property in the <ATRIUMCORE_HOME>/wsc/bmcuddi/
tomcat/webapps/uddi/WEB-INF/classes/juddiv3.properties file.
Warning
Do not rename or modify any of the files under <ATRIUMCORE_HOME>/wsc/bmcuddi/
tomcat/webapps/uddi/WEB-INF/classes/juddi_custom_install_data.
BMC Atrium Core 9.0
Page 1271 of 2268
Home
To change the special publisher

2. Change the bmc.ar.publisher.name property to the new AR user name that will act as a
publisher.
Enabling or disabling BMC Remedy AR System administrators as publishers

You can configure the BMC Atrium Core UDDI Registry Server to allow all BMC Remedy AR
System users with administrator privileges to act as publishers. This might be useful in situations
where requiring applications related to Atrium Web Services to know the local root publisher
account for the BMC Atrium Core UDDI Registry Server is undesirable.
To manage BMC Remedy AR System administrators as publishers

2. Change the bmc.ar.publisher.admins property to true to enable this feature, or to
false to disable it.
By default, it is set to true, which enables the feature.
Enabling or disabling BMC Remedy AR System users as inquirers

You can configure the BMC Atrium Core UDDI Registry Server to allow all BMC Remedy AR
System users regardless of their privileges to act as inquirers, which means that they can run
queries to retrieve registry data but cannot publish new entries or modify existing entries.
This might be useful in situations where allowing for BMC Remedy AR System users to query
endpoints without also having to grant publishing privileges is desirable.
Note
This feature does not allow users that log on to BMC Remedy AR System as a guest to
make inquiries. Only users that exist in the AR system can authenticate as inquirers.
BMC Atrium Core 9.0
Page 1272 of 2268
Home
To set BMC Remedy AR System users as inquirers

2. Change the bmc.ar.inquiry.users property to true to enable this feature or to false to
disable it.
By default, it is set to false, which disables the feature.
Changing the BMC Remedy AR System server used as a userstore

In rare situtations, you might need to change the BMC Remedy AR System server that the BMC
Atrium Core UDDI Registry Server uses as a userstore. Normally, you should leave this setting as
defined during installation. You might need to change the userstore to reconfigure internal server
aliases or to make reverse proxy sites external after installation.
To change the server used as a userstore

2. Change the following properties if needed:
bmc.atrium.arserver.hostname Set this to the accessible host name of the
BMC Remedy AR System server.
bmc.atrium.arserver.port Set this to the accessible port number for your
BMC Remedy AR System server. If you are using the default BMC Remedy AR
System port, this should be set to 0.
Disabling the use of a BMC Remedy AR System server as a userstore

You can disable all BMC Remedy AR System users from access to the registry and all sole access
to the server from the local UDDI publisher.
Note
BMC Atrium Core 9.0
Page 1273 of 2268
Home
This procedure will disable the special AR publisher, treatment of all AR administrators as
publishers, and treatment of all AR users as inquirers, even if other settings specify
differently. This procedure should only be used in cases where granting AR users access
to the registry is entirely unwanted behavior.
To disable the BMC Remedy AR System server as a userstore

1. Edit the file <ATRIUMCORE_HOME>/wsc/bmcuddi/tomcat/webapps/uddi/WEB-INF/
classes/bmcauth.properties.
2. Comment out the bmc.atrium.arserver.hostname property by adding a # character to
the beginning of the line containing that property definition.
3. Stop the Tomcat server that hosts the BMC Atrium Core UDDI Registry Server.
BMC Atrium Core UDDI Registry Server functionality and

supported features
In BMC Atrium Core, the BMC Atrium Core UDDI Registry Server is based on the Apache jUDDI
Registry Server. This section presents the following topics:
New functionality in the BMC Atrium Core UDDI Registry Server
Unsupported functionality in the BMC Atrium Core UDDI Registry Server
Components used from the jUDDI distribution and source
Modifications to the jUDDI distribution and source
New functionality in the BMC Atrium Core UDDI Registry Server

In BMC Atrium Core, the BMC Atrium Core UDDI Registry Server supports multiple BMC Remedy
Action Request System users as registry consumers. The server supports the following users:
The local user (root publisher) of the server is local to the Universal Description, Discovery
and Integration (UDDI) server, not external, and has full root publishing privileges.
One specific AR System user for the BMC Remedy AR System server that is linked to the
BMC Atrium Core UDDI Registry Server can be designated as having root publishing
privileges using that account's BMC Remedy AR System credentials.
Note
BMC Atrium Core 9.0
Page 1274 of 2268
Home
The BMC Atrium Core installer uses the BMC Remedy AR System administrator used for
installation operations as this user, but you can change it to another BMC Remedy AR
System user. For more information, see Modifying the BMC Atrium UDDI Registry
administrator username and password
All AR administrators for the BMC Remedy AR System server that are linked to the ABMC
Atrium Core UDDI Registry Server have access with root publishing privileges using their AR
credentials. For more information, see Modifying the BMC Atrium UDDI Registry
administrator username and password
All other AR users for the BMC Remedy AR System server that are linked to the BMC Atrium
Core UDDI Registry Server can have access to perform queries using their AR credentials.
For more information, see Modifying the BMC Atrium UDDI Registry administrator username
and password
Unsupported functionality in the BMC Atrium Core UDDI Registry Server

In BMC Atrium Core, the BMC Atrium Core UDDI Registry Server supports most of the functionality
of the previous TIBCO-based server so that your existing integrations continue to work. However,
the BMC Atrium Core UDDI Registry Server does not support the following features:
UDDI UI console TIBCO's console is based on their proprietary UI libraries and cannot be
reproduced with the same look and feel. Although jUDDI supports a Portal console through
its Portle bundle, it is not available in this release.
TIBCO Proprietary Poll-based Subscription Port The TIBCO UDDI Server did not support
the standard publish/subscribe port defined in the UDDIv3 standard, which implemented a
push model for events. Instead, the IBCO UDDI Server used a proprietary port which
provided operations that allowed poll-based subscriptions and which essentially
implemented a pull model. These mplementations and interfaces are proprietary and not
available in the BMC Atrium Core UDDI Registry Server.
External databases Previously, the BMC Atrium Core UDDI Registry Server required an
external database to operate and store data. With this release, the server uses an
embedded Apache Derby database and does not support an external database.
Server group (high availability) BMC Atrium Core UDDI Registry Server does not support
high availability configurations.
Functionality supported in Apache jUDDI Server but unsupported in Atrium UDDI Server
The BMC Atrium Core UDDI Registry Server does not currently support the following features
available in the Apache jUDDI Server:
Apache jUDDI Server Portal Although the Apach jUDDI Server supports a Portal console
through its Portle bundle, the BMC Atrium Core UDDI Registry Server does not support it in
the current release.
BMC Atrium Core 9.0
Page 1275 of 2268
Home
UDDIv3 publish/subscribe-based subscription port Apache jUDDI Server supports the

subscription port and the subscription listener port defined by the UDDIv3 standard. While
these ports are not disabled in BMC Atrium Core UDDI Registry Server, it does not officially
support them at this time.
Other UDDIv3 Ports The Apache jUDDI Server supports other UDDIv3 ports and also
exposes several UDDIv3 ports for which it does not supply an implementation. (All
operations for those ports return a SOAP Fault with a "Not Implemented" message.)
BMC Atrium Core UDDI Registry Server supports the following UDDIv3 ports:
Security
Inquiry
Publish (Renamed to Publication to match the previous release of BMC Atrium Core
UDDI Registry Server)
The BMC Atrium Core UDDI Registry Server does not support the following UDDIv3
ports:
Subscription (unsupported but not disabled)
Subscription-Listener (disabled)
Custody-Transfer (disabled)
Replication (disabled)
Valueset-Validation (disabled)
Valueset-Caching (disabled)
jUDDI API Port (Non-standard) Apache jUDDI Server provides a port for jUDDI's
proprietary API. Because this port is specific to jUDDI and is not defined by the UDDIv3
standard, it is not supported and is disabled.
Components used from the jUDDI distribution and source

The BMC Atrium Core UDDI Registry Server is built primarily from several Apache jUDDI 3.0.4
distributions. If any source files required rebuilding, BMC compiled only those modified files against
the existing Java Archive (JAR) files. Then, those JAR files are updated with the newly compiled
classes to replace only those files.
The BMC Atrium Core UDDI Registry Server uses the following distributions and components:
jUDDI Tomcat 3.0.4 Binary Distribution To install to an existing Tomcat 6 or the bundled
Tomcat 6, BMC Atrium Core UDDI Registry Server includes the following components from
the distribution:
lib/commons-discovery-0.2.jar
lib/derby-10.4.2.0.jar
lib/jasper-jdt.jar
lib/log4j-1.2.13.jar
lib/mysql-connector-java-5.1.6.jar
webapps/juddiv3 (The entire directory)
BMC Atrium Core 9.0
Page 1276 of 2268
Home
jUDDI 3.0.4 source Only the modified source files from the distribution are recompiled,
which includes the following files:
juddi-parent/juddi-core/src/main/java/org/apache/juddi/config/Install.java
juddi-parent/juddi-core/src/main/java/org/apache/juddi/validation/
ValidatePublish.java
juddi-parent/juddi-core/src/main/java/org/apache/juddi/validation/
ValidateInquiry.java
juddi-parent/juddi-core/src/main/resources/juddi_install_data (The entire
directory)
Modifications to the jUDDI distribution and source

The BMC Atrium Core UDDI Registry Server uses Apache jUDDI. Apache jUDDI has been
modified to fit BMC's requirements in the following ways:
Renaming of the WAR and its files
Modifications to WAR and its files
Modifications to the configuration files
Removed directories from the WAR
Additions to the WAR
Renaming of the WAR and its files

The Web application directory has been renamed from juddiv3 to uddi. This is to ensure
that the endpoints of each of the supported UDDI services (security, inquiry, and publication)
match those of the TIBCO UDDI Server.
The WEB-INF/lib/juddi-core-openjpa-3.0.4 jar file has been renamed to
juddi-core-openjpa-3.0.4-BMCSoftwareModified-atriumuddi appended with the BMC
Atrium CMDB version number (for example, for BMC Atrium CMDB 9.0, the file name will be
juddi-core-openjpa-3.0.4-BMCSoftwareModified-atriumuddi90.jar). This change reflects that
BMC has modified the implementation of this file. For more information, see Modifications to
web application archive (WAR) and its files .
Modifications to WAR and its files

The BMC Atrium Core UDDI Registry Server incluces the following modifications to the Java source
files from juddi core jar file:
org/apache/juddi/config/Install.java The getPublishers method is modified to
convert the encoded form of space characters in the path automatically, preventing a failure
in loading files when the path includes spaces.
org/apache/juddi/validation/ValidatePublish.java The validateKeyedReference
method has a removed restriction to provide keyed references with blank values assigned at
publishing time. This change provides backward compatibility. The restriction against null
values is still enforced.
BMC Atrium Core 9.0
Page 1277 of 2268
Home
org/apache/juddi/validation/ValidateInquiry.java The validateKeyedReference

method has a removed restriction to provide keyed references with blank values assigned at
query time. This is to provide backward compatibility. The restriction against null values is
still enforced.
Modifications to the configuration files

META-INF/context.xml The resource entry for the embedded Apache Derby database
has the URL attribute set to an absolute path under the BMC Atrium Core installation
directory as the location to cache the data.
Old Setting (with a relative path to the data)
<Resource name="jdbc/JuddiDS" auth="Container"

type="javax.sql.DataSource" username="" password=""
driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
url="jdbc:derby:target/juddi-derby-test-db;create=true"
maxActive="8" />
New Setting (with %ATRIUMCORE_HOME% representing the root installation directory of

BMC Atrium Core)
<Resource name="jdbc/JuddiDS" auth="Container"

type="javax.sql.DataSource" username="" password=""
driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
url="jdbc:derby:%ATRIUMCORE_HOME%/shared/wsc/data/
bmcuddi/derby-db;create=true"
maxActive="8" />
WEB-INF/beans.xml The file has the following changes.

All ports except for security, inquiry, publication, and subscription are commented out,
disabling those ports. This is to ensure that the server does not make unsupported
available, except for the subscription port, which needs to at least be active to allow
previous releases of the API not to fault at instantiation.
The relative endpoint address for the UDDI publication service has been changed
from the jUDDI default of /publish to /publication. This ensures that the endpoint for
the publication service matches that of the previous release.
Old setting:
<jaxws:endpoint id="publish" implementor="

org.apache.juddi.api.impl.UDDIPublicationImpl" address="/publish"
New setting:
BMC Atrium Core 9.0
Page 1278 of 2268
Home
<jaxws:endpoint id="publish" implementor="

org.apache.juddi.api.impl.UDDIPublicationImpl" address="/publication"
WEB-INF/classes/juddiv3.properties The juddi.authenticator property has been

changed from the default authentication implementation class org.apache.juddi.v3.
auth.JUDDIAuthenticator to the BMC implementation
com.bmc.webservices.uddiauth.juddi.BMCJuddiAuthenticator.
Old setting:
juddi.authenticator = org.apache.juddi.v3.auth.JUDDIAuthenticator
New setting:
juddi.authenticator = com.bmc.webservices.uddiauth.juddi.BMCJuddiAuthenticator
Removed directories from the WAR

The following directories have been removed:
WEB-INF/classes/RENAME4MARKETING_juddi_custom_install_data
WEB-INF/classes/RENAME4SALES_juddi_custom_install_data
Additions to the WAR

The Apache UDDI Server components are organized in a Tomcat instance as follows.
WEB-INF/lib/BMCJuddiAuth<MM>.jar This file contains the implementation of BMC
authenticator for jUDDI, which consists of the
com.bmc.webservices.uddiauth.juddi.BMCJuddiAuthenticator class and other
supporting implementation classes. <MM> in the file name is the version for the particular
release of Atrium, such as 77, meaning that the file is named BMCJuddiAuth77.jar for the
8.0.00 release.
WEB-INF/lib/cmdbapi<MM>.jar This file contains the CMDB API, which is used in the
authentication process to allow CMDB or AR users to authenticate for inquiries and CMDB
or AR administrators to act as publishers. <MM> in the file name is the version for the
particular release of Atrium, such as 77, meaning that the file is named cmdbapi77.jar for
the 8.0.00 release.
WEB-INF/lib/arapi<MM>_build<BBB>.jar This file contains the CMDB API, which is
used in the authentication process to allow BMC Atrium CMDB or BMC Remedy AR System
users to authenticate for inquiries and BMC Atrium CMDB or BMC Remedy AR System
administrators to act as publishers. <MM> in the file name is the version for the particular
release of Atrium, and <BBB> value represents the build number. For example, for the
8.0.00 release, these values are 77 and 002 respectively, meaning that the file is named
arapi77_build002.jar for that release.
BMC Atrium Core 9.0
Page 1279 of 2268
Home
WEB-INF/classes/bmcauth.properties This file contains the configuration properties

used by the BMC authenticator for jUDDI to faciliate authentication of both the root publisher
and CMDB and AR users and administrators. The default file contains meaningful defaults
for some properties and leaves others unset for now. The installer modifies those properties
at installation time too their appropriate values:
bmc.atrium.arserver.hostname=
bmc.atrium.arserver.port=
bmc.atrium.arserver.rpcqueue=0
bmc.atrium.arserver.defaultlocale=en
bmc.atrium.arserver.defaulttimeout.normal=0
bmc.atrium.arserver.defaulttimeout.long=0
bmc.atrium.arserver.defaulttimeout.xlong=0
bmc.juddi.auth.localuser.name=
bmc.juddi.auth.localuser.passwd=
bmc.juddi.auth.localuser.alias=
bmc.ar.publisher.name=
bmc.ar.publisher.admins=true
bmc.ar.inquiry.users=false
WEB-INF/classes/juddi_custom_install_data This is the juddi_install_data directory

from the resources in the source. It is placed in the WAR WEB-INF/classes under the new
name juddi_custom_install_data. Several additional changes are made to the contents of
this directory as follows:
root_Publisher.xml This file is renamed as admin_publisher.xml. No changes
are made to this file at build time.
root_BusinessEntity.xml This file is renamed as admin_BusinessEntity.xml.
Every businessKey, serviceKey, and bindingKey attribute found has its value modified
. The default values for these attributes follow the formula "uddi:juddi.apache.org:" (
where * represents a wildcard for any string value). These values are modified to the
corresponding value "uddi:bmc.com:". This instructs the jUDDI engine to generate
keys for published entities in the pattern uddi:bmc.com:guid instead of the default
patterm of uddi:juddi.apache.org:guid.
root_tModelKeyGen.xml This file is renamed as admin_tModelKeyGen.xml.
The tModelKey attribute of the parent tModel element is modified as follows:
Original setting:
<tModel tModelKey="uddi:juddi.apache.org:keygenerator" xmlns="urn:uddi-org:

api_v3">
New setting:
<tModel tModelKey="uddi:bmc.com:keygenerator" xmlns="urn:uddi-org:api_v3">
BMC Atrium Core 9.0
Page 1280 of 2268
Home
This instructs the jUDDI engine to generate keys for published entities in the pattern
uddi:bmc.com:guid instead of the default patterm of uddi:juddi.apache.org:guid.
aruser_Publisher.xml This is a new file added to this directory, not an existing
one. The contents of this file are as follows:

<!-* Copyright 2001-2009 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/ -->
<publisher xmlns="urn:juddi-apache-org:api_v3" authorizedName="">
<publisherName>AR publisher</publisherName>
<isAdmin>true</isAdmin>
</publisher>
UDDI_Publisher.xml This is an existing file in this directory. No changes are made

to this file at build time.
UDDI_tModels.xml This is an existing file in this directory. No changes are made
to this file at build time.
Backing Up and Restoring Data in the BMC Atrium Core UDDI

Registry Server
There are two methods to back up your data. The first is to back up the database files themselves,
which is the simplest method and preserves the unique ID values of the entries when restoring data
. The second is to export the contents of the Universal Description, Discovery and Integration (
UDDI) registry server itself to an XML file. This method will not preserve the unique ID values of the
entries when restoring data.
To back up the database
To restore the database
To back up the UDDI server
To restore the UDDI server
BMC Atrium Core 9.0
Page 1281 of 2268
Home
To back up the database

2. Navigate to the <ATRIUMCORE_HOME>/shared/wsc/data/bmcuddi/derby-db directory.
3. Add the entire contents of derby-db/ to a zip file.
This file is a snapshot of your data.
4. Rename the file to include the date and time of the backup and store it in a reliable location.
To restore the database

This procedure assumes that you have a zip file with a saved backup.
2. Navigate to the <ATRIUMCORE_HOME>/shared/wsc/data/bmcuddi/ directory.
3. If the derby-db/ directory exists, move it to another directory outside the <
ATRIUMCORE_HOME> location, or rename it, such as derby-db.bak.
4. Extract the contents of the backup zip file.
The expanded directory should be derby-db.
To back up the UDDI server

1. Do not stop the Tomcat server. If the server is not running, start the server.
It must remain running while performing this procedure.
2. In the <ATRIUMCORE_HOME>/wsc/wsregistryapi/registryserver.properties file, verify
the correct endpoints.
If the endpoints are incorrect, edit the file and correct them.
To test the validity of the endpoints, open a browser and enter the endpoint as listed
but with an added ?wsdl to the end of it. If the WSDL for each endpoint appears
correctly, then the endpoints are likely correct.
In the following example, the hostname is mozart.yourcompany.com and the port is
8080:
bmc.uddi.registryserver.url.security=http://mozart.yourcompany.com:8080/
uddi/services/security
bmc.uddi.registryserver.url.inquiry=http://mozart.yourcompany.com:8080/uddi
/services/inquiry
bmc.uddi.registryserver.url.publishing=http://mozart.yourcompany.com:8080/
uddi/services/publication
bmc.uddi.registryserver.url.subscription=http://mozart.yourcompany.com:8080
/uddi/services/subscription
3.
BMC Atrium Core 9.0
Page 1282 of 2268
Home
3. In a command-line interface, go to the <ATRIUMCORE_HOME>/wsc/wsregistryapi/

migration/scripts/ directory.
4. At the command prompt, enter the following command:
Windows: test_export.cmd
UNIX/Linux: ./test_export.cmd
5. When the script prompts for a username and password, enter the root publisher's username
and password.
If the script executes successfully, it creates a migration_list.xml file in the directory. This
file is a snapshot of all of the businesses, applications, and services that are published into
the registry at the point that the script was executed.
6. Rename the migration_list.xml file to include the date and time of the backup and store it in
a reliable location.
To restore the UDDI server

When restoring data to the UDDI server by importing from an exported data file, you must start with
a clean database. To ensure that the database is clean and empty, complete the following steps:
2. Navigate to the <ATRIUMCORE_HOME>/shared/wsc/data/bmcuddi/ directory.
3. If the derby-db/ directory exists, move it to another directory outside the <
ATRIUMCORE_HOME> location, or rename it, such as derby-db.bak.
Because the database directory is no longer present, it creates a new, empty database
instance on startup.
5. Do not stop the Tomcat server. If the server is not running, start the server.
It must remain running while performing this procedure.
6. In the <ATRIUMCORE_HOME>/wsc/wsregistryapi/registryserver.properties file, verify
the correct endpoints.
If the endpoints are incorrect, edit the file and correct them.
To test the validity of the endpoints, open a browser and enter the endpoint as listed
but with an added ?wsdl to the end of it. If the WSDL for each endpoint appears
correctly, then the endpoints are likely correct.
In the following example, the hostname is mozart.yourcompany.com and the port is
8080:
bmc.uddi.registryserver.url.security=http://mozart.yourcompany.com:8080/
uddi/services/security
bmc.uddi.registryserver.url.inquiry=http://mozart.yourcompany.com:8080/uddi
/services/inquiry
bmc.uddi.registryserver.url.publishing=http://mozart.yourcompany.com:8080/
uddi/services/publication
bmc.uddi.registryserver.url.subscription=http://mozart.yourcompany.com:8080
/uddi/services/subscription
7.
BMC Atrium Core 9.0
Page 1283 of 2268
Home
7. In a command-line interface, go to the <ATRIUMCORE_HOME>/wsc/wsregistryapi/

migration/scripts/ directory.
8. Copy the export data file created in the previous previous into the directory, and rename it to
migration_list.xml.
9. At the command prompt, enter the following command:
Windows: test_import.cmd
UNIX/Linux: ./test_import.cmd
10. When the script prompts for a username and password, enter the root publisher's username
and password.
11. If the script executes successfully, all of the entries in the data file are entered into the UDDI
registry.
Modifying BMC Atrium Web Services runtime configuration

With the Service Configuration Service, you can modify some configuration properties for web
service implementations without stopping services and the Tomcat server. The Service
Configuration Service is deployed with BMC Atrium Web Services Archive and offers the following
operations:
GetProperties For each specified property, this operation returns the matching data
type, password status, and value. To retrieve all available properties, do not specify any
property names. If a property is enabled as a password, GetProperties returns the value
in encrypted format.
SetProperties For a specific property, set its data type, value, and password status.
You can also use SetProperties to create custom properties.
If the property's data type is a string and the password setting is true, the property's value is
passed encrypted. Only string properties can be passwords, so the password enablement is
ignored for properties with other data types.
If you specify a property that does not exist, SetProperties creates and any settings that
you declare for that property.
DeleteProperties For each specified property, this operation performs one of the
following actions:
If the property is a required property, the property is not deleted but restored to a
default value.
If the property is a custom property created with SetProperties, that property is
deleted.
Although these operations must meet the same security requirements as the rest of the web
services, the UsernameToken does not contain a BMC Remedy AR System username but an
administrative username specific to the web service. The default for both the username and
password for this administrative service is admin.
BMC Atrium Core 9.0
Page 1284 of 2268
Home
For a list of runtime properties, see the following table.

Runtime web services properties
Property
Settings
Description
bmc.atrium.arserver.hostname
Type:
string
The hostname of the BMC Remedy AR System and BMC Atrium Core
server that Web Services accesses.
Default:
localhost
Password
: false
bmc.atrium.arserver.port
Type:
integer
Default: 0
Password
: false
The port number of the BMC Remedy AR System and BMC Atrium Core
server that Web Services accesses.
bmc.atrium.arserver.rpcqueue
Type:
The default RPC queue number used to access the BMC Atrium CMDB.
integer
Default: 0
Password
: false
Clients can specify a value for the RPC queue. But if not, the value
defined for this property is used.
bmc.atrium.arserver.defaultlocale
Type:
string
Default:
en
Password
: false
The default locale to be used by the Web services and the AR Server/
CMDB for its human readable status or fault messages. Clients can
specify a value for the default locale. But if not, the value defined for this
property is used.
bmc.atrium.arserver.defaulttimezone
Type:
string
Default:
NIL
Password
: false
The default timezone to be used in accessing the AR Server/CMDB.

Clients can specify a value for the default time zone. But if not, the value
bmc.atrium.arserver.defaulttimeout.normal
Type:
integer
Default: 0
Password
The normal timeout value to be used in accessing the AR Server/CMDB.

Clients can specify a value for the default timeout. But if not, the value
: false
bmc.atrium.arserver.defaulttimeout.long
Type:
The long timeout value to be used in accessing the AR Server/CMDB.
integer
Default: 0
Clients can specify a value for the default long timeout. But if not, the
value defined for this property is used.
Password
: false
bmc.atrium.arserver.defaulttimeout.xlong
Type:
integer
Default: 0
Password
: false
bmc.atrium.log.level
Type:
string
Default:
BMC Atrium Core 9.0
The extra long timeout value to be used in accessing the AR Server/

CMDB. Clients can specify a value for the default extra long timeout. But
if not, the value defined for this property is used.
Page 1285 of 2268
Home
Property
Settings
Description
WARN
Password
The level at which the Atrium Web services should log themselves. Log
messages are written out to standard out, meaning that those messages
: false
should be included in the console window of Tomcat or one of its

standard out logs. Possible values are INFO, ERROR, WARN, DEBUG,
and TRACE.
bmc.atrium.graphwalk.defaultexpiration
Type:
duration
Default:
PT1H
Password
: false
The default expiration duration for any new graph walk query began
through the Graph Walk Service. Clients can specify this value, but if it is
not specified, this value is taken as the default. It is in xs:duration format.
bmc.atrium.graphwalk.minimumexpiration
Type:
duration
The minimum expiration duration for any new graph walk query began
through the Graph Walk Service. If a client submits a value that is below
Default:
PT5M
this minimum value, this value will become the expiration value instead.
It is in xs:duration format.
Password
: false
bmc.atrium.graphwalk.maximumexpiration
Type:
The maximum expiration duration for any new graph walk query began
duration
Default:
through the Graph Walk Service. If a client submits a value that is above
this maximum value, this value will become the expiration value instead.
PT5M
Password
It is in xs:duration format.
: false
bmc.atrium.graphwalk.cleanupinterval
Type:
long
Default:
300000
Password
: false
The duration in milliseconds after which a new query or operation runs a

cleanup thread before continuing the operation. This cleanup thread
removes any graph walk contexts from the Graph Walk Service's
memory before allowing the operation to continue. It will then reset the
timer to wait for the completion of another interval.
bmc.atrium.graphwalk.maximumretrieval
Type:
integer
The maximum number of instances that can be returned in a single pull

operation against a given graph walk context in the GraphWalk Service.
Default:
250
If the number specified by the user exceeds this amount, this amount will
be what is returned at most.
Password
: false
bmc.atrium.serviceconfig.admin.username
Type:
string
Default:
admin
Password
: false
The administrator username that allows access to the Service

Configuration Service to retrieve or modify these runtime properties.
bmc.atrium.serviceconfig.admin.password
Type:
string
Default:
admin
Password
: true
The administrator password that allows access to the Service

Configuration Service to retrieve or modify these runtime properties.
The settings for these properties are stored in <ATRIUMCORE_HOME>/wsc/atriumws<

currentAtriumVersion>/conf/AtriumProperties.xml.
BMC Atrium Core 9.0
Page 1286 of 2268
Home
The AriumProperties.xml file is loaded one time: the first call that a client makes to any Web
Service that relies on those properties. When you use the Service Configuration Web Service,
property modifications are saved immediately to AriumProperties.xml, preserving the properties'
states on the next major restart or packaging and deployment of a new archive. Any required
pre-determined properties that are missing from this file on startup are populated with default
values.
You can modify the properties in AtriumProperties.xml instead of using the Service Configuration
Web Service, but you must stop the services while modifying the properties and restart the Tomcat
server. This risks disrupting other applications that the Tomcat server hosts.
Modifying archive properties in main.xml

To configure or view all security settings, you must use the atriumwsutil utility because all property
values are encrypted in the conf/crypto.xml file, which is local to the utility.
However, some foundational properties are not related specifically to security and are not obscured
through encryption. These properties are stored in the main.xml file which is a basic Java
properties file in XML format. The BMC Atrium Core installer populates the file with the correct
properties. Normally, you do not need to modify the main.xml file.
If you modify the main.xml file, you must package and deploy the service. For more information,
see Packaging and deploying the service archive .
Updating the WSDL and EPR links in the UDDI Registry to display the HTTPS port
To update the WSDL and EPR links in the UDDI Registry on Windows
To update the WSDL and EPR links in the UDDI Registry on UNIX or Linux
Properties in main.xml
Property
Description
bmc.atrium.util.dir
The absolute canonical path to the directory that contains the atriumwsutil utility, which
will be used by the Web services to determine where to access resources relative to
this directory, such as the runtime configuration properties file (contained in the c*onf/
AtriumProperties.xml* file) and the default keystores (contained in the keystores
directory).
bmc.atrium.services.aar
The intended file name for the Atrium Web services archive, so that the utility can
repackage the assembly using the correct name. For this version of Atrium, that file
name is atriumws80.aar.
bmc.atrium.services.hostname
The hostname of the computer system on which the utility and Web services are
executing. In this version of Atrium, this value will be used by the utility to create the
endpoint in the WSDL files to be accessed at runtime.
bmc.atrium.services.port.http
The port established in the Tomcat instance that will host the Atrium Web Application
and the Atrium Web Services archive for the HTTP connector. It will be used by the
utility in the formation of the endpoint in the WSDL files to be accessed at runtime
when HTTP is specified as the published connection.
BMC Atrium Core 9.0
Page 1287 of 2268
Home
Property
Description
bmc.atrium.services.port.https
The port established in the Tomcat instance that will host the Atrium Web Application
and the Atrium Web Services archive for the HTTPS connector. It will be used by the
utility in the formation of the endpoint in the WSDL files to be accessed at runtime
when HTTPS is specified as the published connection.
bmc.atrium.services.address
The first half of the local path that the utility will use in the formation of the endpoint in
the WSDL files to be accessed at runtime. The value for this version of Atrium is
atriumws81/services. The latter half of the endpoint is the name of the service, such
as atrium_classes for the classes service.
bmc.atrium.war.dir
The absolute canonical path to the Atrium Web Application currently running in Tomcat
. The value for this version would usually be <CATALINA_HOME>/webapps/
atriumws81, where <CATALINA_HOME> is the root of the Tomcat 6 installation that
is hosting the Atrium Web Application.
bmc.atrium.war.webinf
The local directory name for the WEB-INF directory of the Atrium Web Application. It is
almost always set to WEB-INF.
bmc.atrium.war.services.dir
The local directory name for the directory that contains the Web service archives to be
hosted by the Atrium Web Application. This is almost always set to services. The
combination of this and the previous two properties determines which directory the
utility will copy the latest Web Service archive for hot deploy.
bmc.atrium.war.services.list
The local file name for the directory that contains the file names of the Web service
archives to be hosted by the Atrium Web Application. This is almost always set to
services.list. When deploying, the utility updates this file to contain the Atrium Web
service archive if it does not already contain it.
bmc.atrium.ver.major
The major version. For this release of BMC Atrium Core, it is 7.
bmc.atrium.ver.minor
The minor version. For this release of BMC Atrium Core, it is 6.
bmc.atrium.ver.revision
The revision version. For this release of BMC Atrium Core, it is 00.
bmc.atrium.ver.patch
The patch level. For this release of BMC Atrium Core, it is 002.
bmc.atrium.ver.tag
The abbreviated version for this release of BMC Atrium Core, which is unique to a
release of Atrium for all but patch level.
Updating the WSDL and EPR links in the UDDI Registry to display the HTTPS port
Although you configured the web services port to HTTP by using the atriumws utility, the WSDL
and EPR links in the BMC Atrium Core UDDI Registry display the HTTPS port. To work around this
issue, you must manually replace the HTTPS port with the HTTP port in the BMC Atrium Core
UDDI Registry.
To update the WSDL and EPR links in the UDDI Registry on Windows
1. On the system where Web Services Registry is installed, open a command prompt window.
2. Type the following command:
cd %ATRIUMCORE_HOME%\wsc\wsregistryapi
3. Type the following command to set the CLASSPATH variable:
SET CLASSPATH=WSRegistryAPI81.jar;lib/axis2-1.5.1merge-client-set.jar;lib/activation-1.1.jar
4.
BMC Atrium Core 9.0
Page 1288 of 2268
Home
4. To delete the incorrect WSDL and EPR links from the UDDI Registry, enter a command
similar to the following:
java -cp %CLASSPATH%
com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil
deleteaccesspts localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> .\
webservices_list_template.xml
5. Open the webservices_list_template.xmlfile and apply the following changes:
a. Replace all instances of https with http.
b. For each service, replace the HTTPS port number with the HTTP port number in the
EPR and WSDL URL links.
6. To add the correct WSDL and EPR links in the UDDI Registry, enter a command similar to
the following:
java -cp %CLASSPATH%
com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil publish
localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> .\
To update the WSDL and EPR links in the UDDI Registry on UNIX or Linux
1. On the system where Web Services Registry is installed, open a shell window.
2. Type the following command:
cd $ATRIUMCORE_HOME/wsc/wsregistryapi
3. Type the following command to set the CLASSPATH variable:
export CLASSPATH=WSRegistryAPI81.jar:lib/axis2-1.5.1merge-client-set.jar;lib/activation-1.1.jar
4. To delete the incorrect WSDL and EPR links from the UDDI Registry , enter a command
similar to the following:
java -cp $CLASSPATH
com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil
deleteaccesspts localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> ./
5. Open the webservices_list_template.xmlfile and apply the following changes:
a. Replace all instances of "https" with "http".
b. For each service, replace the HTTPS port number with the HTTP port number in the
EPR and WSDL URL links.
6. To add the correct WSDL and EPR links in the UDDI Registry, enter a command similar to
the following:
java -cp $CLASSPATH
com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil publish
localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> ./
BMC Atrium Core 9.0
Page 1289 of 2268
Home
BMC Atrium Core Web Services security

Web service operations transmit data over the network and through the web. BMC Atrium Core
Web Services includes a set of default security settings that you can customize for secure data
transmission.
Transport-level encryption provides security for the complete communication (all the information
exchanged between the client and the server).
The Federal Information Processing Standards (FIPS) compliance implementation of J2SE security
for BMC Atrium Core Web Services requires the Java Cryptography Extension.
Complying with Web Services security policies
SSL TLS transport-level security
Security policies for BMC Atrium Web Services
Installing the cryptography extension and enabling FIPS compliance
Complying with Web Services security policies

BMC Atrium Core Web Services has several supported security policies that are consistent with the
Web Services Security 1.0 standard.
These policies facilitate authentication, integrity, and confidentiality of the information passed
through BMC Atrium Core Web Services. You can use these supported policies and configuration
settings to help you start using BMC Atrium Core Web Services immediately after installation.
BMC Atrium Configuration Management Database (BMC Atrium CMDB) requires client
authentication with wsse:Username. The wsse:Username authentication is the only default
security policy.
Supported security policies for SOAP requests
Authenticating to BMC Atrium Core with web services
Web services authentication and request message integrity
Authenticating web services
Understanding request message confidentiality
Supported security policies for SOAP responses
Separating the client implementation and security policy layer
Supported security policies for SOAP requests

BMC Atrium Core provides security policies for incoming Simple Object Access Protocol (SOAP)
requests.
The wsse:UsernameToken element manages authentication to BMC Atrium Configuration
Management Database (BMC Atrium CMDB). You cannot remove or disable this policy.
BMC Atrium Core 9.0
Page 1290 of 2268
Home
(optional ) XML Digital Signature manages authentication to the web service layer and
verification of integrity of the content of the SOAP request.
(optional ) XML Encryption manages confidentiality of the content of the SOAP request.
Authenticating to BMC Atrium Core with web services

The security policy that manages authentication to BMC Atrium Core requires a Simple Object
Access Protocol (SOAP) request that includes the wsse:UsernameToken and wsse:Password
elements.
The other elements described in Authenticating to BMC Atrium Core with web services are not
required but are supported.
Authentication elements (Continued)
Element
Requirements
wsse:
Username
A username of a BMC Atrium CMDB user. Empty strings are invalid.
wsse:
Password
A password corresponding to the username provided in the wsse:Username element. If you omit the
password, use a single space to represent the password value.
The Type attribute of the wsse:Password element must be:
http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText
If you omit the Type attribute, BMC Atrium Core defaults to the Type attribute of PasswordText. BMC does
not support the Type attribute of PasswordDigest.
If nonce enforcement is enabled, BMC Atrium Core takes the following actions:
wsse:
Nonce
The nonce value must be unique within five minutes of the last time that particular nonce value was used.
If a username is sent without a nonce value, the username token is not rejected. Nonce validation is an option
in the WS-Security standard.
If nonce enforcement is disabled, any nonce token sent with the username is ignored.
wsu:
Created
If created date and time enforcement is enabled, BMC Atrium Core takes the following actions:
It checks for a valid date in the xsd:dateTime format. The date and time value can be in the past or present,
but not in the future. If the date and time value is in the past, it must be less than five minutes in the past.
If a username is sent without a created value, the username token is not rejected. Created time and date
validation is an option in the WS-Security standard.
If created date and time enforcement is disabled, any created date and time token sent with the
username is ignored.
The following is an example of the wsse:UsernameToken element:
<wsse:UsernameToken>
<wsse:Username>Demo</wsse:Username>
<wsse:Password
BMC Atrium Core 9.0
Page 1291 of 2268
Home
Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile
-1.0#PasswordText">DemoPswd</wsse:Password>
<wsse:Nonce>LyEQw+0pSZr+a+CJVSuNgOvp9cY=</wsse:Nonce>
<wsu:Created>2009-01-25T11:45:30Z</wsu:Created>
</wsse:UsernameToken>
The following example assumes that the password Type is PasswordText:
<wsse:Password>DemoPswd</wsse:Password>
<wsse:Nonce>LyEQw+0pSZr+a+CJVSuNgOvp9cY=</wsse:Nonce>
<wsu:Created>2009-01-25T11:45:30Z</wsu:Created>
Web services authentication and request message integrity

The security policy that manages web services authentication and request message integrity
checks requires that you authenticate to the web services and validate that the content of the
message was not altered in transit or at any other point in its lifetime.
This security policy requires the client to generate a public key and corresponding private key
combination for use in one of the following supported asynchronous signing algorithms. The client's
private keystore keeps private keys safe and signs messages using the signing algorithm.
Supported algorithm
Location of detailed description
DSAwithSHA1 (DSS)
http://www.w3.org/2000/09/xmldsig#dsa-sha1 (http://www.w3.org/2000/09/xmldsig#dsa\-sha1)
RSAwithSHA1 (PKCS1
http://www.w3.org/2000/09/xmldsig#rsa-sha1 (http://www.w3.org/2000/09/xmldsig#rsa\-sha1)
Message validation
Trusted certificate authorities
Message validation
When validating the message, the incoming service validates the following items:
The signed content has been unchanged. It does this by validating the signature against the
public key contained in the X509v3 certificate sent with the Simple Object Access Protocol (
SOAP) request.
The certificate was signed by a trusted certificate authority. It does this to authenticate the
client and allow the request to process further.
A trusted certificate authority must sign the X509v3 certificate before use. BMC Atrium Core Web
Services authenticates the X509v3 certificate, contained in the wsse:BinarySecurityToken
element, by validating the signature of the certificate issued by a trusted certificate authority.
BMC Atrium Core 9.0
Page 1292 of 2268
Home
Trusted certificate authorities

BMC Atrium Core Web Services uses a truststore file, which contains the public keys of common
trusted certificate authorities, to validate X509v3 certificates. See the following table for details
about the default truststore.
Important
Replace the default truststore and trusted CA or trusted ID certificates with those that
meet your company's requirements. For more information about replacing the keystore,
see Security policies for BMC Atrium Web Services .
Truststore details
Truststore
Description
Filename
<BMCAtriumCoreInstallationDirectory>
/wsc/atriumws90/keystores/bmcatriumwscacerts.jks
Type
Java KeyStore (JKS)
Password
atrium
For initial use and testing of BMC Atrium Core Web Services, you can use the client keystore (
described in the following table), which contains a public and a private key, for proper signatures
and authentication so that you can begin consuming BMC Atrium Core Web Services. The
truststore contains a self-signed public certificate as a trusted certificate authority.
Client keystore details

Keystore
Description
Filename
/wsc/atriumws90/keystores/bmcatriumwsclient.jks
Type
Java KeyStore (JKS)
Password
atrium
Client key details within a

keystore
Name--bmcatriumwsclient
Private Password--atrium
Certificate file
BMC Atrium Core 9.0
Page 1293 of 2268
Home
Keystore
Description
BMC provides the client keystore file so that you can import it into your keystore. You can find this
file in the following location:
/wsc/atriumws90/keystores/bmcatriumwsclient.cer
Authenticating web services

Use the following procedure to authenticate to the web services and validate that message content
has not been altered.
To authenticate web services

1. Sign the soap:Body element using the chosen algorithm with the private key.
2. Include the resulting signature data in a ds:Signature element.
3. Place it in the wsse:Security element in the soap:Header.
4. Include the public key in the following locations:
an X509v3 certificate
a wsse:BinarySecurityToken element in Base64 encoding
the soap:Header element
Understanding request message confidentiality

The security policy that enables request message confidentiality requires that important message
content is obscured in transit and through the lifetime of the message. BMC Atrium Core Web
Services accomplishes message confidentiality by using XML Encryption. BMC Atrium Core Web
Services requires using a combination of symmetric and asymmetric encryption to ensure message
confidentiality.
This optional policy does not require encrypted incoming messages by default. When you enable
this policy, clients can send encrypted as well as unencrypted messages. However, you can require
that clients encrypt the soap:Body and wsse:UsernameToken elements.
The client must generate a synchronous 128-bit key and use that synchronous key to encrypt
important parts of the document using one of the following algorithms:
Synchronous 128-bit kit algorithms
Algorithm
Triple DES
http://www.w3.org/2001/04/xmlenc#kw-tripledes (http://www.w3.org/2001/04/xmlenc#kw\-tripledes)
AES-128
http://www.w3.org/2001/04/xmlenc#kw-aes128 (http://www.w3.org/2001/04/xmlenc#kw\-aes128)
The web service's asynchronous public certificate encrypts the corresponding 128-bit synchronous
key (depending on the algorithm that you used to generate the key) using one of the following
algorithms:
BMC Atrium Core 9.0
Page 1294 of 2268
Home
Asynchronous 128-bit kit algorithms

Algorithm
RSA-v1.5
http://www.w3.org/2001/04/xmlenc#rsa-1_5 (http://www.w3.org/2001/04/xmlenc#rsa\-1_5)
RSA-OAEP
http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p (http://www.w3.org/2001/04/xmlenc#rsa\-oaep\-mgf1p)
Include the wsse:EncryptedKey and wsse:BinarySecurityToken elements (representing

the result of encryption in the wsse:Security element) in your soap:Header element.
BMC Atrium Core Web Services includes a keystore and corresponding public and private
asynchronous encryption key combination. Clients can use that public key as the asynchronous
component in this process.
Important
Replace the default keystore and key with one that meets your company's requirements.
For information about replacing the keystore, see Security policies for BMC Atrium Web
Services.
Server keystore details

Keystore
Description
Filename
/wsc/atriumws90/keystores/bmcatriumwsserver.jks
Type
Java KeyStore (JKS)
Password
atrium
Server key details within the

keystore
Certificate file
Server Key Name bmcatriumwsserver

Server Private Key Password atrium
BMC provides the server keystore file so that you can import it into your keystore. You can find
this file at:
/wsc/atriumws90/keystores/bmcatriumwsserver.cer
BMC Atrium Core 9.0
Page 1295 of 2268
Home
Supported security policies for SOAP responses

By default, no outgoing WS-Security policies are enabled. Messages are sent out without
WS-Security-based message-level security applied. You can apply incoming and outgoing security
policies, such as cryptographic policies for XML digital signature and XML encryption.
To consume a Simple Object Access Protocol (SOAP) response from BMC Atrium Core Web
Services, clients can use several security policies.
The following policies comply with WS-Security 1.0 standards:
Authenticate that the response came from the correct web service server and verify the
integrity of the response content by using XML Digital Signature.
Validate that the message is coming from the correct web service server and verify the
response content for integrity by using XML Digital Signature.
Decrypt the content of the SOAP response by using XML Encryption.
Authenticating to the client and checking response message integrity

The server signs the soap:Body element of the SOAP response by using the corresponding
private key of the public key that it exposes for encryption.
The private key is called bmcatriumwsserver and it belongs to the bmcatriumwsserver.jks
keystore. XML Digital Signature creates the signature by using the RSAwithSHA1 (PKCS1)
algorithm.
The client validates that the signed content of the message (the soap:Body element) has not been
modified, and it authenticates the server by verifying that the related public certificate sent in the
wsse:BinarySecurityToken element within the wsse:Security element in the soap:
Header element matches the public certificate of the server.
For the server's keystore details, see Server keystore details.
Ensure response message confidentiality

The server encrypts the soap:Body element of the SOAP response by using a synchronous key
with the AES-128 algorithm. It then encrypts the synchronous key by using the public certificate that
the client sends to the server in the wsse:BinarySecurityToken element for its XML Digital
Signature in the corresponding SOAP request using the RSA-v1.5 algorithm.
Because the client originally signs the document with the corresponding private key, it is able to
decrypt the key by using that private key, and then decrypt the encrypted soap:Body element by
using the resulting synchronous certificate and algorithm.
BMC Atrium Core 9.0
Page 1296 of 2268
Home
If you use the example client certificate and bmcatriumwsclient private key from the
bmcatriumwsclient.jks keystore, that private key decrypts the response. Otherwise, the
corresponding private key of any other public certificate in the signature of the request decrypts the
response.
Because the server encrypts its responses with the public certificate that the client includes in its
request signature, you cannot apply this policy unless you have also applied on the server the
policy enforcing XML Digital Signature on requests.
For the client's keystore details, see Client keystore details.
Separating the client implementation and security policy layer

BMC recommends that you keep security policies and client implementation logic separate because
security policies can change frequently. Apply and configure policies to an existing client.
Most web service client tools provide the necessary abstraction in their implementations of web
service security features and policies. Depending on the tool that you are using, the rules for how to
separate the client implementation and the security policy layer might vary.
BMC Atrium Core allows you to disable, reconfigure, and reapply the available security policies to
BMC Atrium Core Web Services. For example, you can apply conservative measures to implement
and enforce all of the available security policies, or liberal measures to enforce only the basic wsse
:UsernameToken policy. This flexibility is available because you apply and enforce a policy layer
that brokers access to the service implementation.
SSL TLS transport-level security

Apache Tomcat 6 is configured to be ready for both HTTP and HTTPS connections for one-way
SSL authentication. BMC Atrium Core Web Services does not support two-way SSL authentication.
The HTTPS connector for BMC Atrium Core Web Services uses the TLS scheme (TLSv1) rather
than SSL/SSLv3.
If you install into an existing Tomcat 6 instance that already has SSL enabled, that SSL
configuration is used. If either a new Tomcat 6 instance is installed or your existing Tomcat 6
instance did not have SSL enabled, the installer adds the HTTPS connector and configures it to
use the following key and keystore:
Keystore details
Keystore
Description
Filename
/wsc/atriumws90/keystores/bmcatriumwsserverssl.jks
Type
Java KeyStore (JKS)
Password
atrium
BMC Atrium Core 9.0
Page 1297 of 2268
Home
Keystore
Description
Key alias
bmcatriumwsserverssl
Key password
atrium
Because this is only configured for one-way SSL, the server does not authenticate the certificates
of any connecting clients. However, the client must authenticate the public certificate that the server
uses in its SSL configuration. If the default key pair in Truststore details is used, the client adds the
following public certificate to its truststore for SSL: <BMCAtriumCoreInstallationDirectory>/wsc/
atriumws90/keystores/bmcatriuwscacertsssl.jks
BMC Atrium Core Web Services also includes a truststore that contains all the public certificates of
commonly accepted Certificate Authorities as well as the default public certificate used in
configuration. The following table describes this truststore.
Public certificate details

Keystore
Description
Filename
/wsc/atriumws90/keystores/bmcatriuwscacertsssl.jks
Type
Java KeyStore (JKS)
Password
atrium
Important
Replace the default truststore and key with one that meets your company's requirements.
You can configure the Atrium Web Service Archive to accept both HTTP and HTTPS connections,
exposing the web services on both endpoints, or you can restrict to one or the other. The default
instance restricts access to HTTPS because the default behavior has no cryptographic WS-Security
policies applied.
Security policies for BMC Atrium Web Services

You can modify the default security policies. BMC recommends switching out keystores and
references to private keys for keystores and keys that fit your security standards.
Also, consider modifying your security policies when your standard client tools and libraries cannot
support Web Services Security encryption (for example, gSOAP). In this case, you might want to
disable the policy that manages encryption enforcement and the policy that manages incoming and
outgoing web services cryptography.
BMC Atrium Core 9.0
Page 1298 of 2268
Home
Modifying security configuration for BMC Atrium Web Services

Modifying security properties for BMC Atrium Web Services
Packaging and deploying the service archive
Modifying security configuration for BMC Atrium Web Services

Certain configuration settings, all security policies, and settings for WS-Security and
transport-enablement cannot be modified during runtime because these properties are defined in
the BMC Atrium Web Service Archive.
To modify these properties, you must use the following procedure:
1. Modify the security property values with the atriumwsutil utility.
2. Repackage the service archive with the changes.
3. Deploy the repackaged service archive into the BMC Atrium Web Application running on
Tomcat.
Atriumwsutil command
To modify, package, and deploy configuration changes, you must use the atriumwsutil
command:
Windows (batch file): <BMCAtriumCoreInstallationDirectory>\wsc\atriumws90\
atriumwsutil.cmd
UNIX (shell script):<ATRIUMCORE_HOME>/wsc/atriumws90/atriumwsutil
Note
The Axis2 administration console not available by default. For more information, see
Apache Axis2 WAR Distribution modifications.
Execute the utility from the command-line as follows:

atriumwsutil -package -deploy [HTMLUATAtriumCoreWSH:-verbose]
atriumwsutil -restoredefaults
atriumwsutil -listconfig
atriumwsutil <filename>
atriumwsutil -<securityProperty> <value>
BMC Atrium Core 9.0
Page 1299 of 2268
Home
You can combine as many of these options on the command line as you need, except for the
listconfig, restoredefaults, and <filename> options, each of which must be used by
itself. The security settings and modifications are processed first. Then, if those changes pass
validation, the -package and -deploy options execute in that order.
For example, the following command changes the transport configuration of the utility's
configuration files to HTTPS_PRIMARY. Then it packages and deploys the new BMC Atrium Web
Service archive with the new transport setting.
atriumwsutil -transport HTTPS_PRIMARY -package -deploy
The following table describes the command options for the atriumwsutil utility.
atriumwsutil options
Option
Description
-package|-p
Creates a new BMC Atrium Web Services Archive with all changes in main.xml and with the atriumwsutil
utility.
-deploy|-d
Deploys the BMC Atrium Web Services Archive into the Atrium Web Application, replacing the previous
archive and its configuration.
-verbose|-v
Displays a detailed file-by-file listing in the output of the archive creation process.
restoredefaults
| -rd
Restores defaults and list the values so that you can verify that the defaults were restored. This option only
restores these values in the atriumwsutil utility's configuration. After restoring the defaults, you must
package and deploy the restored archive.
-listconfig|-l
Lists the current security configuration excluding passwords.
<filename_
Uses the specified text file to define options. If the only specified parameter is an existing filename that
does not begin with a hyphen (-) to signal an option, the atriumwsutil utility reads the file and parses the
options in the file. Using a file follows its own parameter format rather than the command-line format. The
following rules apply to the format of the file:
Parameters can be separated by white space or by new lines.
Parameter values with intervening spaces must be surrounded by quotation marks.
Quotation marks contained within parameters already surrounded by quotation marks can be
escaped with a back slash.
Blank lines are ignored.
Lines can be commented out by having the first non-white-space character as a '#'.
Any environment variables that are intended to be expanded in the option value must be surrounded
by the '%' character.
Other than those rules, parameter files operate exactly the same as when passing options through
the command-line. |
<securityProperty> <value1>
. . . <valueN>
BMC Atrium Core 9.0
Specifies the security parameter to modify and the values to specify for the modification.
For more information, see Security policies for BMC Atrium Web Services.
Page 1300 of 2268
Home
Modifying security properties for BMC Atrium Web Services

To view and modify the security properties, you must use the atriumwsutil utility, which saves the
values to an encrypted file (wsc/atriumws90/conf/crypto.xml ).
1. To view the current security configuration excluding passwords, use the atriumwsutil listconfig command.
2. To modify security properties, use the atriumwsutil -<securityProperty> <value>
command.
The following table describes the security properties that you can define. For more
information, see Atriumwsutil command.
Security properties
Option syntax
Description
-resttransport|-rt [
HTTP_ONLY|
HTTP_PRIMARY|
HTTPS_ONLY|
HTTPS_PRIMARY]
Configures the transports from which the RESTful Web services can be accessed.
HTTP_ONLY ensures that the service is only accessible from the http port
configured in Tomcat.
HTTPS_ONLY (default) ensures that the service is only accessible from the https
port configured in Tomcat.
HTTP_PRIMARY and HTTPS_PRIMARY make the services accessible from both
http and https ports. WSDL files themselves are accessible from both ports
regardless of the option chosen here.
-transport|-t [
HTTP_ONLY|
HTTP_PRIMARY|
HTTPS_ONLY|
HTTPS_PRIMARY]
Configures the transports from which the SOAP Web services can be accessed.
HTTP_ONLY ensures that the service is only accessible from the http port
configured in Tomcat.
HTTPS_ONLY (default) ensures that the service is only accessible from the https
port configured in Tomcat.
HTTP_PRIMARY and HTTPS_PRIMARY make the services accessible from both
http and https ports, but will cause the WSDL files of the services to report the
endpoint with the primary port. WSDL files themselves are accessible from both
ports regardless of the option chosen here.
-noncevalidation|-nv
[ON|OFF|REQUIRED|
NONCE_ONLY|
CREATED_ONLY]
Configures the Web services to validate wsse:Nonce and wssu:Created elements passed
in with the wsse:UsernameToken element in the wsse:Security header.
ON enables validation of both elements optionally, meaning only if they are present
in the header. This is the optimal option for compliance to the WS-Security 1.0
standard when using wsse:UsernameToken with PasswordText encoding.
OFF (default) disables all validation, ignoring the presence or absence of these
elements.
REQUIRED enables validation of both wsse:Nonce and wssu:Created elements.
NONCE_ONLY enables validation of only the wsse:Nonceelement.
CREATED_ONLY enables validation of only the wssu:Created element.
-noncethreshold|-nt [
300-86400]
Configures the threshold for wsse:Nonce validation in seconds. This determines how long
the Web Services holds the value in the element and prevent its reuse. The value can be
300 (five minutes) to 86400 (24 hours). The default value is 300.
-createdthreshold|-ct
[60-86400]
Configures the threshold for wsu:Created validation in seconds. This determines how long
that the Web Services allow submission of the element after its creation date. The value
can be 60 (one minute) to 86400 (24 hours). For best defense against replay attacks, set
this to either the same or lesser value as the noncethreshold. The default value is 300.
Configures the services' requirement for a valid wsu:Timestamp.
BMC Atrium Core 9.0
Page 1301 of 2268
Home
Option syntax
-timestampin|-ti [ON|
OFF]
Description
OFF (default) wsu:Timestamp is validated if received but is not required.
ON wsu:Timestamp is required and validated in the wsse:Security header of all
SOAP requests.
-timestampout|-to [ON
|OFF]
Configures the services to include a valid wsu:Timestamp.

OFF (default) wsu:Timestamp is not included.
ON A valid wsu:Timestamp is included in the wsse:Security header of all SOAP
responses with an expiry of five minutes past the creation date.
-checksignature|-cs [
ON|OFF]
Configures the services to require that the SOAP request's body is signed, that the
signature is valid, and that the client's public certificate is trusted.
OFF (default) Disables the requirement.
ON Enables the requirement.
-decryptrequest|-dr [
ON|OFF]
Configures the services to decrypt the SOAP request using the server's private key.
Clients must therefore use the server's public certificate as the key transport encryption
key in the encryption of the request.
OFF (default) Disables the server to decrypt requests.
ON Enables the server to decrypt requests. If an incoming message is not
encrypted, this option alone does not fail the request. To require encryption, use
the -enforceencryption option.
-signresponse|-sr [ON
|OFF]
Configures the services to sign the SOAP response's body and, if included, wsu:
Timestamp using the private key of the server, and include the server's public certificate is
included in the SOAP response as well. The algorithm used to sign the response (
RSA-SHA1 or DSA-SHA1) depends on the type of key set in the -signaturekey option. If
an RSA key is used, RSA-SHA1 is the algorithm. If a DSA key is used, DSA-SHA1 is the
algorithm.
OFF (default) Disables the requirement.
-encryptresponse|-er
[ON|OFF]
Configures the services to encrypt the SOAP response's body and, if included, wsu:
Timestamp using the public certificate that the client passes through the SOAP request as
the key transport encryption key. Because this outgoing encryption depends on the
signing certificate passed to the SOAP request, this option cannot be turned ON while the
-checksignature option is turned OFF.
OFF (default) Disables encryption.
ON Enables encryption.
-enforceencryption|-
Configures the services to reject any SOAP request that does not have the wsse:
ee [ON|OFF]
UsernameToken encrypted at the element level and SOAP:Body encrypted at the content
level. Because this option depends on incoming decryption being active, this option
cannot be turned ON while the -decryptrequest option is turned OFF.
OFF (default) Disables the encrypted wsse:UsernameToken and SOAP:Body
requirement.
-encryptionalgorithm|
-ea [TRIP_DES|AES_128
|AES_192|AES_256]
Specifies the symmetric cryptographic algorithm used to encrypt the SOAP requests.
TRIP_DES stands for Triple DES, AES_128 for AES 128, AES_192 for AES 192, and
AES_256 for AES 256.
Note: The AES_192 and AES_256 options only operate properly if unlimited encryption
has been enabled in the JRE and JDK of the Tomcat instance on which these services
are executing.
The default value is TRIP_DES.
BMC Atrium Core 9.0
Page 1302 of 2268
Home
Option syntax
Description
keytransportalgorithm
Specifies the asymmetric algorithm to be used for encrypting the symmetric key used to
encrypt SOAP responses. The available options are RSA_15 (RSA 1.5) and RSA_OAEP (
|-kta [RSA_15|
RSA_OAEP]
RSA with Optimal Asymmetric Encryption Padding). The default value is RSA_15.
-signaturekey|-sk <
keystoreFile> <
keystorePassword>[JKS
|JCEKS|PKCS12] <
keyAlias> <
keyPassword>
Specifies the asymmetric key used to sign outgoing messages. It requires the path and
file name of the keystore containing the key, the password used to access the keystore,
the type of keystore (JKS, JCEKS, and PKCS12), the alias of the key, and the password
for the private key. The specified signing key can be an RSA or DSA type. The key used
determines the algorithm of the outgoing signature. If an RSA key is used, RSA-SHA1 is
the algorithm. If a DSA key is used, DSA-SHA1 is the algorithm. The default keystore and
decryption key are the following values:
Keystore File Name: <BMCAtriumCoreInstallationDirectory>/wsc/
atriumws90/keystores/bmcatriumwsserver.jks
Keystore Type: Java Keystore (JKS)
Keystore Password: atrium
Key Alias: bmcatriumwsserver
Key Password: atrium
Because the client authenticates the signature in the Web Service response, clients
connecting with the default configuration must add the following public certificate to
its own truststore: <BMCAtriumCoreInstallationDirectory>/wsc/
atriumws90/keystores/bmcatriumwsserver.cer
Note: Replace the default keystore and key with one that meets your company's
requirements.
-decryptionkey|-dk <
keystoreFile> <
keystorePassword>[JKS
|JCEKS|PKCS12] <
keyAlias> <
keyPassword>
Specifies the asymmetric key used to decrypt incoming messages. It requires the path
and file name of the keystore containing the key, the password used to access the
keystore, the type of keystore (JKS, JCEKS, and PKCS12), the alias of the key, and the
password for the private key.
Note: The specified decryption key must be an RSA type.
The default keystore and decryption key are the following values:
atriumws90/keystores/bmcatriumwsserver.jks
Key Alias: bmcatriumwsserver
To encrypt its requests to the services using the default certificate, a client must
add the default public certificate to its own keystore that is found in the following file
: BMCAtriumCoreInstallationDirectory>/wsc/atriumws77/keystores
/bmcatriumwsserver.cer
Note: Replace the default decryption key with one that meets your company's
requirements.
-truststore|-ts <
truststoreFile> <
password>[JKS|JCEKS|
PKCS12]
Specifies the truststore containing all the trusted public CA certificates and all the directly
trusted public certificates used to validate signatures on incoming requests. It requires the
path and file name of the truststore, the password used to access the truststore, and the
type of keystore (JKS, JCEKS, and PKCS12). The truststore has the following defaults:
atriumws90/keystores/bmcatriumwscacerts.jks>
BMC Atrium Core 9.0
Page 1303 of 2268
Home
Option syntax
Description
This default truststore contains all the public certificates of Certificate Authorities in
the cacerts file of the Java 1.6 distribution. It also contains a public self-signed
certificate with the alias bmcatriumwsclient. This certificate allows clients to sign
their requests and decrypt their responses with the following private/public key pair:
atriumws90/keystores/bmcatriumwsclient.jks
Key Alias: bmcatriumwsclient
Note: Replace the default truststore and key with one that meets your company's
requirements.
Packaging and deploying the service archive

After making the wanted modifications, you must package and deploy the modified BMC Atrium
Web Services Archive for the BMC Atrium Web Application hosted on Tomcat 6.
To package and deploy the modified service archive

1. To apply the modified security properties, use the atriumwsutil -<option> command
to package and deploy the BMC Atrium Web Services Archive.
You can use the -package and -deploy options together, or you can run them separately.
Example: atriumwsutil -package -deploy
The previous archive is undeployed and replaced by the new archive. The output appears
either in the standard output log file for Tomcat 6 or its console window.
Note
You can ignore messages that a service was not found in the WSDL because they
refer to the abstract WSDL files that are imported by instance WSDL files that do
have the necessary service elements.
2. In the output, confirm that the previous archive is undeployed and that the new archive is
deployed.
After deploying a package, you should see a message such as the following:
BMC Atrium Core 9.0
Page 1304 of 2268
Home
Deploying service assembly

Inspecting services directory
C:/a pache-tomcat-6.0.20/webapps/atriumws80/WEB-INF/services
Inspecting services list
C:/ apache-tomcat-6.0.20/webapps/atriumws80/WEB-INF/services/services.list
Replacing service archive in services directory
C:/ apache-tomcat-6.0.20/webapps/atriumws80/WEB-INF/services/atriumws80.aar
Service assembly filename is already in the services list
Finished deploying service assembly
When the new deployment is available, you should see a message in the Tomcat log files,
such as the following:
[INFO] Deploying Web service: atriumws80.aar - file:/C:/apache-tomcat-6.0.20/

webapps/atriumws80/WEB-INF/services/atriumws80.aar
The new BMC Atrium Web Service Archive is now available for use.
Installing the cryptography extension and enabling FIPS compliance

The Federal Information Processing Standards (FIPS) compliance implementation of J2SE security
is available for BMC Atrium Core Web Services. Before enabling FIPS compliance, you must install
the Java Cryptography Extension to your BMC Atrium Core Web Services installation. The Java
Cryptography Extension enables 192-bit and 256-bit synchronous keys for use with AES-192 and
AES-256 algorithms for your Web Services Security implementation.
Unlimited Strength Cryptography and FIPS-Compliance are not enabled out of the box, nor does
BMC Atrium Web Services provide the necessary Java security libraries needed to enable them.
You install the required libraries and then modify the node configuration to enable these features.
You can install and enable Unlimited Strength Cryptography by itself; however, FIPS-Compliance
requires Unlimited Strength Cryptography to be applied first.
Obtaining and installing the Java Cryptography Extension
Enabling FIPS compliance
Obtaining and installing the Java Cryptography Extension

To install this extension, obtain the Java Cryptography Extension from the vendor that distributes
the Java Cryptography Extension for your installation of BMC Atrium Core Web Services. BMC
Atrium Core uses 1.5 JREs from the following distributors:
Oracle (for Windows, Solaris, Linux, HP-UX platforms)
IBM (for AIX platform)
BMC Atrium Core 9.0
Page 1305 of 2268
Home
The Unlimited Strength Java Crytopgraphy Extension extends the functionality of the WS-Security
implementation to support using 192-bit and 256-bit synchronous keys with AES-192 and AES-256
algorithms.
To apply this extension, you must download the extension for the JRE associated with your
installation of BMC Atrium Core Web Services. BMC Atrium Core runs on 1.5 JREs from two
distributors: Oracle (for Windows, Solaris, Linux, HPUX) and IBM (for AIX).
To install the Java crytopgraphy extension

1. Download the appropriate files from the following Web address: http://java.sun.com/javase/
downloads/index_jdk5.jsp.
JRE
Download URL
Link title
Java 1.5
JRE
http://java.sun.com/javase/downloads/
index_jdk5.jsp
Java Cryptography Extension (JCE) Unlimited Strength

Jurisdiction Policy Files 5.0
IBM 1.5
JRE
http://www.ibm.com/developerworks/java/jdk/
security/50/
IBM SDK Policy files
2. Stop the Tomcat server.

3. Install the downloaded files into the lib/security directory of the JRE and JVM on which
Tomcat 6 depends.
These files overwrite the existing files.
The extended cryptography is applied, and the new algorithms are available to apply
WS-Security policies.
Enabling FIPS compliance

After applying the Unlimited Strength Java Cryptography Extension, you can enable FIPS
compliance on your node.
To enable FIPS compliance

1. In a text editor, open the java.security file in the lib/security directory of the JRE and JDK.
2. Add the library's representative implementing class as the first entry in the list of security
providers, shifting all existing others by an increment of 1.
The order and type of security providers depends on existing providers. The following
example shows one possibility.
security.provider.1=sun.security.rsa.SunRsaSign
security.provider.2=*** FIPS-COMPLAINT PROVIDER CLASS ***
security.provider.3=sun.security.provider.Sun
security.provider.4=com.sun.net.ssl.internal.ssl.Provider
security.provider.5=com.sun.crypto.provider.SunJCE
security.provider.6=sun.security.jgss.SunProvider
security.provider.7=com.sun.security.sasl.Provider
BMC Atrium Core 9.0
Page 1306 of 2268
Home
security.provider.8=org.bouncycastle.jce.provider.BouncyCastleProvider
3. Fulfill other requirements that are specific to the implementation of the FIPS-compliant library
, such as a Java property set through CATALINA_OPTS or through a registry entry when
running Tomcat as a service.
Guidelines for using the BMC Atrium Core Web Services

Registry and interfaces
This section provides guidelines for creating interfaces and publishing to the BMC Atrium Core Web
Services Registry, which is an essential component of the BMC Service Oriented Architecture (SOA
).
Resolving ambiguous results for a service query
Version control in web services
Designing interfaces for BMC Web Services Registry
Resolving ambiguous results for a service query

This section explains how to differentiate among multiple endpoints that implement the same
interface of a given web service.
Example of disambiguating by geography
Example of disambiguating by interface version
Example of disambiguating by organization
Example of disambiguating by geography and interface version
Web services are published to the Web Services Registry in BMC Atrium Core. Client applications
can query the registry for the list of services and retrieve the services' endpoints. In some cases, a
query of the same service can return more than one service endpoint, such as installations of the
same service at multiple sites.
To address this problem, the WSRegistryAPI supports criteria for disambiguating services:
With the publishService() method, publish a service with criteria that disambiguates
services endpoints.
With the findServices() method, query for services endpoints using disambiguation
criteria.
These criteria can include but are not restricted to the following types of information, which you can
use in any combination. Typically, one criterion is sufficient.
Geography This criterion specifies the physical location of the service's implementation,
such as Singapore.
BMC Atrium Core 9.0
Page 1307 of 2268
Home
Organization This criterion is the owner of the implementation, such as the R&D
Department.
QoS This criterion provides information about the respective Quality of Service of the
service implementations, such as "best performing".
Description This criterion is any descriptive information the user feels can help to
disambiguate services, such as "implementation has bugs but generally works."
Note
The WSRegistryAPI uses the uddi-org:general_keywords tModel in the UDDI
Registry for storing the disambiguating criteria. You must assign each defined criterion a
unique key name in the tModel. For example, the predefined key name for the Geography
criterion in the WSRegistryAPI is bmc.com:categorization:geography.
The WSRegistryAPI comes with a test driver TestUDDIRegistry in the

com.bmc.webservices.uddiapi.test package. You can use this test driver to publish and
find service endpoints with disambiguating criteria.
To publish a service with disambiguation criteria, use the following syntax:
publish _BusinessName_ _ApplicationName_ _ServiceName_ _ServiceVersion

ServiceInterfaceVersion_
" _ServiceDescription_
"
_AccessPointUrl_ _WSDLUrl_ _CriteriaList_
The CriteriaList parameter is a list of comma-separated name-value pairs that is enclosed in parens
( ).
For example, you can specify the geography and organization criteria when you publish a service to
the registry.
publish BMC_INC CMDB_APP CMDB_Service 1.1 1.0 "My CMDB Service" http://myhost:8080/
cmdbws/server/cmdbws http://myhost:8080/cmdbws/server/cmdbws?wsdl= (bmc.com:
categorization:geography,Sunnyvale) (bmc.com:categorization:organization,ITSM)
To find a service with disambiguation criteria, use the follow syntax:
findsvc
_BusinessName_ _ApplicationName_ _ServiceName_ _ServiceVersion
ServiceInterfaceVersion ApproximateMatch_ _CriteriaList_
BMC Atrium Core 9.0
Page 1308 of 2268
Home
The following example specifies the geography and organization criteria. For geography, the query
includes only the letter S while a wildcard is used for the organization. If the service had more than
one location that started with an S, then a more unique value is needed, such as Su.
findsvc BMC CMDB_APP CMDB_Service .* 1.* Y (bmc.com:categorization:geography,S.) (

bmc.com:categorization:organization,.*)
Example of disambiguating by geography

In the following query, the geography criterion specifies Pune and the organization criterion uses a
wildcard to find all organizations.
$JAVA_HOME%\bin\java - Dbmc.wsregistry.uddiapi.home="%CLIENT_HOME%" Dbmc.wsregistry.username="admin" -Dbmc.wsregistry.password="admin" -cp -.;%CLASSPATH%"

com.bmc.webservices.uddiapi.test.TestUDDIRegistry findsvc BMC ATRIUM_CORE
atrium_business.* .* .* Y (bmc.com:categorization:geography,Pune) (bmc.com:
categorization:organization,.*)
The results include only one service that is located in Pune for one organization.
findServices() return [com.bmc.webservices.uddiapi.impl.ServiceImpl@4ccfdd]

serviceArrayList[0]:
businessName = BMC
applicationName = ATRIUM_CORE
serviceName = atrium_businessobjects
serviceVersion = 8.1.00
serviceInterfaceVersion = 2.0
key = uddi:bmc.com:06f8d54e-a8dd-4254-94bc-7c9e1ad733dc
accessPointURL = http://punesrv:9090/ atriumbusinessobjects_porttype
wsdlAccessPointURL = http://punesrv:9090/atriumbusinessobjects_porttype?wdsl
criteriaList =
0:uddi:uddi.org:categorization:general_keywords bmc.com:categorization:geography
Pune
1:uddi:uddi.org:categorization:general_keywords bmc.com:categorization:organization
BEM
Example of disambiguating by interface version

The following query searches for all services with an interface version of 1.0 for all organization
across all locations.

atrium_business.* .* 1.0 Y (bmc.com:categorization:geography,.*) (bmc.com:categorization
:organization,.*)
BMC Atrium Core 9.0
Page 1309 of 2268
Home
The results include two services with a 1.0 interface version for two locations, Houston and
Sunnyvale.
findServices() return [com.bmc.webservices.uddiapi.impl.ServiceImpl@4ccfdd

com.bmc.webservices.uddiapi.impl.ServiceImpl@30d82d]
businessName = BMC
key = uddi:bmc.com:ab9b857c-ed08-497a-a4dc-83cf6f61ca42
accessPointURL = http://houstonsrv1:9090/ atriumbusinessobjects_porttype
wsdlAccessPointURL = http://houstonsrv1:9090/atriumbusinessobjects_porttype?wdsl
criteriaList =
Houston
REMEDY
businessName = BMC
key = uddi:bmc.com:c616c900-43f4-406c-a530-3b60f90ed0ef
criteriaList =
Sunnyvale
REMEDY
Example of disambiguating by organization

The following query searches for all services for the Remedy organization across all locations, as
specified by a wildcard.

atrium_business.* .* .* Y (bmc.com:categorization:geography,.*) (bmc.com:categorization:
organization,REMEDY)
The results include two services for Remedy for two locations, Houston and Sunnyvale.

BMC Atrium Core 9.0
Page 1310 of 2268
Home
businessName = BMC
criteriaList =
Houston
REMEDY
businessName = BMC
key = uddi:bmc.com:c616c900-43f4-406c-a530-3b60f90ed0ef
criteriaList =
Sunnyvale
REMEDY
Example of disambiguating by geography and interface version

The following query searches for all services with an interface version of 1.0 for all organizations
across all locations.

atrium_business.* .* 1.0 Y (bmc.com:categorization:geography,Houston) (bmc.com:
categorization:organization,.*)
The results include one service with a 1.0 interface version. Because Houston was specified for
geography, the Sunnyvale 1.0 installation is not returned.

businessName = BMC
BMC Atrium Core 9.0
Page 1311 of 2268
Home
accessPointURL = http://houstonsrv1:9090/
atriumbusinessobjects_porttype
criteriaList =
Houston
REMEDY
Version control in web services

This section describes supported versioning and backward compatibility for web services.
Interface versioning
Implementation (product release) versioning
Backward compatibility of services
Interface versioning for web services

To specify interface versions, you can use the following methods:
Date and timestamp for the web services description language (WSDL)
Version and revision information stored in the Universal Description, Discovery and
Integration (UDDI)
Note
Because interface and WDSL changes require changes to clients that depend on the
WDSL, create new versions infrequently, and consider the client impacts.
Usually including a date or timestamp ensures that interface versions are unique, which follows the
guidelines given by W3C:
http://www.w3.org/TR/REC\-xml\-names/
For example, for the first version of a web service interface, the following schema tag in the WDSL
indicates the version with the 2009/02/15 date:
<schema targetNamespace="http://bmc.com/2009/02/15/myService.xsd" xmlns="http://www.w3.org/2000/10/XMLSchema
When WSDL changed, the new version of the service is specified with the 2010/10/23/ date:
BMC Atrium Core 9.0
Page 1312 of 2268
Home
<schema targetNamespace="http://example.com/2010/10/23/myService.xsd" xmlns="http://www.w3.org/2000/10/XMLSc
BMC also stores interface version information in the UDDI, following the <version>. <majorRevision
>. <minorRevision> model used for other types of software. To access this additional version
information in the UDDI, use the publish and find APIs which support versioning:
Publication of the service interface version
Querying the service interface version
Version IDs or numbers comply with the following principles:
A minor version should be backward compatible with other minor versions associated with a
major version. For example, interface version 1.1 should be fully backwards compatible with
interface version 1.0. Minor versions should never break backward compatibility. A minor
release can include new operations and bug fixes that do not change the signatures of
existing operations.
A minor update can use the same targetNamespace. For example, a 2.5.1 update can use
the same targetNamespace as 2.5.0.
A major version might break backwards compatibility with clients created for other major
versions. For example, interface version 2.0 might not be backward compatible with version
1.0.
Also, the targetNamespace should always map to a major version, and a new major version
must have a new targetNamespace.
Examples of changes for a major version include deleting methods or functions, changing names,
and changes to parameters.
Tip
You can modify a service implementation without modifying the interface so that one
interface can have multiple service implementations. For example, changing a web
service's underlying API requires changes to the web service implementation, but the
WSDL interface remains the same.
BMC Atrium Core does not automatically enforce or check these principles for web services, but
you should follow these principles to ensure that clients can work with minor versions without
having to be updated.
For more information about creating clients that can work with different versions of the interface,
see Backward compatibility of services.
BMC Atrium Core 9.0
Page 1313 of 2268
Home
Implementation (product release) versioning

You can create versions for the logic that implements a service, even though you have not changed
the service's interface or web services description language (WSDL).
In most cases, client applications dependent on the service should not have to be re-written when a
new version of a service's implementation is introduced.
You can specify the implementation version with the serviceVersion parameter in the Web
Registry API.
The WSRegistryAPI comes with a test driver TestUDDIRegistry in the
com.bmc.webservices.uddiapi.test package. You can use this test driver to publish and
find service endpoints with implementation versions. For example, to publish a service with an
implementation version, you could use the following command syntax:
publish <BusinessName> <ApplicationName> <ServiceName> <ServiceVersion

ServiceInterfaceVersion>
" <ServiceDescription>
"
<AccessPointUrl> <WSDLUrl> <CriteriaList>
In the following example, the CMDB_Service is assigned an implementation version of 1.1, but the
interface version remains 1.0.
publish BMC_INC CMDB_APP CMDB_Service 1.1 1.0 "My CMDB Service" http://myhost:8080/
cmdbws/server/cmdbws http://myhost:8080/cmdbws/server/cmdbws?wsdl= (bmc.com:
categorization:geography,Sunnyvale) (bmc.com:categorization:organization,ITSM)
To find a service with a specific implementation version, use the follow syntax:
findsvc _BusinessName_ _ApplicationName_ <ServiceName> <ServiceVersion

ServiceInterfaceVersion ApproximateMatch> <CriteriaList>
The following example is a search for CMDB_Service using a wildcard for the implementation
version and would return all CMDB_Service instances with an implementation version range of 1.0
through 1.9 and with an interface version of 1.0.
findsvc BMC CMDB_APP CMDB_Service 1.* 1.0 Y (bmc.com:categorization:geography,S.) (

bmc.com:categorization:organization,.*)
Backward compatibility of services

Client applications should be able to interact with more than the current version of an interface. To
ensure backward compatibility, observe the following guidelines:
BMC Atrium Core 9.0
Page 1314 of 2268
Home
Determine the version of a web services description language (WSDL) interface when found
in the registry.
Provide business logic in the client application to accommodate different WSDLs.
Incorporate if-then or case logic in the client for the different interface versions.
For example, for one version of a web service interface, the following schema tag in the WDSL
indicates the version by the date 2009/02/15:
<schema targetNamespace="http://bmc.com/2009/02/15/myService.xsd" xmlns="http://www.w3.

org/2000/10/XMLSchema">
The following example shows a subsequent version of the service in which the WSDL changed:
<schema targetNamespace="http://example.com/2010/10/23/myService.xsd" xmlns="http://

www.w3.org/2000/10/XMLSchema">
To interact with both versions, a client application must determine the version from the dates
embedded in the schema tag and take appropriate action.
If the first WSDL targetNamespace corresponds to interface versions 1.* of the service and the
second one corresponds to interface versions 2.*, the client can compare the interface versions of
services returned by the WSRegistryAPI findServices() or findService() calls and act
accordingly.
Designing interfaces for BMC Web Services Registry

This section describes standards, recommendations, and guidelines for creating WSDL interfaces
to services stored in the BMC Web Services Registry so that applications can interoperate more
effectively and efficiently. Interoperability is the ability of two or more applications to exchange
information and to use the information that they exchanged. To do this, interfaces must meet the
following requirements:
Standards compliance
Semantic and syntactic consistency
Extensible in a structured, predictable manner
Complying with core standards
Complying with recommended practices
Interface consistency in the BMC Web Services Registry
Choosing durable or well-defined interfaces
Using consistent syntax for web services
Choosing a WSDL binding style
BMC Atrium Core 9.0
Page 1315 of 2268
Home
Example of the document-literal wrapped binding style
Complying with core standards

For BMC Web Services, you must comply with the following standards.
XML 1.0
SOAP 1.1
WSDL 1.1
WS-I Basic Profile (BP) 1.1
UDDI V3.0.2
The WS-I Basic Profile (BP) 1.1 interprets WSDL 1.1 so that it enhances interoperability. BMC uses
both WSDL 1.1 and WS-I Basic Profile (BP) 1.1 for developing WSDL interfaces.
Several versions of WSDL are available, but BMC uses WSDL 1.1 for the following reasons:
It is the most widely implemented and deployed version.
TIBCO, which BMC uses in its web services architecture, supports this version.
WSDL 2.0 has not gained widespread adoption.
Complying with recommended practices

Where appropriate, all Web Services definitions should comply with the following WS-Management
(WS-MAN) standards.
WS-Addressing
WS-Security
WS-Transfer
WS-Enumeration
WS-Eventing
WS-ReliableMessaging
Where possible, follow these standards in substance and style to develop web services. The BMC
SOA implements these standards.
Also, although not part of WS-MAN, WS-ReliableMessaging provides means for sending and
receiving SOAP messages reliably.
Interface consistency in the BMC Web Services Registry

Because the BMC service-oriented architecture (SOA) relies on the web services (UDDI) registry,
all interface definitions should be expressed correctly and consistently in web services description
language (WSDL) so that client applications can retrieve the interfaces.
The following figure shows how an example WSDL named StockQuoteService maps to the UDDI
registry.
BMC Atrium Core 9.0
Page 1316 of 2268
Home
The service name value in the WSDL service implementation maps to the name element
in the UDDI businessService.
The WSDL port name maps to the bindingTemplate element in the UDDI registry.
Mapping UDDI definitions to WDSL
Choosing durable or well-defined interfaces

You can define how interfaces can handle changes and must be modified. You can use the
following methods:
BMC Atrium Core 9.0
Page 1317 of 2268
Home
Durable interfaces One parameter that is an XML stream and out-of-band XML
documentation of the syntax and semantics.
In this approach, XML documents define the interface semantics and are transferred through
these interfaces. To process these XML payloads, out-of-band agreements must be in place
to understand their content. The parameter is typically an XML stream, such as xs:Any.
Well-defined interfaces A set of well-defined parameters (similar to most programming
language APIs)
WSDL interfaces look like traditional programming APIs where every parameter is explicitly
and atomically define. Applications exchange all information with these parameters.
Hybrid interfaces A small set of well-defined parameters and one extensibility parameter
which is an XML stream.
BMC does not require one particular approach, but you should be aware of the advantages and
disadvantages of each. The following table summarizes the advantages and disadvantages of
durable and well-defined interfaces.
Summary of durable and well-defined interfaces
Interface
Type
Characteristics
Advantages
Disadvantages
Durable
A simple operation, such
as Get or Put.
One XML stream
parameter typically.
Out-of-band
documentation of XML.
Well-defined
Parameter for each element

which a service's operations
manipulate.
Interface definition never or

rarely changes.
Applications using a durable
interface are less likely to
change or break.
Tool support.
Familiar to traditional
Interpretation of XML stream in the

parameter.
Out-of-band agreements are not
rigorous.
Changes require modifying the interface

which causes changes in dependent
applications.
programmers.
BMC recommends that you balance durable and well-defined interfaces by providing a small set of
well-defined interfaces and one extensible parameter. This extensible parameter could be an xs:
any type that passes an XML stream with almost any set of data. In terms of XML, xs:any cannot
be validated given the current XML schema. Therefore, it can accommodate types of parameters
that might not have been anticipated when the API was initially designed.
For example, you could use an extensible xs:Any parameter to federate data from several data
sources. All the data sources use a common data model. For those attributes, you can use a fixed
number of well-defined parameters. But each source also presents data that is unique to that model
. To exchange this data among sources, you can use the extensible xs:Any parameter to pass an
XML string with this unique information.
BMC Atrium Core 9.0
Page 1318 of 2268
Home
Using consistent syntax for web services

BMC has developed a list of verbs and nouns to create consistency across interfaces. You can use
these verbs and nouns in your operations or as guidelines for defining verbs and nouns.
Verbs
As a guideline, create operations with generic verbs, and avoid embedding semantics details in the
operation:
The objects that the operation manipulates
Constraints that might affect the operation
Using generic verbs allows you to extend verbs more easily for new objects and constraints.
For example, an operation named GetCriticalPriority uses a complex verb that includes the
object (critical statuses). A simpler, more generic Get operation could use Priority and
Critical as parameters. If the web service could provide status information for low priority, the
Get operation could be extended with a Low value for the Priority parameter. With the
GetCriticalPriority operation, a new GetLowPriority operation is required.
BMC derived the following verbs from the WS-* Standards listed in Complying with core standards
and from operations defined by BMC products.
Get To retrieve data.
Put To send data.
Delete To erase data.
Create To instantiate data.
Subscribe To express interest in a message.
Unsubscribe To end a subscription.
End To mark the end of a some interaction such a subscription or enumeration.
Enumerate To begin an enumeration (batch) of data.
Pull To get an enumeration (batch) of data.
Renew To renew (such as an enumeration).
Release To release resources such as enumerations.
Submit To send an object (such as a job) for processing.
Nouns
Like operational verbs, you should use nouns that you can extend.
For example, a Get operation uses a {LowPriority}} parameter that includes a specific priority value.
To retrieve other priority values requires a new parameter for each:
Get [LowPriority|MediumPriority|CriticalPriority]
BMC Atrium Core 9.0
Page 1319 of 2268
Home
A simpler syntax of Get Priority allows Priority to be extended for different values as
needed.
BMC derived the following nouns from operations defined by BMC products. You can use these
nouns in your operations or as guidelines for defining nouns.
Activity A set of actions designed to achieve a particular result.
Alert A warning that a threshold has been reached, something has changed, or a failure
has occurred.
Asset Any resource or capability. Assets of a service provider include anything that could
contribute to the delivery of a service.
Attribute A single property of an instance or class or information about a CI.
Certificate An object that associates some level of validity or credibility to the holder.
Change The addition, modification, or removal of anything that could have an effect on IT
services.
ChangeRequest A formal proposal for a change.
Class A group of things that have a common representation and behavior.
Configuration Item Any component that needs to be managed to deliver an IT service.
Contract A legally binding agreement between two or more parties.
ContractLineItem A representation of some specific terms, conditions or obligations of a
Contract.
Cost The amount of money spent on a particular activity, IT service or business unit.
Credentials The username and password combination, or other identifier, that is
necessary to access a system or device.
Customer A person or organization that buys goods or services.
DemandRequest A request from a customer of IT to request a new service that IT does
not currently offer.
Diagnosis A stage in the Incident and Problem lifecycles. The purpose of diagnosis is to
identify a workaround for an incident or the root cause of a problem.
Error A design flaw or malfunction that causes a failure of one or more CI or IT services,
or a mistake made by a person or a faulty process that impacts a CI or IT service.
Escalation An activity that obtains additional resources when they are needed to meet
service level targets or customer expectations.
Event A change of state which has significance for the management of a CI or IT service.
Graph The structure of a set of relationships and the objects to which they relate
Impact The effect of an event on the status of an IT service or a CI.
Incident An unplanned interruption to an IT service or a reduction in the 1uality of an IT
service. Also, commonly used to describe the record of an interaction between the service
desk and a user.
Instance A specific object derived from a class definition.
Job An activity performed on a managed device, either manually or through automation.
KeyPerformanceIndicator (KPI)--A metric that is used to help manage a process, IT service
or activity.
BMC Atrium Core 9.0
Page 1320 of 2268
Home
License A legal instrument governing the usage, distribution, or copying of a piece of

software.
Metric Something that is measured and reported to help manage a process, IT service or
activity. Also, a measured value of a property of a CI.
Plan A detailed proposal that describes the activities and resources required to achieve
an objective.
Policy Formally documented management expectations and intentions.
Priority A category used to identify the relative importance of an incident, problem, or
change.
Problem A cause of one or more incidents
Process A structured set of activities designed to accomplish a specific objective.
Project A temporary organization required to achieve an objective or other outcome.
Property A characteristic of an object for which information is held or metrics are
measured or collected.
PurchaseOrder A document describing a customer's intent to purchase goods or services.
Relationship A connection between two people or things. Also, an association between
two instances, classes or relationships.
Release A collection of hardware, software, documentation, processes or other
components required to implement one or more approved changes to IT services.
Request The act of asking for some action (often a service or activity) to take place. Also,
the documentation of such a request.
Resource A generic term that includes IT infrastructure, people, money or anything else
that might help to deliver an IT service.
Risk A possible event that could cause harm or loss, or affect the ability to achieve
objectives. A risk is measured by the probability of a threat, the vulnerability of the asset to
that threat, and the impact it would have if it occurred.
Role A set of responsibilities, activities and authorities granted to a person or team.
Schedule A set of time periods usually grouped together for some planning purpose.
Service A means of delivering value to customers by facilitating outcomes customers
want to achieve without the ownership of specific costs and risks.
Service Offering The combination of a service with specific service level targets to provide
a specific utility and warranty to a customer.
ServiceCatalog A database or structured document with information about all live IT
services, including those available for deployment.
ServiceLevel A measured and reported achievement against one or more service level
targets.
ServiceLevelAgreement (SLA) An agreement between an IT service provider and a
customer that describes the IT service, documents service level targets and describes the
responsibilities of the IT service provider and the customer.
ServiceLevelTarget A commitment, that is documented in a SLA, that defines a specific
service level the IT service provider is obligated to meet
ServicePortfolio The complete set of services that are managed by a service provider.
BMC Atrium Core 9.0
Page 1321 of 2268
Home
ServiceRequest A request from a user for information, or advice or for a Standard

Change or for Access to an IT service. Also, A user request for a service that is being
offered
Solution The resolution of a problem.
Strategy A long-term plan designed to achieve some objective.
Task--An activity that is performed to achieve a specific result, usually by a person.
Threshold The value of a metric which should cause an Alert to be generated, or
management action to be taken.
TimePeriod A defined segment of time.
Transaction A discrete function performed by an IT service
User An actor (human or software) that utilizes IT services. Someone who uses goods or
services.
Vendor A third party responsible for supplying goods or services that are required to
deliver IT services. Synonymous with supplier.
Version An edition, revision or update of a given object (class, instance, attribute, etc.).
Workflow A set of activities organized into a process that is meant to achieve some end
goal.
Choosing a WSDL binding style

When you create a web services description language (WSDL) to describe a web service, you must
bind the WSDL to the Simple Object Access Protocol (SOAP) message, and the binding style can
be either RPC or document, as well as encoded or literal.
Of the different binding styles, BMC requires the document-literal wrapped style. While this style is
more complex than others, it is the most interoperable for the following reasons:
It complies with WS-I Basic Profile (BP) 1.1 (one child per soap:body).
It is widely accepted.
The BMC SOA uses it.
The following table summarizes the advantages and disadvantages of the other binding styles. A
style must comply with WS-I Basic Profile (BP) 1.1 and have only one child per soap:body
element. It should be easily validated so that you can maintain consistency and avoid problems.
Summary of advantages and disadvantages of binding styles

Binding
style
Advantages
RPC encode
Simple
Disadvantages
Not easily validated

Not compliant with WS-I Basic Profile (BP) 1.1
RPC literal
Simple
Compliant with WS-I Basic Profile (BP) 1.1
BMC Atrium Core 9.0
Not easily validated
Page 1322 of 2268
Home
Document
literal
Document
literal
Compliant with WS-I Basic Profile (BP) 1.1 (

where soap:body has only one child)
Not compliant with WS-I Basic Profile (BP) 1.1 (

where soap:body has more than one child)
Can be validated
Loss of operation name
Complex
Compliant with WS-I Basic Profile (BP) 1.1
Can be validated
wrapped
Widely accepted
Example of the document-literal wrapped binding style

The following web services description language (WSDL) and Simple Object Access Protocol (
SOAP) message examples show how the message content is defined separately from the web
service interface.
The WSDL example uses the document-literal wrapped binding style. It defines the type of data
that the SOAP message uses (int and float ). When creating a client, you can use the WSDL to
find all the information about the service's myMethod operation without having to look also at the
SOAP message.
public void myMethod(int x, float y);

<types>
<schema>
<element name="myMethod">
<complexType>
<sequence>
<element name="x" type="xsd:int"/>
<element name="y" type="xsd:float"/>
</sequence>
</complexType>
</element>
<element name="myMethodResponse">
<complexType/>
</element>
</schema>
</types>
<message name="myMethodRequest">
<part name="parameters" element="myMethod"/>
</message>
<message name="empty">
<part name="parameters" element="myMethodResponse"/>
</message>
<portType name="PT">
<operation name="myMethod">
<input message="myMethodRequest"/>
<output message="empty"/>
</operation> </portType>
<binding .../>
BMC Atrium Core 9.0
Page 1323 of 2268
Home
The following example of a SOAP message could work with the example WSDL. Rather than
embedding the data type in the message, the message uses one method in the soap:body
element and provides values for the x and y elements.
<soap:envelope>
<soap:body>
<myMethod>
<x>5</x>
<y>5.0</y>
</myMethod>
</soap:body>
</soap:envelope>
Accessing BMC Atrium Core Web Services

After installing BMC Atrium Core Web Services, run the test_treedump utility to obtain a list of the
web services that are published to the Web Services Registry. The test_treedump utility is available
at: $ATRIUMCORE_HOME\wsc\wsregistryapi\scripts (Microsoft Windows) and $
ATRIUMCORE_HOME/wsc/wsregistryapi/scripts (UNIX).
To run the test_treedump utility

1. From the scripts folder, open env.cmd (Windows) or env (UNIX) in a text editor.
2. Set the JAVA_HOME environment variable to reflect the path of the Java home directory.
4. Run the test_treedump utility.
(Windows) test_treedump.cmd
(UNIX) test_treedump
5. When prompted, provide the Web Services Registry username and password.
Note
The output after running this utility is saved to the treedump_list.xml file in the scripts
folder. The treedump_list.xml file contains a list of the web services that are published to
the Web Services Registry.
Use the following URL to access the BMC Atrium Web Services Registry Administrator Console
after you have installed the web services components in BMC Atrium Core 9.0:
http://hostname:httpport/uddi
Important
BMC Atrium Core 9.0
Page 1324 of 2268
Home
You cannot configure the Web Services Registry from the BMC Atrium Web Services
Registry Administrator Console.
CMDBWS support
CMDBWS is the deprecated Web Services that was released in BMC Atrium Configuration
Management Database (BMC Atrium CMDB) 2.1. It does not support the new WS-Security of BMC
Atrium Core, and it is provided only to support existing integrations until it is removed in a future
release. The following topics are provided:
CMDBWS and WS-Security
Enabling SSL for transport-level encryption for CMDBWS
CMDBWS and WS-Security

Because CMDBWS does not support any WS-Security features, none of the default WS-Security
policies are applied to CMDBWS. Also, you cannot apply the supported WS-Security policies to
CMDBWS.
Any changes made to the policies and keystores as described in other sections affect only BMC
Atrium Core Web Services 7.5.00 and later.
Important
Products that have an existing integration with CMDBWS might not be able to use
CMDBWS if you enable SSL using the procedure described in Enabling SSL for
transport-level encryption for CMDBWS If, after SSL is applied to the CMDBWS, you
encounter any issues with BMC products integrated with BMC Atrium CMDB using
CMDBWS , you might have to return the CMDBWS to its former configuration without SSL
.
CMDBWS is the deprecated Web Services that was released in BMC Atrium CMDB 2.1. To support
CMDBWS in the Axis2 implementation, the Web application is a modified Axis2-based WAR
distribution and contains the CMDBWS Web Service archive prebuilt into it. This Web application
should be installed into the same Tomcat instance as the Atrium Web Application. If you need to
reinstall or redeploy into that Tomcat instance, the packaged cmdbws.war file is installed in <
BMCAtriumCoreInstallationDirectory>/wsc/atriumws90/archives/ .
The cmdbws.war file includes the following custom module:
BMCAtriumWSPrerequisiteChecker This module is globally referenced in the atriumws90.war
distribution and affects access to all service endpoints. This module checks that prerequisites are
met for BMC Atrium Core services to run in Tomcat:
BMC Atrium Core 9.0
Page 1325 of 2268
Home
the CMDB APIs are accessible in a shared lib path in Tomcat

the JNI shared native libraries are loadable in Tomcat
the Java version is either 1.5 or 1.6,
the JRE or JDK is 32-bit.
The installation verifies these prerequisites, so this module is included to check if anything has
changed in the Tomcat configuration since installation that would affect these prerequisites. If the
prerequisites do not pass, a SOAP:Fault message is sent as a response from the Web Services
that describes the failures.
Apache Axis2 WAR Distribution modifications for CMDBWS

The Axis2 WAR is the primary component of the CMDBWS Web Application Archive and has the
WEB-INF/web.xml Modified to remove access to the Axis2 Administration Console,
which the CMDBWS WAR does not use. Also, endpoints use the following format:
http://<hostname>:<port>/cmdbws/server/cmdbws
This change matches what existing BMC products expect so that they can integrate with
BMC Atrium Core through CMDBWS.
The <servlet> element for AxisAdminServlet has been commented out.
The <servlet-mapping> element for AxisAdminServlet has been commented out.
The existing <servlet-mapping> element for the AxisServlet is mapped to /
services/, and a new element maps to /server/. These changes ensure that the
CMDBWS meets the requirement format for endpoints.
WEB-INF/conf/axis2.xml Modified to fit the wanted operational configuration for BMC
Atrium Web Services and, like web.xml, to meet the requirement format for endpoints.
The servicePath parameter is no longer commented out and has been changed
from services to server. This change ensures that the CMDBWS meets the
requirement format for endpoints.
The userName and password parameters have been commented out. With the
WEB-INF/web.xml changes, these parameters are not necessary.
The hotupdate parameter has been changed from false to true. The CMDBWS is a
standalone bundle, and you cannot deploy other Web Service archives into it.
The sendStacktraceDetailsWithFaults and
DrillDownToRootCauseForFaultReason parameters both changed from false to
true. These changes enable detailed stack traces accompanying faults to be sent with
the SOAP fault responses at runtime.
The messageBuilder class name, where contentType is application/xml, is
changed from ApplicationXMLBuilder to SOAPBuilder. For more details about this
change, see section 4.2 defined in Apache Axis2 Security Advisory (CVE-2010-1632)
.
BMC Atrium Core 9.0
Page 1326 of 2268
Home
The disableREST and disableSOAP12 parameters changed from false to true.

BMC Atrium Web Services does not support Axis2's REST option to send and receive
responses without the SOAP envelope, and only SOAP 1.1 is currently supported in
SOAP requests and responses.
The existing HTTP transportReceiver is replaced with a transportReceiver declaration
absent a declaration for the HTTP port. Additionally, an HTTPS transportReceiver is
added absent a declaration for the HTTPS port. Both of these are mapped to the
AxisServlet class. These sections indicate that the Atrium WAR depends on the
Tomcat configured connectors.
The reference to the WS-Addressing module is removed. CMDBWS does not support
WS-Addressing.
A new custom phase (BMCPrerequisitesPhase) is added to the InFlow
phaseOrder declaration immediately before the Security phase. The
BMCAtriumWSPrerequisiteChecker custom module uses BMCPrerequisitesPhase to
order the prerequisite checks before security phases are encountered.
Configuring CMDBWS
The Axis2-based implementation of CMDBWS does not share runtime properties with BMC Atrium
Web Services, and you do not configure it through Atrium Service Configuration Service. Instead,
CMDBWS has its own properties file: <BMCAtriumCoreInstallationDirectory>\wsc\cmdbws
directory\cmdbws.properties.
The CMDBWS implementation reads this file each time an operation is called. CMDBWS
immediately picks up any property changes in the Web service without restarting the server.
The BMC Atrium Core installer configures the correct values for the properties. The following table
describes the CMDBWS properties
CMDBWS properties
Property
Description
bmc.atrium.arserver.hostname
The hostname of the AR Server/CMDB to be accessed by the Web services.
bmc.atrium.arserver.port
The port number of the AR Server/CMDB to be accessed by the Web services.
bmc.atrium.arserver.rpcqueue
The default RPC queue number to be used in accessing the CMDB. This is a global
configuration. Client applications cannot set their own values for this property. The
default queue number is 0.
bmc.atrium.arserver.defaultlocale
The default locale to be used by AR Server/CMDB for its human readable status or
fault messages. This value can be specified by a client in each operation exposed by
the core Web services, but if that value is not passed in at that time, the value
specified here is used as the default. Messages specific to CMDBWS are not
localized as they are in Atrium Web services, so this setting has no effect on those
but rather only on messages from the AR and CMDB. The default locale is en.
bmc.atrium.arserver.defaulttimezone
BMC Atrium Core 9.0
The default timezone to be used in accessing the AR Server/CMDB. The default

value is 0.
Page 1327 of 2268
Home
Property
Description
bmc.atrium.arserver.defaulttimeout.normal
The normal timeout value to be used in accessing the AR Server/CMDB. This is a

global configuration. Client applications cannot set their own values for this property.
The default value is 0.
bmc.atrium.arserver.defaulttimeout.long
The long timeout value to be used in accessing the AR Server/CMDB. This is a

bmc.atrium.arserver.defaulttimeout.xlong
The extra long timeout value to be used in accessing the AR Server/CMDB. This is a
bmc.cmdbws.log.level
The level at which the CMDBWS should log itself. Log messages are written to
standard out, meaning that those messages should be included in the console
window of Tomcat or one of its standard out logs. Possible values are INFO, ERROR
, WARN, DEBUG, and TRACE. The default log level is WARN.
Enabling SSL for transport-level encryption for CMDBWS

Because CMDBWS was never documented to support SSL and contained no out-of-the-box SSL
configuration in BMC Atrium Configuration Management Database (BMC Atrium CMDB) 2.1, the
default configuration in BMC Atrium Core Web Services does not apply to CMDBWS.
If you configured SSL for CMDBWS or need to enable it after upgrading to BMC Atrium Core Web
Services, use the following procedure to map a configured SSL server, such as the default
SSL_Server, to CMDBWS.
In previous versions, you had to configure CMDBWS separately from BMC Atrium Core Web
Services. In the Axis2-implementation, CMDBWS is always exposed through both HTTP and
HTTPS without additional steps.
To access CMDBWS, use the following endpoints:
http://<hostname>:<httpport>/cmdbws/server/cmdbws
https://<hostname>:<sslport>/cmdbws/server/cmdbws
The WSDL can be accessed at the following address:
http://<hostname>:<httpport>/cmdbws/server/cmdbws.wsdl

The following topics provide reference information for the C API data structures:
Types of BMC Atrium CMDB C API structures
CMDBAttributeGetStruct structure
CMDBAttributeLimit structure
CMDBAttributeLimitList structure
CMDBAttributeNameId structure
CMDBAttributeValueList structure
BMC Atrium Core 9.0
Page 1328 of 2268
Home
CMDBAttributeValueListList structure
CMDBAttributeValueStruct structure
CMDBAuditInfoStruct structure
CMDBAuditValueList structure
CMDBAuditValueListList structure
CMDBClassNameId structure
CMDBClassNameIdList structure
CMDBClassRelationship structure
CMDBClassTypeInfo structure
CMDBExportItem structure
CMDBExportItemList structure
CMDBExportItemStruct structure
CMDBFederatedActivateInfo structure
CMDBFederatedARInfo structure
CMDBGetObjectList structure
CMDBGetObjectStruct structure
CMDBGetRelationList structure
CMDBGetRelationStruct structure
CMDBGraphAdjacentList structure
CMDBGraphAdjacentStruct structure
CMDBGraphList structure
CMDBGraphStruct structure
CMDBGraphWalkObjectList structure
CMDBGraphWalkObjectStruct structure
CMDBGraphWalkQueryStruct structure
CMDBGraphWalkRelation structure
CMDBGraphWalkRelationList structure
CMDBGraphWalkResultStruct structure
CMDBGraphWalkSelectorAndFilterList structure
CMDBGraphWalkSelectorAndFilterStruct structure
CMDBGraphWalkStateStruct structure
CMDBImportItem structure
CMDBImportDataSummaryStruct structure
CMDBImportItemStruct structure
CMDBIndexList structure
CMDBIndexStruct structure
CMDBInstanceList structure
CMDBInstanceStruct structure
CMDBItemTypeAttribute structure
CMDBItemTypeClass structure
CMDBNestedQueryStruct structure
CMDBQualifierStruct structure
CMDBQueryArithOpStruct structure
BMC Atrium Core 9.0
Page 1329 of 2268
Home
CMDBQueryAttributeName structure
CMDBQueryCardinality structure
CMDBQueryObject structure
CMDBQueryObjectList structure
CMDBQueryObjectRelationship structure
CMDBQueryObjectSelectorList structure
CMDBQueryObjectSelectorStruct structure
CMDBQueryQualifierAndOrStruct structure
CMDBQueryQualifierSetOpStruct structure
CMDBQueryQualifierSimpleOpStruct structure
CMDBQueryQualifierStruct structure
CMDBQueryQualifierValueSetStruct structure
CMDBQueryQualifierValueStruct structure
CMDBQueryResultGraph structure
CMDBQuerySortStruct structure
CMDBQuerySortList structure
CMDBQueryStruct structure
CMDBGraphQueryResult structure
CMDBStdEdgeResult structure
CMDBEdgeListList structure
CMDBNodeList structure
CMDBNodeListList structure
CMDBRelationshipResult structure
CMDBRelationshipResultList structure
CMDBREClassQualList structure
CMDBREClassQualStruct structure
CMDBREDatasetList structure
CMDBREDatasetPair structure
CMDBREJobRunInfo structure
CMDBREJobRunInfoList structure
CMDBSortList structure
CMDBSortStruct structure
CMDBUIComponentInfo structure
CMDBUIComponentResult structure
CMDBUIComponentResultList structure
CMDBVersionInfo structure
CMDBVersionInfoList structure
CMDBWeakPropagatedAttrs structure
CMDBWeakPropagatedAttrsList structure
CMDBXMLExportItemList structure
CMDBXMLImportItemList structure
BMC Atrium Core 9.0
Page 1330 of 2268
Home
Types of BMC Atrium CMDB C API structures

C API data structures are categorized by types, as listed in the following table.
List of data structures categorized by function type
Data structure type
List of data structures
Attribute structures: used in data model functions.

CMDBAttributeGetStruct
CMDBAttributeLimit
CMDBAttributeLimitList
CMDBAttributeNameId
CMDBAttributeValueList
CMDBAttributeValueListList
CMDBAttributeValueStruct
CMDBAuditInfoStruct
CMDBAuditValueList
CMDBAuditValueListList
CMDBSortList
CMDBSortStruct
CMDBWeakPropagatedAttrs
CMDBWeakPropagatedAttrsList
Export and import structures: used in export and import functions.

CMDBItemTypeAttribute
CMDBItemTypeClass
CMDBExportItem
CMDBExportItemList
CMDBExportItemStruct
CMDBImportItem
CMDBXMLExportItemList
Export and import structures (continued)

CMDBImportItemList
CMDBImportItemStruct
CMDBXMLImportItemList
CMDBImportDataSummaryStruct
Federation structures: used in federation functions.

CMDBFederatedActivateInfo
CMDBFederatedARInfo
Class structures: holds CI and relationship definitions.

CMDBClassRelationship
CMDBClassTypeInfo
CMDBIndexList
CMDBIndexStruct
General-purpose structures: used in general-purpose functions.

CMDBVersionInfo
CMDBVersionInfoList
BMC Atrium Core 9.0
Page 1331 of 2268
Home
Data structure type
Instance structures: used for manipulating instance data.

CMDBClassNameId
CMDBClassNameIdList
CMDBInstanceList
CMDBInstanceStruct
CMDBQualifierStruct
Query structures: used in queries.

CMDBGetObjectList
CMDBGetObjectStruct
CMDBGetRelationList
CMDBGetRelationStruct
CMDBGraphAdjacentList
CMDBGraphAdjacentStruct
CMDBGraphList
CMDBGraphStruct
CMDBGraphWalkObjectList
CMDBGraphWalkObjectStruct
CMDBGraphWalkQueryStruct
CMDBGraphWalkSelectorAndFilterList
CMDBGraphWalkSelectorAndFilterStruct
CMDBGraphWalkRelation
CMDBGraphWalkRelationList
CMDBGraphWalkResultStruct
CMDBGraphWalkStateStruct
CMDBQueryArithOpStruct
CMDBQueryAttributeName
CMDBQueryCardinality
CMDBQueryObject
CMDBQueryObjectList
CMDBQueryObjectSelectorList
CMDBQueryObjectSelectorStruct
CMDBQueryQualifierAndOrStruct
CMDBQueryQualifierSetOpStruct
CMDBQueryQualifierSimpleOpStruct
CMDBQueryQualifierStruct
CMDBQueryQualifierValueSetStruct
CMDBQueryQualifierValueStruct
CMDBQueryResultGraph
CMDBQuerySortList
CMDBQuerySortStruct
CMDBQueryStruct
CMDBStdRelationship
CMDBStdRelationshipList
CMDBRelationshipResultList
CMDBEdgeListList
CMDBNodeList
CMDBNodeListList
CMDBGraphQueryResult
CMDBNestedQueryStruct
Reconciliation Engine structures: used in Reconciliation Engine queries.

CMDBREClassQualList
BMC Atrium Core 9.0
Page 1332 of 2268
Home
Data structure type

CMDBREClassQualStruct
CMDBREDatasetList
CMDBREDatasetPair
CMDBREJobRunInfo
CMDBREJobRunInfoList
User interface components structures: used in UI component functions.

CMDBUIComponentInfo
CMDBUIComponentResult
CMDBUIComponentResultList
CMDBAttributeGetStruct structure
The CMDBAttributeGetStruct structure holds the attributes to retrieve.
typedef struct CMDBAttributeGetStruct

{
unsigned int type;
union
{
ARNameList attributeNameList;
} u;
} CMDBAttributeGetStruct;
The CMDBAttributeGetStruct structure consists of the following elements:

An integer value indicating the type of attributes to retrieve.
type
1 --Retrieve all attributes in attributeNameList (CMDB_GET_ATTR_CUSTOM_LIST )

2 --Retrieve all attributes except hidden attributes ( CMDB_GET_ATTR_NONHIDDEN )
3 --Retrieve all attributes (CMDB_GET_ATTR_ALL )
attributeNameList
The name of the attribute list.
CMDBAttributeLimit structure
The CMDBAttributeLimit structure holds the data limit definitions for an attribute of any data
type.
typedef struct CMDBAttributeLimit

{
unsigned int dataType;
union
{
struct
{
int rangeLow;
BMC Atrium Core 9.0
Page 1333 of 2268
Home
int rangeHigh;
} integerLimits;
struct
{
int maxLength;
char *format;
unsigned int
menuStyle;
ARNameType charMenu;
char *pattern;
unsigned int qbeMatchOperation;
} charLimits;
struct
{
double rangeLow;
double rangeHigh;
int precision;
} realLimits;
struct
{
char *rangeLow;
char *rangeHigh;
int precision;
} decimalLimits;
struct
{
int minDate;
int maxDate;
} dateLimits;
struct
{
unsigned int listStyle;
union
{
ARNameList regularList;
AREnumItemList customList;
} u;
} enumLimits;
struct
{
char *rangeLow;
char *rangeHigh;
int precision;
ARCurrencyDetailList functionalCurrencies;
ARCurrencyDetailList allowableCurrencies;
} currencyLimits;
struct
{
unsigned long maxSize;
ARNameType attachmentPoolName;
} attachLimits;
} u;
}CMDBAttributeLimit;
BMC Atrium Core 9.0
Page 1334 of 2268
Home
The CMDBAttributeLimit structure consists of the following element:

dataType
An integer value indicating the data type of the value being passed. The following table describes the possible values.
Data types represented by values not in the following table are either unsupported or display fields.
Value
Data type
Description
CMDB_ATTR_DATA_TYPE_NULL
Specifies a NULL value.
CMDB_ATTR_DATA_TYPE_
An integer identifying the particular keyword (defined in cmdb.h ).
KEYWORD
2
A 32-bit signed integer value.
INTEGER
3
CMDB_ATTR_DATA_TYPE_REAL
A 64-bit floating-point value.
CMDB_ATTR_DATA_TYPE_CHAR
A null-terminated string that requires freeing allocated space. A NULL pointer of this
type is equivalent to CMDB_ATTR_DATA_TYPE_NULL.
CMDB_ATTR_DATA_TYPE_DIARY
A null-terminated string that requires freeing allocated space. A NULL pointer of this
type is equivalent to CMDB_ATTR_DATA_TYPE_NULL.
CMDB_ATTR_DATA_TYPE_ENUM
A set of integer values (beginning with zero) that represent possible selection values
as an indexed list. You must specify an attribute limit by using ARNameList to define
string values for each selection.
CMDB_ATTR_DATA_TYPE_ TIME
A UNIX-style date and time stamp (number of seconds since midnight January 1,
1970).
10
DECIMAL
A fixed-point decimal attribute. Values must be specified in C locale, for example,
11
ATTACH
An attachment attribute.
12
CURRENCY
A currency attribute.
13
CMDB_ATTR_DATA_TYPE_DATE
A Julian date number (number of days since January 1, 4713 BC).
14
CMDB_ATTR_DATA_TYPE_TIME_
OF_DAY
The number of seconds since 12:00 a.m. of the current day.
37
ATTACH_POOL
A pool for grouping attachments.
1234.56.
Integer limits
The integerLimits structure holds data limit definitions for an attribute of the integer data type. It
consists of the following elements:
rangeLow
The lowest integer value allowed for the attribute.
rangeHigh
The highest integer value allowed for the attribute.
BMC Atrium Core 9.0
Page 1335 of 2268
Home
Character limits
The charLimits structure holds data limit definitions for an attribute of the character data type. It
maxLength
The maximum character length allowed for the attribute.
format
Used for character list data, specified as L n, where n is the number of items in the list. L4, for example, indicates a
list of a maximum of 4 items, with each item separated by a semicolon (
. NULL indicates that a list is not used.
Real limits
The realLimits structure holds data limit definitions for an attribute of the real data type. It
rangeLow
The lowest real value allowed for the attribute.
rangeHigh
The highest real value allowed for the attribute.
precision
The number of integers allowed to the right of the decimal point for an attribute of the real data type.
Decimal limits
The decimalLimits structure holds data limit definitions for an attribute of the decimal data type.
It consists of the following elements:
rangeLow
The lowest decimal value allowed for the attribute.
rangeHigh
The highest decimal value allowed for the attribute.
precision
The number of integers allowed to the right of the decimal point for an attribute of the decimal data type.
Date limits
The dateLimits structure holds data limit definitions for an attribute of the date data type. It
minDate
The earliest date value allowed for the attribute.
maxDate
The latest date value allowed for the attribute.
Enum limits
The enumLimits structure holds data limit definitions for an attribute of the enum data type. It
consists of the following element:
regularList
A name list of possible selection values for an attribute of the enum data type.
Currency limits
The currencyLimits structure holds data limit definitions for an attribute of the currency data
type. It consists of the following elements:
BMC Atrium Core 9.0
Page 1336 of 2268
Home
rangeLow
The lowest currency value allowed for the attribute.
rangeHigh
The highest currency value allowed for the attribute.
precision
The number of integers allowed to the right of the decimal point for an attribute of the currency data type.
functionalCurrencies
Default list of functional currencies when new currency attributes are created.
allowableCurrencies
Default list of allowable currencies when new currency attributes are created.
Attachment limits
The attachLimits structure holds data limit definitions for an attribute of the attachment data
type. It consists of the following elements:
maxSize
The maximum size in bytes allowed for the attachment attribute.
attachmentPoolName
The name of the attachment pool attribute with which this attachment attribute is associated.
CMDBAttributeLimitList structure
The CMDBAttributeLimitList structure holds a list of data limit definitions for attributes.
typedef struct CMDBAttributeLimitList

{
unsigned int numItems;
CMDBAttributeLimit *limitList;
} CMDBAttributeLimitList;
The CMDBAttributeLimitList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBAttributeLimit items in the list.
limitList
The list of attribute limit items that hold the limit definitions for the attribute.
CMDBAttributeNameId structure
The CMDBAttributeNameId structure holds the namespace name and the class name
information for a class.
typedef struct CMDBAttributeNameId

{
ARNameType namespaceName;
ARNameType className;
ARNameType attributeName;
} CMDBAttributeNameId;
The CMDBAttributeNameId structure consists of the following elements:

namespaceName
BMC Atrium Core 9.0
The namespace name for the class.
Page 1337 of 2268
Home
className
The name of the class.
attributeName
The name of the attribute.
CMDBAttributeValueList structure
The CMDBAttributeValueList structure holds a list of values for an attribute.
typedef struct CMDBAttributeValueList

{
CMDBAttributeValueStruct *attributeValueList;
} CMDBAttributeValueList;
The CMDBAttributeValueList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBAttributeValueStruct items in the list.
attributeValueList
A list of CMDBAttributeValueStruct items.
CMDBAttributeValueListList structure
The CMDBAttributeValueListList structure holds a list of values for an attributes list.
typedef struct CMDBAttributeValueListList

{
CMDBAttributeValueList *attributeValueListList;
} CMDBAttributeValueListList;
The CMDBAttributeValueListList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBAttributeValueList items in the list.
attributeValueListList
A list of CMDBAttributeValueList items.
CMDBAttributeValueStruct structure
The CMDBAttributeValueStruct structure holds values for attributes.
typedef struct CMDBAttributeValueStruct

{
ARValueStruct attributeValue;
} CMDBAttributeValueStruct;
The CMDBAttributeValueStruct structure consists of the following elements:
BMC Atrium Core 9.0
Page 1338 of 2268
Home
attributeName
attributeValue
The value of the attribute.
CMDBAuditInfoStruct structure
The CMDBAuditInfoStruct data structure holds the audit information to set audit options for the
class.
typedef struct CMDBAuditInfoStruct

{
unsigned int type;
CMDBQualifierStruct qual;
union
{
ARNameType logForm;
} u;
CMDB_CLASS_AUDITCHANGE_MASK auditMask;
} CMDBAuditInfoStruct;
The CMDBAuditInfoStruct structure consists of the following elements:

The type of audit option to set.
type
0 --No auditing option set (None).

1 --Create a copy of an instance when an attribute is modified (Copy).
2 --Store the information for the modified attributes in a log (Log).
qual
The qualification to retrieve the audit information for the class.
logForm
The name of the BMC Remedy AR System form for the Log audit option.
auditMask
The setting (Audit Only Changed Fields) for what type of activity triggers an audit. The options for auditMask are of
the type CMDB_CLASS_AUDITCHANGE_MASK.
CMDB_CLASS_AUDITCHANGE_DEFAULT = 0 --Use the value of the Disable Audit Only Change Fields
system setting on the BMC Remedy AR System server. The system setting default is that only changing the
attribute to a different value triggers auditing.
CMDB_CLASS_AUDITCHANGE_YES = 1 --Audit when an updated field value is different than the existing
value.
CMDB_CLASS_AUDITCHANGE_NO = 2 --Audit when a field value is modified, even if the updated value is the
same as the existing value.
CMDBAuditValueList structure
The CMDBAuditValueList data structure holds a list of audit values to retrieve.
typedef struct CMDBAuditValueList

{
unsigned int operation;
ARAccessNameType changedBy;
BMC Atrium Core 9.0
Page 1339 of 2268
Home
ARTimestamp auditTimestamp;
ARNameList attrNameChangeList;
CMDBAuditValueList *attrAuditValueList;
} CMDBAuditValueList;
The CMDBAuditValueList structure consists of the following elements:

operation
The type of audit operation performed.

0 --No audit operation performed (CMDB_AUDIT_OPERATION_NONE ).
1 --The modify operation performed (CMDB_AUDIT_OPERATION_SET ).
2 --The create operation performed (CMDB_AUDIT_OPERATION_CREATE ).
3 --The delete operation performed (CMDB_AUDIT_OPERATION_DELETE ).
4 --The merge operation performed (CMDB_AUDIT_OPERATION_MERGE ).
changedBy
The user who performed the audit operation.
auditTimestamp
The date and time when the audit operation was performed.
attrNameChangeList
The list of attribute names that changed in the audit operation.
attrAuditValueList
The list of attribute values that changed for the specified attributes.
CMDBAuditValueListList structure
The CMDBAuditValueListList data structure holds a list of audit values list to retrieve.
typedef struct CMDBAuditValueListList

{
CMDBAuditValueList *attrAuditValueList;
} CMDBAuditValueListList;
The CMDBAuditValueListList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBAuditValueList structure items in the list.
attrAuditValueList
The list of audit value list.
CMDBClassNameId structure
The CMDBClassNameId structure holds the namespace name and the class name information for
a class.
typedef struct CMDBClassNameId

{
ARNameType namespaceName;
ARNameType className;
} CMDBClassNameId;
BMC Atrium Core 9.0
Page 1340 of 2268
Home
The CMDBClassNameId structure consists of the following elements:

namespaceName
The namespace name of the class.
className
CMDBClassNameIdList structure
The CMDBClassNameIdList structure holds a list of CMDBClassNameId structures.
typedef struct CMDBClassNameIdList

{
CMDBClassNameId *classNameIdList;
} CMDBClassNameIdList;
The CMDBClassNameIDList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBClassNameIditems instances in the list.
classNameIdList
The list of class names.
CMDBClassRelationship structure
The CMDBClassRelationship structure holds the relationship information of the CI classes.
typedef struct CMDBClassRelationship

{
CMDBClassNameID relClassNames[2];
ARNameType roleNames[2];
unsigned int cardinality;
ARBoolean isRole2WeakReference;
CMDBWeakPropagatedAttrsList weakPropagatedAttrsList;
ARBoolean cascadeDelete;
} CMDBClassRelationship;
The CMDBClassRelationship structure consists of the following elements:

relClassNames[2]
The names of the two classes that are a part of the relationship.
roleNames[2]
The role names for the two classes that are a part of the relationship.
cardinality
An integer identifying the cardinality of the relationship between the related classes:
1 --One-to-one, one instance of a class is associated with a single instance of another class (
CMDB_CLASS_RELATIONSHIP_CARDINALITY_1 ).
2 --Many-to-one, one or more instances of a class are associated with one instance of
another class (CMDB_CLASS_RELATIONSHIP_CARDINALITY _MANY_1 ).
3 --One-to-many, one instance of a class is associated with one or more instances of another
class (CMDB_CLASS_RELATIONSHIP_CARDINALITY_1 _MANY ).
BMC Atrium Core 9.0
Page 1341 of 2268
Home
4 --Many-to-many, many instances of a class are associated with many instances of another
class (CMDB_CLASS_RELATIONSHIP_CARDINALITY _MANY_MANY ).
A Boolean value indicating whether role 2 is a weak reference:
isRole2WeakReference
TRUE --The role 2 class is a weak reference. Role 2 is a weak entity and it uses role 1's
primary key as part of its own key. If the value is TRUE, cardinality must be one-to-one or
many-to-many.
FALSE --The role 2 class is not a weak reference.
weakPropagatedAttrsList
If the value of isRole2WeakReference is TRUE, indicates the list of attributes that are propagated
from the role 1 class to the role 2 class.
A Boolean value indicating the type of delete allowed between the related classes:
cascadeDelete
TRUE --A cascade delete is allowed. Deleting an instance in one class also deletes the
instance in the related class.
FALSE --A cascade delete is not allowed.
This item is applicable only for one-to-one and one-to-many relationships.
CMDBClassTypeInfo structure
The CMDBClassTypeInfo structure holds the class type information.
typedef struct CMDBClassTypeInfo

{
unsigned int classType;
union
{
CMDBClassRelationship relationshipInfo;
} u;
} CMDBClassTypeInfo;
The CMDBClassTypeInfo structure consists of the following elements:

classType
An integer value identifying the type of class.

1 --The class type is regular (CMDB_CLASS_TYPE_REGULAR ).
2 --The class type is relationship (CMDB_CLASS_TYPE_RELATIONSHIP ).
relationshipInfo
If the classType parameter value is set to 2 (CMDB_CLASS_TYPE_RELATIONSHIP ), the relationship

information is retrieved.
CMDBExportItem structure
The CMDBExportItem data structure holds the items to export for the specified item type.
Note
BMC Atrium Core 9.0
Page 1342 of 2268
Home
This is a legacy structure of the BMC Atrium CMDB API, and has been replaced by newer
functions, CMDBExportData and CMDBExportDef.
typedef CMDBExportItem
{
unsigned int itemType;
union
{
CMDBItemTypeClass classItem;
CMDBItemTypeAttribute attributeItem;
}
}CMDBExportItem;
The CMDBExportItem structure consists of the following elements:

itemType
The type of item to export.

0 --No item to export (CMDB_ITEM_TYPE_NONE ).
1 --Export class (CMDB_ITEM_TYPE_CLASS ).
2 --Export attribute (CMDB_ITEM_TYPE_ATTRIBUTE ).
classItem
The class items to import, if the itemType is CMDB_ITEM_TYPE_CLASS.
attributeItem
The attribute items to import, if the itemType is CMDB_ITEM_TYPE_ATTRIBUTE.
CMDBExportItemList structure
The CMDBExportItemList data structure holds a list of CMDBExportItemStruct structures.
Note
typedef struct CMDBExportItemList

{
CMDBExportItemStruct *exportItemList;
} CMDBExportItemList;
The CMDBExportItemList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBExportItemStruct items in the list.
exportItemList
The list of items to export.
BMC Atrium Core 9.0
Page 1343 of 2268
Home
CMDBExportItemStruct structure
The CMDBExportItemStruct data structure holds a single item to export.
Note
typedef struct CMDBExportItemStruct

{
CMDBClassNameId classNameId;
union {
char *qualifier;
unsigned long exportOption;
} u;} CMDBExportItemStruct;
The CMDBExportItemStruct structure consists of the following elements:

itemType
An integer value indicating the type of information to export.

1 --Export class definitions (meta data) ( CMDB_ITEM_TYPE_META_DATA ).
2 --Export instance data (CMDB_ITEM_TYPE_INSTANCE_DATA ).
classNameId
The namespace name and the class name of the class that contains the items to export.
qualifier
A query that determines the set of entries to export. The qualification can include one or more attributes and any
combination of conditional, relational, and arithmetic (numeric data types only) operations. This item is applicable
only if CMDB_ITEM_TYPE_INSTANCE_DATA is set.
exportOption
An integer value indicating the type of classes to export. If you specified the
CMDB_ITEM_TYPE_INSTANCE_DATA value for itemType, provide an export option. This option is applicable only
if CMDB_ITEM_TYPE_META_DATA is set. To use more than one export option, add the value of each option. For
example, 3 indicates the class (1 ) and superclasses (2 ) will be exported. The default value for this parameter is
NULL, which means all classes are exported.
1 --Export the class only (CMDB_EXPORT_OPTION_CLASS_ONLY ).
2 --Export superclasses (CMDB_EXPORT_OPTION_SUPER_CLASSES ).
4 --Export subclasses (CMDB_EXPORT_OPTION_SUB_CLASSES ).
CMDBFederatedActivateInfo structure
The CMDBFederatedActivateInfo data structure holds the federated instance data activation
information to retrieve.
typedef struct CMDBFederatedActivateInfo

{
BMC Atrium Core 9.0
Page 1344 of 2268
Home
unsigned int
actionType;
unsigned int
accessType;
union
{
CMDBFederatedARInfo arInfo;
char *accessString;
} u;
} CMDBFederatedActivateInfo;
The CMDBFederatedActivateInfo structure consists of the following elements:

actionType
The action to perform.

0 --Activate none (CMDB_FEDERATION_ACTIVATION_NONE ).
1<<0 --Return the expanded federated interface data
(CMDB_FEDERATION_ACTIVATION_EXPAND ).
1<<0 --Expand and launch the federated interface (CMDB_FEDERATION_ACTIVATION_LAUNCH ).
accessType
The type of access required.

0--Access a BMC Remedy AR System form for the federated interface (
CMDB_FEDERATED_ACCESS_TYPE_AR ).
1 --Access a URL for the federated interface ( CMDB_FEDERATED_ACCESS_TYPE_URL ).
2 --Use a web service for the federated interface ( CMDB_FEDERATED_ACCESS_TYPE_WEBSERVICE ).
3 --Start a process for the federated interface ( CMDB_FEDERATED_ACCESS_TYPE_PROCESS ).
4 --Access a manual launch link information for the federated interface (
CMDB_FEDERATED_ACCESS_TYPE_MANUAL ).
5 --Access a data store for the federated interface ( CMDB_FEDERATED_ACCESS_TYPE_DATA_STORE ).
6 --Access a data store using a federated data class
(CMDB_FEDERATED_ACCESS_TYPE_CLASS ).
arInfo
Contains information related to the BMC Remedy AR System form.
accessString
Based on the accessType subclasses, contains the URL link, process command, class ID, or other information.
CMDBFederatedARInfo structure
The CMDBFederatedARInfo data structure holds the BMC Remedy AR System related federated
interface information to retrieve.
typedef struct CMDBFederatedARInfo

{
unsigned int arAccessType;
ARNameType server;
ARNameType form;
ARNameType view;
char *qualifier;
char *url;
} CMDBFederatedARInfo;
The CMDBFederatedARInfo structure consists of the following elements:
BMC Atrium Core 9.0
Page 1345 of 2268
Home
arAccessType
The access type for the BMC Remedy AR System.

0 --Retrieve BMC Remedy AR System URL (CMDB_FEDERATED_ACCESS_TYPE_AR_URL ).
1 --Retrieve BMC Remedy AR System Process ( CMDB_FEDERATED_ACCESS_TYPE_AR_PROCESS ).
server
The BMC Remedy AR System server name.
form
The BMC Remedy AR System form name.
view
The BMC Remedy AR System view name.
qualifier
The qualifier string for accessing the BMC Remedy AR System.
url
Contains the URL for a BMC Remedy AR System form or any other external website. To access a BMC
Remedy AR System form, the default web path specified on the BMC Remedy AR System server is used.
CMDBGetObjectList structure
The CMDBGetObjectList data structure holds a list of CI instances.
typedef struct CMDBGetObjectList

{
CMDBGetObjectStruct *objectList;
} CMDBGetObjectList;
The CMDBGetObjectList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBGetObjectStruct items in the list.
objectList
The list of CI instances.
CMDBGetObjectStruct structure
The CMDBGetObjectStruct data structure holds a CI instance.
typedef struct CMDBGetObjectStruct

{
ARNameType instanceId;
CMDBAttributeValueList attributeValueList;
} CMDBGetObjectStruct;
The CMDBGetObjectStruct structure consists of the following elements:

classNameId
The class name ID for the class.
instanceId
The instance ID of the object.
attributeValueList
The list of attribute values.
BMC Atrium Core 9.0
Page 1346 of 2268
Home
CMDBGetRelationList structure
The CMDBGetRelationList data structure holds a list of relationships.
typedef struct CMDBGetRelationList

{
CMDBGetRelationStruct *relationList;
} CMDBGetRelationList;
The CMDBGetRelationList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBGetRelationStruct items in the list.
relationList
The list of relationships.
CMDBGetRelationStruct structure
The CMDBGetRelationStruct data structure holds a single relationship.
typedef struct CMDBGetRelationStruct

{
ARNameType roleNames[2];
CMDBClassNameId relatedClassNames[2];
ARNameType relatedClassIds[2];
ARNameType relatedInstanceIds[2];
} CMDBGetRelationStruct;
The CMDBGetRelationStruct structure consists of the following elements:

classNameId
The namespace name and the class name of the relationship class.
instanceId
The instance ID of the related class.
roleNames[2]
The role names for the two classes that make up the relationship.
relatedClassNames[2]
The names of the two classes that make up the relationship.
relatedClassIds[2]
The class IDs of the two classes that make up the relationship.
relatedInstanceIds[2]
The instance IDs of the two classes that make up the relationship.
attributeValueList
The list of relationship attribute values.
CMDBGraphAdjacentList structure
The CMDBGraphAdjacentList data structure holds a list of adjacent nodes in
CMDBGraphAdjacentStruct.
BMC Atrium Core 9.0
Page 1347 of 2268
Home
typedef struct CMDBGraphAdjacentList

{
CMDBGraphAdjacentStruct *adjacents;
} CMDBGraphAdjacentList;
The CMDBGraphAdjacentList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBGraphAdjacentStruct items in the list.
adjacents
The list of adjacent nodes.
CMDBGraphAdjacentStruct structure
The CMDBGraphAdjacentStruct data structure holds an adjacent node.
typedef struct CMDBGraphAdjacentStruct

{
CMDBClassNameId relClassNameId;
CMDBQualifierStruct relQual;
CMDBAttributeGetStruct relGetAttribute;
CMDBClassNameId objClassNameId;
ARNameType extensionId;
CMDBQualifierStruct objQual;
CMDBAttributeGetStruct objGetAttribute;
} CMDBGraphAdjacentStruct;
The CMDBGraphAdjacentStruct structure consists of the following elements:

relClassNamesNameId
The name of the class that makes up the relationship.
relQual
The qualification string that qualifies the relationship. This item can be NULL.
relGetAttribute
The related attribute to retrieve from the relationship.
objClassNameId
The object class name.
extensionId
The extension ID of the object. This item can contain an empty string.
objQual
The qualification of the object. This item can be NULL.
objGetAttribute
The object attribute to retrieve.
CMDBGraphList structure
The CMDBGraphList data structure is used to define the query graph list in the CMDBGraphQuery
function.
typedef struct CMDBGraphList

{
BMC Atrium Core 9.0
Page 1348 of 2268
Home

CMDBGraphStruct *graph;
} CMDBGraphList;
The CMDBGraphList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBGraphStruct items in the list.
graph
The graph structure.
CMDBGraphStruct structure
The CMDBGraphStruct data structure holds each graph node in the query graph.
typedef struct CMDBGraphStruct

{
ARNameType extensionId;
CMDBGraphAdjacentList adjacentList;
} CMDBGraphStruct;
The CMDBGraphStruct structure consists of the following elements:

classNameId
The name of the class for the object (node).
extensionId
The extension ID of the node.
adjacentList
The list of adjacent objects (nodes).
CMDBGraphWalkObjectList structure
The CMDBGraphWalkObjectList structure holds a list of CMDBGraphWalkObjectStruct
structures. This structure is for internal use only.
typedef struct CMDBGraphWalkObjectList

{
CMDBClassNameIdList classNameIdList;
CMDBGraphWalkObjectStruct *objectList;
}CMDBGraphWalkObjectList;
The CMDBGraphWalkObjectList structure consists of the following elements:

classNameIdList
The list of class name Ids of all the objects walked in the graph.
numItems
An integer value indicating the number of CMDBGraphWalkObjectStruct instances in the list

.
CMDBGraphWalkObjectStruct
BMC Atrium Core 9.0
A pointer to the list of CMDBGraphWalkObjectStruct structures.
Page 1349 of 2268
Home
CMDBGraphWalkObjectStruct structure
The CMDBGraphWalkObjectStruct structure holds the information about the objects walked in
the relationship graph, which is required to retrieve instances in chunks. This structure is for internal
use only.
typedef struct CMDBGraphWalkObjectStruct

{
unsigned int classNameIdIndex;
ARBoolean bNeedToWalkFurther;
unsigned int level;
}CMDBGraphWalkObjectStruct;
The CMDBGraphWalkObjectStruct structure consists of the following elements:

classNameIdIndex
An integer value indicating the index number in the CMDBGraphWalkObjectList array.
instanceId
Instance Id of the object in the array.
bNeedToWalkFurther
A Boolean value indicating whether to stop the graph walk for the specific object in the query or whether
to continue the walk.
level
Level of the node in the relationship graph.
CMDBGraphWalkQueryStruct structure
The CMDBGraphWalkQueryStruct structure holds the parameters for the query. This structure is
used in the CMDBGraphWalkBegin function to set up the starting node in the relationship graph for
the query.
typedef struct CMDBGraphWalkQueryStruct

{
ARNameType datasetId;
unsigned int datasetMask;
CMDBGraphWalkRelation walkRelation;
unsigned int numLevels;
unsigned int maxRetrieve;
CMDB_GRAPH_WALK_QUERY_MODE queryMode;
CMDBGraphWalkSelectorAndFilterList objSelectorAndFilterList;
}CMDBGraphWalkQueryStruct;
The CMDBGraphWalkQueryStruct structure consists of the following elements:

datasetId
The ID of the dataset from which to retrieve the instances.
datasetMask
An integer value that specifies the dataset type for the query.
BMC Atrium Core 9.0
Page 1350 of 2268
Home
0 -- Based on the datasetId passed, instances are retrieved from either the overlay or the
original dataset (CMDB_GET_MASK_NONE ).
1 << 0 --Allows you to retrieve instances from the current dataset only (
CMDB_GET_DATASET_MODE_CURRENT ).
walkRelation
A CMDBGraphWalkRelation structure, which contains the qualification for the query.
numLevels
An integer value indicating the number of levels to walk in the relationship graph. If this parameter is
set to a value of 0, the query walks all the levels in the graph.
maxRetrieve
The maximum number of objects to retrieve from the list of objects returned.
queryMode
An integer value that specifies the properties for querying objects in the graph. The match is based
on the qualification specified in the CMDBGraphWalkSelectorAndFilterStruct for an object. If
no qualification is specified in CMDBGraphWalkSelectorAndFilterStruct, all the objects in the
graph are returned.
0 -- Skips those nodes in the graph walk that do not match the qualification that you specified
for the query. Use this option to get the connected graph for a given node. The graph walk is
stopped and the results are returned when the query finds the first node that does not match
the criteria (CMDB_GRAPH_WALK_STOP_IF_NO_MATCH_FOUND ).
1 --The graph walk is stopped and the results are returned when the query finds the first node
that matches the qualification. The query returns only the matching nodes and their
relationships (CMDB_GRAPH_WALK_STOP_IF_MATCH_FOUND ).
2 --The query walks all levels of the graph to find matching and nonmatching nodes. The query
returns only the matching nodes and their relationships (
CMDB_GRAPH_WALK_WALK_COMPLETE_GRAPH ).
objSelectorAndFilterList
A objSelectorAndFilterList structure, which contains the selection and filter criteria for the
query.
CMDBGraphWalkRelation structure
The CMDBGraphWalkRelation structure holds information about the relationship to walk
recursively, the qualification for the query, and the attributes to retrieve.
typedef struct CMDBGraphWalkRelation

{
ARNameList *getAttrList;
CMDBQualifierStruct *qualification;
unsigned int direction;
ARBoolean isImpactGraphWalk;
}CMDBGraphWalkRelation;
The CMDBGraphWalkRelation structure consists of the following elements:

classNameId
The class name and namespace for which the attribute values are specified.
getAttrList
The list of attributes to retrieve.
qualification
A pointer to the CMDBQualifierStruct structure, which holds the qualification for the query.
BMC Atrium Core 9.0
Page 1351 of 2268
Home
An integer value indicating the direction in which to traverse the relationship graph.
direction
0 --Return those relationships in which the node is the destination (

CMDB_RELATIONSHIP_DIRECTION_OUT ).
1 --Return those relationships in which the node is the source (
CMDB_RELATIONSHIP_DIRECTION_IN ).
2 --Return those relationships in which the node is either the source or the destination (
CMDB_RELATIONSHIP_DIRECTION_BOTH ).
isImpactGraphWalk
A boolean value indicating whether to walk only Impact relationships in the query for the given CI.
TRUE-- The CMDBGraphWalk function uses only impact attributes in the query. The query returns
only those CIs that share Impact relationships among each other.
FALSE --Walk only regular relationships in the query. The Impact relationships for the CI are
ignored.
CMDBGraphWalkRelationList structure
The CMDBGraphWalkRelationList structure holds information about the relationship graph to
walk and the type of attributes to retrieve in the query.
typedef struct CMDBGraphWalkRelationList

{
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT attrFlag;
CMDBGraphWalkRelation *walkRelationList;
}CMDBGraphWalkRelation;
The CMDBGraphWalkRelationList structure consists of the following elements:

attrFlag
An integer value indicating the type of attributes to select in the query when the object list in
CMDBGraphWalkSelectorAndFilterList is empty or NULL.
0 -- If attributes omitted, select nothing ( CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_NONE).
1 -- If attributes omitted, select all non-hidden attributes (
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ NONHIDDEN ).
2 -- If attributes omitted, select all attributes, hidden and non-hidden (
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ALL ).
numItems
An integer value indicating the number of CMDBGraphWalkRelation instances in the list.
walkRelationList
A pointer to the list of CMDBGraphWalkRelation structures.
CMDBGraphWalkResultStruct structure
The CMDBGraphWalkResultStruct structure holds the graph walk query results.
typedef struct CMDBGraphWalkResultStruct

{
CMDBInstanceList relationList;
BMC Atrium Core 9.0
Page 1352 of 2268
Home
CMDBInstanceList objectList;
}CMDBGraphWalkResultStruct;
The CMDBGraphWalkResultStruct structure consists of the following elements:

relationList
A list of relationship instances that the query retrieved.
objectList
A list of CI instances that the query retrieved.
CMDBGraphWalkSelectorAndFilterList structure
The CMDBGraphWalkSelectorAndFilterList structure holds a list of attributes of
CMDBGraphWalkSelectorAndFilterStruct structures for a specified object.
typedef struct CMDBGraphWalkSelectorAndFilterList

{
CMDB_GRAPH_WALK_OBJECT_FLAG_DEFAULT objFlag;
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT attrFlag;
CMDBGraphWalkSelectorAndFilterStruct *objSelectorAndFilterList;
}CMDBGraphWalkSelectorAndFilterList;
The CMDBGraphWalkSelectorAndFilterList structure consists of the following elements:

objFlag
An integer value indicating the objects to retrieve in the query.

0 --If no specific objects are listed in the filter, select nothing (
CMDB_GRAPH_WALK_OBJECT_FLAG_DEFAULT_NONE ).
1 -- If no specific objects are listed in the filter, select all objects walked (
CMDB_GRAPH_WALK_OBJECT_FLAG_DEFAULT_ALL ).
attrFlag
An integer value indicating the type of attributes to select in the query.

0 -- If no specific attributes are listed in the filter, select nothing (
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_NONE ).
1 -- If no specific attributes are listed in the filter, select all non-hidden attributes (
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ NONHIDDEN ).
2 -- If no specific attributes are listed in the filter, select all attributes, hidden and non-hidden (
CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ALL ).
numItems
An integer value indicating the number of CMDBGraphWalkSelectorAndFilterStruct instances

in the list.
objSelectorAndFilterList
A pointer to the list of CMDBGraphWalkSelectorAndFilterStruct structures.
CMDBGraphWalkSelectorAndFilterStruct structure
The CMDBGraphWalkSelectorAndFilterStruct structure holds the filter criteria and the list of
attributes to retrieve in the graph walk query.
BMC Atrium Core 9.0
Page 1353 of 2268
Home
typedef struct CMDBGraphWalkSelectorAndFilterStruct

{
ARNameList *attributes;
CMDBQualifierStruct *qualification;
} CMDBGraphWalkSelectorAndFilterStruct;
The CMDBGraphWalkSelectorAndFilterStruct structure consists of the following elements:

classNameId
attributes
qualification
A pointer to the CMDBQualifierStruct structure, which holds the qualification for the query.
CMDBGraphWalkStateStruct structure
The CMDBGraphWalkStateStruct structure holds the information about all the objects walked in
the graph walk query. This structure is used for query chunking purposes. Therefore, the default
value of the structure members should not be modified.
typedef struct CMDBGraphWalkStateStruct

{
CMDBGraphWalkQueryStruct queryStruct;
CMDBGraphWalkObjectList walkedObjectList;
ARBoolean hasNextChunk;
unsigned int firstRetrieve;
unsigned int nextObjectIndex;
}CMDBGraphWalkStateStruct;
The CMDBGraphWalkStateStruct structure consists of the following elements:

queryStruct
A CMDBGraphWalkQueryStruct structure, which contains the qualifications for the graph walk query.
walkedObjectList
The list of objects walked in the query chunk.
hasNextChunk
A Boolean value that indicates whether the next chunk is available for querying. TRUE indicates that another
chunk is available.
firstRetrieve
The object to retrieve first in case chunking is required.
nextObjectIndex
The index in the walkedObjectList array for the parent node. This structure member is for internal use
only.
CMDBImportItem structure
Note
BMC Atrium Core 9.0
Page 1354 of 2268
Home
functions, CMDBImportData and CMDBImportDef.
The CMDBImportItem data structure holds the items to import for the specified item type.
typedef CMDBImportItem
{
union
{
CMDBItemTypeClass classItem;
CMDBItemTypeAttribute attributeItem;
}
}CMDBImportItem;
The CMDBImportItem structure consists of the following elements:

itemType
The type of item to import.

0 --No item to import (CMDB_ITEM_TYPE_NONE ).
1 --Import class (CMDB_ITEM_TYPE_CLASS ).
2 --Import attribute (CMDB_ITEM_TYPE_ATTRIBUTE ).
classItem
The class item to import.
attributeItem
The attribute item to import.
CMDBImportDataSummaryStruct structure
The CMDBImportDataSummaryStruct structure holds the status summary for an import
operation, such as the number of items to import, the total number of items that imported
successfully, and the number of items that failed.
typedef struct CMDBImportDataSummaryStruct {

unsigned int totalItemsToImport;
unsigned int totalItemsImportSuccess;
unsigned int totalItemsToImportFail;
}CMDBImportDataSummaryStruct;
The CMDBImportDataSummaryStruct structure consists of the following elements:

totalItemsToImport
An integer value indicating the number of items to import in the operation.
totalItemsImportSuccess
An integer value indicating the total number of items that were successfully imported out of the
original list of items.
totalItemsImportFail
An integer value indicating the total number of items that failed to import successfully.
BMC Atrium Core 9.0
Page 1355 of 2268
Home
CMDBImportItemStruct structure
Note
functions, CMDBImportData and CMDBImportDef.
The CMDBImportItemStruct data structure holds the items to import.
typedef struct CMDBImportItemStruct

{
unsigned long importOption;
} CMDBImportItemStruct;
The CMDBImportItemStruct structure consists of the following elements:

itemType
An integer value indicating the type of information to import.

1 --Import class definitions (meta data) ( CMDB_ITEM_TYPE_META_DATA ).
2 --Import instance data (CMDB_ITEM_TYPE_INSTANCE_DATA )
classNameId
The namespace name and the class name of the class that contains the items to import.
importOption
An integer value indicating how the import of instances is handled if any duplicates are found during the import.
These option values are mutually exclusive.
This option is applicable only if CMDB_ITEM_TYPE_META_DATA is set.
1 --Generate an error (AR_MERGE_ENTRY_DUP_ERROR ).
2 --Create a new entry with a new ID if the Entry ID attribute and the ID specified already exist in the target
class (AR_MERGE_ENTRY_DUP_NEW_ID ).
3 --Delete the existing entry and create a new entry in its place if the Entry ID attribute and the ID specified
already exist in the target class (AR_MERGE_ENTRY_DUP_OVERWRITE ).
4 --Update the attributes specified in the existing entry if the Entry ID attribute and the ID specified already
exist in the target class (AR_MERGE_ENTRY_DUP_MERGE ).
5 --Create an entry with a new ID ( AR_MERGE_ENTRY_NEW_ID ).
These constants are the same as used by the ARMergeEntry function in the BMC Atrium Core C
API. For more information, see the BMC Atrium Core ar.h file.|
CMDBIndexList structure
The CMDBIndexList structure holds index information for the class.
typedef struct CMDBIndexList
BMC Atrium Core 9.0
Page 1356 of 2268
Home
{
CMDBIndexStruct *indexList;
} CMDBIndexList;
The CMDBIndexList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBIndexStruct items in the list.
indexList
The set of zero or more CMDBIndexStruct items defined for the class. Each index can include from 1 to 16
attributes (limited by AR_MAX_INDEX_subclasses ). Diary attributes and character attributes larger than 255 bytes
cannot be indexed.
CMDBIndexStruct structure
The CMDBIndexStruct structure holds the attributes to index.
typedef struct CMDBIndexStruct

{
unsigned int numAttributes;
ARNameType attributeName[AR_MAX_INDEX_subclasses];
ARBoolean unique;
ARBoolean isPrimaryKey;
ARNameType indexName;
} CMDBIndexStruct;
The CMDBIndexStruct structure consists of the following elements:

numAttributes
An integer value indicating the number of attributes to index.
attributeName
The names of attributes to index.
unique
A Boolean value indicating if the index key must be unique:

TRUE --The index key is unique.
FALSE --The index key is not unique.
isPrimaryKey
A Boolean value indicating whether to make this index a primary key index:
TRUE --The index key is a primary key index.
FALSE --The index key is not a primary key index.
indexName
The name of the index.
CMDBInstanceList structure
The CMDBInstanceList structure holds a list of CMDBInstanceStruct structures.
typedef struct CMDBInstanceList

{
BMC Atrium Core 9.0
Page 1357 of 2268
Home

CMDBInstanceStruct *instanceList;
} CMDBInstanceList;
The CMDBInstanceList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBInstanceStruct items in the list.
instanceList
The list of CMDBInstanceStruct structures.
CMDBInstanceStruct structure
The CMDBInstanceStruct structure holds a list of attribute values for a specified class and
instance.
typedef struct CMDBInstanceStruct

{
} CMDBInstanceStruct;
The CMDBInstanceStruct structure consists of the following elements:

classNameId
instanceId
The instance for which the attribute values are specified.
attributeValueList
The list of attribute values for the instance. The values in this list are ignored for the Delete operation.
CMDBItemTypeAttribute structure
The CMDBItemTypeAttribute data structure holds a list of attribute information.
typedef struct CMDBItemTypeAttribute

{
ARNameList attribNameList;
}CMDBItemTypeAttribute;
The CMDBItemTypeAttribute structure consists of the following elements:

classNameId
The ID for the class.
attributeNameList
The list of attribute names.
BMC Atrium Core 9.0
Page 1358 of 2268
Home
CMDBItemTypeClass structure
The CMDBItemTypeClass data structure holds the class name information.
typedef struct CMDBItemTypeClass

{
}CMDBItemTypeClass;
The CMDBItemTypeClass structure consists of the following element:

classNameId
The ID for the class.
CMDBNestedQueryStruct structure
The CMDBNestedQueryStruct structure holds the query condition and class details to select from
the result list.
typedef struct CMDBNestedQueryStruct

{
CMDBQueryObjectList *queryObjects;
CMDBQueryObjectList *queryObjectsOptional;
CMDBQueryObjectSelector *queryObjectToSelect;
} CMDBNestedQueryStruct;
The CMDBNestedQueryStruct structure consists of the following elements:

queryObjects
A pointer to the CMDBQueryObjectList structure, which is used to formulate the query. The values in
this structure provide the initial condition for the recursive query. The query is formulated based on the
sequence in which the objects are listed.
queryObjectsOptional
A pointer to the CMDBQueryObjectList structure, which specifies the optional qualifications for the
query. For example, when querying for all computer systems in an organization, you might also want to
retrieve the printers to which these computer systems are connected. A computer system might not
inaccessibly be connected to a printer, in which case returning a printer becomes optional.
queryObjectsToSelect
The CMDBQueryObjectSelectorStruct instance that contains the class name and attribute to
select from the result that met the required condition.
CMDBQualifierStruct structure
The CMDBQualifierStruct structure holds the qualifier structure for the query based on the
qualifier type that is specified.
typedef struct CMDBQualifierStruct

{
unsigned int qualifierType;
union
BMC Atrium Core 9.0
Page 1359 of 2268
Home
{
char *qualifierString;
ARQualifierStruct qualifierStruct;
} u;
} CMDBQualifierStruct;
The CMDBQualifierStruct structure consists of the following elements:

qualifierType
An integer value indicating the type of qualifier.

1 --The qualifier is a string ( CMDB_QUALIFIER_TYPE_STRING )
2 --The qualifier is a structure ( CMDB_QUALIFIER_TYPE_STRUCT )
qualifierString
The qualification in string format. The qualification string can include one or more attributes and any combination
of conditional, relational, and arithmetic (numeric data types only) operations.
qualifierStruct
The qualification in structure format.
CMDBQueryArithOpStruct structure
The CMDBQueryArithOpStruct structure is used to specify the arithmetic operation to perform in
the query qualification. This structure also holds the left and right operands to use in the
qualification.
typedef struct CMDBQueryArithOpStruct

{
CMDB_QUERY_QUAL_ARITH_OP_TYPE operation;
struct CMDBQueryQualifierValueStruct *operandLeft;
struct CMDBQueryQualifierValueStruct *operandRight;
} CMDBQueryArithOpStruct;
The CMDBQueryArithOpStruct structure consists of the following elements:

operation
Specifies the arithmetic operation to perform in the query.

1 -- Addition (+) (CMDB_QUERY_QUAL_ARITH_OP_ADD ).
2 -- Subtraction (-) (CMDB_QUERY_QUAL_ARITH_OP_SUBTRACT ).
3 -- Multiplication (*) (CMDB_QUERY_QUAL_ARITH_OP_MULTIPLY ).
4 -- Division (/) (CMDB_QUERY_QUAL_ARITH_OP_DIVIDE ).
5 -- Modulus (%) (CMDB_QUERY_QUAL_ARITH_OP_MODULO ).
6 -- Negate, for example, the value of +5 is converted to -5 ( CMDB_QUERY_QUAL_ARITH_OP_NEGATE ).
operandLeft
Specifies the operand that appears to the left of the arithmetic operator. For example, for an expression of salary
/100, salary is specified in operandLeft.
operandRight
Specifies the operand that appears to the right of the arithmetic operator. From the operandLeft example, 100
is specified in operandRight.
BMC Atrium Core 9.0
Page 1360 of 2268
Home
CMDBQueryAttributeName structure
The CMDBQueryAttributeName structure holds the attribute name to return in the query.
typedef struct CMDBQueryAttributeName

{
ARNameType classAlias;
} CMDBQueryAttributeName;
The CMDBQueryAttributeName structure consists of the following elements:

This alias name for the class that is specified in the CMDBQueryObject structure. The alias must be unique
classAlias
across all CMDBQueryObject objects.

attributeName
The name of the attribute to specify in the query qualification.
CMDBQueryCardinality structure
The CMDBQueryCardinality structure holds the range definition for the relationship to walk in
the query. If you require the CMDBQueryByPath function to return all BMC_ComputerSystem CIs
that are connected to three or less BMC_DiskDrive CIs, set the minCount member to 1 and the
MaxCount member to 3.
typedef struct CMDBQueryCardinality

{
int minCount;
int maxCount;
}CMDBQueryCardinality;
The CMDBQueryCardinality structure consists of the following elements:

minCount
.An integer value indicating the minimum number of CI endpoints to match for a given CI in the query. A value of
zero for this member indicates that the query qualification will be ignored and only the CI specified in the selection
criteria will be returned.
For example, if you require the query to return all BMC_ComputerSystem CIs that are connected to one or less
BMC_Printer CIs, set the minCount member to 0.
maxCount
.An integer value indicating the maximum number of CI endpoints to match for a given CI in the query. Specify a
value in this member that is greater than minCount.
For example, if you require the query to return all BMC_ComputerSystem CIs that are connected to five or less
BMC_Printer CIs, set the maxCount member to 5. If you set maxCount to 0, the query will yield incorrect results.
BMC Atrium Core 9.0
Page 1361 of 2268
Home
CMDBQueryObject structure
The CMDBQueryObject structure holds the qualification for the query, such as whether to retrieve
a CI or a relationship class and how many levels to walk in the graph.
typedef struct CMDBQueryObject

{
ARNameType alias;
ARNameType sourceNodeAlias;
CMDBQueryQualifierStruct *qualification;
CMDB_QUERY_OBJECT_TYPE queryObjectType;
CMDB_QUERY_JOIN_TYPE joinType;
CMDBQueryQualifierStruct *joinQualification;
union
{
CMDBQueryObjectRelationship relationshipInfo
} u;
} CMDBQueryObject;
The CMDBQueryObject structure consists of the following elements:

classNameId
The class name and namespace of the instance to query.
alias
The alias name for the class that is specified in the CMDBQueryObject structure. The alias must be unique
sourceNodeAlias
The alias name of the source CI class for which the related endpoints are requested in the query. Specify this
parameter when requesting multiple relationships for a given CI class. This member is not required for
querying linear relationships in the format C->R->C.
If the value in this member is NULL, the previous node in the query graph is the source node by default.
qualification
The CMDBQueryQualifierStruct structure that holds the qualification for the query.
queryObjectType
An integer value that specifies whether the query object to retrieve is a CI (regular) or a relationship class.
1 --The class type is regular (CMDB_CLASS_TYPE_REGULAR ).
2 --The class type is relationship (CMDB_CLASS_TYPE_RELATIONSHIP ).
joinType
The type of join to execute in the query for any two consecutive query objects in the query object list. You can
create an explicit join to relate any two CIs, even if they do not have a relationship class connecting them.
-1 --No explicit Join type to perform in the query
(CMDB_QUERY_JOIN_TYPE_NONE = -1 ). If no explicit Join type is specified, an INNER join is
performed in the query, using the relationship attributes in the qualification.
0 --The Join type to perform in the query is Inner join.
(CMDB_QUERY_JOIN_TYPE_INNER = 0 ).
1 --The Join type to perform in the query is Left Outer join.
(CMDB_QUERY_JOIN_TYPE_LEFT = 1 ).
2 --The Join type to perform in the query is Right Outer join.
(CMDB_QUERY_JOIN_TYPE_RIGHT = 2 ).
BMC Atrium Core 9.0
Page 1362 of 2268
Home
joinQualification
The explicit join condition to execute in the query in conjunction with the joinType.
For example, to determine the impact relationships for the C1 class in the query C1->R1->C2, the joinType
of R1 is specified as Inner and the join qualification is specified as C1.instanceid= R1.
impactdestinationid. The joinType of C2 is Inner and the join qualification is C2.instanceid = R2.
impactsourceid.
relationshipInfo
A CMDBQueryObjectRelationship object that defines the direction to walk in the graph and the minimum
and maximum number of relationships to return for the specified CI class.
CMDBQueryObjectList structure
The CMDBQueryObjectList structure holds a list of CMDBQueryObject structures. Depending
on the complexity of the query, CMDBQueryObjectList can have multiple CMDBQueryObject
structures. The first query object in the list should always be a CI, followed by a relationship object,
and then a CI object again. This object structure is represented by C->(R->C)* , where (R->C)
can occur more than once.
typedef struct CMDBQueryObjectList

{
CMDBQueryObject *queryObjectlist;
} CMDBQueryObjectList;
The CMDBQueryObjectList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBQueryObject items in the list.
queryObjectList
The list of CMDBQueryObject structures.
CMDBQueryObjectRelationship structure
The CMDBQueryObjectRelationship structure holds the information about the relationship,
such as the direction and the number of relationships to traverse in the query.
typedef struct CMDBQueryObjectRelationship

{
unsigned int direction;
CMDBQueryCardinality downstreamCardinality;
} CMDBQueryObjectRelationship;
The CMDBQueryObjectRelationship structure consists of the following elements:

direction
The direction of the relationship map to traverse if the class type in the queryObjectType parameter
is relationship.
0 --Relationship of a CI where the given CI is the source (on the left), arrow coming out from the
node
BMC Atrium Core 9.0
Page 1363 of 2268
Home
(CMDB_RELATIONSHIP_DIRECTION_OUT ).
1 --Relationship of a CI where the given CI is the destination (on the right), arrow pointing at the
node (CMDB_RELATIONSHIP_DIRECTION_IN ).
downstreamCardinality
A CMDBQueryCardinality object that contains information about the number of relationships to

traverse in the query.
CMDBQueryObjectSelectorList structure
The CMDBQueryObjectSelectorList structure holds a list of CMDBQueryObjectSelector
structures. Depending on the list of attributes and values requested in the query result, the
CMDBQueryObjectSelectorList structure can have multiple CMDBQueryObjectSelector
items.
typedef struct CMDBQueryObjectSelectorList

{
CMDBQueryObjectSelector *queryObjectSelectorList;
unsigned int flags;
} CMDBQueryObjectSelectorList;
The CMDBQueryObjectSelectorList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBQueryObjectSelector items in the list.
queryObjectSelectorList
The list of CMDBQueryObjectSelector structures.
flags
Specifies the attributes to retrieve in the query.

0 --The attributes to fetch are none. The query fetches the instance ID attribute by default
when the flag is set to this option. ( CMDB_QUERY_OBJECTSELECTOR_FLAG_DEFAULT_NONE )
.
2 --The query fetches all non-hidden attributes (
CMDB_QUERY_OBJECTSELECTOR_FLAG_DEFAULT_NONHIDDEN ).
3 --The query fetches all hidden and non-hidden attributes (
CMDB_QUERY_OBJECTSELECTOR_FLAG_DEFAULT_ALL ).
CMDBQueryObjectSelectorStruct structure
The CMDBQueryObjectSelector structure holds the list of attributes to retrieve from the query
result.
typedef struct CMDBQueryObjectSelectorStruct

{
ARNameType alias;
ARNameList *attributes;
} CMDBQueryObjectSelectorStruct;
BMC Atrium Core 9.0
Page 1364 of 2268
Home
The CMDBQueryObjectSelectorStruct structure consists of the following elements:

The alias name for the class that is specified in the CMDBQueryObject structure. The alias must be unique across
alias
all CMDBQueryObject and queryObjectsOptional objects.

attributes
The list of attributes to return for the given class referred by the alias.
CMDBQueryQualifierAndOrStruct structure
The CMDBQueryQualifierAndOrStruct structure holds the left and right operands of a query.
typedef struct CMDBQueryQualifierAndOrStruct

{
struct CMDBQueryQualifierStruct *operandLeft;
struct CMDBQueryQualifierStruct *operandRight;
} CMDBQueryQualifierAndOrStruct;
The CMDBQueryQualifierAndOrStruct structure consists of the following elements:

operandLeft
The CMDBQueryQualifierStruct instance that contains the value that appears to the left of the AND or OR
logical condition. For example, in the qualification, Type = "Operating system" AND Model = "
Microsoft Windows XP", the Type qualification is specified in operandLeft.
operandRight
The CMDBQueryQualifierStruct instance that contains the value that appears to the right of the AND or OR
logical operator. For example, in the qualification,Type = "Operating system" AND Model = "
Microsoft Windows XP", the Model qualification is specified in operandRight.
CMDBQueryQualifierSetOpStruct structure
The CMDBQueryQualifierSetOpStruct structure is used to specify the attribute and right
operand for an IN or NOT IN type of operation.
typedef struct CMDBQueryQualifierSetOpStruct

{
ARNameType attribute;
CMDBQueryQualifierValueSetStruct *operandRight;
} CMDBQueryQualifierSetOpStruct;
The CMDBQueryQualifierSetOpStruct structure consists of the following elements:

operation
An integer value indicating the type of SET operation to perform in the query.
8 --An IN operation to perform in the query, for example, Model IN "Microsoft Windows XP", "
Microsoft Windows 2003", "Microsoft Windows 2000" (CMDB_QUERY_QUAL_SETOP_IN).
9 --A NOT IN operation to perform in the query, for example, Model NOT IN "Microsoft Windows
XP", "Microsoft Windows 2003", "Microsoft Windows 2000" (
CMDB_QUERY_QUAL_SETOP_NOT_IN ).
BMC Atrium Core 9.0
Page 1365 of 2268
Home
attribute
The name of the attribute in the qualification that should match a specific value, for example, ClassName =
BMC_ComputerSystem. In this example, ClassName, will be specified in attribute, which is the left operand
in the expression.
operandRight
A pointer to the CMDBQueryQualifierValueSetStruct structure, which contains the list of values or query
for the Set operation.
CMDBQueryQualifierSimpleOpStruct structure
The CMDBQueryQualifierSimpleOpStruct structure holds the attribute and the right operand
for a SIMPLE type of operation.
typedef struct CMDBQueryQualifierSimpleOpStruct

{
ARNameType attribute;
CMDBQueryQualifierValueStruct *operandRight;
} CMDBQueryQualifierSimpleOpStruct;
The CMDBQueryQualifierSimpleOpStruct structure consists of the following elements:

operation
An integer value indicating the type of relational or inequality operation to perform in the query.
1 --Equal to (=) (CMDB_QUERY_QUAL_SIMPLEOP_EQUAL ).
2 --Greater than (>) (CMDB_QUERY_QUAL_SIMPLEOP_GREATER ).
3 --Greater than or equal to (> =) ( CMDB_QUERY_QUAL_SIMPLEOP_GREATER_EQUAL ).
4 --Less than (<) (CMDB_QUERY_QUAL_SIMPLEOP_LESS ).
5 --Less than or equal to (< =) ( CMDB_QUERY_QUAL_SIMPLEOP_LESS_EQUAL ).
6 --Not equal to (!=) ( CMDB_QUERY_QUAL_SIMPLEOP_NOT_EQUAL ).
7 --Like (Like) (CMDB_QUERY_QUAL_SIMPLEOP_LIKE ).
attribute
The name of the attribute in the qualification that should match a specific value, for example, ClassName =
BMC_ComputerSystem. In this example, ClassName will be specified in attribute.
operandRight
A pointer to the CMDBQueryQualifierValueStruct, which specifies the type of qualifier operand that
appears to the right of the relational or inequality operator.
1 -- The right operand is a value, for example, ClassName = BMC_ComputerSystem. In this example,
BMC_ComputerSystem will be specified in operandRight (CMDB_QUERY_QUAL_VALUE_TYPE_VALUE )
.
2 -- The right operand is an attribute name, which can be of the current query object class or of another
class, for example, ClassName = A1.ClassName. In this example, A1.ClassName will be specified in
operandRight (CMDB_QUERY_QUAL_VALUE_TYPE_ATTRIBUTENAME ).
3 -- The right operand is an arithmetic expression, for example, QtyInStock = 90/100. In this example
, the arithmetic operator / will be specified in the operandRight (
CMDB_QUERY_QUAL_VALUE_TYPE_ARITHMETIC ).
BMC Atrium Core 9.0
Page 1366 of 2268
Home
CMDBQueryQualifierStruct structure
The CMDBQueryQualifierStruct structure holds the qualification for the query. CIs and
relationships that the query returns depend on the qualification specified in this structure. This is a
top-level structure that holds the query qualifications.
typedef struct CMDBQueryQualifierStruct

{
CMDB_QUERY_QUAL_OP_TYPE operation;
union
{
CMDBQueryQualifierAndOrStruct andor;
struct CMDBQueryQualifierStruct *notQual;
CMDBQueryQualifierSimpleOpStruct *simpleOp;
CMDBQueryQualifierSetOpStruct *setOp;
} u;
} CMDBQueryQualifierStruct;
The CMDBQueryQualifierStruct structure consists of the following elements:

operation
Specifies the type of logical operation to perform in the query. Depending on the option that is set for operation,
specify the value for any one of the other members in the structure.
0 -- No logical operation to perform in the query ( CMDB_QUERY_QUAL_OP_NONE )
1 -- The logical operation to perform in the query is AND ( CMDB_QUERY_QUAL_OP_AND ).
2 -- The logical operation to perform in the query is OR ( CMDB_QUERY_QUAL_OP_OR ).
3 -- The logical operation to perform in the query is NOT, for example, " != " (CMDB_QUERY_QUAL_OP_NOT ).
4 -- The logical operation to perform in the query is SIMPLE ( CMDB_QUERY_QUAL_OP_SIMPLE ).
5 -- The logical operation to perform in the query is SET ( CMDB_QUERY_QUAL_OP_SET ).
andor
A CMDBQueryQualifierAndOrStruct structure that specifies the left and right operand in a AND or OR logical
operation if operation is set to either CMDB_QUERY_QUAL_OP_AND or CMDB_QUERY_QUAL_OP_OR.
notQual
A CMDBQueryQualifierStruct structure that specifies the != condition for the logical operation if operation is
set to CMDB_QUERY_QUAL_OP_NOT.
simpleOp
A CMDBQueryQualifierSimpleOpStruct structure that specifies the simple logical operation to perform, for
example,=, <, or >.
setOp
A CMDBQueryQualifierSetOpStruct structure that specifies the IN, or NOT IN operation to perform, for example
, Model NOT IN "Microsoft Windows XP", "Microsoft Windows 2003", "Microsoft Windows
2000".
CMDBQueryQualifierValueSetStruct structure
The CMDBQueryQualifierValueSetStruct structure holds literal values or the query
statement for a nested query.
typedef struct CMDBQueryQualifierValueSetStruct

{
BMC Atrium Core 9.0
Page 1367 of 2268
Home
unsigned int type;

union
{
ARValueList valueSet;
struct CMDBNestedQueryStruct *query;
} u;
} CMDBQueryQualifierValueSetStruct;
The CMDBQueryQualifierValueSetStruct structure consists of the following elements:

Specifies the type of query value for a SET operation. Depending on the option that is set for type, specify the value
type
for any one of the other members in the structure.

1 -- A set of values specified to compare against in the nested query (
CMDB_QUERY_QUAL_VALUESET_TYPE_VALUESET ).
2 -- The inner query to use in the nested query statement ( CMDB_QUERY_QUAL_VALUESET_TYPE_QUERY ).
The list of literal values for the SET query statement, for example, Model IN "Microsoft Windows XP", "
valueSet
Microsoft Windows 2003", "Microsoft Windows 2000".

This member is filled in if type is set to 1.
A pointer to the CMDBNestedQueryStruct structure that holds the inner query in a nested query, for example, "
query
Select computerId from ComputerSystem where locationId in (select locId from

PhysicalLocation where LocName != "Sunnyvale")".
This member is filled in if type is set to 2.
CMDBQueryQualifierValueStruct structure
The CMDBQueryQualifierValueStruct structure holds the set of values and query conditions
for a nested query.
typedef struct CMDBQueryQualifierValueStruct

{
CMDB_QUERY_QUAL_VALUE_TYPE type;
union
{
ARValueStruct value;
CMDBQueryAttributeName attributeName;
CMDBQueryArithOpStruct arithOp;
} u;
} CMDBQueryQualifierValueStruct;
The CMDBQueryQualifierValueStruct structure consists of the following elements:

type
Specifies the object type for the structure instance that appears to the right of the logical operator. Depending on
the option that is set for type, specify the value for any one of the other members in the structure.
1 -- The right operand is a value( CMDB_QUERY_QUAL_VALUE_TYPE_VALUE ).
2 -- The right operand is an attribute name of a class (
CMDB_QUERY_QUAL_VALUE_TYPE_ATTRIBUTENAME ).
3 -- The right operand is an arithmetic expression ( CMDB_QUERY_QUAL_VALUE_TYPE_ARITHMETIC ).
BMC Atrium Core 9.0
Page 1368 of 2268
Home
value
The literal value for the query if type is set to CMDB_QUERY_QUAL_VALUE_TYPE_VALUE.
attributeName
A CMDBQueryAttribteName structure that specifies the attribute name for the query if the type is set to
CMDB_QUERY_QUAL_VALUE_TYPE_ATTRIBUTENAME.
arithOp
The CMDBQueryArithOpStruct structure for the query if type is set to

CMDB_QUERY_QUAL_VALUE_TYPE_ARITHMETIC. The structure holds the arithmetic operator and value for the
attribute, for example, / 100.
CMDBQueryResultGraph structure
The CMDBQueryResultGraph structure is used to return the query results in a list or a graph
format depending on the format requested.
typedef struct CMDBQueryResultGraph

{
CMDB_QUERY_RESULT_FORMAT_TYPE formatType;
unsigned int *numMatches;
ARNameList aliasOrderForListFormat;
union
{
CMDBInstanceList *instanceListList;
CMDBGraphQueryResult *graphQueryResult;
} u;
} CMDBQueryResultGraph;
The CMDBQueryResultGraph structure consists of the following elements:

formatType
The format in which to return the CI and relationships that match the query criteria.
0 --The query results are returned in a list or linear format (
CMDB_QUERY_RESULT_STRUCT_FORMAT_LIST ).
1 --The query results are divided in two parts: a list of CI nodes and a list of relationship edges
, which helps in constructing a CI and relationship graph (
CMDB_QUERY_RESULT_STRUCT_FORMAT_CMDB_GRAPH ).
2 --The query results are returned in a graph format if the number of rows that matches the
criteria is within the chunk size. The results are returned in a list format if the number of rows
that matches is greater than the chunk size (
CMDB_QUERY_RESULT_STRUCT_FORMAT_CHUNK_BASED ).
numItems
An integer value indicating the number of CMDBInstanceList items returned by the query if the
format type requested is CMDB_QUERY_RESULT_STRUCT_FORMAT_LIST.
numMatches
A pointer to the numMatches member that holds the number of CI and relationship instances that the
query matched. This member contains a NULL value if the numMatches member of the
CMDBQueryStruct structure is set to FALSE.
aliasOrderForListFormat
The order of query object aliases to which the row of instances belong in the results that are returned
.
For example, if you specify alias order as "personqueryobj, computersqueryobj, monitorsqueryobj" in
BMC Atrium Core 9.0
Page 1369 of 2268
Home
the selector list and instruct the query to return instance IDs for them, the alias order associates the
instances IDs in the result row with query object in the selector list.
The alias order is applicable only to the list format type.
The list of CMDBInstanceList structures that hold the CIs and relationships returned by the query
instanceListList
in a list or linear format.

graphQueryResult
A pointer to the top-level query result structure that holds the query results if the format type
requested is CMDB_QUERY_RESULT_STRUCT_FORMAT_CMDB_GRAPH.
CMDBQuerySortStruct structure
The CMDBQuerySortStruct structure is used to sort the results that the CMDBQuery function
returns, based on the attribute specified in the CMDBQuerySortStruct structure.
typedef struct CMDBQuerySortStruct

{
ARNameType alias;
unsigned int sortorder;
} CMDBQuerySortStruct;
The CMDBQuerySortStruct structure consists of the following elements:

alias
This alias name for the class that is specified in the CMDBQueryObject structure. The alias must be unique
attributeName
The attribute name on which to sort the result list that the query returns.
Make sure that the attributes you specify belong to the CI nodes that are a part of the query inputs. Otherwise,
the sort functionality might not yield results.
sortOrder
An integer value indicating the sort order for the attribute.

1 -- The attribute is sorted in ascending order ( CMDB_QUERY_SORT_ASCENDING ).
2 -- The attribute is sorted in descending order ( CMDB_QUERY_SORT_DESCENDING ).
CMDBQuerySortList structure
The CMDBQuerySortList structure holds a list of CMDBQuerySortStruct structures.
typedef struct CMDBQuerySortList

{
CMDBQuerySortStruct *querySortList;
} CMDBQuerySortList;
The CMDBQuerySortList structure consists of the following elements:

numItems
BMC Atrium Core 9.0
Page 1370 of 2268
Home
An integer value indicating the number of CMDBQuerySortStruct items in the list.

querySortList
The list of attributes and their sort orders, which is the basis for sorting the results that the query returns.
CMDBQueryStruct structure
The CMDBQueryStruct structure holds a list of query objects with qualification for the instances to
retrieve. This is a top-level structure, which is used in the CMDBQueryByPath function.
typedef struct CMDBQueryStruct

{
ARNameType datasetId;
unsigned int datasetMask;
CMDBQueryObjectList *queryObjects;
CMDBQueryObjectOptionalList *queryObjectsOptional;
CMDBQueryObjectSelectorList *queryObjectsToSelect;
unsigned int firstRetrieve;
unsigned int maxRetrieve;
CMDB_QUERY_STRUCT_MASK_TYPE queryMask;
CMDBQuerySortList querySortList;
ARBoolean numMatches;
} CMDBQueryStruct;
The CMDBQueryStruct structure consists of the following elements:

datasetId
The ID of the dataset from which to retrieve the instances.
datasetMask
An integer value that specifies the dataset type for the query.
0 -- Based on the datasetId passed, instances are retrieved from either the overlay or the
1 << 0 --Allows you to retreive instances from the current dataset only .(
queryObjects
A pointer to CMDBQueryObjectList, which contains a list of CMDBQueryObject structures that

specify the qualifications for the instance to retrieve.
A pointer to the CMDBQueryObjectList structure, which specifies the optional qualifications for the
query. For example, when querying for all computer systems in an organization, you might also want to
retrieve the printers to which these computer systems are connected. A computer system might not be
connected to a printer, in which case returning a printer becomes optional.
queryObjectsToSelect
A pointer to CMDBQueryObjectSelectorList, which contain the class name and attributes to select
from each instance in the result that met the required condition.
firstRetrieve
The first object to retrieve from the list of objects returned.
maxRetrieve
The maximum number of objects to retrieve from the list of objects returned.
queryMask
An integer value that specifies the properties for returning the query results.
0 --The query results are returned in a list or linear format (
CMDB_QUERY_RESULT_STRUCT_FORMAT_LIST ).
BMC Atrium Core 9.0
Page 1371 of 2268
Home
1 --The query results are divided in two parts: a list of CIs nodes and a list of relationship edges,
which helps in constructing a CI and relationship graph (
CMDB_QUERY_RESULT_STRUCT_FORMAT_CMDB_GRAPH ).
2 --The query results are returned in a graph format if the number of rows that matches the
criteria is within the chunk size. The results are returned in a list format if the number of rows that
matches is greater than the chunk size (
CMDB_QUERY_RESULT_STRUCT_FORMAT_CHUNK_BASED ).
querySortList
The list of attributes and the sort orders, based on which the query results are returned.
numMatches
A Boolean value indicating whether to return the total number of CI and relationship instances that the
call matched in the query.
TRUE --Return the number of instances that match the query.
FALSE --No matched instances to return.
CMDBGraphQueryResult structure
The CMDBGraphQueryResult structure holds the results that the CMDBQueryByPath function
returns. The query returns the results in a graph format or a linear format. When requested in a
graph format, the query results are grouped and stored in two parts: CIs and relationships.
If the query result contains a CI with two different relationships, the CI list will includes only one
entry for the specific CI. For example, if a BMC_Printer instance is connected to two different
BMC_ComputerSystem instances, the BMC_Printer instance is listed only once.
The CMDBGraphQueryResult structure is a top-level result structure, which uses
CMDBNodeListList to store the list of CIs and CMDBEdgeListList to store the list of
relationships to return for the query results.
typedef struct CMDBGraphQueryResult

{
CMDBNodeListList nodeListList;
CMDBEdgeListList edgeListList;
} CMDBGraphQueryResult;
The CMDBGraphQueryResult structure consists of the following elements:

nodeListList
The list of CMDBNodeListList structures that hold the CIs returned in the query.
edgeListList
The list of CMDBEdgeListList structures that hold the relationships returned in the query.
CMDBStdEdgeResult structure
The CMDBStdEdgeResult structure holds the relationship part of the query result.
typedef struct CMDBStdEdgeResult

{
BMC Atrium Core 9.0
Page 1372 of 2268
Home
ARNameType alias;
CMDBStdRelationshipList relationshipList;
} CMDBStdEdgeResult;
The CMDBStdEdgeResult structure consists of the following elements:

alias

relationshipList
The CMDBStdRelationshipList structure that holds the relationship part of the query result.
CMDBEdgeListList structure
The CMDBEdgeListList structure holds a list of CMDBRelationshipResultList structures
that store the relationship part of the query result.
typedef struct CMDBEdgeListList

{
CMDBRelationshipResultList *relationshipResultList;
} CMDBEdgeListList;
The CMDBEdgeListList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBRelationshipResultList items in the list.
relationshipResultList
A pointer to the CMDBRelationshipResultList structure that holds the relationship part of the query
result.
CMDBNodeList structure
The CMDBNodeList structure holds the CI part of the query result.
typedef struct CMDBNodeList

{
ARNameType alias;
CMDBInstanceList instanceList;
} CMDBNodeList;
The CMDBNodeList structure consists of the following elements:

alias
instanceList
A list of CMDBInstanceStruct structures that hold the attribute values for a specified class and instance.
BMC Atrium Core 9.0
Page 1373 of 2268
Home
CMDBNodeListList structure
The CMDBNodeListList structure holds a list of CMDBNodeList structures that store the CI part
of the query result.
typedef struct CMDBNodeListList

{
CMDBNodeList *nodeList;
} CMDBNodeListList;
The CMDBNodeListList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBNodeList items in the list.
nodeList
A pointer to the CMDBNodeList structure that holds the CI part of the query result.
CMDBRelationshipResult structure
The CMDBRelationshipResult structure holds the source instance ID, destination instance ID,
and a pointer to the relationship object for the relationship instances returned in the query results
for the specified CI.
typedef struct CMDBRelationshipResult

{
ARNameType srcInstanceId;
ARNameType destInstanceId;
CMDBInstanceStruct *relationshipInstance;
} CMDBRelationshipResult;
The CMDBRelationshipResult structure consists of the following elements:

srcInstanceId
The source instance ID in the relationship.
destinationInstanceId
The destination CI in the relationship.
relationshipInstance
A pointer to the CMDBInstanceStruct structure that holds the relationship instance information.
CMDBRelationshipResultList structure
The CMDBRelationshipResultList structure holds a list of CMDBRelationshipResult
structures that store the relationship information for the results returned by the query.
typedef struct CMDBRelationshipResultList

{
ARNameType alias;
BMC Atrium Core 9.0
Page 1374 of 2268
Home
CMDBRelationshipResult *relationshipInstance;
} CMDBRelationshipResultList;
The CMDBRelationshipResultList structure consists of the following elements:

The alias name for the class that is specified in the CMDBQueryObject structure. The alias must be
alias
unique across all CMDBQueryObject objects.

numItems
An integer value indicating the number of CMDBRelationshipResult items in the list.
relationshipInstance
A pointer to the CMDBRelationshipResult structure that holds the source instance ID and destination
instance ID information for the relationships returned in the query.
CMDBREClassQualList structure
The CMDBREClassQualList data structure holds a list of CMDBREClassQualStruct structures.
typedef struct CMDBREClassQuaList

{
CMDBREClassQualStruct *classQualList;
}CMDBREClassQuaList;
The CMDBREClassQualList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBREClassQualStruct structure items in the list.
classQualList
A list of CMDBClassQualStruct structures.
CMDBREClassQualStruct structure
The CMDBREClassQualStruct data structure holds information about the class qualification.
typedef struct CMDREBClassQualStruct

{
ARNameType classId;
CMDBQualifierStruct *qual;
}CMDBREClassQualStruct;
The CMDBREClassQualStruct structure consists of the following elements:

classId
The ID of the class.
qual
The qualification for the class. If the qualification contains a null value, all the instances in the class are reconciled.
CMDBREDatasetList structure
The CMDBREDatasetList data structure holds a list of CMDBREDatasetPair structures.
BMC Atrium Core 9.0
Page 1375 of 2268
Home
typedef Struct CMDBREDatasetList

{
Unsigned int numItems;
CMDBREDatasetPair *datasetList;
}CMDBREDatasetList;
The CMDBREDatasetList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBREDatasetPair items in the list.
datasetList
A list of CMDBREDatasetPair items.
CMDBREDatasetPair structure
The CMDBREDatasetPair data structure holds information about the datasets to use in the
reconciliation job.
typedef Struct CMDBREDatasetPair

{
ARNameType workingDataset;
ARNameType dataset;
}CMDBREDatasetPair;
The CMDBREDatasetPair structure consists of the following elements:

workingDataset
The dataset name of the working dataset. If this field contains a Null, the dataset for the reconciliation job is
replaced with workingDataset before reconciliation.
dataset
The dataset for the reconciliation job. If the workingDataset field in the structure contains a Null, the dataset
specified in this field is used.
CMDBREJobRunInfo structure
The CMDBREJobRunInfo data structure holds information about a currently running Reconciliation
Engine job.
typedef struct CMDBREJobRunInfo

{
ARNameType jobRunId;
ARNameType jobInstanceId;
ARNameType jobName;
ARTimestamp startTime;
ARTimestamp endTime;
unsigned int jobState;
} CMDBREJobRunInfo;
The CMDBREJobRunInfo structure consists of the following elements:
BMC Atrium Core 9.0
Page 1376 of 2268
Home
jobRunId
The Reconciliation Engine job run ID.
jobInstanceId
The instance ID of the Reconciliation Engine job.
jobName
The name of the Reconciliation Engine job.
startTime
The start time of the job.
endTime
The end time of the job.
jobStatus
The current status of the Reconciliation Engine job.
CMDBREJobRunInfoList structure
The CMDBREJobRunInfoList data structure holds a list of Reconciliation Engine jobs that are
currently running.
typedef struct CMDBREJobRunInfoList

{
CMDBREJobRunInfo *jobRunList;
} CMDBREJobRunInfoList;
The CMDBREJobRunInfoList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBREJobRunInfo items in the list.
jobRunList
The list of Reconciliation Engine jobs that are currently in progress.
CMDBSortList structure
The CMDBSortList structure holds a list of attributes to sort.
typedef struct CMDBSortList

{
CMDBSortStruct *sortList;
} CMDBSortList;
The CMDBSortList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBSortStruct items in the list.
sortList
A list of CMDBSortStruct items.
CMDBSortStruct structure
The CMDBSortStruct structure holds the attribute to sort.
BMC Atrium Core 9.0
Page 1377 of 2268
Home
typedef struct CMDBSortStruct

{
unsigned int sortOrder;
} CMDBSortStruct;
The CMDBSortStruct structure consists of the following elements:

attributeName
The name of the attribute to sort.
sortOrder
An integer value indicating sort order.

1 --Sort attributes in ascending order (CMDB_SORT_ASCENDING ).
2 --Sort attributes in descending order (CMDB_SORT_DESCENDING ).
CMDBUIComponentInfo structure
The CMDBUIComponentInfo data structure holds the UI components to retrieve.
typedef struct CMDBUIComponentInfo

{
ARNameType classId;
ARLocaleType locale;
unsigned int componentType;
ARNameType componentId;
char *tag1;
char *tag2;
char *tag3;
char *tag4;
char *tag5;
char *tag6;
char *tag7;
char *encodedQual;
} CMDBUIComponentInfo;
The CMDBUIComponentInfo structure consists of the following elements:

classId
An integer value indicating the class ID for the UI component.
locale
The name of the locale specific to the component. If no locale is specified in this subclasses, the default locale
is used.
componentType
The integer value indicating the component type.

0 --The information to retrieve is a component type of None. ( CMDB_COMPONENT_TYPE_NONE ).
1 --The icon type component to retrieve (CMDB_COMPONENT_TYPE_ICON ).
2 --The localized label type component to retrieve ( CMDB_COMPONENT_TYPE_LOCALIZEDSTRING ).
3 --The tooltip type component to retrieve (CMDB_COMPONENT_TYPE_TOOLTIP ).
4 --The user interface graphical line information to retrieve ( CMDB_COMPONENT_TYPE_LINE ).
100 --The server configuration information to retrieve (
CMDB_COMPONENT_TYPE_CMDB_SERVER_CONFIGURATION ).
BMC Atrium Core 9.0
Page 1378 of 2268
Home
101-- The saved query information to retrieve for the APIs (

CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY ). This option is for BMC use only.
102 --The CI scope saved query information to retrieve for the APIs (
CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_SAVED_QUERY ). This option is for internal use only. A CI
scope refers to the specific attributes that are displayed when you query and drill down on a CI in the
900 --The BMC Atrium Explorer view to retrieve ( CMDB_COMPONENT_TYPE_EXPLORER_VIEW ). This
option is for internal use only.
901 --The saved query to retrieve for BMC Atrium Explorer ( CMDB_COMPONENT_TYPE_SAVED_QUERY )
. This option is for internal use only.
902 --The BMC Atrium Explorer filter to retrieve ( CMDB_COMPONENT_TYPE_EXPLORER_FILTER ). This
option is for internal use only.
903 --The user preference to retrieve for the BMC Atrium Explorer (
CMDB_COMPONENT_TYPE_ATRIUM_USER_PREF ). This option is for internal use only.
904 --The adapter used for configuring federated data to retrieve (
CMDB_COMPONENT_TYPE_FEDERATION_ADAPTER ). This option is for internal use only.
905 --The plug-in configuration used for federated data to retrieve (
CMDB_COMPONENT_TYPE_FEDERATION_PLUGIN_CONFIG ). This option is for internal use only.
906 --The quick edit attribute to retrieve ( CMDB_COMPONENT_TYPE_QUICK_EDIT_ATTRIBUTES ). This
attribute is displayed when you right-click an instance and select Quick Edit in the Display pane.
907 --The BMC Atrium Explorer group threshold value to retrieve (
CMDB_COMPONENT_TYPE_EXPLORER_GROUP_THRESHOLD ). The group threshold value controls the
total number of like CIs displayed in the BMC Atrium Explorer at a given time (for example, disk drives
or computer systems).
908 --The class label to retrieve (CMDB_COMPONENT_TYPE_CLASS_LABEL_ATTRIBUTE ). This
attribute is displayed in the BMC Atrium Explorer as the label for the class icon.
909 --The class display name to retrieve ( CMDB_COMPONENT_TYPE_CLASS_DISPLAY_NAME ). This is
the display name for the class that is used in the BMC Atrium Explorer.
componentID
An integer value indicating the ID of the component. The composite values of componentType and
componentId for a component form a unique value, based on which a unique index is created. The
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY and CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE component
types use this tag to stores the name of the saved query.
For all other component types, the CMDB engine auto-populates the instance ID by default.
tag1
An information tag allows you to provide descriptions for the components. You might use more than one tag at
a time to provide descriptions for a specific component type. These tags are used to filter a specific
component type. Each of the component types use this tag in the following ways:
CMDB_COMPONENT_TYPE_ICON --Used to specify the owner of the icon.
CMDB_COMPONENT_TYPE_LOCALIZED_LABEL --Used to specify the owner of the localized label.
CMDB_COMPONENT_TYPE_TOOLTIP --Used to specify the owner of the tool tip.
CMDB_COMPONENT_TYPE_LINE --Used to specify the owner of the UI line.
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the category name for the saved
query.
CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the category name of
the CI scope for the saved query.
tag2
Each of the component types use this tag in the following ways:
CMDB_COMPONENT_TYPE_ICON --Used to specify the size of the icon.
CMDB_COMPONENT_TYPE_LOCALIZED_LABEL --Used to specify the attribute name of the localized
string. This tag is left blank if it is a label for a class.
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the description for the saved query.
BMC Atrium Core 9.0
Page 1379 of 2268
Home
CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the description of the

CI scope for the saved query.
Each of the component types use this tag in the following ways:
tag3
CMDB_COMPONENT_TYPE_ICON --Used to specify the image type of the icon for the component type (
for example, JPG, BMP, or GIF).
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the characteristics for the saved
query.
CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the characteristics of
the CI scope for the saved query.
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the version number of the saved
query XML file.
tag4
Used to specify the weight of the icon for the CMDB_COMPONENT_TYPE_ICON component type.
tag5
Used to describe a specific component type.
tag6
Used to store the version number of the saved query XML file for the
CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY and
CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_SAVED_QUERY component types. The query definitions for the
saved query and CI scope saved query components are stored in an XML file for data manipulation.
tag7
Reserved for future use.
encodedQual
The encoded qualifier for the UI component query.
CMDBUIComponentResult structure
The CMDBUIComponentResult data structure holds the component query result.
typedef struct CMDBUIComponentResult

{
CMDBUIComponentIno componentInfo;
char *dataString;
ARAttachStruct *attachVal;
} CMDBUIComponentResult;
The CMDBUIComponentResult structure consists of the following elements:

instanceId
An integer value indicating the class ID of the UI component class.
componentInfo
Contains the component information for the specific instance.
dataString
Contains the component data string.
attachVal
Contains the attachment for the component.
CMDBUIComponentResultList structure
The CMDBUIComponentResultList data structure holds the component query result.
BMC Atrium Core 9.0
Page 1380 of 2268
Home
typedef struct CMDBUIComponentResultList

{
CMDBUIComponentResult *componentResList;
} CMDBUIComponentResultList;
The CMDBUIComponent ResultList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBUIComponent items in the list.
componentResultList
Contains a list of UI components.
CMDBVersionInfo structure
The CMDBVersionInfo structure holds version information for the BMC Atrium Core components.
typedef struct CMDBVersionInfo

{
ARNameType applicationId;
ARNameType applicationName;
unsigned int majorVer;
unsigned int minorVer;
unsigned int maintenanceVer;
unsigned int patchNum;
} CMDBVersionInfo;
The CMDBVersionInfo structure consists of the following elements:

applicationId
An ID for the application.
applicationName
The name for the application.
majorVer
The major part (preceding the dot) of the version number information.
minorVer
The minor part (succeeding the dot) of the version number information.
maintenanceVer
The maintenance version number.
patchNum
The patch number.
CMDBVersionInfoList structure
The CMDBVersionInfoList structure holds a list of version information elements for the CMDB
component.
typedef struct CMDBVersionInfoList

{
CMDBVersionInfo *versionInfoList;
} CMDBVersionInfoList;
BMC Atrium Core 9.0
Page 1381 of 2268
Home
The CMDBVersionInfoList structure consists of the following elements:

numItems
The number of items in the list.
versionInfoList
A list of version information.
CMDBWeakPropagatedAttrs structure
The CMDBWeakPropagatedAttrs structure holds a list of source and target attributes to use for
attribute value propagation when isRole2WeakReference is TRUE.
The specified source and target attributes must already exist on the role one and role two classes.
This list describes the mapping of the attribute values from the role one class to be propagated to
the role two class.
typedef struct CMDBWeakPropagatedAttrs

{
ARNameType sourceAttributeName;
ARNameType targetAttributeName;
} CMDBWeakPropagatedAttrs;
The CMDBWeakPropagatedAttrs structure consists of the following elements:

sourceAttributeName
The name of the attribute on the role one class.
targetAttributeName
The name of the attribute on the role two class.
CMDBWeakPropagatedAttrsList structure
The CMDBWeakPropagatedAttrsList structure holds a list of CMDBWeakPropagatedAttrs
structures.
typedef struct CMDBWeakPropagatedAttrsList

{
CMDBWeakPropagatedAttrs *attrsList;
} CMDBWeakPropagatedAttrsList;
The CMDBWeakPropagatedAttrsList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBWeakPropagatedAttrs items in the list.
attrsList
The list of attributes to propagate from the role one class to the role two class.
CMDBXMLExportItemList structure
The CMDBXMLExportItemList data structure holds a list of items to export.
BMC Atrium Core 9.0
Page 1382 of 2268
Home
typedef struct CMDBXMLExportItemList

}
CMDBWeakPropagatedAttrsList;
CMDBXMLExportItemStruct *exportItemList;
}CMDBXMLExportItemList;
The CMDBXMLExportItemList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBXMLExportItem items in the list.
exportItemList
A structure that holds the list of items to export.
CMDBXMLImportItemList structure
The CMDBXMLImportItemList data structure holds a list of XML items to import.
typedef struct CMDBXMLImportItemList

}
CMDBXMLExportItemList;
CMDBXMLImportItemStruct *importItemList;
}CMDBXMLImportItemList;
The CMDBXMLImportItemList structure consists of the following elements:

numItems
An integer value indicating the number of CMDBXMLImportItem items in the list.
exportItemList
A structure that holds the list of XML items to import.
C API functions
The following topics provide reference information for the C API functions, which are defined in the
cmdb.h and cmdbfree.h header files. For a complete list of header files required for BMC Atrium
Core, see BMC Atrium CMDB C API requirements and package contents .
Types of BMC Atrium CMDB C API functions
CMDBActivateFederatedInContext function
CMDBBeginBulkEntryTransaction function
CMDBBeginClientManagedTransaction function
CMDBCancelJobRun function
CMDBCreateAttribute function
CMDBCreateClass function
CMDBCreateGuid function
CMDBCreateInstance function
CMDBCreateMultipleAttributes function
BMC Atrium Core 9.0
Page 1383 of 2268
Home
CMDBCreateMultipleInstances function
CMDBDeleteAttribute function
CMDBDeleteClass function
CMDBDeleteInstance function
CMDBDeleteMultipleInstances function
CMDBEndBulkEntryTransaction function
CMDBEndClientManagedTransaction function
CMDBExpandParametersForCI function
CMDBExportData function
CMDBExportDef function
CMDBGetAttribute function
CMDBGetClass function
CMDBGetCopyAuditData function
CMDBGetInstance function
CMDBGetInstanceBLOB function
CMDBGetListClass function
CMDBGetListInstance function
CMDBGetMultipleAttributes function
CMDBGetMultipleInstances function
CMDBGetCMDBUIComponents function
CMDBGetJobRun function
CMDBGetListJobRun function
CMDBGetRelatedFederatedInContext function
CMDBGetServerPort function
CMDBGetVersions function
CMDBGraphQuery function
CMDBGraphWalkBegin function
CMDBGraphWalkEnd function
CMDBGraphWalkNext function
CMDBImportData function
CMDBImportDef function
CMDBInitialization function
CMDBQueryByPath function
CMDBRemoveClientManagedTransaction function
CMDBRunQualificationForCI function
CMDBSetAttribute function
CMDBSetClass function
CMDBSetClientManagedTransaction function
CMDBSetInstance function
CMDBSetMultipleAttributes function
CMDBSetMultipleInstances function
CMDBSetServerPort function
CMDBStartJobRun function
BMC Atrium Core 9.0
Page 1384 of 2268
Home
CMDBSynchMetaData function
CMDBSystemInit function
CMDBTermination function
Types of BMC Atrium CMDB C API functions

The BMC Atrium CMDB C API functions are categorized by the type of action that they perform, as
listed in the following table. To use the C API functions in your program, you must have the
following BMC Atrium CMDB permissions depending on the specific function type:
CMDB Definitions Admin For working with data model definitions, such as
CMDBCreateClass, CMDBDeleteClass, CMDBCreateAttribute, and
CMDBCreateMultipleAttributes. For more information about these functions, see the
data model functions in the following table.
CMDB RE User For working with the Reconciliation Engine functions, such as
CMDBGetJobRun and CMDBCancelJobRun. For more information about these functions,
see the Reconciliation Engine functions in the following table.
CMDB Data Change All For all other functions with which you manipulate the data in
BMC Atrium CMDB.
List of functions categorized by type

Function type
Bulk-entry transaction functions:
Invoke the bulk-entry API functions.
Function list
CMDBBeginBulkEntryTransaction
CMDBEndBulkEntryTransaction
Client-managed transaction functions:

Invoke the client-managed API functions. Prior to using these
functions, set the maximum number of client transactions and the
transaction timeout parameters in the AR System configuration file
(ar.cfg or ar.conf ) Guidelines include:
CMDBBeginClientManagedTransaction
CMDBEndClientManagedTransaction
CMDBSetClientManagedTransaction
CMDBRemoveClientManagedTransaction
Do not execute long running processes or APIs in the

transaction.
Do not use the same transaction handle in multi-threaded
API calls.
Make sure that the transaction is as small as possible to
reduce the chance of deadlock.
When running concurrent transactions, make sure that
there is no data overlap between transactions.
Copy functions:
Copy the values of one C API structure to another. The copy
CopyCMDBGraphWalkQueryStruct
structures return an integer value that indicate whether the copy
CopyCMDBGraphWalkSelectorAndFilterList
operation was a success or a failure. A value of 1 indicates

success. Each of the copy functions accepts the following
parameters:
CopyCMDBGraphWalkSelectorAndFilterStruct
CopyCMDBGraphWalkRelation
CopyCMDBGraphWalkRelationList
CopyCMDBGraphWalkResultStruct
BMC Atrium Core 9.0
Page 1385 of 2268
Home
Function type
Function list
dst --A pointer to the destination structure to which you

want to copy the values.
CopyCMDBInstanceList
src --A pointer to the source structure from which you want
to copy values.
CopyCMDBNestedQueryStruct
CopyCMDBInstanceStruct
CopyCMDBQueryQualifierStruct
CopyCMDBQueryQualifierValueStruct
CopyCMDBQueryObject
CopyCMDBQueryObjectList
CopyCMDBQueryObjectSelectorList
CopyCMDBQueryStruct
CopyCMDBQuerySortStruct
CopyCMDBQuerySortList
Data model functions:

Manipulate the BMC Atrium CMDB class and attribute definitions.
CMDBCreateAttribute
CMDBCreateClass
CMDBCreateMultipleAttributes
CMDBDeleteAttribute
CMDBDeleteClass
CMDBGetAttribute
CMDBGetClass
CMDBGetListClass
CMDBGetMultipleAttributes
CMDBSetAttribute
CMDBSetClass
CMDBSetMultipleAttributes
CMDBSynchMetaData
Environment functions:
Initialize, set, or query information about the API environment.
CMDBGetServerPort
CMDBInitialization
CMDBSetServerPort
CMDBSystemInit
CMDBTermination
Export and import functions:

Export and import BMC Atrium CMDB definitions and data.
CMDBExportData
CMDBExportDef
CMDBImportData
CMDBImportDef
Federation functions:
Work with federated data for an instance.
CMDBActivateFederatedInContext
CMDBExpandParametersForCI
CMDBGetRelatedFederatedInContext
CMDBRunQualificationForCI
Free functions:
Release the memory space allocated to the specified C API
structure. When you allocate memory space for parameters that
various functions require, you must release the memory when it is
no longer required. Each of these free functions accept two
FreeCMDBAttributeGetStruct
parameters:
FreeCMDBAttributeValueList
BMC Atrium Core 9.0
FreeCMDBAttributeLimit
FreeCMDBAttributeLimitList
FreeCMDBAttributeLimitStruct
Page 1386 of 2268
Home
Function type
Function list
value --A pointer to the structure you want to free. The

function recursively frees all allocated memory within that
FreeCMDBAttributeValueListList
structure. If you specify NULL for this parameter (or the

structure is a list with zero items), the function performs no
operations.
FreeCMDBAuditValueList
freeStruct --A Boolean value that indicates whether to free

the top level structure. If you allocated memory for the top
level structure, specify TRUE to free both the structure and
its contents. If you used a stack variable for the top level
structure, specify FALSE to free only the contents of the
structure.
FreeCMDBClassTypeInfo
FreeCMDBAuditInfoStruct
FreeCMDBAuditValueListList
FreeCMDBClassNameIdList
FreeCMDBExportItemList
FreeCMDBExportItemStruct
FreeCMDBFederatedActivateInfo
FreeCMDBGetObjectList
FreeCMDBGetRelationList
FreeCMDBGraphAdjacentList
FreeCMDBGraphAdjacentStruct
FreeCMDBGraphList
FreeCMDBGraphStruct
FreeCMDBGraphWalkObjectStruct
FreeCMDBGraphWalkObjectList
FreeCMDBGraphWalkQueryStruct
FreeCMDBGraphWalkRelation
FreeCMDBGraphWalkRelationList
FreeCMDBGraphWalkResultStruct
FreeCMDBGraphWalkSelectorAndFilterList
FreeCMDBGraphWalkSelectorAndFilterStruct
FreeCMDBGraphWalkStateStruct
FreeCMDBIndexList
FreeCMDBNestedQueryStruct
FreeCMDBQualifierStruct
FreeCMDBImportItemList
FreeCMDBIndexList
FreeCMDBInstanceList
FreeCMDBQueryObject
FreeCMDBQueryObjectList
FreeCMDBQueryObjectSelectorList
FreeCMDBQueryQualifierStruct
FreeCMDBQueryQualifierValueStruct
FreeCMDBQueryResultGraph
FreeCMDBQueryStruct
FreeCMDBQuerySortStruct
FreeCMDBQuerySortList
Instance functions:
Manipulate the BMC Atrium CMDB data, such as creating and
deleting instances, getting and setting instances, and querying
instances. When you use the bulk functions, such as
CMDBCreateMultipleInstances and
CMDBCreateInstance
CMDBCreateMultipleInstances
CMDBDeleteInstance
CMDBDeleteMultipleInstances
CMDBDeleteMultipleInstances, to manipulate one or more
CMDBGetCopyAuditData
instances, the success of the operation depends on the complete

call. For example, if an error is encountered when creating a
particular instance in the bulk function, the entire operation is
rolled back and none of the instances are created.
CMDBGetInstance
CMDBGetInstanceBLOB
CMDBGetListInstance
CMDBGetMultipleInstances
CMDBSetInstance
CMDBSetMultipleInstances
BMC Atrium Core 9.0
Page 1387 of 2268
Home
Function type
Function list
Query functions:
Find related CIs depending on the information that you need to
retrieve about CI and relationship instances.
CMDBGraphQuery
CMDBGraphWalkBegin
CMDBGraphWalkEnd
CMDBGraphWalkNext
CMDBQueryByPath
Reconciliation Engine functions:

Manipulate Reconciliation Engine jobs.
CMDBCancelJobRun
CMDBGetJobRun
CMDBGetListJobRun
CMDBStartJobRun
User interface component functions:

Manipulate BMC Atrium CMDB components, such as tooltips,
icons, and labeled strings.
CMDBGetCMDBUIComponents
Utility functions:
Use BMC Atrium CMDB utilities to generate globally unique
identifiers (GUIDs) and get version information.
CMDBCreateGuid
CMDBGetVersions
CMDBActivateFederatedInContext function
The CMDBActivateFederatedInContext function expands the BMC_FederatedInterface
instance for a specific CI. Depending on a flag that you specify when you call this function, your
federated instance might be either only expanded or expanded and launched.
Synopsis
#include "ar.h"
#include "arextern.h"
#include "cmdb.h"
int CMDBActivateFederatedInContext(
ARControlStruct *control,
CMDBClassNameId *classNameId,
ARNameType datasetId,
ARNameType instanceId,
ARNameType federatedInstanceId,
unsigned int activateOption,
CMDBFederatedActivateInfo *federatedInfo,
ARStatusList *status)
Input arguments
Input argument
Description
control
The control record for the operation, which contains information about the user requesting the
operation and the server on which the operation is to be performed.
BMC Atrium Core 9.0
Page 1388 of 2268
Home
Input argument
Description
classNameId
The class name for which to expand or launch the federated instance. The classNameID argument
contains the namespace name and the unique class name.
datasetId
The unique identifier for the dataset. The data in the return values are based on the dataset ID
specified.
instanceId
The instance ID of the specified instance for which the federated instance is to be expanded or
launched.
federatedInstanceId
The instance ID of the federated instance that is to be expanded or launched.
activateOption
The mask number that indicates whether the federated instance is to be launched and expanded.
Specify a value of 1 for this parameter to return information in federatedInfo.
0: Activate None--No BMC_FederatedInterface instance to be activated (
CMDB_FEDERATION_ACTIVATION_NONE ).
1 << 0: Activation Expand--Only activate the specified BMC_FederatedInterface instance (
CMDB_FEDERATION_ACTIVATION_EXPAND ). No launch required.
1 << 1: Activation Launch--Activate and launch the specified BMC_FederatedInterface
instance
(CMDB_FEDERATION_ACTIVATION_LAUNCH ).
Return values
Return value
Description
federatedInfo
The expanded federated instance information.
status
A list of zero or more notes, warnings, or errors generated from a call of this function.
CMDBBeginBulkEntryTransaction function
The CMDBBeginBulkEntryTransaction function enables you to invoke API functions within a
bulk transaction construct. Any API calls that arrive after this function call are placed in a queue.
Data model functions are not part of the bulk transaction.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBBeginBulkEntryTransaction(
Input argument
BMC Atrium Core 9.0
Page 1389 of 2268
Home
Input
argument
Description
control
The control record for the operation, which contains information about the user requesting the operation and the
server on which the operation is to be performed.
Return value
Return value
Description
federatedInfo
The expanded federated instance information.
status
CMDBBeginClientManagedTransaction function
The CMDBBeginClientManagedTransaction function enables you to start a client managed
database transaction. This function returns the transaction handle which can be used by other
control records and allows both AR and CMDB calls to be made in the same transaction.
Note
The maximum number of client transaction and the transaction timeout parameters must
be set in the AR System configuration file ( ar.cfg or ar.conf ) prior to using client
managed transaction functions. For more information on AR System C APIs, see
Developing an API program in the BMC Remedy AR System online documentation.
For more information on the AR System configuration file, see Configuring after
installation in the BMC Remedy AR System online documentation.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBBeginClientManagedTransaction(
char *transactionHandle,
Input argument
Input
argument
Description
control
BMC Atrium Core 9.0
Page 1390 of 2268
Home
Input
argument
Description
Return value
Return value
Description
transactionHandle
The transaction handle ID of the database transaction.
status
CMDBCancelJobRun function
The CMDBCancelJobRun function cancels a currently running Reconciliation Engine job.
Depending on the system resources, the Reconciliation Engine might cancel a job with a certain
delay.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCancelJobRun(
ARNameType jobRunId,
Input arguments
Input
argument
Description
control
jobRunId
A unique job identifier.
Return value
Return value
Description
status
CMDBCreateAttribute function
The CMDBCreateAttribute function creates a new attribute with the specified name for the
specified class.
BMC Atrium Core 9.0
Page 1391 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateAttribute(
CMDBClassNameId classNameID,
ARNameType attributeName,
ARNameType attributeId,
unsigned int dataType,
ARInternalId *arsubclassesId,
unsigned int entryMode,
CMDBAttributeLimit *attributeLimit,
ARValueStruct *defaultValue,
ARPropList *characList,
ARPropList *customCharacList,
Input arguments
Input argument
Description
control
The control record for the operation, which contains information about the user requesting the operation
and the server on which the operation is to be performed.
classNameId
The name of the class for which you want to create an attribute. The classNameID argument contains
the namespace name and the unique class name.
attributeName
The name of the attribute to create. The name of the attribute must be unique within the specified class
and within its superclasses and subclasses.
attributeId
The ID of the attribute to create.
dataType
The data type of the new attribute. Data types not listed are either unsupported or display fields.
1: Keyword (CMDB_ATTR_DATA_TYPE_KEYWORD)
2: Integer (CMDB_ATTR_DATA_TYPE_INTEGER)
3: Real (CMDB_ATTR_DATA_TYPE_REAL)
4: Character (CMDB_ATTR_DATA_TYPE_CHAR)
5: Diary (CMDB_ATTR_DATA_TYPE_DIARY)
6: Selection (CMDB_ATTR_DATA_TYPE_ENUM)
7: Time (CMDB_ATTR_DATA_TYPE_TIME)
10: Fixed-point decimal (CMDB_ATTR_DATA_TYPE_DECIMAL)
11: Attachment (CMDB_ATTR_DATA_TYPE_ATTACH)
12: Currency (CMDB_ATTR_DATA_TYPE_CURRENCY)
13: Date (CMDB_ATTR_DATA_TYPE_DATE)
14: Time of day (CMDB_ATTR_DATA_TYPE_TIME_OF_DAY)
37: Attachment pool (CMDB_ATTR_DATA_TYPE_ATTACH_POOL)
arsubclassesId
The BMC Remedy AR System subclass ID of the new attribute. The IDs of all attributes must be unique
within the class. If you want the system to generate the ID, specify 0 for this parameter.
entryMode
BMC Atrium Core 9.0
The entry mode for the attribute. Entry modes not listed are for BMC Software internal use.
Page 1392 of 2268
Home
Input argument
Description
1: Required--Users must enter data ( CMDB_ATTR_ENTRYMODE_REQUIRED ).
2: Optional--Users do not have to enter data, but they can if needed (
CMDB_ATTR_ENTRYMODE_OPTIONAL ).
4: Display only--Users cannot enter data ( CMDB_ATTR_ENTRYMODE_DISPLAY_ONLY ).
attributeLimit
The value limits for the attribute and other properties specific to the attribute's type. See the
CMDBsubclassesLimitStruct definition in cmdb.h to find the contained structure that applies to the
type of attribute that you are creating. The limits and properties that you assign must be of the same data
type as the attribute. If you do not want to change the attribute limits and properties, specify NULL for this
parameter.
defaultValue
The value to apply if a user submits an entry with no value for the new attribute. The default value can be
up to 255 bytes and must be of the same data type as the attribute. If you do not want to specify a default
value, specify NULL.
characList
A list of characteristics for the attribute. Characteristics not listed are not applicable for creating attributes.
1: View Permissions--Specify a list of groups or roles that have permissions to view this attribute (
CMDB_ATTR_CHARAC_VIEW_PERMS ). When querying for attributes, you see all attributes,
including the hidden attributes. You can specify one or more group IDs or role IDs for the
permissions, separated by a semicolon, for example, 20;-5.
2: Change Permissions--Specify a list of groups or roles that have permissions to view and modify
the characteristics of the attribute (CMDB_ATTR_CHARAC_CHANGE_PERMS ).
3: Hidden--Set the flag to false so that this attribute is hidden ( CMDB_ATTR_CHARAC_HIDDEN ).
This setting marks the attribute as hidden for a group or a role. When querying for classes, you can
retrieve hidden attributes. You can specify one or more group IDs or role IDs for the permissions,
separated by a semicolon, for example, 20;3.
5: Propagated Owner--The class ID and the attribute ID of the lead class attribute from which the
attribute is propagated (CMDB_ATTR_CHARAC_PROPAGATED_OWNER ).
The format for this value is:
<sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<
destinationAttributeId>|[<additionalPairs>].
6: Create Mode--Set permissions for specifying data for the attribute (
CMDB_ATTR_CHARAC_CREATE_MODE ).
0 --CMDB_ATTR_CREATE_MODE_NONE --No permissions specified for the attribute.
1 --CMDB_ATTR_CREATE_MODE_OPEN --Anyone can specify a value for the attribute.
2 --CMDB_ATTR_CREATE_MODE_PROTECTED --Only users with permissions can specify a
value for the attribute.
7: Audit Option--Set the audit option on to store the audit history for the attribute (
CMDB_ATTR_CHARAC_AUDIT_OPTION ).
8: Namespace--Set the namespace of the attribute (CMDB_ATTR_CHARAC_NAMESPACE ).
9: Description--Set the description for the attribute
(CMDB_ATTR_CHARAC_DESCRIPTION ).
10: Federation External Name--Specify external name for attributes of a federated class that are
mapped by way of Vendor AR System database connectivity (ARDBC) plug-in (
CMDB_ATTR_CHARAC_FEDERATION_EXTERNAL_NAME ).
customCharacList
A list of user-defined custom characteristics for the attribute. The attributes must be between 300000 (
CMDB_ATTR_CUSTOM_CHARAC_MIN ) and 399999 (CMDB_ATTR_CUSTOM_CHARAC_MAX ). After the
properties list structure that you specify is serialized, it is converted into the following format:
<listSize> <propId> <dataType> <propValue>
listSize: The number of items in the properties list.
propId: The ID for the property, which is within the 300000-399999 range.
BMC Atrium Core 9.0
Page 1393 of 2268
Home
Input argument
Description
dataType: The native data type for the property.
propValue: The value for the property. An example for the serialized property list is 1\300050\2\1.
Return value
Return value
Description
status
CMDBCreateClass function
The CMDBCreateClass function creates a class with the core attributes in the OBJSTR:Class.
The data model is stored in the OBJSTR:Class form, and the attribute information is stored in the
OBJSTR:AttributeDefinition form.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateClass(
CMDBClassNameId *classNameID,
ARNameType classID,
CMDBClassTypeInfo *classTypeInfo,
CMDBClassNameId *superclassNameId,
CMDBIndexList *indexList,
CMDBAuditInfoStruct *auditInfo,
Input arguments
Input argument
Description
control
classNameID
The name of the class to create. The classNameID argument contains the namespace name and the
unique class name.
classID
The unique identifier for the class. It can be provided by the user. If left blank, the class ID is automatically
generated by the system.
classTypeInfo
The type of class to create:

1: Regular class (CMDB_CLASS_TYPE_REGULAR).
2: Relationship (CMDB_CLASS_TYPE_RELATIONSHIP).
BMC Atrium Core 9.0
Page 1394 of 2268
Home
Input argument
Description
3: Federated (CMDB_CLASS_TYPE_FEDERATED).
4: Relationship class for a federated class (CMDB_CLASS_TYPE_FEDERATED_RELATIONSHIP)
superclassNameID
The superclass of this class. If the class has no superclass, specify NULL for this parameter.
indexList
A list of indexes defined for the class.
auditInfo
The audit information for the class: audit type, qualification, and Audit Only Changed Fields ( auditMask )
. Use the following auditMask values:
CMDB_CLASS_AUDITCHANGE_DEFAULT = 0--Use the value of the Disable Audit Only Change
Fields system setting on the BMC Remedy AR System server. The system setting default is that
only changing the attribute to a different value triggers auditing.
CMDB_CLASS_AUDITCHANGE_YES = 1--Audit when an updated field value is different than the
existing value.
CMDB_CLASS_AUDITCHANGE_NO = 2--Audit when a field value is modified, even if the updated
value is the same as the existing value.
characList
A list of characteristics for the class. Specify NULL for this parameter if you do not want to associate
characteristics with this class. Characteristics not listed are for BMC Software internal use.
1: Singleton--Used to specify if this is a singleton class. This characteristic is an integer value
where type CMDB_CLASS_CHARAC_SINGLETON_FALSE indicates that this is not a singleton class.
Type CMDB_CLASS_CHARAC_SINGLETON_TRUE indicates that this is a singleton class (
CMDB_CLASS_CHARAC_SINGLETON ).
2: Abstract--This property does not allow you to create instances for this abstract class (
CMDB_CLASS_CHARAC_ABSTRACT ). After the property has been set for the attribute, you cannot
create instances for it. All the attributes are propagated to the subclasses.
3: Final--You cannot create subclasses from this class ( CMDB_CLASS_CHARAC_FINAL ).
4: Author--The author of the class (CMDB_CLASS_CHARAC_AUTHOR ).
5: Description--The class description (CMDB_CLASS_CHARAC_DESCRIPTION ).
6: Hidden Permission--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_HIDDEN_PERMS ). Marks the class as hidden for a group or a role.
When querying for classes, you can choose to retrieve hidden classes. You can specify one or
more group IDs or role IDs for the permissions separated by a semicolon, for example, 20;3.
7: Visible Permission--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_VISIBLE_PERMS ). Marks the class as visible for a group or a role
. When querying for classes, you will see all classes, including the hidden classes. You can specify
one or more group IDs or role IDs for the permissions separated by a semicolon, for example, 20;5.
8: Subclass--CMDB_CLASS_CHARAC_CATEGORIZATION_SUBCLASS
9: Form name--CMDB_CLASS_CHARAC_FORM_NAME
10: Exposure--The visibility of the class, which can be CMDB_CLASS_EXPOSURE_NONE,
CMDB_CLASS_EXPOSURE_USED_VISIBLE, or CMDB_CLASS_EXPOSURE_USED_HIDDEN.
12: Federation schema type--Allows you to specify the schema type for federation (
CMDB_CLASS_CHARAC_FEDERATION_SCHEMA_TYPE ). This characteristic is an integer data type,
where:
0 --CMDB_FEDERATION_SCHEMA_REGULAR --Indicates that the schema is not of type
federation. 0 is the default value for this characteristic.
1 --CMDB_FEDERATION_SCHEMA_VENDOR --Indicates that the schema type is an BMC
Remedy AR System Vendor form.
13: Federation vendor name--Allows you to specify the name of the vendor form or ARDBC plug-in
name (CMDB_CLASS_CHARAC_FEDERATION_VENDOR_NAME ). Specify this characteristic only if
you set the CHARAC_FEDERATION_SCHEMA_TYPE characteristic to 1.
BMC Atrium Core 9.0
Page 1395 of 2268
Home
Input argument
Description
14: Federation vendor table name--Allows you to specify the name of the data store from which the
federated data class will retrieve the data (
CMDB_CLASS_CHARAC_FEDERATION_VENDOR_TABLE_NAME ). Specify this characteristic only if
15: Relation type--Allows you to specify the type of relationship for the federated class (
CMDB_CLASS_CHARAC_RELATION_TYPE ). This characteristic, which only applies to relationship
classes, is an integer data type, where:
0 --CMDB_RELATION_REGULAR --Indicates a regular relationship that relates two CI
endpoints.
1 --CMDB_RELATION_QUERY --Indicates that the relation type is a query used for join
conditions. 0 is the default value for this characteristic.
16: BMC Remedy AR System qualification--Allows you to specify the BMC Remedy AR System
qualification, which defines how the source class links to the destination class in federated
relationship classes (CMDB_CLASS_CHARAC_RELATION_LINK_QUALIFIER ).
17: Number of temp tables--Allows you to define the maximum number of temporary tables to
create for vendor forms (CMDB_CLASS_CHARAC_NUM_TEMP_TABLES ). Do not specify a value for
the characteristic if you are working with regular (non-vendor) forms.
18: Requires qualifier for the query--Allows you to specify whether a qualification is required for the
federated class in the CMDBQueryByPath function (
CMDB_CLASS_CHARAC_REQUIRES_QUALIFIER_FOR_QUERY ). This characteristic is an integer
data type, where:
0 --CMDB_QUAL_RESTRICITVE --Indicates that no qualification is required for the query.
1 --CMDB_QUAL_NON_RESTRICITVE --Indicates that a qualification is required for the
federated class. 1 is the default value for this characteristic. For performance reasons, BMC
recommends that you do not set this value if you have a lot of data in the external data store
and you have not specified any qualifications against the federated data class that maps to it
.
customCharacList
A list of user-defined custom characteristics for the class. The ID for each list item can be set to any
user-defined characteristic but must be between 100000 (CMDB_CLASS_CUSTOM_CHARAC_MIN ) and
199999 (CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do not want to associate custom characteristics
with this class, specify NULL for this parameter. After the properties list structure you specify is serialized,
it is converted into the following format: <listSize> <propId> <dataType> <propValue>. For
example, the serialized property list could be represented as 1\100050\2\1.
listSize: The number of items in the properties list.
propId: The ID for the property, which is within the 100000-199999 range.
dataType: The data type for the property, which can be of any native data type.
propValue: The value for the property. |
Return values
Return value
Description
status
CMDBCreateGuid function
The CMDBCreateGuid function creates a globally unique identifier (GUID).
BMC Atrium Core 9.0
Page 1396 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateGuid(
ARGuid guid,
Return values
Return value
Description
guid
The unique identifier (system-generated).
status
CMDBCreateInstance function
The CMDBCreateInstance function creates a CI or relationship instance of the specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateInstance(
CMDBAttributeValueList *attributeValueList,
Input arguments
Input argument
Description
control
classNameId
The name of the class from which the instance is created. The classNameID argument contains the
namespace name and the unique class name.
datasetId
The unique identifier for the dataset. Instances are created in a dataset based on the value specified in
this parameter.
attributeValueList
BMC Atrium Core 9.0
Page 1397 of 2268
Home
Input argument
Description
A list of one or more attribute and value pairs (specified in any order) that identifies the data for the new
attributes. You must specify values for all required attributes that do not have defined defaults. Values
must be of the data type defined for the attributes or have a data type of 0. NULL values can be
specified for optional attributes only. An error is generated if an attribute does not exist or the user
specified by the control parameter does not have write permission for an attribute.
If you set values to a diary attribute when you create an instance, the name, text, and timestamp details
of that diary entry are concatenated into a single string. To avoid this issue, first create the instance, get
the instance, and then set the diary attribute value.
Return values
Return
Description
value
instanceId
The system-generated unique identifier for the new instance that is created if you did not specify it in the
attributeValueList parameter.
status
CMDBCreateMultipleAttributes function
The CMDBCreateMultipleAttributes function creates multiple new attributes with the
specified names for the specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateMultipleAttribute(
CMDBClassNameId *classNameID,
ARNameList *attributeNameList,
ARNameList *attributeIdList,
ARUnsignedIntList *dataTypeList,
ARInternalIdList *arsubclassesIdList,
ARUnsignedIntList *entryModeList,
CMDBAttributeLimitList *attributeLimitList,
ARValueList *defaultValueList,
ARPropListList *characListList,
ARPropListList *customCharacListList,
Input arguments
Input argument
Description
control
BMC Atrium Core 9.0
Page 1398 of 2268
Home
Input argument
Description
classNameID
The name of the class for which you want to create the attributes. The classNameID argument
attributeNameList
The names of attributes to create. The names of all attributes must be unique within the specified
class and within its superclasses and subclasses.
attributeIdList
The list of attribute IDs for the attributes being created.
dataTypeList
The list of data types for the attributes being created.
arsubclassesIdList
The BMC Remedy AR System subclass IDs of the attributes being created.
entryModeList
The entry mode for the attributes. Entry modes not listed are for BMC Software internal use.
attributeLimitList
The list of value limits for the attributes being created and other properties specific to the attributes'
types. See the CMDBsubclassesLimitStruct definition in cmdb.h to find the contained structure
that applies to the type of attribute list that you are modifying. The limits and properties that you
assign must be of the same data type as the attribute. If you do not want to change the attribute
limits and properties, specify NULL for this parameter.
defaultValueList
The list of values to apply if a user submits an entry with no value for the attributes being created.
The default value can be up to 255 bytes and must be of the same data type as the attribute. If you
do not want to specify a default value, specify NULL for this parameter.
characListList
A list of characteristics for each attribute. Characteristics not listed are not applicable for creating
attributes.
1: View Permissions--Specify a list of groups or roles that have permissions to view this
attribute (CMDB_ATTR_CHARAC_VIEW_PERMS ). When querying for attributes, you will see all
attributes, including the hidden attributes. You can specify one or more group IDs or role IDs
for the permissions separated by a semicolon, for example, 20;-5.
2: Change Permissions--Specify a list of groups or roles that have permissions to view and
modify the characteristics of the attribute (CMDB_ATTR_CHARAC_CHANGE_PERMS ).
3: Hidden--Set the flag to false so that this attribute is hidden ( CMDB_ATTR_CHARAC_HIDDEN
). This setting marks the attribute as hidden for a group or a role. When querying for classes,
you can retrieve hidden attributes. You can specify one or more group IDs or role IDs for the
permissions, separated by a semicolon, for example, 20;3.
5: Propagated Owner--The class ID and the attribute ID of the lead class attribute from which
the attribute is propagated ( CMDB_ATTR_CHARAC_PROPAGATED_OWNER ). The format for
this value is <sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<
destinAtionattributeId>|[<additionalPairs>].
2 --CMDB_ATTR_CREATE_MODE_PROTECTED --Only users with permissions can
specify a value for the attribute.
9: Users can set descriptions for the attributes ( CMDB_ATTR_CHARAC_DESCRIPTION ).
BMC Atrium Core 9.0
Page 1399 of 2268
Home
Input argument
Description
10: Federation External Name--Specify external name for attributes of a federated class that
are mapped by way of Vendor AR System database connectivity (ARDBC) plug-in (
customCharacListList
A list of user-defined custom characteristics list for each attribute. The value can be set to any
user-defined characteristic but must be between 300000 (CMDB_CLASS_CUSTOM_CHARAC_MIN )
and 399999 (CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do not want to associate custom
characteristics with this attribute, specify NULL for this parameter. After the properties list structure
that you specify is serialized, it is converted into the following format: <listSize> <propId> <
dataType> <propValue>. For example the serialized property list could be represented as 1\
300050\2\1.
listSize --The number of items in the properties list.
propId --The ID for the property, which is within the 300000-399999 range.
dataType --The data type for the property, which can be of any native data type.
propValue --The value for the property.
Return value
Return value
Description
status
CMDBCreateMultipleInstances function
The CMDBCreateMultipleInstances function creates multiple specified CI or relationship
instances in the specified dataset.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBCreateMultipleInstances(
const ARNameType datasetId,
const CMDBInstanceList *instances,
ARNameList *instanceIdList,
Input arguments
Input
argument
Description
control
datasetId
BMC Atrium Core 9.0
Page 1400 of 2268
Home
Input
argument
Description
The unique identifier for the dataset. Instances are created in a dataset based on the value specified in this
parameter.
instances
The instance IDs and the attribute values to create.
Return values
Return value
Description
instanceIdList
The system-generated unique identifier for the new instance ID list that is created if you did not specify it in
the attributeValueList parameter.
status
CMDBDeleteAttribute function
The CMDBDeleteAttribute function deletes the attribute with the specified ID. Depending on the
value that you specify for the deleteOption parameter, the attribute is deleted immediately and is
not returned to users who request information about attributes.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBDeleteAttribute(
CMDBClassNameId classNameID,
unsigned int deleteOption,
Input arguments
Input argument
Description
control
The control record for the operation, which contains information about the user requesting the operation and
the server on which the operation is to be performed.
classNameID
The name of the class from which you want to delete the attribute. The classNameID argument contains the
attributeName
The name of the attribute to delete.
deleteOption
Specifies the action to take if the specified attribute contains data:

0: Do not delete the attribute (AR_ATTRIBUTE_CLEAN_DELETE ).
1: Delete if the attribute contains data but not if it is inherited by subclasses (
AR_ATTRIBUTE_DATA_DELETE ).
BMC Atrium Core 9.0
Page 1401 of 2268
Home
Input argument
Description
2: Delete the attribute even if it has subclasses that are associated with it (
AR_ATTRIBUTE_FORCE_DELETE ).
Return value
Return value
Description
status
CMDBDeleteClass function
The CMDBDeleteClass function deletes a specified class and its associated attributes.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBDeleteClass(
ARControlStruct
*control,
Input arguments
Input
argument
Description
control
classNameID
The name of the class to delete. The classNameID argument contains the namespace name and the unique
class name.
deleteOption
A value indicating the action to take if the specified class contains attributes or subclasses.
0: None--Delete the class only if the class contains no instances and has no subclasses or dependent
relationships ( CMDB_DELETE_CLASS_OPTION_NONE ).
1: With data--Delete the class only if the class has no subclasses or dependent relationships. This
applies only to regular classes (CMDB_DELETE_CLASS_OPTION_WITH_DATA ).
2: All dependencies--Delete the class, including all the subclasses, dependent relationship classes, and
audit history (if any) that are associated with the class. All the dependencies for the specified class are
deleted (CMDB_DELETE_CLASS_OPTION_ALL_DEPENDENCIES ). This option overrides the
CMDB_CLASS_DATA_DELETE option.
Note: To retain the audit history after you delete the class, back up the class audit form before you
delete the class. |
BMC Atrium Core 9.0
Page 1402 of 2268
Home
Return value
Return value
Description
status
CMDBDeleteInstance function
The CMDBDeleteInstance function deletes the instance of the class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBDeleteInstance(
ARControlStruct
*control,
Input arguments
Input
argument
Description
control
classNameId
The name of the class to which the instance to delete belongs. The classNameID argument contains the
datasetId
The unique identifier for the dataset. Instances are deleted from a dataset based on the value specified in this
parameter.
instanceId
The unique identifier for the instance (system-generated).
deleteOption
A value indicating the action to take when the specified instance cannot be retrieved.
0: Invalid input--This option is currently reserved for future use (CMDB_DELETEOPTION_FIRSTBIT_SET
).
1<<0: Follow weak relationships--Specifies cascade delete for weak relationships. (
CMDB_DELETEOPTION_CASCADE_FOLLOW_WEAKREL ).
1<<1: Follow one-to-one and one-to-many relationships--Specifies cascade delete for relationships with
one-to-many and one-to-one cardinality. (CMDB_DELETEOPTION_CASCADE_FOLLOW_1TOM_1TO1_REL
).
Return value
BMC Atrium Core 9.0
Page 1403 of 2268
Home
Return value
Description
status
CMDBDeleteMultipleInstances function
The CMDBDeleteMultipleInstances function deletes a list of CI or relationship instances in the
specified dataset.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBDeleteMultipleInstance(
const unsigned int deleteOption,
Input arguments
Input
Description
argument
control
datasetId
The unique identifier for the dataset. Instances are deleted from a dataset based on the value specified in this
parameter.
instances
The list of instances to delete.
deleteOption
A value indicating the action to take if the specified instance to delete is found.
0: Invalid input--This option is currently reserved for future use (CMDB_DELETEOPTION_FIRSTBIT_SET
).
1<<0: Follow weak relationships--Specifies cascade delete for weak relationships. (
CMDB_DELETEOPTION_CASCADE_FOLLOW_WEAKREL ).
1<<1: Follow one-to-one and one-to-many relationships--Specifies cascade delete for relationships with
one-to-many and one-to-one cardinality. (CMDB_DELETEOPTION_CASCADE_FOLLOW_1TOM_1TO1_REL
).
Return value
Return value
Description
status
BMC Atrium Core 9.0
Page 1404 of 2268
Home
CMDBEndBulkEntryTransaction function
Depending on the success of the calls invoked within the CMDBBeginBulkEntryTransaction
function, the transactions are committed or rolled back.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBEndBulkEntryTransaction(
unsigned int actionType,
ARBulkEntryReturnList *bulkEntryReturnList,
Input arguments
Input
argument
Description
control
actionType
The type of action. Action type can be SEND or CANCEL. For an action type of SEND, the API call is executed as
part of the transaction. For an action type of CANCEL, the transaction is canceled.
Return values
Return value
Description
bulkEntryReturnList
Returns the status of the entry calls.
status
CMDBEndClientManagedTransaction function
The CMDBEndClientManagedTransaction function enables you to end the client managed
database transaction. Depending on the transaction option used, the transaction is either rolled
back or committed.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBEndClientManagedTransaction(
int *transactionOption,
BMC Atrium Core 9.0
Page 1405 of 2268
Home
Input argument
Input argument
Description
control
transactionOption
The transaction option allows you to either rollback or commit the transaction. The possible transaction
option values are CMDB_COMMIT_CLIENT_MANAGED_TRANSACTION to commit the transaction and
CMDB_ROLLBACK_CLIENT_MANAGED_TRANSACTION to rollback the transaction.
Return value
Return value
Description
status
CMDBExpandParametersForCI function
The CMDBExpandParametersForCI function accepts an unexpanded string that contains
parameters and substitutes values from the attribute value list provided in the
CMDBAttributeValueList structure. For example, the function takes $Name$ and $InstanceId
$ as the unexpanded parameters and substitutes the values HRServer and CS000019.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBQualificationForCI(
char *paramString,
CMDBAttributeValueList *attValueList,
char **expandedStr,
Input arguments
Input
argument
Description
control
paramString
The string to expand.
attValueList
BMC Atrium Core 9.0
Page 1406 of 2268
Home
Input
argument
Description
The list of attribute and values pairs that is used to expand the parameters. You must specify values for all
required attributes that do not have defined defaults. Values must be of the data type defined for the attributes
or have a data type of 0. NULL values can be specified for optional attributes only. An error is generated if an
attribute does not exist or the user specified by the control parameter does not have write permission for an
attribute.
Return Values
Return value
Description
expandedStr
The string that contains the expanded parameters.
status
CMDBExportData function
The CMDBExportData function exports the specified class data for a specific qualification.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBExportData(
ARQualifierStruct *qualifier,
ARNameList *attributeGetList,
CMDBSortList *sortList,
unsigned int firstRetrieve,
unsigned int maxRetrieve,
char *exportBuf,
Input arguments
Input argument
Description
control
qualifier
A query that determines the set of classes or attributes to retrieve. The qualification can include one or
more subclasses and any combination of conditional, relational, and arithmetic operations. For more
information about how to construct a qualifier, see "Building qualifications and expressions," in the BMC
Remedy Action Request System Workflow Objects Guide.
attributeGetList
The list of attribute names to retrieve.
sortList
A list of zero or more fields that identifies the sort order for the exported data. Specify a NULL value for
this parameter to use no specific sort order.
BMC Atrium Core 9.0
Page 1407 of 2268
Home
Input argument
Description
firstRetrieve
The first instance to retrieve. A value of 0 (CMDB_START_WITH_FIRST_INSTANCE )represents the first

entry and is the default value if no value is set.
The maximum number of instances to retrieve. Use this parameter to limit the instances returned in the
maxRetrieve
query if the qualification does not sufficiently narrow the list. Specify 0 (CMDB_NO_MAX_LIST_RETRIEVE )
to assign no maximum instances.
Return values
Return value
Description
exportBuf
The exported buffer that contains the class data in an XML format.
status
CMDBExportDef function
The CMDBExportDef function exports a list of specified class definitions.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBExportDef(
CMDBExportItemList *exportItemList,
char *exportBuf,
Input arguments
Input argument
Description
control
exportItemList
A list of zero or more classes or attributes to export.
Return values
Return value
Description
exportBuf
The exported buffer that contains the class data in an XML format.
status
CMDBGetAttribute function
The CMDBGetAttribute function retrieves a single attribute.
BMC Atrium Core 9.0
Page 1408 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetAttribute(
ARNameType attributeId,
unsigned int *dataType,
unsigned int *attributeType,
CMDBClassNameId *baseClassNameId,
ARInternalId *arsubclassesId,
unsigned int *entryMode,
Input arguments
Input argument
Description
control
classNameId
The name of the class to which the attributes belong. The classNameID argument contains the namespace
name and the unique class name.
attributeName
The name of the attribute to retrieve.
Return values
Return value
Description
attributeId
The ID of the attribute.
dataType
The data type of the attribute. Data types represented by numbers not in the list are either unsupported or
display fields.
1: Keyword (CMDB_ATTR_DATA_TYPE_KEYWORD )
2: Integer (CMDB_ATTR_DATA_TYPE_INTEGER )
3: Real (CMDB_ATTR_DATA_TYPE_REAL )
4: Character (CMDB_ATTR_DATA_TYPE_CHAR )
5: Diary (CMDB_ATTR_DATA_TYPE_DIARY )
6: Selection (CMDB_ATTR_DATA_TYPE_ENUM )
7: Time (CMDB_ATTR_DATA_TYPE_TIME )
10: Fixed-point decimal (CMDB_ATTR_DATA_TYPE_DECIMAL )
12: Currency (CMDB_ATTR_DATA_TYPE_CURRENCY )
13: Date (CMDB_ATTR_DATA_TYPE_DATE )
BMC Atrium Core 9.0
Page 1409 of 2268
Home
Return value
Description
14: Time of day (CMDB_ATTR_DATA_TYPE_TIME_OF_DAY )
37: Attachment pool (CMDB_ATTR_DATA_TYPE_ATTACH_POOL )
attributeType
Hidden attributes that are available to BMC Atrium CMDB for internal use (
CMDB_ATTR_TYPE_CORE_INTERNAL ).
1: Core Internal--Hidden attributes that are available to BMC Atrium CMDB for internal use (
2: Core--Attributes that are available for internal use only ( CMDB_ATTR_TYPE_CORE ). Apart from
modifying the labels, you cannot make any other changes to the internal attributes.
3: Regular--Attributes that you can create ( CMDB_ATTR_TYPE_REGULAR ).
baseClassNameId
The name of the class that owns this attribute.
arsubclassesId
The internal ID of the attribute to retrieve.
entryMode
attributeLimit
The value limits for the attribute and other properties specific to the attribute's type. See the
type of attribute that you are creating. The limits and properties that you assign must be of the same data
type as the attribute. If you do not want to change the attribute limits and properties, specify NULL for this
parameter.
defaultValue
The value to apply if the user specifies no value for the attribute. The default value can be up to 255 bytes
and must be of the same data type as the attribute.
characList
A list of characteristics for each attribute:

4: Primary Key--Specify whether the attribute is a part of the primary key of the class (
CMDB_ATTR_CHARAC_PRIMARY_KEY).
attribute is propagated (CMDB_ATTR_CHARAC_PROPAGATED_OWNER ). The format for this value is
<sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<destinationAttributeId>|[<
additionalPairs>]
BMC Atrium Core 9.0
Page 1410 of 2268
Home
Return value
Description
9: Description--Set the description for the attribute ( CMDB_ATTR_CHARAC_DESCRIPTION ).
customCharacList
CMDB_ATTR_CUSTOM_CHARAC_MIN ) and 399999 (CMDB_ATTR_CUSTOM_CHARAC_MAX )
status
CMDBGetClass function
The CMDBGetClass function retrieves class information from the OBJSTR:Class form for the
specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetClass(
CMDBClassNameID *classNameId,
ARNameType *classId,
CMDBClassNameId *superclassNameId,
CMDBAuditInfoStruct auditInfo,
Input arguments
Input
argument
Description
control
classNameID
The class to retrieve. The classNameID argument contains the namespace name and the unique class name.
Return values
BMC Atrium Core 9.0
Page 1411 of 2268
Home
Return value
Description
classId
The ID used to identify the class.
classTypeInfo
Information about the type of class.
superclassNameId
The name of the superclass. The superclassNameID argument contains the namespace name and the
unique class name.
indexList
The list of indexes defined for the class.
auditInfo
The audit information for the class: audit type, log form, qualification, and Audit Only Changed Fields (
auditMask ). Use the following auditMask values:
CMDB_CLASS_AUDITCHANGE_DEFAULT = 0 --Use the value of the Disable Audit Only Change
CMDB_CLASS_AUDITCHANGE_YES = 1 --Audit when an updated field value is different than the
existing value.
CMDB_CLASS_AUDITCHANGE_NO = 2 --Audit when a field value is modified, even if the updated
characList
A list of characteristics for this class. Specify NULL for this parameter if you do not want to associate
characteristics with this class. Characteristics not listed are for BMC Software internal use.
6: Hidden permissions--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_HIDDEN_PERMS ). Marks the class as hidden for the users in the
group. When querying for classes, you can choose to retrieve hidden classes.
7: Visible permissions--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_VISIBLE_PERMS ). Marks the class as visible for the users in the
group. When querying for classes, you will see all classes including the hidden classes.
8: Categorization--(CMDB_CLASS_CHARAC_CATEGORIZATION_SUBCLASS ).
9: Form name--(CMDB_CLASS_CHARAC_FORM_NAME ).
where:
BMC Atrium Core 9.0
Page 1412 of 2268
Home
Return value
Description
endpoints.
17: Number of temp tables--Allows you to define the maximum number of temporary tables to
data type, where:
.
customCharacList
A list of user-defined custom characteristics for the class. The value retrieved must be between 100000 (
CMDB_CLASS_CUSTOM_CHARAC_MIN ) and 199999 (CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do
not want to retrieve custom characteristics with this class, specify NULL for this parameter.
status
CMDBGetCopyAuditData function
If the attribute data for the instance is modified, the CMDBGetCopyAuditData function retrieves a
copy of the specified CI instance. The Audit Option must be set for the attribute's characteristic to
get the audit data.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetCopyAuditData(
ARTimestamp auditTimestamp,
CMDBQualifierStruct *qualifier,
BMC Atrium Core 9.0
Page 1413 of 2268
Home
CMDBAuditValueListList *auditValueListList,
unsigned int *numMatches,
Input arguments
Input argument
Description
control
classNameId
The class name of the CI instance for which to retrieve the audit data. The classNameID argument
instanceId
The instance ID of the specified CI instance for which a copy of the audit data is to be retrieved.
auditTimestamp
The date and time information for the instance. The CI instances with the date and time greater than or
equal to the auditTimestamp value are retrieved. If auditTimestamp is 0, all the audit data is
retrieved.
qualifier
A query that determines the set of CI instances to retrieve. The qualification can include one or more
attributes and any combination of conditional, relational, and arithmetic (numeric data types only)
operations. For more information about how to construct a qualifier, see "Building qualifications and
expressions," in the BMC Remedy Action Request System Workflow Objects Guide.
attributeGetList
A list of attribute names for which the audit data is to be retrieved.
sortList
A list of zero or more fields that identifies the sort order for the attributes. Specify a NULL value for this
parameter to use no specific sort order.
firstRetrieve
The first instance to retrieve for the qualification. If you do not specify a value for this parameter, the
default value of CMDB_START_WITH_FIRST_ENTRY is used and the function retrieves the first entry.
maxRetrieve
The maximum number of entries to retrieve for the qualification. Use this parameter to limit the amount of
data returned if qualifier does not narrow the list. Specify CMDB_NO_MAX_LIST_RETRIEVE to assign no
maximum.
Return values
Return value
Description
auditValueListList
The list of values for the specified attributes. If the audit option at the CI class-level is disabled, an error
is returned.
numMatches
The number of CI instance entries that matched the specified qualification.
status
CMDBGetInstance function
The CMDBGetInstance function retrieves information about the instance.
BMC Atrium Core 9.0
Page 1414 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetInstance(
usigned int getMask,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which to retrieve the instance. The classNameID argument contains the
datasetId
The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in
this parameter.
getMask
The ID that specifies the type of dataset on which to perform the operation.
0: None--Based on the datasetId being passed, instances are retrieved from either the overlay
or the original dataset (CMDB_GET_MASK_NONE ).
1<<0: Current Mode--Allows you to retrieve instances from the current dataset only (
instanceId
The unique identifier for the instance to retrieve.
attributeGetList
Return values
Return value
Description
attributeValueList
A list of one or more attribute and value pairs retrieved for the specified instance.
status
CMDBGetInstanceBLOB function
The CMDBGetInstanceBLOB function retrieves the attachment, or binary large object ( BLOB ),
stored for the attachment subclasses. The BLOB can be returned in a file or in an in-memory buffer
.
BMC Atrium Core 9.0
Page 1415 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetInstanceBLOB(
unsigned int getMask,
ARLocStruct *loc,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which to retrieve the instance blob. The classNameID argument contains the
datasetId
this parameter.
getMask
0: None--Based on the datasetId being passed, instances are retrieved from either the overlay or the
instanceId
The unique identifier of the instance to retrieve.
attributeName
The name of the attribute that contains the attachment.
Return values
Return value
Description
loc
The location where the BLOB is stored.
status
CMDBGetListClass function
The CMDBGetListClass function retrieves a list of classes. You can specify one or more of the
classNameIdRelation, superclassName, and characQueryList qualification parameters.
BMC Atrium Core 9.0
Page 1416 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetListClass(
ARNameType namespaceName,
CMDBClassNameId *classNameIdRelation,
CMDBClassNameId *superclassName,
ARPropList *characQueryList,
ARBoolean getHiddenClasses,
CMDBClassNameIdList *classNameIdList,
Input arguments
Input argument
Description
control
namespaceName
The name of the namespace. Namespaces are a way of partitioning your data model to create logical
groups of classes. The Class Manager namespaces are implemented using a prefix-based naming
convention on classes.
classNameIdRelation
Retrieves the relationship classes that have a class specified in this parameter as part of the
relationship.
superclassName
The superclass name of the classes to retrieve.
characQueryList
The search criteria.
getHiddenClasses
A Boolean flag that indicates whether to retrieve the hidden classes.
Return values
Return value
Description
classNameIdList
A list of class names that match the specified criteria.
status
CMDBGetListInstance function
The CMDBGetListInstance function retrieves a list of instances. You can limit the instance list to
entries that match particular conditions by specifying the qualifier parameter.
Synopsis
#include "ar.h"
BMC Atrium Core 9.0
Page 1417 of 2268
Home
#include "cmdb.h"
int CMDBGetListInstance(
usigned int getMask,
CMDBAttributeValueListList *attributeValueListList,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which to retrieve the instances. The classNameID argument contains the
datasetId
this parameter.
getMask
qualifier
A query that determines the set of entries to retrieve. The qualification can include one or more
subclasses and any combination of conditional, relational, and arithmetic operations. For more information
about how to construct a qualifier, see "Building qualifications and expressions" in the BMC Remedy
Action Request System Workflow Objects Guide.
attributeGetList
A list of attribute names to retrieve.
sortList
A list of zero or more attributes that identifies the sort order for the retrieved data. Specify a NULL value
for this parameter to use no specific sort order.
firstRetrieve
The first instance to retrieve for the qualification. If you do not specify a value for this parameter, the
default value of CMDB_START_WITH_FIRST_ENTRY is used and the function retrieves the first entry.
maxRetrieve
The maximum number of entries to retrieve. Use this parameter to limit the amount of data returned if the
qualification does not narrow the list. Specify CMDB_NO_MAX_LIST_RETRIEVE to assign no maximum.
Return values
BMC Atrium Core 9.0
Page 1418 of 2268
Home
Return value
Description
instanceIdList
The list of instance IDs that match the criteria.
A list of one or more attribute and value pairs retrieved for the specified instances.
numMatches
The total number of entries that match the qualification criteria. This value does not represent the
number of entries returned unless the number of matching entries is less than or equal to the
maxRetrieve value. Set this parameter to NULL to improve the system performance, if you do
not want to retrieve the number of entries that match the qualification criteria.
status
CMDBGetMultipleAttributes function
The CMDBGetMultipleAttributes function retrieves multiple attributes.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetMultipleAttribute(
ARBoolean getHiddenAttrs,
ARBoolean getDerivedAttrs,
ARNameList *nameList,
ARPropList *attrCharacQueryList,
ARBooleanList *existList,
ARNameList *attributeIdList,
ARUnsignedIntList *dataTypeList,
ARUnsignedIntList *attributeTypeList,
CMDBClassNameIdList *baseClassNameIdList,
ARInternalIdList *arsubclassesIdList,
ARPropListList *characList,
ARPropListList *customCharacList,
Input arguments
Input argument
Description
control
classNameId
BMC Atrium Core 9.0
Page 1419 of 2268
Home
Input argument
Description
The name of the class to which the attributes belong. The classNameID argument contains the
namespace name and unique class name.
getHiddenAttrs
A flag indicating whether to retrieve hidden attributes. If set to FALSE, hidden attributes are not
retrieved.
getDerivedAttrs
A flag indicating whether to retrieve attributes derived from a superclass. If set to FALSE, derived
attributes are not retrieved.
nameList
A list of attributes to retrieve.
attrCharacQueryList
A list of attribute characteristic queries to retrieve.
Return values
Return value
Description
existList
A list of flags and corresponding Boolean values indicating whether the attribute list exists. The value
TRUE indicates that the attribute list exists; FALSE indicates that the attribute list does not exist.
attributeNameList
The list of attribute names retrieved.
attributeIdList
The list of IDs of the attributes retrieved.
dataTypeList
The list of data types for the attributes.
attributeTypeList
The types of attributes to retrieve:

1: Core Internal--Hidden attributes that are available to BMC Atrium CMDB for internal use (
2: Core--Attributes that are available for internal use only ( CMDB_ATTR_TYPE_CORE ). Apart
from modifying the labels, you cannot make any other changes to the internal attributes.
3: Regular--Attributes that you can create ( CMDB_ATTR_TYPE_REGULAR ).
baseClassNameIdList
The list of base class name IDs for which you want to retrieve the attribute.
arsubclassesIdList
The BMC Remedy AR System subclass IDs for which you want to retrieve the attribute.
entryModeList
4: Display only--Users cannot enter data
(CMDB_ATTR_ENTRYMODE_DISPLAY_ONLY ).
attributeLimitList
The list of value limits for the attribute and other properties specific to the attributes' types. See the
CMDBsubclassesLimitStruct definition in cmdb.h to find the contained structure that applies to
the type of attributes that you are retrieving. The limits and properties that you assign must be of the
same data type as the attribute. If you do not want to change the attribute limits and properties,
specify NULL for this parameter.
defaultValueList
The list of default values to apply if a user does not specify any values for the attributes. The default
value can be up to 255 bytes and must be of the same data type as the attribute.
characList
A list of characteristics for the attribute:
BMC Atrium Core 9.0
Page 1420 of 2268
Home
Return value
Description
attribute (CMDB_ATTR_CHARAC_VIEW_PERMS ). When querying for attributes, you see all
for the permissions, separated by a semicolon, for example, 20;-5.
This setting marks the attribute as hidden for a group or a role. When querying for classes, you
can retrieve hidden attributes. You can specify one or more group IDs or role IDs for the
CMDB_ATTR_CHARAC_PRIMARY_KEY ).
the attribute is propagated (CMDB_ATTR_CHARAC_PROPAGATED_OWNER ). The format for this
value is <sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<
2 --CMDB_ATTR_CREATE_MODE_PROTECTED --Only users with permissions can specify
a value for the attribute.
7: Audit Option--Set the audit option on to store the audit history for the attribute
(CMDB_ATTR_CHARAC_AUDIT_OPTION ).
customCharacList
CMDB_ATTR_CUSTOM_CHARAC_MIN ) and 399999 (CMDB_ATTR_CUSTOM_CHARAC_MAX ).
status
CMDBGetMultipleInstances function
The CMDBGetMultipleInstances function retrieves multiple instances of the specified class in a
dataset.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetMultipleInstances(
ARNameList *instanceIds,
BMC Atrium Core 9.0
Page 1421 of 2268
Home
ARBooleanList *existList,
CMDBAttributeValueListList *attributeValueListList,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which to retrieve the instances. The classNameID argument contains the
datasetId
this parameter.
getMask
instanceIds
A list of instance IDs to retrieve.
attributeGetList
Return values
Return value
Description
existList
A list of flags and corresponding Boolean values indicating whether the attribute list exists. The
value TRUE indicates that the attribute list exists; FALSE indicates that the attribute list does not
exist.
A list of one or more attribute and value pairs retrieved for the specified list of instances.
status
CMDBGetCMDBUIComponents function
The CMDBGetCMDBUIComponents function retrieves a list of UI components for a specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetCMDBUIComponents(
CMDBUIComponentInfo *inputInfo,
BMC Atrium Core 9.0
Page 1422 of 2268
Home
CMDBUIComponentResultList *outputInfo,
Input arguments
Input
argument
Description
control
inputInfo
The qualification for the user interface component. You can specify information such as locale, classId, and tags
to retrieve the required UI component data. If no qualifications are specified, all existing UI components are
returned.
datasetId
The dataset ID of the specific CI for which you want to retrieve the UI components. For example, to retrieve
component data for an instance of BMC_ComputerSystem, specify the dataset ID for that instance. If you do not
specify the instanceId parameter for this function, the datasetId parameter is ignored.
instanceId
The unique identifier of the instance for which you want to retrieve the UI component information.
Return Values
Return value
Description
outputInfo
The CMDBUIComponents result set for the specified qualifications.
status
CMDBGetJobRun function
The CMDBGetJobRun function retrieves job information and the log for the currently running
Reconciliation Engine job. For information about interpreting job run logs and job run information,
see the BMC Atrium Core Installation Guide.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetJobRun(
ARREJobRunInfoStruct *jobRunInfo,
char **jobRunLog
Input arguments
BMC Atrium Core 9.0
Page 1423 of 2268
Home
Input
argument
Description
control
jobRunId
Return values
Return value
Description
jobRunInfo
The job run information to retrieve.
jobRunLog
The job run log to retrieve.
status
CMDBGetListJobRun function
The CMDBGetListJobRun function returns a list of running Reconciliation Engine jobs. The job list
is retrieved based on the qualification passed to the function.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetListJobRun(
CMDBQualifierStruct *jobQualifier,
ARREJobRunInfoList *jobRunInfoList,
Input arguments
Input
argument
Description
control
jobQualifier
A query that determines the set of entries to retrieve. The qualification can include one or more subclasses and
any combination of conditional, relational, and arithmetic operations. For more information about how to
construct a qualifier, see "Building qualifications and expressions," in the BMC Remedy Action Request System
Workflow Objects Guide. The following qualifiers are supported: Run Status*, Run Start Time, Run End Time,
Job Instance ID*, Job Run ID, and Submitter.
Return values
BMC Atrium Core 9.0
Page 1424 of 2268
Home
Return value
Description
jobRunInfoList
The list of running jobs that match the qualification criteria.
numMatches
The total number of jobs that match the qualification criteria.
status
CMDBGetRelatedFederatedInContext function
The CMDBGetRelatedFederatedInContext function returns related
BMC_FederatedInterface instances for a specific CI.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetRelatedFederatedInContext(
CMDBAttributeValueListList *attrValueListList,
ARStatusList *status
Input arguments
Input argument
Description
control
classNameId
The class name for which to retrieve the federated instances. The classNameID argument contains the
datasetId
The dataset ID of the instance to retrieve.
instanceId
The instance ID of the specific instance for which federated instances are to be retrieved.
attributeGetList
The list of attribute names to retrieve.
Return values
Return value
Description
instanceIdList
The list of instance GUIDs.
attrValueListList
BMC Atrium Core 9.0
Page 1425 of 2268
Home
Return value
Description
A list of one or more attribute and value pairs (specified in any order). You must specify values for all
required attributes that do not have defined defaults. Values must be of the data type defined for the
attributes or have a data type of 0. NULL values can be specified for optional attributes only. An error is
generated if an attribute does not exist or the user specified by the control parameter does not have
write permission for an attribute.
status
CMDBGetServerPort function
The CMDBGetServerPort function retrieves information about the BMC Atrium CMDB server port.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGetServerPort(
int *tcpPort,
int *rpcPort,
Input argument
Input
argument
Description
control
Return values
Return value
Description
tcpPort
Retrieves the TCP port number for the BMC Atrium Core server.
rpcPort
Retrieves the RPC port number for the BMC Atrium Core server.
status
CMDBGetVersions function
The CMDBGetVersions function retrieves the version information for any BMC Atrium Core
component that is installed.
Synopsis
#include "ar.h"
BMC Atrium Core 9.0
Page 1426 of 2268
Home
int CMDBGetVersions(
ARNameList *appIdList
ARBooleanList *existList
CMDBVersionInfoList *versionInfoList
Input arguments
Input
argument
Description
control
appIdList
A list of application IDs for which the version information is required. Specify a NULL value in this argument to get
version information of all the existing applications.
Return values
Return value
Description
existList
A list of TRUE or FALSE values. Each value in this list denotes whether the corresponding application IDs
in the supplied appIdList exists.
versionInfoList
A list of BMC Atrium Core version structures.
status
The CMDBGraphQuery function searches for relationships and endpoints related to a specific CI.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGraphQuery(
CMDBClassNameId *startClassNameId,
ARNameType startExtensionId,
ARNameType startInstanceId,
int numLevels,
int direction,
ARBoolean noMatchProceed,
ARBoolean onMatchProceed,
CMDBGraphList *queryGraph,
CMDBGetObjectList *objects,
BMC Atrium Core 9.0
Page 1427 of 2268
Home
CMDBGetRelationList *relations,
Input arguments
Input argument
Description
control
startClassNameId
The name of the class for which you want to retrieve relationships and instances. The classNameID
argument contains the namespace name and the unique class name.
datasetId
this parameter.
getMask
startExtensionId
The extension ID of the class for which you want to retrieve relationships and instances. This is required if
the query graph contains the same CI class more than once and needs to distinguish one from another.
startInstanceId
The instance ID of the class for which you want to retrieve relationships and instances.
numLevels
The number of levels to traverse in the specified queryGraph. The value A-1 specifies the query to
traverse to the end of the graph.
direction
The direction in which the graph is to traverse.

0: Out--Return all relationships for the starting node where an endpoint is the destination node (
CMDB_RELATIONSHIP_DIRECTION_OUT ).
1: In--Return all relationships for the starting node where an endpoint is the source node (
CMDB_RELATIONSHIP_DIRECTION_IN ).
2: Both--Return all relationships for the starting node where an endpoint is source or destination(
CMDB_RELATIONSHIP_DIRECTION_BOTH ).
noMatchProceed
Specifies whether to proceed with the query when the node returned for a given relationship instance
does not match the criteria.T (1): When the node returned for a given relationship instance does not
match the criteria specified, proceed to the next relationship. No relationship information is returned
because the returned components might not be connected (because the nonmatching nodes are skipped).
F (0): When the node returned for a given relationship instance does not match the criteria specified, do
not proceed any further.
onMatchProceed
Specifies whether to proceed with the query when the node returned for a given relationship instance
matches the criteria.T (1): When the node returned for a given relationship instance matches the criteria
specified, proceed to the next relationship.F (0): When the node returned for a given relationship instance
matches the criteria specified, do not proceed further.
queryGraph
Indicates the path that needs to be queried to return the desired CIs and relationships
Return values
BMC Atrium Core 9.0
Page 1428 of 2268
Home
Return value
Description
objects
List of one or more CI instances matching the specified criteria. The starting node is not included.
relations
List of relationship instances that connects the returned CIs and that match the specified criteria.
status
CMDBGraphWalkBegin function
The CMDBGraphWalkBegin function specifies the start node for retrieving CI and relationship
instances in a chunk. This function sets up the starting node and query parameters for the graph
walk.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGraphWalkBegin(
CMDBClassNameId *startClassNameId,
ARNameType *startInstanceId,
CMDBGraphWalkQueryStruct *graphWalkQueryStruct,
CMDBGraphWalkStateStruct *graphWalkStateStruct,
Input arguments
Input argument
Description
control
startClassNameId
The name of the starting node class. The classNameID argument contains the namespace name
and the unique class name.
startInstanceId
The instance ID of the starting node for the query.
graphWalkQueryStruct
Specifies information such as the dataset ID of the instances to retrieve, number of levels to walk in
the relationship map, the maximum number of rows to retrieve, and the query mode for the query.
Return values
Return value
Description
graphWalkStateStruct
The status of the list of classes walked in the query, next chunks availability, and the next object
index. This structure, which is for internal use only, is used as an input argument for the
CMDBGraphWalkNext function.
status
BMC Atrium Core 9.0
Page 1429 of 2268
Home
CMDBGraphWalkEnd function
The CMDBGraphWalkEnd function ends the graph walk. Use this function after you retrieve the CI
and relationship information using the CMDBGraphWalkNext function.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGraphWalkNext(
Input argument
Input
argument
Description
control
Return values
Return value
Description
The status of the last node walked in the CI and relationship graph.
status
CMDBGraphWalkNext function
The CMDBGraphWalkNext function moves to the next chunk of nodes to retrieve in the graph walk.
This function is used after setting up the start node in the CI and relationship graph using the
CMDBGraphWalkBegin function.
You do not need to specify values for any of the parameters of the function. To retrieve rows in
chunks, use only the hasNextChunk member of the CMDBGraphWalkStateStruct structure.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBGraphWalkNext(
BMC Atrium Core 9.0
Page 1430 of 2268
Home
CMDBGraphWalkResultStruct *graphWalkResultStruct,
Input arguments
Input argument
Description
control
The status of the start node setup for the graph walk query before performing the next query chunk.
This structure is for internal use only.
Return values
Return value
Description
The status of the graph walk after the next chunk is queried.
graphWalkResultStruct
The list of CI and relationship instances returned by the query.
status
CMDBImportData function
The CMDBImportData function imports the specified instance data.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBImportData(
unsigned int importOption,
char *importBuf,
CMDBImportDataSummaryStruct *impSummary,
Input arguments
Input
argument
Description
control
importOption
A value that indicates how to manage duplicates found during the importing of instance data. These options are
mutually exclusive.
1: Error--Generate an error ( CMDB_DATA_IMPORT_OPT_ERROR_FOR_DUP ).
BMC Atrium Core 9.0
Page 1431 of 2268
Home
Input
argument
Description
2: New ID for duplicates--Create an instance with a new instance ID if the instance ID already exists (
CMDB_DATA_IMPORT_OPT_NEWID_FOR_DUP ).
3: Merge--Update the existing instance if the instance ID specified already exists (
CMDB_DATA_IMPORT_OPT_MERGE_FOR_DUP ).
4: New ID for all--Create a new instance ID for all the imported instances, including those instances that
are not duplicates ( CMDB_DATA_IMPORT_OPT_NEWID_FOR_ALL ).
The import buffer, which contains the class data in XML format to import.
importBuf
Return value
Return
Description
value
impSummary
The CMDBImportDataSummaryStruct structure, which contains the summary of the data import, such as total
number of items that were set to be imported, total number of items that were imported successfully, and the total
number of items for which the import failed.
status
CMDBImportDef function
The CMDBImportDef function imports a list of specified class definitions.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBImportDef(
CMDBXMLImportItemList *importItemList,
unsigned int importOption,
char *importBuf,
Input arguments
Input argument
Description
control
importItemList
A list of zero or more items to import. Specify NULL for this parameter to import all definitions in the import
buffer.
importOption
A value indicating whether to replace class definitions being imported if they already exist. If an import item
already exists, the function generates an error.
1: Create--Generate an error if an item to import already exists ( CMDB_DEF_IMPORT_OPT_CREATE ).
BMC Atrium Core 9.0
Page 1432 of 2268
Home
Input argument
Description
2: Overwrite--Overwrite if an item to import already exists ( CMDB_DEF_IMPORT_OPT_OVERWRITE ).
The import buffer that contains the class definitions in XML format to import.
importBuf
Return value
Return value
Description
status
CMDBInitialization function
The CMDBInitialization function initializes the C API session. You must invoke this function
before any other C API calls.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBInitialization(
Input argument
Input
argument
Description
control
Return value
Return value
Description
status
The CMDBQueryByPath function retrieves a list of instances for the specified qualifications. To
improve the performance of the queries, add indexes on attributes that are frequently used in the
qualification.
BMC Atrium Core 9.0
Page 1433 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBQueryByPath(
CMDBQueryStruct *query,
CMDBQueryResult *result,
Input arguments
Input
argument
Description
control
query
A query that determines the list of instances to return. The qualification can include one or more subqueries and any
combination of conditional, relational, and arithmetic operations.
Return values
Return value
Description
result
The list of instances returned for the specified qualifications.
status
CMDBRemoveClientManagedTransaction function
The CMDBRemoveClientManagedTransaction function enables you to remove the client
managed database transaction. All the subsequent calls for this control record will not be part of the
transaction associated with the transaction handle.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBRemoveClientManagedTransaction(
Input argument
BMC Atrium Core 9.0
Page 1434 of 2268
Home
Input
argument
Description
control
Return value
Return value
Description
status
CMDBRunQualificationForCI function
The CMDBRunQualificationForCI function validates a list of attributes for a specified CI. The
CMDBRunQualificationForCI function takes qualification parameters in structured and
encoded modes.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBRunQualificationForCI(
CMDBAttributeValueList *attValueList,
ARBoolean *passed,
Input arguments
Input
argument
Description
control
qualifier
A query that determines the set of CIs to retrieve. The qualification can include one or more subclasses and
any combination of conditional, relational, and arithmetic operations. For more information about how to
construct a qualifier, see "Building qualifications and expressions," in the BMC Remedy Action Request System
Workflow Objects Guide.
attValueList
The list of one or more attribute and value pairs (specified in any order) to validate. Values must be of the data
type defined for the attributes or have a data type of 0.
Return values
Return value
Description
passed
A Boolean value that specifies whether the qualification passed.
BMC Atrium Core 9.0
Page 1435 of 2268
Home
Return value
Description
status
CMDBSetAttribute function
The CMDBSetAttribute function sets an attribute with the specified name for the specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetAttribute(
ARNameType newAttributeName,
unsigned int *entryMode,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which the attribute needs to set. The classNameID argument contains the
attributeName
The name of the attribute to set.
newAttributeName
The new name of the attribute, which must be unique within the specified class and within its
superclasses and subclasses.
entryMode
The list of entry modes for the attribute being set. Entry modes not listed are for BMC Software internal
use.
attributeLimit
The list of value limits for the attribute and other properties specific to the attribute's type. See the
type of attribute that you are modifying. The limits and properties that you assign must be of the same
data type as the attribute. If you do not want to change the attribute limits and properties, specify NULL
for this parameter.
BMC Atrium Core 9.0
Page 1436 of 2268
Home
Input argument
Description
defaultValue
The value to apply if a user does not specify a value for the attribute. The default value can be up to 255
bytes in length and must be of the same data type as the attribute.
characList

attribute is propagated (CMDB_ATTR_CHARAC_PROPAGATED_OWNER ). The format for this value is
<sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<destinationAttributeId>|[<
additionalPairs>].
7: Audit Option--Set the audit option on to store the audit history for the attribute
(CMDB_ATTR_CHARAC_AUDIT_OPTION ).
8: Namespace--Set the namespace of the attribute ( CMDB_ATTR_CHARAC_NAMESPACE ).
9: Description--Set the description for the attribute
(CMDB_ATTR_CHARAC_DESCRIPTION ).
customCharacList
A list of user-defined custom characteristics for the attribute. The attribute must be between 300000 (
CMDB_ATTR_CUSTOM_CHARAC_MIN ) and 399999 (CMDB_ATTR_CUSTOM_CHARAC_MAX ). To delete a
custom characteristic, set its data type to NULL.
Return value
Return value
Description
status
CMDBSetClass function
The CMDBSetClass function sets the class properties in the OBJSTR:Class form. After you create
a class, you cannot change the following properties: namespace, classId, classType (CI or
relationship), and persistence provider.
BMC Atrium Core 9.0
Page 1437 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetClass(
CMDBClassNameId *newclassNameId,
CMDBAuditInfoStruct *auditInfo,
Input arguments
Input argument
Description
control
classNameId
The class to set. The classNameID argument contains the namespace name and the unique class name
.
newclassNameId
The new name of the class. The newclassNameID argument contains the namespace name and the
unique class name.
classTypeInfo
Information about the type of class.
indexList
The list of indexes defined for the class. When this parameter is specified, all previously existing indexes
are replaced by its contents. To add indexes without losing existing indexes, include the existing indexes
in this list.
auditInfo
The audit information for the class: audit type, qualification, and Audit Only Changed Fields ( auditMask )
. Use the following auditMask values:
CMDB_CLASS_AUDITCHANGE_DEFAULT = 0 --Use the value of the Disable Audit Only Change
CMDB_CLASS_AUDITCHANGE_YES = 1 --Audit when an updated field value is different than the
existing value.
CMDB_CLASS_AUDITCHANGE_NO = 2 --Audit when a field value is modified, even if the updated
characList
A list of characteristics for this class. Specify NULL for this parameter if you do not want to
associate characteristics with this class. Characteristics not listed are for BMC Software internal
use.
BMC Atrium Core 9.0
Page 1438 of 2268
Home
Input argument
Description
6: Hidden permissions--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_HIDDEN_PERMS ). Marks the class as hidden for the users in the
group. When querying for classes, you can choose to retrieve hidden classes.
7: Visible permissions--Gives you the permissions to modify the class (
CMDB_CLASS_CHARAC_CLASS_VISIBLE_PERMS ). Marks the class as visible for the users in the
group. When querying for classes, you will see all classes including the hidden classes.
8: Categorizationq--(CMDB_CLASS_CHARAC_CATEGORIZATION_SUBCLASS ).
9: Form name--(CMDB_CLASS_CHARAC_FORM_NAME ).
where:
endpoints.
17: Number of temp tables; allows you to define the maximum number of temporary tables to
data type, where:
.
BMC Atrium Core 9.0
Page 1439 of 2268
Home
Input argument
Description
customCharacList
A list of user-defined custom characteristics for the class. The value can be set to any user-defined
characteristic but must be between 100000 (CMDB_CLASS_CUSTOM_CHARAC_MIN ) and 199999 (
CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do not want to associate custom characteristics with this
class, specify NULL for this parameter. To delete a custom characteristic, set its data type to NULL.
Return value
Return value
Description
status
CMDBSetClientManagedTransaction function
The CMDBSetClientManagedTransaction function enables you to set a client managed
database transaction handle to the given user context. After the transaction handle is set then all
the subsequent calls will be in the same transaction associated with this handle. With this function,
you can make data calls on different user contexts in the same transaction.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetClientManagedTransaction(
char *transactionHandle,
Input argument
Input argument
Description
control
transactionHandle
The transaction handle ID of the database transaction.
Return value
Return value
Description
status
CMDBSetInstance function
The CMDBSetInstance function sets attribute values for a CI or relationship instance of the
specified class.
BMC Atrium Core 9.0
Page 1440 of 2268
Home
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetInstance(
Input arguments
Input argument
Description
control
classNameId
The name of the class to which the instance to set belongs. The classNameID argument contains the
datasetId
The unique identifier for the dataset. Instances in a dataset are modified based on the dataset ID
specified in this parameter.
instanceId
The unique identifier for the instance (system-generated).
attributeValueList
A list of one or more attribute and value pairs (specified in any order) that identifies the data for the new
attribute. You must specify values for all required attributes that do not have defaults defined. Values
must be of the data type defined for the attributes or have a data type of 0. NULL values can be
specified for optional attributes only. An error is generated if an attribute does not exist or the user
specified by the control parameter does not have write permission for an attribute.
Return value
Return value
Description
status
CMDBSetMultipleAttributes function
The CMDBSetMultipleAttributes function sets multiple attributes with the specified names for
the specified class.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetMultipleAttribute(
BMC Atrium Core 9.0
Page 1441 of 2268
Home
ARNameList *newAttributeNameList,
ARPropListList *characListList,
ARPropListList *customCharacListList,
Input arguments
Input argument
Description
control
classNameId
The name of the class for which the attributes need to be set. The classNameID argument contains
the namespace name and the unique class name.
attributeNameList
The list of attributes to set.
newAttributeNameList
The list of new names of the attributes. The names of each attribute must be unique within the
specified class and within its superclasses and subclasses.
entryModeList
The list of entry modes for the attributes being set. Entry modes not listed are for BMC Software
internal use.
attributeLimitList
The list of value limits for the attributes being set and other properties specific to the attributes' types.
See the CMDBsubclassesLimitStruct definition in cmdb.h to find the contained structure that
applies to the type of attributes that you are modifying. The limits and properties that you assign
must be of the same data type as the attributes. If you do not want to change the attributes' limits
and properties, specify NULL for this parameter.
defaultValueList
The list of default values to apply if a user does not specify a value for each of the attributes. The
default value can be up to 255 bytes in length and must be of the same data type as the attribute.
Specify NULL if you do not want to specify a default value
characList

attribute (CMDB_ATTR_CHARAC_VIEW_PERMS). When querying for attributes, you see all
for the permissions, separated by a semicolon, for example, 20;-5.
3: Hidden--Set the flag to false so that this attribute is hidden ( CMDB_ATTR_CHARAC_HIDDEN
). This setting marks the attribute as hidden for a group or a role. When querying for classes,
you can retrieve hidden attributes. You can specify one or more group IDs or role IDs for the
BMC Atrium Core 9.0
Page 1442 of 2268
Home
Input argument
Description
the attribute is propagated (CMDB_ATTR_CHARAC_PROPAGATED_OWNER ). The format for this
value is <sourceAttributeId>;<destinationAttributeId>|<sourceAttributeId>;<
2 --CMDB_ATTR_CREATE_MODE_PROTECTED --Only users with permissions can
specify a value for the attribute.
8: Namespace--Set the namespace of the attribute ( CMDB_ATTR_CHARAC_NAMESPACE ).
customCharacListList
A list of user-defined custom characteristics list for the attribute. The value can be set to any
user-defined characteristic but must be between 100000 (CMDB_CLASS_CUSTOM_CHARAC_MIN )
and 199999 (CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do not want to associate custom
characteristics with this attribute, specify NULL for this parameter. To delete a custom characteristic,
set its data type to NULL.
Return value
Return value
Description
status
CMDBSetMultipleInstances function
The CMDBSetMultipleInstances function sets attribute values for CI or relationship instances
in the specified dataset.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetMultipleInstances(
Input arguments
BMC Atrium Core 9.0
Page 1443 of 2268
Home
Input
argument
Description
control
datasetId
The unique identifier for the dataset. Instances in a dataset are modified based on the dataset ID specified in this
parameter.
instances
The list of instance IDs and attribute values to set.
Return value
Return value
Description
status
CMDBSetServerPort function
CMDBSetServerPort function sets the TCP and RPC port number information for the BMC Atrium
CMDB server.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSetServerPort(
int *tcpPort,
int *rpcPort,
Input arguments
Input
argument
Description
control
tcpPort
The TCP port number that your program will use to communicate with the BMC Remedy AR System server. If you do
not specify this parameter or provide 0 for the port number, your program will use the port number supplied by the
portmapper. This parameter is overridden by the ARTCPPORT environment variable.
rpcPort
The RPC port number for the BMC Atrium Core server. Specify 390697 to use the admin thread. The default RPC
port number is 390696.
Return value
BMC Atrium Core 9.0
Page 1444 of 2268
Home
Return value
Description
status
CMDBStartJobRun function
The CMDBStartJobRun function starts an existing Reconciliation Engine job. Before starting a job,
make sure the job is defined and exists in the Active state. If no job for the specified job name
exists or the job is not Active, the CMDBStartJobRun function returns an error. Only one instance
of a specific job can be executed at a given time.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBStartJobRun(
ARNameType jobName,
CMDBClassQualList *classQualList,
CMDBREDatasetList *datasetList
Input arguments
Input argument
Description
control
jobName
The name of the reconciliation job.
classQualList
The list of class qualifications with which to substitute the Qualification group defined for the job. In the
qualification list, specify the class ID and the qualification that applies to it, for example:"
BMC_ComputerSystem", {"1", "('ReconciliationId' = NULL AND'CreateDate' > ($
TIMESTAMP$ - 86400))"}.
datasetList
The list of dataset pairs, where the first one represents the substitution dataset (working dataset) and the
second represents the dataset defined in the Reconciliation Engine job (defined dataset), for example: "2",
{"BMC.IMPORT.CONFIG", BMC.SAMPLE"}.
Return values
Return value
Description
jobRunId
status
BMC Atrium Core 9.0
Page 1445 of 2268
Home
CMDBSynchMetaData function
The CMDBSynchMetaData function creates BMC Remedy AR System forms from the metadata
instance in the OBJSTR:Class and OBJSTR:AttributeDefinition forms.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSynchMetaData(
ARNameType pendingId,
CMDBClassNameIdList *classNameIdList,
Input arguments
Input
argument
Description
control
pendingId
The ID of the object to be synchronized with the system.
Return values
Return value
Description
classNameIDList
The list of classes that are successfully synchronized with the system. The classNameID argument
status
CMDBSystemInit function
The CMDBSystemInit function performs server- and network-specific initialization operations for
internal use by BMC.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBSystemInit(
ARPropList *propList,
BMC Atrium Core 9.0
Page 1446 of 2268
Home
Return values
Return value
Description
propList
A list of properties that need to be initialized.
status
CMDBTermination function
The CMDBTermination function performs environment-specific cleanup routines and disconnects
from the session. All API programs that interact with the Class Manager session should call this
function upon completing work in the session.
Synopsis
#include "ar.h"
#include "cmdb.h"
int CMDBTermination(
Input argument
Input
argument
Description
control
Return value
Return value
Description
status

This section describes how to find CIs related to each other by using the BMC Atrium CMDB C API
query functions.
Although this section does not discuss specific elements of the Java API and web services API, the
concepts and strategies discussed here are the same for them. For more information about the
query function equivalents in the Java API, see BMC Atrium CMDB Javadoc Help installed in the
cmdb/sdk/javadoc/cmdbapi/ subdirectory of your BMC Atrium Core installation directory. For
more information about BMC Atrium Core Web Services query operations, see Web Services API
functions.
BMC Atrium Core 9.0
Page 1447 of 2268
Home

Function
Description
CMDBQueryByPath
function overview
The CMDBQueryByPath function is used to query BMC Atrium CMDB for CI and relationship information.
Use this function when you know the exact relationship path to follow.
Graph Walk Query
The graph walk function is used to retrieve CI and relationship instances when you do not know the exact
function overview
relationship path to follow
CMDBGraphQuery
function overview
The CMDBGraphQuery function allows you to explore (walk) the graph of CIs and relationships in the BMC
Atrium CMDB, starting with a specified CI and following its relationships to other CIs, continuing along the
graph for as many levels as you want.
CMDBQueryByPath function overview

You can use the CMDBQueryByPath function to query BMC Atrium CMDB for CI and relationship
information. Use this function when you know the exact relationship path to follow. For example, to
view all computer systems in the Payroll division, you could use CMDBQueryByPath to query from
BMC_ComputerSystem through a BMC_MemberOfCollection relationship to
BMC_Organization.
Structure of the CMDBQueryByPath function

Unlike the CMDBGraphQuery function, which requires the graph adjacency list to traverse
relationships, the CMDBQueryByPath function takes each qualification as a structure and
dynamically generates the query. The following figure illustrates the structure of the
CMDBQueryByPath function and its parameters.
CMDBQueryByPath structure diagram
BMC Atrium Core 9.0
Page 1448 of 2268
Home
Example- Finding all computers in the payroll division using the

This CMDBQueryByPath example uses a common query scenario, where you want to search for all
computers in a specific division in your organization.
At the fictional Calbro Services company, Allen Allbrook wants to view all the computers in the
payroll division to compare their configurations. Because Allen knows the exact data model path to
follow in the query, he uses the CMDBQueryByPath function in his program.
For information about the CIs and relationships in the common data model, see the BMC Atrium
CMDB Common Data Model Diagram. The following pseudocode shows the construct for building
the query.
BMC_ComputerSystem > BMC_MemberOfCollection --> BMC_Organization '
BusinessCategory'=Payroll
To search for all computers within the payroll division, Allen needs to query the
BMC_ComputerSystem and the BMC_Organization classes that share a
BMC_MemberOfCollection relationship and where the BusinessCategory attribute of the
BMC_Organization class is equal to Payroll.
BMC Atrium Core 9.0
Page 1449 of 2268
Home
In the following sample program, Allen creates the queryObjects, queryObjectsOptional,

qObj, and query variables. He then initializes these variables with specific values and passes them
to the CMDBQueryByPath function as parameters.
/*declare variables*/
CMDBQueryObjectList queryObjects;
CMDBQueryObjectList queryObjectsOptional;
CMDBQueryObject *qObj;
CMDBQueryStruct query;
CMDBQueryStruct query;
/*Reset the memory space allocated for the query variable*/
memset(&query, 0, sizeof(CMDBQueryStruct));
memset(&query, 0, sizeof(CMDBQueryStruct));
/*Set values to the members of the query structure*/
strcpy(query.datasetId, "BMC.ASSET");
query.datasetMask = 0;
query.datasetMask = 0;
/*Reset the memory space allocated for the queryObjects variable*/
memset(&queryObjects, 0, sizeof(CMDBQueryObjectList));
/*Set values to the members of the queryObjects structure*/
queryObjects.numItems = 3;
queryObjects.queryObjectList = (CMDBQueryObject *) calloc(3, sizeof(CMDBQueryObject));
queryObjects.queryObjectList = (CMDBQueryObject *) calloc(3, sizeof(CMDBQueryObject));
/* Initialize the qObj CMDBQueryObject structure for the BMC_ComputerSystem class*/
qObj = &queryObjects.queryObjectList[0];
strcpy(qObj->classNameId.namespaceName,"BMC.CORE");
strcpy(qObj->classNameId.className, "BMC_ComputerSystem ");
strcpy(qObj->alias, "class1");
qObj->qualification = NULL;
/* Initialize the second query object for the BMC_MemberOfCollection class*/
strcpy(qObj->classNameId.className, "BMC_MemberOfCollection");
strcpy(qObj->alias, "relationship1");
/* Initialize the third query Object for the BMC_Organization class*/
strcpy(qObj->classNameId.className, "BMC_Organization ");
/*Memory space allocated to contain qualification for the BMC_Organization class*/
qObj->qualification = ( *) calloc (sizeof(), 1);
qObj->qualification = ( *) calloc (sizeof(), 1);
/*Specify SIMPLE type operation for the qualification*/
qObj->qualification->operation = CMDB_QUERY_QUAL_OP_SIMPLE;
BMC Atrium Core 9.0
Page 1450 of 2268
Home
qObj->qualification->u.simpleOp = (CMDBQueryQualifierSimpleOpStruct *) calloc (sizeof(

CMDBQueryQualifierSimpleOpStruct), 1);
qObj->qualification->u.simpleOp = (CMDBQueryQualifierSimpleOpStruct *) calloc (sizeof(
CMDBQueryQualifierSimpleOpStruct), 1);
/*Specify the attribute and arithmetic condition for the qualification*/
qObj->qualification->u.simpleOp->operation = CMDB_QUERY_QUAL_SIMPLEOP_EQUAL;
strcpy(qObj->qualification->u.simpleOp->attribute, "BusinessCategory");
strcpy(qObj->qualification->u.simpleOp->attribute, "BusinessCategory");
/*Specify the expression to the right of the condition (right operand)*/
qObj->qualification->u.simpleOp->operandRight = (CMDBQueryQualifierValueStruct *)
calloc (sizeof(CMDBQueryQualifierValueStruct), 1);
qObj->qualification->u.simpleOp->operandRight = (CMDBQueryQualifierValueStruct *)
calloc (sizeof(CMDBQueryQualifierValueStruct), 1);
/*Specify the operand type for the right operand*/
qObj->qualification->u.simpleOp->operandRight->type = CMDB_QUERY_QUAL_VALUE_TYPE_VALUE
;
qObj->qualification->u.simpleOp->operandRight->u.value.dataType = AR_DATA_TYPE_CHAR;
qObj->qualification->u.simpleOp->operandRight->u.value.dataType = AR_DATA_TYPE_CHAR;
/* Specify the literal value for the comparison in the qualification*/
qObj->qualification->u.simpleOp->operandRight->u.value.u.charVal = strdup("Payroll");
qObj->qualification->u.simpleOp->operandRight->u.value.u.charVal = strdup("Payroll");
/*Specifies the object type for the top level object in the query*/
qObj->queryObjectType = CMDB_QUERY_OBJECT_TYPE_REGULAR;
qObj->queryObjectType = CMDB_QUERY_OBJECT_TYPE_REGULAR;
/*Set the queryObjectsOptional object with 0s to indicate that all attributes in the
CMDBQueryObjectSelectorList object are required*/
memset(&queryObjectsOptional, 0, sizeof(CMDBQueryObjectList));
memset(&queryObjectsOptional, 0, sizeof(CMDBQueryObjectList));
/*Initialize the querySelector object*/
memset(&querySelector, 0, sizeof(CMDBQueryObjectSelectorList));
querySelector.numItems = 1;
querySelector.queryObjectSelectorList = (CMDBQueryObjectSelectorStruct *) calloc(2,
sizeof(CMDBQueryObjectSelectorStruct));
querySelector.queryObjectSelectorList = (CMDBQueryObjectSelectorStruct *) calloc(2,
sizeof(CMDBQueryObjectSelectorStruct));
/*Initialize the selector object*/
selector = &querySelector.queryObjectSelectorList[0];
strcpy(selector->alias, "class1");
selector->attributes = (ARNameList *) calloc(sizeof (ARNameList), 1);
selector->attributes->numItems = 1;
selector->attributes->nameList = (ARNameType *) calloc(sizeof(ARNameType), 1);
selector->attributes->nameList = (ARNameType *) calloc(sizeof(ARNameType), 1);
/*Specify the name of the attribute to retrieve*/
strcpy(selector->attributes->nameList[0], "InstanceId"); querySelector.flags =
CMDB_QUERY_OBJECTSELECTOR_FLAG_DEFAULT_NONE;
query.queryObjects = &queryObjects;
query.queryObjects = &queryObjectsOptional;
query.queryObjectsToSelect = &querySelector;
query.firstRetrieve = 0;
query.maxRetrieve = 500;
result = CMDBQueryByPath(GetControlStructPtr(), &query, &resultStruct, &status);
Allen wants to query the production dataset for all computer systems in the Payroll division.
BMC Atrium Core 9.0
Page 1451 of 2268
Home
Therefore, he sets the datasetId member of the query variable to BMC.ASSET and the
datasetMask member to 0. He then initializes the members of the queryObjects object and
sets the numItems member to 3 to include the classes identified in the query:
BMC_ComputerSystem, BMC_MemberOfCollection, and BMC_Organization.
Allen sets the qObj variable to the first queryObject object in the queryObjectList. He then
initializes the Namespace, ClassName, alias, and qualification members to contain
information about the BMC_ComputerSystem class. He initializes the second queryObject
object to contain information about the BMC_MemberOfCollection class. For both
BMC_ComputerSystem and BMC_MemberOfCollection classes, he does not specify any
qualification.
Allen initializes the third queryObject object in the list to contain information about the
BMC_Organization class. Because the qualification for this class is to be specified as
BMC_Organization = 'Payroll', Allen allocates the memory space for the qualification
member. He sets the operation type for the qualification to CMDB_QUERY_QUAL_OP_SIMPLE.
Allen then specifies the qualification for the BMC_Organization class. He sets the operation
for the u.simpleOp member to CMDB_QUERY_QUAL_SIMPLEOP_EQUAL and the attribute to
BusinessCategory.
Because Allen wants to query all computers in the Payroll division, the expression to the right of the
condition in the query in this case is a literal value. Therefore, he sets the operand type for the right
operand to CMDB_QUERY_QUAL_VALUE_TYPE_VALUE. He specifies the data type of the value as
AR_DATA_TYPE_CHAR and sets the value for the right operand in the qualification to Payroll.
Allen sets the queryObjectType member of the qObj object to
CMDB_QUERY_OBJECT_TYPE_REGULAR to indicate that the class information that qObj structure
holds is a regular class. Because this query returns all the attributes specified in the selector list, he
sets the &queryObjectsOptional object to 0 s.
Allen then initializes the querySelector object with the numItems member set to 1. He initializes
the selector object, which points to the first object in the querySelector array, with values for
the nameList member. Because Allen requires only the instance IDs of the computer systems, the
InstanceId is the only attribute that is selected from the query result.
Allen sets the flags member of the querySelector object to
CMDB_QUERY_OBJECTSELECTOR_FLAG_DEFAULT_NONE, which means that no attributes are
selected from the query result by default. He sets the queryObjects, queryObjectsOptional,
querySelector, firstRetrieve, and maxRetrieve members of the query object with the
filled-in structures of each of the objects. He then finally passes these objects to the
BMC Atrium Core 9.0
Page 1452 of 2268
Home
CMDBQueryByPath function. The query result is stored in the result variable, which is of type
CMDBQueryResultStruct.
Graph walk query function overview

Use the graph walk function to retrieve CI and relationship instances when you do not know the
exact relationship path to follow, for example, to view all the dependencies of a computer system
regardless of the class to which the dependencies belong. You must know the instance from which
to begin the graph walk.
The starting node and query loop

To successfully retrieve instances using the graph walk functions, first specify the start node (
CMDBGraphWalkBegin ) for the graph walk. Then use the hasNextChunk member of the
CMDBGraphWalkStateStruct structure to loop until you retrieve all the rows that match the
query.
In the loop, you call the CMDBGraphWalkNext function until the query has no more records to
return. Chunking occurs when the maxRetrieve parameter has a value greater than 0. Otherwise,
the query returns all the nodes in the first call. For example, if the query retrieves 500 rows of data
and the maxRetrieve parameter is set to 100, the CMDBGraphWalkNext function returns 100
nodes in the first call, 100 nodes in the next, and so on.
Example- Finding all CIs related to an instance of computer system using the
graph walk query functions
This example shows how to use the graph walk query functions in a common scenario: searching
for all CIs related to a specific computer system in your organization.
At the fictional Calbro Services company, Allen Allbrook wants to view all the CIs related to the
CS000000 instance of the BMC_ComputerSystem class. Allen needs to determine the impact of
an outage of the CS000000 CI. Allen does not know the exact data model path to follow in the
query. Therefore, he uses the graph walk functions in his program.
In the following sample program, Allen first creates the CMDBGraphWalkQueryStruct,
CMDBGraphWalkStateStruct, and CMDBGraphWalkResultStruct variables, and the
CMDBGraphWalkSelectorAndFilterList data structure in his program. He then initializes
these variables with specific values and passes them to the CMDBQueryByPath function as
parameters.
/*declare variables*/
&status);
int returnCode;
CMDBClassNameId startClassNameId;
ARNameType startInstanceId;
CMDBGraphWalkQueryStruct graphWalkQueryStruct;
BMC Atrium Core 9.0
Page 1453 of 2268
Home
CMDBGraphWalkStateStruct graphWalkStateStruct;
CMDBGraphWalkResultStruct graphWalkResult;
CMDBGraphWalkSelectorAndFilterList objSelAndFilterList;
CMDBGraphWalkRelation walkLink;
CMDBGraphWalkRelationList walkList;
CMDBGraphWalkRelationList walkList;
/*Reset the memory space allocated for the query variables*/
memset(&graphWalkStateStruct,0, sizeof(CMDBGraphWalkStateStruct));
memset(&graphWalkResult,0, sizeof(CMDBGraphWalkResultStruct));
memset(&objSelAndFilterList, 0, sizeof(CMDBGraphWalkSelectorAndFilterList));
memset(&walkLink, 0, sizeof(CMDBGraphWalkRelation));
memset(&walkLink, 0, sizeof(CMDBGraphWalkRelation));
/*Set values to graph walk flags*/
objSelAndFilterList.attrFlag = CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ALL;
objSelAndFilterList.objFlag = CMDB_GRAPH_WALK_OBJECT_FLAG_DEFAULT_ALL;
objSelAndFilterList.objFlag = CMDB_GRAPH_WALK_OBJECT_FLAG_DEFAULT_ALL;
/*Set values to the CMDBGraphWalkRelation and CMDBGraphWalkRelationList structure
members*/
strcpy(walkLink.classNameId.namespaceName, "BMC.CORE");
strcpy(walkLink.classNameId.className, "BMC_BaseRelationship");
walkLink.qualification = NULL;
walkLink.direction = CMDB_RELATIONSHIP_DIRECTION_OUT;
walkList.attrFlag = CMDB_GRAPH_WALK_ATTRIBUTE_FLAG_DEFAULT_ALL;
walkList.numItems = 1;
walkList.walkRelationList = &walkLink;
strcpy(startClassNameId.namespaceName, "BMC.CORE");
strcpy(startClassNameId.className, "BMC_ComputerSystem");
strcpy(startInstanceId, "CS000000");
strcpy(startInstanceId, "CS000000");
/*Set values to the CMDBGraphWalkQueryStruct structure members*/
memset(&graphWalkQueryStruct, 0, sizeof(CMDBGraphWalkQueryStruct));
strcpy(graphWalkQueryStruct.datasetId, "BMC.ASSET");
graphWalkQueryStruct.datasetMask = 0;
graphWalkQueryStruct.maxRetrieve = 10000;
graphWalkQueryStruct.numLevels = 1;
graphWalkQueryStruct.queryMode = CMDB_GRAPH_WALK_WALK_COMPLETE_GRAPH;
graphWalkQueryStruct.objSelectorAndFilterList = objSelAndFilterList;
graphWalkQueryStruct.walkRelationList = walkList;
graphWalkQueryStruct.walkRelationList = walkList;
/*Call the CMDBGraphWalkBegin function
int returnCode = CMDBGraphWalkBegin(
control, &startClassNameId, startInstanceId, &graphWalkQueryStruct, &
graphWalkStateStruct, &status );
control, &startClassNameId, startInstanceId, &graphWalkQueryStruct, &
graphWalkStateStruct, &status );
if( returnCode >= AR_RETURN_ERROR) {return returnCode;}
/* Loop until the next chunk of rows are available for retrieving*/
while(graphWalkStateStruct.hasNextChunk == TRUE)
{
/*call the CMDBGraphWalkNext to retrieve the next chunk of rows*/
returnCode = CMDBGraphWalkNext(control, &graphWalkStateStruct, &graphWalkResult, &
status );
if( returnCode >= AR_RETURN_ERROR)
{
BMC Atrium Core 9.0
Page 1454 of 2268
Home
return returnCode;
}
/* Process the results here */
FreeCMDBGraphWalkResultStruct(&graphWalkResult, FALSE);
}
/*End the graph walk*/
returnCode = CMDBGraphWalkEnd(control, &graphWalkStateStruct, &status);
FreeCMDBGraphWalkStateStruct(&graphWalkStateStruct, FALSE);
Return returnCode;
In the program, Allen sets the namespaceName member of the CMDBGraphWalkRelation

structure to BMC.CORE and the className of the type of relationships to walk to
BMC_BaseRelationship. Allen wants to retrieve only the destination relationships for the
CS000000 instance. Therefore, he sets the qualification for the relationship walk to NULL and
the walk direction to CMDB_RELATIONSHIP_DIRECTION_OUT (destination).
Allen sets the namespaceName and className members of the startClassNameId variable to
BMC.CORE and BMC_ComputerSystem, respectively. He sets the startInstanceId to
CS000000.
Because Allen wants to retrieve instances from the production dataset, he sets the datasetId
member of the graphWalkQueryStruct variable to BMC.ASSET and the datasetMask member
to 0. He sets the maxRetrieve member to 10000 and the numLevels to 1 to indicate that he
wants to enable chunking.
Allen passes the startClassNameId, startInstanceId, graphWalkQueryStruct, and
graphWalkStateStruct parameters as inputs to the CMDBGraphWalkBegin function. The
hasNextChunk member of the graphWalkStateStruct parameter now contains a value of TRUE to
indicate that the next chunk of rows is available to be retrieved.
Allen calls the CMDBGraphWalkNext function in a While loop with the hasNextChunk member as
the condition. The next chunk of rows will be retrieved until hasNextChunk is equal to TRUE. He
then calls the CMDBGraphWalkEnd function to end the graph walk query.
The query that Allen constructed in this example returns all the relationships of the CS000000
instance in the BMC.ASSET dataset where the CS000000 instance is the source.
CMDBGraphQuery function overview

With the graph query function, you can explore (walk) the graph of CIs and relationships in the
BMC Atrium CMDB, starting with a specified CI and following its relationships to other CIs,
continuing along the graph for as many levels as you want. This section provides a context for
these graphs, and then explains how the graph query works . For a description of the
CMDBGraphQuery function, see CMDBGraphQuery function.
BMC Atrium Core 9.0
Page 1455 of 2268
Home
Note
The CMDBGraphQuery function is a legacy method of building queries, and has been
replaced with the newer graph walk functions. If you know the starting instance of your
query, use the graph walk functions.
For the CMDBGraphQuery function, you must know the adjacent nodes to traverse in the graph. To
avoid this issue, use the CMDBQueryByPath or graph walk functions.
CMDBGraphQuery graph representation
Examples of the CMDBGraphQuery function
Example- Walking a specific type of relationship for a CI instance using the
Example- Walking multiple types of relationships for a CI instance using the
CMDBGraphQuery graph representation

You can represent a graph G = (V, E) , in two standard ways: as a collection of adjacency lists or
as an adjacency matrix. The adjacency-list representation is more common, because it provides a
compact way to represent sparse graphs--those for which |E| is much less than |V|2. However,
an adjacency-matrix representation might be better when the graph is dense, |E| is close to |V|2.
The representation used by the CMDBGraphQuery input query graph is an adjacency list.
The adjacency-list representation of a graph G = (V, E) consists of an array Adj of |V| lists,
one for each vertex in V. For each u in the set of V, the adjacency list Adju contains pointers to all
the vertices v such that there is an edge (u, v) in the set of E. That is, Adju consists of all the
vertices adjacent to u in G. The vertices in each adjacency list are typically stored in an arbitrary
order. The following figure (b) is an adjacency-list representation in an arbitrary order of the
undirected graph in the following figure (a).
Undirected graph and its equivalent adjacency list
BMC Atrium Core 9.0
Page 1456 of 2268
Home
Note
In an undirected graph G = (V, E) , the edge set E consists of unordered pairs of
vertices, rather than ordered pairs. That is, an edge is a set { u, v}, where (u, v) in
the set of E, and u is not equal to v. In an undirected graph, self-loops are forbidden, so
every edge consists of exactly two distinct vertices.
Similarly, the following figure (b) is an adjacency-list representation of the directed graph in the
following figure (a). In the BMC Atrium Core, all relationships are directional, so the query graph is
a directed graph. In this graph, each relationship instance is like an edge and each CI instance is
like a vertex.
Directed graph and its equivalent adjacency list
Examples of the CMDBGraphQuery function

This section explains two example graph queries that operate against the CI and relationship data
illustrated as a graph in the following figure. In the graph, CI instances are circular nodes and
relationship instances are the lines connecting them.
Graph of data used with example queries
BMC Atrium Core 9.0
Page 1457 of 2268
Home
Example- Walking a specific type of relationship for a CI instance using the

Suppose that you start on a CI instance of class A:A with instance ID 1 and walk relationships of
class A:rAA, which represents a relationship with A:A instances on both ends. You want to walk
outward to the last level, so the value of the numLevels argument is -1. The instances of A:rAA
and A:A have no qualifications. For return data, you are retrieving all of the attributes of the
relationship instances and the CI instances.
BMC Atrium Core 9.0
Page 1458 of 2268
Home
Graphically, the query that you want to walk is illustrated in the following figure. For the same query
, the graph can be represented either as (a) or (b). In representation (a), the class A:A appears
twice. To distinguish one instance of A:A from the other, you need an extensionId. In this
example, one of the instances is assigned the arbitrary extensionId of two.
Graph of query example 1
The following figure, queryGraph data structures shows the data structures of the queryGraph
argument for the above figure, Graph of query example 1 (a).
queryGraph data structures for Graph of query example 1(a)
The following figure, queryGraph data structures shows the data structures of the queryGraph
argument for the above figure, Graph of query example 1 (b).
BMC Atrium Core 9.0
Page 1459 of 2268
Home
queryGraph data structures for Graph of query example 1(b)
The path taken to walk this graph is shown by the bolded relationships in the following figure. The
bolded nodes are those returned in the objects list.
The expected data to be returned is:
Seven CI instances of A:A with instance IDs 2, 3, 8, 4, 5, 6, and 7.
Eight relationship instances of A:rAA with instance IDs 1, 2, 3, 4, 5, 9, 6, and 7.
Path walked and nodes returned by query example 1
BMC Atrium Core 9.0
Page 1460 of 2268
Home
Example- Walking multiple types of relationships for a CI instance using the

Suppose that you start on a CI instance of class A:A with instance ID 1 and walk relationships of
class A:rAB, which represents a relationship with an A:A instance as the source and an A:B
instance as the destination. From A:B you want to walk relationship A:rBA, which has class A:B
as the source and class A:A as the destination. You want to walk outward to the last level, so the
value of the numLevels argument is -1. The instances of the CI and relationship classes have no
BMC Atrium Core 9.0
Page 1461 of 2268
Home
qualifications. You are retrieving all of the attributes of the relationship instances and the CI
instances.
Graphically, the query you want to walk is illustrated in the following figure. As with example 1, the
graph for this query can be represented either as (a) or (b). In representation (a), the class A:A
appears twice. To distinguish one instance of A:A from the other, an extensionId is needed. In
this example, one of the instances is assigned the arbitrary extensionId of two.
Graph of Query Example 2
queryGraph data structures for Graph of Query example 2 (a)
BMC Atrium Core 9.0
Page 1462 of 2268
Home
queryGraph data structures for Graph of Query example 2 (b)
BMC Atrium Core 9.0
Page 1463 of 2268
Home
The path taken to walk this graph is shown by the bolded relationships in the following figure. The
bolded nodes are those returned in the objects list.
The expected data to be returned is:
Six CIs. Three are instances of A:A with instance IDs 8, 5, and 9. Three are instances of A:
B with instance IDs 1, 3, and 2.
Six relationships. Three are instances of A:rAB with instance IDs 1, 3, and 2. Three are
instances of A:rBA with instance IDs 1, 2, and 3.
Path walked and nodes returned by Query Example 2
BMC Atrium Core 9.0
Page 1464 of 2268
Home
cmdbdriver program
The cmdbdriver program enables you to execute various BMC Atrium Configuration Management
Database (BMC Atrium CMDB) C application programming interface (API) functions. You can
combine several cmdbdriver commands in a script that you can execute with a single command.
This combination is helpful when you need to reuse a series of commands.
BMC Atrium Core 9.0
Page 1465 of 2268
Home
The cmdbdriver program prompts you one at a time for parameters to each command you type.
The parameters that are required for executing BMC Atrium CMDB C API functions using
cmdbdriver are the same as the parameters that are required for the equivalent BMC Atrium
CMDB C API functions.
Running cmdbdriver from the command line
cmdbdriver command line options
Commands for controlling cmdbdriver
cmdbdriver commands for C API functions
Initial cmdbdriver screen
BMC Atrium Core 9.0
Page 1466 of 2268
Home
Running cmdbdriver from the command line

Run cmdbdriver from the command line to be prompted sequentially for each parameter needed
to run your command.
Before you begin
To run the cmdbdriver program from the command line
Before you begin

Locate the CMDBDriver in the BMC Atrium CMDB SDK installation directory (C :\Program
Files\BMC Software\AtriumCore\cmdb\sdk64\bin) .
BMC Atrium Core 9.0
Page 1467 of 2268
Home
Be prepared to provide the necessary login information and perform initialization operations
for connecting to BMC Atrium Core.
To run the cmdbdriver program from the command line

1. Start the cmdbdriver program with the appropriate steps for your platform:
Microsoft Windows: In C:\Program Files\BMC Software\BMC Atrium Core\cmdb\
sdk\bin, double-click cmdbdriver.exe.
UNIX: In <AtriumCoreInstallationDirectory>/cmdb/sdk/bin, type the command: /
cmdbdriver.sh.
Shared libraries required by the cmdbdriver program are added to the library path
for the cmdbdriver session. The cmdbdriver program sets the library path
variable according to your UNIX platform:
UNIX platform
Variable name
Solaris and Linux
LD_LIBRARY_PATH
HP-UX
SHLIB_PATH
AIX
LIBPATH
2. Initialize an API session with the init command.

3. Type log at the prompt.
4. Specify the login parameters one at a time:
a. Type a valid user name and password.
b. Type the name of your server.
You can skip the other parameters.
5. In the command prompt, type the abbreviation of the function and provide the appropriate
input parameter values.
For example, the following cmdbdriver commands import class definitions for the
BMC_ComputerSystem and BMC_SystemComponent classes from the ImportClasses.txt
file. Because the user specifies a value of 1 for the Import Option prompt, cmdbdriver
returns an error if these classes already exist.
Command: impdf
DEFINITION IMPORT
Import Item List:
Number of import items (0): 2
Item Type: (Class, Attribute) (1-2) (1): 1
Class Type
Class Name
Namespace (): BMC.CORE
Class Name (): BMC_ComputerSystem
Item Type: (Class, Attribute) (1-2) (1): 1
BMC Atrium Core 9.0
Page 1468 of 2268
Home
Class Type
Class Name
Namespace (): BMC.CORE
Class Name (): BMC_SystemComponent
Import Option : Create/Overwrite (1-2) (1): 1
Filename containing import data: C:\ImportClasses.txt
Note
Use the help command ( h or ? ) to display cmdbdriver commands.
6. When you are finished using the cmdbdriver, type e or q to exit the program.
cmdbdriver command line options

You can specify login parameters, as shown in the following table, when you invoke the
cmdbdriver program from the command line. These parameters are applicable to both UNIX and
Microsoft Windows environments. When you execute the cmdbdriver program, the system
displays the list of commands. When you run cmdbdriver from the command line with these
parameters, you do not need to use the log command.
cmdbdriver command line parameters
Commands that record your cmdbdriver commands
cmdbdriver and scripts
cmdbdriver command line parameters

Command line
Description
Usage
-u <user>
Specify the BMC Remedy AR System user name for the login.
cmdbdriver.exe -u Demo
-a <authorString>
Specify the BMC Remedy AR System authorization string for the

login.
cmdbdriver.exe -a <
ARSystemAuthorizationString
>
-p <password>
Specify the BMC Remedy AR System password for the login.
cmdbdriver.exe -u Demo -a p
-1 <locale>
Specify the locale in which you want to work.
cmdbdriver.exe -l fr
-s <server>
Specify the BMC Remedy AR System server name to connect to

for the cmdbdriver session.
cmdbdriver.exe -u Demo -a p -s localhost
-x <
inputFileFullpath
>
Use cmdbdriver commands from an input file.
cmdbdriver.exe -x cmdb.in
-t <portNumber>
Specify the BMC Remedy AR System port number.
cmdbdriver.exe -t 8080
parameter
BMC Atrium Core 9.0
Page 1469 of 2268
Home
Command line
parameter
Description
Usage
-q <
A binary value indicating the quiet mode in which you want the
cmdbdriver.exe -q 10
quietModeNumber>
cmdbdriver to operate. You can combine any of the following

numbers to suppress different details that might be printed at a
time. For example, to suppress the cmdbdriver menu and
headers, type 10 for this parameter.
0: NO_SUPPRESSION
1: SUPPRESS_RESULTS
2: SUPPRESS_HEADERS
4: SUPPRESS_PROMPTS
8: SUPPRESS_MENU
16: SUPPRESS_ERRORS
32: SUPPRESS_WARNINGS
64: SUPPRESS_TIME
128: SUPPRESS_DATE
Commands that record your cmdbdriver commands

You can use the rec and srec commands of the cmdbdriver program to record cmdbdriver
commands. The rec command starts recording the commands that you use at the prompt and
srec stops recording commands.
When you type the rec command, you are prompted for the name of the file in which to store these
commands. After you record the commands in a file, you can execute it at the cmdbdriver prompt
by using the execute command and specifying the file name.
cmdbdriver and scripts

As an alternative to using the command line, you can use a script file that contains the
cmdbdriver commands and execute it at the cmdbdriver prompt. You can create this script file
using any text editor, such as Notepad.
Tip
To execute the commands stored in a file, either use the inline parameters (see Running
cmdbdriver from the command line) or copy and paste the commands at the cmdbdriver
prompt.
Commands for controlling cmdbdriver

This section describes the commands for controlling cmdbdriver.
Initialization and termination commands
Recording and logging commands
Thread and timer commands
BMC Atrium Core 9.0
Page 1470 of 2268
Home
Session configuration commands
Initialization and termination commands

The following table lists the commands for initializing and terminating the cmdbdriver program.
Command
Command
full name
What it does
init
initialize
Initializes a session of the cmdbriver program. To successfully use the cmdbdriver program, first
log in to and then initialize a session.
term
terminate
Terminates a session of the cmdbdriver program.
h, ?
help
Displays the list of cmdbdriver commands.
e, q
exit
Exits the cmdbdriver program.
log
login
Allows you to log in to a session of the cmdbdriver program. To successfully use the cmdbdriver
program, first log in to and then initialize a session.
Recording and logging commands

The following table lists the commands for controlling cmdbdriver recording and logging.
Command
Command
full name
What it does
rec
record
Starts recording the commands issued during a cmdbdriver session. The rec command helps
create cmdbdriver scripts, which can be used for installing extensions to the data model. This
command records only the input commands that you issue during a session.
srec
stop
recording
Stops recording a cmdbdriver session.
oout
open out
Starts recording output of the commands that you issue during a cmdbdriver session.
cout
close out
Closes the file created for recording the output of commands that you issue during a cmdbdriver
session.
ex
execute
Executes a specific cmdbdriver script file.
bl
begin
Begins a looping construct in a cmdbdriver script file. You must specify the number of iterations as
loop
a condition for the loop. This command is used only in script files.
end loop
Ends a looping construct in a cmdbdriver script file.
el
Thread and timer commands

The following table lists the commands for controlling cmdbdriver threads and timers.
BMC Atrium Core 9.0
Page 1471 of 2268
Home
Command
Command full
name
What it does
lt
launch
Creates a timer thread for a command. You can delay the processing of commands using the rst
command. The sleep time can be any number between zero and the specified number of seconds
.
lwt
launch wait
Launches a thread that waits for an event to occur. You can release the wait for the thread with
the rwt command.
rwt
release wait
Releases all the threads that are launched by the launch wait ( lwt ) command.
st
sleep
Issues a sleep timer on a thread for the specified number of seconds.
rst
random sleep
Issues a sleep timer on a thread that occurs for a random number of seconds within the specified
range.
msst
milliseconds
sleep timer
Issues a sleep timer on a thread for the specified number of milliseconds.
Session configuration commands

The following table lists the commands for cmdbdriver session information.
Command
Command full name
What it does
gsc
get session configuration
Retrieves session configuration information.
ssc
set session configuration
Sets session configuration information.

This section describes the cmdbdriver commands for specific BMC Atrium CMDB C API
functions.
cmdbdriver script - Import example
cmdbdriver script - Get List Class example
cmdbdriver script - Query by path example
Import and export commands for cmdbdriver
Miscellaneous commands for cmdbdriver
Class commands for cmdbdriver
Attribute commands for cmdbdriver
Instance commands for cmdbdriver
Query By Path commands for cmdbdriver
Graph Walk Query command for cmdbdriver
Federation commands for cmdbdriver
RE job run commands for cmdbdriver
cmdbdriver script - Import example

This example shows a cmdbdriver script that imports classes and attributes:
BMC Atrium Core 9.0
Page 1472 of 2268
Home
impdf
2
1
BMC.CORE
BMC_ComputerSystem
1
BMC.CORE
BMC_SystemComponent
1
C:\ImportClasses.txt
The script imports two classes, the BMC_ComputerSystem and BMC_SystemComponent classes
from the BMC.CORE namespace. These classes are imported from a file called ImportClasses.txt.
To accept a default value for a parameter in the cmdbdriver script, insert a blank line, as shown
in the following script that retrieves the destination CI for the BMC_System source class:
cmdbdriver script - Get List Class example

This example shows a cmdbdriver script that returns a list of related classes.
glc
BMC.CORE
BMC.CORE
BMC_System
BMC.CORE
BMC_Component
T
BMC_Component is the relationship between these CIs and their classes within the BMC.CORE
namespace. The blank line in this example accepts the default value for the Number of
characteristics parameter. The default for this parameter is set to 0 (none).
cmdbdriver script - Query by path example

This example shows a cmdbdriver script that queries related configuration items (CIs) using the
CMDBQueryByPath function.
init
log
log
MyUser
MyUser
MyUser
MyUser
MyServer
cqq
PersonQueryQual
BMC Atrium Core 9.0
Page 1473 of 2268
Home
4
1
Name
1
4
Daisy
cqobj
BMC.CORE
BMC_Person
PersonQueryObj
PersonQueryObj
1
1
PersonQueryQual
PersonQueryQual
PersonQueryQual
qbp
BMC.ASSET
BMC.ASSET
1
PersonQueryObj
PersonQueryObj
1
1
PersonQueryObj
1
Name
1
BMC_Person
BMC_Person
PersonQueryObj
Name
1
1
1
2
2
In the preceding example, the script first creates a query qualifier using the cqq command. The
alias for the query qualifier is specified as PersonQueryQual. The query qualification in this
example is a Simple query that searches for an instance of BMC_Person class with Name = 'Daisy'
in the BMC.CORE namespace.
Note
A query qualifier can be reused any number of times within a specific session. After a
cmdbdriver session terminates, the query qualifier that you created within the session is
no longer available.
BMC Atrium Core 9.0
Page 1474 of 2268
Home
The value of 1 in the query qualification instructs the query to perform an "Equal to" operation and 4
indicates that the right operand for the query is a value. The query constructed in the query
qualification is Name = 'Daisy'.
In the query object, you specify the namespace and class information. The alias for the query
object is PersonQueryObj. The first value of 1 after the PersonQueryObj line instructs the query
to search for a CI class. The next value of 1 instructs the query to use the existing
PersonQueryQual query qualification object.
The blank value after the query qualifier name is for the source node alias. The query qualification
in this example does not involve an input of multiple nodes in a graph format. Therefore, this
parameter is left blank. The subsequent values of 1 and 1 specify that the query is to be performed
on a CI class and that the query must use an existing query object. The alias for the query
qualification object is then specified. The blank values indicate that there is no explicit join to
perform in the query.
The qbp command takes the input of the dataset, which is BMC.ASSET in this example. The
dataset mask is specified as none with a blank line. The Query_Object_List,
Query_Object_Optional_List, and Query_Object_Selector_List parameters are then
specified. The attribute to fetch in the query is specified as Name. The results are sorted by the
Name attribute in an ascending order.
Import and export commands for cmdbdriver

The following table lists the cmdbdriver commands for importing and exporting classes and data.
cmdbdriver commands for import and export C API functions
Command
Full name
Description
expdf
export
Exports a list of specified class definitions. This command corresponds with the CMDBExportDef C
def
API function.
import
def
Imports a list of specified class definitions. This command corresponds with the CMDBImportDef C
expdt
export
data
Exports the specified class data for a specific qualification. This command corresponds with the
CMDBExportData C API function
impdt
import
data
Imports the specified instance data. This command corresponds with the CMDBImportData C API
xexpdf
Xexport
def
Exports a list of specified class definitions in XML format. This command corresponds with the
CMDBExportDef C API function.
xexpdt
Xexport
data
Exports the specified class data for a specific qualification in XML format. This command corresponds
with the CMDBExportData C API function.
impdf
API function
function
Miscellaneous commands for cmdbdriver

The following table lists the cmdbdriver commands for miscellaneous BMC Atrium Core
operations.
BMC Atrium Core 9.0
Page 1475 of 2268
Home
cmdbdriver commands for miscellaneous C API functions

Command
Full name
Description
sync
synch
Creates AR System forms from the data model definitions that hold instance data, and workflow,
which enforces class hierarchy and data integrity. This command corresponds with the
CMDBSynchMetaData C API function.
ssp
set server
port
Sets the specified server port. This command corresponds with the CMDBSetServerPort C API
dver
driver
version
Returns the cmdbdriver version installed on your system.
bbet
begin bulk
entry
transaction
Indicates that subsequent API functions are part of the bulk transaction. This command
corresponds with the CMDBBeginBulkEntryTransaction C API function.
ebet
end bulk
entry
transaction
This function commits or rolls back the bulk transaction, depending on the action type. This
command corresponds with the CMDBEndBulkEntryTransaction C API function.
gver
get version
Retrieves the version information for any BMC Atrium Core component that is installed.
gac
get audit
Retrieves a copy of the specified CI instance if the attribute data for the instance is modified.
function.
copy
exp
export
Exports the specified class definitions from the specified server. This command is used in
association with the imp command which is deprecated. If you use this command, you will not be
able to import. See Import and export commands for cmdbdriver.
imp
import
Imports the specified class definitions to the specified server. This function has been deprecated
since BMC Atrium CMDB version 2.1.00. Using this command corrupts the Common Data Model.
See Import and export commands for cmdbdriver.
grq
graph query
Searches related instances. This command corresponds with the CMDBGraphQuery C API function
.
cg
create GUID
Creates a globally unique identifier. This command corresponds with the CMDBCreateGuid C API
function.
upgr
upgrade
For internal use only.
expp
expand
param
Accepts an unexpanded string that contains parameters and substitutes values from the attribute
value list provided in the CMDBAttributeValueList structure. This command corresponds with
the CMDBExpandParametersForCI C API function.
rq
run qual
Performs validation on a list of attributes for a specified CI. This command corresponds with the
CMDBRunQualificationForCI C API function.
gwq
graph walk
query
Retrieves a list of instances for the specified qualifications. Use this function to retrieve instances
when you do not know the exact relationship path to follow. This command corresponds with the
CMDBGraphWalkBegin, CMDBGraphWalkNext, and CMDBGraphWalkEnd C API functions.
Class commands for cmdbdriver

The following table lists the cmdbdriver commands for BMC Atrium Configuration Management
Database (BMC Atrium CMDB) data model classes.
BMC Atrium Core 9.0
Page 1476 of 2268
Home
cmdbdriver commands for class C API functions

Command
Full name
Description
gc
get class
Retrieves the class information from the OBJSTR:Class form. This command corresponds with
the CMDBGetClass C API function.
sc
set class
Sets the class properties in the OBJSTR:Class form. This command corresponds with the
CMDBSetClass C API function.
cc
create
class
Creates a class with the core attributes in the OBJSTR:Class. This command corresponds with
the CMDBCreateClass C API function.
dc
delete
class
Deletes a specified class. This command corresponds with the CMDBDelete Class C API
get list
class
Retrieves a list of classes. This command corresponds with the CMDBGetListClass C API
glc
function.
function.
Attribute commands for cmdbdriver

The following table lists the cmdbdriver commands for BMC Atrium Configuration Management
Database (BMC Atrium CMDB) data model attributes.
cmdbdriver commands for attribute C API functions

Command
Full name
Description
ga
get attribute
Retrieves a single attribute. This command corresponds with the CMDBGetAttribute C API
function.
sa
set attribute
Sets the properties of an attribute. This command corresponds with the CMDBSetAttribute
C API function.
ca
create
attribute
Creates a new attribute of a class with the specified properties. This command corresponds
with the CMDBCreateAttribute C API function.
gma
get multiple
attributes
Retrieves multiple attributes. This command corresponds with the

CMDBGetMultipleAttributes C API function.
cma
create multiple
attributes
Creates multiple new attributes of a class with the specified properties. This command
corresponds with the CMDBCreateMultipleAttributes C API function.
sma
set multiple
attributes
Sets multiple attributes with the specified properties. This command corresponds with the
CMDBSetMultipleAttributes C API function.
da
delete
attribute
Deletes the attribute with the specified ID. This command corresponds with the
CMDBDeleteAttribute C API function.
Instance commands for cmdbdriver

The following table lists the cmdbdriver commands for instances in your BMC Atrium
cmdbdriver commands for instance C API functions
BMC Atrium Core 9.0
Page 1477 of 2268
Home
Command
Full name
Description
gi
get
instance
Retrieves information about the instance. This command corresponds with the CMDBGetInstance
si
set
instance
Sets attribute values for the specified CI or relationship class. This command corresponds with the
CMDBSetInstance C API function.
ci
create
instance
Creates a CI or relationship instance of the specified class. This command corresponds with the
CMDBCreateInstance C API function.
di
delete
instance
Deletes the instance of the class. This command corresponds with the CMDBDeleteInstance C
get list
instance
Retrieves a list of instances. This command corresponds with the CMDBGetListInstance C API
gli
C API function.
API function.
function. If you do not want to retrieve all the entries that match the qualification criteria, set the
numMatches parameter to NULL to improve the system performance.
get
Retrieves multiple instances. This command corresponds with the CMDBGetMultipleInstances
multiple
instances
C API function.
cmi
create
multiple
instances
Creates multiple CI or relationship instances in the specified dataset. This command corresponds
with the CMDBCreateMultipleInstances C API function.
gib
get
instance
blob
Retrieves the attachment, or binary large object (BLOB), stored for the attachment subclasses. This
command corresponds with the CMDBGetInstanceBLOB C API function.
gui
get user
interface
components
Retrieves a list of various UI components for a specified class. This command corresponds with the
CMDBGetCMDBUIComponents C API function.
gmi
Query By Path commands for cmdbdriver

The following table lists the cmdbdriver commands for Query By Path operations. All of these
commands correspond with the CMDBQueryByPath C API function.

Command
Full
name
Description
qbp
query
by
path
Retrieves a list of instances for the specified qualifications. This function takes a query object as a
parameter. Before executing the qbp command, use the cqq command to create the query qualification
cqobj
create
query
object
Creates the query object for the query by path command.
cqq
create
query
qual
Creates the query qualifications for the create query object command.
BMC Atrium Core 9.0
and then use the cqobj command to create the query object.
Page 1478 of 2268
Home
Graph Walk Query command for cmdbdriver

The Graph Walk Query (gwq) command enables you to retrieve a list of instances for the specified
qualifications.
Use this function to retrieve instances when you do not know the exact relationship path to follow.
This command corresponds with the CMDBGraphWalkBegin, CMDBGraphWalkNext, and
CMDBGraphWalkEnd C API classes.
Federation commands for cmdbdriver

The following table lists the cmdbdriver commands for federation.
cmdbdriver commands for federation C API functions
Command
Full name
Description
gf
get related
federated
Returns related FederatedInterface instances for a specific CI. This command corresponds with
the CMDBGetRelatedFederatedInContext C API function.
af
activated
federated
Expands the FederatedInterface instance for a specific CI and federated interface. This command
corresponds with the CMDBActivateFederatedInContext C API function.
RE job run commands for cmdbdriver

The following table lists the cmdbdriver commands for Reconciliation Engine job runs.
cmdbdriver commands for job run C API functions
Command
Full name
Description
sjr
start job
run
Starts an existing Reconciliation Engine job. This command corresponds with the
CMDBStartJobRun C API function.
cjr
cancel job
run
Cancels a currently running Reconciliation Engine job. This command corresponds with the
CMDBCancelJobRun C API function.
gjr
get job run
Gets information about the currently running reconciliation job and retrieves a job log. This
command corresponds with the CMDBGetJobRun C API function.
gljr
get list
job run
Get a list of running Reconciliation Engine jobs. This command corresponds with the
CMDBGetListJobRun C API function.

This section provides reference information for the BMC Atrium Core Web Services API data
structures. The BMC Atrium Core Web Services data structures are used as parameters for BMC
Atrium Core Web Services operations. The data structures are categorized by the type of functions
they perform, as listed in the following table.
List of data structures categorized by type
BMC Atrium Core 9.0
Page 1479 of 2268
Home
Data structure type
Data structure list
Common structures
The common data structures are
XML elements used by one or more
web service operations.
AtriumBackendFault
AtriumFault
ExtensionList
FunctionalCurrency
AtriumServiceFault
AtriumServiceFaultType
FunctionalCurrencyList
GetMask
Attachment
AttributeValue
InstanceInfoOut
InstanceInfoOutList
AttributeValueList
AttributeValueListList
IntArray
Keyword
ByteArray
ByteList
Location
LoginInfo
ByteListType
ClassNameId
NameValue
NameValueList
ClassNameIdList
ComplexExtensionType
NullType
SimpleExtensionType
Coordinate
CoordinateList
Currency
DatasetType
DateTimeArray
DiaryItem
DiaryItemList
DiaryValue
ExpirationIn
ExpirationOut
Status
StatusList
StatusOutput
StatusType
StringArray
Value
ValueList
(page 352)
BOBusinessService
BusinessObjectList
BOContract
BOContractLine
CreateBusinessObject
CreateBusinessObjectOutput
BOContractLineList
BOContractLineType
CreateMultipleBusinessObjects
CreateMultipleBusinessObjectsOutput
BOContractType
BOOffering
DeleteBusinessObject
DeleteMultipleBusinessObjects
BOOfferingBase
BOOfferingLifeCycleStageType
GetBusinessObject
GetBusinessObjectOutput
BOOfferingType
BOOrganization
GetMultipleBusinessObjects
GetMultipleBusinessObjectsOutput
BOPerson
BORef
BORefList
QueryBusinessObjectRefs
QueryBusinessObjectRefsOutput
QueryBusinessObjects
BORequestableOffering
BOService
QueryBusinessObjectsOutput
SetBusinessObject
BOServiceBase
BOServiceLevelTarget
SetBusinessObjectOutput
SetMultipleBusinessObjects
BOServiceLevelTargetList
BOServiceLevelTargetType
SetMultipleBusinessObjectsOutput
Business object structures

Business Objects are an abstraction
of a business entity (such as a
service offering, contract, or
organization) that models
service-model information in a
familiar way. A business object
corresponds to BMC Atrium CMDB
Common Data Model (CDM) classes.
The following structures were
designed specifically for work with
business objects.
BOServiceOffering
BOServiceOfferingList
BOServiceType
BOTechnicalService
BOTechnicalServiceList
BusinessObject
BusinessObjectBase
BMC Atrium Core 9.0
Page 1480 of 2268
Home
Atrium Audit structures

The audit structures enable you to
retrieve information about changes to
relationship and CI classes in BMC
Atrium CMDB.
AuditOperationType (atrium_audit)
AuditValueList (atrium_audit)
AuditValueListList (atrium_audit)
AbstractType
AttachmentLimit
DecimalLimit
DeleteAttribute
AttachPoolLimit
AttributeAuditType
DeleteClass
DiaryLimit
AttributeCreateMode
AttributeEntryMode
EnumItem
EnumItemList
AttributeInfoIn
AttributeInfoList
EnumLimit
EnumStyle
AttributeInfoOut
AttributeLimit
ExposureType
GetAttributes
AttributeLimitBase
AttributeType
Cardinality
CharLimit
ClassAuditInfo
ClassAuditType
ClassDeleteOption
ClassFederation
ClassFederationRelationship
ClassInfoIn
ClassInfoOut
ClassProperties
ClassRegular
ClassRelationship
ClassType
CreateAttribute
CreateClass
CurrencyDetail
CurrencyDetailList
CurrencyLimit
DateLimit
GetAttributesOutput
GetClass
GetClassOutput
IndexInfo
IndexList
IntLimit
ListClasses
ListClassesOutput
Property
PropertyList
PropInfo
PropInfoList
RealLimit
RelationType
SchemaType
SetAttribute
SetClass
TimeLimit
TimeOfDayLimit
WeakPropagatedAttrs
WeakPropagatedAttrsList
ActivateFederatedInContext
ActivateFederatedInContextOutput
FederatedAccessType
FederatedActivateInfo
FederatedActivationOption
FederatedARInfo
FederatedAccessTypeAR
FederatedActionType
GetRelatedFederatedInContext
GetRelatedFederatedInContextOutput
Class structures
The class structures enable you to
work with relationship and CI classes
in BMC Atrium CMDB.
Classic federation structures

Classic federation structures see the
data structures as defined in the
atrium_classicfederation_200901.
xsd file. The following data structures
support the classic federation
operations.
Classic reconciliation
CancelREJobRun (classic
GetREJobRunListOutput (classic
Classic reconciliation structures see

the data structures as defined in the
reconciliation)
ClassQualifier (classic
reconciliation)
GetREJobRunOutput (classic
atrium_classicreconcilliation_
reconciliation)
ClassQualifierList (classic
reconciliation)
DatasetPair (classic reconciliation)
reconciliation)
REJobRunInfo
REJobRunInfoList
REJobRunStatusType
StartREJobRun (classic reconciliation)
200901.xsd file. The following data

structures support the classic
reconciliation operations.
BMC Atrium Core 9.0
Page 1481 of 2268
Home
DatasetPairList (classic
reconciliation)
StartREJobRunOutput (classic
reconciliation)
GetREJobRun (classic
reconciliation)
GetREJobRunList (classic
reconciliation)
Federated CMDB configuration

structures
ClassSchemaDescription
ClassSchemaDescriptionList
ElementDescription
ElementDescriptionList
These structures allow you to set up
ClassSchemaReference
ClassSchemaReferenceList
ElementType
ElementTypeList
ClassToAttributesMapEntry
ClassToAttributesMap
EnumerationValue
EnumerationValues
CMDBfConfigurationParameters
CMDBfConfigurationManifest
EnumerationValueList
SchemaRelationshipDescription
CommonSchemaDescription
WSPolicyMapEntry
WSPolicyMap
XmlSchemaConstraintType
CreateDataset
DatasetAccessType (datasets)
DatasetInfo
DatasetInfoList
DeleteDataset
GetDataset
GetDatasetOutput
ListDatasets
ListDatasetsOutput
SetDataset
CreateSavedQuery
DeleteSavedQuery (
atrium_graphquery)
EdgeList
EdgeListArray
ExecuteSavedQuery
GetSavedQuery (
atrium_graphquery)
GetSavedQueryOutput (
atrium_graphquery)
GraphQuery
GraphQueryInput
GraphQueryObject
GraphQueryOutput
GraphQueryResult
GraphQueryResultFormat
NodeList
NodeListArray
QueryCardinality
QueryCardinalityType
QueryItem
QueryItemList
QueryQualifier (
atrium_graphquery)
QueryQualifierBase
QueryQualifierOpAnd (
atrium_graphquery)
QueryQualifierSetOpOperation (
atrium_graphquery)
QueryQualifierSimpleOp (
atrium_graphquery)
QueryQualifierValueTypeArithExpr (
atrium_graphquery)
QueryQualifierValueTypeAttributeName
(atrium_graphquery)
QueryQualifierValue (
atrium_graphquery)
QueryRelationship
QueryRelationshipList
QueryRelEndpoint
QueryResultGraph (atrium_graphquery
)
QueryResultList
QuerySort
QuerySortArray
RelationshipResult
RelationshipResultArray
SavedGraphQuery
SavedQueryQualifierSimpleOp
SavedQueryParameter
SavedQueryParameterType
SavedQueryParameterOption
SavedQueryParameterValue
SavedQueryParameterValueList
SavedQueryRef
a federated CMDB for queries.
Dataset structures
The dataset structures enable you to
work with the datasets in BMC Atrium
CMDB.
Graph query structures

The graph query structures allow you
to build a list of graph query objects
with qualifications.
BMC Atrium Core 9.0
Page 1482 of 2268
Home
QueryQualifierOpAndOr (
atrium_graphquery)
SavedQueryRefList
UpdateSavedQuery
QueryQualifierOpNot (
atrium_graphquery)
QueryQualifierOpOr (
atrium_graphquery)
QueryQualifierOperation (
atrium_graphquery)
QueryQualifierSetOp (
atrium_graphquery)
Graph walk structures

BeginGraphWalk
GraphWalkRelationList
The graph walk structures enable

you to work with the graph walk
BeginGraphWalkOutput
EndGraphWalk
GraphWalkResult
GraphWalkSelectorAndFilter
queries.
GetGraphWalkStatus
GraphWalkSelectorAndFilterArray
GetGraphWalkStatusOutput
GraphWalkSelectorAndFilterList
GraphWalkAttributeFlag
GraphWalkObjectFlag
GraphWalkQuery
GraphWalkQueryMode
GraphWalkRelation
GraphWalkRelationArray
GraphWalkRelationDirection
PullGraphWalkResults
PullGraphWalkResultsOutput
RenewGraphWalk
RenewGraphWalkOutput
AuditOperationType (
GetCopyAuditDataOutput
atrium_instances)
AuditValueList (atrium_instances)
GetInstances
GetInstancesOutput
AuditValueListList (
atrium_instances)
GetUIComponents
GetUIComponentsOutput
ComponentType
CreateInstance
InstanceDeleteOption
SetInstance
CreateInstanceInfoIn
CreateInstanceInfoInList
SetInstanceInfoIn
SetInstanceInfoInList
CreateInstanceOutput
CreateMultipleInstances
SetMultipleInstances
SortOrder
CreateMultipleInstancesOutput
DeleteInstance
SortOrderList
SortOrderType
DeleteInstanceInfoIn
DeleteInstanceInfoInList
DeleteMultipleInstances
UIComponentInfo
UIComponentResult
UIComponentResultList
Instance structures
The instance structures enable you
to work with the CI or relationship
class instances.
GetCopyAuditData (
atrium_instances)
Normalization structures
Use normalization structures to help
with the normalization of your data to
minimize duplication of information
and to help reduce data anomalies.
BMC Atrium Core 9.0
CancelNEJobRun
NEExportOptionTypeList
ExportNEConfiguration
ExportNEConfigurationOutput
NEFileInfo
NEFileInfoList
GetLastNEJobRunStatus
GetLastNEJobRunStatusOutput
NEImportOptionType
NEJobRunInfo
GetNEJobRunStatus
GetNEJobRunStatusOutput
GetNormalizedInfoList
GetNormalizedInfoListByFileInfo
GetNormalizedInfoListByFPKey
NEJobRunStatusType
NEMultiMatchOptionType
NENameInfo
NENameInfoList
NEQueryInfo
Page 1483 of 2268
Home
GetNormalizedInfoListByName
GetNormalizedInfoListByPCKey
NEQueryInfoList
NEQueryResult
ImportNEConfiguration
ImportNEConfigurationOutput
NEQueryResultCriteriaType
NEQueryResultList
NEExportOptionType
NEQueryResultListOutput
NormalizeInstanceList
ResumeNEJobRun
ResumeNEJobRunOutput
StartNEJobRunOutput
Query structures
The query structures allow you to
build a list of query objects with
qualifications.
DeleteSavedQuery (atrium_query)
GetSavedQuery (
QueryQualifierAndOr
QueryQualifierOpAnd (atrium_query)
atrium_graphquery)
GetSavedQueryOutput (
QueryQualifierOpNot (atrium_query)
QueryQualifierOpOr (atrium_query)
atrium_graphquery)
ListSavedQueries (
atrium_graphquery)
ListSavedQueriesOutput (
atrium_query)
NestedQuery
Query
QueryArithOpType (
atrium_graphquery)
QueryByPath
QueryByPathInput
QueryByPathOutput
QueryByPathXML
QueryByPathXMLInput
QueryExecuteOption
QueryInput
QueryInput2
QueryObject
QueryObjectList
QueryObjectRegular
QueryObjectRelationship
QueryObjectSel
QueryObjectSelector
QueryObjectSelectorList
QueryObjectSelectorFlag
QueryQualifier (atrium_query)
QueryQualifierOperation (atrium_query
)
QueryQualifierSetOp (atrium_query)
QueryQualifierSetOpOperation (
atrium_query)
QueryQualifierSimpleOp (atrium_query
)
QueryQualifierValue (atrium_query)
QueryQualifierValueSetSel
QueryQualifierValueSetTypeQuery
QueryQualifierValueSetTypeValueSet
QueryQualifierValueTypeArithExpr (
atrium_query)
QueryQualifierValueTypeAttributeName
(atrium_query)
QueryQualifierValueTypeValue
QueryResultGraph (atrium_query)
RelationshipDirection
SavedQueryData
SavedQueryInfo
SavedQueryInfoList
CancelREJobRun (reconciliation)
ClassQualifier (reconciliation)
ClassQualifierList (reconciliation)
DatasetPair (reconciliation)
DatasetPairList
GetREJobRun (reconciliation)
GetREJobRunEvent
GetREJobRunEventList
GetREJobRunEventListOutput
GetREJobRunEventOutput
GetREJobRunList (reconciliation)
GetREJobRunListOutput (
reconciliation)
GetREJobRunOutput (reconciliation)
JobRunStatusType
PauseREJobRun
QueryDateQualifier
QueryDateSpan
REJobRun
REJobRunEvent
REJobRunEventList
REJobRunList
ResumeREJobRun
StartREJobRun (reconciliation)
StartREJobRunOutput (reconciliation)
Reconciliation structures
BMC Atrium Core 9.0
Page 1484 of 2268
Home
Service configuration structures

ConfigProperty
GetProperties (service configuration)
ConfigPropertyList
ConfigPropertyValue
GetPropertiesOutput
SetProperties
DeleteProperties
DeletePropertiesOutput
SetPropertiesOutput
Service impact structures

DatasetAccessType (service
impact)
GetRelatedServices
GetRelatedServicesOutput
Service utility structures

GetProperties (service utility)
PropertyFileFormat
Version structures
GetVersions
GetVersionsOutput
VersionInfo
VersionInfoList
AbstractType structure
The AbstractType data structure defines abstract classes.
*http://atrium.bmc.com/2009/01/classes/types*
Namespace
Definition
<simpleType name="AbstractType">
<restriction base="string">
<enumeration value="NO" />
<enumeration value="REGULAR" />
<enumeration value="WITH_DATA_REPLICATION" />
</restriction>
</simpleType>
NO
REGULAR
WITH_DATA_REPLICATION
ActivateFederatedInContextOutput structure
The ActivateFederatedInContextOutput data structure holds information about federated data.
Namespace
*http://atrium.bmc.com/2009/01/classicfederation/types*
BMC Atrium Core 9.0
Page 1485 of 2268
Home
Definition
<element name="ActivateFederatedInContextOutput">
<complexType>
<sequence>
<element name="federatedActivateInfo"
type="tns:FederatedActivateInfo" />
<element name="status" type="common:StatusList" />
<element name="extensions" type="common:ExtensionList"
nillable="true" />
</sequence>
</complexType>
</element>
The structure consists of the following elements:

federatedActivateInfo
See FederatedActivateInfo.
status
See StatusList.
extensions
See ExtensionList.
ActivateFederatedInContext structure
The ActivateFederatedInContext data structure holds information about federated data.
Namespace
Definition
<element name="ActivateFederatedInContext">
<complexType>
<sequence>
<element name="loginInfo" type="common:LoginInfo"
nillable="true" />
<element name="classNameId" type="common:ClassNameId" />
<element name="datasetId" type="string" />
<element name="instanceId" type="string" />
<element name="federatedInstanceId" type="string" />
<element name="activateOption"
type="tns:FederatedActivationOption" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1486 of 2268
Home
loginInfo
See LoginInfo.
classNameId
See ClassNameId.
datasetId
Unique identifier for the dataset.
instanceId
Unique identifier for the instance.
federatedInstanceId
The instance ID of the federated instance.
activateOption
See FederatedActivationOption.
extensions
See ExtensionList.
AtriumBackendFault structure
The AtriumBackendFault data structure holds a list of error messages. For an explanation of
messages that are returned either in the operation output or as a back-end fault, see the BMC
Remedy Action Request System 7.6.03 Error Messages Guide .
The AtriumBackendFault data structure indicates that the back end has thrown an AR System
message. Only a fatal response from the BMC Atrium Core core in AR System messages is
returned as an AtriumServiceFault. The messages returned match the error codes that are
returned by the AR System and BMC Atrium CMDB APIs.
*http://atrium.bmc.com/2009/01/common*
Namespace
Definition
<complexType name="AtriumBackendFault">
<sequence>
<element name="status" type="tns:StatusList" />
<element name="extensions" type="tns:ExtensionList"
nillable="true" />
</sequence>
</complexType>

status
See StatusList.
extensions
See ExtensionList.
AtriumFault structure
The AtriumFault data structure holds message information.
Namespace
BMC Atrium Core 9.0
Page 1487 of 2268
Home
Definition
<element name="AtriumFault">
<complexType>
<choice>
<element name="serviceFault"
type="tns:AtriumServiceFault" />
<element name="backendFault"
type="tns:AtriumBackendFault" />
</choice>
</complexType>
</element>

serviceFault
See AtriumServiceFault.
backendFault
See AtriumBackendFault.
AtriumServiceFault structure
The AtriumServiceFault data structure holds a list of error messages. A service fault originates in
the service implementation itself. If the service encounters an error or discovers a missing
parameter before it uses the back-end APIs, it returns a service fault.
Namespace
Definition
<complexType name="AtriumServiceFault">
<sequence>
<element name="faultType"
type="tns:AtriumServiceFaultType" />
<element name="faultCode" type="string" />
<element name="message" type="string"
nillable="true" />
nillable="true" />
</sequence>
</complexType>

faultType
See AtriumServiceFaultType.
faultCode
Code associated with the fault.
message
Fault message text.
BMC Atrium Core 9.0
Page 1488 of 2268
Home
See ExtensionList.
extensions
AtriumServiceFaultType structure
The AtriumServiceFaultType data structure defines the valid values for the BMC Atrium Core
service fault type definition.
Namespace
Definition
<simpleType name="AtriumServiceFaultType">
<enumeration value="INVALID_ARGUMENT" />
<enumeration value="UNSUPPORTED_OPERATION" />
<enumeration value="UNEXPECTED_FAILURE" />
<enumeration value="SECURITY_FAILURE" />
<enumeration value="OTHER" />
</restriction>
</simpleType>
INVALID_ARGUMENT
UNSUPPORTED_OPERATION
UNEXPECTED_FAILURE
SECURITY_FAILURE
OTHER
AttachmentLimit
The AttachmentLimit data structure defines limits about attachments.
Namespace
Definition
<complexType name="AttachmentLimit">
<sequence>
<element name="attachmentPoolName" type="string" />
<element name="maxSize" type="long" />
</sequence>
</complexType>

attachmentPoolName
The name of the attachment pool attribute this attachment attribute is associated with.
maxSize
The maximum size in bytes of an attachment data type. A value of 0 (zero) represents an unlimited size.
BMC Atrium Core 9.0
Page 1489 of 2268
Home
Attachment structure
The Attachment data structure holds information describing the attachment.
Namespace
Definition
<complexType name="Attachment">
<sequence>
<element name="name" type="string" />
<element name="location" type="tns:Location" />
<element name="originalSize" type="long" nillable="true" />
<element name="compressedSize" type="long"
nillable="true" />
</sequence>
</complexType>

name
Name of the attachment.
location
See Location.
originalSize
Original size of the attachment.
compressedSize
Compressed size of the attachment.
AttachPoolLimit
The AttachPoolLimit data structure defines limits about the attachment pool.
Limits are intended to declare the type of the Attribute as well its limits (such as minimum or
maximum values). Some types have no actual limits, but the API uses a limit structure to indicate
them anyway. In those cases, using the Limit structure is only to indicate the type rather than
declaring limitations on the type.
Namespace
Definition
<complexType name="AttachPoolLimit">
<sequence/>
</complexType>
BMC Atrium Core 9.0
Page 1490 of 2268
Home
AttributeAuditType
The AttributeAuditType data structure defines audit information.
Namespace
Definition
<simpleType name="AttributeAuditType">
<enumeration value="AUDIT" />
<enumeration value="COPY" />
<enumeration value="AUDIT_AND_COPY" />
<enumeration value="NONE" />
</restriction>
</simpleType>
AUDIT--Store the information for the modified attributes in a log.

COPY--Create a copy of an instance when an attribute is modified.
AUDIT_AND_COPY--Create a copy of and store the information for the modified attributes.
NONE--Perform no audit logging and no copying of the attribute.
AttributeCreateMode
The AttributeCreateMode data structure defines how attributes are created.
Namespace
Definition
<simpleType name="AttributeCreateMode">
<enumeration value="OPEN" />
<enumeration value="PROTECTED" />
</restriction>
</simpleType>
OPEN--Allow any user to create an attribute.

PROTECTED--Allow restricted users to create an attribute.
AttributeEntryMode
The AttributeEntryMode data structure defines how data is entered.
Namespace
BMC Atrium Core 9.0
Page 1491 of 2268
Home
Definition
<simpleType name="AttributeEntryMode">
<enumeration value="DISPLAY_ONLY" />
<enumeration value="OPTIONAL_ENTRY" />
<enumeration value="REQUIRED_ENTRY" />
<enumeration value="SYSTEM" />
</restriction>
</simpleType>
DISPLAY_ONLY--Users cannot enter data.

NONE--The attribute needs no data entered by the system or the user.
OPTIONAL_ENTRY--Users do not have to enter data, but they can if needed
REQUIRED_ENTRY--Users must enter data
SYSTEM--Data is created by the system.
AttributeInfoIn
The AttributeInfoIn data structure holds attribute information.
Namespace
Definition
<complexType name="AttributeInfoIn">
<sequence>
<element name="value" type="common:Value"
nillable="true" />
<element name="entryMode" type="tns:AttributeEntryMode" />
<element name="createMode" type="tns:AttributeCreateMode" />
<element name="auditType" type="tns:AttributeAuditType" />
<element name="attrLimit" type="tns:AttributeLimit" />
<element name="changePerms" type="string" />
<element name="isHidden" type="boolean" />
<element name="viewPerms" type="string" />
<element name="externalName" type="string"
nillable="true" />
<element name="fieldId" type="long" nillable="true" />
<element name="customCharacList" type="tns:PropertyList" />
</sequence>
</complexType>

value
BMC Atrium Core 9.0
See Value.
Page 1492 of 2268
Home
entryMode
See AttributeEntryMode.
createMode
See AttributeCreateMode.
auditType
See AttributeAuditType.
attrLimit
See AttributeLimit.
changePerms
Specifies a list of groups or roles that have permissions to view and modify the characteristics of the
attribute.
isHidden
Valid values are "true" or "1" for true values, and "false" or "0" for false values.
viewPerms
Specifies a list of groups or roles that have permissions to view this attribute. When querying for attributes,
you see all attributes, including the hidden attributes. You can specify one or more group IDs or role IDs for
the permissions, separated by a semicolon, for example, 20;-5.
externalName
Specifies an external name for attributes of a federated class that are mapped by way of Vendor AR
database connectivity (ARDBC) plug-in or View form.
fieldId
Unique identifier for the field.
customCharacList
See PropertyList.
AttributeInfoList
The AttributeInfoList data s tructure holds attribute information.
Namespace
Definition
<complexType name="AttributeInfoList">
<sequence>
<element name="list" type="tns:AttributeInfoOut"
minOccurs="0"maxOccurs="unbounded" />
</sequence>
</complexType>
The structure consists of the following element:

list
List of AttributeInfoOut values.
AttributeInfoOut
The AttributeInfoOut data s tructure holds attribute information.
Namespace
Definition
<complexType name="AttributeInfoOut">
<complexContent>
BMC Atrium Core 9.0
Page 1493 of 2268
Home
<extension base="tns:AttributeInfoIn">
<sequence>
<element name="attributeName" type="string" />
<element name="attributeId" type="string" />
<element name="baseclassNameId"
type="common:ClassNameId" />
<element name="type" type="tns:AttributeType" />
<element name="dataType"
type="tns:AttributeLimitBase" />
<element name="isPrimaryKey" type="boolean" />
<element name="propagatedOwner" type="string" />
</sequence>
</extension>
</complexContent>
</complexType>

The name of the attribute to create. The name of the attribute must be unique within the specified class and
attributeName
within its superclasses and subclasses.

attributeId
The unique identifier for the attribute.
baseclassNameId
The name of the base class attribute.
type
See AttributeAuditType.
dataType
See AttributeLimitBase.
isPrimaryKey
propagatedOwner
The class ID and the attribute ID of the lead class attribute from which the attribute is propagated*.* The
format for this value is < leadclassID>|< lead attribute>.
AttributeLimit
The AttributeLimit data structure defines attribute constraints.
Namespace
Definition
<complexType name="AttributeLimit">
<sequence>
<element name="attachmentLimit" type="tns:AttachmentLimit"
nillable="true" />
<element name="attachPoolLimit" type="tns:AttachPoolLimit"
nillable="true" />
<element name="charLimit" type="tns:CharLimit"
nillable="true" />
<element name="currencyLimit" type="tns:CurrencyLimit"
nillable="true" />
<element name="dateLimit" type="tns:DateLimit"
BMC Atrium Core 9.0
Page 1494 of 2268
Home
nillable="true" />
<element name="decimalLimit" type="tns:DecimalLimit"
nillable="true" />
<element name="diaryLimit" type="tns:DiaryLimit"
nillable="true" />
<element name="enumLimit" type="tns:EnumLimit"
nillable="true" />
<element name="intLimit" type="tns:IntLimit"
nillable="true" />
<element name="realLimit" type="tns:RealLimit"
nillable="true" />
<element name="timeLimit" type="tns:TimeLimit"
nillable="true" />
<element name="timeOfDayLimit" type="tns:TimeOfDayLimit"
nillable="true" />
</sequence>
</complexType>

attachmentLimit
See AttachmentLimit.
attachPoolLimit
See AttachPoolLimit.
charLimit
See CurrencyDetail.
currencyLimit
See CurrencyLimit.
dateLimit
See DiaryLimit.
decimalLimit
See DecimalLimit.
diaryLimit
See DiaryLimit.
enumLimit
See EnumLimit.
intLimit
See IntLimit.
realLimit
See RealLimit.
timeLimit
See TimeLimit.
timeOfDayLimit
See TimeOfDayLimit.
AttributeLimitBase
The AttributeLimitBase data s tructure defines valid values for the attribute limit.
Namespace
Definition
<simpleType name="AttributeLimitBase">
<enumeration value="ATTACH" />
BMC Atrium Core 9.0
Page 1495 of 2268
Home
<enumeration value="ATTACH_POOL" />

<enumeration value="CHAR" />
<enumeration value="CURRENCY" />
<enumeration value="DATE" />
<enumeration value="DECIMAL" />
<enumeration value="DIARY" />
<enumeration value="ENUM" />
<enumeration value="INTEGER" />
<enumeration value="NULLTYPE" />
<enumeration value="REAL" />
<enumeration value="TIME" />
<enumeration value="TIME_OF_DAY" />
</restriction>
</simpleType>
ATTACH--An attachment attribute.

ATTACH_POOL--A pool for grouping attachments.
CHAR--A null-terminated is a character with the value zero. Describes limits.
CURRENCY--A currency attribute.
DATE--A Julian date number (number of days since January 1, 4713 BC).
DECIMAL--A fixed-point decimal attribute. Values must be specified in C locale, for example,
1234.56.
DIARY--A null-terminated string that requires freeing allocated space.
ENUM--A set of integer values (beginning with zero) that represent possible selection values
as an indexed list. You must specify an attribute limit by using ARNameList to define string
values for each selection.
INTEGER--A 32-bit signed integer value.
NULLTYPE--Specifies a NULL value.
REAL--A 64-bit floating-point value.
TIME--A UNIX -style date and time stamp (number of seconds since midnight January 1,
1970).
TIME_OF_DAY--The number of seconds since 12:00 a.m. of the current day.
AttributeType
The AttributeType data structure specifies attribute types.
Namespace
Definition
<simpleType name="AttributeType">
<enumeration value="CORE" />
<enumeration value="CORE_INTERNAL" />
BMC Atrium Core 9.0
Page 1496 of 2268
Home
</restriction>
</simpleType>
CORE
CORE_INTERNAL
NONE
REGULAR
AttributeValue
The AttributeValue data structure holds attribute data.
Namespace
Definition
<complexType name="AttributeValue">
<sequence>
<element name="value" type="tns:Value" nillable="true" />
</sequence>
</complexType>

name
Name of the attribute.
value
See Value.
AttributeValueList
The AttributeValueList data structure holds a list of values.
Namespace
Definition
<complexType name="AttributeValueList">
<sequence>
<element name="list" type="tns:AttributeValue"
minOccurs="0" maxOccurs="unbounded" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1497 of 2268
Home
list
List of AttributeValue values.
AttributeValueListList
The AttributeValueListList data structure holds a list of values.
Namespace
Definition
<complexType name="AttributeValueListList">
<sequence>
<element name="list" type="tns:AttributeValueList"
</sequence>
</complexType>

list
List of AttributeValueList values.
AuditOperationType (atrium_audit)
The AuditOperationType data s tructure defines valid audit operation types.
*http://atrium.bmc.com/2010/07/audit/types*
Namespace
Definition
<simpleType name="AuditOperationType">
<enumeration value="SET" />
<enumeration value="CREATE" />
<enumeration value="DELETE" />
<enumeration value="MERGE" />
</restriction>
</simpleType>
NONE
SET
CREATE
DELETE
MERGE
BMC Atrium Core 9.0
Page 1498 of 2268
Home
AuditOperationType (atrium_instances)
The AuditOperationType data s tructure defines valid audit operation types.
*http://atrium.bmc.com/2009/01/instances/types*
Namespace
Definition
<simpleType name="AuditOperationType">
<enumeration value="SET" />
<enumeration value="CREATE" />
<enumeration value="DELETE" />
<enumeration value="MERGE" />
</restriction>
</simpleType>
NONE
SET
CREATE
DELETE
MERGE
AuditValueList (atrium_audit)
Namespace
Definition
<complexType name="AuditValueList">
<sequence>
<element name="attributeList"
type="common:AttributeValueList" />
<element name="auditDate" type="dateTime" />
<element name="changedBy" type="string" />
<element name="operation" type="tns:AuditOperationType" />
</sequence>
</complexType>
The structur e consists of the following elements:

attributeList
See AttributeValueList.
auditDate
Standard XML dateTime format.
changedBy
String value indicating who last changed the object.
BMC Atrium Core 9.0
Page 1499 of 2268
Home
See UIComponentInfo.
operation
AuditValueList (atrium_instances)
Namespace
Definition
<complexType name="AuditValueList">
<sequence>
<element name="attributeList"
<element name="auditDate" type="dateTime" />
<element name="changedBy" type="string" />
<element name="operation" type="tns:AuditOperationType" />
</sequence>
</complexType>
The structur e consists of the following elements:

attributeList
auditDate
changedBy
String value indicating who last changed the object.
operation
AuditValueListList (atrium_audit)
The AuditValueListList data structure holds a list of audit value lists.
Namespace
Definition
<complexType name="AuditValueListList">
<sequence>
<element name="list" type="tns:AuditValueList"
</sequence>
</complexType>

list
List of AuditValueList values.
BMC Atrium Core 9.0
Page 1500 of 2268
Home
AuditValueListList (atrium_instances)
The AuditValueListList data structure holds a list of audit value lists.
Namespace
Definition
<complexType name="AuditValueListList">
<sequence>
<element name="list" type="tns:AuditValueList"
</sequence>
</complexType>

list
List of AuditValueList values.
BeginGraphWalk data structure

The BeginGraphWalk data structure launches the graph walk.
*http://atrium.bmc.com/2009/01/graphwalk/types*
Namespace
Definition
<element name="BeginGraphWalk">
<complexType>
<sequence>
nillable="true" />
<element name="expiration" type="common:ExpirationIn"
nillable="true" />
<element name="startingClassNameId"
<element name="startingInstanceId" type="string" />
<element name="query" type="tns:GraphWalkQuery" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
BMC Atrium Core 9.0
See LoginInfo.
Page 1501 of 2268
Home
expiration
See " Business object structures " in List of data structures categorized by type.
startingClassNameId
See ClassNameId.
startingInstanceId
Unique identifier of the instance from which to start the graph walk.
query
See GraphWalkQuery.
extensions
See ExtensionList.
BeginGraphWalkOutput
The BeginGraphWalkOutput d ata structure holds information about the graph walk.
Namespace
Definition
<element name="BeginGraphWalkOutput">
<complexType>
<sequence>
<element name="contextId" type="string" />
<element name="expiration" type="common:ExpirationOut" />
<element name="hasNext" type="boolean" />
nillable="true" />
</sequence>
</complexType>
</element>

contextId
Unique identifier of a Context whose value is a Context UDI.
expiration
See ExpirationOut.
hasNext
status
See StatusList.
extensions
See ExtensionList.
BOBluePrint
The BOBluePrint d ata structure holds information about service model blueprints.
Namespace
*http://atrium.bmc.com/2011/02/businessobjects/types*
Definition
<complexType name="BOBluePrint">
BMC Atrium Core 9.0
Page 1502 of 2268
Home
<complexContent>
<extension base="tns:BusinessObject">
<sequence>
<element name="documentType" nillable="true"
type="string"/>
<element name="documentPurpose" nillable="true"
type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>

documentType
Name of document.
documentPurpose
Purpose of document.
BOBluePrintSelector
The BOBluePrint d ata structure holds information about service model blueprints.
Namespace
Definition
<complexType name="BOBluePrintSelector">
<choice>
<element name="bluePrint" nillable="true"
type="tns:BOBluePrint"/>
<element name="deploymentBluePrint" nillable="true"
type="tns:BODeploymentBluePrint"/>
<element name="functionalBluePrint" nillable="true"
type="tns:BOFunctionalBluePrint"/>
</choice>
</complexType>

bluePrint
See BOBluePrint.
deploymentBluePrint
See BODeploymentBluePrint.
functionalBluePrint
See BOFunctionalBluePrint.
BOBusinessService
The BOBusinessService data structure holds business object service information.
Namespace
BMC Atrium Core 9.0
Page 1503 of 2268
Home
Definition
<complexType name="BOBusinessService">
<complexContent>
<extension base="tns:BOServiceBase">
<sequence>
<element name="supportingTechnicalServiceRefList"
type="tns:BORefList" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>

supportingTechnicalServiceRefList
See BORefList.
BOContract
The BOContract data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContract">
<complexContent>
<extension base="tns:BusinessObjectBase">
<sequence>
<element name="name" type="string" nillable="true" />
<element name="description" type="string"
nillable="true" />
<element name="startDate" type="dateTime"
nillable="true" />
<element name="endDate" type="dateTime"
nillable="true" />
<element name="contractType"
type="tns:BOContractType" nillable="true" />
<element name="customerOrganizationRef"
type="tns:BORef" nillable="true" />
<element name="contractLineList"
type="tns:BOContractLineList" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1504 of 2268
Home
name
Name of the business object contract.
description
Description of the business object contract.
startDate
endDate
contractType
See BOContractType.
customerOrganizationRef
See BORef.
contractLineList
See BOContractLineList.
BOContractAddOnLine
The BOContractAddOnLine data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractAddOnLine">
<complexContent>
<extension base="tns:BOContractLine">
<sequence>
<element name="selectedOptionLineRefList"
nillable="true" type="tns:BORefList"/>
<element name="organizationRef" nillable="true"
type="tns:BORef"/>
<element name="personRef" nillable="true"
type="tns:BORef"/>
<element name="requestableOfferingRef" nillable="true"
type="tns:BORef"/>
</sequence>
</extension>
</complexContent>
</complexType>

selectedOptionLineRefList
See BORefList.
organizationRef
See BORef.
personRef
See BORef.
requestableOfferingRef
See BORef.
BOContractDeliveryROSOLine
The BOContractDeliveryROSOLine data structure holds the business object contract information.
BMC Atrium Core 9.0
Page 1505 of 2268
Home
Namespace
Definition
<complexType name="BOContractDeliveryROSOLine">
<complexContent>
<extension base="tns:BOContractOfferingLine">
<sequence>
type="tns:BORef"/>
</sequence>
</extension>
</complexContent>
</complexType>

See BORef.
BOContractLifeCycleType
The BOContractLifeCycleType data structure holds the business object contract information.
Namespace
Definition
<simpleType name="BOContractLifeCycleType">
<enumeration value="API_UNDEFINED" />
<enumeration value="UNKNOWN" />
<enumeration value="DRAFT" />
<enumeration value="IN_NEGOTIATION" />
<enumeration value="CANCELED" />
<enumeration value="EXECUTED" />
<enumeration value="ACTIVE" />
<enumeration value="EXPIRED" />
<enumeration value="HOLD" />
<enumeration value="TERMINATED" />
</restriction>
</simpleType>
The structure consists of the following values:

API_UNDEFINED
OTHER
BMC Atrium Core 9.0
Page 1506 of 2268
Home
UNKNOWN
DRAFT
IN_NEGOTIATION
CANCELED
EXECUTED
ACTIVE
EXPIRED
HOLD
TERMINATED
BOContractLine
The BOContractLine data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractLine">
<complexContent>
<sequence>
<element name="name"
type="string" nillable="true" />
<element name="description"
<element name="startDate"
type="dateTime" nillable="true" />
<element name="endDate"
type="dateTime" nillable="true" />
<element name="contractLineType"
type="tns:BOContractLineType" nillable="true" />
<element name="coveredServiceOfferingRef"
<element name="contractRef"
<element name="coveredOrganizationRefList"
<element name="coveredPersonRefList"
</sequence>
</extension>
</complexContent>
</complexType>

name
BMC Atrium Core 9.0
Name that you assign to the basic business object offering.
Page 1507 of 2268
Home
description
Description of the basic business object offering.
startDate
endDate
contractLineType
See BOContractLineType.
coveredServiceOfferingRef
See BORef.
coveredOrganizationRefList
See BORefList.
coveredPersonRefList
See BORefList.
BOContractLineLifeCycleType
The BOContractLineLifeCycleType data structure holds the business object contract information.
Namespace
Definition
<simpleType name="BOContractLineLifeCycleType">
<enumeration value="IN_NEGOTIATION" />
<enumeration value="EXECUTED" />
<enumeration value="ACTIVE" />
<enumeration value="EXPIRED" />
<enumeration value="HOLD" />
<enumeration value="TERMINATED" />
</restriction>
</simpleType>
</simpleType>

API_UNDEFINED
OTHER
UNKNOWN
DRAFT
IN_NEGOTIATION
CANCELED
EXECUTED
ACTIVE
EXPIRED
HOLD
BMC Atrium Core 9.0
Page 1508 of 2268
Home
TERMINATED
BOContractLineList
The BOContractLineList data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractLineList">
<sequence
<element name="list" type="tns:BOContractLine"
</sequence>
</complexType>

list
List of BOContractLine values.
BOContractLineSelector
The BOContractLineSelector data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractLineSelector">
<choice>
<element name="contractLine" nillable="true"
type="tns:BOContractLine"/>
<element name="contractAddOnLine" nillable="true"
type="tns:BOContractAddOnLine"/>
<element name="contractSelectedOptionLine" nillable="true"
type="tns:BOContractSelectedOptionLine"/>
<element name="contractOfferingLine" nillable="true"
type="tns:BOContractOfferingLineSelector"/>
</choice>
</complexType>

contractLine
See BOContractLine.
contractAddOnLine
See BOContractAddOnLine.
BMC Atrium Core 9.0
Page 1509 of 2268
Home
contractSelectedOptionLine
See BOContractSelectedOptionLine.
contractOfferingLine
See BOContractOfferingLineSelector.
BOContractLineSelectorList
The BOContractLineSelectorList data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractLineSelectorList">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="list"
type="tns:BOContractLine"/>
</sequence>
</complexType>

list
See BOContractLine.
BOContractLineType
The BOContractLineType data structure defines business object contract line information.
Namespace
Definition
<simpleType name="BOContractLineType">
<enumeration value="UNDEFINED" />
<enumeration value="SLA" />
<enumeration value="OLA" />
<enumeration value="UPC" />
</restriction>
</simpleType>
UNDEFINED--Contract type is not defined.

OTHER--User-defined contract type.
UNKNOWN--Undetermined contract type.
SLA--Contract type is service level agreement.
OLA--Contract type is outsourcing localization agreement.
BMC Atrium Core 9.0
Page 1510 of 2268
Home
UPC--Contract type is universal procurement contract.
BOContractOfferingLine
The BOContractOfferingLine data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractOfferingLine">
<complexContent>
<sequence />
</extension>
</complexContent>
</complexType>

Extension base
See BOContractLine.
BOContractOfferingLineSelector
The BOContractOfferingLineSelector data structure holds the business object contract
information.
Namespace
Definition
<complexType name="BOContractOfferingLineSelector">
<choice>
<element name="contractOfferingLine" nillable="true"
type="tns:BOContractOfferingLine"/>
<element name="contractROLine" nillable="true"
type="tns:BOContractROLine"/>
<element name="contractSOLine" nillable="true"
type="tns:BOContractSOLine"/>
<element name="contractDeliveryROSOLine" nillable="true"
type="tns:BOContractDeliveryROSOLine"/>
</choice>
</complexType>

contractOfferingLine
BMC Atrium Core 9.0
See BOContractOfferingLine.
Page 1511 of 2268
Home
contractROLine
See BOContractROLine.
contractSOLine
See BOContractSOLine.
contractDeliveryROSOLine
See BOContractDeliveryROSOLine.
BOContractROLine
The BOContractROLine data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractROLine">
<complexContent>
<sequence>
type="tns:BORef"/>
<element name="contractSOLineRef" nillable="true"
type="tns:BORef"/>
</sequence>
</extension>
</complexContent>
</complexType>

See BORef.
contractSOLineRef
See BOContractSOLine.
BOContractSelectedOptionLine
The BOContractSelectedOptionLine data structure holds the business object contract information
.
Namespace
Definition
<complexType name="BOContractSelectedOptionLine">
<complexContent>
<sequence>
<element name="contractAddOnLineRef" nillable="true"
type="tns:BORef"/>
<element name="contractSOLineRef" nillable="true"
type="tns:BORef"/>
BMC Atrium Core 9.0
Page 1512 of 2268
Home
<element name="optionChoiceRef" nillable="true"

type="tns:BORef"/>
</sequence>
</extension>
</complexContent>
</complexType>

contractAddOnLineRef
See BORef.
contractSOLineRef
See BORef.
optionChoiceRef
See BORef.
BOContractSOLine
The BOContractSOLine data structure holds the business object contract information.
Namespace
Definition
<complexType name="BOContractSOLine">
<complexContent>
<sequence>
<element name="contractAddOnLineRefList"
<element name="contractROLineRefList" nillable="true"
type="tns:BORefList"/>
<element name="contractSelectedOptionLineRefList"
<element name="serviceOfferingRef" nillable="true"
type="tns:BORef"/>
</sequence>
</extension>
</complexContent>
</complexType>

contractAddOnLineRefList
See BORefList.
contractROLineRefList
See BORefList.
contractSelectedOptionLineRefList
See BORefList.
serviceOfferingRef
See BORef.
BMC Atrium Core 9.0
Page 1513 of 2268
Home
BOContractType
The BOContractType data structure defines business object contract information.
Namespace
Definition
<simpleType name="BOContractType">
<enumeration value="SLA" />
<enumeration value="OLA" />
<enumeration value="UPC" />
</restriction>
</simpleType>
UNDEFINED--Contract type is not defined.

OTHER--User-defined contract type.
UNKNOWN--Undetermined contract type.
SLA--Contract type is service level agreement.
OLA--Contract type is outsourcing localization agreement.
UPC--Contract type is universal procurement contract.
BOCost
The BOCost data structure defines business object cost information.
Namespace
Definition
<complexType name="BOCost">
<complexContent>
<extension base="tns:BOFinancialElement">
<sequence>
<element name="costDerivedFlag" nillable="true"
type="boolean"/>
<element name="costAmount" nillable="true"
type="common:Currency"/>
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1514 of 2268
Home

costDerivedFlag
Indicate if the cost is derived or not.
costAmount
Specify the amount of the cost.
BODeliveryRequestableOffering
The BODeliveryRequestableOffering data structure defines business object delivery requestable
offering information.
Namespace
Definition
<complexType name="BODeliveryRequestableOffering">
<complexContent>
<extension base="tns:BORequestableOffering">
<sequence />
</extension>
</complexContent>
</complexType>

See BORequestableOffering.
Extension base
BODeploymentBluePrint
The BODeploymentBlueprint data structure defines business object deployment blueprint
information.
Namespace
Definition
<complexType name="BODeploymentBluePrint">
<complexContent>
<extension base="tns:BOBluePrint">
<sequence>
<element name="providerFunctionalBluePrintRef"
nillable="true" type="tns:BORef"/>
<element name="serviceOfferingRefList" nillable="true"
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1515 of 2268
Home

providerFunctionalBluePrintRef
The reference to the fucntional blueprint associated with the deployment blueprint. See
BORef.
serviceOfferingRefList
The reference to the associated service offering. See BORefList.
BOFinancialElement
The BOFinancialElement data structure defines business object cost and price information
associated with a service offering.
Namespace
Definition
<complexType name="BOFinancialElement">
<complexContent>
<sequence>
<element name="unitOfMeasure" nillable="true"
type="string"/>
<element name="perTimePeriod" nillable="true"
type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>

unitOfMeasure
The unit of measure.
perTimePeriod
The time period value, such as Other, Unknown, Hour, Day, Week, Month, Year, and OneTime.
BOFinancialElementSelector
The BOFinancialElementSelector data structure defines business object cost and price information
associated with a service offering.
Namespace
Definition
<complexType name="BOFinancialElementSelector">
<choice>
<element name="financialElement" nillable="true"
type="tns:BOFinancialElement"/>
BMC Atrium Core 9.0
Page 1516 of 2268
Home
<element name="cost" nillable="true" type="tns:BOCost"/>

<element name="price" nillable="true" type="tns:BOPrice"/>
</choice>
</complexType>

financialElement
See BOFinancialElement.
cost
See BOCost.
price
See BOPrice.
BOFunctionalBluePrint
The BOFunctionalBlueprint data structure defines business object deployment blueprint information
.
Namespace
Definition
<complexType name="BOFunctionalBluePrint">
<complexContent>
<extension base="tns:BOBluePrint">
<sequence>
<element name="deploymentBluePrintRefList"
</sequence>
</extension>
</complexContent>
</complexType>

deploymentBluePrintRefList
The reference to the deployment blueprint associated with this functional blueprint. See
BORefList.
BOOffering
The BOOffering data s tructure holds the business object offering information.
Namespace
Definition
<complexType name="BOOffering">
<choice>
BMC Atrium Core 9.0
Page 1517 of 2268
Home
<element name="offering" type="tns:BOOfferingBase" />

<element name="requestableOffering"
type="tns:BORequestableOffering" />
<element name="serviceOffering"
type="tns:BOServiceOffering" />
</choice>
</complexType>

offering
See BOOfferingBase.
requestableOffering
serviceOffering
See BOServiceOffering.
BOOfferingBase
The BOOfferingBase data structure defines the basic business object offering information.
Namespace
Definition
<complexType name="BOOfferingBase">
<complexContent>
<sequence>
nillable="true" />
<element name="offeringType"
type="tns:BOOfferingType" nillable="true" />
<element name="offeringLifeCycleStage"
type="tns:BOOfferingLifeCycleStageType"
nillable="true" />
<element name="serviceLevelTargetList"
type="tns:BOServiceLevelTargetList" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>

name
description
offeringType
See BOOfferingType.
BMC Atrium Core 9.0
Page 1518 of 2268
Home
offeringLifeCycleStage
See BOOfferingLifeCycleStageType.
serviceLevelTargetList
See BOServiceLevelTargetList.
BOOfferingLifeCycleStageType
The BOOfferingLifeCycleStageType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOOfferingLifeCycleStageType">
<enumeration value="DEVELOPMENT" />
<enumeration value="TEST" />
<enumeration value="PREPRODUCTION" />
<enumeration value="PRODUCTION" />
<enumeration value="RETIRED" />
</restriction>
</simpleType>
UNDEFINED
OTHER
UNKNOWN
DEVELOPMENT
TEST
PREPRODUCTION
PRODUCTION
RETIRED
BOOfferingLifeCycleType
The BOOfferingLifeCycleType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOOfferingLifeCycleType">
<enumeration value="REQUIREMENTS" />
BMC Atrium Core 9.0
Page 1519 of 2268
Home
<enumeration value="DEFINED" />

<enumeration value="ANALYZED" />
<enumeration value="APPROVED" />
<enumeration value="CHARTERED" />
<enumeration value="DESIGNED" />
<enumeration value="DEVELOPED" />
<enumeration value="BUILT" />
<enumeration value="TESTED" />
<enumeration value="RELEASED" />
<enumeration value="OPERATIONAL" />
<enumeration value="CLOSED" />
</restriction>
</simpleType>

API_UNDEFINED--The life cycle type is specified but undefined in the API.
OTHER--The life cycle is defined, but is a type other than the ones defined.
UNKNOWN--The life cycle is defined, but is an unknown type.
REQUIREMENTS--The life cycle is defining requirements.
DEFINED--The life cycle is defined.
ANALYZED--The life cycle is analyzed.
APPROVED--The life cycle is approved.
CHARTERED--The life cycle is chartered.
DESIGNED--The life cycle is designed.
DEVELOPED--The life cycle is developed.
BUILT--The life cycle is built.
TESTED--The life cycle is tested.
RELEASED--The life cycle is released.
OPERATIONAL--The life cycle is operational.
CLOSED--The life cycle is closed.
RETIRED--The life cycle is retired.
BOOfferingSelector
The BOOfferingSelector data structure defines business object offering information.
Namespace
Definition
<complexType name="BOOfferingSelector">
<choice>
<element name="offering" type="tns:BOOffering"/>
<element name="serviceOffering"
type="tns:BOServiceOffering"/>
BMC Atrium Core 9.0
Page 1520 of 2268
Home
type="tns:BORequestableOfferingSelector"/>
</choice>
</complexType>

offering
See BOOffering.
serviceOffering
See BOServiceOffering.
requestableOffering
BOOfferingType
The BOOfferingType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOOfferingType">
<enumeration value="REQUESTABLE" />
<enumeration value="SERVICE" />
</restriction>
</simpleType>
UNDEFINED--Business object offering not defined.

REQUESTABLE--Business object offering is by request.
SERVICE--Business object offering is a service.
BOOfferingWarrantyType
The BOOfferingWarrantType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOOfferingWarrantyType">
<enumeration value="BRONZE" />
<enumeration value="SILVER" />
BMC Atrium Core 9.0
Page 1521 of 2268
Home
<enumeration value="GOLD" />

<enumeration value="PLATINUM" />
</restriction>
</simpleType>

API_UNDEFINED
OTHER
UNKNOWN
BRONZE
SILVER
GOLD
PLATINUM
BOOption
The BOOption data structure defines business object service option that modifies the requestable
offering (for example, Memory, Storage, or Software).
Namespace
Definition
<complexType name="BOOption">
<complexContent>
<sequence>
<element name="fulfillmentDetails" nillable="true"
type="string"/>
<element name="choiceSelectionMode" nillable="true"
type="tns:BOOptionChoiceSelectionModeType"/>
<element name="optionChoiceRefList" nillable="true"
</sequence>
</extension>
</complexContent>
</complexType>

fulfillmentDetails
The details of the fulfillment for the option.
choiceSelectionMode
The ChoiceSelectionMode attribute of the option. See BOOptionChoiceSelectionModeType.
optionChoiceRefList
The reference to the list of option choices. See BORefList.
BMC Atrium Core 9.0
Page 1522 of 2268
Home
BOOptionChoice
The BOOptionChoice data structure defines business object for each indvidual choice within the
BOOption.
Namespace
Definition
<complexType name="BOOptionChoice">
<complexContent>
<sequence>
<element name="isDefault" nillable="true"
type="boolean"/>
<element name="sequence" nillable="true" type="int"/>
<element name="optionRef" nillable="true"
type="tns:BORef"/>
<element name="costRef" nillable="true"
type="tns:BORef"/>
<element name="priceRef" nillable="true"
type="tns:BORef"/>
<element name="contractSelectedOptionLineRefList"
</sequence>
</extension>
</complexContent>
</complexType>

isDefault
Sets whether the choice is the selected default for an option.
sequence
The sequence of the option.
optionRef
The reference to an option for this option choice. See BORef.
costRef
The reference to the costs associated with this option choice. See BORef.
priceRef
The reference to the prices associated with this option choice. See BORef.
contractSelectedOptionLineRefList
References to contract lines associated with this option choice. See BORefList.
BOOptionChoiceSelectionModeType
The BOOptionChoiceSelectionModeType data structure defines the mode for the selction of
choices (single or multiple) for an option.
Namespace
BMC Atrium Core 9.0
Page 1523 of 2268
Home
Definition
<simpleType name="BOOptionChoiceSelectionModeType">
<enumeration value="SINGLE" />
<enumeration value="MULTIPLE" />
</restriction>
</simpleType>

API_UNDEFINED
SINGLE
MULTIPLE
BOOrganization
The BOOrganization data structure defines business object organizations.
Namespace
Definition
<complexType name="BOOrganization">
<complexContent>
<sequence>
nillable="true" />
<element name="parentOrganizationRef"
<element name="memberOrganizationRefList"
<element name="memberPersonRefList"
</sequence>
</extension>
</complexContent>
</complexType>

name
Name of the business object organization.
description
Description of the business object organization.
BMC Atrium Core 9.0
Page 1524 of 2268
Home
parentOrganizationRef
See BORef.
memberOrganizationRefList
See BORefList.
memberPersonRefList
See BORefList.
BOPerson
The BOPerson data structure defines a person associated with the business object.
Namespace
Definition
<complexType name="BOPerson">
<complexContent>
<sequence>
<element name="firstName" type="string"
nillable="true" />
<element name="lastName" type="string"
nillable="true" />
<element name="email" type="string"
nillable="true" />
<element name="department" type="string"
nillable="true" />
nillable="true" />
<element name="name" type="string"
nillable="true" />
<element name="organizationRefList"
</sequence>
</extension>
</complexContent>
</complexType>

firstName
First name of the person.
lastName
Last name of the person.
email
Email address of the person.
department
Business unit or department that the person belongs to.
description
Description associated with the person.
name
Name specified to business object person.
organizationRefList
See BORef.
BMC Atrium Core 9.0
Page 1525 of 2268
Home
BOPrice
Namespace
Definition
<complexType name="BOPrice">
<complexContent>
<extension base="tns:BOFinancialElement">
<sequence>
<element name="isLocked" nillable="true"
type="boolean"/>
<element name="minimumQuantity" nillable="true"
type="int"/>
<element name="maximumQuantity" nillable="true"
type="int"/>
<element name="priceQuantity" nillable="true"
type="int"/>
<element name="priceAmount" nillable="true"
type="common:Currency"/>
<element name="priceLifeCycle" nillable="true"
type="tns:BOPriceLifeCycleType"/>
</sequence>
</extension>
</complexContent>
</complexType>

isLocked
Sets the locked attribute of the price.
minimumQuantity
Sets the minimum quantity of the price.
maximumQuantity
Sets the maximum quantity of the price.
priceQuantity
Specifies the quantity of the price.
priceAmount
Sets the amount of the price.
priceLifeCycle
Sets the life cycle of the price. See BOPriceLifeCycleType.
BOPriceLifeCycleType
Namespace
Definition
<simpleType name="BOPriceLifeCycleType">
BMC Atrium Core 9.0
Page 1526 of 2268
Home

</restriction>
</simpleType>

API_UNDEFINED
DRAFT
APPROVED
OPERATIONAL
CLOSED
RETIRED
BORef
The BORef data structure defines business object offering information.
Namespace
Definition
<complexType name="BORef">
<sequence>
<element name="boClass" type="string" nillable="true" />
<element name="boId" type="string" nillable="true" />
</sequence>
</complexType>

boClass
Business object class.
boId
Unique identifier for the business object class.
BORefList
The BORefList data structure defines business object offering information.
Namespace
Definition
<complexType name="BORefList">
BMC Atrium Core 9.0
Page 1527 of 2268
Home
<sequence>
<element name="list" type="tns:BORef"
</sequence>
</complexType>

list
List of BORef values.
BORequestableOffering
The BORequestableOffering data structure holds the business object offering information.
Namespace
Definition
<complexType name="BORequestableOffering">
<complexContent>
<extension base="tns:BOOfferingBase">
<sequence>
<element name="serviceOfferingRefList"
</sequence>
</extension>
</complexContent>
</complexType>

serviceOfferingRefList
List of serviceOfferingRefList values.
BORequestableOfferingSelector
The BORequestableOfferingSelector data structure holds the business object offering information
.
Namespace
Definition
<complexType name="BORequestableOfferingSelector">
<choice>
type="tns:BORequestableOffering"/>
<element name="deliveryRequestableOffering"
type="tns:BODeliveryRequestableOffering"/>
BMC Atrium Core 9.0
Page 1528 of 2268
Home
</choice>
</complexType>

requestableOffering
deliveryRequestableOffering
See BODeliveryRequestableOffering.
BOService
The BOService data structure holds business object service information.
Namespace
Definition
<complexType name="BOService">
<choice>
<element name="service" type="tns:BOServiceBase" />
<element name="businessService"
type="tns:BOBusinessService" />
<element name="technicalService"
type="tns:BOTechnicalService" />
</choice>
</complexType>

service
See CreateBusinessObject.
businessService
technicalService
BOServiceBase
The BOServiceBase data s tructure defines business object service information.
Namespace
Definition
<complexType name="BOServiceBase">
<complexContent>
<sequence>
BMC Atrium Core 9.0
Page 1529 of 2268
Home
nillable="true" />
<element name="serviceType"
type="tns:BOServiceType" nillable="true" />
<element name="providerOrganizationRef"
<element name="serviceOfferingList"
type="tns:BOServiceOfferingList" nillable="true" />
<element name="supportPersonRefList"
<element name="supportOrganizationRefList"
</sequence>
</extension>
</complexContent>
</complexType>

name
Name of the business object.
description
Description for the business object.
serviceType
See BOServiceType.
providerOrganizationRef
See BORef.
serviceOfferingList
See BOServiceOfferingList.
supportPersonRefList
See BORefList.
supportOrganizationRefList
See BORefList.
BOServiceLevelTarget
The BOServiceLevelTarget data structure holds b usiness object information.
Namespace
Definition
<complexType name="BOServiceLevelTarget">
<complexContent>
<sequence>
<element name="description"
<element name="serviceLevelTargetType"
type="tns:BOServiceLevelTargetType" nillable="true" />
<element name="offeringRef"
</sequence>
</extension>
BMC Atrium Core 9.0
Page 1530 of 2268
Home
</complexContent>
</complexType>

name
description
serviceLevelTargetType
See BOServiceLevelTargetType.
offeringRef
See BORef.
BOServiceLevelTargetClassificationType
The BOServiceLevelTargetClassificationType data structure holds b usiness object information.
Namespace
Definition
<simpleType name="BOServiceLevelTargetClassificationType">
<enumeration value="API_UNDEFINED"/>
<enumeration value="INCIDENT_RESPONSE"/>
<enumeration value="AVAILABILITY"/>
<enumeration value="CAPACITY"/>
<enumeration value="SR_TURNAROUND_TIME"/>
</restriction>
</simpleType>

API_UNDEFINED
INCIDENT_RESPONSE
AVAILABILITY
CAPACITY
SR_TURNAROUND_TIME
BOServiceLevelTargetList
The BOServiceLevelTargetList data structure holds business object information.
Namespace
Definition
<complexType name="BOServiceLevelTargetList">
BMC Atrium Core 9.0
Page 1531 of 2268
Home
<sequence>
<element name="list" type="tns:BOServiceLevelTarget"
</sequence>
</complexType>

list
List of BOServiceLevelTarget values.
BOServiceLevelTargetType
The BOServiceLevelTargetType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOServiceLevelTargetType">
<enumeration value="MEASUREMENT" />
<enumeration value="POLICY" />
</restriction>
</simpleType>
UNDEFINED
OTHER
MEASUREMENT
POLICY
BOServiceLifeCycleType
The BOServiceLifeCycleType data structure defines business object offering information.
Namespace
Definition
<simpleType name="BOServiceLifeCycleType">
<enumeration value="REQUIREMENTS" />
<enumeration value="DEFINED" />
BMC Atrium Core 9.0
Page 1532 of 2268
Home
<enumeration value="ANALYZED" />

<enumeration value="CHARTERED" />
<enumeration value="DESIGNED" />
<enumeration value="DEVELOPED" />
<enumeration value="BUILT" />
<enumeration value="TESTED" />
<enumeration value="RELEASED" />
</restriction>
</simpleType>

API_UNDEFINED
OTHER
UNKNOWN
REQUIREMENTS
DEFINED
ANALYZED
APPROVED
CHARTERED
DESIGNED
DEVELOPED
BUILT
TESTED
RELEASED
OPERATIONAL
CLOSED
RETIRED
BOServiceOffering
The BOServiceOffering data structure holds the business object service offering information.
Namespace
Definition
<complexType name="BOServiceOffering">
<complexContent>
<extension base="tns:BOOfferingBase">
<sequence>
<element name="serviceRef" type="tns:BORef"
nillable="true" />
BMC Atrium Core 9.0
Page 1533 of 2268
Home
<element name="requestableOfferingRefList"
<element name="contractLineRefList"
<element name="dependentServiceRefList"
</sequence>
</extension>
</complexContent>
</complexType>

serviceRef
See BORef.
requestableOfferingRefList
See BORefList.
contractLineRefList
See BORefList.
dependentServiceRefList
See BORefList.
BOServiceOfferingList
The BOServiceOfferingList data structure holds the business object service offering information.
Namespace
Definition
<complexType name="BOServiceOfferingList">
<sequence>
<element name="list" type="tns:BOServiceOffering"
</sequence>
</complexType>

list
List of BOServiceOffering values.
BOServiceSelector
The BOServiceSelector data structure defines business object service selector.
Namespace
Definition
<complexType name="BOServiceSelector">
BMC Atrium Core 9.0
Page 1534 of 2268
Home
<choice>
<element name="service" type="tns:BOService"/>
<element name="businessService"
type="tns:BOBusinessService"/>
<element name="technicalService"
type="tns:BOTechnicalService"/>
</choice>
</complexType>

service
See BOService.
businessService
See BOBusinessService.
technicalService
See BOTechnicalService.
BOServiceType
The BOServiceType data structure defines business object service information.
Namespace
Definition
<simpleType name="BOServiceType">
<enumeration value="BUSINESSSERVICE" />
<enumeration value="TECHNICALSERVICE" />
</restriction>
</simpleType>
UNDEFINED--Business object service is not defined.

UNKNOWN--Business object service is not known.
BUSINESSSERVICE--Business object offering is by request.
TECHNICALSERVICE--Business object offering is a service.
BOTechnicalService
The BOTechnicalService data structure holds business object technical service information.
Namespace
Definition
<complexType name="BOTechnicalService">
BMC Atrium Core 9.0
Page 1535 of 2268
Home
<complexContent>
<extension base="tns:BOServiceBase">
<sequence>
<element name="dependentTechnicalServiceRefList"
<element name="supportedBusinessServiceRefList"
<element name="supportedServiceOfferingRefList"
</sequence>
</extension>
</complexContent>
</complexType>

dependentTechnicalServiceRefList
See BORefList.
supportedBusinessServiceRefList
See BORefList.
supportedServiceOfferingRefList
See BORefList.
BOTechnicalServiceList
The BOTechnicalServiceList data structure holds business object technical service information.
Namespace
Definition
<complexType name="BOTechnicalServiceList">
<sequence>
<element name="list" type="tns:BOTechnicalService"
</sequence>
</complexType>

list
List of BOTechnicalService values.
BusinessObject
The BusinessObject data structure defines business objects.
Namespace
BMC Atrium Core 9.0
Page 1536 of 2268
Home
Definition
<complexType name="BusinessObject">
<choice>
<element name="contract" type="tns:BOContract" />
<element name="contractLine" type="tns:BOContractLine" />
<element name="offering" type="tns:BOOffering" />
<element name="organization" type="tns:BOOrganization" />
<element name="person" type="tns:BOPerson" />
<element name="service" type="tns:BOService" />
<element name="serviceLevelTarget"
type="tns:BOServiceLevelTarget" />
</choice>
</complexType>

contract
See BOContract.
contractLine
See BOContractLine.
offering
organization
person
See BOPerson.
service
See BOService.
serviceLevelTarget
See BOServiceLevelTarget.
BusinessObjectBase
The BusinessObjectBase data structure defines a default business object.
Namespace
Definition
<complexType name="BusinessObjectBase">
<complexContent>
<extension base="tns:BORef">
<sequence>
<element name="attributeValues"
type="common:AttributeValueList"
nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1537 of 2268
Home

attributeValues
BusinessObjectList
The BusinessObjectList data structure holds a list of business objects.
Namespace
Definition
<complexType name="BusinessObjectList">
<sequence>
<element name="list" type="tns:BusinessObject"
</sequence>
</complexType>

list
List of BusinessObject values.
BusinessObjectSelector
The BusinessObjectSelector data structure holds a list of business objects.
Namespace
Definition
<complexType name="BusinessObjectSelector">
<choice>
<element name="bluePrint" type="tns:BOBluePrintSelector"/>
<element name="contract" type="tns:BOContract"/>
<element name="contractLine"
type="tns:BOContractLineSelector"/>
<element name="financialElement"
type="tns:BOFinancialElementSelector"/>
<element name="offering" type="tns:BOOfferingSelector"/>
<element name="option" type="tns:BOOption"/>
<element name="optionChoice" type="tns:BOOptionChoice"/>
<element name="organization" type="tns:BOOrganization"/>
<element name="person" type="tns:BOPerson"/>
<element name="service" type="tns:BOServiceSelector"/>
<element name="serviceLevelTarget"
type="tns:BOServiceLevelTarget"/>
<element name="other" type="tns:BusinessObject"/>
</choice>
BMC Atrium Core 9.0
Page 1538 of 2268
Home
</complexType>

bluePrint
See BOBluePrintSelector.
contract
See BOContract.
contractLine
See BOContractLineSelector.
financialElement
See BOFinancialElementSelector.
offering
See BOOfferingSelector.
option
See BOOption.
optionChoice
See BOOptionChoice.
organization
See BOOrganization.
person
See BOPerson.
service
See BOServiceSelector.
serviceLevelTarget
See BOServiceLevelTarget.
other
See BusinessObject.
BusinessObjectSelectorList
The BusinessObjectSelectorList data structure holds a list of business objects.
Namespace
Definition
<complexType name="BusinessObjectSelectorList">
<sequence>
type="tns:BusinessObjectSelector"/>
</sequence>
</complexType>

list
See BusinessObjectSelector.
ByteArray structure
The ByteArray data structure is a variable array containing byte characters.
Namespace
BMC Atrium Core 9.0
Page 1539 of 2268
Home
Definition
<complexType name="ByteArray">
<sequence>
<element name="list" type="byte" minOccurs="0"
maxOccurs="unbounded" />
</sequence>
</complexType>

list
List of byte values.
ByteList structure
The ByteList data structure holds byte list values.
Namespace
Definition
<complexType name="ByteList">
<sequence>
<element name="type" type="tns:ByteListType" />
<element name="data" type="tns:ByteArray" />
</sequence>
</complexType>

type
See ByteListType.
data
See StringArray.
ByteListType
The ByteListType data structure holds valid values for byte list types.
Namespace
Definition
<simpleType name="ByteListType">
<enumeration value="USER_DEFINED" />
<enumeration value="WIN_BMP" />
<enumeration value="JPEG" />
BMC Atrium Core 9.0
Page 1540 of 2268
Home
<enumeration value="TIFF" />

<enumeration value="TARGA" />
<enumeration value="PCX" />
</restriction>
</simpleType>
USER_DEFINED
WIN_BMP
JPEG
TIFF
TARGA
PCX
CancelNEJobRun structure
The CancelNEJobRun data structure cancels a job.
*http://atrium.bmc.com/2009/01/normalization/types*
Namespace
Definition
<element name="CancelNEJobRun">
<complexType>
<sequence>
nillable="true" />
<element name="jobRunId" type="string" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
Unique identifier for the job run.
extensions
See ExtensionList.
CancelREJobRun (classic reconciliation)

The CancelREJobRun data structure stops reconciliation engine jobs.
Namespace
*http://atrium.bmc.com/2009/01/classicreconciliation/types*
BMC Atrium Core 9.0
Page 1541 of 2268
Home
Definition
<element name="CancelREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
CancelREJobRun (reconciliation)
The CancelREJobRun d ata structure cancels the Reconciliation Engine job.
*http://atrium.bmc.com/2009/01/reconciliation/types*
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1542 of 2268
Home
Cardinality structure
The Cardinality data structure defines the cardinality between objects.
Namespace
Definition
<simpleType name="Cardinality">
<enumeration value="ONE_ONE" />
<enumeration value="MANY_ONE" />
<enumeration value="ONE_MANY" />
<enumeration value="MANY_MANY" />
</restriction>
</simpleType>
NONE--No relationship to other classes.

ONE_ONE--One instance of a class is associated with a single instance of another class
MANY_ONE--One or more instances of a class are associated with one instance of another
class
ONE_MANY--One instance of a class is associated with one or more instances of another
class.
MANY_MANY--Many instances of a class are associated with many instances of another
class.
CharacteristicMap
The CharacteristicMap data structure holds list information of custom characteristics of an attribute.
Namespace
*http://atrium.bmc.com/2011/02/query/types*
Definition
<complexType name="CharacteristicMap">
<sequence>
type="tns:Characteristic"/>
</sequence>
</complexType>

list
See Characteristic.
BMC Atrium Core 9.0
Page 1543 of 2268
Home
Characteristic structure
The Characteristic data structure holds information for a custom characteristic of an attribute.
Namespace
Definition
<complexType name="Characteristic">
<sequence>
<element name="tag" type="int"/>
<element name="value" type="common:Value"/>
</sequence>
</complexType>

tag
The ID of the characteristic.
value
The value of the characteristic.
CharLimit
The CharLimit data structure holds character limit information.
Namespace
Definition
<complexType name="CharLimit">
<sequence>
<element name="charMenu" type="string" />
<element name="format" type="string" />
<element name="FTSOption" type="int" />
<element name="maxCharLength" type="int" />
<element name="menuStyle" type="int" />
<element name="pattern" type="string" />
<element name="QBEOption" type="int" />
</sequence>
</complexType>

charMenu
Builds a list of values that can be selected by choosing a character. For example: 1 - Accounts Menu 2 - Cards
Menu 3 - Lending Menu 4 - Investments Menu 5 - Exit
format
Sets the format of the character attribute limit.
FTSOption
Sets the full text search option.
BMC Atrium Core 9.0
Page 1544 of 2268
Home
maxCharLength
Sets the maximum length of the character attribute limit.
menuStyle
Sets the menu style.
pattern
Sets the pattern for the underlying field of this attribute.
QBEOption
Sets the query by example option.
ClassAuditInfo
The ClassAuditInfo data structure holds audit information about the class.
Namespace
Definition
<complexType name="ClassAuditInfo">
<sequence>
<element name="auditType" type="tns:ClassAuditType" />
<element name="qualifierString" type="string" />
</sequence>
</complexType>

auditType
See ClassAuditType.
qualifierString
ClassAuditType
The ClassAuditType data structure specifies auditing behavior about class objects.
Namespace
Definition
<simpleType name="ClassAuditType">
<enumeration value="COPY" />
<enumeration value="LOG" />
</restriction>
</simpleType>
COPY
LOG
NONE
BMC Atrium Core 9.0
Page 1545 of 2268
Home
ClassDeleteOption
The ClassDeleteOption data s tructure defines valid values for class deletion operations.
Namespace
Definition
<simpleType name="ClassDeleteOption">
<enumeration value="ALL_DEPENDENCIES" />
<enumeration value="WITH_DATA" />
</restriction>
</simpleType>
ALL_DEPENDENCIES--Delete the class, including all the subclasses and dependent

relationship classes that are associated with it. All the dependencies for the specified class
are deleted.
NONE--Delete the class only if the class contains no instances and has no subclasses or
dependent relationships.
WITH_DATA--Delete the class only if the class has no subclasses or dependent
relationships. This applies only to regular classes.
ClassFederation
The ClassFederation data structure holds federation information.
Namespace
Definition
<complexType name="ClassFederation">
<complexContent>
<extension base="tns:ClassRegular">
<sequence>
<element name="vendorName" type="string" />
<element name="vendorTableName" type="string" />
<element name="vendorKeyName" type="string"
nillable="true" />
<element name="requiresQualifierForQuery"
type="boolean" nillable="true" />
<element name="schemaType"
type="tns:SchemaType" nillable="true" />
<element name="numTempTables" type="int"
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1546 of 2268
Home
</extension>
</complexContent>
</complexType>

vendorName
Name of the vendor.
vendorTableName
Name of the vendor table.
vendorKeyName
Unique identifier in the BMC Atrium CMDB database for the vendor.
requiresQualifierForQuery
schemaType
See SchemaType.
numTempTables
Indicates how many temporary tables to create.
ClassFederationRelationship
The ClassFederationRelationship data structure holds federated relationship CI class data.
Namespace
Definition
<complexType name="ClassFederationRelationship">
<complexContent>
<extension base="tns:ClassRelationship">
<sequence>
<element name="relationLinkQualifier" type="string" />
<element name="relationType" type="tns:RelationType"
nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>

relationLinkQualifier
Allows you to specify the encoded AR System qualification, which defines how the class on the left links
to the class on the right in federated relationship classes. The left side of the qualification represents a
current data-model class, such as BMC_ComputerSystem, while the right side of the qualification
represents a federated class.
relationType
See RelationType.
ClassInfoIn
The ClassInfoIn data s tructure holds information coming in to a class object.
BMC Atrium Core 9.0
Page 1547 of 2268
Home
Namespace
Definition
<complexType name="ClassInfoIn">
<sequence>
<element name="properties" type="tns:ClassProperties" />
<element name="indexList" type="tns:IndexList" />
<element name="customCharacList" type="tns:PropertyList" />
</sequence>
</complexType>

properties
See ClassProperties.
indexList
See IndexList.
customCharacList
See PropertyList.
ClassInfoOut
The ClassInfoOut data structure holds information going out to a class object.
Namespace
Definition
<complexType name="ClassInfoOut">
<complexContent>
<extension base="tns:ClassInfoIn">
<sequence>
<element name="superclassNameId"
<element name="classId" type="string" />
<element name="classType" type="tns:ClassType" />
</sequence>
</extension>
</complexContent>
</complexType>

superclassNameId
See ClassNameId.
classId
Unique identifier for the class.
classType
See ExposureType.
BMC Atrium Core 9.0
Page 1548 of 2268
Home
ClassNameIdList
The ClassNameIdList data structure holds a list of class names.
Namespace
Definition
<complexType name="ClassNameIdList">
<sequence>
<element name="list" type="tns:ClassNameId"
</sequence>
</complexType>

list
List of ClassNameId values.
ClassNameId structure
The ClassNameId data structure holds a class name. The name of the class. It is a two-part
structure that contains the namespace name and the class name. The name of the class must be
unique across your data model.
Namespace
Definition
<complexType name="ClassNameId">
<sequence>
<element name="namespaceName" type="string" />
<element name="className" type="string" />
</sequence>
</complexType>

namespaceName
The namespace name for the class.
className
ClassProperties structure
The ClassProperties data structure defines properties of the class.
Namespace
BMC Atrium Core 9.0
Page 1549 of 2268
Home
Definition
<complexType name="ClassProperties">
<choice>
<element name="regular" type="tns:ClassRegular" />
<element name="relationship" type="tns:ClassRelationship" />
<element name="federation" type="tns:ClassFederation" />
<element name="federationRelationship"
type="tns:ClassFederationRelationship" />
</choice>
</complexType>

regular
See ClassRegular.
relationship
See ClassRelationship.
federation
See TimeLimit.
federationRelationship
See ClassFederationRelationship.
ClassQualifier (classic reconciliation)

The ClassQualifier data structure holds information about how to qualify the class.
Namespace
Definition
<complexType name="ClassQualifier">
<sequence>
</sequence>
</complexType>

classId
An integer value indicating the class ID.
qualifierString
ClassQualifier (reconciliation)
The ClassQualifier data s tructure holds information about the Reconciliation Engine job.
Namespace
BMC Atrium Core 9.0
Page 1550 of 2268
Home
Definition
<complexType name="ClassQualifier">
<sequence>
</sequence>
</complexType>

classId
qualifierString
The qualifier string in the AR QualifierInfo format.
ClassQualifierList (classic reconciliation)

The ClassQualifierList data structure holds a list of class qualifiers.
Namespace
Definition
<complexType name="ClassQualifierList">
<sequence>
<element name="list" type="tns:ClassQualifier"
</sequence>
</complexType>

list
List of ClassQualifier values.
ClassQualifierList (reconciliation)
The ClassQualifierList data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="ClassQualifierList">
<sequence>
<element name="list"
type="tns:ClassQualifier"
BMC Atrium Core 9.0
Page 1551 of 2268
Home
</sequence>
</complexType>

list
List of ClassQualifier values.
ClassRegular structure
The ClassRegular data structure holds regular CI class information.
Namespace
Definition
<complexType name="ClassRegular">
<sequence>
<element name="isAbstract" type="tns:AbstractType" />
<element name="exposure" type="tns:ExposureType" />
<element name="hiddenPerms" type="string" />
<element name="visiblePerms" type="string" />
<element name="categorizationSubclass" type="boolean" />
<element name="description" type="string" />
<element name="isFinal" type="boolean" />
<element name="isSingleton" type="boolean" />
<element name="formName" type="string" />
<element name="author" type="string" />
<element name="auditInfo" type="tns:ClassAuditInfo" />
</sequence>
</complexType>

isAbstract
See ExposureType.
exposure
See ExposureType.
hiddenPerms
Defines parameters that should stay hidden from the user.
visiblePerms
Defines parameters that are visible to the user.
categorizationSubclass
description
Description of the class.
isFinal
isSingleton
formName
Name of the form.
author
Name of the class object creator.
BMC Atrium Core 9.0
Page 1552 of 2268
Home
See ClassAuditInfo.
auditInfo
ClassRelationship
The ClassRelationship data structure defines the relationship between classes.
Namespace
Definition
<complexType name="ClassRelationship">
<complexContent>
<extension base="tns:ClassRegular">
<sequence>
<element name="relClassName1"
<element name="relClassName2"
<element name="roleName1" type="string"
nillable="true" />
<element name="roleName2" type="string"
nillable="true" />
<element name="cardinality" type="tns:Cardinality" />
<element name="cascadeDelete" type="boolean" />
<element name="isRole2WeakReference" type="boolean" />
<element name="weakPropagatedAttrsList"
type="tns:WeakPropagatedAttrsList" />
</sequence>
</extension>
</complexContent>
</complexType>

relClassName1
See ClassNameId.
relClassName2
See ClassNameId.
roleName1
Name of the first role.
roleName2
Name of the second role.
cardinality
See ClassAuditType.
cascadeDelete
isRole2WeakReference
weakPropagatedAttrsList
See WeakPropagatedAttrsList.
ClassSchemaDescription
The ClassSchemaDescription data structure holds information about the saved query.
BMC Atrium Core 9.0
Page 1553 of 2268
Home
*http://atrium.bmc.com/2010/07/cmdbf/config/types*
Namespace
Definition
<complexType name="ClassSchemaDescription">
<sequence>
<element name="schemaId" type="tns:ClassSchemaReference" />
<element name="URL" type="anyURI" />
<element name="includedAttributes"
type="tns:ElementDescriptionList" />
<element name="excludedAttributes"
type="common:StringArray" />
<element name="inheritanceChain"
type="tns:ClassSchemaReferenceList" />
<element name="schemaRelationship"
type="tns:SchemaRelationshipDescription" minOccurs="0" />
</sequence>
</complexType>

schemaId
See ClassSchemaReference.
URL
Contains a URL.
includedAttributes
See ElementDescriptionList.
excludedAttributes
See StringArray.
inheritanceChain
See ClassSchemaReferenceList.
schemaRelationship
See SchemaRelationshipDescription.
ClassSchemaDescriptionList
The ClassSchemaDescriptionList data structure holds information about the saved query.
Namespace
Definition
<complexType name="ClassSchemaDescriptionList">
<sequence>
type="tns:ClassSchemaDescription" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1554 of 2268
Home
list
List of ClassSchemaDescription values.
ClassSchemaReference
The ClassSchemaReference data structure holds information about the saved query.
Namespace
Definition
<complexType name="ClassSchemaReference">
<sequence>
<element name="className" type="common:ClassNameId" />
<element name="isRelationship" type="boolean" />
<element name="isFederation" type="boolean" />
<element name="isDeprecated" type="boolean" />
<element name="URI" type="anyURI" />
</sequence>
</complexType>

className
classId
isRelationship
isFederation
isDeprecated
URI
A Uniform Resource Identifier (URI) is a compact string of characters used to identify or name a resource on the
Internet.
ClassSchemaReferenceList
The ClassSchemaReferenceList data structure holds information about the saved query.
Namespace
Definition
<complexType name="ClassSchemaReferenceList">
<sequence>
type="tns:ClassSchemaReference" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1555 of 2268
Home

list
List of ClassSchemaReference values.
ClassToAttributesMap
The ClassToAttributesMap data structure holds information about the saved query.
Namespace
Definition
<complexType name="ClassToAttributesMap">
<sequence>
type="tns:ClassToAttributesMapEntry" />
</sequence>
</complexType>

list
List of ClassToAttributesMapEntry values.
ClassToAttributesMapEntry
The ClassToAttributesMapEntry data structure holds information about the saved query.
Namespace
Definition
<complexType name="ClassToAttributesMapEntry">
<sequence>
<element name="className" type="common:ClassNameId" />
<element name="attributeNames" type="common:StringArray" />
</sequence>
</complexType>

className
attributeNames
The name of the class attriburtes.
BMC Atrium Core 9.0
Page 1556 of 2268
Home
ClassType structure
The ClassType data structure defines class types.
Namespace
Definition
<simpleType name="ClassType">
<enumeration value="RELATIONSHIP" />
<enumeration value="FEDERATION" />
<enumeration value="FEDERATION_RELATIONSHIP" />
</restriction>
</simpleType>
REGULAR
RELATIONSHIP
FEDERATION
FEDERATION_RELATIONSHIP
CMDBfConfigurationManifest
The CMDBfConfigurationManifest data structure holds the current values for the CMDBf
parameters.
Namespace
Definition
<complexType name="CMDBfConfigurationManifest">
<sequence>
<element name="mdrId" type="string" />
<element name="mdrIdUri" type="anyURI" />
<element name="policyList" type="tns:WSPolicyMap" />
<element name="xmlSchemaConstraint"
type="tns:XmlSchemaConstraintType" />
<element name="usesXmlSchemaExtensions" type="boolean" />
<element name="commonSchema"
type="tns:CommonSchemaDescription" />
<element name="classSchemaList"
type="tns:ClassSchemaDescriptionList" />
<element name="excludedClasses"
type="tns:ClassSchemaReferenceList" />
<element name="extensions" nillable="true"
type="common:ExtensionList" />
</sequence>
BMC Atrium Core 9.0
Page 1557 of 2268
Home
</complexType>

mdrId
The ID of the Management Data Repository (MDR).
mdrIdUri
The URI of the MDR.
policyList
List of endpoints where to access policies (WS-Addressing policy).
xmlSchemaConstraint
See XmlSchemaConstraintType.
usesXmlSchemaExtensions
commonSchema
classSchemaList
List of all classes and attributes.
excludedClasses
List of excluded classes and attributes.
extensions
See ExtensionList.
CMDBfConfigurationParameters
The CMDBfConfigurationParameters data structure holds values to set the CMDBf parameters.
Namespace
Definition
<complexType name="CMDBfConfigurationParameters">
<sequence>
<element name="mdrId" type="string" />
<element name="xmlSchemaConstraint"
type="tns:XmlSchemaConstraintType" />
<element name="useXmlSchemaExtensions" type="boolean" />
<element name="namespacesToExclude"
<element name="classesToExclude"
type="common:ClassNameIdList" />
<element name="attributesToExclude"
type="tns:ClassToAttributesMap" />
<element name="excludeHiddenClasses" type="boolean" />
<element name="excludeRelationshipClasses" type="boolean" />
<element name="excludeFederationClasses" type="boolean" />
<element name="excludeDeprecatedClasses" type="boolean" />
<element name="excludeHiddenAttributes" type="boolean" />
<element name="excludeCoreInternalAttributes"
type="boolean" />
<element name="excludeCoreAttributes" type="boolean" />
<element name="excludeRegularAttributes" type="boolean" />
<element name="excludeAttributesOfTypeNone" type="boolean" />
<element name="excludeDeprecatedAttributes" type="boolean" />
<element name="excludeTypes" type="tns:ElementTypeList" />
BMC Atrium Core 9.0
Page 1558 of 2268
Home

</sequence>
</complexType>

mdrId
The ID of the Management Data Repository (MDR).
xmlSchemaConstraint
See XmlSchemaConstraintType.
useXmlSchemaExtensions
Set to true to extend, or set to false to create self-contained, full complex types. Valid values
are "true" or "1" for true values, and "false" or "0" for false values.
namespacesToExclude
List of namespaces to exclude from CMDBf queries.
classesToExclude
Excludes relationship and instance classes, and child classes. List of classes to exclude from
CMDBf queries.
attributesToExclude
List of attributes to exclude from CMDBf queries.
excludeHiddenClasses
Also excludes hidden classes from child classes. Valid values are "true" or "1" for true values,
and "false" or "0" for false values.
excludeRelationshipClasses
excludeFederationClasses
excludeDeprecatedClasses
excludeHiddenAttributes
excludeCoreInternalAttributes
excludeCoreAttributes
excludeRegularAttributes
excludeAttributesOfTypeNone
excludeDeprecatedAttributes
excludeTypes
Remove attributes with the specified elements and any attribute of that type. See
ElementTypeList.
extensions
See ExtensionList.
CommonSchemaDescription
Namespace
Definition
<complexType name="CommonSchemaDescription">
<sequence>
<element name="URI" type="anyURI" />
<element name="URL" type="anyURI" />
</sequence>
BMC Atrium Core 9.0
Page 1559 of 2268
Home
</complexType>

URI
URL
ComplexExtensionType
The ComplexExtensionType data structure defines the extension type.
Namespace
Definition
<complexType name="ComplexExtensionType">
<sequence>
<element name="complexExtension" type="anyType" />
</sequence>
</complexType>

complexExtensionType
Can be anyType as defined for standard published XML schemas.
ComponentType structure
The ComponentType data structure defines valid component types.
Namespace
Definition
<simpleType name="ComponentType">
<enumeration value="ICON" />
<enumeration value="LINE" />
<enumeration value="TOOLTIP" />
<enumeration value="LOCALIZED_LABEL" />
</restriction>
</simpleType>
NONE
ICON
LINE
BMC Atrium Core 9.0
Page 1560 of 2268
Home
TOOLTIP
LOCALIZED_LABEL
ConfigProperty
The ConfigProperty data structure holds information about the property.
*http://atrium.bmc.com/2009/01/serviceconfig/types*
Namespace
Definition
<complexType name="ConfigProperty">
<sequence>
<element name="value" type="tns:ConfigPropertyValue"
nillable="true" />
<element name="isPassword" type="boolean"
default="false" />
</sequence>
</complexType>

name
Name of the property.
value
Value for the property.
isPassword
ConfigPropertyList
The ConfigPropertyList data structure holds information about the configuration property.
Namespace
Definition
<complexType name="ConfigPropertyList">
<sequence>
<element name="properties" type="tns:ConfigProperty"
</sequence>
</complexType>

list
List of ConfigProperty values.
BMC Atrium Core 9.0
Page 1561 of 2268
Home
ConfigPropertyValue
The ConfigPropertyValue data structure holds information about the configuration property.
Namespace
Definition
<complexType name="ConfigPropertyValue">
<choice>
<element name="stringValue" type="string" />
<element name="stringList" type="string"
<element name="byteValue" type="byte" />
<element name="byteList" type="byte"
<element name="shortValue" type="short" />
<element name="shortList" type="short"
<element name="intValue" type="int" />
<element name="intList" type="int"
<element name="longValue" type="long" />
<element name="longList" type="long"
<element name="booleanValue" type="boolean" />
<element name="booleanList" type="boolean"
<element name="floatValue" type="float" />
<element name="floatList" type="float"
<element name="doubleValue" type="double" />
<element name="doubleList" type="double"
<element name="dateValue" type="date" />
<element name="dateList" type="date"
<element name="timeValue" type="time" />
<element name="timeList" type="time"
<element name="dateTimeValue" type="dateTime" />
<element name="dateTimeList" type="dateTime"
minOccurs="1 maxOccurs="unbounded" />
<element name="durationValue" type="duration" />
<element name="durationList" type="duration"
<element name="URIValue" type="anyURI" />
<element name="URIList" type="anyURI"
</choice>
</complexType>
BMC Atrium Core 9.0
Page 1562 of 2268
Home

stringValue
Any string value.
stringList
A list of string values.
byteValue
Any byte value.
byteList
Any list of byte values.
shortValue
Any short value.
shortList
Any list of short values.
intValue
Any integer value.
intList
Any list of integer values.
longValue
Any long value.
longList
Any list of long values.
booleanValue
booleanList
List of boolean values.
floatValue
Standard XML float format.
floatList
List of standard XML float values.
doubleValue
Standard XML double format.
doubleList
List of standard XML double values.
dateValue
Standard XML date format.
dateList
List of standard XML date values.
timeValue
Standard XML time format.
timeList
List of standard XML time values.
dateTimeValue
dateTimeList
List of standard XML dateTime values.
durationValue
Standard XML duration format.
durationList
List of standard XML duration values.
URIValue
A Uniform Resource Identifier (URI) is a compact string of characters used to identify or name a resource on the
Internet.
URIList
List of Uniform Resource Identifiers.
CoordinateList structure
The CoordinateList data structure holds a list of Cartesian coordinate values.
Namespace
BMC Atrium Core 9.0
Page 1563 of 2268
Home
Definition
<complexType name="CoordinateList">
<sequence>
<element name="list" type="tns:Coordinate"
</sequence>
</complexType>

list
List of Coordinate values.
Coordinate structure
The Coordinate data structure holds Cartesian coordinate values.
Namespace
Definition
<complexType name="Coordinate">
<sequence>
<element name="x" type="int" />
<element name="y" type="int" />
</sequence>
</complexType>

x
Value of the x Cartesian coordinate.
Value of the y Cartesian coordinate.
CreateAttribute structure
The CreateAttribute data structure creates new attribute information.
Namespace
Definition
<element name="CreateAttribute">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1564 of 2268
Home
nillable="true" />
<element name="attributeId" type="string"
nillable="true" />
<element name="attributeInfo"
type="tns:AttributeInfoIn" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
attributeName
attributeId
Unique identifier for the attribute.
fieldId
Unique identifier for the field.
attributeInfo
See AttributeInfoIn.
extensions
See ExtensionList.
CreateBusinessObjectOutput
The CreateBusinessObjectOutput data structure holds business object information.
Namespace
Definition
<element name="CreateBusinessObjectOutput">
<complexType>
<sequence>
<element name="businessObject"
type="tns:BusinessObject" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1565 of 2268
Home
businessObject
See BusinessObject.
status
See StatusList.
extensions
See ExtensionList.
CreateBusinessObject structure
The CreateBusinessObject data structure creates business object information.
Namespace
Definition
<element name="CreateBusinessObject">
<complexType>
<sequence>
nillable="true" />
<element name="datasetType" type="common:DatasetType" />
type="tns:BusinessObject" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
Unique identifier that you want to use for the dataset.
datasetType
See DatasetType.
businessObject
See BusinessObject.
extensions
See ExtensionList.
CreateClass structure
The CreateClass data structure defines a class.
Namespace
Definition
<element name="CreateClass">
BMC Atrium Core 9.0
Page 1566 of 2268
Home
<complexType>
<sequence>
nillable="true" />
<element name="superclassNameId" type="common:ClassNameId"
nillable="true" />
<element name="classInfo" type="tns:ClassInfoIn" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
superclassNameId
See ClassNameId.
classId
classInfo
See ClassInfoIn.
extensions
See ExtensionList.
CreateDataset structure
The CreateDataset data structure provides for c reation of datasets.
Namespace
*http://atrium.bmc.com/2009/01/datasets/types*
Definition
<element name="CreateDataset">
<complexType>
<sequence>
nillable="true" />
<element name="datasetInfo" type="tns:DatasetInfo" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1567 of 2268
Home
loginInfo
See LoginInfo.
datasetInfo
See DatasetInfo.
extensions
See ExtensionList.
CreateInstanceInfoIn
The CreateInstanceInfoIn data structure holds information about the instance to be created.
Namespace
Definition
<complexType name="CreateInstanceInfoIn">
<sequence>
<element name="attributes"
</sequence>
</complexType>

classNameId
See ClassNameId.
attributes
CreateInstanceInfoInList
The CreateInstanceInfoInList data structure holds information about the instances to be created.
Namespace
Definition
<complexType name="CreateInstanceInfoInList">
<sequence>
<element name="list" type="tns:CreateInstanceInfoIn"
</sequence>
</complexType>

list
List of CreateInstanceInfoInList values.
BMC Atrium Core 9.0
Page 1568 of 2268
Home
CreateInstanceOutput
The CreateInstanceOutput data structure holds information about the instance.
Namespace
Definition
<element name="CreateInstanceOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

instanceId
status
See StatusList.
extensions
See ExtensionList.
CreateInstance structure
The CreateInstance data structure holds information about the instance.
Namespace
Definition
<element name="CreateInstance">
<complexType>
<sequence>
nillable="true" />
<element name="instanceInfo"
type="tns:CreateInstanceInfoIn" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1569 of 2268
Home

loginInfo
See LoginInfo.
datasetId
Unique identifier of the dataset.
instanceInfo
See SetInstanceInfoIn.
extensions
See ExtensionList.
CreateMultipleBusinessObjectsOutput
The CreateMultipleBusinessObjects data structure holds business object information.
Namespace
Definition
<element name="CreateMultipleBusinessObjectsOutput">
<complexType>
<sequence>
<element name="businessObjectList"
type="tns:BusinessObjectList" />
nillable="true" />
</sequence>
</complexType>
</element>

businessObjectList
See BusinessObjectList.
status
See StatusList.
extensions
See ExtensionList.
CreateMultipleBusinessObjects structure
The CreateMultipleBusinessObjects data structure holds business object information.
Namespace
Definition
<element name="CreateMultipleBusinessObjects">
<complexType>
<sequence>
nillable="true" />
BMC Atrium Core 9.0
Page 1570 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
extensions
See ExtensionList.
CreateMultipleInstancesOutput
The CreateMultipleInstancesOutput data structure holds information about the instances.
Namespace
Definition
<element name="CreateMultipleInstancesOutput">
<complexType>
<sequence>
<element name="instanceIds" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>

instanceIds
See StringArray.
status
See StatusList.
extensions
See ExtensionList.
CreateMultipleInstances structure
The CreateMultipleInstances data structure holds information about the instances.
BMC Atrium Core 9.0
Page 1571 of 2268
Home
Namespace
Definition
<element name="CreateMultipleInstances">
<complexType>
<sequence>
nillable="true" />
type="tns:CreateInstanceInfoInList" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
instanceInfo
extensions
See ExtensionList.
CreateSavedQuery structure
The CreateSavedQuery data structure creates information about a graph query.
*http://atrium.bmc.com/2010/07/graphquery/types*
Namespace
Definition
<element name="CreateSavedQuery">
<complexType>
<sequence>
<element name="loginInfo" nillable="true"
type="common:LoginInfo"/>
<element name="savedQuery" type="tns:SavedGraphQuery"/>
type="common:ExtensionList"/>
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1572 of 2268
Home
loginInfo
See LoginInfo.
savedQuery
See SavedGraphQuery.
extensions
See ExtensionList.
CurrencyDetail
The CurrencyDetail data structure defines currency information.
Namespace
Definition
<complexType name="CurrencyDetail">
<sequence>
<element name="currencyCode" type="string" />
<element name="precision" type="int" />
</sequence>
</complexType>

currencyCode
Code used to represent the currency type.
precision
The number of integers allowed to the right of the decimal point for the currency data type.
CurrencyDetailList
The CurrencyDetailList data structure defines currency detail information.
Namespace
Definition
<complexType name="CurrencyDetailList">
<sequence>
<element name="list" type="tns:CurrencyDetail"
</sequence>
</complexType>

list
List of CurrencyDetailvalues.
BMC Atrium Core 9.0
Page 1573 of 2268
Home
CurrencyLimit
The CurrencyLimit data s tructure defines currency constraints.
Namespace
Definition
<complexType name="CurrencyLimit">
<sequence>
<element name="allowableType"
type="tns:CurrencyDetailList" />
<element name="functionalType"
type="tns:CurrencyDetailList" />
<element name="highRange" type="decimal" />
<element name="lowRange" type="decimal" />
</sequence>
</complexType>

allowableType
See CurrencyDetailList.
functionalType
See CurrencyDetailList.
highRange
The high range of the custom characteristic for the currency data type.
lowRange
The low range of the custom characteristic for the currency data type.
precision
The number of integers allowed to the right of the decimal point for the currency data type.
Currency structure
The Currency data structure holds currency values.
Namespace
Definition
<complexType name="Currency">
<sequence>
<element name="value" type="decimal" />
<element name="code" type="string" />
<element name="conversionDate" type="dateTime" />
<element name="funcCurrencyList"
type="tns:FunctionalCurrencyList" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1574 of 2268
Home

value
Numeric value of the currency type.
code
Code associated with the currency value.
conversionDate
Date that the currency was converted to the base currency. Standard XML dateTime format.
funcCurrencyList
See FunctionalCurrencyList.
DatasetAccessType (datasets)
The DatasetAccessType data structure defines values for accessing the dataset.
Namespace
Definition
<simpleType name="DatasetAccessType">
<enumeration value="WRITABLE" />
<enumeration value="READ_ONLY" />
<enumeration value="WRITABLE_BY_CLIENT_LIST" />
</restriction>
</simpleType>
WRITABLE
READ_ONLY
WRITABLE_BY_CLIENT_LIST
DatasetAccessType (service impact)

The DatasetAccessType data structure defines valid dataset access types.
*http://atrium.bmc.com/2009/01/serviceimpact/types*
Namespace
Definition
<simpleType name="DatasetAccessType">
<enumeration value="WRITABLE" />
<enumeration value="READ_ONLY" />
<enumeration value="WRITABLE_BY_CLIENT_LIST" />
</restriction>
</simpleType>
WRITABLE
READ_ONLY
BMC Atrium Core 9.0
Page 1575 of 2268
Home
WRITABLE_BY_CLIENT_LIST
DatasetInfo
The DatasetInfo data structure holds information about the dataset.
Namespace
Definition
<complexType name="DatasetInfo">
<sequence>
<element name="coreDatasetId" type="string" />
<element name="datasetName" type="string" />
<element name="accessibility" type="tns:DatasetAccessType" />
<element name="description" type="string" nillable="true" />
<element name="instanceId" type="string" nillable="true" />
<element name="clientTypeList" type="common:StringArray"
nillable="true" />
<element name="sourceDatasetId"type="string"
nillable="true" />
</sequence>
</complexType>

coreDatasetId
Unique identifier of the core dataset.
datasetName
Name of the dataset.
datasetType
See DatasetType.
accessibility
See DatasetAccessType (datasets).
description
Description of the data that the dataset contains.
instanceId
clientTypeList
See StringArray.
sourceDatasetId
Unique identifier for the source dataset.
DatasetInfoList
The DatasetInfoList data structure holds information about the dataset.
Namespace
Definition
<complexType name="DatasetInfoList">
BMC Atrium Core 9.0
Page 1576 of 2268
Home
<sequence>
<element name="list" type="tns:DatasetInfo"
</sequence>
</complexType>

list
List of DatasetInfoList values.
DatasetPair (classic reconciliation)

The DatasetPair data structure holds information about the datasets to use in the reconciliation job.
Namespace
Definition
<complexType name="DatasetPair">
<sequence>
<element name="dataset" type="string" />
<element name="workingDataset" type="string" />
</sequence>
</complexType>

dataset
The dataset for the reconciliation job. If the workingDataset field in the structure contains a Null, the dataset
specified in this field will be used.
workingDataset
The dataset name of the working dataset. If this field contains a Null, the dataset for the reconciliation job will
be replaced with WorkingDataset before reconciliation.
DatasetPair (reconciliation)
The DatasetPair data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="DatasetPair">
<sequence>
<element name="dataset" type="string" />
<element name="workingDataset" type="string" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1577 of 2268
Home

dataset
The dataset for the reconciliation job.
workingDataset
The dataset name of the working dataset.
DatasetPairList
The DatasetPairList data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="DatasetPairList">
<sequence>
<element name="list" type="tns:DatasetPair"
</sequence>
</complexType>

list
List of DatasetPair values.
DatasetPairList (classic reconciliation)

The DatasetPairList data structure holds a list of dataset pair information.
Namespace
Definition
<complexType name="DatasetPairList">
<sequence>
<element name="list" type="tns:DatasetPair"
</sequence>
</complexType>

list
List of DatasetPair values.
DatasetType
The DatasetType data structure defines the valid values for the dataset type definition.
BMC Atrium Core 9.0
Page 1578 of 2268
Home
Namespace
Definition
<simpleType name="DatasetType">
<enumeration value="OVERLAY" />
</restriction>
</simpleType>
REGULAR --Use this value to retain the original type of the dataset.
OVERLAY --Use this value to mask the orininal type of the dataset.
DateLimit structure
The DateLimit data structure defines date constraints.
Namespace
Definition
<complexType name="DateLimit">
<sequence>
<element name="minDate" type="int" />
<element name="maxDate" type="int" />
</sequence>
</complexType>

minDate
The minimum limit for the date data type.
maxDate
The maximum limit for the date data type.
DateTimeArray structure
The DateTimeArray data structure is a variable array containing date and time information.
Namespace
Definition
<complexType name="DateTimeArray">
<sequence>
<element name="list" type="dateTime" minOccurs="0"
BMC Atrium Core 9.0
Page 1579 of 2268
Home
</sequence>
</complexType>

list
List of date and time values.
DecimalLimit structure
The DecimalLimit data structure defines decimal constraints.
Namespace
Definition
<complexType name="DecimalLimit">
<sequence>
<element name="highRange" type="decimal" />
<element name="lowRange" type="decimal" />
</sequence>
</complexType>

highRange
The high range of the custom characteristic for the decimal data type.
lowRange
The low range of the custom characteristic for the decimal data type.
precision
The number of integers allowed for the decimal data type.
DeleteAttribute structure
The DeleteAttribute data structure deletes attribute information.
Namespace
Definition
<element name="DeleteAttribute">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1580 of 2268
Home
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
attributeName
extensions
See ExtensionList
DeleteBusinessObject structure
The DeleteBusinessObject data structure deletes business object information.
Namespace
Definition
<element name="DeleteBusinessObject">
<complexType>
<sequence>
nillable="true" />
<element name="isSoftDelete" type="boolean"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
The structure consists of the following elements

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
isSoftDelete
Valid values are "true" or "1" for true values, and "false" or "0" for false values. Soft deletes create a flag to
indicate that an object has been deleted instead of actually deleting the row.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1581 of 2268
Home
DeleteClass structure
The DeleteClass data structure deletes a class.
Namespace
Definition
<element name="DeleteClass">
<complexType>
<sequence>
nillable="true" />
<element name="option" type="tns:ClassDeleteOption" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
option
See ClassDeleteOption.
extensions
See ExtensionList.
DeleteDataset structure
The DeleteDataset data structure provides for deletion of datasets.
Namespace
Definition
<element name="DeleteDataset">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1582 of 2268
Home

loginInfo
See LoginInfo.
coreDatasetId
extensions
See ExtensionList.
DeleteInstanceInfoIn
The DeleteInstanceInfoIn data structure holds information about the instance you want to delete.
Namespace
Definition
<complexType name="DeleteInstanceInfoIn">
<sequence>
</sequence>
</complexType>

classNameId
See ClassNameId.
instanceId
Unique identifier of the instance.
DeleteInstanceInfoInList
The DeleteInstanceInfoInList data structure holds information about the instances you want to
delete.
Namespace
Definition
<complexType name="DeleteInstanceInfoInList">
<sequence>
<element name="list" type="tns:DeleteInstanceInfoIn"
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1583 of 2268
Home
list
List of DeleteInstanceInfoInList values.
DeleteInstance structure
The DeleteInstance data structure deletes the instance.
Namespace
Definition
<element name="DeleteInstance">
<complexType>
<sequence>
nillable="true" />
type="tns:DeleteInstanceInfoIn" />
<element name="deleteOption"
type="tns:InstanceDeleteOption" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
Unique identifier of the dataset.
deleteOption
See GetInstances.
extensions
See ExtensionList.
DeleteMultipleBusinessObjects structure
The DeleteMultipleBusinessObjects data structure deletes several business objects.
Namespace
Definition
<element name="DeleteMultipleBusinessObjects">
<complexType>
<sequence>
nillable="true" />
BMC Atrium Core 9.0
Page 1584 of 2268
Home

nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
isSoftDelete
Valid values are "true" or "1" for true values, and "false" or "0" for false values. Soft deletes create a flag to
indicate that an object has been deleted instead of actually deleting the row.
extensions
See ExtensionList.
DeleteMultipleInstances structure
The DeleteMultipleInstances data structure deletes several instances.
Namespace
Definition
<element name="DeleteMultipleInstances">
<complexType>
<sequence>
nillable="true" />
type="tns:DeleteInstanceInfoInList" />
type="tns:InstanceDeleteOption" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1585 of 2268
Home
loginInfo
See LoginInfo.
datasetId
instanceInfo
See DeleteInstanceInfoInList.
deleteOption
See InstanceDeleteOption.
extensions
See ExtensionList.
DeletePropertiesOutput structure
The DeletePropertiesOutput data structure deletes several configuration properties.
Namespace
Definition
<element name="DeletePropertiesOutput">
<complexType>
<sequence>
<element name="deletedPropertyNames"
<element name="duplicatePropertyNames"
<element name="nonexistentPropertyNames"
<element name="invalidPropertyNames"
</sequence>
</complexType>
</element>

deletedPropertyNames
See StringArray.
duplicatePropertyNames
See StringArray.
nonexistentPropertyNames
See StringArray.
invalidPropertyNames
See StringArray.
DeleteProperties structure
The DeleteProperties data structure deletes configuration properties.
Namespace
BMC Atrium Core 9.0
Page 1586 of 2268
Home
Definition
<element name="DeleteProperties">
<complexType>
<choice>
<element name="propertyNames"
</choice>
</complexType>
</element>
DeleteSavedQuery (atrium_graphquery) structure

The DeleteSavedQuery data structure deletes information about a graph query.
Namespace
Definition
<element name="DeleteSavedQuery">
<complexType>
<sequence>
<element name="queryName" type="string"/>
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
queryName
Unique identifier of query.
extensions
See ExtensionList.
DeleteSavedQuery (atrium_query) structure

The DeleteSavedQuery data structure deletes information about a query.
Namespace
BMC Atrium Core 9.0
Page 1587 of 2268
Home
Definition
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
instanceId
extensions
See ExtensionList.
DiaryItemList
The DiaryItemList data structure holds multiple dated text entries.
You cannot set a default value when you create a DiaryItemList structure due to an API limitation.
Because new values are appended and do not overwrite existing values, a default value might not
be useful.
Namespace
Definition
<complexType name="DiaryItemList">
<sequence>
<element name="list" type="tns:DiaryItem"
</sequence>
</complexType>

list
List of DiaryItem values.
BMC Atrium Core 9.0
Page 1588 of 2268
Home
DiaryItem structure
The DiaryItem data structure holds a dated text entry.
You cannot set a default value when you create a DiaryItem structure due to an API limitation.
be useful.
Namespace
Definition
<complexType name="DiaryItem">
<sequence>
<element name="user" type="string" />
<element name="text" type="string" />
<element name="timestamp" type="dateTime" />
</sequence>
</complexType>

user
Name of system user making the entry.
text
Text of the entry.
timestamp
DiaryLimit
The DiaryLimit data structure holds very large character data.
You cannot set a default value when you create a DiaryLimit structure due to an API limitation.
be useful.
Namespace
Definition
<complexType name="DiaryLimit">
<sequence/>
</complexType>
BMC Atrium Core 9.0
Page 1589 of 2268
Home
DiaryValue
The DiaryValue data structure holds diary information.
You cannot set a default value when you create a DiaryValue structure due to an API limitation.
be useful.
Namespace
Definition
<complexType name="DiaryValue">
<choice>
<element name="diaryValueIn" type="string" />
<element name="diaryValueOut" type="tns:DiaryItemList" />
</choice>
</complexType>

diaryValueIn
diaryValueOut
See DiaryItemList.
EdgeList
The EdgeList structure holds information about relationships.
Namespace
Definition
<complexType name="EdgeList">
<sequence>
<element name="id" type="string" />
<element name="relationships"
type="tns:RelationshipResultArray" />
</sequence>
</complexType>

id
Unique identifier.
relationships
See RelationshipResultArray.
BMC Atrium Core 9.0
Page 1590 of 2268
Home
EdgeListArray
Namespace
Definition
<complexType name="EdgeListArray">
<sequence>
type="tns:EdgeList" />
</sequence>
</complexType>

list
List of EdgeList values.
ElementDescription
Namespace
Definition
<complexType name="ElementDescription">
<sequence>
<element name="attributeNamespace" type="string"
nillable="true" />
<element name="attributeFieldId" type="long" />
<element name="elementName" type="NCName" />
<element name="elementType" type="tns:ElementType" />
<element name="enumValues" type="tns:EnumerationValues"
nillable="true" />
</sequence>
</complexType>

attributeName
attributeNamespace
attributeFieldId
elementName
elementType
BMC Atrium Core 9.0
See ElementType.
Page 1591 of 2268
Home
See EnumerationValues.
enumValues
ElementDescriptionList
Namespace
Definition
<complexType name="ElementDescriptionList">
<sequence>
type="tns:ElementDescription" />
</sequence>
</complexType>

list
List of ElementDescription values.
ElementType
Namespace
Definition
<simpleType name="ElementType">
<enumeration value="NULL" />
<enumeration value="STRING" />
<enumeration value="INTEGER" />
<enumeration value="DOUBLE" />
<enumeration value="DECIMAL" />
<enumeration value="DATE" />
<enumeration value="TIME" />
<enumeration value="DATETIME" />
<enumeration value="CURRENCY" />
<enumeration value="DIARY" />
<enumeration value="ATTACH" />
<enumeration value="ATTACHPOOL" />
<enumeration value="ENUM" />
</restriction>
</simpleType>
ElementTypeList
BMC Atrium Core 9.0
Page 1592 of 2268
Home
Namespace
Definition
<complexType name="ElementTypeList">
<sequence>
type="tns:ElementType" />
</sequence>
</complexType>

list
List of ElementType values.
EndGraphWalk structure
The EndGraphWalk data structure ends the graph walk. Use this function after you retrieve the CI
and relationship information.
Namespace
Definition
<element name="EndGraphWalk">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
contextId
extensions
See ExtensionList.
EnumerationValue
BMC Atrium Core 9.0
Page 1593 of 2268
Home
Namespace
Definition
<complexType name="EnumerationValue">
<sequence>
<element name="integerValue" type="int" />
</sequence>
</complexType>

stringValue
Standard XML string format.
integerValue
Standard XML integer format.
EnumerationValueList
Namespace
Definition
<complexType name="EnumerationValueList">
<sequence>
type="tns:EnumerationValue" />
</sequence>
</complexType>

list
List of EnumerationValue values.
EnumerationValues
Namespace
Definition
<complexType name="EnumerationValues">
<sequence>
<element name="typeName" type="NCName" />
<element name="enumerationValues"
type="tns:EnumerationValueList" />
</sequence>
BMC Atrium Core 9.0
Page 1594 of 2268
Home
</complexType>

typeName
enumerationValues
See EnumerationValueList.
EnumItem
The EnumItem data structure defines enumerated items.
Namespace
Definition
<complexType name="EnumItem">
<sequence>
<element name="id" type="int" />
</sequence>
</complexType>

name
Name of the enumerated item.
id
Identifier for the enumerated item.
EnumItemList
The EnumItemList data structure holds enumerated item list information.
Namespace
Definition
<complexType name="EnumItemList">
<sequence>
<element name="list" type="tns:EnumItem"
</sequence>
</complexType>

list
List of EnumItem values.
BMC Atrium Core 9.0
Page 1595 of 2268
Home
EnumLimit
The EnumLimit data structure defines enumerated list constraints.
Namespace
Definition
<complexType name="EnumLimit">
<sequence>
<element name="listStyle" type="tns:EnumStyle" />
<element name="regularEnumItems" type="common:StringArray" />
<element name="customEnumItems" type="tns:EnumItemList" />
</sequence>
</complexType>

listStyle
See IntLimit.
regularEnumItems
See StringArray.
customEnumItems
See EnumItemList.
EnumStyle
The EnumStyle data structure specifies an enumeration pattern. When working with data-oriented
XML, there is often a requirement to handle "controlled vocabularies", otherwise known as
enumerated values.
Namespace
Definition
<simpleType name="EnumStyle">
<enumeration value="CUSTOM" />
</restriction>
</simpleType>
REGULAR--Defined by and controlled by the W3C XML Schemas, because this is the
dominant XML schema format for data-oriented XML.
CUSTOM--Defined by or specifically for your company.
BMC Atrium Core 9.0
Page 1596 of 2268
Home
ExecuteSavedQuery structure
The ExecuteSavedQuery data structure creates information about a graph query.
Namespace
Definition
<element name="ExecuteSavedQuery">
<complexType>
<sequence>
<element name="parameterValues"
type="tns:SavedQueryParameterValueList"/>
<element name="datasetId" type="string"/>
<element name="datasetMask" type="common:GetMask"/>
<element name="firstRetrieve" type="int"/>
<element name="maxRetrieve" type="int"/>
<element name="returnNumMatches" type="boolean"/>
<element name="formatType"
type="tns:GraphQueryResultFormat"/>
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
queryName
parameterValues
See SavedQueryParameterValueList.
datasetId
Unique identifier of dataset.
datasetMask
See GetMask.
firstRetrieve
maxRetrieve
returnNumMatches
formatType
See GraphQueryResultFormat.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1597 of 2268
Home
ExpirationIn
The ExpirationIn data structure holds the expiration information.
Namespace
Definition
<complexType name="ExpirationIn">
<choice>
<element name="expirationDuration" type="duration" />
<element name="expirationDateTime" type="dateTime" />
</choice>
</complexType>

expirationDuration
expirationDateTime
ExpirationOut
The ExpirationOut data structure holds the expiration information.
Namespace
Definition
<complexType name="ExpirationOut">
<sequence>
<element name="expirationDuration" type="duration" />
<element name="expirationDateTime" type="dateTime" />
<element name="isExpired" type="boolean" />
</sequence>
</complexType>

expirationDuration
expirationDateTime
Date time value indicating when the element expires. Standard XML dateTime format.
isExpired
ExportNEConfigurationOutput
The ExportNEConfigurationOutput data structure holds exported configuration information.
BMC Atrium Core 9.0
Page 1598 of 2268
Home
Namespace
Definition
<element name="ExportNEConfigurationOutput">
<complexType>
<sequence>
<element name="xml" type="string" />
nillable="true" />
</sequence>
</complexType>
</element>

xml
Any standard XML string.
status
See StatusList.
extensions
See ExtensionList.
ExportNEConfiguration structure
The ExportNEConfiguration data structure exports configuration information.
Namespace
Definition
<element name="ExportNEConfiguration">
<complexType>
<sequence>
nillable="true" />
<element name="exportOptions"
type="tns:NEExportOptionTypeList" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
BMC Atrium Core 9.0
Page 1599 of 2268
Home
exportOptions
See NEExportOptionTypeList
extensions
See ExtensionList.
ExposureType
The ExposureType data structure specifies whether an object should be visible to the user.
Namespace
Definition
<simpleType name="ExposureType">
<enumeration value="USED_VISIBLE" />
<enumeration value="USED_HIDDEN" />
</restriction>
</simpleType>
NONE
USED_VISIBLE
USED_HIDDEN
ExtensionList
The ExtensionList data structure enables you to add items to existing lists. This element enables
existing services to be extended without making modifications to the WSDL interface. The element
is applicable to any changes made to WSDL services in a patch release.
Namespace
Definition
<complexType name="ExtensionList">
<sequence>
<any namespace="##other"
processContents="lax"
minOccurs="0"
</sequence>
</complexType>
FederatedAccessType
The FederatedAccessType data structure defines valid access types.
BMC Atrium Core 9.0
Page 1600 of 2268
Home
Namespace
Definition
<simpleType name="FederatedAccessType">
<enumeration value="AR" />
<enumeration value="URL" />
<enumeration value="WEB_SERVICE" />
<enumeration value="PROCESS" />
<enumeration value="MANUAL" />
<enumeration value="DATA_STORE" />
</restriction>
</simpleType>
AR--Access is through the AR System forms.

URL --Access is through a static URL.
WEB_SERVICE--Access is through a web service.
PROCESS--Access is through a process.
MANUAL--Access is manual.
DATA_STORE--Access is through a data store.
FederatedAccessTypeAR
The FederatedAccessTypeAR data s tructure defines valid AR System access types.
Namespace
Definition
<simpleType name="FederatedAccessTypeAR">
<enumeration value="AR_URL" />
<enumeration value="AR_PROCESS" />
</restriction>
</simpleType>
AR_URL--Access is through the AR System URL.

AR_PROCESS--Access is through an AR System process.
FederatedActionType
The FederatedActionType data structure defines valid action types.
Namespace
BMC Atrium Core 9.0
Page 1601 of 2268
Home
Definition
<simpleType name="FederatedActionType">
<enumeration value="LAUNCH" />
<enumeration value="DATA_RETURN" />
</restriction>
</simpleType>
LAUNCH --Access a manual launch link information for the federated interface
DATA_RETURN
FederatedActivateInfo
The FederatedActivateInfo data structure defines federated instance activation information.
Namespace
Definition
<complexType name="FederatedActivateInfo">
<sequence>
<element name="accessType" type="tns:FederatedAccessType" />
<element name="actionType" type="tns:FederatedActionType" />
<element name="accessString" type="string" />
<element name="arInfo" type="tns:FederatedARInfo"
nillable="true" />
</sequence>
</complexType>

accessType
See FederatedAccessType.
actionType
See FederatedActionType.
accessString
Based on the accessType subclasses, contains the URL link, process command, or other information.
arInfo
See FederatedARInfo.
The FederatedActivationOption data structure defines valid activation option types.
Namespace
BMC Atrium Core 9.0
Page 1602 of 2268
Home
Definition
<simpleType name="FederatedActivationOption">
<enumeration value="EXPAND" />
<enumeration value="LAUNCH" />
</restriction>
</simpleType>
NONE--Activate none.
EXPAND--Only activate, no launch.
LAUNCH--Activate and launch.
FederatedARInfo
The FederatedARInfo data structure specifies AR System access information.
Namespace
Definition
<complexType name="FederatedARInfo">
<sequence>
<element name="accessType"
type="tns:FederatedAccessTypeAR" />
<element name="form" type="string" />
<element name="qualifier" type="string" />
<element name="server" type="string" />
<element name="url" type="string" />
<element name="view" type="string" />
</sequence>
</complexType>
The FederatedARInfo structure consists of the following elements:

accessType
See FederatedAccessTypeAR.
form
The AR System form name.
qualifier
The qualifier string for accessing the AR System.
server
The AR System server name.
url
Contains a URL to access the AR System form depending on whether the default web path is specified on the AR
System server.
view
The AR System view name.
BMC Atrium Core 9.0
Page 1603 of 2268
Home
FunctionalCurrency
The FunctionalCurrency data structure holds the monetary unit of account of the principal
economic environment in which an economic entity operates.
Namespace
Definition
<complexType name="FunctionalCurrency">
<sequence>
<element name="value" type="decimal" />
<element name="code" type="string" />
</sequence>
</complexType>

value
Numeric value of the base currency type.
code
Code you want to or have already associated with the currency value.
FunctionalCurrencyList
The FunctionalCurrency List data structure holds a list of functional currency values.
Namespace
Definition
<complexType name="FunctionalCurrencyList">
<sequence>
<element name="list" type="tns:FunctionalCurrency"
</sequence>
</complexType>

list
List of FunctionalCurrency values.
GetAttributesOutput
The GetAttributesOutput data structure holds attribute output information.
Namespace
BMC Atrium Core 9.0
Page 1604 of 2268
Home
Definition
<element name="GetAttributesOutput">
<complexType>
<sequence>
<element name="attributeInfoList"
type="tns:AttributeInfoList" />
nillable="true" />
</sequence>
</complexType>
</element>

attributeInfoList
See AttributeInfoList.
statusType
See Status.
extensions
See ExtensionList.
GetAttributes structure
The GetAttributes data structure retrieves attribute information.
Namespace
Definition
<element name="GetAttributes">
<complexType>
<sequence>
nillable="true" />
<element name="attributeNames" type="common:StringArray"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
BMC Atrium Core 9.0
Page 1605 of 2268
Home
attributeNames
See StringArray.
extensions
See ExtensionList.
GetBusinessObjectOutput
The GetBusinessObjectOutput data structure retrieves information about business objects.
Namespace
Definition
<element name="GetBusinessObjectOutput">
<complexType>
<sequence>
<element name="extensions"
type="common:ExtensionList" nillable="true" />
</sequence>
</complexType>
</element>

businessObject
See BusinessObject.
status
See StatusList.
extensions
See ExtensionList.
GetBusinessObject structure
The GetBusinessObject data structure retrieves information about business objects.
Namespace
Definition
<element name="GetBusinessObject">
<complexType>
<sequence>
nillable="true" />
<element name="boRef" type="tns:BORef" />
nillable="true" />
BMC Atrium Core 9.0
Page 1606 of 2268
Home
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
boRef
See BORef.
extensions
See ExtensionList.
GetClassOutput
The GetClassOutput data structure retrieves class information.
Namespace
Definition
<element name="GetClassOutput">
<complexType>
<sequence>
<element name="classInfo" type="tns:ClassInfoOut" />
nillable="true" />
</sequence>
</complexType>
</element>

classInfo
See ClassInfoOut.
status
See StatusList.
extensions
See ExtensionList.
GetClass structure
The GetClass data structure retrieves class information.
Namespace
BMC Atrium Core 9.0
Page 1607 of 2268
Home
Definition
<element name="GetClass">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
extensions
See ExtensionList.
GetCopyAuditData (atrium_audit) structure

The GetCopyAuditData data structure holds data copied and the information about that data for
auditing purposes.
Namespace
Definition
<element name="GetCopyAuditData">
<complexType>
<sequence>
nillable="true" />
<element name="query" type="string"
nillable="true" />
<element name="attributes" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1608 of 2268
Home
loginInfo
See LoginInfo.
classNameId
See ClassNameId.
instanceId
datasetId
query
The query string in the AR QualifierInfo format.
attributes
See StringArray.
extensions
See ExtensionList.
GetCopyAuditData (atrium_instances) structure

The GetCopyAuditData data structure holds data copied and the information about that data for
auditing purposes.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
<element name="query" type="string"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
instanceId
datasetId
query
attributes
See StringArray.
BMC Atrium Core 9.0
Page 1609 of 2268
Home
See ExtensionList.
extensions
GetCopyAuditDataOutput
The GetCopyAuditDataOutput data structure holds auditing information.
Namespace
Definition
<element name="GetCopyAuditDataOutput">
<complexType>
<sequence>
<element name="auditValueListList"
type="tns:AuditValueListList" />
nillable="true" />
</sequence>
</complexType>
</element>

auditValueListList
See AuditValueListList (atrium_audit).
status
See StatusList.
extensions
See ExtensionList.
GetDatasetOutput
The GetDatasetOutput data structure holds information about the dataset.
Namespace
Definition
<element name="GetDatasetOutput">
<complexType>
<sequence>
<element name="datasetInfo" type="tns:DatasetInfo" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1610 of 2268
Home

datasetInfo
See DatasetInfo.
status
See StatusList.
extensions
See ExtensionList.
GetDataset structure
The GetDataset data structure retrieves dataset information.
Namespace
Definition
<element name="GetDataset">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
coreDatasetId
extensions
See ExtensionList.
GetGraphWalkStatusOutput
The GetGraphWalkStatusOutput data structure holds information about the graph walk.
Namespace
Definition
<element name="GetGraphWalkStatusOutput">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1611 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>

expiration
See ExpirationOut.
hasNext
status
See StatusList.
extensions
See ExtensionList.
GetGraphWalkStatus structure
The GetGraphWalkStatus data structure holds information about the graph walk.
Namespace
Definition
<element name="GetGraphWalkStatus">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
contextId
extensions
See ExtensionList.
GetInstancesOutput
The GetInstancesOutput data structure retrieves information about the instance.
Namespace
BMC Atrium Core 9.0
Page 1612 of 2268
Home
Definition
<element name="GetInstancesOutput">
<complexType>
<sequence>
type="common:InstanceInfoOutList" />
nillable="true" />
</sequence>
</complexType>
</element>

instanceInfo
See InstanceInfoOutList.
status
See StatusList.
extensions
See ExtensionList.
GetInstances structure
The GetInstances data structure retrieves instance information.
Namespace
Definition
<element name="GetInstances">
<complexType>
<sequence>
nillable="true" />
<element name="query" type="string" />
<element name="firstRetrieve" type="int" />
<element name="maxRetrieve" type="int" />
<element name="sortOrder" type="tns:SortOrderList" />
<element name="getMask" type="common:GetMask" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1613 of 2268
Home

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
query
attributes
See StringArray.
firstRetrieve
The first instance to retrieve for the qualification. Represents the first entry and is the default value if the value is
not set.
maxRetrieve
The maximum number of entries to retrieve for the qualification. Use this parameter to limit the amount of data
returned if the query does not narrow the list. Specify 0 to assign no maximum.
sortOrder
datasetId
getMask
See GetMask.
extensions
See ExtensionList.
GetLastNEJobRunStatusOutput
The GetLastNEJobRunStatusOutput data structure holds information about the status of the
previously run job.
Namespace
Definition
<element name="GetLastNEJobRunStatusOutput">
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:NEJobRunInfo"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunInfo
See NENameInfo.
status
See StatusList.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1614 of 2268
Home
GetLastNEJobRunStatus structure
The GetLastNEJobRunStatus data structure holds information about the status of the previously
run job.
Namespace
Definition
<element name="GetLastNEJobRunStatus">
<complexType>
<sequence>
nillable="true" />
<element name="jobName" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobName
The name of the job.
extensions
See ExtensionList.
GetMask
The GetMask data structure defines the valid values for the data mask type definition.
Namespace
Definition
<simpleType name="GetMask">
<enumeration value="DATASET_MODE_CURRENT" />
<enumeration value="GET_MASK_NONE" />
</restriction>
</simpleType>
DATASET_MODE_CURRENT --Retreives instances from the current dataset only.

GET_MASK_NONE --Retreives instances based on the datasetId being passed, instances
are retrieved from either the overlay or the original dataset.
BMC Atrium Core 9.0
Page 1615 of 2268
Home
GetMultipleBusinessObjectsOutput
The GetMultipleBusinessObjectsOutput data structure retrieves several business objects.
Namespace
Definition
<element name="GetMultipleBusinessObjectsOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

businessObjectList
status
See StatusList.
extensions
See ExtensionList.
GetMultipleBusinessObjects structure
The GetMultipleBusinessObjects data structure retrieves several business objects.
Namespace
Definition
<element name="GetMultipleBusinessObjects">
<complexType>
<sequence>
nillable="true" />
<element name="boRefList" type="tns:BORefList" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1616 of 2268
Home

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
boRefList
See BORefList.
extensions
See ExtensionList.
GetNEJobRunStatusOutput
The GetNEJobRunStatusOutput data structure holds information about the status of a job.
Namespace
Definition
<element name="GetNEJobRunStatusOutput">
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:NEJobRunInfo" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunInfo
See NENameInfo.
status
See StatusList.
extensions
See ExtensionList.
GetNEJobRunStatus structure
The GetNEJobRunStatus data structure retrieves information about the status of a job.
Namespace
Definition
<element name="GetNEJobRunStatus">
<complexType>
BMC Atrium Core 9.0
Page 1617 of 2268
Home
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
GetNormalizedInfoListByFileInfo
The GetNormalizedInfoListByFileInfo data structure retrieves information about the normalized
instance.
Namespace
Definition
<element name="GetNormalizedInfoListByFileInfo">
<complexType>
<sequence>
nillable="true" />
<element name="fileInfoList" type="tns:NEFileInfoList" />
<element name="attrGetList" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
fileInfoList
See NEFileInfoList.
attrGetList
See StringArray.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1618 of 2268
Home
GetNormalizedInfoListByFPKey structure
The GetNormalizedInfoListByFPKey data structure retrieves information about the normalized
instance.
Namespace
Definition
<element name="GetNormalizedInfoListByFPKey">
<complexType>
<sequence>
nillable="true" />
<element name="fpKeyList" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
fpKeyList
See StringArray.
attrGetList
See StringArray.
extensions
See ExtensionList.
GetNormalizedInfoListByName structure
The GetNormalizedInfoListByFileInfo data structure retrieves information about the normalized
instance.
Namespace
Definition
<element name="GetNormalizedInfoListByName">
<complexType>
<sequence>
nillable="true" />
<element name="nameInfoList" type="tns:NENameInfoList" />
nillable="true" />
BMC Atrium Core 9.0
Page 1619 of 2268
Home
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
nameInfoList
See NENameInfoList.
attrGetList
See StringArray.
extensions
See ExtensionList.
GetNormalizedInfoListByPCKey structure
The GetNormalizedInfoListByPCKey data structure retrieves information about the normalized
instance.
Namespace
Definition
<element name="GetNormalizedInfoListByPCKey">
<complexType>
<sequence>
nillable="true" />
<element name="pcKeyList" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
pcKeyList
See StringArray.
attrGetList
See StringArray.
extensions
See ExtensionList.
GetNormalizedInfoList structure
The GetNormalizedInfoList data structure retrieves information about the normalized instances.
Namespace
BMC Atrium Core 9.0
Page 1620 of 2268
Home
Definition
<element name="GetNormalizedInfoList">
<complexType>
<sequence>
nillable="true" />
<element name="queryInfoList"type="tns:NEQueryInfoList" />
<element name="multiMatchOption"
type="tns:NEMultiMatchOptionType" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
queryInfoList
See NEQueryInfoList.
attrGetList
See StringArray.
multiMatchOption
See NEMultiMatchOptionType.
extensions
See ExtensionList.
GetProperties (service configuration) structure

The GetProperties data structure holds information about the configuration property.
Namespace
Definition
<element name="GetProperties">
<complexType>
<sequence>
</sequence>
</complexType>
</element>

propertyNames
BMC Atrium Core 9.0
List of propertyNames values.
Page 1621 of 2268
Home
GetProperties (service utility)

The GetProperties data structure holds property names.
*http://atrium.bmc.com/2009/01/serviceutility/types*
Namespace
Definition
<complexType>
<sequence>
</sequence>
</complexType>
</element>

See StringArray.
propertyNames
GetPropertiesOutput
The GetPropertiesOutput data structure holds information about the configuration property.
Namespace
Definition
<element name="GetPropertiesOutput">
<complexType>
<sequence>
<element name="properties"
type="tns:ConfigPropertyList" />
</sequence>
</complexType>
</element>

properties
See ConfigPropertyList.
See StringArray.
BMC Atrium Core 9.0
Page 1622 of 2268
Home
See StringArray.
See StringArray.
GetREJobRun (classic reconciliation)

The GetREJobRun data structure gets information about the currently running reconciliation job
and retrieves a job log. For information about interpreting job run logs and job run information, see
the section "Viewing job status, results, and history" in the Installation and Configuration Guide.
Namespace
Definition
<element name="GetREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
Unique identifier for the job.
extensions
See ExtensionList.
GetREJobRun (reconciliation)
The GetREJobRun data structure retrieves information about the Reconciliation Engine job.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
BMC Atrium Core 9.0
Page 1623 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
GetREJobRunEventListOutput
The GetREJobRunEventListOutput data structure retrieves information about the Reconciliation
Engine job.
Namespace
Definition
<element name="GetREJobRunEventListOutput">
<complexType>
<sequence>
<element name="jobRunEventList"
type="tns:REJobRunEventList" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunEventList
See REJobRunEventList.
status
See StatusList.
extensions
See ExtensionList.
GetREJobRunEventList structure
The GetREJobRunEventList data structure retrieves information about the Reconciliation Engine
job.
Namespace
BMC Atrium Core 9.0
Page 1624 of 2268
Home
Definition
<element name="GetREJobRunEventList">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
GetREJobRunEventOutput
The GetREJobRunEventOutput data structure retrieves information about the Reconciliation Engine
job.
Namespace
Definition
<element name="GetREJobRunEventOutput">
<complexType>
<sequence>
<element name="jobRunEvent" type="tns:REJobRunEvent" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunEvent
See REJobRunEvent.
status
See StatusList.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1625 of 2268
Home
GetREJobRunEvent structure
The GetREJobRunEvent data structure retrieves information about the Reconciliation Engine job.
Namespace
Definition
<element name="GetREJobRunEvent">
<complexType>
<sequence>
nillable="true" />
<element name="jobRunEventId" type="string" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunEventId
Unique identifier for the job run event.
extensions
See ExtensionList.
GetREJobRunList (classic reconciliation)

The GetREJobRunList data structure retrieves reconciliation engine jobs information.
Namespace
Definition
<element name="GetREJobRunList">
<complexType>
<sequence>
nillable="true" />
<element name="numMatch" type="int" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1626 of 2268
Home

loginInfo
See LoginInfo.
qualifier
Value that restricts the set of returned data.
numMatch
Maximum number of matches to return.
extensions
See ExtensionList.
GetREJobRunList (reconciliation)
The GetREJobRunList data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
<element name="jobId" type="string" />
<element name="queryDateQualifier"
type="tns:QueryDateQualifier" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobId
queryDateQualifier
See QueryDateQualifier.
extensions
See ExtensionList.
GetREJobRunListOutput (classic reconciliation)

The GetREJobRunListOutput data structure retrieves reconciliation engine jobs information.
Namespace
Definition
<element name="GetREJobRunListOutput">
BMC Atrium Core 9.0
Page 1627 of 2268
Home
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:REJobRunInfoList" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunInfo
See StartREJobRun (classic reconciliation).
status
See StatusList.
extensions
See ExtensionList.
GetREJobRunListOutput (reconciliation)
The GetREJobRunListOutput data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType>
<sequence>
<element name="jobRunList" type="tns:REJobRunList" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunList
See REJobRunEvent.
status
See StatusList.
extensions
See ExtensionList.
GetREJobRunOutput (classic reconciliation)

The GetREJobRunOutput data structure returns Reconciliation Engine job information.
Namespace
BMC Atrium Core 9.0
Page 1628 of 2268
Home
Definition
<element name="GetREJobRunOutput">
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:REJobRunInfo" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRunInfo
See StartREJobRun (classic reconciliation).
status
See StatusList.
extensions
See ExtensionList.
GetREJobRunOutput (reconciliation)
The GetREJobRunOutput data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType>
<sequence>
<element name="jobRun" type="tns:REJobRun"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

jobRun
See REJobRun.
status
See StatusList.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1629 of 2268
Home
GetRelatedFederatedInContextOutput
The GetRelatedFederatedInContextOutput data structure retrieves federated data.
Namespace
Definition
<element name="GetRelatedFederatedInContextOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

instanceInfo
status
See StatusList.
extensions
See ExtensionList.
GetRelatedFederatedInContext structure
The GetRelatedFederatedInContext data structure holds information about federated data.
Namespace
Definition
<element name="GetRelatedFederatedInContext">
<complexType>
<sequence>
nillable="true" />
<element name="attributeNames"
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1630 of 2268
Home
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
datasetId
instanceId
attributeNames
See StringArray.
extensions
See ExtensionList.
GetRelatedServicesOutput
The GetRelatedServicesOutput data structure holds information about the service impact.
Namespace
Definition
<element name="GetRelatedServicesOutput">
<complexType>
<sequence>
<element name="datasetInfo" type="datasets:DatasetInfo" />
<element name="instanceList"
nillable="true" />
</sequence>
</complexType>
</element>

datasetInfo
See DatasetInfo.
instanceList
status
See StatusList.
extensions
See ExtensionList.
GetRelatedServices structure
The GetRelatedServices data structure holds information about the service impact.
Namespace
BMC Atrium Core 9.0
Page 1631 of 2268
Home
Definition
<element name="GetRelatedServices">
<complexType>
<sequence>
nillable="true" />
<element maxOccurs="unbounded" minOccurs="0"
name="attributesToInclude" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
instanceId
classNameId
See ClassNameId.
datasetInfo
See DatasetInfo.
attributesToInclude
List of attributes.
status
See StatusList.
extensions
See ExtensionList.
GetSavedQuery (atrium_graphquery) structure

The GetSavedQuery data structure holds information about the graph query.
Namespace
Definition
<element name="GetSavedQuery">
<complexType>
<sequence>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1632 of 2268
Home
</element>

loginInfo
See LoginInfo.
queryName
extensions
See ExtensionList.
GetSavedQuery (atrium_query) structure

The GetSavedQuery data structure holds information about the query.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
<element name="instanceId" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
instanceId
extensions
See ExtensionList.
GetSavedQueryOutput (atrium_graphquery)
The GetSavedQueryOutput data structure holds information about the graph query.
Namespace
Definition
<element name="GetSavedQueryOutput">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1633 of 2268
Home
<element name="savedQuery" nillable="true"

type="tns:SavedGraphQuery"/>
<element name="status" type="common:StatusList"/>
</sequence>
</complexType>
</element>

savedQuery
status
See StatusList.
extensions
See ExtensionList.
GetSavedQueryOutput (atrium_query)
The GetSavedQueryOutput data structure holds information about the query.
Namespace
Definition
<complexType>
<sequence>
<element name="savedQueryData" type="tns:SavedQueryData"/>
nillable="true" />
</sequence>
</complexType>
</element>

savedQueryData
See SavedQueryData.
status
See StatusList.
extensions
See ExtensionList.
GetUIComponentsOutput
The GetUIComponentsOutput data structure holds information about the UI components.
Namespace
BMC Atrium Core 9.0
Page 1634 of 2268
Home
Definition
<element name="GetUIComponentsOutput">
<complexType>
<sequence>
<element name="uiComponentResultList"
type="tns:UIComponentResultList" />
nillable="true" />
</sequence>
</complexType>
</element>

uiComponentResultList
See UIComponentResultList.
status
See StatusList.
extensions
See ExtensionList.
GetUIComponents structure
The GetUIComponents data structure retrieves information about the UI components.
Namespace
Definition
<element name="GetUIComponents">
<complexType>
<sequence>
nillable="true" />
<element name="componentInfo"
type="tns:UIComponentInfo" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
BMC Atrium Core 9.0
Page 1635 of 2268
Home
componentInfo
datasetId
instanceId
extensions
See ExtensionList.
GetVersionsOutput
The GetVersionsOutput data structure holds version information.
*http://atrium.bmc.com/2009/01/versions/types*
Namespace
Definition
<element name="GetVersionsOutput">
<complexType>
<sequence>
<element name="versionInfoList"
type="tns:VersionInfoList" />
nillable="true" />
</sequence>
</complexType>
</element>

versionInfoList
See VersionInfoList.
status
See StatusList.
extensions
See ExtensionList.
GetVersions structure
The GetVersions data structure retrieves application version information.
Namespace
Definition
<element name="GetVersions">
<complexType>
<sequence>
nillable="true" />
<element name="appIdList" type="common:StringArray" />
BMC Atrium Core 9.0
Page 1636 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
appIdList
See StringArray.
extensions
See ExtensionList.
GraphQueryInput
Namespace
Definition
<complexType name="GraphQueryInput">
<sequence>
<element name="itemList" nillable="true"
type="tns:QueryItemList"/>
<element name="relationshipList" nillable="true"
type="tns:QueryRelationshipList"/>
<element name="startNodeIdList" nillable="true"
type="tns:NillableStringArray"/>
<element name="querySortArray" nillable="true"
type="tns:QuerySortArray"/>
</sequence>
</complexType>

itemList
See QueryItemList.
relationshipList
See QueryRelationshipList.
startNodeIdList
See NillableStringArray.
querySortArray
See QuerySortArray.
GraphQueryObject
Namespace
Definition
<complexType name="GraphQueryObject">
BMC Atrium Core 9.0
Page 1637 of 2268
Home
<sequence>
<element name="className" nillable="true"
type="common:ClassNameId"/>
<element name="id" nillable="true" type="string"/>
<element name="constraint" nillable="true"
type="tns:QueryQualifier"/>
<element name="suppressFromResult" nillable="true"
type="boolean"/>
<element name="contentSelector" nillable="true"
type="tns:NillableStringArray"/>
<element name="characteristicMap" nillable="true"
type="classes:PropertyList"/>
</sequence>
</complexType>

className
See ClassNameId.
id
Unique identifier.
constraint
See QueryQualifier (atrium_graphquery).
suppressFromResult
Indicates that the relationships that correspond to the template with this attribute should be absent in the
results.
contentSelector
See NillableStringArray.
characteristicMap
See PropertyList.
GraphQueryOutput
Namespace
Definition
<element name="GraphQueryOutput">
<complexType>
<sequence>
<element name="queryResult" nillable="true"
type="tns:GraphQueryOutput"/>
</sequence>
</complexType>
</element>

queryResult
See GraphQueryResult.
BMC Atrium Core 9.0
Page 1638 of 2268
Home
status
See StatusList.
extensions
See ExtensionList.
GraphQueryResult (7.6.04) structure

Namespace
Definition
<complexType name="GraphQueryResult">
<choice>
<element name="nodeListArray" type="tns:NodeListArray" />
<element name="edgeListArray" type="tns:EdgeListArray" />
</choice>
</complexType>

nodeListArray
See .
edgeListArray
See .
GraphQueryResult data structure

The GraphQueryResult data structure defines the format of the graph query results.
Namespace
Definition
<choice>
</choice>
</complexType>

nodeListArray
See NodeListArray.
edgeListArray
See EdgeListArray.
GraphQueryResultFormat
The GraphQueryResultFormat data structure defines the format of the graph query results.
BMC Atrium Core 9.0
Page 1639 of 2268
Home
Namespace
Definition
<simpleType name="GraphQueryResultFormat">
<enumeration value="CHUNK_BASED"/>
<enumeration value="GRAPH"/>
<enumeration value="LIST"/>
</restriction>
</simpleType>
CHUNK_BASED
GRAPH
LIST
GraphQueryResult structure
Namespace
Definition
<choice>
<element name="listResult" type="query:QueryResultGraph" />
<element name="graphResult" type="tns:QueryResultGraph" />
</choice>
</complexType>

listResult
See QueryResultGraph (atrium_query).
graphResult
See QueryResultGraph (atrium_graphquery).
GraphQuery structure
Namespace
Definition
<element name="GraphQuery">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1640 of 2268
Home
<element name="graphQuery" type="tns:GraphQueryInput"/>
<element name="returnNumMatches" type="boolean"/>
type="tns:GraphQueryResultFormat"/>
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
graphQuery
See GraphQueryInput.
datasetId
Unique identifier of dataset.
datasetMask
See GetMask.
firstRetrieve
maxRetrieve
returnNumMatches
formatType
See GraphQueryResultFormat.
extensions
See ExtensionList.
GraphWalkAttributeFlag
The GraphWalkAttributeFlag data structure defines valid attribute flags.
Namespace
Definition
<simpleType name="GraphWalkAttributeFlag">
<enumeration value="ALL" />
<enumeration value="NONHIDDEN" />
</restriction>
</simpleType>
ALL
NONE
BMC Atrium Core 9.0
Page 1641 of 2268
Home
NOHIDDEN
GraphWalkObjectFlag
The GraphWalkObjectFlag data structure defines valid object flag types.
Namespace
Definition
<simpleType name="GraphWalkObjectFlag">
</restriction>
</simpleType>
ALL
NONE
GraphWalkQuery
The GraphWalkQuery data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkQuery">
<sequence>
<element name="datasetMask" type="common:GetMask"
nillable="true" />
<element name="queryMode" type="tns:GraphWalkQueryMode" />
<element name="relation" type="tns:GraphWalkRelationList"
nillable="true" />
<element name="numLevels" type="int" nillable="true" />
<element name="maxRetrieve" type="int" nillable="true" />
<element name="selectorAndFilter"
type="tns:GraphWalkSelectorAndFilterList"
nillable="true" />
</sequence>
</complexType>

datasetId
BMC Atrium Core 9.0
Page 1642 of 2268
Home
datasetMask
See GetMask.
queryMode
See GraphWalkQueryMode.
relation
See GraphWalkRelationList.
numLevels
The number of levels to traverse the specified queryGraph. The value A-1 specifies the graph query to
traverse to the end of the graph.
maxRetrieve
The maximum number of instances to retrieve. Use this parameter to limit the instances returned in the query
if the qualification does not sufficiently narrow the list. Specify 0 to assign no maximum instances.
selectorAndFilter
See GraphWalkSelectorAndFilterList.
GraphWalkQueryMode
The GraphWalkQueryMode data structure defines valid query mode types.
Namespace
Definition
<simpleType name="GraphWalkQueryMode">
<enumeration value="STOP_IF_MATCH_FOUND" />
<enumeration value="STOP_IF_NO_MATCH_FOUND" />
<enumeration value="WALK_COMPLETE_GRAPH" />
</restriction>
</simpleType>
STOP_IF_MATCH_FOUND
STOP_IF_NO_MATCH_FOUND
WALK_COMPLETE_GRAPH
GraphWalkRelation
The GraphWalkRelation data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkRelation">
<sequence>
<element name="relationshipClassNameId"
<element name="attributeList" type="common:StringArray" />
<element name="direction"
type="tns:GraphWalkRelationDirection" />
/sequence>
BMC Atrium Core 9.0
Page 1643 of 2268
Home
</complexType>

relationshipClassNameId
See ClassNameId.
qualifier
attributeList
See StringArray.
direction
See GraphWalkRelationDirection.
GraphWalkRelationArray
The GraphWalkRelationArray data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkRelationArray">
<sequence>
<element name="list" type="tns:GraphWalkRelation"
</sequence>
</complexType>

list
List of GraphWalkRelation values.
GraphWalkRelationDirection
The GraphWalkRelationDirection data structure defines valid directional types.
Namespace
Definition
<simpleType name="GraphWalkRelationDirection">
<enumeration value="IN" />
<enumeration value="OUT" />
<enumeration value="BOTH" />
</restriction>
</simpleType>
IN
BMC Atrium Core 9.0
Page 1644 of 2268
Home
OUT
BOTH
GraphWalkRelationList
The GraphWalkRelationList data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkRelationList">
<sequence>
<element name="attributeFlag"
type="tns:GraphWalkAttributeFlag" />
<element name="relationList"
type="tns:GraphWalkRelationArray" />
</sequence>
</complexType>

attributeFlag
See GraphWalkAttributeFlag.
relationList
See GraphWalkRelationArray.
GraphWalkResult
The GraphWalkResult data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkResult">
<sequence>
<element name="objectList"
<element name="relationList"
</sequence>
</complexType>

objectList
relationList
BMC Atrium Core 9.0
Page 1645 of 2268
Home
GraphWalkSelectorAndFilter
The GraphWalkSelectorAndFilter data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkSelectorAndFilter">
<sequence>
</sequence>
</complexType>

classNameId
See ClassNameId.
qualifier
attributes
See StringArray.
GraphWalkSelectorAndFilterArray
The GraphWalkSelectorAndFilterArray data structure holds information about the graph walk.
Namespace
Definition
<complexType name="GraphWalkSelectorAndFilterArray">
<sequence>
<element name="list" type="tns:GraphWalkSelectorAndFilter"
</sequence>
</complexType>

list
List of GraphWalkSelectorAndFilter values.
GraphWalkSelectorAndFilterList
The GraphWalkSelectorAndFilterList data structure holds information about the graph walk.
BMC Atrium Core 9.0
Page 1646 of 2268
Home
Namespace
Definition
<complexType name="GraphWalkSelectorAndFilterList">
<sequence>
<element name="objectFlag" type="tns:GraphWalkObjectFlag" />
<element name="attributeFlag"
type="tns:GraphWalkAttributeFlag" />
<element name="selectorAndFilterList"
type="tns:GraphWalkSelectorAndFilterArray" />
</sequence>
</complexType>

objectFlag
See GraphWalkObjectFlag.
attributeFlag
See GraphWalkAttributeFlag.
selectorAndFilterList
See GraphWalkSelectorAndFilterArray.
ImportNEConfigurationOutput
The ImportNEConfigurationOutput data structure imports information about the configuration.
Namespace
Definition
<element name="ImportNEConfigurationOutput">
<complexType>
<sequence>
<element name="duplicateEntryGuids"
nillable="true" />
</sequence>
</complexType>
</element>

duplicateEntryGuids
See StringArray.
status
See StatusList.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1647 of 2268
Home
ImportNEConfiguration structure
The ImportNEConfiguration data structure imports information about the configuration.
Namespace
Definition
<element name="ImportNEConfiguration">
<complexType>
<sequence>
nillable="true" />
<element name="importOption"
type="tns:NEImportOptionType" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
xml
Any standard XML string.
importOption
See NEImportOptionType.
extensions
See ExtensionList.
IndexInfo
The IndexInfo data structure defines indexes about objects.
Namespace
Definition
<complexType name="IndexInfo">
<sequence>
<element name="indexName" type="string" />
<element name="unique" type="boolean" />
<element name="isPrimaryKey" type="boolean" />
<element name="attributeNames" type="common:StringArray" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1648 of 2268
Home

indexName
Name of the index.
unique
isPrimaryKey
attributeNames
See StringArray.
IndexList
The IndexList data structure defines index information.
Namespace
Definition
<complexType name="IndexList">
<sequence>
<element name="list" type="tns:IndexInfo"
</sequence>
</complexType>

list
List of IndexInfo values.
InstanceDeleteOption
The InstanceDeleteOption data structure defines delete options.
Namespace
Definition
<simpleType name="InstanceDeleteOption">
<enumeration value="DERIVED_INSTANCE_FOUND" />
<enumeration value="UNCONDITIONALLY" />
</restriction>
</simpleType>
DERIVED_INSTANCE_FOUND--Allows you to delete only the specified instance, if the

instance is retrieved.
UNCONDITIONALLY--Allows you to delete the instance even when the instance cannot be
retrieved. Errors will be ignored for instances that do not exist.
BMC Atrium Core 9.0
Page 1649 of 2268
Home
InstanceInfoOut
The InstanceInfoOut data structure holds class and instance information.
Namespace
Definition
<complexType name="InstanceInfoOut">
<sequence>
<element name="classNameId" type="tns:ClassNameId" />
<element name="instanceAttributes"
type="tns:AttributeValueList" />
</sequence>
</complexType>

classNameId
See ClassNameId.
instanceId
Unique identifier for the CI.
instanceAttributes
Attributes of the instance. See AttributeValueList.
InstanceInfoOutList
The InstanceInfoOutList data structure holds instance information.
Namespace
Definition
<complexType name="InstanceInfoOutList">
<sequence>
<element name="list" type="tns:InstanceInfoOut"
</sequence>
</complexType>

list
List of InstanceInfoOut values.
IntArray structure
The IntArray data structure is a variable array containing integers.
BMC Atrium Core 9.0
Page 1650 of 2268
Home
Namespace
Definition
<complexType name="IntArray">
<sequence>
<element name="list" type="int" minOccurs="0"
</sequence>
</complexType>

list
List of integer values.
IntLimit structure
The IntLimit data structure defines integer constraints.
Namespace
Definition
<complexType name="IntLimit">
<sequence>
<element name="highRange" type="int" />
<element name="lowRange" type="int" />
</sequence>
</complexType>

highRange
Integer specifying the highest integer value allowed. The high range of the custom characteristic for the integer data
type.
lowRange
Integer specifying the lowest integer value allowed. The low range of the custom characteristic for the integer data
type.
JobRunStatusType
The JobRunStatusType data structure defines valid values for Reconciliation Engine job status.
Namespace
BMC Atrium Core 9.0
Page 1651 of 2268
Home
Definition
<simpleType name="JobRunStatusType">
<enumeration value="ABORTED" />
<enumeration value="CANCELLED" />
<enumeration value="FAILED" />
<enumeration value="PAUSED" />
<enumeration value="QUEUED" />
<enumeration value="STARTED" />
<enumeration value="SUCCESS" />
</restriction>
</simpleType>
ABORTED
CANCELLED
FAILED
PAUSED
QUEUED
STARTED
SUCCESS
Keyword structure
The Keyword data structure holds valid values for a keyword.
Namespace
Definition
<simpleType name="Keyword">
<enumeration value="APPLICATION" />
<enumeration value="BROWSER" />
<enumeration value="CLIENT_TYPE" />
<enumeration value="CURRENT_WIN_ID" />
<enumeration value="DATABASE" />
<enumeration value="DATE_ONLY" />
<enumeration value="DEFAULT" />
<enumeration value="EVENT_SRC_WIN_ID" />
<enumeration value="EVENT_TYPE" />
<enumeration value="FIELD_HELP" />
<enumeration value="GROUPS" />
<enumeration value="GUIDE" />
<enumeration value="GUIDE_TEXT" />
<enumeration value="HARDWARE" />
<enumeration value="HOME_URL" />
BMC Atrium Core 9.0
Page 1652 of 2268
Home
<enumeration value="LAST_COUNT" />

<enumeration value="LAST_ID" />
<enumeration value="LAST_OPENED_WIN_ID" />
<enumeration value="LOCALE" />
<enumeration value="OPERATION" />
<enumeration value="OS" />
<enumeration value="ROLES" />
<enumeration value="ROW_CHANGED" />
<enumeration value="ROW_SELECTED" />
<enumeration value="SCHEMA" />
<enumeration value="SCHEMA_ALIAS" />
<enumeration value="SERVER" />
<enumeration value="TCP_PORT" />
<enumeration value="TIME_ONLY" />
<enumeration value="TIMESTAMP" />
<enumeration value="USER" />
<enumeration value="VERSION" />
<enumeration value="VUI" />
<enumeration value="VUI_TYPE" />
<enumeration value="WEEKDAY" />
</restriction>
</simpleType>
APPLICATION
BROWSER
CLIENT_TYPE
CURRENT_WIN_ID
DATABASE
DATE_ONLY
DEFAULT
EVENT_SRC_WIN_ID
EVENT_TYPE
FIELD_HELP
GROUPS
GUIDE
GUIDE_TEXT
HARDWARE
HOME_URL
LAST_COUNT
LAST_ID
LAST_OPENED_WIN_ID
LOCALE
OPERATION
OS
ROLES
ROW_CHANGED
ROW_SELECTED
BMC Atrium Core 9.0
Page 1653 of 2268
Home
SCHEMA
SCHEMA_ALIAS
SERVER
TCP_PORT
TIME_ONLY
TIMESTAMP
USER
VERSION
VUI
VUI_TYPE
WEEKDAY
ListClassesOutput
The ListClassesOutput data structure retrieves a list of classes.
Namespace
Definition
<element name="ListClassesOutput">
<complexType>
<sequence>
<element name="classList" type="common:ClassNameIdList" />
nillable="true" />
</sequence>
</complexType>
</element>

classList
See ClassNameIdList.
status
See StatusList.
extensions
See ExtensionList.
ListClasses structure
The ListClasses data structure retrieves a list of classes.
Namespace
BMC Atrium Core 9.0
Page 1654 of 2268
Home
Definition
<element name="ListClasses">
<complexType>
<sequence>
nillable="true" />
<element name="namespace" type="string"
nillable="true" />
<element name="relatedClass" type="common:ClassNameId"
nillable="true" />
<element name="superClass" type="common:ClassNameId"
nillable="true" />
<element name="propInfo" type="tns:PropInfoList"
nillable="true" />
<element name="getHidden" type="boolean" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
namespace
User-defined name for the namespace.
relatedClass
See ClassNameId.
superClass
See ClassNameId.
propInfo
See PropInfoList.
getHidden
extensions
See ExtensionList.
ListDatasetsOutput
The ListDatasetsOutput data structure holds information about the dataset.
Namespace
Definition
<element name="ListDatasetsOutput">
<complexType>
<sequence>
<element name="datasetInfo" type="tns:DatasetInfoList" />
BMC Atrium Core 9.0
Page 1655 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>

datasetInfo
See DatasetInfoList.
statusType
See StatusList.
extensions
See ExtensionList.
ListDatasets structure
The ListDatasets data structure holds information about the dataset.
Namespace
Definition
<element name="ListDatasets">
<complexType>
<sequence>
nillable="true" />
<element name="coreDatasetId" type="string"
nillable="true" />
<element name="sourceDatasetId" type="string"
nillable="true" />
<element name="datasetType" type="common:DatasetType"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
coreDatasetId
sourceDatasetId
Unique identifier of the source dataset.
datasetType
See DatasetType.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1656 of 2268
Home
ListSavedQueries (atrium_graphquery) structure

The ListSavedQueries data structure holds information about the graph query.
Namespace
Definition
<element name="ListSavedQueries">
<complexType>
<sequence>
<element name="characteristics" nillable="true"
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
characteristics
See PropertyList.
extensions
See ExtensionList.
ListSavedQueries (atrium_query) structure

The ListSavedQueries data structure holds information about the query.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1657 of 2268
Home

loginInfo
See LoginInfo.
extensions
See ExtensionList.
ListSavedQueriesOutput (atrium_graphquery)
The ListSavedQueriesOutput data structure holds information about the graph query.
Namespace
Definition
<element name="ListSavedQueriesOutput">
<complexType>
<sequence>
<element name="savedQueryRefList"
type="tns:SavedQueryRefList"/>
</sequence>
</complexType>
</element>

savedQueryRefList
See SavedQueryRefList.
status
See StatusList.
extensions
See ExtensionList.
ListSavedQueriesOutput (atrium_query)
The ListSavedQueriesOutput data structure holds information about the query.
Namespace
Definition
<complexType>
<sequence>
<element name="savedQueriesInfo"
type="tns:SavedQueryInfoList"/>
nillable="true" />
BMC Atrium Core 9.0
Page 1658 of 2268
Home
</sequence>
</complexType>
</element>

savedQueriesInfo
See SavedQueryInfoList.
status
See StatusList.
extensions
See ExtensionList.
Location structure
The Location data structure holds information describing the location of data.
Namespace
Definition
<complexType name="Location">
<choice>
<element name="fileName" type="string" />
<element name="buffer" type="tns:ByteArray" />
</choice>
</complexType>

fileName
Name of the file.
buffer
See StringArray.
LoginInfo structure
The LoginInfo data structure holds the login information for a user. User ID, passwords, domain
and other information necessary to log on to the application.
Namespace
Definition
<complexType name="LoginInfo">
<sequence>
<element name="locale" type="string" nillable="true" />
<element name="timeZone" type="string" nillable="true" />
<element name="authentication" type="string"
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1659 of 2268
Home
</complexType>

locale
The locale setting to use for the current session of the application.
timeZone
The region throughout which the same standard time is used.
authentication
The string necessary to establish the identity of the user.
NameValueList
The NameValueList data structure holds name-value pairs.
Namespace
Definition
<complexType name="NameValueList">
<sequence>
<element name="list" type="tns:NameValue"
</sequence>
</complexType>

list
List of NameValue values.
NameValue structure
The NameValue data structure holds name-value pairs.
Namespace
Definition
<complexType name="NameValue">
<sequence>
<element name="value" type="string" />
</sequence>
</complexType>

name
Attribute name.
BMC Atrium Core 9.0
Page 1660 of 2268
Home
value
Attribute value.
NEExportOptionType
The NEExportOptionType data structure defines valid values for export types.
Namespace
Definition
<simpleType name="NEExportOptionType">
<enumeration value="CATALOG_ALIAS_MAPPING" />
<enumeration value="CLASS_CONFIG" />
<enumeration value="DATASET_CONFIG" />
<enumeration value="JOB_SCHEDULE" />
</restriction>
</simpleType>
CATALOG_ALIAS_MAPPING
CLASS_CONFIG
DATASET_CONFIG
JOB_SCHEDULE
NEExportOptionTypeList
The NEExportOptionTypeList data structure holds valid values for export types.
Namespace
Definition
<complexType name="NEExportOptionTypeList">
<sequence>
<element name="list" type="tns:NEExportOptionType"
</sequence>
</complexType>

list
List of NEExportOptionType values.
NEFileInfo
The NEFileInfo data structure holds information about a file.
BMC Atrium Core 9.0
Page 1661 of 2268
Home
Namespace
Definition
<complexType name="NEFileInfo">
<sequence>
<element name="fileName" type="string" />
<element name="fileSize" type="string" />
</sequence>
</complexType>

fileName
Name of the file.
fileSize
Size of the file.
NEFileInfoList
The NEFileInfoList data structure holds information about files.
Namespace
Definition
<complexType name="NEFileInfoList">
<sequence>
<element name="list" type="tns:NEFileInfo"
</sequence>
</complexType>

list
List of NEFileInfoList values.
NEImportOptionType
The NEImportOptionType data structure defines valid values for import types.
Namespace
Definition
<simpleType name="NEImportOptionType">
BMC Atrium Core 9.0
Page 1662 of 2268
Home
<enumeration value="DISCARD_DUPLICATES" />

<enumeration value="KEEP_DUPLICATES" />
</restriction>
</simpleType>
DISCARD_DUPLICATES
KEEP_DUPLICATES
NEJobRunInfo
The NEJobRunInfo data structure defines information about a currently running Normalization
Engine job.
Namespace
Definition
<complexType name="NEJobRunInfo">
<sequence>
<element name="jobStartTime"type="dateTime" />
<element name="jobEndTime"type="dateTime" nillable="true" />
<element name="jobName"type="string" />
<element name="jobRunStatus"
type="tns:NEJobRunStatusType" />
<element name="reasonForAbort" type="string" />
<element name="currentClass" type="string" />
<element name="totalClasses" type="int" />
<element name="totalCIProcessed" type="int" />
<element name="totalCIsInCurrentClass" type="int" />
<element name="numberOfClassesProcessed" type="int" />
<element name="numberOfCIProcessedInCurrentClass"
type="int" />
<element name="logFileNames" type="string" />
<element name="isFullRun" type="boolean" />
</sequence>
</complexType>

jobStartTime
jobEndTime
jobName
Name of the job.
jobRunId
Unique identifier for the job execution.
jobRunStatus
See NEJobRunStatusType.
reasonForAbort
Description of reasoning for stopping the job execution.
BMC Atrium Core 9.0
Page 1663 of 2268
Home
currentClass
Name of the class.
totalClasses
Integer value indicating the number of classes for the job.
totalCIProcessed
Integer value indicating the number of classes actually processed for the job.
totalCIsInCurrentClass
Integer value indicating the number of CIs in the class.
numberOfClassesProcessed
Integer value indicating the number of classes processed by the job.
numberOfCIProcessedInCurrentClass
Integer value indicating the number of CIs processed for the class currently being
processed by the job.
logFileNames
Name of the log file.
isFullRun
NEJobRunStatusType
The NEJobRunStatusType data structure defines valid values for job status.
Namespace
Definition
<simpleType name="NEJobRunStatusType">
<enumeration value="COMPLETED" />
<enumeration value="STOPPED" />
</restriction>
</simpleType>
ABORTED
COMPLETED
STARTED
STOPPED
NEMultiMatchOptionType
The NEMultiMatchOptionType data structure defines valid values for multi-match options.
Namespace
Definition
<simpleType name="NEMultiMatchOptionType">
<enumeration value="RETURN_ERROR" />
<enumeration value="RETURN_LIST" />
BMC Atrium Core 9.0
Page 1664 of 2268
Home
</restriction>
</simpleType>
RETURN_ERROR
RETURN_LIST
NENameInfo
The NENameInfo data structure holds information about the product and vendor.
Namespace
Definition
<complexType name="NENameInfo">
<sequence>
<element name="productName" type="string" />
<element name="vendorName" type="string" />
<element name="version" type="string" />
<element name="patch" type="string" />
</sequence>
</complexType>

productName
Name of the product.
vendorName
Name of the vendor.
version
Name or number of the version.
patch
Name or number used to identify the patch.
NENameInfoList
The NENameInfoList data structure holds a list of information about product and vendors.
Namespace
Definition
<complexType name="NENameInfoList">
<sequence>
<element name="list" type="tns:NENameInfo"
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1665 of 2268
Home

list
List of NENameInfo values.
NEQueryInfo
The NEQueryInfo data structure holds query information.
Namespace
Definition
<complexType name="NEQueryInfo">
<sequence>
<element name="nameInfo" type="tns:NENameInfo" />
<element name="fileInfo"type="tns:NEFileInfo" />
<element name="dictionaryId" type="string" />
<element name="fpKey" type="string" />
</sequence>
</complexType>

nameInfo
See NENameInfo.
fileInfo
See NENameInfo.
dictionaryId
Unique identifier for the dictionary.
fpKey
The finger print key.
NEQueryInfoList
The NEQueryInfoList data structure holds query information.
Namespace
Definition
<complexType name="NEQueryInfoList">
<sequence>
<element name="list" type="tns:NEQueryInfo"
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1666 of 2268
Home
list
List of NEQueryInfo values.
NEQueryResult
The NEQueryResult data structure holds information retrieved from the query.
Namespace
Definition
<complexType name="NEQueryResult">
<sequence>
<element name="attributes"type="common:AttributeValueList" />
<element name="isMultiMatch"type="boolean" />
<element name="multiMatchList"
type="common:AttributeValueListList" />
<element name="resultCriteria"
type="tns:NEQueryResultCriteriaType" />
<element name="pcKey"type="string" />
</sequence>
</complexType>

attributes
isMultiMatch
multiMatchList
See AttributeValueListList.
resultCriteria
See StartNEJobRun.
pcKey
The unique identifier for the product catalog.
status
See StatusList.
NEQueryResultCriteriaType
The NEQueryResultCriteriaType data structure defines valid values for query results.
Namespace
Definition
<simpleType name="NEQueryResultCriteriaType">
<enumeration value="UNAVAILABLE" />
<enumeration value="BASED_ON_PC_KEY" />
<enumeration value="BASED_ON_NAME_INFO" />
BMC Atrium Core 9.0
Page 1667 of 2268
Home
<enumeration value="BASED_ON_FP_KEY" />

<enumeration value="BASED_ON_FILE_INFO" />
</restriction>
</simpleType>
UNAVAILABLE
BASED_ON_PC_KEY
BASED_ON_NAME_INFO
BASED_ON_FP_KEY
BASED_ON_FILE_INFO
NEQueryResultList
The NEQueryResultList data structure holds information query results.
Namespace
Definition
<complexType name="NEQueryResultList">
<sequence>
<element name="list" type="tns:NEQueryResult"
</sequence>
</complexType>

list
List of NEQueryResult values.
NEQueryResultListOutput
The NEQueryResultListOutput data structure holds query results.
Namespace
Definition
<element name="NEQueryResultListOutput">
<complexType>
<sequence>
<element name="queryResult"
type="tns:NEQueryResultList" />
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1668 of 2268
Home
</complexType>
</element>

queryResult
See NEQueryResultList.
status
See StatusList.
extensions
See ExtensionList.
NestedQuery
The NestedQuery data structure holds information about the nested query.
Namespace
Definition
<complexType name="NestedQuery">
<sequence>
<element name="queryObjects" type="tns:QueryObjectList"/>
<element name="queryObjectsOptional"
type="tns:QueryObjectList" nillable="true"/>
<element name="queryObjectSelector"
type="tns:QueryObjectSelector"/>
</sequence>
</complexType>

queryObjects
See QueryObjectList.
queryObjectSelector
See QueryObjectSelector.
NillableStringArray
Namespace
Definition
<complexType name="NillableStringArray">
<sequence>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1669 of 2268
Home

list
List of string values.
NillableValueList
Namespace
Definition
<complexType name="NillableValueList">
<sequence>
type="common:Value" nillable="true" />
</sequence>
</complexType>

list
List of values.
NodeListArray
Namespace
Definition
<complexType name="NodeListArray">
<sequence>
type="tns:NodeList" />
</sequence>
</complexType>

list
List of NodeList values.
NodeList structure
The NodeList structure holds information about items, or instances.
Namespace
BMC Atrium Core 9.0
Page 1670 of 2268
Home
Definition
<complexType name="NodeList">
<sequence>
<element name="instances"
</sequence>
</complexType>

id
instances
NormalizeInstanceList structure
The NormalizeInstanceList data structure holds information about the normalized instances.
Namespace
Definition
<element name="NormalizeInstanceList">
<complexType>
<sequence>
nillable="true" />
<element name="instanceIdList"
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
instanceIdList
See StringArray.
extensions
See ExtensionList.
NullType structure
BMC Atrium Core 9.0
Page 1671 of 2268
Home
Namespace
Definition
<complexType name="NullType">
<sequence />
</complexType>
PauseREJobRun structure
The PauseREJobRun data structure pauses the Reconciliation Engine job.
Namespace
Definition
<element name="PauseREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
PropertyFileFormat structure
The PropertyFileFormat data structure holds configuration property information.
Namespace
Definition
<element name="PropertyFileFormat">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1672 of 2268
Home
type="config:ConfigPropertyList" />
</sequence>
</complexType>
</element>

properties
PropertyList
The PropertyList data structure defines a list of properties.
Namespace
Definition
<complexType name="PropertyList">
<sequence>
<element name="list" type="tns:Property"
</sequence>
</complexType>

list
List of Property values.
Property structure
The Property data structure defines properties and their values.
Namespace
Definition
<complexType name="Property">
<sequence>
<element name="tag" type="int" />
<element name="value" type="common:Value"
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1673 of 2268
Home
tag
An integer value indicating the particular display property.
value
See Value. The value for the property, which can be of any supported data type.
PropInfo
The PropInfo data structure holds property information. After they are defined, tags can be used
instead of longer value names in your code.
Namespace
Definition
<complexType name="PropInfo">
<sequence>
<element name="tag" type="int" />
<element name="value" type="common:Value" />
</sequence>
</complexType>

tag
An integer value used as a programatic constant or variable.
value
See Value. The value for the property.
PropInfoList
The PropInfoList data structure holds property information.
Namespace
Definition
<complexType name="PropInfoList">
<sequence>
<element name="list" type="tns:PropInfo"
</sequence>
</complexType>

list
List of PropInfo values.
BMC Atrium Core 9.0
Page 1674 of 2268
Home
PullGraphWalkResultsOutput
The PullGraphWalkResultsOutput data structure holds information about the graph walk.
Namespace
Definition
<element name="PullGraphWalkResultsOutput">
<complexType>
<sequence>
<element name="results" type="tns:GraphWalkResult" />
nillable="true" />
</sequence>
</complexType>
</element>

results
See GraphWalkResult.
expiration
See ExpirationOut.
hasNext
status
See StatusList.
extensions
See ExtensionList.
PullGraphWalkResults structure
The PullGraphWalkResults data structure holds information about the graph walk.
Namespace
Definition
<element name="PullGraphWalkResults">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1675 of 2268
Home
</complexType>
</element>

loginInfo
See LoginInfo.
contextId
extensions
See ExtensionList.
QueryArithOpType (atrium_graphquery)
The QueryArithOpType data structure defines valid values for query arithmetic types. Specifies the
arithmetic operation to perform in the query.
Namespace
Definition
<simpleType name="QueryArithOpType">
<enumeration value="ADD" />
<enumeration value="SUBTRACT" />
<enumeration value="MULTIPLY" />
<enumeration value="DIVIDE" />
<enumeration value="MODULO" />
<enumeration value="NEGATE" />
</restriction>
</simpleType>
ADD--The arithmetic operation to perform in the query is

addition.
SUBTRACT--The arithmetic operation to perform in the query is (-) subtraction.
MULTIPLY--The arithmetic operation to perform in the query is (*) multiplication.
DIVIDE--The arithmetic operation to perform in the query is
division.
MODULO--The arithmetic operation to perform in the query is (%) modulus.
NEGATE--The arithmetic operation to perform in the query is negative, for example, the
value of +5 is converted to -5.
QueryArithOpType (atrium_query)
Namespace
BMC Atrium Core 9.0
Page 1676 of 2268
Home
Definition
</restriction>
</simpleType>
addition.

division.

QueryArithOpType (atrium_querybypath)
Namespace
Definition
</restriction>
</simpleType>
addition.

BMC Atrium Core 9.0
division.
Page 1677 of 2268
Home

QueryBusinessObjectRefsOutput
The QueryBusinessObjectRefsOutput data structure retrieves several business objects.
Namespace
Definition
<element name="QueryBusinessObjectRefsOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

boRefList
See BORefList.
status
See StatusList.
extensions
See ExtensionList.
QueryBusinessObjectRefs structure
The QueryBusinessObjectRefs data structure retrieves several business objects.
Namespace
Definition
<element name="QueryBusinessObjectRefs">
<complexType>
<sequence>
nillable="true" />
<element name="query" type="query:Query" />
nillable="true" />
BMC Atrium Core 9.0
Page 1678 of 2268
Home
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
query
See SavedQueryInfo.
extensions
See ExtensionList.
QueryBusinessObjectsOutput
The QueryBusinessObjectsOutput data structure retrieves several business objects.
Namespace
Definition
<element name="QueryBusinessObjectsOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

businessObjectList
status
See StatusList.
extensions
See ExtensionList.
QueryBusinessObjects structure
The QueryBusinessObjects data structure retrieves several business objects.
Namespace
BMC Atrium Core 9.0
Page 1679 of 2268
Home
Definition
<element name="QueryBusinessObjects">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
query
See SavedQueryInfo.
extensions
See ExtensionList.
QueryByPathInput
The QueryByPathInput data structure holds information about the query.
Namespace
Definition
<complexType name="QueryByPathInput">
<sequence>
nillable="true" />
<element name="query" type="tns:Query"/>
<element name="queryDescription" type="string"/>
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1680 of 2268
Home
loginInfo
See LoginInfo.
query
See SavedQueryInfo.
queryDescription
Description of the query.
extensions
See ExtensionList.
QueryByPathOutput
The QueryByPathOutput data structure holds information about the query.
Namespace
Definition
<element name="QueryByPathOutput">
<complexType>
<sequence>
<element name="queryResult" type="tns:QueryResultGraph"/>
nillable="true" />
</sequence>
</complexType>
</element>

queryResult
status
See StatusList.
extensions
See ExtensionList.
QueryByPath structure
The QueryByPath data structure holds information about the query.
Namespace
Definition
<element name="QueryByPath" type="tns:QueryByPath"/>
<complexType name="QueryByPath">
<sequence>
<element name="input" type="tns:QueryByPathInput"/>
<element name="executeOption"
type="tns:QueryExecuteOption"/>
</sequence>
BMC Atrium Core 9.0
Page 1681 of 2268
Home
</complexType>

input
See " Reconciliation structures " in List of data structures categorized by type.
executeOption
See SavedQueryInfo.
QueryByPathXMLInput
The QueryByPathXMLInput data structure holds information about the query.
Namespace
Definition
<complexType name="QueryByPathXMLInput">
<sequence>
name="list" type="string"/>
<element name="queryDescription" type="string"/>
nillable="true" />
</sequence>
</complexType>

list
queryDescription
Description of the query.
extensions
See ExtensionList.
QueryByPathXML structure
The QueryByPathXML data structure holds information about the query.
Namespace
Definition
<element name="QueryByPathXML" type="tns:QueryByPathXML"/>
<complexType name="QueryByPathXML">
<sequence>
<element name="input" type="tns:QueryByPathXMLInput"/>
<element name="executeOption" type="tns:QueryExecuteOption"/>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1682 of 2268
Home

input
executeOption
See SavedQueryInfo.
QueryCardinality
Namespace
Definition
<complexType name="QueryCardinality">
<sequence>
<element name="type" type="tns:QueryCardinalityType"/>
<element name="minCount" type="int"/>
<element name="maxCount" type="int"/>
</sequence>
</complexType>

See QueryCardinalityType.
type
minCount
maxCount
QueryCardinalityType
Namespace
Definition
<simpleType name="QueryCardinalityType">
<enumeration value="OPTIONAL"/>
<enumeration value="REQUIRED"/>
</restriction>
</simpleType>
OPTIONAL
REQUIRED
BMC Atrium Core 9.0
Page 1683 of 2268
Home
QueryDateQualifier
The QueryDateQualifier data structure holds information about the query.
Namespace
Definition
<complexType name="QueryDateQualifier">
<choice>
<element name="durationInDays" type="int" />
<element name="dateSpan" type="tns:QueryDateSpan" />
</choice>
</complexType>

durationInDays
Integer value indicating the number of days worth of data to query.
dateSpan
See QueryDateSpan.
QueryDateSpan
The QueryDateSpan data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="QueryDateSpan">
<sequence>
<element name="fromDate"type="date" />
<element name="toDate"type="date" />
</sequence>
</complexType>

fromDate
Standard XML date data type. Example, May the 31st, 1999 is: 1999-05-31.
toDate
Standard XML date data type. Example, May the 31st, 1999 is: 1999-05-31.
QueryExecuteOption
The QueryExecuteOption data structure defines valid values for query options.
BMC Atrium Core 9.0
Page 1684 of 2268
Home
Note
This data structure is not supported in the atrium_querybypath service.
Namespace
Definition
<simpleType name="QueryExecuteOption">
<enumeration value="EXECUTE_ONLY" />
<enumeration value="SAVE_ONLY" />
<enumeration value="EXECUTE_AND_SAVE" />
</restriction>
</simpleType>
EXECUTE_ONLY--Run the query.

SAVE_ONLY--Save the information defined for the query.
EXECUTE_AND_SAVE--Save the query information and run the query.
QueryInput
The QueryInput data structure holds information about the query.
Namespace
Definition
<complexType name="QueryInput">
<sequence>
<element name="queryObjectSelectorList"
type="tns:QueryObjectSelectorList"/>
</sequence>
</complexType>

datasetId
The unique identifier for the dataset.
datasetMask
See GetMask.
queryObjects
See QueryObjectSelectorList.
BMC Atrium Core 9.0
Page 1685 of 2268
Home
QueryInput2
The QueryInput2 data structure extends query input by adding three additional attributes.
Namespace
Definition
<complexType name="QueryInput2">
<complexContent>
<extension base="tns:QueryInput">
<sequence>
<element name="queryObjectsOptional"
type="tns:QueryObjectList" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>

firstRetrieve
The first instance to retrieve for the qualification. Represents the first entry and is the default value if the
value is not set.
maxRetrieve
The maximum number of entries to retrieve for the qualification. Use this parameter to limit the amount
of data returned if the query does not narrow the list.
QueryInput3
The QueryInput3 data structure extends query input by adding an additional attribute.
Namespace
Definition
<complexContent>
<extension base="tns:QueryInputBasic">
<sequence>
<element name="querySortArray"
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1686 of 2268
Home

See QuerySortArray.
querySortArray
QueryInput4
The QueryInput4 data structure extends query input by adding three additional attributes.
Namespace
Definition
<complexContent>
<extension base="tns:QueryInputBasic">
<sequence>
<element name="querySortArray"
</sequence>
</extension>
</complexContent>
</complexType>

firstRetrieve
value is not set.
maxRetrieve
QueryInput5
The QueryInput5 data structure extends query input by adding an additional attribute.
Namespace
Definition
<complexContent>
<extension base="tns:QueryInput4">
<sequence>
<element name="queryResultFormat"
type="tns:QueryResultFormat"/>
BMC Atrium Core 9.0
Page 1687 of 2268
Home
</sequence>
</extension>
</complexContent>
</complexType>

firstRetrieve
value is not set.
maxRetrieve
QueryInputBasic
The QueryInputBasic data structure holds information about the query.
Namespace
Definition
<complexType name="QueryInputBasic">
<sequence>
<element name="queryObjectSelectorList"
type="tns:QueryObjectSelectorList"/>
<element name="queryResultFormat"
type="tns:QueryResultFormat"/>
<element name="numMatchesMask" type="boolean"/>
</sequence>
</complexType>

datasetId
datasetMask
See GetMask.
queryObjects
See QueryObjectSelectorList.
queryResultFormat
See QueryResultFormat
numMatchesMask
QueryItem
BMC Atrium Core 9.0
Page 1688 of 2268
Home
Namespace
Definition
<complexType name="QueryItem">
<complexContent>
<extension base="tns:GraphQueryObject">
<sequence>
<element name="foldBehind" type="common:StringArray" />
<element name="level" type="int" />
</sequence>
</extension>
</complexContent>
</complexType>

foldBehind
See StringArray.
level
QueryItemList
Namespace
Definition
<complexType name="QueryItemList">
<sequence>
type="tns:QueryItem"/>
</sequence>
</complexType>

list
List of QueryItem values.
QueryJoinType
The QueryJoinType data structure holds join information about the query.
Namespace
BMC Atrium Core 9.0
Page 1689 of 2268
Home
Definition
<simpleType name="QueryJoinType">
<enumeration value="NONE"/>
<enumeration value="INNER"/>
<enumeration value="LEFT"/>
<enumeration value="RIGHT"/>
</restriction>
</simpleType>

INNER--Inner join
LEFT--Left outer join
NONE--No explicit Join type to perform in the query. If no explicit Join type is specified, an
inner join is performed in the query, using the relationship attributes in the qualification.
RIGHT--Right outer join
QueryObject
The QueryObject data structure holds information about the query.
Namespace
Definition
<complexType name="QueryObject">
<sequence>
<element name="alias" type="string"/>
<element name="classNameId" type="common:ClassNameId"/>
<element name="qualification" type="tns:QueryQualifier"
nillable="true" />
</sequence>
</complexType>

alias
The unique alias for the query object.
classNameId
See ClassNameId.
qualification
See QueryQualifier (atrium_query).
QueryObject (atrium_querybypath)
The QueryObject data structure holds information about the query.
BMC Atrium Core 9.0
Page 1690 of 2268
Home
Namespace
Definition
<complexType name="QueryObject">
<sequence>
<element name="qualification" type="tns:QueryQualifier"
<element name="sourceNodeAlias" nillable="true"
type="string"/>
<element name="joinType" type="tns:QueryJoinType"/>
<element name="joinQualification" nillable="true"
nillable="true" />
</sequence>
</complexType>

alias
classNameId
See ClassNameId.
qualification
See QueryQualifier (atrium_query).
sourceNodeAlias
The starting node for the query.
joinType
See QueryJoinType.
joinQualification
See QueryQualifier (atrium_querybypath).
QueryObjectList
The QueryObjectList data structure holds information about the query.
Namespace
Definition
<complexType name="QueryObjectList">
<sequence>
type="tns:QueryObjectSel"/>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1691 of 2268
Home
list
List of QueryObjectSelvalues.
QueryObjectRegular
Namespace
Definition
<complexType name="QueryObjectRegular">
<complexContent>
<extension base="tns:QueryObject">
</extension>
</complexContent>
</complexType>
QueryObjectRelationship
The QueryObjectRelationship data structure holds information about the object relationship.
Namespace
Definition
<complexType name="QueryObjectRelationship">
<complexContent>
<extension base="tns:QueryObject">
<sequence>
<element name="direction"
type="tns:RelationshipDirection"/>
</sequence>
</extension>
</complexContent>
</complexType>

direction
See RelationshipDirection.
QueryObjectSel
The QueryObjectSel data structure holds information about the query.
Namespace
BMC Atrium Core 9.0
Page 1692 of 2268
Home
Definition
<complexType name="QueryObjectSel">
<choice>
<element name="queryObjectRegular"
type="tns:QueryObjectRegular"/>
<element name="queryObjectRelationship"
type="tns:QueryObjectRelationship"/>
</choice>
</complexType>

queryObjectRegular
See QueryObjectRegular.
queryObjectRelationship
See QueryObjectRelationship.
QueryObjectSelector
The QueryObjectSelector data structure holds information about the query.
Namespace
Definition
<complexType name="QueryObjectSelector">
<sequence>
name="attributes" type="string"/>
</sequence>
</complexType>

alias
attributes
The attributes for the query object.
QueryObjectSelectorFlag
The QueryObjectList data structure defines selector flags for the query.
Namespace
BMC Atrium Core 9.0
Page 1693 of 2268
Home
Definition
<simpleType name="QueryObjectSelectorFlag">
<enumeration value="DEFAULT_NONE" />
<enumeration value="DEFAULT_NONHIDDEN" />
<enumeration value="DEFAULT_ALL" />
</restriction>
</simpleType>
DEFAULT_NONE
DEFAULT_NONHIDDEN
DEFAULT_ALL
QueryObjectSelectorList
The QueryObjectSelectorList data structure holds information about the query.
Namespace
Definition
<complexType name="QueryObjectSelectorList">
<sequence>
<element name="flags" type="tns:QueryObjectSelectorFlag"/>
type="tns:QueryObjectSelector"/>
</sequence>
</complexType>

flags
See SavedQueryInfo.
list
List of QueryObjectSelector values.
QueryQualifier (atrium_graphquery)
The QueryQualifier data structure holds information about the graph query.
Namespace
Definition
<complexType name="QueryQualifier">
BMC Atrium Core 9.0
Page 1694 of 2268
Home
<choice>
<element name="queryQualifierOpAnd"
type="tns:QueryQualifierOpAnd"/>
<element name="queryQualifierOpNot"
type="tns:QueryQualifierOpNot"/>
<element name="queryQualifierOpOr"
type="tns:QueryQualifierOpOr"/>
<element name="queryQualifierSetOp"
type="tns:QueryQualifierSetOp"/>
<element name="queryQualifierSimpleOp"
type="tns:QueryQualifierSimpleOp"/>
<element name="savedQueryQualifierSimpleOp"
type="tns:SavedQueryQualifierSimpleOp"/>
</choice>
</complexType>

queryQualifierOpAnd
The logical condition to perform in the query is "and."
queryQualifierOpNot
The logical condition to perform in the query is "not", for example, "!=."
queryQualifierOpOr
The logical condition to perform in the query is "or."
queryQualifierSetOp
The logical condition to perform in the query is "set."
queryQualifierSimpleOp
The logical condition to perform in the query is "simple."
QueryQualifier (atrium_query)
The QueryQualifier data structure holds information about the query.
Namespace
Definition
<choice>
</choice>
</complexType>
BMC Atrium Core 9.0
Page 1695 of 2268
Home

queryQualifierOpAnd
queryQualifierOpNot
queryQualifierOpOr
queryQualifierSetOp
QueryQualifier (atrium_querybypath)
The QueryQualifier data structure holds information about the query.
Namespace
Definition
<choice>
</choice>
</complexType>

queryQualifierOpAnd
queryQualifierOpNot
queryQualifierOpOr
queryQualifierSetOp
QueryQualifierAndOr
The QueryQualifierAndOr data structure holds the left and right operands of a query.
Namespace
BMC Atrium Core 9.0
Page 1696 of 2268
Home
Definition
<complexType name="QueryQualifierAndOr">
<sequence>
<element name="operandLeft" type="tns:QueryQualifier"/>
<element name="operandRight" type="tns:QueryQualifier"/>
</sequence>
</complexType>

operandLeft
The QueryQualifier instance that contains the value that appears to the left of the AND or OR logical condition.
For example, in the qualification, "Type ="Operating system" AND Model = "Microsoft Windows XP", the Type
qualification is specified in operandLeft.
operandRight
The QueryQualifier instance that contains the value that appears to the right of the AND or OR logical operator.
For example, in the qualification, "Type ="Operating system" AND Model = "Microsoft Windows XP", the Model
qualification is specified in operandRight.
QueryQualifierBase
Namespace
Definition
<complexType name="QueryQualifierBase">
<sequence>
</sequence>
</complexType>

characteristics
See PropertyList.
QueryQualifierBasic
The QueryQualifierBasic data structure holds the attribute characteristics of a query.
Namespace
Definition
<complexType name="QueryQualifierBasic">
<sequence>
<element name="characteristicMap"
BMC Atrium Core 9.0
Page 1697 of 2268
Home
type="tns:CharacteristicMap"/>
</sequence>
</complexType>

CharacteristicMap
See CharacteristicMap.
QueryQualifierOpAnd (atrium_graphquery)
Namespace
Definition
<complexType name="QueryQualifierOpAnd">
<complexContent>
<extension base="tns:QueryQualifierOpAndOr">
<sequence/>
</extension>
</complexContent>
</complexType>
QueryQualifierOpAnd (atrium_query)
Namespace
Definition
<complexContent>
<extension base="tns:QueryQualifierAndOr">
</extension>
</complexContent>
</complexType>
QueryQualifierOpAnd (atrium_querybypath)
Namespace
Definition
<complexContent>
BMC Atrium Core 9.0
Page 1698 of 2268
Home
</extension>
</complexContent>
</complexType>
QueryQualifierOpAndOr (atrium_graphquery)
Namespace
Definition
<complexType name="QueryQualifierOpAndOr">
<complexContent>
<extension base="tns:QueryQualifierBase">
<sequence>
<element name="operandLeft" nillable="true"
<element name="operandRight" nillable="true"
</sequence>
</extension>
</complexContent>
</complexType>

operandLeft
operandRight
QueryQualifierOperation (atrium_graphquery)
The QueryQualifierOperation data structure defines valid values for query qualifiers.
Namespace
Definition
<simpleType name="QueryQualifierOperation">
<enumeration value="EQUAL" />
<enumeration value="GREATER" />
<enumeration value="GREATER_EQUAL" />
<enumeration value="LESS" />
<enumeration value="LESS_EQUAL" />
<enumeration value="NOT_EQUAL" />
<enumeration value="LIKE" />
</restriction>
</simpleType>
BMC Atrium Core 9.0
Page 1699 of 2268
Home
EQUAL
GREATER
GREATER_EQUAL
LESS
LESS_EQUAL
NOT_EQUAL
LIKE
QueryQualifierOperation (atrium_query)
Namespace
Definition
</restriction>
</simpleType>
EQUAL
GREATER
GREATER_EQUAL
LESS
LESS_EQUAL
NOT_EQUAL
LIKE
QueryQualifierOperation (atrium_querybypath)
Namespace
Definition
BMC Atrium Core 9.0
Page 1700 of 2268
Home
</restriction>
</simpleType>
EQUAL
GREATER
GREATER_EQUAL
LESS
LESS_EQUAL
NOT_EQUAL
LIKE
QueryQualifierOpNot (atrium_graphquery)
Namespace
Definition
<complexType name="QueryQualifierOpNot">
<complexContent>
<sequence>
<element name="notQual" nillable="true"
</sequence>
</extension>
</complexContent>
</complexType>
QueryQualifierOpNot (atrium_query)
Namespace
Definition
<sequence>
<element name="notQual" type="tns:QueryQualifier"/>
</sequence>
BMC Atrium Core 9.0
Page 1701 of 2268
Home
</complexType>
QueryQualifierOpNot (atrium_querybypath)
Namespace
Definition
<complexContent>
<extension base="tns:QueryQualifierBasic">
<sequence>
<element name="notQual" type="tns:QueryQualifier"/>
</sequence>
</extension>
</complexContent>
</complexType>
QueryQualifierOpOr (atrium_graphquery)
Namespace
Definition
<complexType name="QueryQualifierOpOr">
<complexContent>
<extension base="tns:QueryQualifierOpAndOr">
<sequence/>
</extension>
</complexContent>
</complexType>
QueryQualifierOpOr (atrium_query)
Namespace
Definition
<complexContent>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1702 of 2268
Home
QueryQualifierOpOr (atrium_querybypath)
Namespace
Definition
<complexContent>
</extension>
</complexContent>
</complexType>
QueryQualifierSetOp (atrium_graphquery)
The QueryQualifierSetOp data structure holds information about the graph query.
Namespace
Definition
<complexType name="QueryQualifierSetOp">
<complexContent>
<sequence>
<element name="attribute" nillable="true"
type="string"/>
<element name="operation" nillable="true"
type="tns:QueryQualifierSetOpOperation"/>
type="tns:NillableValueList"/>
</sequence>
</extension>
</complexContent>
</complexType>

attribute
operation
See QueryQualifierSetOpOperation (atrium_graphquery).
operandRight
See NillableValueList.
QueryQualifierSetOp (atrium_query)
The QueryQualifierSetOp data structure holds information about the query.
BMC Atrium Core 9.0
Page 1703 of 2268
Home
Namespace
Definition
<sequence>
<element name="attribute" type="string"/>
<element name="operation"
<element name="operandRight"
type="tns:QueryQualifierValueSetSel"/>
</sequence>
</complexType>

attribute
operation
See QueryQualifierSetOpOperation (atrium_query).
operandRight
QueryQualifierSetOp (atrium_querybypath)
The QueryQualifierSetOp data structure holds information about the query.
Namespace
Definition
<sequence>
<element name="operandRight"
type="tns:QueryQualifierValueSetSel"/>
</sequence>
</complexType>

attribute
operation
See QueryQualifierSetOpOperation (atrium_querybypath).
operandRight
See QueryQualifierValueSetSel.
BMC Atrium Core 9.0
Page 1704 of 2268
Home
QueryQualifierSetOpOperation (atrium_graphquery)
The QueryQualifierSetOpOperation data structure defines valid values for qualifier set options.
Namespace
Definition
<simpleType name="QueryQualifierSetOpOperation">
<enumeration value="NOT_IN" />
</restriction>
</simpleType>
IN--Operation to perform in the query, for example, 'Model IN "Microsoft Windows XP", "
Microsoft Windows 2003", "Microsoft Windows 2000.
NOT_IN--Operation to perform in the query, for example, 'Model NOT IN "Microsoft Windows
XP", "Microsoft Windows 2003", "Microsoft Windows 2000.
QueryQualifierSetOpOperation (atrium_query)
Namespace
Definition
</restriction>
</simpleType>
QueryQualifierSetOpOperation (atrium_querybypath)
Namespace
BMC Atrium Core 9.0
Page 1705 of 2268
Home
Definition
</restriction>
</simpleType>
QueryQualifierSimpleOp (atrium_graphquery)
The QueryQualifierSimpleOp data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierSimpleOp">
<complexContent>
<sequence>
<element name="attribute" nillable="true"
type="string"/>
type="tns:QueryQualifierOperation"/>
type="tns:QueryQualifierValue"/>
</sequence>
</extension>
</complexContent>
</complexType>

attribute
operation
See QueryQualifierOperation (atrium_query).
operandRight
See QueryQualifierValue (atrium_query).
QueryQualifierSimpleOp (atrium_query)
BMC Atrium Core 9.0
Page 1706 of 2268
Home
Namespace
Definition
<sequence>
<element name="operandRight" type="tns:QueryQualifierValue"/>
</sequence>
</complexType>

attribute
operation
operandRight
QueryQualifierSimpleOp (atrium_querybypath)
Namespace
Definition
<sequence>
<element name="operandRight" type="tns:QueryQualifierValue"/>
</sequence>
</complexType>

attribute
operation
See QueryQualifierOperation (atrium_querybypath).
operandRight
See QueryQualifierValue (atrium_querybypath).
QueryQualifierValue (atrium_graphquery)
The QueryQualifierValue data structure holds information about the query.
BMC Atrium Core 9.0
Page 1707 of 2268
Home
Namespace
Definition
<complexType name="QueryQualifierValue">
<choice>
<element name="arithExpr"
type="tns:QueryQualifierValueTypeArithExpr"/>
<element name="attributeName"
type="tns:QueryQualifierValueTypeAttributeName"/>
</choice>
</complexType>

value
See Value.
arithExpr
See QueryQualifierValueTypeArithExpr (atrium_graphquery).
attributeName
See QueryQualifierValueTypeAttributeName (atrium_graphquery).
QueryQualifierValue (atrium_query)
Namespace
Definition
<choice>
<element name="queryQualifierValueTypeArithExpr"
<element name="queryQualifierValueTypeAttributeName"
<element name="queryQualifierValueTypeValue"
type="tns:QueryQualifierValueTypeValue"/>
</choice>
</complexType>

queryQualifierValueTypeArithExpr
See QueryQualifierValueTypeArithExpr (atrium_query).
queryQualifierValueTypeAttributeName
See QueryQualifierValueTypeAttributeName (atrium_query).
queryQualifierValueTypeValue
See QueryQualifierValueTypeValue.
BMC Atrium Core 9.0
Page 1708 of 2268
Home
QueryQualifierValue (atrium_querybypath)
Namespace
Definition
<choice>
<element name="queryQualifierValueTypeArithExpr"
<element name="queryQualifierValueTypeAttributeName"
<element name="queryQualifierValueTypeValue"
type="tns:QueryQualifierValueTypeValue"/>
</choice>
</complexType>

queryQualifierValueTypeArithExpr
See QueryQualifierValueTypeArithExpr (atrium_querybypath).
queryQualifierValueTypeAttributeName
See QueryQualifierValueTypeAttributeName (atrium_querybypath).
queryQualifierValueTypeValue
See QueryQualifierValueTypeValue.
QueryQualifierValueSetSel
The QueryQualifierValueSetSel data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierValueSetSel">
<choice>
<element name="queryQualifierValueSetTypeQuery"
type="tns:QueryQualifierValueSetTypeQuery"/>
<element name="queryQualifierValueSetTypeValueSet"
type="tns:QueryQualifierValueSetTypeValueSet"/>
</choice>
</complexType>

queryQualifierValueSetTypeQuery
See QueryQualifierValueSetTypeQuery.
queryQualifierValueSetTypeValueSet
See QueryQualifierValueSetTypeValueSet.
BMC Atrium Core 9.0
Page 1709 of 2268
Home
QueryQualifierValueSetTypeQuery
The QueryQualifierValueSetTypeQuery data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierValueSetTypeQuery">
<sequence>
<element name="query" type="tns:NestedQuery"/>
</sequence>
</complexType>

queryObjects
See NestedQuery.
QueryQualifierValueSetTypeValueSet
The QueryQualifierValueSetTypeValueSet data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierValueSetTypeValueSet">
<sequence>
<element name="valueSet" type="common:ValueList"/>
</sequence>
</complexType>

queryObjects
See ValueList.
QueryQualifierValueTypeArithExpr (atrium_graphquery)
The QueryQualifierValueTypeArithExpr data structure holds information about the graph query.
Namespace
Definition
<complexType name="QueryQualifierValueTypeArithExpr">
BMC Atrium Core 9.0
Page 1710 of 2268
Home
<sequence>
<element name="leftOperand" nillable="true"
type="tns:QueryArithOpType"/>
<element name="rightOperand" nillable="true"
</sequence>
</complexType>

leftOperand
See QueryQualifierValue (atrium_graphquery).
operation
See QueryArithOpType (atrium_graphquery).
rightOperand
See QueryQualifierValue (atrium_graphquery).
QueryQualifierValueTypeArithExpr (atrium_query)
The QueryQualifierValueTypeArithExpr data structure holds information about the query.
Namespace
Definition
<sequence>
<element name="leftOperand" type="tns:QueryQualifierValue"/>
<element name="operation" type="tns:QueryArithOpType"/>
<element name="rightOperand" type="tns:QueryQualifierValue"/>
</sequence>
</complexType>

leftOperand
operation
See QueryArithOpType (atrium_graphquery).
rightOperand
QueryQualifierValueTypeArithExpr (atrium_querybypath)
The QueryQualifierValueTypeArithExpr data structure holds information about the query.
Namespace
BMC Atrium Core 9.0
Page 1711 of 2268
Home
Definition
<sequence>
<element name="leftOperand" type="tns:QueryQualifierValue"/>
<element name="operation" type="tns:QueryArithOpType"/>
<element name="rightOperand" type="tns:QueryQualifierValue"/>
</sequence>
</complexType>

leftOperand
operation
See QueryArithOpType (atrium_querybypath).
rightOperand
QueryQualifierValueTypeAttributeName (atrium_graphquery)
The QueryQualifierValueTypeAttributeName data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierValueTypeAttributeName">
<sequence>
<element name="attributeName" nillable="true" type="string"/>
<element name="classAlias" nillable="true" type="string"/>
</sequence>
</complexType>

attributeName
classAlias
The unique alias for the class.
QueryQualifierValueTypeAttributeName (atrium_query)
Namespace
BMC Atrium Core 9.0
Page 1712 of 2268
Home
Definition
<sequence>
<element name="attributeName" type="string"/>
<element name="classAlias" type="string"/>
</sequence>
</complexType>

attributeName
classAlias
QueryQualifierValueTypeAttributeName (atrium_querybypath)
Namespace
Definition
<sequence>
<element name="classAlias" type="string"/>
</sequence>
</complexType>

attributeName
classAlias
QueryQualifierValueTypeValue
The QueryQualifierValueTypeValue data structure holds information about the query.
Namespace
Definition
<complexType name="QueryQualifierValueTypeValue">
<sequence>
BMC Atrium Core 9.0
Page 1713 of 2268
Home
</sequence>
</complexType>

value
See Value.
QueryRelationship
Namespace
Definition
<complexType name="QueryRelationship">
<complexContent>
<extension base="tns:GraphQueryObject">
<sequence>
<element name="sourceEndpoint" nillable="true"
type="tns:QueryRelEndpoint"/>
<element name="targetEndpoint" nillable="true"
type="tns:QueryRelEndpoint"/>
<element name="isImpact" nillable="true"
type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>

sourceEndpoint
See QueryRelEndpoint.
targetEndpoint
See QueryRelEndpoint.
isImpact
QueryRelationshipList
Namespace
Definition
<complexType name="QueryRelationshipList">
<sequence>
type="tns:QueryRelationship"/>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1714 of 2268
Home

list
List of QueryRelationship values.
QueryRelEndpoint
Namespace
Definition
<complexType name="QueryRelEndpoint">
<sequence>
<element name="id" type="string"/>
<element name="cardinality" nillable="true"
type="tns:QueryCardinality"/>
</sequence>
</complexType>

id
Unique identifier.
cardinality
See QueryCardinality.
QueryResultFormat
The QueryResultFormat data structure defines the structure for the query results.
Namespace
Definition
<simpleType name="QueryResultFormat">
<enumeration value="CHUNK_BASED" />
<enumeration value="GRAPH" />
<enumeration value="LIST" />
</restriction>
</simpleType>
The structure has the following values:

CHUNK_BASED--Results are in a graph format if the number of rows that matches the
criteria within the chunk size. The results are returned in a list format if the number of rows
that matches is greater than the chunk size
BMC Atrium Core 9.0
Page 1715 of 2268
Home
GRAPH--Results are in a graph format which is a list of nodes (CIs) and list of edges (
relationships).
LIST--Results are in a table format.
QueryResultGraph
The QueryResultGraph data structure defines the graph structure for the query results.
Namespace
Definition
<complexType name="QueryResultGraph">
<sequence>
<element name="formatType" type="tns:QueryResultFormat"/>
<element name="aliasOrderForListFormat"
type="common:StringArray"/>
<element name="numMatches" nillable="true" type="int"/>
<element name="graphQueryResult"
type="tns:GraphQueryResult"/>
</sequence>
</complexType>

formatType
See QueryResultFormat.
aliasOrderForListFormat
See StringArray.
numMatches
The number of query matches to return in the results.
graphQueryResult
See GraphQueryResult.
QueryResultGraph (atrium_graphquery)
The QueryResultGraph data structure holds information about the query.
Namespace
Definition
<sequence>
<element name="nodeListArray" type="tns:NodeListArray"/>
<element name="edgeListArray" type="tns:EdgeListArray"/>
</sequence>
</complexType>

BMC Atrium Core 9.0
Page 1716 of 2268
Home
nodeListArray
See NodeListArray.
edgeListArray
See EdgeListArray.
QueryResultGraph (atrium_query)
Namespace
Definition
<sequence>
type="common:InstanceInfoOutList"/>
</sequence>
</complexType>

list
List of DeleteInstanceInfoInList values.
QueryResultGraph (atrium_querybypath)
Namespace
Definition
<sequence>
</sequence>
</complexType>

nodeListArray
List of nodes (CIs).
edgeListArray
List of edges (Relationships).
QueryResultList
BMC Atrium Core 9.0
Page 1717 of 2268
Home
Namespace
Definition
<complexType name="QueryResultList">
<sequence>
</sequence>
</complexType>

list
QuerySort
Namespace
Definition
<complexType name="QuerySort">
<sequence>
<element name="alias" nillable="true" type="string"/>
<element name="attributeName" nillable="true" type="string"/>
<element name="sortOrder" nillable="true" type="int"/>
</sequence>
</complexType>

alias
attributeName
The name of the class attribute.
sortOrder
QuerySortArray
Namespace
Definition
<complexType name="QuerySortArray">
<sequence>
BMC Atrium Core 9.0
Page 1718 of 2268
Home

nillable="true" type="tns:QuerySort"/>
</sequence>
</complexType>

list
List of QuerySort values.
QuerySortOrder
Namespace
Definition
<simpleType name="QuerySortOrder">
<enumeration value="SORT_ASCENDING"/>
<enumeration value="SORT_DESCENDING"/>
</restriction>
</simpleType>

SORT_ASCENDING
SORT_DESCENDING
Query structure
The Query data structure holds information about the query.
Namespace
Definition
<complexType name="Query">
<choice>
<element name="queryChoice1" type="tns:QueryInput"/>
<element name="queryChoice2" type="tns:QueryInput2"/>
</choice>
</complexType>

queryChoice1
See SavedQueryInfo.
BMC Atrium Core 9.0
Page 1719 of 2268
Home
See QueryInput2.
queryChoice2
RealLimit
The RealLimit data structure defines real data type limits.
Namespace
Definition
<complexType name="RealLimit">
<sequence>
<element name="highRange" type="double" />
<element name="lowRange" type="double" />
</sequence>
</complexType>

highRange
The high range of the custom characteristic for the real data type.
lowRange
The low range of the custom characteristic for the real data type.
precision
The number of integers allowed for the real data type.
REJobRun
The REJobRun data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="REJobRun">
<sequence>
<element name="activityName" type="string" />
<element name="assignedTo" type="string" />
<element name="createdBy" type="string" />
<element name="entryId" type="string" />
<element name="jobInstanceId" type="string" />
<element name="jobRunStatus" type="tns:JobRunStatusType" />
<element name="jobStartType" type="string" />
<element name="lastClassName" type="string" />
<element name="runAlertLevel" type="int" />
<element name="runEndTime" type="dateTime"
nillable="true" />
<element name="runStartTime" type="dateTime"
BMC Atrium Core 9.0
Page 1720 of 2268
Home
nillable="true" />
<element name="runStatus" type="int" />
<element name="shortDescription" type="string" />
</sequence>
</complexType>

activityName
Name of the activity.
assignedTo
Indicates who the job run is assigned to.
createdBy
Indicates who created the job run.
entryId
Unique identifier for the entry.
instanceId
jobInstanceId
Unique identifier for the instance of the job.
jobRunStatus
See JobRunStatusType.
jobStartType
String value indicating the how the job is started.
lastClassName
String value indicating the name of the last class.
runAlertLevel
Integer value indicating an alert level associated the job.
runEndTime
runStartTime
runStatus
Integer value indicating the job run status.
shortDescription
Description of the job.
REJobRunEvent
The QueryDateSpan data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="REJobRunEvent">
<sequence>
<element name="activityName" type="string" />
<element name="activityStatus" type="int" />
<element name="assignedTo" type="string" />
<element name="createdDate" type="dateTime"
nillable="true" />
<element name="entryId" type="string" />
<element name="eventDescription" type="string" />
<element name="eventName" type="string" />
<element name="eventType" type="string" />
BMC Atrium Core 9.0
Page 1721 of 2268
Home
<element name="failedCIs" type="int" />

<element name="jobRunInstanceId" type="string" />
<element name="lastModifiedBy" type="string" />
<element name="lastModifiedDate" type="dateTime"
nillable="true" />
<element name="lastUpdatedTime" type="time" />
<element name="pendingId" type="string" />
<element name="processedCIs" type="int" />
<element name="shortDescription" type="string" />
<element name="totalCIs" type="int" />
</sequence>
</complexType>

activityName
Name of the activity.
activityStatus
Integer value indicating the status of the activity.
assignedTo
Indicates who the event is assigned to.
createdBy
Indicates who created the event.
createdDate
entryId
Unique identifier for the entry.
eventDescription
Description of the event.
eventName
Name of the event.
eventType
Indicates the event type.
failedCIs
Integer value indicating how many CIs experienced failures during the event.
instanceId
jobInstanceId
Unique identifier for the instance of the job.
jobRunInstanceId
Unique identifier for the instance of the job run.
lastModifiedBy
Indicates who made the last change to the event.
lastModifiedDate
lastUpdatedTime
pendingId
Unique identifier for the pending event.
processedCIs
Integer value indicating the number of CIs that have been processed.
shortDescription
Short description identifying the event.
totalCIs
Integer value indicating the total number of CIs to be processed by the event.
REJobRunEventList
The REJobRunEventList data structure holds information about the Reconciliation Engine job.
BMC Atrium Core 9.0
Page 1722 of 2268
Home
Namespace
Definition
<complexType name="REJobRunEventList">
<sequence>
<element name="list" type="tns:REJobRunEvent"
</sequence>
</complexType>

list
List of REJobRunEvent values.
REJobRunInfo
The REJobRunInfo data structure holds information about a currently running Reconciliation Engine
job.
Namespace
Definition
<complexType name="REJobRunInfo">
<sequence>
<element name="jobStartTime" type="dateTime" />
<element name="jobEndTime" type="dateTime" />
<element name="jobName" type="string" />
<element name="jobLog" type="string" />
<element name="jobRunStatus" type="tns:REJobRunStatusType" />
</sequence>
</complexType>

jobRunId
jobStartTime
The start time of the job. Standard XML dateTime format.
jobEndTime
The end time of the job. Standard XML dateTime format.
jobInstanceId
The instance ID of the Reconciliation Engine job.
jobName
Name of the job.
jobLog
The log for the currently running job.
BMC Atrium Core 9.0
Page 1723 of 2268
Home
jobRunStatus
See REJobRunStatusType.
REJobRunInfoList
The REJobRunInfoList data structure holds a list of Reconciliation Engine jobs that are currently
running.
Namespace
Definition
<complexType name="REJobRunInfoList">
<sequence>
<element name="list" type="tns:REJobRunInfo"
</sequence>
</complexType>

list
List of REJobRunInfo values.
REJobRunList
The REJobRunList data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType name="REJobRunList">
<sequence>
<element name="list" type="tns:REJobRun"
</sequence>
</complexType>

list
List of REJobRun values.
REJobRunStatusType
The REJobRunStatusType data structure defines valid job run statuses.
Namespace
BMC Atrium Core 9.0
Page 1724 of 2268
Home
Definition
<simpleType name="REJobRunStatusType">
<enumeration value="FAILED" />
<enumeration value="PAUSED" />
<enumeration value="QUEUED" />
<enumeration value="SUCCESS" />
</restriction>
</simpleType>
ABORTED
CANCELED
FAILED
PAUSED
QUEUED
STARTED
SUCCESS
UNKNOWN
RelationshipDirection
The RelationshipDirection data structure defines the direction of the relationship between objects.
Namespace
Definition
<simpleType name="RelationshipDirection">
<enumeration value="OUT" />
</restriction>
</simpleType>
IN
OUT
RelationshipResult
Namespace
BMC Atrium Core 9.0
Page 1725 of 2268
Home
Definition
<complexType name="RelationshipResult">
<complexContent>
<extension base="common:InstanceInfoOut">
<sequence>
<element name="srcInstanceId" type="string" />
<element name="targetInstanceId" type="string" />
</sequence>
</extension>
</complexContent>
</complexType>

srcInstanceId
Identifer for source instance in a relationship.
targetInstanceId
Identifer for target instance in a relationship.
RelationshipResultArray
Namespace
Definition
<complexType name="RelationshipResultArray">
<sequence>
type="tns:RelationshipResult" />
</sequence>
</complexType>

list
List of RelationshipResult values.
RelationType
The RelationType data structure specifies the relationship type.
Namespace
Definition
<simpleType name="RelationType">
BMC Atrium Core 9.0
Page 1726 of 2268
Home

<enumeration value="QUERY" />
</restriction>
</simpleType>
REGULAR
QUERY
RenewGraphWalkOutput
The RenewGraphWalkOutput data structure holds information about the graph walk.
Namespace
Definition
<element name="RenewGraphWalkOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

expiration
See ExpirationOut.
hasNext
status
See StatusList.
extensions
See ExtensionList.
RenewGraphWalk structure
The RenewGraphWalk data structure holds information about the graph walk.
Namespace
Definition
<element name="RenewGraphWalk">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1727 of 2268
Home

nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
contextId
expiration
See ExpirationOut.
extensions
See ExtensionList.
ResumeNEJobRunOutput
The ResumeNEJobRunOutput data structure restarts output from the job.
Namespace
Definition
<element name="ResumeNEJobRunOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

jobRunId
status
See StatusList.
extensions
See ExtensionList.
ResumeNEJobRun structure
The ResumeNEJobRun data structure restarts a job.
BMC Atrium Core 9.0
Page 1728 of 2268
Home
Namespace
Definition
<element name="ResumeNEJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
loginInfo
See LoginInfo.
jobName
extensions
See ExtensionList.
ResumeREJobRun structure
The ResumeREJobRun data structure restarts the Reconciliation Engine job.
Namespace
Definition
<element name="ResumeREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobRunId
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1729 of 2268
Home
SavedGraphQuery
Namespace
Definition
<complexType name="SavedGraphQuery">
<complexContent>
<extension base="tns:SavedQueryRef">
<sequence>
<element name="graphQuery" nillable="true"
type="tns:GraphQueryInput" />
type="classes:PropertyList" />
<element name="rowLevelSecurity" nillable="true"
type="string" />
<element name="writeSecurity" nillable="true"
type="string" />
</sequence>
</extension>
</complexContent>
</complexType>

graphQuery
See GraphQueryInput.
characteristics
See PropertyList.
rowLevelSecurity
writeSecurity
SavedQueryData
The SavedQueryData data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryData">
<complexContent>
<extension base="tns:SavedQueryInfo">
<sequence>
<element name="createDate" type="dateTime" />
<element name="queryByPathXMLText" type="string" />
<element name="queryByPathObject"
type="tns:QueryByPathInput" />
BMC Atrium Core 9.0
Page 1730 of 2268
Home
</sequence>
</extension>
</complexContent>
</complexType>

createdBy
Indicates who created the query.
createDate
queryByPathXMLText
The XML text representing the query that has been saved to the database.
queryByPathObject
SavedQueryData (atrium_querybypath)
The SavedQueryData data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryData">
<complexContent>
<extension base="tns:SavedQueryInfo">
<sequence>
<element name="queryByPathObject" type="tns:Query"/>
</sequence>
</extension>
</complexContent>
</complexType>

queryByPathObject
See Query.
SavedQueryInfo
The SavedQueryInfo data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryInfo">
<sequence>
BMC Atrium Core 9.0
Page 1731 of 2268
Home
</sequence>
</complexType>

description
Description of the query you want to save.
instanceId
Unique identifier for the query instance.
SavedQueryInfo (atrium_querybypath)
The SavedQueryInfo data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryInfo">
<sequence>
<element name="queryName" type="string" nillable="true" />
<element name="categoryName" type="string" nillable="true" />
</sequence>
</complexType>

queryName
Name of the saved query.
description
Description of the query you want to save.
categoryName
Category name for the query instance.
SavedQueryInfoList
The SavedQueryInfoList data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryInfoList">
<sequence>
<element name="list"
type="tns:SavedQueryInfo"

</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1732 of 2268
Home

list
List of SavedQueryInfo values.
SavedQueryInfoList (atrium_querybypath)
The SavedQueryInfoList data structure holds information about the query.
Namespace
Definition
<complexType name="SavedQueryInfoList">
<sequence>
<element name="list" type="tns:SavedQueryInfo"
</sequence>
</complexType>

list
List of SavedQueryInfo values.
SavedQueryParameter
Namespace
Definition
<complexType name="SavedQueryParameter">
<sequence>
<element name="id" nillable="true" type="string"/>
<element name="parameterType" nillable="true"
type="tns:SavedQueryParameterType"/>
<element name="queryOption" nillable="true"
type="tns:SavedQueryParameterOption"/>
</sequence>
</complexType>

id
Unique identifier.
parameterType
See SavedQueryParameterType.
queryOption
See SavedQueryParameterOption.
BMC Atrium Core 9.0
Page 1733 of 2268
Home
SavedQueryParameterOption
Namespace
Definition
<simpleType name="SavedQueryParameterOption">
<enumeration value="ERROR_IF_NO_RUNTIME_VALUE"/>
<enumeration value="IGNORE_QUAL_IF_NO_RUNTIME_VALUE"/>
<enumeration
value="USE_VALUE_AS_IN_QUERY_IF_NO_RUNTIME_VALUE"/>
</restriction>
</simpleType>
ERROR_IF_NO_RUNTIME_VALUE--.
IGNORE_QUAL_IF_NO_RUNTIME_VALUE--.
USE_VALUE_AS_IN_QUERY_IF_NO_RUNTIME_VALUE--.
SavedQueryParameterType
Namespace
Definition
<simpleType name="SavedQueryParameterType">
<enumeration value="OPERATOR"/>
<enumeration value="RIGHT_OPERAND"/>
<enumeration value="BOTH"/>
</restriction>
</simpleType>
OPERATOR--.
RIGHT_OPERAND--.
BOTH--.
SavedQueryParameterValue
Namespace
Definition
<complexType name="SavedQueryParameterValue">
BMC Atrium Core 9.0
Page 1734 of 2268
Home
<sequence>
<element name="operator"
type="query:QueryQualifierOperation" />
<element name="rightOperandValue" nillable="true"
type="common:Value"/>
</sequence>
</complexType>

id
operator
rightOperandValue
See Value.
SavedQueryParameterValueList
Namespace
Definition
<complexType name="SavedQueryParameterValueList">
<sequence>
type="tns:SavedQueryParameterValue"/>
</sequence>
</complexType>

list
List of SavedQueryParameterValue values.
SavedQueryQualifierSimpleOp
Namespace
Definition
<complexType name="SavedQueryQualifierSimpleOp">
<complexContent>
<extension base="tns:QueryQualifierSimpleOp">
<sequence>
<element name="savedQueryParameter" nillable="true"
type="tns:SavedQueryParameter"/>
</sequence>
</extension>
BMC Atrium Core 9.0
Page 1735 of 2268
Home
</complexContent>
</complexType>

savedQueryParameter
See SavedQueryParameter
SavedQueryRef
The SavedQueryRef data structure holds information about the saved query.
Namespace
Definition
<complexType name="SavedQueryRef">
<sequence>
<element name="queryName" nillable="true" type="string"/>
<element name="description" nillable="true" type="string"/>
<element name="categoryName" nillable="true" type="string"/>
</sequence>
</complexType>

queryName
Unique identifer of query.
description
Query description.
categoryName
Category of saved query.
SavedQueryRefList
Namespace
Definition
<complexType name="SavedQueryRefList">
<sequence>
type="tns:SavedQueryRef"/>
</sequence>
</complexType>

list
List of SavedQueryRef values.
BMC Atrium Core 9.0
Page 1736 of 2268
Home
SchemaRelationshipDescription
Namespace
Definition
<complexType name="SchemaRelationshipDescription">
<sequence>
<element name="SourceSchema"
<element name="DestinationSchema"
</sequence>
</complexType>

SourceSchema
See See ClassSchemaReference.
DestinationSchema
See See ClassSchemaReference.
SchemaType structure
The SchemaType data structure specifies which CMDB Federated class schema type should be
used. In a Federated Class, the schema is the one that originated the class. It can be created from
within the CMDB or created from a vendor form.
Namespace
Definition
<simpleType name="SchemaType">
<enumeration value="VENDOR_FORM" />
</restriction>
</simpleType>
REGULAR--Specifies that the schema type characteristic is default and not federation.
VENDOR_FORM--Specifies that the schema type characteristic is an AR System vendor
form.
SetAttribute structure
The SetAttribute data structure creates new attributes or sets attribute information.
BMC Atrium Core 9.0
Page 1737 of 2268
Home
Namespace
Definition
<element name="SetAttribute">
<complexType>
<sequence>
nillable="true" />
<element name="newAttributeName" type="string"
nillable="true" />
type="tns:AttributeInfoIn" nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
attributeName
newAttributeName
Name for the new attribute.
attributeInfo
extensions
See ExtensionList.
SetBusinessObjectOutput
The SetBusinessObjectOutput data structure retrieves several business objects.
Namespace
Definition
<element name="SetBusinessObjectOutput">
<complexType>
<sequence>
<element name="businessObject" type="tns:BusinessObject"
nillable="true" />
nillable="true" />
BMC Atrium Core 9.0
Page 1738 of 2268
Home
</sequence>
</complexType>
</element>

businessObject
See BusinessObject.
status
See StatusList.
extensions
See ExtensionList.
SetBusinessObject structure
The SetBusinessObject data structure retrieves several business objects.
Namespace
Definition
<element name="SetBusinessObject">
<complexType>
<sequence>
nillable="true" />
<element name="createRelatedBO" type="boolean"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObject
See BusinessObject.
createRelatedBO
Valid values are "true" or "1" for true values, and "false" or "0" for false values. Set to 'true' to create a new
business object based on the selected business object.
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1739 of 2268
Home
SetClass structure
The SetClass data structure sets a class value.
Namespace
Definition
<element name="SetClass">
<complexType>
<sequence>
nillable="true" />
<element name="newClassNameId" type="common:ClassNameId"
nillable="true" />
<element name="classInfo" type="tns:ClassInfoIn"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
classNameId
See ClassNameId.
newClassNameId
See ClassNameId.
classInfo
See ClassInfoIn.
extensions
See ExtensionList.
SetDataset structure
The SetDataset data structure holds information about the dataset.
Namespace
Definition
<element name="SetDataset">
<complexType>
<sequence>
nillable="true" />
<element name="datasetName" type="string"
BMC Atrium Core 9.0
Page 1740 of 2268
Home
nillable="true" />
nillable="true" />
<element name="datasetType" type="common:DatasetType"
nillable="true" />
<element name="accessibility" type="tns:DatasetAccessType"
nillable="true" />
<element name="clientTypeList" type="common:StringArray"
nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
coreDatasetId
datasetName
Name of the dataset.
description
Description of the dataset.
datasetType
See DatasetType.
accessibility
See DatasetAccessType (datasets).
clientTypeList
See StringArray.
sourceDatasetId
Unique identifier of the source dataset.
extensions
See ExtensionList.
SetInstanceInfoIn
The SetInstanceInfoIn data structure holds information about the instances you want to set.
Namespace
Definition
<complexType name="SetInstanceInfoIn">
<complexContent>
<extension base="tns:CreateInstanceInfoIn">
<sequence>
</sequence>
</extension>
</complexContent>
</complexType>
BMC Atrium Core 9.0
Page 1741 of 2268
Home

instanceId
The SetInstanceInfoInList data structure holds information about the instances you want to set.
Namespace
Definition
<complexType name="SetInstanceInfoInList">
<sequence>
<element name="list" type="tns:SetInstanceInfoIn"
</sequence>
</complexType>

list
List of SetInstanceInfoInList values.
SetInstance structure
The SetInstance data structure holds information about the instance.
Namespace
Definition
<element name="SetInstance">
<complexType>
<sequence>
nillable="true" />
type="tns:SetInstanceInfoIn" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1742 of 2268
Home
loginInfo
See LoginInfo.
datasetId
instanceInfo
extensions
See ExtensionList.
SetMultipleBusinessObjectsOutput
The SetMultipleBusinessObjectsOutput data structure retrieves several business objects.
Namespace
Definition
<element name="SetMultipleBusinessObjectsOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

businessObjectList
status
See StatusList.
extensions
See ExtensionList.
SetMultipleBusinessObjects structure
The SetMultipleBusinessObjects data structure retrieves several business objects.
Namespace
Definition
<element name="SetMultipleBusinessObjects">
<complexType>
<sequence>
nillable="true" />
BMC Atrium Core 9.0
Page 1743 of 2268
Home

nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
datasetType
See DatasetType.
businessObjectList
createRelatedBO
extensions
See ExtensionList.
SetMultipleInstances structure
The SetMultipleInstances data structure holds information about the instances.
Namespace
Definition
<element name="SetMultipleInstances">
<complexType>
<sequence>
nillable="true" />
type="tns:SetInstanceInfoInList" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
datasetId
BMC Atrium Core 9.0
Page 1744 of 2268
Home
instanceInfo
See SetInstanceInfoInList.
extensions
See ExtensionList.
SetPropertiesOutput
The SetPropertiesOutput data structure holds information about the configuration property.
Namespace
Definition
<element name="SetPropertiesOutput">
<complexType>
<sequence>
<element name="createdProperties"
<element name="modifiedProperties"
<element name="duplicateProperties"
<element name="invalidProperties"
</sequence>
</complexType>
</element>

createdProperties
modifiedProperties
duplicateProperties
invalidProperties
SetProperties structure
The SetProperties data structure holds information about the configuration property.
Namespace
Definition
<element name="SetProperties">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1745 of 2268
Home
</sequence>
</complexType>
</element>

properties
SimpleExtensionType
The SimpleExtensionType data structure is a name-value pair used to define the extension type.
Namespace
Definition
<complexType name="SimpleExtensionType">
<sequence>
<element name="value" type="anySimpleType" />
</sequence>
</complexType>

name
.Name of the extension.
value
Can be anySimpleType as defined for standard published XML schemas.
SortOrderList
The SortOrderList data structure holds attribute sorting information.
Namespace
Definition
<complexType name="SortOrderList">
<sequence>
<element name="list" type="tns:SortOrder"
</sequence>
</complexType>

list
List of SortOrder values.
BMC Atrium Core 9.0
Page 1746 of 2268
Home
SortOrder structure
The SortOrder data structure holds attribute sorting information.
Namespace
Definition
<complexType name="SortOrder">
<sequence>
<element name="sortOrder" type="tns:SortOrderType" />
</sequence>
</complexType>

attributeName
sortOrder
See SortOrderType.
SortOrderType
The SortOrderType data structure defines sort order types.
Namespace
Definition
<simpleType name="SortOrderType">
<enumeration value="ASCENDING" />
<enumeration value="DESCENDING" />
</restriction>
</simpleType>
ASCENDING
DESCENDING
StartNEJobRunOutput
The StartNEJobRunOutput data structure holds job information.
Namespace
BMC Atrium Core 9.0
Page 1747 of 2268
Home
Definition
<element name="StartNEJobRunOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

jobRunId
status
See StatusList.
extensions
See ExtensionList.
StartNEJobRun structure
The StartNEJobRun data structure launches the normalization engine job.
Namespace
Definition
<element name="StartNEJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobName
isFullRun
BMC Atrium Core 9.0
Page 1748 of 2268
Home
See ExtensionList.
extensions
StartREJobRun (classic reconciliation)

The StartREJobRun data structure launches reconciliation engine jobs.
Namespace
Definition
<element name="StartREJobRun">
<complexType>
<sequence>
nillable="true" />
<element name="qualifierList"
type="tns:ClassQualifierList" />
<element name="datasetList" type="tns:DatasetPairList" />
nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobName
Name of the job.
qualifierList
See ClassQualifierList (classic reconciliation).
datasetList
See DatasetPairList (classic reconciliation).
extensions
See ExtensionList.
StartREJobRun (reconciliation)
The StartREJobRun data structure holds information about the Reconciliation Engine job.
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
BMC Atrium Core 9.0
Page 1749 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
jobName
Name of the job.
qualifierList
See ClassQualifierList (reconciliation).
datasetList
See DatasetPairList.
extensions
See ExtensionList.
StartREJobRunOutput (classic reconciliation)

The StartREJobRunOutput data structure stores information from reconciliation engine jobs.
Namespace
Definition
<element name="StartREJobRunOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

jobRunId
status
See StatusList.
extensions
See ExtensionList.
StartREJobRunOutput (reconciliation)
The StartREJobRunOutput data structure holds information about the Reconciliation Engine job.
BMC Atrium Core 9.0
Page 1750 of 2268
Home
Namespace
Definition
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

jobRunId
status
See StatusList.
extensions
See ExtensionList.
StatusList structure
The StatusList data structure holds a list of status messages. A list of zero or more notes,
warnings, or errors generated from a call of this operation.
Namespace
Definition
<complexType name="StatusList">
<sequence>
<element name="list" type="tns:Status"
</sequence>
</complexType>

list
An array of elements of the same type.
StatusOutput structure
The StatusOutput data structure holds the status information.
BMC Atrium Core 9.0
Page 1751 of 2268
Home
Namespace
Definition
<element name="StatusOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>

status
See StatusList.
extensions
See ExtensionList.
Status structure
The Status data structure holds the status information.
Namespace
Definition
<complexType name="Status">
<sequence>
<element name="statusType" type="tns:StatusType" />
<element name="messageNum" type="long" />
<element name="messageText" type="string" />
<element name="appendedText" type="string" />
</sequence>
</complexType>

statusType
See Status.
messageNum
Number associated with the status message.
messageText
The text of the message.
appendedText
Text that you want added to the status message.
BMC Atrium Core 9.0
Page 1752 of 2268
Home
StatusType
The StatusType data structure defines the valid values for the status type definition.
Namespace
Definition
<simpleType name="StatusType">
<enumeration value="OK" />
<enumeration value="WARNING" />
<enumeration value="ERROR" />
<enumeration value="FATAL" />
<enumeration value="BAD_STATUS" />
<enumeration value="PROMPT" />
<enumeration value="ACCESSIBLE" />
</restriction>
</simpleType>
OK
WARNING
ERROR
FATAL
BAD_STATUS
PROMPT
ACCESSIBLE
StringArray structure
The StringArray data structure is a variable array containing string data.
Namespace
Definition
<complexType name="StringArray">
<sequence>
<element name="list" type="string" minOccurs="0"
</sequence>
</complexType>

list
BMC Atrium Core 9.0
Page 1753 of 2268
Home
TimeLimit
The TimeLimit data structure defines a period of time within which an action or procedure must be
done or completed.
Namespace
Definition
<complexType name="TimeLimit">
<sequence/>
</complexType>
TimeOfDayLimit
The TimeLimit data structure defines a period of time for a specified day within which an action or
procedure should be done or completed.
Namespace
Definition
<complexType name="TimeOfDayLimit">
<sequence/>
</complexType>
UIComponentInfo
The UIComponentInfo data structure holds information about the UI component.
Namespace
Definition
<complexType name="UIComponentInfo">
<sequence>
<element name="componentType" type="tns:ComponentType" />
<element name="encodedQual" type="string" />
<element name="locale" type="string" />
<element name="tag1" type="string" />
</sequence>
BMC Atrium Core 9.0
Page 1754 of 2268
Home
</complexType>

classId
An integer value indicating the class ID for the UI component.
componentType
See ComponentType.
encodedQual
The encoded qualifier for the UI component query.
locale
The name of the locale specific to the component. If no locale is specified in this subclasses, the default locale
will be used.
tag1
Information tag used to filter a specific component type.
tag2
tag3
tag4
tag5
UIComponentResult
The UIComponentResult data structure holds information about the UI component.
Namespace
Definition
<complexType name="UIComponentResult">
<sequence>
<element name="attachVal" type="common:Attachment" />
<element name="componentInfo" type="tns:UIComponentInfo" />
<element name="dataString" type="string" />
</sequence>
</complexType>

attachVal
See Status.
componentInfo
dataString
Data returned about the UI component.
instanceId
BMC Atrium Core 9.0
Page 1755 of 2268
Home
UIComponentResultList
The UIComponentResultList data structure lists the data retrieved and stored in
UIComponentResult.
Namespace
Definition
<complexType name="UIComponentResultList">
<sequence>
<element name="list" type="tns:UIComponentResult"
</sequence>
</complexType>

list
List of UIComponentResult values.
UpdateSavedQuery structure
Namespace
*
http://atrium.bmc.com/2010/07/graphquery/types\*
Definition
<element name="UpdateSavedQuery">
<complexType>
<sequence>
</sequence>
</complexType>
</element>

loginInfo
See LoginInfo.
savedQuery
extensions
See ExtensionList.
BMC Atrium Core 9.0
Page 1756 of 2268
Home
ValueList structure
The ValueList data structure holds a list of values.
Namespace
Definition
<complexType name="ValueList">
<sequence>
<element name="list" type="tns:Value"
</sequence>
</complexType>

list
List of values.
Value structure
The Value data structure holds value definitions.
Namespace
Definition
<complexType name="Value">
<choice>
<element name="nullValue" type="tns:NullType" />
<element name="intValue" type="int" />
<element name="keywordValue" type="tns:Keyword" />
<element name="bitMaskValue" type="long" />
<element name="ulongValue" type="long" />
<element name="doubleValue" type="double" />
<element name="diaryValue" type="tns:DiaryValue" />
<element name="enumValue" type="int" />
<element name="byteListValue" type="tns:ByteList" />
<element name="decimalValue" type="decimal" />
<element name="attachValue" type="tns:Attachment" />
<element name="coordListValue" type="tns:CoordinateList" />
<element name="currencyValue" type="tns:Currency" />
<element name="dateValue" type="date" />
<element name="timeOfDayValue" type="time" />
<element name="timeValue" type="dateTime" />
</choice>
</complexType>
BMC Atrium Core 9.0
Page 1757 of 2268
Home

nullValue
See NullType.
intValue
keywordValue
See Keyword.
bitMaskValue
Standard XML long format.
ulongValue
Standard XML long format.
doubleValue
Standard XML double format.
stringValue
Standard XML string format.
diaryValue
See DiaryValue.
enumValue
byteListValue
See ByteList.
decimalValue
Standard XML decimal format.
attachValue
See Attachment.
coordListValue
See CoordinateList.
currencyValue
See Currency.
dateValue
Standard XML date format.
timeOfDayValue
timeValue
VersionInfo
The VersionInfo data structure holds information about the version.
Namespace
Definition
<complexType name="VersionInfo">
<sequence>
<element name="applicationId" type="string" />
<element name="applicationName" type="string" />
<element name="maintenanceVer" type="int" />
<element name="majorVer" type="int" />
<element name="minorVer" type="int" />
<element name="patchNum" type="int" />
<element name="isExist" type="boolean" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1758 of 2268
Home
applicationId
Unique identifier for the application.
applicationName
Name associated with the application.
maintenanceVer
An integer value indicating the maintenance version of the application.
majorVer
An integer value indicating the primary version number.
minorVer
An integer value indicating the secondary version number. For example, for 'Application 7.5', 5 would be the
minor version number.
patchNum
An integer value indicating the patch level for the application.
isExist
VersionInfoList
The VersionInfoList data structure holds information about application versions.
Namespace
Definition
<complexType name="VersionInfoList">
<sequence>
<element name="list" type="tns:VersionInfo"
</sequence>
</complexType>

list
List of VersionInfo values.
WeakPropagatedAttrs
The WeakPropagatedAttrs data structure holds attribute information.
Namespace
Definition
<complexType name="WeakPropagatedAttrs">
<sequence>
<element name="sourceAttributeName" type="string" />
<element name="targetAttributeName" type="string" />
</sequence>
</complexType>

BMC Atrium Core 9.0
Page 1759 of 2268
Home
sourceAttributeName
The attribute name of the source attribute. The names of all attributes must be unique within the
specified class and within its superclasses and subclasses.
targetAttributeName
The attribute name of the target attribute. The names of all attributes must be unique within the specified
class and within its superclasses and subclasses.
WeakPropagatedAttrsList
The WeakPropagatedAttrsList data structure holds attribute information.
Namespace
Definition
<complexType name="WeakPropagatedAttrsList">
<sequence>
<element name="list" type="tns:WeakPropagatedAttrs"
</sequence>
</complexType>

list
List of WeakPropagatedAttrs values.
WSPolicyMap
Namespace
Definition
<complexType name="WSPolicyMap">
<sequence>
type="tns:WSPolicyMapEntry" />
</sequence>
</complexType>

list
List of WSPolicyMapEntry values.
WSPolicyMapEntry
Namespace
BMC Atrium Core 9.0
Page 1760 of 2268
Home
Definition
<complexType name="WSPolicyMapEntry">
<sequence>
<element name="URL" type="anyURI" nillable="true" />
</sequence>
</complexType>

name
URL
XmlSchemaConstraintType
Namespace
Definition
<simpleType name="XmlSchemaConstraintType">
<enumeration value="SEQUENCE" />
</restriction>
</simpleType>
ALL--List 0-1 or 1-1 globally, allowing for any order.

SEQUENCE--List items in the defined order, 0 to unlimited.

This section provides reference information for BMC Atrium Core Web Services API operations.
The BMC Atrium Core Web Services operations are categorized by the type of functions they
perform, as listed in the following table.

Function type
Function list
Audit operations
The audit operations enable you to retrieve information about changes to relationship
and CI classes in BMC Atrium CMDB.
BMC Atrium Core 9.0
GetAuditData
GetCopyAuditData (
atrium_instances)
Page 1761 of 2268
Home
Function type
Function list
GetLogAuditData
Business object operations

CreateBusinessObject
Business Objects are an abstraction of a business entity (such as a service offering,
contract, or organization) that models service-model information in a familiar way. A
CreateMultipleBusinessObjects
DeleteBusinessObject
business object corresponds to BMC Atrium CMDB Common Data Model (CDM)
classes. Because one business object can encapsulate multiple CDM classes and
DeleteMultipleBusinessObjects
GetBusinessObject
relationships, business objects hide the complexity of the relationships between related
CDM classes.
GetMultipleBusinessObjects
QueryBusinessObjects
QueryBusinessObjectRefs
SetBusinessObject
SetMultipleBusinessObjects
Business object operations (Deprecated)
Note
These operations are deprecated but still supported. For the new business
objection operations, see "Business object operations".
Business Objects are an abstraction of a business entity (such as a service offering,

contract, or organization) that models service-model information in a familiar way. A
business object corresponds to BMC Atrium CMDB Common Data Model (CDM)
classes. Because one business object can encapsulate multiple CDM classes and
relationships, business objects hide the complexity of the relationships between related
CDM classes.
CreateBusinessObject (
deprecated)
CreateMultipleBusinessObjects (
deprecated)
DeleteBusinessObject (
deprecated)
DeleteMultipleBusinessObjects (
deprecated)
GetBusinessObjects (
deprecated)
GetMultipleBusinessObjects (
deprecated)
QueryBusinessObject (
deprecated)
QueryBusinessObjectRefs (
deprecated)
SetBusinessObject (deprecated)
SetMultipleBusinessObjects (
deprecated)
Class operations
The class operations enable you to work with relationship and CI classes in BMC Atrium
CMDB.
CreateAttribute
CreateClass
DeleteAttribute
DeleteClass
GetAttributes
GetClass
ListClasses
SetAttribute
SetClass
Classic federation operations

Classic federation operations see the operations as defined in the
ActivateFederatedInContext
GetRelatedFederatedInContext
atrium_classicfederation_200901.wsdl file and are used to link external data stores to

your BMC Atrium CMDB.
CancelREJobRun
GetREJobRun
BMC Atrium Core 9.0
Page 1762 of 2268
Home
Function type
Function list
Classic reconciliation operations
GetREJobRunEvent
GetREJobRunEventList
Classic reconciliation operations see the operations as defined in the

atrium_classicreconcilliation_200901.wsdl file and help you perform tasks associated
with reconciliation of your BMC Atrium CMDB.
GetREJobRunList
PauseREJobRun
ResumeREJobRun
StartREJobRun
CMDBf configuration operations

CreateInstance
The CMDBf configuration operations enable you to set up a federated CMDB for
queries.
GetCMDBfConfiguration
LoadDefaultCMDBfConfiguration
Dataset operations
The dataset operations enable you to work with the datasets in BMC Atrium CMDB.
CreateDataset
DeleteDataset
GetDataset
ListDatasets
SetDataset
Graph walk operations

Use a graph walk to retrieve CI and relationship instances when you do not know the
exact relationship path to follow, for example, to view all of the dependencies for an
instance of a computer system. To successfully retrieve instances using a graph walk,
you need to first specify the start node using BeginGraphWalk, and then loop until you
BeginGraphWalk
EndGraphWalk
GetGraphWalkStatus
PullGraphWalkResults
RenewGraphWalk
retrieve all of the rows that match the query. Chunking occurs when the maxRetrieve
parameter has a value greater than 0. Otherwise, the query returns all the nodes in the
first call. For example, if the query retrieves 500 rows of data and the maxRetrieve
parameter is set to 100, the operation will return 100 nodes in the first call, then 100
nodes in the next call, and so on until all data has been returned.
Instance data operations
The instance data operations act on CI or relationship class instances.
CreateInstance
CreateMultipleInstances
DeleteInstance
DeleteMultipleInstances
GetInstances
GetUIComponents
SetInstance
SetMultipleInstances
Normalization operations
Use normalization operations to help with the normalization of your data to minimize
duplication of information and to help reduce data anomalies.
CancelNEJobRun
ExportNEConfiguration
GetLastNEJobRunStatus
GetNEJobRunStatus
GetNormalizedInfoList
GetNormalizedInfoListByFPKey
GetNormalizedInfoListByName
GetNormalizedInfoListByPCKey
ImportNEConfiguration
NormalizeInstanceList
ResumeNEJobRun
StartNEJobRun
BMC Atrium Core 9.0
Page 1763 of 2268
Home
Function type
Function list
Query by Path operations

The query operations allow you to build a list of query objects with qualifications.
Queries of BMC Atrium CMDB classes can range from simple to complex, and is related
to how the data is represented in your data model. The complexity increases with the
number of classes and relationships that are required to represent the data. For
example, a query about computers and one other class is simpler than a query about
computers and two or more classes with multiple relationships. The complexity also
depends on whether the information is directly represented or whether it must be
inferred by a chain of associations or negative sets. For example, you might build a
query to find all computers in the payroll division of your company. This query must
examine CI and relationship instances in three data-model classes. The query then
looks for computers in the BMC_ComputerSystem class, and then uses the
CreateSavedQuery (
query_bypath)
DeleteSavedQuery (
query_bypath)
ExecuteSavedQuery (
query_bypath)
GetSavedQuery (query_bypath)
ListSavedQueries (
query_bypath)
QueryByPath (query_bypath)
UpdateSavedQuery (
query_bypath)
BMC_MemberOfCollection relationship class to associate computers to an

organization. The query finds details about the payroll division in the
BMC_Organization class. For example, you might query for all computers running
Solaris and with patch 123. The query must examine the BMC_ComputerSystem class
for a list of computers. The query then uses the BMC_HostedSystemComponent
relationship class to find the associated operating systems. The query examines the
BMC_Patch class to locate the specified patch, and uses the
BMC_HostedSystemComponents relationship class to associate computers with their
installed patches.
Query operations
Note
These operations are deprecated.
The query operations allow you to build a list of query objects with qualifications.
Queries of BMC Atrium CMDB classes can range from simple to complex, and is related
to how the data is represented in your data model. The complexity increases with the
number of classes and relationships that are required to represent the data. For
example, a query about computers and one other class is simpler than a query about
computers and two or more classes with multiple relationships. The complexity also
depends on whether the information is directly represented or whether it must be
inferred by a chain of associations or negative sets. For example, you might build a
query to find all computers in the payroll division of your company. This query must
examine CI and relationship instances in three data-model classes. The query then
DeleteSavedQuery (
atrium_graphquery)
GetSavedQuery (atrium_query)
ListSavedQueries (atrium_query
)
QueryByPath
QueryByPathXML
looks for computers in the BMC_ComputerSystem class, and then uses the
BMC_MemberOfCollection relationship class to associate computers to an
organization. The query finds details about the payroll division in the
BMC_Organization class. For example, you might query for all computers running
Solaris and with patch 123. The query must examine the BMC_ComputerSystem class
for a list of computers. The query then uses the BMC_HostedSystemComponent
relationship class to find the associated operating systems. The query examines the
BMC_Patch class to locate the specified patch, and uses the
BMC_HostedSystemComponents relationship class to associate computers with their
installed patches.
Graph query operations
The graph query operations allow you to build a list of graph query objects with
qualifications. Queries of BMC Atrium CMDB classes can range from simple to complex
, and is related to how the data is represented in your data model.
BMC Atrium Core 9.0
CMDBf Query
CreateSavedQuery
DeleteSavedQuery (
atrium_graphquery)
Page 1764 of 2268
Home
Function type
Function list
ExecuteSavedQuery
GetSavedQuery (atrium_query)
GraphQuery
ListSavedQueries (atrium_query
)
UpdateSavedQuery
Federated CMDB query operations

CMDBf Query
The federated CMDB graph query operation allows you to build a list of graph query
objects with qualifications. Queries of BMC Atrium CMDB classes can range from
simple to complex, and is related to how the data is represented in your data model.
Service configuration operations
AttributeEntryMode
The service configuration operations are used to configure your BMC Atrium Core Web
Services. The values you set using these operations are used by the Web Service
GetProperties (service
configuration)
Registry Java API and sample scripts when they are executed.
SetProperties
Service impact operation

GetRelatedServices
The service impact operations allow you to work with service impact simulations.
Service utility operations
The service utility operations allow you to manipulate and retrieve information about
your BMC Atrium Core Web Services.
PropertyFileFormat
StatusOutput
Version operation
GetVersions
The version operation allows you to verify the version of BMC Atrium Core Web
Services.
Fault message function

Unless otherwise described for a particular web service operation, the web service operations have
certain fault message data structures.
serviceFault Indicates that the fault originates in the service implementation itself.
If the service encounters an error or discovers a missing parameter before it uses the
back-end APIs, it will return that as a service fault.
backendFault Indicates that the backend encountered an ARException from the Java
API.
Only a fatal response from BMC Atrium Core in ARException is returned as an AtriumFault.
The messages returned match the error codes that are returned by the AR System and BMC
Atrium CMDB APIs. You can see your BMC Atrium user documentation for an explanation of
messages returned either in the operation output or as a back-end fault.
BMC Atrium Core 9.0
Page 1765 of 2268
Home
ActivateFederatedInContext function
Expands t he FederatedInterface instance for a specific CI and federated interface. Depending on a
flag you specify when you call this operation, your federated instance might either be only
expanded, or expanded and launched.
Namespace
WSDL operation
<operation name="ActivateFederatedInContext"
parameterOrder="inargs">
<input message="tns:ActivateFederatedInContextRequest"
name="ActivateFederatedInContextRequest"/>
<output message="tns:ActivateFederatedInContextResponse"
name="ActivateFederatedInContextResponse"/>
<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>
WSDL messages
<message name="ActivateFederatedInContextRequest">
<part element="types:ActivateFederatedInContext" name="inargs"/>
</message>
<message name="ActivateFederatedInContextResponse">
<part element="types:ActivateFederatedInContextOutput"
name="outargs"/>
</message>
<message name="AtriumFault">
<part element="common:AtriumFault" name="errargs"/>
</message>
XSD schema
<element name="ActivateFederatedInContext">
<complexType>
<sequence>
<element name="loginInfo"
type="common:LoginInfo" nillable="true" />
<element name="classNameId"
<element name="federatedInstanceId" type="string" />
<element name="activateOption"
type="tns:FederatedActivationOption" />
BMC Atrium Core 9.0
Page 1766 of 2268
Home

</sequence>
</complexType>
</element>
<element name="ActivateFederatedInContextOutput">
<complexType>
<sequence>
<element name="federatedActivateInfo"
type="tns:FederatedActivateInfo" />
<element name="status"
type="common:StatusList" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
User ID, passwords, domain and other information necessary to log on to the application. See LoginInfo.
classNameId
The name of the class. It is a two-part structure that contains the namespace name and the class name.
See ClassNameId.
datasetId
instanceId
The unique identifier.
federatedInstanceId
The unique identifier for the federated instance.
activateOption
See FederatedActivationOption.
extensions
A list of extension types for the operation.
Return value
federatedActivateInfo
Holds the federated instance data activation information that is retrieved.
status
A list of zero or more notes, warnings, or errors generated from a call of this operation.
extensions
Fault message
BMC Atrium Core 9.0
Page 1767 of 2268
Home
See Fault message.
Fault message
BeginGraphWalk function
Specifies the start node for retrieving CI and relationship instances in a chunk. This operation sets
up the starting node and query parameters for the graph walk, such as number of levels to walk in
the relationship map, and maximum number of nodes to retrieve in one call.
This operation returns a structure that contains information such as, the list of classes walked in the
query, available next chunk status, and the next object index.
Namespace
WSDL operation
<operation name="BeginGraphWalk" parameterOrder="inargs">
<input message="tns:BeginGraphWalkRequest"
name="BeginGraphWalkRequest"/>
<output message="tns:BeginGraphWalkResponse"
name="BeginGraphWalkResponse"/>
<fault message="tns:AtriumFault"name="AtriumFault"/>
</operation>
WSDL messages
<message name="BeginGraphWalkRequest">
<part element="types:BeginGraphWalk" name="inargs"/>
</message>
<message name="BeginGraphWalkResponse">
<part element="types:BeginGraphWalkOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="BeginGraphWalk">
<complexType>
<sequence>
nillable="true" />
<element name="expiration"type="common:ExpirationIn"
nillable="true" />
<element name="startingClassNameId"
BMC Atrium Core 9.0
Page 1768 of 2268
Home
<element name="startingInstanceId"type="string" />

<element name="query" type="tns:GraphWalkQuery" />
<element name="extensions"type="common:ExtensionList"
nillable="true" />
</sequence>
</complexType>
</element>
<element name="BeginGraphWalkOutput">
<complexType>
<sequence>
<element name="expiration"type="common:ExpirationOut" />
type="common:ExtensionList"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
expiration
See ExpirationOut.
startingClassNameId
The class name ID to process first.
startingInstanceId
The ID of the instance to process first.
query
A qualification that determines the set of instances to retrieve. The qualification can include one or more
attributes and any combination of conditional, relational, and arithmetic operations. See GraphWalkQuery
.
extensions
Return value
contextId
The unique identifier for a particular set of circumstances.
expiration
Indicates when the graph walk query will expire.
hasNext
status
BMC Atrium Core 9.0
Page 1769 of 2268
Home
extensions
Fault message
See Fault message.
Fault message
CancelNEJobRun function
Cancels a specific normalization engine job.
Namespace
WSDL operation
<operation name="CancelNEJobRun" parameterOrder="inargs">
<input message="tns:CancelNEJobRunRequest"
name="CancelNEJobRunRequest"/>
<output message="tns:CancelNEJobRunResponse"
name="CancelNEJobRunResponse"/>
</operation>
WSDL messages
<message name="CancelNEJobRunRequest">
<part element="types:CancelNEJobRun" name="inargs"/>
</message>
<message name="CancelNEJobRunResponse">
<part element="common:StatusOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="CancelNEJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1770 of 2268
Home
<complexType>
<sequence>
<element name="status"type="tns:StatusList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobRunId
The run ID for the job.
extensions
Return value
status
extensions
Fault message
Fault message
See Fault message.
CancelREJobRun function
Stops reconciliation engine jobs.
Namespace
WSDL operation
<operation name="CancelREJobRun" parameterOrder="inargs">
<input message="tns:CancelREJobRunRequest"
name="CancelREJobRunRequest"/>
<output message="tns:CancelREJobRunResponse"
BMC Atrium Core 9.0
Page 1771 of 2268
Home
name="CancelREJobRunResponse"/>
</operation>
WSDL messages
<message name="CancelREJobRunRequest">
<part element="types:CancelREJobRun" name="inargs"/>
</message>
<message name="CancelREJobRunResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1772 of 2268
Home
Input arguments
loginInfo
User ID, passwords, domain and other information necessary to log on to the application.
See LoginInfo.
jobRunId
extensions
Return value
status
extensions
Fault message
Fault message
See Fault message.
CMDBf Query function

Retrieves data for the specified qualifications.from a Management Data Repository (MDR) that
stores federated data.
Unlike the BMC Atrium CMDB GraphQuery operation, CMDBf GraphQuery can work with any
federated CMDB or MDR. If you want to query BMC Atrium CMDB, you can use GraphQuery.
Queries can select and return items, relationships, or graphs containing items and relationships,
and the data records associated with each item and relationship. An MDR or a federating CMDB
can declare the data record types that its Query Service supports
A GraphQuery request describes the items and relationships of interest in the form of a graph.
Constraints can be applied to the nodes (items) and edges (relationships) in that graph to further
refine them. The GraphQuery response contains the items and relationships that, through their
combination, compose a graph that satisfies the constraints of the graph in the query.
Note
The first <itemTemplate> element must have a <DatasetId> element to specify the
dataset to query. If you do not specify the dataset ID, the query uses BMC.ASSET by
default.
Note
BMC Atrium Core 9.0
Page 1773 of 2268
Home
CMDBf Query does not use xpath.
Before you use CMDBf Query, you should access the service metadata for the MDR to see what
query options it supports.
Example: *https://testserver:8443/atriumws77/services/atrium_cmdbf_servicemetadata/wspolicy/
queryServiceMetadata*
For more information about the federated CMDB, see the standards at www.cmdbf.org.
Namespace
*http://schemas.dmtf.org/cmdbf/1/tns/serviceData*
WSDL operation
<operation name="GraphQuery">
<input message="tns:QueryRequest" />
<output message="tns:QueryResponse" />
<fault name="UnkownTemplateID" message="tns:UnkownTemplateIDFault"/>
<fault name="InvalidPropertyType" message="tns:InvalidPropertyTypeFault"/>
<fault name="XPathError" message="tns:XPathErrorFault"/>
<fault name="UnsupportedConstraint" message="tns:UnsupportedConstraintFault"/>
<fault name="UnsupportedSelector" message="tns:UnsupportedSelectorFault"/>
<fault name="QueryError" message="tns:QueryErrorFault"/>
</operation>
WSDL messages
<message name="QueryRequest">
<part name="body" element="cmdbf:query" />
</message>
<message name="QueryResponse">
<part name="body" element="cmdbf:queryResult" />
</message>
<message name="UnkownTemplateIDFault">
<part name="Detail" element="cmdbf:UnkownTemplateIDFault"/>
</message>
<message name="InvalidPropertyTypeFault">
<part name="Detail" element="cmdbf:InvalidPropertyTypeFault"/>
</message>
<message name="XPathErrorFault">
<part name="Detail" element="cmdbf:XPathErrorFault"/>
</message>
<message name="UnsupportedConstraintFault">
<part name="Detail" element="cmdbf:UnsupportedConstraintFault"/>
</message>
<message name="UnsupportedSelectorFault">
<part name="Detail" element="cmdbf:UnsupportedSelectorFault"/>
BMC Atrium Core 9.0
Page 1774 of 2268
Home
</message>
<message name="ExpensiveQueryErrorFault">
<part name="Detail" element="cmdbf:ExpensiveQueryErrorFault"/>
</message>
<message name="QueryErrorFault">
<part name="Detail" element="cmdbf:QueryErrorFault"/>
</message>
XSD schema
<xs:complexType name="QueryType">
<xs:sequence>
<xs:element name="itemTemplate" type="cmdbf:ItemTemplateType"minOccurs="0" maxOccurs
="unbounded" />
<xs:element name="relationshipTemplate"type="cmdbf:RelationshipTemplateType"
</xs:sequence>
</xs:complexType>
</xs:complexType>
<xs:complexType name="ItemTemplateType">
<xs:sequence>
<xs:group ref="cmdbf:Constraints" />
<xs:any namespace="##other" processContents="lax" minOccurs="0"
</xs:sequence>
<xs:attribute name="id" type="xs:ID" use="required" />
<xs:attribute name="suppressFromResult" type="xs:boolean" use="optional"
default="false"/>
</xs:complexType>
</xs:complexType>
<xs:group name="Constraints" >
<xs:sequence>
<xs:element name="contentSelector" type="cmdbf:ContentSelectorType"
minOccurs="0" maxOccurs="1" />
<xs:element name="instanceIdConstraint"
type="cmdbf:InstanceIdConstraintType"
<xs:element name="recordConstraint" type="cmdbf:RecordConstraintType"

</xs:sequence>
</xs:group>
</xs:group>
<xs:complexType name="RelationshipTemplateType">
<xs:sequence>
<xs:group ref="cmdbf:Constraints" />
<xs:element name="sourceTemplate" type="cmdbf:RelationshipRefType"
<xs:element name="targetTemplate" type="cmdbf:RelationshipRefType"
<xs:element name="depthLimit" type="cmdbf:DepthLimitType" minOccurs="0"
maxOccurs="1" />
BMC Atrium Core 9.0
Page 1775 of 2268
Home
</xs:sequence>
<xs:attribute name="id" type="xs:ID" use="required" />
<xs:attribute name="suppressFromResult" type="xs:boolean" use="optional"
default="false"/>
</xs:complexType>
</xs:complexType>
<xs:complexType name="RelationshipRefType">
<xs:attribute name="ref"
type="xs:IDREF" use="required" />
<xs:attribute name="minimum" type="xs:int" />
<xs:attribute name="maximum" type="xs:int" />
</xs:complexType>
</xs:complexType>
<xs:complexType name="DepthLimitType">
<xs:attribute name="maxIntermediateItems"
type="xs:positiveInteger" />
<xs:attribute name="intermediateItemTemplate" type="xs:IDREF" />

</xs:complexType>
</xs:complexType>
<xs:complexType name="ContentSelectorType">
<xs:sequence>
<xs:element name="selectedRecordType" type="cmdbf:SelectedRecordTypeType"
<xs:element name="xpathSelector" type="cmdbf:XPathExpressionType"
</xs:sequence>
</xs:complexType>
</xs:complexType>
<xs:complexType name="SelectedRecordTypeType">
<xs:sequence>
<xs:element name="selectedProperty" type="cmdbf:QNameType" minOccurs="0"
</xs:sequence>
<xs:attribute name="namespace" type="xs:anyURI" use="required" />
<xs:attribute name="localName" type="xs:NCName" use="required" />
</xs:complexType>
</xs:complexType>
<xs:complexType name="InstanceIdConstraintType">
<xs:sequence>
<xs:element ref="cmdbf:instanceId" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:complexType>
<xs:complexType name="RecordConstraintType">
<xs:sequence>
<xs:element name="recordType" type="cmdbf:QNameType" minOccurs="0"
<xs:element name="propertyValue" type="cmdbf:PropertyValueType"
<xs:element name="xpathConstraint" type="cmdbf:XPathExpressionType"
</xs:sequence>
BMC Atrium Core 9.0
Page 1776 of 2268
Home
</xs:complexType>
</xs:complexType>
<xs:complexType name="PropertyValueType">
<xs:sequence>
<xs:element name="equal" type="cmdbf:EqualOperatorType" minOccurs="0"
<xs:element name="less" type="cmdbf:ComparisonOperatorType" minOccurs="0"
maxOccurs="1" />
<xs:element name="lessOrEqual" type="cmdbf:ComparisonOperatorType"
<xs:element name="greater" type="cmdbf:ComparisonOperatorType" minOccurs="0"
maxOccurs="1" />
<xs:element name="greaterOrEqual" type="cmdbf:ComparisonOperatorType"
<xs:element name="contains" type="cmdbf:StringOperatorType" minOccurs="0"
<xs:element name="like" type="cmdbf:StringOperatorType" minOccurs="0"
<xs:element name="isNull" type="cmdbf:NullOperatorType" minOccurs="0"
maxOccurs="1" />
</xs:sequence>
<xs:attribute name="namespace" type="xs:anyURI"
use="required" />
<xs:attribute name="localName" type="xs:NCName"
use="required" />
<xs:attribute name="recordMetadata" type="xs:boolean" use="optional"

default="false" />
<xs:attribute name="matchAny" type="xs:boolean" use="optional" default="false"
/>
</xs:complexType>
Input arguments
QueryType
The <query> element contains <itemTemplate> and <relationshipTemplate> elements. The <
itemTemplate> and <relationshipTemplate> elements can have content selectors and constraints, which
have the same form in both elements.
ItemTemplate
Identifies matching items (not relationships) that are returned in the graph response. This element has
two attributes:
id--Unique identifier.
suppressFromResult--(optional) Indicates that the relationships that correspond to the template
with this attribute should be absent in the results. You can use suppressFromResult to constrain
other templates in the query.
DatasetID
Identifies the dataset to query.

The first <itemTemplate> element must have a <DatasetId> element to specify the dataset to query. If
you do not specify the dataset ID, the query uses BMC.ASSET by default.
Constraints
Restrict the instances returned based on properties of the instances and associated records.
contentSelector--Determines how instances matching the template are returned in the response.
If a template does not contain a <contentSelector> element, all matching instances and
associated records are returned in the response. See "ContentSelector" on page 375.
BMC Atrium Core 9.0
Page 1777 of 2268
Home
instanceIdConstraint--Specifies instances by instance ID. See "InstanceIdConstraint" on page

375.
recordConstraint--Defines specific record types and related properties to be evaluated. See "
RecordConstraint" on page 375.
RelationshipTemplate
Identifies matching relationships (not items) that are returned in the graph response.
RelationshipTemplateType has two attributes:
id--Unique identifier.
suppressFromResult--(optional) Indicates that the relationships that correspond to the template
with this attribute should be absent in the results. You can use suppressFromResult to constrain
other templates in the query.
You can use the following elements with RelationshipTemplateType:

sourceTemplate--Source item of a relationship.
targetTemplate--Target item of a relationship.
depthLimit--The number of edges (relationships) between source and target nodes in the
graph. See "DepthLimit" on page 374.
The <sourceTemplate> and <targetTemplate> elements each refer to an <itemTemplate> element
using the required @ref attribute. The value of the @ref attribute must match the value of the @id
attribute of an <itemTemplate> element in the query.|
DepthLimit
An optional element in the <relationshipTemplate> that extends the template to apply to other
relationships and items.
maxIntermediateItems--The maximum number of intermediate items in the relationship chain
between source and target items. A value of 1 indicates that the <relationshipTemplate> can
traverse one intermediate item between the source item and target item. This attribute is optional.
If it is not present, then the number of intermediate items between the source and the target is
unlimited.
intermediateItemTemplate--The value of the intermediateItemTemplate corresponds to the @id
attribute of an <itemTemplate> element that is used as a prototype for intermediate items in the
relationship chain. The value of the @intermediateItemTemplate attribute is also used to represent
the intermediate items in the <nodes> element of the query response.
ContentSelector
Determines how items or relationships matching the template are returned in the response. If a template
contains a <contentSelector> element, the records and properties returned for the instances that match
this template are limited to those explicitly selected.
Use only one of the following elements:
selectedRecordType--Selects records and properties explicitly by specifying their namespace and
local name. See "SelectedRecordType" on page 375.
SelectedRecordType
If <selectedRecordType> is used without any <selectedProperty> child elements, all properties (child
elements) of all records of the selected type are returned in the response.
You must provide the following attributes:
namespace--Specifies the URI.
BMC Atrium Core 9.0
Page 1778 of 2268
Home
localName--Specifies the non-qualified name.
You can use the <selectedProperty> element to define the properties of the selected record types
that are returned in the response. For each <selectedProperty>, you must provide the namespace
and localname attributes.|
InstanceIdConstraint
Specifies items or relationships by instance ID. A template element can have only one <
instanceIdConstraint>, which must have at least one <instanceId> element.
You must include <recordConstraint> if you use <instanceIdConstraint>.
RecordConstraint
Specifies record types and related properties to evaluate. An <itemTemplate> or <relationshipTemplate>

element can have any number of <recordConstraint> elements, which can have the following elements.
recordType--Defines the record types against which to evaluate the constraint. See "recordType"
on page 376.
propertyValue--Defines properties and values against which to evaluate the constraint. See "
propertyValue" on page 376.
recordType
If there are no <recordType> elements, the <propertyValue> element is evaluated against all record
types. If the instance contains a record element that has, as the first child element, an element in the
namespace corresponding to the value of the <recordType>/@namespace attribute and where the local
name of that first child element is the value of the <recordType>/@localName attribute.
propertyValue
These records contain properties whose values are accessible through an XML representation of the
instance. The <propertyValue> element can only be used on properties that have a type that is a subtype
of the xs:anySimpleType type. While the type must be known, it is not required that an XML schema
definition of the property be available.
The <propertyValue> element has the following attributes:
localName
namespace
recordMetadata--If set to true, indicates that the property to be evaluated is in the <
recordMetadata> element of the record.
matchAny--Defines whether the operators inside that element are logically AND-ed or OR-ed.
The <propertyValue> element has child operator elements: less, lessOrEqual, greater,
greaterOrEqual, contains, like, and isNull. Operator elements can have the following attributes:
caseSensitive
negate
For more information about operators, see the Configuration Management Database (CMDB)
Federation Specification at www.cmdbf.org. |
Return value
QueryResponse
NodesType
List of items.
EdgesType
List of relationships.
BMC Atrium Core 9.0
Page 1779 of 2268
Home
Fault message
UnkownTemplateIDFault
This fault occurs when a <relationshipTemplate> includes an ID that refers to a <sourceTemplate

>, <targetTemplate>, or <intermediateItemTemplate> that was not included in the query.
InvalidPropertyTypeFault
This fault occurs when the value in a constraint is invalid for the type of the property as defined
by the schema for the property. For example, this fault occurs when the property is a date and
the query includes a parameter to compare to the date that is a string that cannot be cast to a
date, such as "foobar."
UnsupportedConstraintFault
A constraint element in the template was specified that is not supported by this MDR.
UnsupportedSelectorFault
A selector element in the template was specified that is not supported by this MDR.
ExpensiveQueryErrorFault
The query was valid, but the server determined that the query is too expensive to execute or that
it would return a result set that is too large to return. The requestor is invited to retry, using a
simpler and/or more constrained query. What constitutes "too expensive" or "too large" is
determined by the server.
CMDBf Query examples

The three following examples are provided:
Service metadata example
Request example
Response example
Service metadata example

This is an example of a queryServiceMetadata to view what queries are supported. The <ser:
recordTypeList> element defines all the available classes. The example includes only the first two
classes, but in a real instance, it would include more classes. The CMDBf wsdl contains the
WS-Policy endpoint.
<wsp:Policy xmlns:wsp="http://www.w3.org/ns/ws-policy">
<ser:queryServiceMetadata xmlns:ser="http://schemas.dmtf.org/cmdbf/1/tns/
serviceMetadata">
<ser:serviceDescription>
<ser:mdrId>http://atrium.bmc.com/cmdbf/mdrId_Test</ser:mdrId>
</ser:serviceDescription>
<ser:queryCapabilities>
<ser:relationshipTemplateSupport depthLimit="false"
minimumMaximum="true" />
<ser:contentSelectorSupport propertySelector="true"
recordTypeSelector="true" />
<ser:recordConstraintSupport recordTypeConstraint="true"
propertyValueConstraint="true">
<ser:propertyValueOperators equal="true" less="true" greater="true"
lessOrEqual="true" greaterOrEqual="true" contains="true" like="true"
isNull="true" />
</ser:recordConstraintSupport>
</ser:queryCapabilities>
<ser:recordTypeList>
BMC Atrium Core 9.0
Page 1780 of 2268
Home
<ser:recordTypes namespace="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/
BMC.CORE/BMC_BaseElement" schemaLocation="https://iBMCHR47KM1.adprod.bmc.com:8443/atriumws77/services/
atrium_cmdbf_servicemetadata/xsd/BMC.CORE/BMC_BaseElement">
<ser:recordType localName="BMC_BaseElement" appliesTo="item" />
</ser:recordTypes>
</ser:recordTypes>
. . .
. . .
</ser:queryServiceMetadata>
</wsp:Policy>
Request example
In the following example, the query retrieves information from TestDataset on two classes of CIs
using two <itemTemplate> structures: BMC_ComputerSystem and BMC_OperatingSystem. For the
computer system, the query specifies to retrieve the data for the Name, History, Notes, and
ModifiedDate attributes for any computer with the name is TestComputer2. Similarly, for the
operating system, the query specifies to retrieve the data for the Name, History, Notes, and
ModifiedDate attributes for any computer with the name is TestOS2.
It also includes a <relationshipTemplate> structure to get BMC_Component relationship data
between the BMC_ComputerSystem and BMC_OperatingSystem instances.

<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext
-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401wss-wssecurity-utility-1.0.xsd">
<wsse:Password
Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText"/>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<query
xmlns="http://schemas.dmtf.org/cmdbf/1/tns/serviceData">
<itemTemplate
id="computer">
<contentSelector>
<selectedRecordType
localName="BMC_ComputerSystem"
BMC Atrium Core 9.0
Page 1781 of 2268
Home
namespace="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/BMC.CORE/
BMC_ComputerSystem">
<selectedProperty
localName="Name" namespace=""/>
<selectedProperty
localName="History" namespace=""/>
<selectedProperty
localName="Notes" namespace=""/>
<selectedProperty
localName="ModifiedDate"
namespace=""/>
</selectedRecordType>
</contentSelector>
<recordConstraint>
<recordType
localName="BMC_ComputerSystem"
BMC_ComputerSystem"/>
<propertyValue
localName="Name" namespace="">
<equal
xsi:type="xsd:string">TestComputer2</equal>
</propertyValue>
<propertyValue
localName="PrimaryCapability" namespace="">
<less
xsi:type="xsd:int">5</less>
</propertyValue>
</recordConstraint>
<DatasetId
xmlns="http://atrium.bmc.com/2010/07/cmdbf/common">TestDataset</DatasetId>
</itemTemplate>
<itemTemplate
id="os">
<contentSelector>
<selectedRecordType
localName="BMC_OperatingSystem"
BMC_OperatingSystem">
<selectedProperty
<selectedProperty
localName="ModifiedDate" namespace=""/>
<selectedProperty
localName="History" namespace=""/>
<selectedProperty
localName="Notes"
namespace=""/>
</contentSelector>
<recordConstraint>
<recordType
localName="BMC_OperatingSystem"
BMC Atrium Core 9.0
Page 1782 of 2268
Home
BMC_OperatingSystem"/>
<propertyValue
<equal
xsi:type="xsd:string">TestOS2</equal>
</propertyValue>
</recordConstraint>
</itemTemplate>
<relationshipTemplate
id="running">
<contentSelector>
<selectedRecordType
localName="BMC_Component"
namespace="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/BMC.CORE/BMC_Component">
<selectedProperty
<selectedProperty
localName="ModifiedDate"
namespace=""/>
</contentSelector>
<recordConstraint>
<recordType
localName="BMC_Component"
namespace="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/BMC.CORE/BMC_Component"/>
<propertyValue
<equal
xsi:type="xsd:string">TestComponent</equal>
</propertyValue>
</recordConstraint>
<sourceTemplate
ref="computer"/>
<targetTemplate ref="os"/>
</relationshipTemplate>
</query>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response example
The following example is a response to the query in Request example.

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ser:queryResult
xmlns:ser="http://schemas.dmtf.org/cmdbf/1/tns/serviceData">
<ser:nodes
templateId="computer">
BMC Atrium Core 9.0
Page 1783 of 2268
Home
<ser:item>
<ser:record>
<tns:BMC_ComputerSystem
xmlns:tns="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/BMC.CORE/
BMC_ComputerSystem">
<ModifiedDate>2010-07-23T16:22:41.000-05:00</ModifiedDate>
<Name>TestComputer2</Name>
<History
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:nil="true"/>
<Notes
xsi:nil="true"/>
</tns:BMC_ComputerSystem>
</ser:record>
<ser:instanceId>
<ser:localId>TestComputer2_54321</ser:localId>
</ser:instanceId>
</ser:item>
</ser:nodes>
<ser:nodes
templateId="os">
<ser:item>
<ser:record>
<tns:BMC_OperatingSystem
xmlns:tns="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/BMC.CORE/
BMC_OperatingSystem">
<Name>TestOS2</Name>
<History
xsi:nil="true"/>
<Notes
xsi:nil="true"/>
</tns:BMC_OperatingSystem>
</ser:record>
<ser:instanceId>
<ser:localId>TestOS2_54321</ser:localId>
</ser:instanceId>
</ser:item>
</ser:nodes>
<ser:edges
templateId="running">
<ser:relationship>
<ser:source>
<ser:localId>TestComputer2_54321</ser:localId>
</ser:source>
<ser:target>
<ser:localId>TestOS2_54321</ser:localId>
BMC Atrium Core 9.0
Page 1784 of 2268
Home
</ser:target>
<ser:record>
<tns:BMC_Component xmlns:tns="http://atrium.bmc.com/cmdbf/mdrId_Test/schema/
BMC.CORE/BMC_Component">
<Name>TestComponent</Name>
</tns:BMC_Component>
</ser:record>
<ser:instanceId>
<ser:localId>TestComponent_54321</ser:localId>
</ser:instanceId>
</ser:relationship>
</ser:edges>
</ser:queryResult>
</soapenv:Body>
</soapenv:Envelope>
ConfigureCMDBf function
Configures BMC Atrium CMDB for CMDBf queries. You can create only one custom CMDBf
configuration.
Namespace
*http://atrium.bmc.com/2010/07/cmdbf/config*
WSDL operation
<operation name="ConfigureCMDBf" parameterOrder="inargs">
<input message="tns:ConfigureCMDBfRequest"
name="ConfigureCMDBfRequest" />
<output message="tns:ConfigureCMDBfResponse"
name="ConfigureCMDBfResponse" />
<fault message="tns:AtriumFault" name="AtriumFault" />
</operation>
WSDL messages
<message name="ConfigureCMDBfRequest">
<part element="types:ConfigureCMDBf" name="inargs" />
</message>
<message name="ConfigureCMDBfResponse">
<part element="types:CMDBfConfiguration" name="outargs" />
</message>
</message>
BMC Atrium Core 9.0
Page 1785 of 2268
Home
XSD schema
<element name="ConfigureCMDBf">
<complexType>
<sequence>
type="common:LoginInfo" />
<element name="parameters"
type="tns:CMDBfConfigurationParameters" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
parameters
See CMDBfConfigurationParameters.
extensions
A list of extension types for the operation. See ExtensionList.
Return value
ConfigureCMDBfResponse
See CMDBfConfigurationParameters and CMDBfConfigurationManifest.
Fault message
Fault message
See Fault message.
CreateAttribute function
Creates a new attribute with the specified name.
Namespace
BMC Atrium Core 9.0
Page 1786 of 2268
Home
WSDL operation
<operation name="CreateAttribute" parameterOrder="inargs">
<input message="tns:CreateAttributeRequest"
name="CreateAttributeRequest"/>
<output message="tns:CreateAttributeResponse"
name="CreateAttributeResponse"/>
</operation>
WSDL messages
<message name="CreateAttributeRequest">
<part element="types:CreateAttribute" name="inargs"/>
</message>
<message name="CreateAttributeResponse">
</message>
</message>
XSD schema
<element name="CreateAttribute">
<complexType>
<sequence>
<element name="lang" type="string"/>
<element name="attributeId" type="string"
nillable="true" />
type="common:AttributeInfoIn"/>
<element name="extensions" type="common:ExtensionsList"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="status" type="impl:StatusList"/>
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1787 of 2268
Home
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
The language of the product specific to the locale. If no language is specified, the default language is used.
classNameId
The name of the class for which you want to create an attribute. It is a two-part structure that contains the
namespace name and the class name. The name of the class must be unique to the namespace. See
ClassNameId.
attributeName
The name of the attribute to create. The name of the attribute must be unique within the specified class and
within its superclasses and subclasses.
attributeId
The ID of the attribute to create.
fieldId
The unique identifier for the field.
attributeInfo
extensions
Return values
status
Fault message
Fault message
See Fault message.
CreateBusinessObject function
Creates a new business object with the specified name.
Namespace
*http://atrium.bmc.com/2011/02/businessobjects*
WSDL operation
<operation name="CreateBusinessObject" parameterOrder="inargs">
<input message="tns:CreateBusinessObjectRequest"
name="CreateBusinessObjectRequest"/>
<output message="tns:CreateBusinessObjectResponse"
name="CreateBusinessObjectResponse"/>
BMC Atrium Core 9.0
Page 1788 of 2268
Home
</operation>
WSDL messages
<message name="CreateBusinessObjectRequest">
<part element="types:CreateBusinessObject" name="inargs"/>
</message>
<message name="CreateBusinessObjectResponse">
<part element="types:CreateBusinessObjectOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
type="tns:BusinessObjectSelector" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
type="tns:BusinessObjectSelector" nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
BMC Atrium Core 9.0
Page 1789 of 2268
Home
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObject
See BusinessObjectSelectorList.
extensions
Return values
businessObject
status
A list of zero or more notes, warnings, or errors generated from a call of this operation. See StatusList.
extensions
Fault message
Fault message
See Fault message.
CreateBusinessObject function (deprecated)

Creates a new business object with the specified name.
Note
This function and its service are deprecated but supported. See CreateBusinessObject.
Namespace
WSDL operation
<operation name="CreateBusinessObject" parameterOrder="inargs">
<input message="tns:CreateBusinessObjectRequest"
name="CreateBusinessObjectRequest"/>
<output message="tns:CreateBusinessObjectResponse"
name="CreateBusinessObjectResponse"/>
<fault message="tns:AtriumFault"
name="AtriumFault"/>
</operation>
BMC Atrium Core 9.0
Page 1790 of 2268
Home
WSDL messages
<message name="CreateBusinessObjectRequest">
<part element="types:CreateBusinessObject" name="inargs"/>
</message>
<message name="CreateBusinessObjectResponse">
<part element="types:CreateBusinessObjectOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1791 of 2268
Home
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObject
See BusinessObject.
extensions
Return values
businessObject
See BusinessObject.
status
extensions
Fault message
See Fault message.
Fault message
CreateClass function
Creates a class with the specified properties.
Namespace
WSDL operation
<operation name="CreateClass" parameterOrder="inargs">
<input message="tns:CreateClassRequest"
name="CreateClassRequest"/>
<output message="tns:CreateClassResponse"
name="CreateClassResponse"/>
</operation>
WSDL messages
<message name="CreateClassRequest">
<part element="types:CreateClass" name="inargs"/>
</message>
<message name="CreateClassResponse">
</message>
BMC Atrium Core 9.0
Page 1792 of 2268
Home
</message>
XSD schema
<element name="CreateClass">
<complexType>
<sequence>
<element name="superclassNameId" type="common:ClassNameId"
nillable="true"/>
<element name="classId" type="string"/>
<element name="classInfo" type="common:ClassInfoIn"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class to create. The classNameId property is a two-part structure that contains the
namespace name and the class name. The name of the class must be unique to the namespace. See
ClassNameId.
superclassNameId
The parent class of the new class. Specify NULL for this parameter if there is no superclass. See
ClassNameId.
classId
The unique identifier for the class. You can type a value for the ID or you can let the system generate it.
classInfo
The type of class to create. The information contained in this definition depends on the type of class you
specify. See ClassInfoIn.
extensions
BMC Atrium Core 9.0
Page 1793 of 2268
Home
Return value
status
Fault message
See Fault message.
Fault message
CreateDataset function
Creates a dataset with the specified attribute values.
Namespace
WSDL operation
<operation name="CreateDataset" parameterOrder="inargs">
<input message="tns:CreateDatasetRequest"
name="CreateDatasetRequest"/>
<output message="tns:CreateDatasetResponse"
name="CreateDatasetResponse"/>
</operation>
WSDL messages
<message name="CreateDatasetRequest">
<part element="types:CreateDataset" name="inargs"/>
</message>
<message name="CreateDatasetResponse">
</message>
</message>
XSD schema
<element name="CreateDataset">
<complexType>
<sequence>
<element name="datasetInfo" type="tns:DatasetInfo"/>
nillable="true" />
BMC Atrium Core 9.0
Page 1794 of 2268
Home
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
datasetInfo
A list of one or more attribute names and value pairs (specified in any order) that identify the parameters for the
dataset to create, for example, DatasetType, Name, and Accessibility. You must specify values for all required
attributes that do not have defaults defined. An error is generated if an attribute does not exist or the user does not
have the write permission for an attribute name.
extensions
Return values
status
Fault message
Fault message
See Fault message.
CreateInstance function
Creates a CI instance of the specified class.
If you create a diary attribute with a value (using DiaryValue ) as part of a new instance, the name,
text, and timestamp of that diary entry are concatenated as a single string. The recommended
method to avoid concatenating the diary entry is create the instance, get the instance, and then set
the diary attribute value.
Namespace
BMC Atrium Core 9.0
Page 1795 of 2268
Home
WSDL operation
<operation name="CreateInstance" parameterOrder="inargs">
<input message="tns:CreateInstanceRequest"
name="CreateInstanceRequest"/>
<output message="tns:CreateInstanceResponse"
name="CreateInstanceResponse"/>
</operation>
WSDL messages
<message name="CreateInstanceRequest">
<part element="types:CreateInstance" name="inargs"/>
</message>
<message name="CreateInstanceResponse">
<part element="types:CreateInstanceOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="CreateInstance">
<complexType>
<sequence>
<element name="datasetId"
type="string"/>
type="common:
CreateInstanceInfoIn" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="CreateInstanceOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
BMC Atrium Core 9.0
Page 1796 of 2268
Home
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
datasetId
instanceInfo
A list of instances. See SetInstanceInfoIn.
extensions
Return values
instanceId
The unique identifier for the new attribute.
status
extensions
Fault message
See Fault message.
Fault message
CreateSavedQuery function (query_bypath)

Create a saved query of BMC Atrium CMDB.
Namespace
*http://atrium.bmc.com/2011/02/query*
WSDL operation
<operation name="CreateSavedQuery" parameterOrder="inargs">
<input message="tns:CreateSavedQueryRequest"
name="CreateSavedQueryRequest"/>
<output message="tns:CreateSavedQueryResponse"
name="CreateSavedQueryResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1797 of 2268
Home
WSDL messages
<message name="CreateSavedQueryRequest">
<part element="types:CreateSavedQuery" name="inargs"/>
</message>
<message name="CreateSavedQueryResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="savedQuery" type="tns:SavedQueryData"/>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
User ID, passwords, domain and other information necessary to log on to the application. See "LoginInfo" on page
198.
savedQuery
Indicates the path that needs to be queried to return the wanted CIs and relationships.
extensions
The extension ID of the class for which you want to retrieve relationships and instances. This is required if the
query graph contains the same CI class more than once and needs to distinguish one from another. See
ExtensionList.
BMC Atrium Core 9.0
Page 1798 of 2268
Home
Fault message
See "Fault message" on page 267.
Fault message
CreateSavedQuery function
Create a saved query of BMC Atrium CMDB.
*http://atrium.bmc.com/2010/07/graphquery*
Namespace
WSDL operation
<operation name="CreateSavedQuery" parameterOrder="inargs">
<input message="tns:CreateSavedQueryRequest"
name="CreateSavedQueryRequest"/>
<output message="tns:CreateSavedQueryResponse"
name="CreateSavedQueryResponse"/>
</operation>
WSDL messages
<message name="CreateSavedQueryRequest">
<part element="types:CreateSavedQuery" name="inargs"/>
</message>
<message name="CreateSavedQueryResponse">
</message>
</operation>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
<complexType>
<choice>
BMC Atrium Core 9.0
Page 1799 of 2268
Home
</choice>
</complexType>
</element>
Input arguments
loginInfo
198.
savedQuery
Indicates the path that needs to be queried to return the wanted CIs and relationships.
extensions
ExtensionList.
Fault message
Fault message
CreateMultipleBusinessObjects function
Creates multiple new business objects with the specified name.
Namespace
WSDL operation
<operation name="CreateMultipleBusinessObjects"
<input message="tns:CreateMultipleBusinessObjectsRequest"
name="CreateMultipleBusinessObjectsRequest"/>
<output message="tns:CreateMultipleBusinessObjectsResponse"
name="CreateMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="CreateMultipleBusinessObjectsRequest">
<part element="types:CreateMultipleBusinessObjects"
name="inargs"/>
</message>
<message name="CreateMultipleBusinessObjectsResponse">
<part element="types:CreateMultipleBusinessObjectsOutput"
BMC Atrium Core 9.0
Page 1800 of 2268
Home
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="datasetType" type="common:DatasetType"/>
type="tns:BusinessObjectSelectorList"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
BMC Atrium Core 9.0
Page 1801 of 2268
Home
businessObjectList
extensions
Return values
businessObjectList
status
extensions
Fault message
See Fault message.
Fault message
CreateMultipleBusinessObjects function (deprecated)

Creates multiple new business objects with the specified name.
Note
This function and its service are deprecated but supported. See
CreateMultipleBusinessObjects.
Namespace
WSDL operation
<operation name="CreateMultipleBusinessObjects"
<input message="tns:CreateMultipleBusinessObjectsRequest"
name="CreateMultipleBusinessObjectsRequest"/>
<output message="tns:CreateMultipleBusinessObjectsResponse"
name="CreateMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="CreateMultipleBusinessObjectsRequest">
<part element="types:CreateMultipleBusinessObjects"
name="inargs"/>
</message>
<message name="CreateMultipleBusinessObjectsResponse">
<part element="types:CreateMultipleBusinessObjectsOutput"
name="outargs"/>
BMC Atrium Core 9.0
Page 1802 of 2268
Home
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
BMC Atrium Core 9.0
Page 1803 of 2268
Home
businessObjectList
extensions
Return values
businessObjectList
status
extensions
Fault message
Fault message
See Fault message.
CreateMultipleInstances function
Creates multiple instances of the specified CI or relationship class.
Namespace
WSDL operation
<operation name="CreateMultipleInstances" parameterOrder="inargs">
<input message="tns:CreateMultipleInstancesRequest"
name="CreateMultipleInstancesRequest"/>
<output message="tns:CreateMultipleInstancesResponse"
name="CreateMultipleInstancesResponse"/>
</operation>
WSDL messages
<message name="CreateMultipleInstancesRequest">
<part element="types:CreateMultipleInstances"
name="inargs"/>
</message>
<message name="CreateMultipleInstancesResponse">
<part element="common:CreateMultipleInstancesOutput"
name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1804 of 2268
Home
XSD schema
<element name="CreateMultipleInstances">
<complexType>
<sequence>
type="common:CreateInstanceInfoInList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
type="tns:ExtensionList" nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
datasetId
The unique identifier for the dataset. CI or relationship instances are created in the dataset specified in this
parameter.
instanceInfo
A list of instances. See CreateInstanceInfoInList.
extensions
Return values
status
Fault message
BMC Atrium Core 9.0
Page 1805 of 2268
Home
See Fault message.
Fault message
DeleteAttribute function
Deletes the attribute with the specified ID.
Namespace
WSDL operation
<operation name="DeleteAttribute" parameterOrder="inargs">
<input message="tns:DeleteAttributeRequest"
name="DeleteAttributeRequest"/>
<output message="tns:DeleteAttributeResponse"
name="DeleteAttributeResponse"/>
</operation>
WSDL messages
<message name="DeleteAttributeRequest">
<part element="types:DeleteAttribute" name="inargs"/>
</message>
<message name="DeleteAttributeResponse">
</message>
</message>
XSD schema
<element name="DeleteAttribute">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1806 of 2268
Home
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class from which to delete the attribute. It is a two-part structure that contains the namespace
name and the class name. See ClassNameId.
attributeName
The name of the attribute to delete.
extensions
Return values
status
Fault message
See Fault message.
Fault message
DeleteBusinessObject function
Deletes a business object with the specified name.
Namespace
WSDL operation
<operation name="DeleteBusinessObject" parameterOrder="inargs">
<input message="tns:DeleteBusinessObjectRequest"
name="DeleteBusinessObjectRequest"/>
<output message="tns:DeleteBusinessObjectResponse"
name="DeleteBusinessObjectResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1807 of 2268
Home
WSDL messages
<message name="DeleteBusinessObjectRequest">
<part element="types:DeleteBusinessObject" name="inargs"/>
</message>
<message name="DeleteBusinessObjectResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="boRef" type="tns:boRef"/>
<element name="isSoftDelete" nillable="true"
type="boolean"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1808 of 2268
Home
loginInfo
datasetId
DatasetType
See DatasetType.
boRef
See BORef.
isSoftDelete
extensions
Return values
status
extensions
Fault message
See Fault message.
Fault message
DeleteBusinessObject function (deprecated)

Deletes a business object with the specified name.
Note
This function and its service are deprecated but supported. See DeleteBusinessObject.
Namespace
WSDL operation
<operation name="DeleteBusinessObject" parameterOrder="inargs">
<input message="tns:DeleteBusinessObjectRequest"
name="DeleteBusinessObjectRequest"/>
<output message="tns:DeleteBusinessObjectResponse"
name="DeleteBusinessObjectResponse"/>
</operation>
WSDL messages
<message name="DeleteBusinessObjectRequest">
<part element="types:DeleteBusinessObject" name="inargs"/>
</message>
BMC Atrium Core 9.0
Page 1809 of 2268
Home
<message name="DeleteBusinessObjectResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
BMC Atrium Core 9.0
Page 1810 of 2268
Home
DatasetType
See DatasetType.
businessObject
See BusinessObject.
isSoftDelete
extensions
Return values
status
extensions
Fault message
Fault message
See Fault message.
DeleteClass function
Deletes a specified class and its attributes.
Namespace
WSDL operation
<operation name="DeleteClass" parameterOrder="inargs">
<input message="tns:DeleteClassRequest"
name="DeleteClassRequest"/>
<output message="tns:DeleteClassResponse"
name="DeleteClassResponse"/>
</operation>
WSDL messages
<message name="DeleteClassRequest">
<part element="types:DeleteClass" name="inargs"/>
</message>
<message name="DeleteClassResponse">
</message>
</message>
BMC Atrium Core 9.0
Page 1811 of 2268
Home
XSD schema
<element name="DeleteClass">
<complexType>
<sequence>
<element name="option" type="class:ClassDeleteOption"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class to delete. See ClassNameId.
option
Specifies the action to take if the specified class contains attributes or subclasses. ALL_DEPENDENCIES -Delete the class, including all the subclasses and dependent relationship classes that are associated with it. All
the dependencies for the specified class are deleted. NONE --Delete the class only if the class contains no
instances and has no subclasses or dependent relationships. WITH_DATA --Delete the class only if the class has
no subclasses or dependent relationships. This applies only to regular classes.
extensions
Return values
status
Fault message
BMC Atrium Core 9.0
Page 1812 of 2268
Home
See Fault message.
Fault message
DeleteDataset function
Deletes the specified dataset.
Namespace
WSDL operation
<operation name="DeleteDataset" parameterOrder="inargs">
<input message="tns:DeleteDatasetRequest"
name="DeleteDatasetRequest"/>
<output message="tns:DeleteDatasetResponse"
name="DeleteDatasetResponse"/>
</operation>
WSDL messages
<message name="DeleteDatasetRequest">
<part element="types:DeleteDataset" name="inargs"/>
</message>
<message name="DeleteDatasetResponse">
</message>
</message>
XSD schema
<element name="DeleteDataset">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1813 of 2268
Home
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
coreDatasetId
The ID of the dataset to delete.
extensions
Return values
status
Fault message
Fault message
See Fault message.
DeleteInstance function
Deletes an instance of a class.
Namespace
WSDL operation
<operation name="DeleteInstance" parameterOrder="inargs">
<input message="tns:DeleteInstanceRequest"
name="DeleteInstanceRequest"/>
<output message="tns:DeleteInstanceResponse"
name="DeleteInstanceResponse"/>
</operation>
WSDL messages
<message name="DeleteInstanceRequest">
<part element="types:DeleteInstance" name="inargs"/>
BMC Atrium Core 9.0
Page 1814 of 2268
Home
</message>
<message name="DeleteInstanceResponse">
</message>
</message>
XSD schema
<element name="DeleteInstance">
<complexType>
<sequence>
type="common:DeleteInstanceInfoIn" />
type="common:InstanceDeleteOption"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
datasetId
The unique identifier for the dataset. The data in the return values are based on the dataset ID specified in this
parameter.
instanceInfo
A list of instances. See InstanceDeleteOption.
deleteOption
BMC Atrium Core 9.0
Page 1815 of 2268
Home
Specifies the action to take if the specified class contains attributes or subclasses.
DERIVED_INSTANCE_FOUND --Deletes only the specified instance, if the instance is retrieved.
UNCONDITIONALLY --Deletes the instance even when the instance cannot be retrieved. Errors are ignored for
instances that do not exist.
extensions
Return values
status
Fault message
See Fault message.
Fault message
DeleteMultipleBusinessObjects function
Deletes several business objects.
Namespace
WSDL operation
<operation name="DeleteMultipleBusinessObjects"
<input message="tns:DeleteMultipleBusinessObjectsRequest"
name="DeleteMultipleBusinessObjectsRequest"/>
<output message="tns:DeleteMultipleBusinessObjectsResponse"
name="DeleteMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="DeleteMultipleBusinessObjectsRequest">
<part element="types:DeleteMultipleBusinessObjects"
name="inargs"/>
</message>
<message name="DeleteMultipleBusinessObjectsResponse">
</message>
</message>
BMC Atrium Core 9.0
Page 1816 of 2268
Home
XSD schema
<complexType>
<sequence>
<element name="boRefList" type="tns:boRefList"/>
<element name="isSoftDelete" nillable="true"
type="boolean"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
boRefList
See BORefList.
isSoftDelete
extensions
BMC Atrium Core 9.0
Page 1817 of 2268
Home
Return values
status
extensions
Fault message
Fault message
See Fault message.
DeleteMultipleBusinessObjects function (deprecated)

Deletes several business objects.
Note
DeleteMultipleBusinessObjects.
Namespace
WSDL operation
<operation name="DeleteMultipleBusinessObjects"
<input message="tns:DeleteMultipleBusinessObjectsRequest"
name="DeleteMultipleBusinessObjectsRequest"/>
<output message="tns:DeleteMultipleBusinessObjectsResponse"
name="DeleteMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="DeleteMultipleBusinessObjectsRequest">
<part element="types:DeleteMultipleBusinessObjects"
name="inargs"/>
</message>
<message name="DeleteMultipleBusinessObjectsResponse">
</message>
</message>
BMC Atrium Core 9.0
Page 1818 of 2268
Home
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObjectList
isSoftDelete
extensions
Return values
BMC Atrium Core 9.0
Page 1819 of 2268
Home
status
extensions
Fault message
See Fault message.
Fault message
DeleteMultipleInstances function
Deletes multiple instances of the specified class.
Namespace
WSDL operation
<operation name="DeleteMultipleInstances" parameterOrder="inargs">
<input message="tns:DeleteMultipleInstancesRequest"
name="DeleteMultipleInstancesRequest"/>
<output message="tns:DeleteMultipleInstancesResponse"
name="DeleteMultipleInstancesResponse"/>
</operation>
WSDL messages
<message name="DeleteMultipleInstancesRequest">
<part element="types:DeleteMultipleInstances" name="inargs"/>
</message>
<message name="DeleteMultipleInstancesResponse">
</message>
</message>
XSD schema
<element name="DeleteMultipleInstances">
<complexType>
<sequence>
type="common:DeleteInstanceInfoInList" />
type="common:InstanceDeleteOption"/>
BMC Atrium Core 9.0
Page 1820 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
parameter.
instanceInfo
A list of instances.
deleteOption
Specifies the action to take if the specified class contains attributes or subclasses.
DERIVED_INSTANCE_FOUND --Deletes only the specified instance, if the instance is retrieved.
UNCONDITIONALLY --Deletes the instance even when the instance cannot be retrieved. Errors are ignored for
instances that do not exist.
extensions
Return values
status
Fault message
Fault message
See Fault message.
DeleteProperties function
Deletes specific configuration properties.
Namespace
BMC Atrium Core 9.0
Page 1821 of 2268
Home
WSDL operation
<operation name="DeleteProperties" parameterOrder="inargs">
<input message="tns:DeletePropertiesRequest"
name="DeletePropertiesRequest"/>
<output message="tns:DeletePropertiesResponse"
name="DeletePropertiesResponse"/>
<fault message="tns:AtriumServiceFault"
name="AtriumServiceFault" />
</operation>
WSDL messages
<message name="DeletePropertiesRequest">
<part element="types:DeleteProperties" name="inargs"/>
</message>
<message name="DeletePropertiesResponse">
<part element="types:DeletePropertiesOutput" name="outargs"/>
</message>
<message name="AtriumServiceFault">
<part element="types:AtriumServiceFault" name="errargs"/>
</message>
XSD schema
<element name="DeleteProperties">
<complexType>
<choice>
<element name="propertyNames" type="common:StringArray" />
</choice>
</complexType>
</element>
<element name="DeletePropertiesOutput">
<complexType>
<sequence>
<element name="deletedPropertyNames"
</sequence>
</complexType>
</element>
<element name="AtriumServiceFault
type="common:AtriumServiceFault" />
BMC Atrium Core 9.0
Page 1822 of 2268
Home
<sequence>
<element name="message" type="string" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
Input arguments
Names of the configuration properties.
propertyNames
Return values
deletedPropertyNames
List of deleted property names.
Property names that have been specified one or more times.
Property names that are required, but missing from the configuration values.
Incorrect property names.
Fault message
Fault message
DeleteSavedQuery function (query_bypath)

Deletes the specified query.
Namespace
WSDL operation
<operation name="DeleteSavedQuery" parameterOrder="inargs">
<input message="tns:DeleteSavedQueryRequest"
name="DeleteSavedQueryRequest"/>
<output message="tns:DeleteSavedQueryResponse"
name="DeleteSavedQueryResponse"/>
</operation>
WSDL messages
<message name="DeleteSavedQueryRequest">
<part element="types:DeleteSavedQuery" name="inargs"/>
BMC Atrium Core 9.0
Page 1823 of 2268
Home
</message>
<message name="DeleteSavedQueryResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
instanceId
The unique identifier for the query instance.
extensions
Return values
status
extensions
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1824 of 2268
Home
DeleteSavedQuery function (atrium_graphquery)

Namespace
WSDL operation
<wsdl:operation name="DeleteSavedQuery" parameterOrder="inargs">
<wsdl:input name="DeleteSavedQueryRequest"
message="tns:DeleteSavedQueryRequest">
</wsdl:input>
<wsdl:output name="DeleteSavedQueryResponse"
message="tns:DeleteSavedQueryResponse">
</wsdl:output>
<wsdl:fault name="AtriumFault" message="tns:AtriumFault">
</wsdl:fault>
WSDL messages
</message>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1825 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
instanceId
extensions
Return values
status
extensions
Fault message
Fault message
See Fault message.
DeleteSavedQuery function (atrium_query)

Namespace
WSDL operation
<operation name="DeleteSavedQuery" parameterOrder="inargs">
<input message="tns:DeleteSavedQueryRequest"
name="DeleteSavedQueryRequest"/>
<output message="tns:DeleteSavedQueryResponse"
name="DeleteSavedQueryResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1826 of 2268
Home
WSDL messages
</message>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
BMC Atrium Core 9.0
Page 1827 of 2268
Home
instanceId
extensions
Return values
status
extensions
Fault message
See Fault message.
Fault message
EndGraphWalk function
Ends the graph walk.
Namespace
WSDL operation
<operation name="EndGraphWalk" parameterOrder="inargs">
<input message="tns:EndGraphWalkRequest"
name="EndGraphWalkRequest"/>
<output message="tns:EndGraphWalkResponse"
name="EndGraphWalkResponse"/>
</operation>
WSDL messages
<message name="EndGraphWalkRequest">
<part element="types:EndGraphWalk" name="inargs"/>
</message>
<message name="EndGraphWalkResponse">
</message>
</message>
XSD schema
<element name="EndGraphWalk">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1828 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
contextId
Return value
loginInfo
contextId
extensions
Fault message
Fault message
See Fault message.
ExecuteSavedQuery function (query_bypath)

Runs a saved query of BMC Atrium CMDB.
Namespace
BMC Atrium Core 9.0
Page 1829 of 2268
Home
WSDL operation
<operation name="ExecuteSavedQuery" parameterOrder="inargs">
<input message="tns:ExecuteSavedQueryRequest"
name="ExecuteSavedQueryRequest"/>
<output message="tns:ExecuteSavedQueryResponse"
name="ExecuteSavedQueryResponse"/>
</operation>
WSDL messages
<message name="ExecuteSavedQueryRequest">
<part element="types:ExecuteSavedQuery" name="inargs"/>
</message>
<message name="ExecuteSavedQueryResponse">
<part element="types:QueryByPathOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1830 of 2268
Home
User ID, passwords, domain and other information necessary to log on to the application. See "LoginInfo" on
loginInfo
page 198.
queryName
The name of the saved query to execute.
parameterValues
datasetId
this parameter.
datasetMask
0: None--Based on the datasetId being passed, instances are retrieved from either the overlay or the original
dataset (CMDB_GET_MASK_NONE).
CMDB_GET_DATASET_MODE_CURRENT).
firstRetrieve
maxRetrieve
The number of levels to traverse in the specified queryGraph. The value A-1 specifies the query to traverse to
the end of the graph.
formatType
See QueryResultList.
extensions
ExtensionList.
Fault message
Fault message
ExecuteSavedQuery function
Runs a saved query of BMC Atrium CMDB.
Namespace
WSDL operation
<operation name="ExecuteSavedQuery" parameterOrder="inargs">
<input message="tns:ExecuteSavedQueryRequest"
name="ExecuteSavedQueryRequest"/>
<output message="tns:ExecuteSavedQueryResponse"
name="ExecuteSavedQueryResponse"/>
</operation>
WSDL messages
<message name="ExecuteSavedQueryRequest">
BMC Atrium Core 9.0
Page 1831 of 2268
Home
<part element="types:ExecuteSavedQuery" name="inargs"/>

</message>
<message name="ExecuteSavedQueryResponse">
<part element="types:GraphQueryOutput" name="outargs"/>
</message>
XSD schema
<complexType>
<sequence>
<element name="parameterValues"
type="tns:SavedQueryParameterValueList" />
type="tns:QueryResultGraphFormat"/>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
User ID, passwords, domain and other information necessary to log on to the application. See "LoginInfo" on
page 198.
queryName
The name of the saved query to execute.
parameterValues
datasetId
this parameter.
datasetMask
BMC Atrium Core 9.0
Page 1832 of 2268
Home
firstRetrieve
maxRetrieve
The number of levels to traverse in the specified queryGraph. The value A-1 specifies the query to traverse to
the end of the graph.
formatType
See QueryResultList.
extensions
ExtensionList.
Fault message
Fault message
ExportNEConfiguration function
Exports normalization engine configuration information.
Namespace
WSDL operation
<operation name="ExportNEConfiguration" parameterOrder="inargs">
<input message="tns:ExportNEConfigurationRequest"
name="ExportNEConfigurationRequest"/>
<output message="tns:ExportNEConfigurationResponse"
name="ExportNEConfigurationResponse"/>
</operation>
WSDL messages
<message name="ExportNEConfigurationRequest">
<part element="types:ExportNEConfiguration" name="inargs"/>
</message>
<message name="ExportNEConfigurationResponse">
<part element="types:ExportNEConfigurationOutput"
name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1833 of 2268
Home
XSD schema
<element name="ExportNEConfiguration">
<complexType>
<sequence>
nillable="true" />
<element name="exportOptions"
type="tns:NEExportOptionTypeList" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="ExportNEConfigurationOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
exportOptions
See NEExportOptionTypeList.
extensions
Return values
xml
String of any valid XML code.
status
extensions
BMC Atrium Core 9.0
Page 1834 of 2268
Home
Fault message
See Fault message.
Fault message
GetAttributes function
Retrieves multiple attributes for the specified class.
Namespace
WSDL operation
<operation name="GetAttributes" parameterOrder="inargs">
<input message="tns:GetAttributesRequest"
name="GetAttributesRequest"/>
<output message="tns:GetAttributesResponse"
name="GetAttributesResponse"/>
</operation>
WSDL messages
<message name="GetAttributesRequest">
<part element="types:GetAttributes" name="inargs"/>
</message>
<message name="GetAttributesResponse">
<part element="types:GetAttributesOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetAttributes">
<complexType>
<sequence>
type="common:ArrayOf_String" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetAttributesOutput">
BMC Atrium Core 9.0
Page 1835 of 2268
Home
<complexType>
<sequence>
<element name="attributeInfoList"
type="common:AttributeInfoList"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class. It is a two-part structure that contains the namespace name and the class name. See
ClassNameId.
attributeNames
The names of the attributes to retrieve.
Return values
attributeInfoList
Retrieves attribute information. See AttributeInfoList.
status
extensions
Fault message
Fault message
See Fault message.
GetAuditData function
Retrieves information about the audit process.
Namespace
*http://atrium.bmc.com/2010/07/audit*
WSDL operation
<wsdl:operation name="GetAuditData">
BMC Atrium Core 9.0
Page 1836 of 2268
Home
<wsdl:documentation/>
<soap:operation soapAction="GetAuditData" style="document"/>
<wsdl:input>
<soap:body parts="inargs" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="outargs" use="literal"/>
</wsdl:output>
<wsdl:fault name="AtriumFault">
<soap:fault name="AtriumFault" use="literal"/>
</wsdl:fault>
</wsdl:operation>
WSDL messages
<message name="GetAuditDataRequest">
<part element="types:GetAuditData" name="inargs"/>
</message>
<message name="GetAuditDataResponse">
<part element="types:GetAuditDataOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetAuditData">
<complexType>
<sequence>
<element name="query" nillable="true" type="string" />
</sequence>
</complexType>
</element>
<element name="GetAuditDataOutput">
<complexType>
<sequence>
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1837 of 2268
Home
</element>
Input arguments
loginInfo
See LoginInfo..
classNameId
See ClassNameId.
instanceId
The ID of the instance. The unique identifier for the new attribute. An integer value that specifies the class ID of
the UI component class.
query
A qualification that determines the set of instances to retrieve. The qualification can include one or more attributes
and any combination of conditional, relational, and arithmetic operations.
extensions
Return value
auditValueListList
Holds the retrieved list of audit values.
status
extensions
Fault message
Fault message
GetBusinessObject function
Finds business objects that meet the specified criteria.
Namespace
WSDL operation
<operation name="GetBusinessObject" parameterOrder="inargs">
<input message="tns:GetBusinessObjectRequest"
name="GetBusinessObjectRequest"/>
<output message="tns:GetBusinessObjectResponse"
name="GetBusinessObjectResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1838 of 2268
Home
WSDL messages
<message name="GetBusinessObjectRequest">
<part element="types:GetBusinessObject" name="inargs"/>
</message>
<message name="GetBusinessObjectResponse">
<part element="types:GetBusinessObjectOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="boRef" type="tns:BORef"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="businessObject" nillable="true"
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1839 of 2268
Home
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
boRef
See BORef.
extensions
Return values
businessObject
status
extensions
Fault message
Fault message
See Fault message.
GetBusinessObjects function (deprecated)

Note
This function and its service are deprecated but supported. See GetBusinessObject.
Namespace
WSDL operation
<operation name="GetBusinessObjects" parameterOrder="inargs">
<input message="tns:GetBusinessObjectsRequest"
name="GetBusinessObjectsRequest"/>
<output message="tns:GetBusinessObjectsResponse"
name="GetBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="GetBusinessObjectsRequest">
<part element="types:GetBusinessObjects" name="inargs"/>
BMC Atrium Core 9.0
Page 1840 of 2268
Home
</message>
<message name="GetBusinessObjectsResponse">
<part element="types:GetBusinessObjectsOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
<element name="boRef" type="tns:BORef" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
BMC Atrium Core 9.0
Page 1841 of 2268
Home
datasetType
See DatasetType.
boRef
See BORef.
extensions
Return values
businessObject
See BusinessObject.
status
extensions
Fault message
Fault message
See Fault message.
GetClass function
Retrieves class information.
Namespace
WSDL operation
<operation name="GetClass" parameterOrder="inargs">
<input message="tns:GetClassRequest"
name="GetClassRequest"/>
<output message="tns:GetClassResponse"
name="GetClassResponse"/>
</operation>
WSDL messages
<message name="GetClassRequest">
<part element="types:GetClass" name="inargs"/>
</message>
<message name="GetClassResponse">
<part element="types:GetClassOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1842 of 2268
Home
XSD schema
<element name="GetClass">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetClassOutput">
<complexType>
<sequence>
<element name="classInfo" type="common:ClassInfoOut"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
ClassNameId.
extensions
Return values
classInfo
The information retrieved for the specified class.
status
extensions
BMC Atrium Core 9.0
Page 1843 of 2268
Home
Fault message
See Fault message.
Fault message
GetCMDBfConfiguration function
Retrieves the current BMC Atrium CMDB configuration values for CMDBf queries.
Namespace
WSDL operation
<operation name="GetCMDBfConfiguration" parameterOrder="inargs">
<input message="tns:GetCMDBfConfigurationRequest"
name="GetCMDBfConfigurationRequest" />
<output message="tns:GetCMDBfConfigurationResponse"
name="GetCMDBfConfigurationResponse" />
<fault message="tns:AtriumFault" name="AtriumFault" />
</operation>
WSDL messages
<message name="GetCMDBfConfigurationRequest">
<part element="types:GetCMDBfConfiguration" name="inargs" />
</message>
<message name="GetCMDBfConfigurationResponse">
</message>
XSD schema
<element name="GetCMDBfConfiguration">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
BMC Atrium Core 9.0
Page 1844 of 2268
Home
</choice>
</complexType>
</element>
Input arguments
loginInfo
extensions
Return value
See CMDBfConfigurationParameters.
parameters
Fault message
Fault message
See Fault message.
GetCopyAuditData function (atrium_audit)

Retrieves information about the copy and audit processes.
Namespace
http://atrium.bmc.com/2010/07/audit/types
WSDL operation
<wsdl:operation name="GetCopyAuditData">
<soap:operation soapAction="GetCopyAuditData" style="document"/>
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
</wsdl:fault>
</wsdl:operation>
WSDL messages
<message name="GetCopyAuditDataRequest">
<part element="types:GetCopyAuditData" name="inargs"/>
</message>
<message name="GetCopyAuditDataResponse">
<part element="types:GetCopyAuditDataOutput" name="outargs"/>
BMC Atrium Core 9.0
Page 1845 of 2268
Home
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="query" nillable="true" type="string"/>
<element name="attributes" type="common:StringArray"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
classNameId
ClassNameId.
instanceId
BMC Atrium Core 9.0
Page 1846 of 2268
Home
query

attributes
A list of attribute names to retrieve. See StringArray.
extensions
Return values
auditValueListList
status
extensions
Fault message
See Fault message.
Fault message
GetCopyAuditData function (atrium_instances)

Retrieves information about the copy and audit processes.
Namespace
WSDL operation
<operation name="GetCopyAuditData" parameterOrder="inargs">
<input message="tns:GetCopyAuditDataRequest"
name="GetCopyAuditDataRequest"/>
<output message="tns:GetCopyAuditDataResponse"
name="GetCopyAuditDataResponse"/>
</operation>
WSDL messages
<message name="GetCopyAuditDataRequest">
<part element="types:GetCopyAuditData" name="inargs"/>
</message>
<message name="GetCopyAuditDataResponse">
<part element="types:GetCopyAuditDataOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1847 of 2268
Home
XSD schema
<complexType>
<sequence>
nillable="true" />
<element name="query" type="string" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
classNameId
ClassNameId.
instanceId
datasetId
query
BMC Atrium Core 9.0
Page 1848 of 2268
Home
attributes
A list of attribute names to retrieve. See StringArray.
extensions
Return values
auditValueListList
status
extensions
Fault message
Fault message
See Fault message.
GetDataset function
Retrieves dataset information.
Namespace
WSDL operation
<operation name="GetDataset" parameterOrder="inargs">
<input message="tns:GetDatasetRequest"
name="GetDatasetRequest"/>
<output message="tns:GetDatasetResponse"
name="GetDatasetResponse"/>
</operation>
WSDL messages
<message name="GetDatasetRequest">
<part element="types:GetDataset" name="inargs"/>
</message>
<message name="GetDatasetResponse">
<part element="types:GetDatasetOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1849 of 2268
Home
XSD schema
<element name="GetDataset">
<complexType>
<sequence>
<element name="coreDatasetId" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetDatasetOutput">
<complexType>
<sequence>
<element name="datasetInfo" type="tns:DatasetInfo"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
coreDatasetId
The unique ID for the dataset. The dataset ID cannot contain a slash
, semicolon (
, or comma (,). If you
do not provide an ID, the system generates a GUID to use for this ID. The dataset ID cannot be changed after
the dataset is created.
extensions
Return values
datasetInfo
Information retrieved about the dataset, such as Dataset ID, Dataset Name, Accessibility, Source Dataset ID,
ClientTypeList, Instance ID, and Description.
status
BMC Atrium Core 9.0
Page 1850 of 2268
Home
extensions
Fault message
See Fault message.
Fault message
GetGraphWalkStatus function
Retrieve the status of a graph walk query.
Namespace
WSDL operation
<operation name="GetGraphWalkStatus" parameterOrder="inargs">
<input message="tns:GetGraphWalkStatusRequest"
name="GetGraphWalkStatusRequest"/>
<output message="tns:GetGraphWalkStatusResponse"
name="GetGraphWalkStatusResponse"/>
</operation>
WSDL messages
<message name="GetGraphWalkStatusRequest">
<part element="types:GetGraphWalkStatus" name="inargs"/>
</message>
<message name="GetGraphWalkStatusResponse">
<part element="types:GetGraphWalkStatusOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetGraphWalkStatus">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1851 of 2268
Home
<element name="GetGraphWalkStatusOutput">
<complexType>
<sequence>
<element name="expiration"
type="common:ExpirationOut" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
contextId
extensions
Return value
expiration
See ExpirationOut.
hasNext
status
extensions
Fault message
Fault message
See Fault message.
GetInstances function
Retrieves a list of instances. You can limit the retrieved instance result set by specifying a
qualification.
Namespace
BMC Atrium Core 9.0
Page 1852 of 2268
Home
WSDL operation
<operation name="GetInstances" parameterOrder="inargs">
<input message="tns:GetInstancesRequest"
name="GetInstancesRequest"/>
<output message="tns:GetInstancesResponse"
name="GetInstancesResponse"/>
</operation>
WSDL messages
<message name="GetInstancesRequest">
<part element="types:GetInstances" name="inargs"/>
</message>
<message name="GetInstancesResponse">
<part element="types:GetInstancesOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetInstances">
<complexType>
<sequence>
<element name="query" type="string"/>
<element name="attributes" type="common:ArrayOf_String"/>
<element name="sortOrder" type="common:SortOrderList"/>
<element name="aGetMask" type="common:GetMask"/>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetInstancesOutput">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1853 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The class from which the instances are to be retrieved. It is a two-part structure that contains the namespace
query
attributes
A list of attribute names to retrieve.
firstRetrieve
The first instance to retrieve. The value represents the first entry and is the default value if the value is not set.
maxRetrieve
The maximum number of entries to retrieve. Use this parameter to limit the amount of data returned if the query
does not narrow the list.
sortOrder
The sort order for the retrieved data. See SortOrderList.
datasetId
parameter.
aGetMask
The identifier for specifying the dataset type.GET_MASK_NONE: Based on the datasetId being passed,
instances retrieves instancesfrom either the overlay or the original dataset. DATASET_MODE_CURRENT:
Retrieves instances from the current dataset only.
extensions
Return values
instanceInfo
A list of instances. See InstanceInfoOutList.
status
extensions
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1854 of 2268
Home
GetLastNEJobRunStatus function
Retrieves the status of the normalization job that was last run.
Namespace
WSDL operation
<operation name="GetLastNEJobRunStatus" parameterOrder="inargs">
<input message="tns:GetLastNEJobRunStatusRequest"
name="GetLastNEJobRunStatusRequest"/>
<output message="tns:GetLastNEJobRunStatusResponse"
name="GetLastNEJobRunStatusResponse"/>
</operation>
WSDL messages
<message name="GetLastNEJobRunStatusRequest">
<part element="types:GetLastNEJobRunStatus" name="inargs"/>
</message>
<message name="GetLastNEJobRunStatusResponse">
<part element="types:GetLastNEJobRunStatusOutput" name="outargs"/> </message>
</message>
XSD schema
<element name="GetLastNEJobRunStatus">
<complexType>
<sequence>
<element name="loginInfo"type="common:LoginInfo"
nillable="true" />
<element name="jobName" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetLastNEJobRunStatusOutput">
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:NEJobRunInfo"
nillable="true" />
nillable="true" />
BMC Atrium Core 9.0
Page 1855 of 2268
Home
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobName
extensions
Return value
jobRunInfo
Retrieves job information.
status
extensions
Fault message
Fault message
See Fault message.
GetLogAuditData function
Retrieves information about the audit logging process.
Namespace
*http://atrium.bmc.com/2010/07/audit*
WSDL operation
<wsdl:operation name="GetLogAuditData">
<soap:operation soapAction="GetLogAuditData" style="document"/>
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
BMC Atrium Core 9.0
Page 1856 of 2268
Home
</wsdl:fault>
</wsdl:operation>
WSDL messages
<message name="GetLogAuditDataRequest">
<part element="types:GetLogAuditData" name="inargs"/>
</message>
<message name="GetLogAuditDataResponse">
<part element="types:GetAuditDataOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetLogAuditData">
<complexType>
<sequence>
<element name="query" nillable="true" type="string" />
</sequence>
</complexType>
</element>
<element name="GetAuditDataOutput">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
Input arguments
loginInfo
BMC Atrium Core 9.0
Page 1857 of 2268
Home
See LoginInfo.
classNameId
See ClassNameId.
instanceId
query
extensions
Return value
auditValueListList
status
extensions
Fault message
Fault message
GetMultipleBusinessObjects function
Returns multiple business objects with the specified criteria.
Namespace
WSDL operation
<operation name="GetMultipleBusinessObjects"
<input message="tns:GetMultipleBusinessObjectsRequest"
name="GetMultipleBusinessObjectsRequest"/>
<output message="tns:GetMultipleBusinessObjectsResponse"
name="GetMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="GetMultipleBusinessObjectsRequest">
<part element="types:GetMultipleBusinessObjects" name="inargs"/>
</message>
<message name="GetMultipleBusinessObjectsResponse">
BMC Atrium Core 9.0
Page 1858 of 2268
Home
<part element="types:GetMultipleBusinessObjectsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="boRefList" type="tns:BORefList"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
BMC Atrium Core 9.0
Page 1859 of 2268
Home
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
boRefList
See BORefList.
extensions
Return values
businessObjectList
status
extensions
Fault message
See Fault message.
Fault message
GetMultipleBusinessObjects function (deprecated)

Returns multiple business objects with the specified criteria.
Note
GetMultipleBusinessObjects.
Namespace
WSDL operation
<operation name="GetMultipleBusinessObjects"
<input message="tns:GetMultipleBusinessObjectsRequest"
name="GetMultipleBusinessObjectsRequest"/>
<output message="tns:GetMultipleBusinessObjectsResponse"
name="GetMultipleBusinessObjectsResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1860 of 2268
Home
WSDL messages
<message name="GetMultipleBusinessObjectsRequest">
<part element="types:GetMultipleBusinessObjects" name="inargs"/>
</message>
<message name="GetMultipleBusinessObjectsResponse">
<part element="types:GetMultipleBusinessObjectsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
<complexType>
BMC Atrium Core 9.0
Page 1861 of 2268
Home
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
boRefList
See BORefList.
extensions
Return values
businessObjectList
status
extensions
Fault message
Fault message
See Fault message.
GetNEJobRunStatus function
Retrieves the status for a specific normalization job execution.
Namespace
WSDL operation
<operation name="GetNEJobStatus" parameterOrder="inargs">
<input message="tns:GetNEJobRunStatusRequest"
name="GetNEJobRunStatusRequest"/>
<output message="tns:GetNEJobRunStatusResponse"
name="GetNEJobRunStatusResponse"/><fault message="tns:AtriumFault" name="AtriumFault
"/>
</operation>
BMC Atrium Core 9.0
Page 1862 of 2268
Home
WSDL messages
<message name="GetNEJobRunStatusRequest">
<part element="types:GetNEJobRunStatus" name="inargs"/>
</message>
<message name="GetNEJobRunStatusResponse">
<part element="types:GetNEJobRunStatusOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetNEJobRunStatus">
<complexType>
<sequence>
<element name="extensions"type="common:ExtensionList"
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetNEJobRunStatusOutput">
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:NEJobRunInfo" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1863 of 2268
Home
loginInfo
jobRunId
extensions
Return value
jobRunInfo
status
extensions
Fault message
Fault message
See Fault message.
GetNormalizedInfoList function
Retrieves normalized instance information.
Namespace
WSDL operation
<operation name="GetNormalizedInfoList" parameterOrder="inargs">
<input message="tns:GetNormalizedInfoListRequest"
name="GetNormalizedInfoListRequest"/>
<output message="tns:GetNormalizedInfoListResponse"
name="GetNormalizedInfoListResponse" />
</operation>
WSDL messages
<message name="GetNormalizedInfoListRequest">
<part element="types:GetNormalizedInfoList" name="inargs"/>
</message>
<message name="GetNormalizedInfoListResponse">
<part element="types:NEQueryResultListOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1864 of 2268
Home
XSD schema
<element name="GetNormalizedInfoList">
<complexType>
<sequence>
nillable="true" />
<element name="queryInfoList"
type="tns:NEQueryInfoList" />
<element name="multiMatchOption"
type="tns:NEMultiMatchOptionType" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="queryResult"type="tns:NEQueryResultList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
queryInfoList
See NEQueryInfoList.
attrGetList
See StringArray.
multiMatchOption
See NEMultiMatchOptionType.
extensions
Return value
BMC Atrium Core 9.0
Page 1865 of 2268
Home
queryResult
Values returned for a particular query.
status
extensions
Fault message
See Fault message.
Fault message
GetNormalizedInfoListByFPKey function
Retrieves normalized instance information by fingerprint key information.
Namespace
WSDL operation
<operation name="GetNormalizedInfoListByFPKey" parameterOrder="inargs">
<input message="tns:GetNormalizedInfoListByFPKeyRequest"
name="GetNormalizedInfoListByFPKeyRequest"/>
<output message="tns:GetNormalizedInfoListByFPKeyResponse"
name="GetNormalizedInfoListByFPKeyResponse" />
</operation>
WSDL messages
<message name="GetNormalizedInfoListByFPKeyRequest">
<part element="types:GetNormalizedInfoListByFPKey"
name="inargs"/>
</message>
<message name="GetNormalizedInfoListByFPKeyResponse">
</message>
</message>
XSD schema
<element name="GetNormalizedInfoListByFPKey">
<complexType>
<sequence>
nillable="true" />
<element name="fpKeyList" type="common:StringArray" />
BMC Atrium Core 9.0
Page 1866 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
fpKeyList
A fingerprint key is a short sequence of bytes used to authenticate or look up a longer key.
attrGetList
extensions
Return value
queryResult
status
extensions
Fault message
Fault message
See Fault message.
GetNormalizedInfoListByName function
Retrieve normalized instance information by name of the instance.
BMC Atrium Core 9.0
Page 1867 of 2268
Home
Namespace
WSDL operation
<operation name="GetNormalizedInfoListByName" parameterOrder="inargs">
<input message="tns:GetNormalizedInfoListByNameRequest"
name="GetNormalizedInfoListByNameRequest"/>
<output message="tns:GetNormalizedInfoListByNameResponse"
name="GetNormalizedInfoListByNameResponse" />
</operation>
WSDL messages
<message name="GetNormalizedInfoListByNameRequest">
<part element="types:GetNormalizedInfoListByName"
name="inargs"/>
</message>
<message name="GetNormalizedInfoListByNameResponse">
</message>
</message>
XSD schema
<element name="GetNormalizedInfoListByName">
<complexType>
<sequence>
nillable="true" />
<element name="nameInfoList" type="tns:NENameInfoList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1868 of 2268
Home
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
nameInfoList
See NENameInfoList.
attrGetList
extensions
Return values
queryResult
status
extensions
Fault message
See Fault message.
Fault message
GetNormalizedInfoListByPCKey function
Retrieve normalized instance information by product catalog key.
Namespace
WSDL operation
<operation name="GetNormalizedInfoListByPCKey" parameterOrder="inargs">
<input message="tns:GetNormalizedInfoListByPCKeyRequest"
name="GetNormalizedInfoListByPCKeyRequest"/>
<output message="tns:GetNormalizedInfoListByPCKeyResponse"
name="GetNormalizedInfoListByPCKeyResponse" />
</operation>
BMC Atrium Core 9.0
Page 1869 of 2268
Home
WSDL messages
<message name="GetNormalizedInfoListByPCKeyRequest">
<part element="types:GetNormalizedInfoListByPCKey"
name="inargs"/>
</message>
<message name="GetNormalizedInfoListByPCKeyResponse">
</message>
</message>
XSD schema
<element name="GetNormalizedInfoListByPCKey">
<complexType>
<sequence>
nillable="true" />
<element name="pcKeyList" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1870 of 2268
Home
loginInfo
pcKeyList
One or more product catalog key values.
attrGetList
extensions
Return values
queryResult
status
extensions
Fault message
Fault message
See Fault message.
GetProperties function (service configuration)

Retrieve service configuration properties.
Namespace
WSDL operation
<operation name="GetProperties" parameterOrder="inargs">
<input message="tns:GetPropertiesRequest"
name="GetPropertiesRequest"/>
<output message="tns:GetPropertiesResponse"
name="GetPropertiesResponse"/>
</operation>
WSDL messages
<message name="GetPropertiesRequest">
<part element="types:GetProperties" name="inargs"/>
</message>
<message name="GetPropertiesResponse">
<part element="types:GetPropertiesOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1871 of 2268
Home
XSD schema
<complexType>
<sequence>
<element name="propertyNames" type="common:StringArray" />
</sequence>
</complexType>
</element>
<element name="GetPropertiesOutput">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<element name="AtriumServiceFault
<sequence>
<element name="message" type="string" nillable="true" />
nillable="true" />
</sequence>
</complexType>
Input arguments
propertyNames
Names of the configuration properties.
Return values
properties
List of configuration properties.
Property names that have been specified one or more times.
Property names that are required, but missing from the configuration values.
Fault message
BMC Atrium Core 9.0
Page 1872 of 2268
Home
Fault message
GetREJobRun function
Retrieve reconciliation engine job information.
Namespace
WSDL operation
<operation name="GetREJobRun" parameterOrder="inargs">
<input message="tns:GetREJobRunRequest"
name="GetREJobRunRequest"/>
<output message="tns:GetREJobRunResponse"
name="GetREJobRunResponse"/>
</operation>
WSDL messages
<message name="GetREJobRunRequest">
<part element="types:GetREJobRun" name="inargs"/>
</message>
<message name="GetREJobRunResponse">
<part element="types:GetREJobRunOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:REJobRunInfo" />
BMC Atrium Core 9.0
Page 1873 of 2268
Home

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobRunId
extensions
Return value
jobRunInfo
status
extensions
Fault message
Fault message
See Fault message.
GetREJobRunEvent function
Finds reconciliation engine job events that meet the specified criteria.
Namespace
WSDL operation
<operation name="GetREJobRunEvent" parameterOrder="inargs">
<input message="tns:GetREJobRunEventRequest" name="GetREJobRunEventRequest"/>
<output message="tns:GetREJobRunEventResponse" name="GetREJobRunEventResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1874 of 2268
Home
WSDL messages
<message name="GetREJobRunEventRequest">
<part element="types:GetREJobRunEvent" name="inargs"/>
</message>
<message name="GetREJobRunEventResponse">
<part element="types:GetREJobRunEventOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetREJobRunEvent">
<complexType>
<sequence>
nillable="true" />
<element name="jobRunEventId" type="string" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetREJobRunEventOutput">
<complexType>
<sequence>
<element name="jobRunEvent" type="tns:REJobRunEvent" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
BMC Atrium Core 9.0
Page 1875 of 2268
Home
jobRunEventId
The identifier that you want to use to limit the return results.
extensions
Return value
jobRunEvent
See REJobRunEvent.
status
extensions
Fault message
See Fault message.
Fault message
GetREJobRunEventList function
Finds reconciliation job events that meet the specified criteria.
Namespace
WSDL operation
<operation name="GetREJobRunEventList" parameterOrder="inargs">
<input message="tns:GetREJobRunEventListRequest"
name="GetREJobRunEventListRequest"/>
<output message="tns:GetREJobRunEventListResponse"
name="GetREJobRunEventListResponse"/>
</operation>
WSDL messages
<message name="GetREJobRunEventListRequest">
<part element="types:GetREJobRunEventList" name="inargs"/>
</message>
<message name="GetREJobRunEventListResponse">
<part element="types:GetREJobRunEventListOutput"
name="outargs"/>
</message>
</message>
XSD schema
<element name="GetREJobRunEventList">
BMC Atrium Core 9.0
Page 1876 of 2268
Home
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetREJobRunEventListOutput">
<complexType>
<sequence>
<element name="jobRunEventList"
type="tns:REJobRunEventList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobRunId
extensions
Return value
jobRunEventList
See REJobRunEventList.
status
extensions
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1877 of 2268
Home
GetREJobRunList function
Finds reconciliation engine jobs that meet the specified criteria.
Namespace
WSDL operation
<operation name="GetREJobRunList" parameterOrder="inargs">
<input message="tns:GetREJobRunListRequest"
name="GetREJobRunListRequest"/>
<output message="tns:GetREJobRunListResponse"
name="GetREJobRunListResponse"/>
</operation>
WSDL messages
<message name="GetREJobRunListRequest">
<part element="types:GetREJobRunList" name="inargs"/>
</message>
<message name="GetREJobRunListResponse">
<part element="types:GetREJobRunListOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
<element name="numMatch" type="int" nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="jobRunInfo" type="tns:REJobRunInfoList" />
BMC Atrium Core 9.0
Page 1878 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
qualifier
String value that limits the set of data returned.
numMatch
Integer value that specifies the number of results to return.
extensions
Return value
jobRunInfo
status
extensions
Fault message
Fault message
See Fault message.
GetRelatedFederatedInContext function
Returns related FederatedInterface instances for a specific CI (context).
Namespace
WSDL operation
<operation name="GetRelatedFederatedInContext"
<input message="tns:GetRelatedFederatedInContextRequest"
name="GetRelatedFederatedInContextRequest"/>
<output message="tns:GetRelatedFederatedInContextResponse"
name="GetRelatedFederatedInContextResponse"/>
BMC Atrium Core 9.0
Page 1879 of 2268
Home
</operation>
WSDL messages
<message name="GetRelatedFederatedInContextRequest">
<part element="types:GetRelatedFederatedInContext"
name="inargs"/>
/message>
<message name="GetRelatedFederatedInContextResponse">
<part element="types:GetRelatedFederatedInContextOutput"
name="outargs"/>
/message>
</message>
XSD schema
<element name="GetRelatedFederatedInContext">
<complexType>
<sequence>
<element name="instanceId"type="string" />
</sequence>
</complexType>
</element>
<element name="GetRelatedFederatedInContextOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
BMC Atrium Core 9.0
Page 1880 of 2268
Home
</choice>
</complexType>
</element>
Input arguments
loginInfo
classNameId
The class from which the instances are to be retrieved. It is a two-part structure that contains the namespace
datasetId
instanceId
attributeNames
See StringArray.
extensions
Return value
instanceInfo
A list of instance information. See InstanceInfoOutList.
status
extensions
Fault message
See Fault message.
Fault message
GetRelatedServices function
Retrieves a list of related services.
Namespace
WSDL operation
<operation name="GetRelatedServices" parameterOrder="inargs">
<input message="tns:GetRelatedServicesRequest"
name="GetRelatedServicesRequest"/>
<output message="tns:GetRelatedServicesResponse"
name="GetRelatedServicesResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1881 of 2268
Home
WSDL messages
<message name="GetRelatedServicesRequest">
<part element="types:GetRelatedServices" name="inargs"/>
</message>
<message name="GetRelatedServicesResponse">
<part element="types:GetRelatedServicesOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetRelatedServices">
<complexType>
<sequence>
nillable="true" />
name="attributesToInclude" type="string"/>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetRelatedServicesOutput">
<complexType>
<sequence>
<element name="instanceList"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
BMC Atrium Core 9.0
Page 1882 of 2268
Home
</complexType>
</element>
Input arguments
loginInfo
instanceId
classNameId
The name of the class. See ClassNameId.
datasetInfo
Information about the dataset.
attributesToInclude
List of attributes you want included in the retrieved results.
extensions
Return values
datasetInfo
Returns information about the dataset.
instanceList
List of instances.
status
extensions
Fault message
Fault message
See Fault message.
GetSavedQuery function (query_bypath)

Retrieves a saved query.
Namespace
http://atrium.bmc.com/2011/02/query
WSDL operation
<operation name="GetSavedQuery" parameterOrder="inargs">
<input message="tns:GetSavedQueryRequest"
name="GetSavedQueryRequest"/>
<output message="tns:GetSavedQueryResponse"
name="GetSavedQueryResponse"/>
</operation>
WSDL messages
<message name="GetSavedQueryRequest">
<part element="types:GetSavedQuery" name="inargs"/>
BMC Atrium Core 9.0
Page 1883 of 2268
Home
</message>
<message name="GetSavedQueryResponse">
<part element="types:GetSavedQueryOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
Input arguments
loginInfo
queryName
extensions
Return values
savedQueryData
status
extensions
Fault message
BMC Atrium Core 9.0
Page 1884 of 2268
Home
See Fault message.
Fault message
GetSavedQuery function (atrium_graphquery)

http://atrium.bmc.com/2010/07/graphquery/types
Namespace
WSDL operation
<wsdl:operation name="GetSavedQuery" parameterOrder="inargs">
<wsdl:input name="GetSavedQueryRequest"
message="tns:GetSavedQueryRequest">
</wsdl:input>
<wsdl:output name="GetSavedQueryResponse"
message="tns:GetSavedQueryResponse">
</wsdl:output>
<wsdl:fault name="AtriumFault" message="tns:AtriumFault">
</wsdl:fault>
</wsdl:operation>
WSDL messages
</message>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1885 of 2268
Home
<complexType>
<sequence>
<element name="savedQueryData" nillable="true"
type="tns:SavedGraphQuery"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
queryName
extensions
Return values
savedQueryData
status
extensions
Fault message
Fault message
See Fault message.
GetSavedQuery function (atrium_query)

Namespace
WSDL operation
<operation name="GetSavedQuery" parameterOrder="inargs">
<input message="tns:GetSavedQueryRequest"
BMC Atrium Core 9.0
Page 1886 of 2268
Home
name="GetSavedQueryRequest"/>
<output message="tns:GetSavedQueryResponse"
name="GetSavedQueryResponse"/>
</operation>
WSDL messages
</message>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
BMC Atrium Core 9.0
Page 1887 of 2268
Home
</element>
Input arguments
loginInfo
instanceId
extensions
Return values
savedQueryData
See SavedQueryData.
status
extensions
Fault message
Fault message
See Fault message.
GetUIComponents function
Retrieves a list of UI components.
Namespace
WSDL operation
<operation name="GetUIComponents" parameterOrder="inargs">
<input message="tns:GetUIComponentsRequest"
name="GetUIComponentsRequest"/>
<output message="tns:GetUIComponentsResponse"
name="GetUIComponentsResponse"/>
</operation>
WSDL messages
<message name="GetUIComponentsRequest">
<part element="types:GetUIComponents" name="inargs"/>
</message>
<message name="GetUIComponentsResponse">
<part element="types:GetUIComponentsOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1888 of 2268
Home
XSD schema
<element name="GetUIComponents">
<complexType>
<sequence>
type="common:LoginInfo"
nillable="true" />
<element name="componentInfo"
type="tns:UIComponentInfo" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetUIComponentsOutput">
<complexType>
<sequence>
<element name="uiComponentResultList"
type="tns:UIComponentResultList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
componentInfo
Contains the component information for the specific instance.
datasetId
instanceId
The ID of the instance.
BMC Atrium Core 9.0
Page 1889 of 2268
Home
extensions
Return values
uiComponentResultList
Holds the returned information about the UI components.
status
extensions
Fault message
See Fault message.
Fault message
GetVersions function
Retrieves the version of the application specified.
Namespace
WSDL operation
<operation name="GetVersions" parameterOrder="inargs">
<input message="tns:GetVersionsRequest"
name="GetVersionsRequest"/>
<output message="tns:GetVersionsResponse"
name="GetVersionsResponse"/>
</operation>
WSDL messages
<message name="GetVersionsRequest">
<part element="types:GetVersions" name="inargs"/>
</message>
<message name="GetVersionsResponse">
<part element="types:GetVersionsOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="GetVersions">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1890 of 2268
Home

nillable="true" />
<element name="appIdList" type="common:StringArray" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="GetVersionsOutput">
<complexType>
<sequence>
<element name="versionInfoList"
type="tns:VersionInfoList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
appIdList
List of application IDs.
extensions
Return values
versionInfoList
Holds a list of version information elements for the BMC Atrium Core components.
status
extensions
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1891 of 2268
Home
GraphQuery function
Retrieves a list of instances for the specified qualifications.
Namespace
WSDL operation
<operation name="GraphQuery" parameterOrder="inargs">
<input message="tns:GraphQueryRequest" name="GraphQueryRequest"/>
<output message="tns:GraphQueryResponse"
name="GraphQueryResponse"/>
</operation>
WSDL messages
<message name="GraphQueryRequest">
<part element="types:GraphQuery" name="inargs"/>
</message>
<message name="GraphQueryResponse">
<part element="types:GraphQueryOutput" name="outargs"/>
</message>
</operation>
XSD schema
<element name="GraphQuery">
<complexType>
<sequence>
<element name="graphQuery" type="tns:GraphQueryInput"/>
type="tns:QueryResultGraphFormat"/>
</sequence>
</complexType>
</element>
<element name="GraphQueryOutput">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1892 of 2268
Home
<element name="queryResult" type="tns:GraphQueryOutput"
nillable="true" />

</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
198.
graphQuery
Indicates the path that needs to be queried to return the wanted CIs and relationships. See GraphQueryInput.
datasetId
parameter.
datasetMask
firstRetrieve
maxRetrieve
The number of levels to traverse in the specified queryGraph. The value A-1 specifies the query to traverse to the
end of the graph.
formatType
See GraphQueryOutput.
status
See StatusList.
extensions
query graph contains the same CI class more than once and needs to distinguish one from another.See
ExtensionList.
Return value
queryResult
List of one or more CI instances matching the specified criteria. The starting node is not included.
status
extensions
BMC Atrium Core 9.0
Page 1893 of 2268
Home
Fault message
Fault message
ImportNEConfiguration function
Imports normalization engine configuration information.
Namespace
WSDL operation
<operation name="ImportNEConfiguration" parameterOrder="inargs">
<input message="tns:ImportNEConfigurationRequest"
name="ImportNEConfigurationRequest"/>
<output message="tns:ImportNEConfigurationResponse"
name="ImportNEConfigurationResponse"/>
</operation>
WSDL messages
<message name="ImportNEConfigurationRequest">
<part element="types:ImportNEConfiguration" name="inargs"/>
</message>
<message name="ImportNEConfigurationResponse">
<part element="types:ImportNEConfigurationOutput"
name="outargs"/>
</message>
</message>
XSD schema
<element name="ImportNEConfiguration">
<complexType>
<sequence>
nillable="true" />
<element name="importOption"
type="tns:NEImportOptionType" />
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1894 of 2268
Home
</element>
<element name="ImportNEConfigurationOutput">
<complexType>
<sequence>
<element name="duplicateEntryGuids"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
xml
Any valid XML code.
importOption
See NEImportOptionType.
extensions
Return values
duplicateEntryGuids
A Globally Unique Identifier (GUID) that has been specified one or more times.
status
extensions
Fault message
Fault message
See Fault message.
ListClasses function
Retrieves relationship classes whose relatedClass parameter contains the specified class, and
information about those classes.
Namespace
BMC Atrium Core 9.0
Page 1895 of 2268
Home
WSDL operation
<operation name="ListClasses" parameterOrder="inargs">
<input message="tns:ListClassesRequest"
name="ListClassesRequest"/>
<output message="tns:ListClassesResponse"
name="ListClassesResponse"/>
</operation>
WSDL messages
<message name="ListClassesRequest">
<part element="types:ListClasses" name="inargs"/>
</message>
<message name="ListClassesResponse">
<part element="types:ListClassesOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="ListClasses">
<complexType>
<sequence>
<element name="namespace" type="string" nillable="true"/>
<element name="relatedClass" type="common:ClassNameId"
nillable="true"/>
<element name="superClass" type="common:ClassNameId"
nillable="true"/>
<element name="propInfo" type="common:PropInfoList"
nillable="true"/>
<element name="getHidden" type="boolean"/>
nillable="true" />
</sequence>
</complexType>
</element>
<element name="ListClassesOutput">
<complexType>
<sequence>
<element name="classList" type="common:ClassNameIdList"/>
type="common:StatusList"/>
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1896 of 2268
Home
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
namespace
The name of the namespace to which the class belongs. Namespaces are a way of partitioning your data model to
create logical groups of classes.
relatedClass
Specifies the class to which the returned classes must be related.
superClass
Specifies the class from which the returned classes must be derived.
propInfo
Specifies the properties that the returned classes must match.
getHidden
Specifies whether to return hidden classes. Valid values are "true" or "1" for true values, and "false" or "0" for false
values.
extensions
Return values
classList
A list of class names that match the criteria specified in the input parameters.
status
extensions
Fault message
Fault message
See Fault message.
ListDatasets function
Retrieves information about multiple datasets.
Namespace
WSDL operation
<operation name="ListDatasets" parameterOrder="inargs">
<input message="tns:ListDatasetsRequest"
BMC Atrium Core 9.0
Page 1897 of 2268
Home
name="ListDatasetsRequest"/>
<output message="tns:ListDatasetsResponse"
name="ListDatasetsResponse"/>
</operation>
WSDL messages
<message name="ListDatasetsRequest">
<part element="types:ListDatasets" name="inargs"/>
</message>
<message name="ListDatasetsResponse">
<part element="types:ListDatasetsOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="ListDatasets">
<complexType>
<sequence>
<element name="coreDatasetId" type="string"
nillable="true" />
nillable="true" />
<element name="datasetType" type="tns:DatasetType"
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="ListDatasetsOutput">
<complexType>
<sequence>
<element name="datasetInfo" type="tns:DatasetInfoList"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
BMC Atrium Core 9.0
Page 1898 of 2268
Home
</choice>
</complexType>
</element>
Input arguments
lang
coreDatasetId
, semicolon (
, or comma (,). If
you do not provide an ID, the system generates a GUID to use for this ID. The dataset ID cannot be changed
after the dataset is created.
sourceDatasetId
The source dataset ID for an Overlay type of dataset.
datasetType
The type of dataset, Regular or Overlay. See DatasetType.
extensions
Return values
datasetInfo
Information retrieved about the dataset, such as Dataset ID, Dataset Name, Accessibility, Source Dataset ID,
ClientTypeList, Instance ID, and Description.
status
extensions
Fault message
Fault message
See Fault message.
ListSavedQueries function (query_bypath)

Retrieves a list of saved queries.
Namespace
WSDL operation
<operation name="ListSavedQueries" parameterOrder="inargs">
<input message="tns:ListSavedQueriesRequest"
name="ListSavedQueriesRequest"/>
<output message="tns:ListSavedQueriesResponse"
name="ListSavedQueriesResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1899 of 2268
Home
WSDL messages
<message name="ListSavedQueriesRequest">
<part element="types:ListSavedQueries" name="inargs"/>
</message>
<message name="ListSavedQueriesResponse">
<part element="types:ListSavedQueriesOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1900 of 2268
Home
loginInfo
extensions
characteristics
See PropertyList.
Return values
savedQueriesInfo
status
extensions
Fault message
Fault message
See Fault message.
ListSavedQueries function (atrium_graphquery)

Namespace
WSDL operation
</operation>
WSDL messages
</message>
</message>
</message>
BMC Atrium Core 9.0
Page 1901 of 2268
Home
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="savedQueryRefList"
type="tns:SavedQueryRefList"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
extensions
characteristics
See PropertyList.
Return values
savedQueriesInfo
status
BMC Atrium Core 9.0
Page 1902 of 2268
Home
extensions
Fault message
See Fault message.
Fault message
ListSavedQueries function (atrium_query)

Namespace
WSDL operation
</operation>
WSDL messages
</message>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1903 of 2268
Home
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
extensions
Return values
savedQueriesInfo
See SavedQueryData.
status
extensions
Fault message
Fault message
See Fault message.
LoadDefaultCMDBfConfiguration
Restores the default BMC Atrium CMDB configuration for CMDBf queries. The current configuration
is not saved. To be able to restore to your custom configuration, you should use
GetCMDBfConfiguration to retrieve the current settings.
Namespace
WSDL operation
<wsdl:operation name="LoadDefaultCMDBfConfiguration">
BMC Atrium Core 9.0
Page 1904 of 2268
Home
<soap:operation soapAction="LoadDefaultCMDBfConfiguration"
style="document"/>
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
</wsdl:fault>
</wsdl:operation>
</wsdl:operation>
WSDL messages
<message name="LoadDefaultCMDBfConfigurationRequest">
<part element="types:LoadDefaultCMDBfConfiguration"
name="inargs" />
</message>
<message name="LoadDefaultCMDBfConfigurationResponse">
</message>
XSD schema
<element name="LoadDefaultCMDBfConfiguration">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
Input arguments
loginInfo
extensions
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1905 of 2268
Home
NormalizeInstanceList function
Allows for the creation of a list of normalized instances.
Namespace
WSDL operation
<operation name="NormalizeInstanceList" parameterOrder="inargs">
<input message="tns:NormalizeInstanceListRequest"
name="NormalizeInstanceListRequest"/>
<output message="tns:NormalizeInstanceListResponse"
name="NormalizeInstanceListResponse"/>
</operation>
WSDL messages
<message name="NormalizeInstanceListRequest">
<part element="types:NormalizeInstanceList" name="inargs"/>
</message>
<message name="NormalizeInstanceListResponse">
</message>
</message>
XSD schema
<element name="NormalizeInstanceList">
<complexType>
<sequence>
nillable="true" />
<element name="instanceIdList"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="status"type="tns:StatusList" />
BMC Atrium Core 9.0
Page 1906 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
classNameId
ClassNameId.
instanceIdList
See StringArray.
extensions
Return value
status
extensions
Fault message
Fault message
See Fault message.
PauseREJobRun function
Pauses reconciliation jobs.
Namespace
WSDL operation
<operation name="PauseREJobRun" parameterOrder="inargs">
<input message="tns:PauseREJobRunRequest"
name="PauseREJobRunRequest"/>
<output message="tns:PauseREJobRunResponse"
name="PauseREJobRunResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1907 of 2268
Home
WSDL messages
<message name="PauseREJobRunRequest">
<part element="types:PauseREJobRun" name="inargs"/>
</message>
<message name="PauseREJobRunResponse">
</message>
</message>
XSD schema
<element name="PauseREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
BMC Atrium Core 9.0
Page 1908 of 2268
Home
jobRunId
extensions
Return value
status
extensions
Fault message
See Fault message.
Fault message
PropertyFileFormat function
Defines the configuration properties.
Namespace
WSDL operation
<operation name="PropertyFileFormat" parameterOrder="inargs">
<input message="tns:PropertyFileFormatRequest"
name="PropertyFileFormatRequest"/>
</operation>
WSDL message
<message name="PropertyFileFormatRequest">
<part element="types:PropertyFileFormat" name="inargs"/>
</message>
XSD schema
<element name="PropertyFileFormat">
<complexType>
<sequence>
type="config:ConfigPropertyList" />
</sequence>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1909 of 2268
Home
properties
List of configuration properties.
PullGraphWalkResults function
Retrieve results from the graph walk query.
Namespace
WSDL operation
<operation name="PullGraphWalkResults" parameterOrder="inargs">
<input message="tns:PullGraphWalkResultsRequest"
name="PullGraphWalkResultsRequest"/>
<output message="tns:PullGraphWalkResultsResponse"
name="PullGraphWalkResultsResponse"/>
</operation>
WSDL messages
<message name="PullGraphWalkResultsRequest">
<part element="types:PullGraphWalkResults" name="inargs"/>
</message>
<message name="PullGraphWalkResultsResponse">
<part element="types:PullGraphWalkResultsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<element name="PullGraphWalkResults">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="PullGraphWalkResultsOutput">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1910 of 2268
Home
<element name="results" type="tns:GraphWalkResult" />

nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
contextId
extensions
Return value
results
A list of objects and their relationships.
expiration
See ExpirationOut.
hasNext
status
extensions
Fault message
Fault message
See Fault message.
QueryBusinessObjects function
Namespace
BMC Atrium Core 9.0
Page 1911 of 2268
Home
WSDL operation
</element>
<operation name="QueryBusinessObjects" parameterOrder="inargs">
<input message="tns:QueryBusinessObjectsRequest"
name="QueryBusinessObjectsRequest"/>
<output message="tns:QueryBusinessObjectsResponse"
name="QueryBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="QueryBusinessObjectsRequest">
<part element="types:QueryBusinessObjects" name="inargs"/>
</message>
<message name="QueryBusinessObjectsResponse">
<part element="types:QueryBusinessObjectsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="query" type="query:Query"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1912 of 2268
Home
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
query
and any combination of conditional, relational, and arithmetic operations. See SavedQueryInfo.
extensions
Return values
businessObjectList
status
extensions
Fault message
Fault message
See Fault message.
QueryBusinessObject function (deprecated)

Note
This function and its service are deprecated but supported. See QueryBusinessObjects.
Namespace
BMC Atrium Core 9.0
Page 1913 of 2268
Home
WSDL operation
<operation name="QueryBusinessObjects" parameterOrder="inargs">
<input message="tns:QueryBusinessObjectsRequest"
name="QueryBusinessObjectsRequest"/>
<output message="tns:QueryBusinessObjectsResponse"
name="QueryBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="QueryBusinessObjectsRequest">
<part element="types:QueryBusinessObjects" name="inargs"/>
</message>
<message name="QueryBusinessObjectsResponse">
<part element="types:QueryBusinessObjectsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
BMC Atrium Core 9.0
Page 1914 of 2268
Home
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
query
extensions
Return values
businessObjectList
status
extensions
Fault message
Fault message
See Fault message.
QueryBusinessObjectRefs function
Finds business object references.
Namespace
WSDL operation
<operation name="QueryBusinessObjectRefs" parameterOrder="inargs">
<input message="tns:QueryBusinessObjectRefsRequest"
name="QueryBusinessObjectRefsRequest"/>
<output message="tns:QueryBusinessObjectRefsResponse"
name="QueryBusinessObjectRefsResponse"/>
BMC Atrium Core 9.0
Page 1915 of 2268
Home
</operation>
WSDL messages
<message name="QueryBusinessObjectRefsRequest">
<part element="types:QueryBusinessObjectRefs" name="inargs"/>
</message>
<message name="QueryBusinessObjectRefsResponse">
<part element="types:QueryBusinessObjectRefsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="query" type="query:Query"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="boRefList" type="tns:BORefList"/>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1916 of 2268
Home
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
query
extensions
Return values
boRefList
See BORefList.
status
extensions
Fault message
See Fault message.
Fault message
QueryBusinessObjectRefs function (deprecated)

Finds business object references.
Note
QueryBusinessObjectRefs.
Namespace
WSDL operation
<operation name="QueryBusinessObjectRefs" parameterOrder="inargs">
<input message="tns:QueryBusinessObjectRefsRequest"
name="QueryBusinessObjectRefsRequest"/>
<output message="tns:QueryBusinessObjectRefsResponse"
name="QueryBusinessObjectRefsResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1917 of 2268
Home
WSDL messages
<message name="QueryBusinessObjectRefsRequest">
<part element="types:QueryBusinessObjectRefs" name="inargs"/>
</message>
<message name="QueryBusinessObjectRefsResponse">
<part element="types:QueryBusinessObjectRefsOutput"
name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1918 of 2268
Home
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
query
extensions
Return values
boRefList
See BORefList.
status
extensions
Fault message
Fault message
See Fault message.
QueryByPath function (query_bypath)

Retrieves a list of instances for the specified qualifications. To improve the performance of the
queries, add indexes in the query qualifier. You must create indexes on only those attributes that
are frequently used in the query qualifier because adding indexes incur some amount of overhead.
Namespace
WSDL operation
<operation name="QueryByPath" parameterOrder="inargs">
<input message="tns:QueryByPathRequest"
name="QueryByPathRequest"/>
<output message="tns:QueryByPathResponse"
name="QueryByPathResponse"/>
</operation>
WSDL messages
<message name="QueryByPathRequest">
<part element="types:QueryByPath" name="inargs"/>
</message>
<message name="QueryByPathResponse">
BMC Atrium Core 9.0
Page 1919 of 2268
Home
</message>
</message>
XSD schema
<element name="QueryByPath">
<complexType>
<sequence>
<element name="loginInfo" nillable="true" type="common:LoginInfo"/>
<element name="input" type="tns:Query"/>
<element name="extensions" nillable="true" type="common:ExtensionList"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="extensions" nillable="true" type="common:ExtensionList"/>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
input
See QueryByPathInput.
executeOption
See SavedQueryInfo.
Return values
queryResult
status
extensions
Fault message
BMC Atrium Core 9.0
Page 1920 of 2268
Home
See Fault message.
Fault message
QueryByPath function
Retrieves a list of instances for the specified qualifications. To improve the performance of the
queries, add indexes in the query qualifier. You must create indexes on only those attributes that
are frequently used in the query qualifier because adding indexes incur some amount of overhead.
Namespace
WSDL operation
<operation name="QueryByPath" parameterOrder="inargs">
<input message="tns:QueryByPathRequest"
name="QueryByPathRequest"/>
<output message="tns:QueryByPathResponse"
name="QueryByPathResponse"/>
</operation>
WSDL messages
<message name="QueryByPathRequest">
<part element="types:QueryByPath" name="inargs"/>
</message>
</message>
</message>
XSD schema
<element name="QueryByPath" type="tns:QueryByPath"/>
<complexType name="QueryByPath">
<sequence>
<element name="input" type="tns:QueryByPathInput"/>
<element name="executeOption" type="tns:QueryExecuteOption"/>
</sequence>
</complexType>
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1921 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
input
executeOption
See SavedQueryInfo.
Return values
queryResult
status
extensions
Fault message
Fault message
See Fault message.
QueryByPathXML function
Use XML to represent the query.
Namespace
WSDL operation
<wsdl:operation name="QueryByPathXML">
<soap:operation soapAction="QueryByPath" style="document"/>
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
BMC Atrium Core 9.0
Page 1922 of 2268
Home
</wsdl:fault>
</wsdl:operation>
WSDL messages
<message name="QueryByPathXMLRequest">
<part element="types:QueryByPathXML" name="inargs"/>
</message>
</message>
</message>
XSD schema
<element name="QueryByPathXML" type="tns:QueryByPathXML">
<complexType name="QueryByPathXML">
<sequence>
<element name="input" type="tns:QueryByPathXMLInput"/>
<element name="executeOption"
type="tns:QueryExecuteOption"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
BMC Atrium Core 9.0
Page 1923 of 2268
Home
</complexType>
</element>
Input arguments
loginInfo
See LoginInfo.
input
executeOption
See SavedQueryInfo.
extensions
See ExtensionList.
Return values
queryResult
status
extensions
Fault message
See Fault message.
Fault message
RenewGraphWalk function
Sets a new expiration duration for a graph walk operation.
Namespace
WSDL operation
<operation name="RenewGraphWalk" parameterOrder="inargs">
<input message="tns:RenewGraphWalkRequest"
name="RenewGraphWalkRequest"/>
<output message="tns:RenewGraphWalkResponse"
name="RenewGraphWalkResponse"/>
</operation>
WSDL messages
<message name="RenewGraphWalkRequest">
<part element="types:RenewGraphWalk" name="inargs"/>
</message>
<message name="RenewGraphWalkResponse">
<part element="types:RenewGraphWalkOutput" name="outargs"/>
</message>
BMC Atrium Core 9.0
Page 1924 of 2268
Home
</message>
XSD schema
<element name="RenewGraphWalk">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="RenewGraphWalkOutput">
<complexType>
<sequence>
<element
<element
<element
<element
name="expiration" type="common:ExpirationOut" />

name="hasNext" type="boolean" />
name="status" type="common:StatusList" />
name="extensions" type="common:ExtensionList"
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
contextId
expiration
See ExpirationIn.
extensions
BMC Atrium Core 9.0
Page 1925 of 2268
Home
Return value
expiration
See ExpirationOut.
hasNext
status
extensions
Fault message
See Fault message.
Fault message
ResumeNEJobRun function
Resumes execution of a specific normalization engine job.
Namespace
WSDL operation
<operation name="ResumeNEJobRun" parameterOrder="inargs">
<input message="tns:ResumeNEJobRunRequest"
name="ResumeNEJobRunRequest"/>
<output message="tns:ResumeNEJobRunResponse"
name="ResumeNEJobRunResponse"/>
</operation>
WSDL messages
<message name="ResumeNEJobRunRequest">
<part element="types:ResumeNEJobRun" name="inargs"/>
</message>
<message name="ResumeNEJobRunResponse">
<part element="types:ResumeNEJobRunOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="ResumeNEJobRun">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1926 of 2268
Home

nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<element name="ResumeNEJobRunOutput">
<complexType>
<sequence>
<element name="status"type="common:StatusList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobName
extensions
Return value
jobRunId
status
extensions
Fault message
Fault message
See Fault message.
ResumeREJobRun function
Restarts paused reconciliation engine jobs.
BMC Atrium Core 9.0
Page 1927 of 2268
Home
Namespace
WSDL operation
<operation name="ResumeREJobRun" parameterOrder="inargs">
<input message="tns:ResumeREJobRunRequest"
name="ResumeREJobRunRequest"/>
<output message="tns:ResumeREJobRunResponse"
name="ResumeREJobRunResponse"/>
</operation>
<message name="ResumeREJobRunRequest">
<part element="types:ResumeREJobRun" name="inargs"/>
WSDL messages
</message>
<message name="ResumeREJobRunResponse">
</message>
</message>
XSD schema
<element name="ResumeREJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
BMC Atrium Core 9.0
Page 1928 of 2268
Home
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobRunId
extensions
Return value
status
extensions
Fault message
Fault message
See Fault message.
SetAttribute function
Sets or creates a specified attribute to the specified properties. If the attribute does not exist, it is
created. If the attribute exists, it is updated with the specified settings.
Namespace
WSDL operation
<operation name="SetAttribute" parameterOrder="inargs">
<input message="tns:SetAttributeRequest"
name="SetAttributeRequest"/>
<output message="tns:SetAttributeResponse"
name="SetAttributeResponse"/>
</operation>
WSDL messages
<message name="SetAttributeRequest">
<part element="types:SetAttribute" name="inargs"/>
BMC Atrium Core 9.0
Page 1929 of 2268
Home
</message>
<message name="SetAttributeResponse">
</message>
</message>
XSD schema
<element name="SetAttribute">
<complexType>
<sequence>
<element name="newAttributeName" type="string"
nillable="true" />
type="common:AttributeInfoIn" nillable="true"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class must be unique to the namespace. See ClassNameId.
attributeName
The name of the attribute to set.
BMC Atrium Core 9.0
Page 1930 of 2268
Home
newAttributeName
The new name of the attribute, which must be unique within the specified class and within its superclasses
and subclasses.
attributeInfo
extensions
Return values
status
Fault message
See Fault message.
Fault message
SetBusinessObject function
Sets the business object name.
Namespace
WSDL operation
<operation name="SetBusinessObject" parameterOrder="inargs">
<input message="tns:SetBusinessObjectRequest"
name="SetBusinessObjectRequest"/>
<output message="tns:SetBusinessObjectResponse"
name="SetBusinessObjectResponse"/>
</operation>
WSDL messages
<message name="SetBusinessObjectRequest">
<part element="types:SetBusinessObject" name="inargs"/>
</message>
<message name="SetBusinessObjectResponse">
<part element="types:SetBusinessObject" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
BMC Atrium Core 9.0
Page 1931 of 2268
Home
<sequence>
<element name="createRelatedBO" nillable="true"
type="boolean"/>
<element name="ignoreNilledElements" nillable="true"
type="boolean"/>
</sequence>
</complexType>
</element>
<complexType>
<sequence>
<element name="businessObject" nillable="true"
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObject
createRelatedBO
Valid values are "true" or "1" for true values, and "false" or "0" for false values..
ignoreNilledElements
Set whether to ignore elements with no values.
extensions
BMC Atrium Core 9.0
Page 1932 of 2268
Home
Return values
businessObject
status
extensions
Fault message
Fault message
See Fault message.
SetBusinessObject function (deprecated)

Sets the business object name.
Note
SetMultipleBusinessObjects.
Namespace
WSDL operation
<operation name="SetBusinessObject" parameterOrder="inargs">
<input message="tns:SetBusinessObjectRequest"
name="SetBusinessObjectRequest"/>
<output message="tns:SetBusinessObjectResponse"
name="SetBusinessObjectResponse"/>
</operation>
WSDL messages
<message name="SetBusinessObjectRequest">
<part element="types:SetBusinessObject" name="inargs"/>
</message>
<message name="SetBusinessObjectResponse">
<part element="types:SetBusinessObject" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1933 of 2268
Home
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObject
See BusinessObject.
createRelatedBO
extensions
BMC Atrium Core 9.0
Page 1934 of 2268
Home
Return values
businessObject
See BusinessObject.
status
extensions
Fault message
See Fault message.
Fault message
SetClass function
Sets or creates a specified class with the specified properties. If the class does not exist, it is
created. If the class exists, it is updated with the specified settings.
Namespace
WSDL operation
<operation name="SetClass" parameterOrder="inargs">
<input message="tns:SetClassRequest"
name="SetClassRequest"/>
<output message="tns:SetClassResponse"
name="SetClassResponse"/>
</operation>
WSDL messages
<message name="SetClassRequest">
<part element="types:SetClass" name="inargs"/>
</message>
<message name="SetClassResponse">
</message>
</message>
XSD schema
<element name="SetClass">
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1935 of 2268
Home

<element name="newClassNameId" type="common:ClassNameId"
nillable="true" />
<element name="classInfo" type="common:ClassInfoIn"
nillable="true" />
nillable="true" />
/sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
classNameId
The name of the class. It is a two-part structure that contains the namespace name and the class name. The
name of the class must be unique to the namespace. See ClassNameId.
newClassNameId
The new name for the class. Specify NULL for this parameter if there is no superclass. See ClassNameId.
classInfo
Class information, see ClassInfoIn.
extensions
Return value
status
Fault message
Fault message
See Fault message.
BMC Atrium Core 9.0
Page 1936 of 2268
Home
SetDataset function
Sets or creates dataset with the specified properties. If the dataset does not exist, it is created. If
the dataset exists, it is updated with the specified settings.
Namespace
WSDL operation
<operation name="SetDataset" parameterOrder="inargs">
<input message="tns:SetDatasetRequest"
name="SetDatasetRequest"/>
<output message="tns:SetDatasetResponse"
name="SetDatasetResponse"/>
</operation>
WSDL messages
<message name="SetDatasetRequest">
<part element="types:SetDataset" name="inargs"/>
</message>
<message name="SetDatasetResponse">
</message>
</message>
XSD schema
<element name="SetDataset">
<complexType>
<sequence>
<element name="instanceId" type="string"
nillable="true" />
<element name="datasetName" type="string"
nillable="true" />
nillable="true" />
<element name="datasetType" type="tns:DatasetType"
nillable="true" />
<element name="accessibility" type="tns:DatasetAccessType"
nillable="true" />
<element name="clientTypeList"
BMC Atrium Core 9.0
Page 1937 of 2268
Home
type="common:ArrayOf_String" nillable="true" />

nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
coreDatasetId
, semicolon (
, or comma (,). If
you do not provide an ID, the system generates a GUID to use for this ID. The dataset ID cannot be changed
after the dataset is created.
instanceId
datasetName
The unique name for the dataset. The dataset name cannot be changed after the dataset is created.
description
The description of the dataset.
datasetType
The type of dataset, Regular or Overlay. See DatasetType.
accessibility
The level of accessibility for the dataset: Writable, Read-Only, or Writable by client only. This refers to whether
instances can be created, modified, and deleted in the dataset. See DatasetAccessType (datasets).
clientTypeList
The client IDs of each BMC Atrium CMDB client that can write to this dataset for the Writable by client only
accessibility option. To allow all clients to write to this dataset, specify a NULL value in this argument. If you
specify any IDs here, only those clients can create, modify, or delete instances in the dataset. Client IDs are
integer values, and must be delimited by semicolons. For more information about the allowable values for this
parameter, see the BMC Atrium Core 7.6.03 Installation Guide.
sourceDatasetId
The source dataset ID for an Overlay type of dataset.
extensions
Return values
BMC Atrium Core 9.0
Page 1938 of 2268
Home
status
Fault message
See Fault message.
Fault message
SetInstance function
Sets a CI or relationship instance of a class with the specified properties. If the CI or relationship
instance of a class exists, it is updated with the specified settings.
Namespace
WSDL operation
<operation name="SetInstance" parameterOrder="inargs">
<input message="tns:SetInstanceRequest"
name="SetInstanceRequest"/>
<output message="tns:SetInstanceResponse"
name="SetInstanceResponse"/>
</operation>
WSDL messages
<message name="SetInstanceRequest">
<part element="types:SetInstance" name="inargs"/>
</message>
<message name="SetInstanceResponse">
</message>
</message>
XSD schema
<element name="SetInstance">
<complexType>
<sequence>
type="common:SetInstanceInfoIn" />
nillable="true" />
BMC Atrium Core 9.0
Page 1939 of 2268
Home
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
lang
DatasetId
parameter.
instanceInfo
A list of instances. See SetInstanceInfoIn.
extensions
Return values
status
Fault message
Fault message
See Fault message.
SetMultipleBusinessObjects function
Sets several business object names.
Namespace
WSDL operation
<operation name="SetMultipleBusinessObjects" parameterOrder="inargs">
<input message="tns:SetMultipleBusinessObjectsRequest"
BMC Atrium Core 9.0
Page 1940 of 2268
Home
name="SetMultipleBusinessObjectsRequest"/>
<output message="tns:SetMultipleBusinessObjectsResponse"
name="SetMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="SetMultipleBusinessObjectsRequest">
<part element="types:SetMultipleBusinessObjects" name="inargs"/>
</message>
<message name="SetMultipleBusinessObjectsResponse">
<part element="types:SetMultipleBusinessObjectsOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
type="tns:BusinessObjectSelectorList" />
nillable="true" />
<element name="ignoreNilledElements" nillable="true"
type="boolean"/>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
type="tns:BusinessObjectSelectorList" />
nillable="true" />
</sequence>
</complexType>
</element>
BMC Atrium Core 9.0
Page 1941 of 2268
Home
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObjectList
createRelatedBO
ignoreNilledElements
Set whether to ignore elements with no values.
extensions
Return values
businessObjectList
status
extensions
Fault message
Fault message
See Fault message.
SetMultipleBusinessObjects function (deprecated)

Sets several business object names.
Note
SetMultipleBusinessObjects function.
Namespace
http://atrium.bmc.com/2009/01/businessobjects/types
BMC Atrium Core 9.0
Page 1942 of 2268
Home
WSDL operation
<operation name="SetMultipleBusinessObjects" parameterOrder="inargs">
<input message="tns:SetMultipleBusinessObjectsRequest"
name="SetMultipleBusinessObjectsRequest"/>
<output message="tns:SetMultipleBusinessObjectsResponse"
name="SetMultipleBusinessObjectsResponse"/>
</operation>
WSDL messages
<message name="SetMultipleBusinessObjectsRequest">
<part element="types:SetMultipleBusinessObjects" name="inargs"/>
</message>
<message name="SetMultipleBusinessObjectsResponse">
<part element="types:SetMultipleBusinessObjectsOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
BMC Atrium Core 9.0
Page 1943 of 2268
Home
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
datasetId
datasetType
See DatasetType.
businessObjectList
createRelatedBO
extensions
Return values
status
extensions
Fault message
Fault message
See Fault message.
SetMultipleInstances function
Sets or creates multiple CI or relationship instances of a class with the specified values.
Namespace
WSDL operation
<operation name="SetMultipleInstances" parameterOrder="inargs">
<input message="tns:SetMultipleInstancesRequest"
name="SetMultipleInstancesRequest"/>
<output message="tns:SetMultipleInstancesResponse"
name="SetMultipleInstancesResponse"/>
BMC Atrium Core 9.0
Page 1944 of 2268
Home

</operation>
WSDL messages
<message name="SetMultipleInstancesRequest">
<part element="types:SetMultipleInstances" name="inargs"/>
</message>
<message name="SetMultipleInstancesResponse">
</message>
</message>
XSD schema
<element name="SetMultipleInstances">
<complexType>
<sequence>
type="common:SetInstanceInfoInList" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
BMC Atrium Core 9.0
Page 1945 of 2268
Home
lang
datasetId
parameter.
instanceInfo
A list of instances. See SetInstanceInfoInList.
extensions
Return values
status
Fault message
Fault message
See Fault message.
SetProperties function
Sets configuration property values. Sets or creates a specified class with the specified properties. If
the class does not exist, it is created. If the class exists, it is updated with the specified settings.
Namespace
WSDL operation
<operation name="SetProperties" parameterOrder="inargs">
<input message="tns:SetPropertiesRequest"
name="SetPropertiesRequest"/>
<output message="tns:SetPropertiesResponse"
name="SetPropertiesResponse"/>
</operation>
WSDL messages
<message name="SetPropertiesRequest">
<part element="types:SetProperties" name="inargs"/>
</message>
<message name="SetPropertiesResponse">
<part element="types:SetPropertiesOutput" name="outargs"/>
</message>
</message>
BMC Atrium Core 9.0
Page 1946 of 2268
Home
XSD schema
<element name="SetProperties">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<element name="SetPropertiesOutput">
<complexType>
<sequence>
<element name="createdProperties"
<element name="modifiedProperties"
<element name="duplicateProperties"
<element name="invalidProperties"
</sequence>
</complexType>
</element>
<element name="AtriumServiceFault"
<sequence>
<element name="message" type="string"
nillable="true" />
nillable="true" />
/sequence>
</complexType>
Input arguments
properties
List of the configuration properties.
Return values
createdProperties
List of the properties that were created.
modifiedProperties
List of the properties that were modified.
duplicateProperties
List of the properties that were duplicates.
BMC Atrium Core 9.0
Page 1947 of 2268
Home
invalidProperties
Fault message
Fault message
StartNEJobRun function
Executes a specific normalization engine job.
Namespace
WSDL operation
<operation name="StartNEJobRun" parameterOrder="inargs">
<input message="tns:StartNEJobRunRequest"
name="StartNEJobRunRequest"/>
<output message="tns:StartNEJobRunResponse"
name="StartNEJobRunResponse"/>
</operation>
WSDL messages
<message name="StartNEJobRunRequest">
<part element="types:StartNEJobRun" name="inargs"/>
</message>
<message name="StartNEJobRunResponse">
<part element="types:StartNEJobRunOutput" name="outargs"/>
</message>
</message>
XSD schema
<element name="StartNEJobRun">
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1948 of 2268
Home
</element>
<element name="StartNEJobRunOutput">
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobName
isFullRun
extensions
Return value
jobRunId
status
extensions
Fault message
Fault message
See Fault message.
StartREJobRun function
Launches a reconciliation engine job.
Namespace
BMC Atrium Core 9.0
Page 1949 of 2268
Home
WSDL operation
<operation name="StartREJobRun" parameterOrder="inargs">
<input message="tns:StartREJobRunRequest"
name="StartREJobRunRequest"/>
<output message="tns:StartREJobRunResponse"
name="StartREJobRunResponse"/>
</operation>
WSDL messages
<message name="StartREJobRunRequest">
<part element="types:StartREJobRun" name="inargs"/>
</message>
<message name="StartREJobRunResponse">
<part element="types:StartREJobRunOutput" name="outargs"/>
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
BMC Atrium Core 9.0
Page 1950 of 2268
Home
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
jobName
qualifierList
See ClassQualifierList (classic reconciliation).
datasetList
Retrieves information about multiple datasets based on the information provided to the operation.
extensions
Return value
jobRunId
status
extensions
Fault message
Fault message
See Fault message.
StatusOutput function
Outputs a list of messages.
Namespace
WSDL operation
<operation name="StatusOutput" parameterOrder="inargs">
<input message="tns:StatusOutputRequest"
name="StatusOutputRequest"/>
<output message="tns:StatusOutputResponse"
name="StatusOutputResponse"/>
</operation>
BMC Atrium Core 9.0
Page 1951 of 2268
Home
WSDL messages
<message name="StatusOutputRequest">
<part element="common:StatusOutput" name="inargs"/>
</message>
<message name="StatusOutputResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<sequence>
nillable="true" />
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
status
extensions
BMC Atrium Core 9.0
Page 1952 of 2268
Home
Return values
status
extensions
Fault message
See Fault message.
Fault message
UpdateSavedQuery function (query_bypath)

Update a saved query of BMC Atrium CMDB.
Namespace
WSDL operation
<operation name="UpdateSavedQuery" parameterOrder="inargs">
<input message="tns:UpdateSavedQueryRequest"
name="UpdateSavedQueryRequest"/>
<output message="tns:UpdateSavedQueryResponse"
name="UpdateSavedQueryResponse"/>
</operation>
WSDL messages
<message name="UpdateSavedQueryRequest">
<part element="types:UpdateSavedQuery" name="inargs"/>
</message>
<message name="UpdateSavedQueryResponse">
</message>
</message>
XSD schema
<complexType>
<sequence>
<element name="savedQueryData"
type="tns:SavedQueryData" />
BMC Atrium Core 9.0
Page 1953 of 2268
Home

</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
savedQueryData
Indicates the path that needs to be queried to return the wanted CIs and relationships. See
SavedGraphQuery.
extensions
ExtensionList.
Fault message
Fault message
UpdateSavedQuery function
Update a saved query of BMC Atrium CMDB.
Namespace
WSDL operation
<operation name="UpdateSavedQuery" parameterOrder="inargs">
<input message="tns:UpdateSavedQueryRequest" name="UpdateSavedQueryRequest"/>
<output message="tns:UpdateSavedQueryResponse" name="UpdateSavedQueryResponse"/>
WSDL messages
<message name="UpdateSavedQueryResponse">
</message>
BMC Atrium Core 9.0
Page 1954 of 2268
Home

</operation>
XSD schema
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<complexType>
<choice>
</choice>
</complexType>
</element>
Input arguments
loginInfo
savedQuery
Indicates the path that needs to be queried to return the wanted CIs and relationships. See SavedGraphQuery.
extensions
ExtensionList.
Fault message
Fault message

This section lists the Product Catalog web service API operations. For some operations, it might be
necessary to see the WSDL file for the complete definition of all XSD data structure elements.
The Product Catalog web service APIs were created using the methodologies described in
Publishing the BMC Remedy AR System functionality as a web service in the BMC Remedy AR
System documentation.
BMC Atrium Core 9.0
Page 1955 of 2268
Home
Each of the operations in this section is a custom web service with public permissions, that can be
used by the user belonging to the BMC Remedy AR System permission "Atrium Foundation Admin"
role.
Authentication for the Product Catalog web service API operations must be declared in your SOAP
header file. The BMC Remedy AR System login User Name and Password need to be in the SOAP
header as an "AuthenticationInfo" header with child elements of "userName" and "password." For
more information about SOAP headers and authentication, see SOAP headers and authentication
in the BMC Remedy AR System documentation.
The web service operations are categorized by the type of functions they perform, as listed in the
following table.
Function type
Function list
PCT_Product_Create_WS
PCT_Get_ProductKey_WS
Get_ProductKey_QueryList_Service
Get_ProductKey_QueryListFields_Service
PCT_SignatureProductAssociation_WS
SignatureProductAssociation_WS
PDL_Associate_File_To_Product_WS
Associate_File_To_Product_WS
PDL_Create_File_WS
Create_File_WS
PDL_Get_Product_Info_From_File_WS
Get_Product_Info_From_File_WS
PDL_PDInterface_WS
PD_QueryList_Service
PD_QueryListFields_Service
PDL_PDPInterface_WS
PDP_QueryList_Service
PDP_QueryListFields_Service
PDL_SLIInterface_Create_WS
SLI_Submit_Service
PDL_SLIInterface_WS
SLI_Modify_Service
SLI_Query_Service
SLI_QueryList_Service
SLI_QueryListFields_Service
PDL_Suite_Product_Association_WS
Suite_Product_Association_WS
Associate_File_To_Product_WS function
Associates an existing file with a product in the Product Catalog.
BMC Atrium Core 9.0
Page 1956 of 2268
Home
Web service URL

http:// _midtierServer_:8080/arsys/WSDL/public/
serverName_
/PDL_Associate_File_To_Product_WS
WSDL operation
<wsdl:operation name="Associate_File_To_Product_WS">
<wsdl:input message="s0:Associate_File_To_Product_WSSoapIn" />
<wsdl:output message="s0:Associate_File_To_Product_WSSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="Associate_File_To_Product_WSSoapIn">
<wsdl:part element="s0:Associate_File_To_Product_WS" name="parameters" />
</wsdl:message>
- <wsdl:message name="Associate_File_To_Product_WSSoapOut">
<wsdl:part element="s0:Associate_File_To_Product_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="Associate_File_To_Product_WS" type="s0:CreateInputMap" />
- <xsd:complexType name="CreateInputMap">
+ <xsd:sequence>
<xsd:element name="Assigned_To" type="xsd:string" />
<xsd:element name="Assignee_Groups" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="DataTags" type="xsd:string" />

name="File_ID" type="xsd:string" />
name="File_Instance_ID" type="xsd:string" />
name="instanceId" type="xsd:string" />
name="MainExecutableFile" type="s0:MainExecutableFileType" />
<xsd:element name="PatchInstanceID" type="xsd:string" />

<xsd:element name="Product_ID" type="xsd:string" />
<xsd:element name="Product_Instance_ID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Short_Description" type="xsd:string" />

name="Status" type="s0:StatusType" />
name="Submitter" type="xsd:string" />
name="Vendor_Assignee_Groups" type="xsd:string" />
name="z1D_FileName" type="xsd:string" />
<xsd:element name="z1D_FileSize" type="xsd:string" />

<xsd:element name="z1D_Manufacturer" type="xsd:string" />
<xsd:element name="z1D_ModelVersion" type="xsd:string" />
<xsd:element name="z1D_PatchLastBuildID" type="xsd:string" />
<xsd:element name="z1D_ProductName" type="xsd:string" />
<xsd:element name="zTmpField1" type="xsd:string" />
BMC Atrium Core 9.0
Page 1957 of 2268
Home
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Associate_File_To_Product_WSResponse" type="s0:CreateOutputMap" />
- <xsd:complexType name="CreateOutputMap">
- <xsd:sequence>
<xsd:element name="Request_ID" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="AuthenticationInfo" type="s0:AuthenticationInfo" />
Required input arguments

File_ID
The Request_ID of an existing file from PDL:File form.
File_Instance_ID
The instanceId of the existing file from PDL:File form with the same File_ID.
MainExecutableFile
The main executable file is referenced by file ID. Use this value to indicate whether this is the main
executable file. Valid values are Yes and No.
PatchInstanceID
The patch instance ID of the product to associate with the file.
Product_ID
The product ID of the product to associate with the file.
Product_Instance_ID
The product instance ID of the product to associate with the file.
Short_Description
Limited length description.
Status
Valid values are New, Assigned, Fixed, Rejected, and Closed.
Submitter
The name of the user who is currently logged into the system. Example: pcadmin.
Return value
Request_ID
Returned after successful association of the file with the product.
Create_File_WS function
Creates a file in the Product Catalog.
Web service URL
serverName_
/PDL_Create_File_WS
WSDL operation
<wsdl:operation name="Create_File_WS">
<wsdl:input message="s0:Create_File_WSSoapIn" />
<wsdl:output message="s0:Create_File_WSSoapOut" />
</wsdl:operation>
BMC Atrium Core 9.0
Page 1958 of 2268
Home
WSDL messages
<wsdl:message name="Create_File_WSSoapIn">
<wsdl:part element="s0:Create_File_WS" name="parameters" />
</wsdl:message>
- - <wsdl:message name="Create_File_WSSoapOut">
<wsdl:part element="s0:Create_File_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="Create_File_WS" type="s0:CreateInputMap" />
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="CRC" type="xsd:string" />

name="File_Name" type="xsd:string" />
name="File_Size" type="xsd:string" />
name="instanceId" type="xsd:string" />
<xsd:element name="Short_Description" type="xsd:string" />

<xsd:element name="Status" type="s0:StatusType" />
<xsd:element name="Submitter" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Timestamp" type="xsd:dateTime" />

name="Vendor_Assignee_Groups" type="xsd:string" />
name="VendorFileID" type="xsd:string" />
name="versionbuild" type="xsd:string" />
name="versionmaint" type="xsd:string" />
<xsd:element name="versionmajor" type="xsd:string" />

<xsd:element name="versionminor" type="xsd:string" />
<xsd:element name="z1D_Char01" type="xsd:string" />
<xsd:element name="z1D_Action" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Create_File_WSResponse" type="s0:CreateOutputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>

File_Name
The name of the file.
File_Size
The file size in megabytes.
Short_Description
BMC Atrium Core 9.0
Page 1959 of 2268
Home
Status
Valid values are: New Assigned Fixed Rejected Closed
Submitter
Create_Product_WS function
Creates a product in the Product Catalog.
Web service URL
serverName_
/PCT_Product_Create_WS
WSDL operation
<wsdl:operation name="Create_Product_WS">
<wsdl:input message="s0:Create_Product_WSSoapIn" />
<wsdl:output message="s0:Create_Product_WSSoapOut" />
</wsdl:operation>
WSDL messages
- <wsdl:message name="Create_Product_WSSoapIn">
<wsdl:part element="s0:Create_Product_WS" name="parameters" />
</wsdl:message>
- <wsdl:message name="Create_Product_WSSoapOut">
<wsdl:part element="s0:Create_Product_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="Create_Product_WS" type="s0:CreateInputMap" />
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Approved_Patch" type="s0:Approved_PatchType" />

name="Approved_Product" type="s0:Approved_PatchType" />
name="Approved_Version" type="s0:Approved_PatchType" />
name="Asset_Class" type="s0:Asset_ClassType" />
name="Assigned_To" type="xsd:string" />
<xsd:element name="Blacklisted_Patch" type="s0:Approved_PatchType" />

<xsd:element name="Blacklisted_Product" type="s0:Approved_PatchType" />
<xsd:element name="Blacklisted_Version" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
BMC Atrium Core 9.0
name="Build_Date" type="xsd:dateTime" />

name="Company" type="xsd:string" />
name="Company_ID" type="xsd:string" />
name="Company_Instance_ID" type="xsd:string" />
name="CreateAssetType" type="xsd:string" />
Page 1960 of 2268
Home
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Hide_Patch" type="s0:Approved_PatchType" />

name="Hide_Product" type="s0:Approved_PatchType" />
name="Hide_Version" type="s0:Approved_PatchType" />
name="InstanceId" type="xsd:string" />
name="Locale" type="xsd:string" />
<xsd:element name="Managed_Patch" type="s0:Approved_PatchType" />

<xsd:element name="Managed_Product" type="s0:Approved_PatchType" />
<xsd:element name="Managed_Version" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Manufacturer" type="xsd:string" />

name="Manufacturer_ID" type="xsd:string" />
name="ModelVersion_InstanceId" type="xsd:string" />
name="ModelVersionPatchID" type="xsd:string" />
name="Normalized_Patch" type="s0:Approved_PatchType" />
<xsd:element name="Normalized_Product" type="s0:Approved_PatchType" />

<xsd:element name="Normalized_Version" type="s0:Approved_PatchType" />
<xsd:element name="Operating_System" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Origin" type="s0:OriginType" />

name="Patch_Life_Cycle" type="s0:Patch_Life_CycleType" />
name="Patch_InstanceId" type="xsd:string" />
name="Patch_Last_Build_ID" type="xsd:string" />
name="Patch_Status" type="s0:Patch_StatusType" />
<xsd:element name="ProductKey" type="xsd:string" />

<xsd:element name="Platform" type="xsd:string" />
<xsd:element name="Prod_instID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Product_Categorization_Tier_1" type="xsd:string" />

name="Product_Life_Cycle" type="s0:Patch_Life_CycleType" />
name="Product_Model_Version" type="xsd:string" />
<xsd:element name="Product_Model_Version_State" type="s0:

Product_Model_Version_StateType" />
<xsd:element name="Product_Name" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Requires_Contract" type="s0:Requires_ContractType" />

name="SignatureId" type="xsd:string" />
name="Status-PDC" type="s0:Patch_StatusType" />
<xsd:element name="Status2" type="s0:StatusType" />

<xsd:element name="Suite_Definition" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Verified" type="s0:Requires_ContractType" />

name="Version_Build" type="xsd:string" />
name="Version_Life_Cycle" type="s0:Patch_Life_CycleType" />
name="Version_Maintenance" type="xsd:string" />
name="Version_Major" type="xsd:string" />
<xsd:element name="Version_Minor" type="xsd:string" />

<xsd:element name="z1D_Char01" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="z1D_Char02" type="xsd:string"
name="z1D_Integer01" type="xsd:int"
/>
/>
/>
/>
/>
<xsd:element name="z1G_DefaultCompany" type="xsd:string" />
BMC Atrium Core 9.0
Page 1961 of 2268
Home
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Create_Product_WSResponse" type="s0:CreateOutputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>
Required input arguments for all instances

Asset_Class
Valid values for the asset class are: Hardware Service Business Process Network Segment
Software
Company
The company name.
Manufacturer
The name of the manufacturer.
Origin
The value specified for this input parameter must be "Custom."
Product_Categorization_Tier
_1
Product categorization divides CIs into groups. Typically, Tier 1 is used to divide CIs into
hardware and software groups.
_2
Product categorization divides CIs into groups. Typically, Tier 2 for the hardware group would be
used for disks device, peripheral, processing unit, and virtual systems.
_3
Product categorization divides CIs into groups. Typically, Tier 3 for the hardware processing unit,
would be groups for desktop, laptop, mainframe, personal digital assistant, and server.
Product_Name
The product name.
Short_Description
Status
The product status, where valid values are: New Assigned Fixed Rejected Closed
Status-PDC
The product status, where valid values are: Proposed--Temporarily prevents the product
category from being selected by an application. Enabled--Enables the product category to be
selected by an application. Product categories must be set to Enabled for it to appear in lists for
product fields. Offline--Specifies that the product category is offline and temporarily unavailable.
Obsolete--Specifies that the product category is obsolete and no longer available. Archive-Specifies that the selected product category has been archived. Delete--Specifies that the
selected product category has been deleted. Product Catalog entries are deleted using the
Delete button on the Product Category tab on the Product Category Setup form. (clear)--Clears
the Status field.
Submitter
Suite_Definition
If this product is a suite of products, specify Yes, otherwise specify No.
z1D_Action
This required value should be set to CREATE-CAT.
Optional input arguments for all instances

Approved_Product
Authorize a product to be installed in the organizational environment. Set to Yes or No.
Blacklisted_Product
Mark a product as a security risk. Set to Yes or No.
Hide_Product
BMC Atrium Core 9.0
Page 1962 of 2268
Home
Disable the display of a product in the Product Catalog Console. Set to Yes or No. Hidden products are
not removed from the Product Catalog and appear in search results if they match the criteria.
Managed_Product
Track the product in the organizational environment. Set to Yes or No.
Normalized_Product
Use the alias that has been defined for the product. Set to Yes or No.
Required input arguments for model/version instances

Product_Model_Version
Specify the version or model for a product.
Requires_Contract
Set to Yes or No. If you select Yes, this means that this Product Catalog entry must be related
to a Software License contract in BMC Remedy Asset Management to facilitate software
license compliance of specified software configuration items.
Product_Model_Version_State
The status of the product model or version, where valid values are Planned, Not Planned,
Future Consideration, Alpha/Beta, Pre-Release, General Availability, Discontinued Availability,
and Discontinued Support.
Optional input arguments for model/version instances

Approved_Version
Authorize a version or model to be installed in the organizational environment. Set to Yes or No.
Blacklisted_Version
Mark a version or model as a security risk. Set to Yes or No.
Hide_Version
Disable the display of a version or model in the Product Catalog Console. Set to Yes or No.
Managed_Version
Track the version or model in the organizational environment. Set to Yes or No.
Normalized_Version
Use the alias that has been defined for the version or model. Set to Yes or No.
Required input arguments for patch instances

Patch_Status
Status of the patch, where valid values are Enabled, Proposed, Offline, Obsolete, Achieve, and Delete
Patch_Last_Build_ID
The patch number.
Optional input arguments for patch instances

Approved_Patch
Authorize a patch to be installed in the organizational environment. Set to Yes or No.
Blacklisted_ Patch
Mark a patch as a security risk. Set to Yes or No.
Hide_ Patch
Disable the display of a patch in the Product Catalog Console. Set to Yes or No.
Managed_ Patch
Track the patch in the organizational environment. Set to Yes or No.
Normalized_ Patch
Use the alias that has been defined for the patch. Set to Yes or No.
Return value
Request_ID
Returned after successful creation of the file in Product Catalog.
BMC Atrium Core 9.0
Page 1963 of 2268
Home
Get_Product_Info_From_File_WS function
Retrieves the product information based on the file details from PDL:ProductFileLookup. The first
matching request is returned
Web service URL
serverName_
/PDL_Get_Product_Info_From_File_WS
WSDL operation
<wsdl:operation name="Get_Product_Info_From_File_WS">
<wsdl:input message="s0:Get_Product_Info_From_File_WSSoapIn" />
<wsdl:output message="s0:Get_Product_Info_From_File_WSSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="Get_Product_Info_From_File_WSSoapIn">
<wsdl:part element="s0:Get_Product_Info_From_File_WS" name="parameters" />
</wsdl:message>
- <wsdl:message name="Get_Product_Info_From_File_WSSoapOut">
<wsdl:part element="s0:Get_Product_Info_From_File_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="Get_Product_Info_From_File_WS" type="s0:ServiceInputMap" />
- <xsd:complexType name="ServiceInputMap">
- <xsd:sequence>
<xsd:element name="Approved_Patch" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Approved_Product" type="xsd:string" />

name="Approved_Version" type="xsd:string" />
name="Asset_Class" type="xsd:string" />
name="Blacklisted_Patch" type="xsd:string" />
name="Blacklisted_Product" type="xsd:string" />
<xsd:element name="Blacklisted_Version" type="xsd:string" />

<xsd:element name="Build_Date" type="xsd:dateTime" />
<xsd:element name="CategorizationSchemaKeyword" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="DA_Date" type="xsd:string" />
name="DA_Date_Time" type="xsd:dateTime" />
<xsd:element name="DataTags" type="xsd:string" />
BMC Atrium Core 9.0
Page 1964 of 2268
Home
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Description" type="xsd:string" />

name="DS_Date" type="xsd:string" />
name="DS_Date_Time" type="xsd:dateTime" />
name="GA_Date" type="xsd:string" />
<xsd:element name="GA_Date_Time" type="xsd:dateTime" />

<xsd:element name="Hide_Patch" type="xsd:string" />
<xsd:element name="Hide_Product" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Hide_Version" type="xsd:string" />

name="Main_Executable_Name" type="xsd:string" />
name="MainExecutableID" type="xsd:string" />
name="Managed_Patch" type="xsd:string" />
<xsd:element name="Managed_Product" type="xsd:string" />

<xsd:element name="Managed_Version" type="xsd:string" />
<xsd:element name="Manufacturer" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Normalized_Patch" type="xsd:string" />
name="Normalized_Product" type="xsd:string" />
name="Normalized_Version" type="xsd:string" />
name="Operating_System" type="xsd:string" />
<xsd:element name="Patch_Instance_ID" type="xsd:string" />

<xsd:element name="Patch_Life_Cycle" type="xsd:string" />
<xsd:element name="Patch_Last_Build_ID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Platform" type="xsd:string" />

name="PMVInstanceID" type="xsd:string" />
name="PreRelease_Date_Time" type="xsd:dateTime" />
name="PreReleaseDate" type="xsd:string" />
<xsd:element name="Product_Categorization_Tier_2" type="xsd:string" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Product_Life_Cycle" type="xsd:string" />

name="Product_Model_Version_State" type="xsd:string" />
name="Product_Name" type="xsd:string" />
name="Product_Type" type="xsd:string" />

<xsd:element name="Requires_Contract" type="xsd:string" />
<xsd:element name="Service_Type" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Status-PDA" type="xsd:string" />

name="Status-PDC" type="xsd:string" />
name="Status" type="xsd:string" />
name="Vendor_Name" type="xsd:string" />
<xsd:element name="Version_Life_Cycle" type="xsd:string" />

<xsd:element name="Version_Maintenance" type="xsd:string" />
<xsd:element name="Version_Major" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Get_Product_Info_From_File_WSResponse" type="s0:ServiceOutputMap" />
- <xsd:complexType name="ServiceOutputMap">
- <xsd:sequence>
BMC Atrium Core 9.0
Page 1965 of 2268
Home
<xsd:element name="Approved_Patch" type="s0:Approved_PatchType" />

<xsd:element name="Approved_Product" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Blacklisted_Patch" type="s0:Approved_PatchType" />
name="Blacklisted_Product" type="s0:Approved_PatchType" />
name="Blacklisted_Version" type="s0:Approved_PatchType" />

<xsd:element name="Company" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="Description" type="xsd:string" />

<xsd:element name="DS_Date" type="xsd:string" />
<xsd:element name="DS_Date_Time" type="xsd:dateTime" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="GA_Date_Time" type="xsd:dateTime" />
<xsd:element name="Hide_Version" type="s0:Approved_PatchType" />

<xsd:element name="Locale" type="xsd:string" />
<xsd:element name="Main_Executable_Name" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Managed_Patch" type="s0:Approved_PatchType" />
name="Managed_Product" type="s0:Approved_PatchType" />
name="Managed_Version" type="s0:Approved_PatchType" />
<xsd:element name="Manufacturer_ID" type="xsd:string" />

<xsd:element name="Normalized_Patch" type="s0:Approved_PatchType" />
<xsd:element name="Normalized_Product" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Normalized_Version" type="s0:Approved_PatchType" />

name="Patch_Instance_ID" type="xsd:string" />

<xsd:element name="PMVInstanceID" type="xsd:string" />
<xsd:element name="PreRelease_Date_Time" type="xsd:dateTime" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Product_ID" type="xsd:string" />
<xsd:element name="Product_Life_Cycle" type="s0:Patch_Life_CycleType" />

<xsd:element name="Product_Model_Version" type="xsd:string" />
<xsd:element name="Product_Model_Version_ID" type="xsd:string" />
<xsd:element name="Product_Type" type="s0:Product_TypeType" />
BMC Atrium Core 9.0
Page 1966 of 2268
Home

<xsd:element name="Requires_Contract" type="s0:Requires_ContractType" />
<xsd:element name="Service_Type" type="s0:Service_TypeType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Status-History" type="xsd:string" />

name="Status-PDA" type="s0:Status-PDAType" />
name="Status-PDC" type="s0:Status-PDAType" />
name="Status" type="s0:Status-PDAType" />
<xsd:element name="Version_Build" type="xsd:string" />

<xsd:element name="Version_Life_Cycle" type="s0:Patch_Life_CycleType" />
</xsd:sequence>
</xsd:complexType>
- </xsd:restriction>

File_Size
The file size in megabytes.
Main_Executable_Name
The name of the main executable.
Return value
Product information
Returned for the entered file from the PDL:ProductFileLookup form.
Get_ProductKey_QueryList_Service function
Queries the product key information based on the search qualifications from the PCT:
ProductVersionPatchKey form.
Web service URL
http:// _midtierServer_:8080
_>_
/arsys/WSDL/public/ _
serverName_
/PCT_Get_ProductKey_WS
WSDL operation
<wsdl:operation name="Get_ProductKey_QueryList_Service">
<wsdl:input message="s0:Get_ProductKey_QueryList_ServiceSoapIn" />
<wsdl:output message="s0:Get_ProductKey_QueryList_ServiceSoapOut" />
</wsdl:operation>
BMC Atrium Core 9.0
Page 1967 of 2268
Home
WSDL messages
<wsdl:message name="Get_ProductKey_QueryList_ServiceSoapIn">
<wsdl:part element="s0:Get_ProductKey_QueryList_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="Get_ProductKey_QueryList_ServiceSoapOut">
<wsdl:part element="s0:Get_ProductKey_QueryList_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="Get_ProductKey_QueryList_Service" type="s0:GetListInputMap" />
- <xsd:complexType name="GetListInputMap">
- <xsd:sequence>
<xsd:element name="Qualification" type="xsd:string" />
<xsd:element name="startRecord" type="xsd:string" />
<xsd:element name="maxLimit" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Get_ProductKey_QueryList_ServiceResponse" type="s0:GetListOutputMap
" />
- <xsd:complexType name="GetListOutputMap">
- <xsd:sequence>
- <xsd:element maxOccurs="unbounded" name="getListValues">
- <xsd:complexType>
- <xsd:sequence>
<xsd:element name="Approved_Version" type="s0:Approved_PatchType" />
<xsd:element name="Asset_Class" type="s0:Asset_ClassType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="CategorizationSchemaKeyword" type="xsd:string" />
<xsd:element name="DA_Date" type="xsd:string" />

<xsd:element name="DA_Date_Time" type="xsd:dateTime" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="Hide_Patch" type="s0:Approved_PatchType" />

<xsd:element name="Hide_Product" type="s0:Approved_PatchType" />
BMC Atrium Core 9.0
Page 1968 of 2268
Home
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Normalized_Product" type="s0:Approved_PatchType" />
<xsd:element name="Patch_Life_Cycle" type="s0:Patch_Life_CycleType" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Request_ID" type="xsd:string" />

name="Service_Type" type="s0:Service_TypeType" />
<xsd:element name="Status-PDC" type="s0:Status-PDAType" />

<xsd:element name="Status" type="s0:Status-PDAType" />
<xsd:element name="Vendor_Name" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Version_Minor" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
- <xsd:simpleType name="Approved_PatchType">
- <xsd:restriction base="xsd:string">
<xsd:enumeration value="No" />
<xsd:enumeration value="Yes" />
BMC Atrium Core 9.0
Page 1969 of 2268
Home
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Asset_ClassType">
<xsd:enumeration value="Hardware" />
<xsd:enumeration value="Software" />
<xsd:enumeration value="Service" />
<xsd:enumeration value="Business Process" />
<xsd:enumeration value="Network Segment" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Patch_Life_CycleType">
<xsd:enumeration value="Development" />
<xsd:enumeration value="Released" />
<xsd:enumeration value="Test" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Product_Model_Version_StateType">
<xsd:enumeration value="Future Consideration" />
<xsd:enumeration value="Not Planned" />
<xsd:enumeration value="Planned" />
<xsd:enumeration value="Alpha/Beta" />
<xsd:enumeration value="Pre-Release" />
<xsd:enumeration value="General Availability" />
<xsd:enumeration value="Discontinued Availability" />
<xsd:enumeration value="Discontinued Support" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Product_TypeType">
<xsd:enumeration value="Non-CMDB Entity" />
<xsd:enumeration value="Configuration Item" />
<xsd:enumeration value="Configuration Component" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Requires_ContractType">
<xsd:enumeration value="Yes" />
<xsd:enumeration value="No" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Service_TypeType">
<xsd:enumeration value="User Service Restoration" />
<xsd:enumeration value="User Service Request" />
<xsd:enumeration value="Infrastructure Restoration" />
<xsd:enumeration value="Infrastructure Event" />
</xsd:restriction>
</xsd:simpleType>
- <xsd:simpleType name="Status-PDAType">
<xsd:enumeration value="Proposed" />
BMC Atrium Core 9.0
Page 1970 of 2268
Home
<xsd:enumeration value="Enabled" />

<xsd:enumeration value="Offline" />
<xsd:enumeration value="Obsolete" />
<xsd:enumeration value="Archive" />
<xsd:enumeration value="Delete" />
</xsd:restriction>
</xsd:simpleType>

Qualification
A qualification that determines the set of data to retrieve. The qualification can include one or more attributes. For
example: 'Manufacturer' = "4D" AND 'Product Name'= "Tutor Trac"
Return values
Product entries
Returned for the entered file from the PCT:ProductVersionPatchKey form.
Get_ProductKey_QueryListFields_Service function
Queries the product key information based on the fields from the PCT:ProductVersionPatchKey
form, such as Manufacturer, Product name. The first matching request is returned.
Web service URL
serverName_
/PCT_Get_ProductKey_WS
WSDL operation
<wsdl:operation name="Get_ProductKey_QueryListFields_Service">
<wsdl:input message="s0:Get_ProductKey_QueryListFields_ServiceSoapIn" />
<wsdl:output message="s0:Get_ProductKey_QueryListFields_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="Get_ProductKey_QueryListFields_ServiceSoapIn">
<wsdl:part element="s0:Get_ProductKey_QueryListFields_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="Get_ProductKey_QueryListFields_ServiceSoapOut">
<wsdl:part element="s0:Get_ProductKey_QueryListFields_ServiceResponse" name="
parameters" />
</wsdl:message>
BMC Atrium Core 9.0
Page 1971 of 2268
Home
XSD schema
<xsd:element name="Get_ProductKey_QueryListFields_Service" type="s0:GetInputMap" />
- <xsd:complexType name="GetInputMap">
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Approved_Patch" type="s0:Approved_PatchType" />

name="Approved_Product" type="s0:Approved_PatchType" />
name="Blacklisted_Patch" type="s0:Approved_PatchType" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="DA_Date_Time" type="xsd:dateTime" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="Hide_Product" type="s0:Approved_PatchType" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Managed_Version" type="s0:Approved_PatchType" />

<xsd:element name="Normalized_Patch" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element name="PMVInstanceID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


BMC Atrium Core 9.0
Page 1972 of 2268
Home

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element name="Status" type="s0:Status-PDAType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

</xsd:sequence>
</xsd:complexType>
<xsd:element name="Get_ProductKey_QueryListFields_ServiceResponse" type="s0:
GetOutputMap" />
- <xsd:complexType name="GetOutputMap">
- <xsd:sequence>
<xsd:element name="Approved_Version" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Blacklisted_Product" type="s0:Approved_PatchType" />

name="Blacklisted_Version" type="s0:Approved_PatchType" />
<xsd:element name="Company_ID" type="xsd:string" />

<xsd:element name="Company_Instance_ID" type="xsd:string" />
<xsd:element name="DA_Date" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="GA_Date" type="xsd:string" />

<xsd:element name="GA_Date_Time" type="xsd:dateTime" />
<xsd:element name="Hide_Patch" type="s0:Approved_PatchType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Hide_Version" type="s0:Approved_PatchType" />
<xsd:element name="Managed_Patch" type="s0:Approved_PatchType" />
BMC Atrium Core 9.0
Page 1973 of 2268
Home
<xsd:element name="Managed_Product" type="s0:Approved_PatchType" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element name="Patch_Instance_ID" type="xsd:string" />
<xsd:element name="Patch_Life_Cycle" type="s0:Patch_Life_CycleType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Product_Life_Cycle" type="s0:Patch_Life_CycleType" />
name="Product_Model_Version_ID" type="xsd:string" />
name="Product_Model_Version_State" type="s0:
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Product_Instance_ID" type="xsd:string" />

name="ProductKey" type="xsd:string" />
<xsd:element name="Status-History" type="xsd:string" />

<xsd:element name="Status-PDA" type="s0:Status-PDAType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Status" type="s0:Status-PDAType" />


</xsd:sequence>
</xsd:complexType>

Manufacturer
Product_Name
The product name.
Product_Model_Version
The product version.
BMC Atrium Core 9.0
Page 1974 of 2268
Home
Return values
Product entries
Returned for the entered file from the PCT:ProductVersionPatchKey form.
PD_QueryList_Service function
Queries a product entry based on the qualification from the PDL_PDInterface form.
Web service URL
serverName_
/PDL_PDInterface_WS
WSDL operation
<wsdl:operation name="PD_QueryList_Service">
<wsdl:input message="s0:PD_QueryList_ServiceSoapIn" />
<wsdl:output message="s0:PD_QueryList_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="PD_QueryList_ServiceSoapIn">
<wsdl:part element="s0:PD_QueryList_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="PD_QueryList_ServiceSoapOut">
<wsdl:part element="s0:PD_QueryList_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="PD_QueryList_Service" type="s0:GetListInputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>
</xsd:complexType>
<xsd:element name="PD_QueryList_ServiceResponse" type="s0:GetListOutputMap" />
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
BMC Atrium Core 9.0
Page 1975 of 2268
Home
<xsd:element name="GUID" type="xsd:string" />

<xsd:element name="InstanceId" type="xsd:string" />
<xsd:element name="Main_Executable_Name" type="xsd:string" />
<xsd:element name="MainExecutableID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="PDRequestID" type="xsd:string" />

<xsd:element name="Product_Status" type="s0:Product_StatusType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Suite_Definition" type="s0:Suite_DefinitionType" />

</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

Qualification
A qualification that determines the set of data to retrieve. The qualification can include one or more attributes.
Return values
Product entries
Returned for the entered qualification from the PDL:PDInterface form.
PD_QueryListFields_Service function
Queries a product entry based on the entered fields from the PDL_PDInterface form. The first
matching request is returned.
Web service URL
BMC Atrium Core 9.0
Page 1976 of 2268
Home
serverName_
/PDL_PDInterface_WS
WSDL operation
<wsdl:operation name="PD_QueryListFields_Service">
<wsdl:input message="s0:PD_QueryListFields_ServiceSoapIn" />
<wsdl:output message="s0:PD_QueryListFields_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="PD_QueryListFields_ServiceSoapIn">
<wsdl:part element="s0:PD_QueryListFields_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="PD_QueryListFields_ServiceSoapOut">
<wsdl:part element="s0:PD_QueryListFields_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="PD_QueryListFields_Service" type="s0:GetListInputMap1" />
- <xsd:complexType name="GetListInputMap1">
- <xsd:sequence>
<xsd:element minOccurs="0" name="Company" type="xsd:string" />
<xsd:element minOccurs="0" name="Locale" type="xsd:string" />
<xsd:element minOccurs="0" name="Manufacturer" type="xsd:string" />
<xsd:element minOccurs="0" name="Operating_System" type="xsd:string" />
<xsd:element minOccurs="0" name="Origin" type="s0:OriginType" />
<xsd:element minOccurs="0" name="Platform" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"

<xsd:element minOccurs="0" name="Product_Name" type="xsd:string" />
<xsd:element minOccurs="0" name="Product_Status" type="s0:Product_StatusType" />
<xsd:element minOccurs="0" name="Suite_Definition" type="s0:Suite_DefinitionType" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="PD_QueryListFields_ServiceResponse" type="s0:GetListOutputMap1" />
- <xsd:complexType name="GetListOutputMap1">
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
BMC Atrium Core 9.0
Page 1977 of 2268
Home

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="GUID" type="xsd:string" />

<xsd:element name="Origin" type="s0:OriginType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="PDRequestID" type="xsd:string"
name="Product_Categorization_Tier_1"
/>
type="xsd:string" />

<xsd:element name="Version_Build" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Product_Status" type="s0:Product_StatusType" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

Manufacturer
Return values
Product entries
PDP_QueryList_Service function
Queries a product entry based on the qualification on the PDL:PDPInterface form.
Web service URL
BMC Atrium Core 9.0
Page 1978 of 2268
Home
serverName_
/PDL_PDPInterface_WS
WSDL operation
<wsdl:operation name="PDP_QueryList_Service">
<wsdl:input message="s0:PDP_QueryList_ServiceSoapIn" />
<wsdl:output message="s0:PDP_QueryList_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="PDP_QueryList_ServiceSoapIn">
<wsdl:part element="s0:PDP_QueryList_Service" name="parameters" />
</wsdl:message>
- <wsdl:message name="PDP_QueryList_ServiceSoapOut">
<wsdl:part element="s0:PDP_QueryList_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="PDP_QueryList_Service" type="s0:GetListInputMap" />
- <xsd:sequence>
<xsd:element name="startRecord" type="xsd:string" />
<xsd:element name="maxLimit" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="PDP_QueryList_ServiceResponse" type="s0:GetListOutputMap" />
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
<xsd:element name="GUID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
BMC Atrium Core 9.0

Page 1979 of 2268
Home
<xsd:element name="ModelVersionPatchID" type="xsd:string" />

<xsd:element name="Origin" type="s0:OriginType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="ProdCatInstanceID" type="xsd:string" />


<xsd:element name="ProductCompanyAssocInstanceID" type="xsd:string" />
<xsd:element name="Request_ID2" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element


</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

Qualification
example: 'Manufacturer' = "4D" AND 'Product Name'= "Tutor Trac"
Return values
Product entries
PDP_QueryListFields_Service function
Queries a product entry based on the fields in the request on the PDL:PDPInterface form. The first
matching request is returned.
Web service URL
BMC Atrium Core 9.0
Page 1980 of 2268
Home
serverName_
/PDL_PDPInterface_WS
WSDL operation
<wsdl:operation name="PDP_QueryListFields_Service">
<wsdl:input message="s0:PDP_QueryListFields_ServiceSoapIn" />
<wsdl:output message="s0:PDP_QueryListFields_ServiceSoapOut" />
</wsdl:operation>
</wsdl:portType>
WSDL messages
<wsdl:message name="PDP_QueryListFields_ServiceSoapIn">
<wsdl:part element="s0:PDP_QueryListFields_Service" name="parameters" />
</wsdl:message>
- <wsdl:message name="PDP_QueryListFields_ServiceSoapOut">
<wsdl:part element="s0:PDP_QueryListFields_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="PDP_QueryListFields_Service" type="s0:GetListInputMap1" />
- <xsd:sequence>
<xsd:element minOccurs="0" name="Company" type="xsd:string" />
<xsd:element minOccurs="0" name="Description" type="xsd:string" />
<xsd:element minOccurs="0" name="Locale" type="xsd:string" />
<xsd:element minOccurs="0" name="Main_Executable_Name" type="xsd:string" />
<xsd:element minOccurs="0" name="Manufacturer" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"

<xsd:element minOccurs="0" name="Product_Categorization_Tier_2" type="xsd:string" />

<xsd:element minOccurs="0" name="Product_Categorization_Tier_3" type="xsd:string" />
<xsd:element minOccurs="0" name="Product_Model_Version" type="xsd:string" />
<xsd:element minOccurs="0" name="Product_Model_Version_State" type="s0:
<xsd:element minOccurs="0" name="Product_Name" type="xsd:string" />
<xsd:element minOccurs="0" name="Product_Status" type="s0:Product_StatusType" />
<xsd:element minOccurs="0" name="Requires_Contract" type="s0:Requires_ContractType" />
<xsd:element minOccurs="0" name="Suite_Definition" type="s0:Suite_DefinitionType" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="PDP_QueryListFields_ServiceResponse" type="s0:GetListOutputMap1" />
BMC Atrium Core 9.0
Page 1981 of 2268
Home
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="GUID" type="xsd:string" />


<xsd:element name="ModelVersionPatchID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="PatchInstanceID" type="xsd:string" />
<xsd:element name="ProdCatInstanceID" type="xsd:string" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Product_Model_Version_ID" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Product_Type" type="s0:Product_TypeType" />

name="ProductCompanyAssocInstanceID" type="xsd:string" />
name="Request_ID2" type="xsd:string" />

<xsd:element name="Suite_Definition" type="s0:Suite_DefinitionType" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
BMC Atrium Core 9.0
Page 1982 of 2268
Home

Manufacturer
Return values
Product entries
SignatureProductAssociation_WS function
Associates an existing signature to a product.
Web service URL
serverName_
/PCT_SignatureProductAssociation_WS
WSDL operation
<wsdl:operation name="SignatureProductAssociation_WS">
<wsdl:input message="s0:SignatureProductAssociation_WSSoapIn" />
<wsdl:output message="s0:SignatureProductAssociation_WSSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="SignatureProductAssociation_WSSoapIn">
<wsdl:part element="s0:SignatureProductAssociation_WS" name="parameters" />
</wsdl:message>
<wsdl:message name="SignatureProductAssociation_WSSoapOut">
<wsdl:part element="s0:SignatureProductAssociation_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="SignatureProductAssociation_WS" type="s0:CreateInputMap" />
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Assigned_To" type="xsd:string" />

name="ProductKey" type="xsd:string" />
<xsd:element name="SignatureId" type="xsd:string" />

<xsd:element name="Status" type="s0:StatusType" />
BMC Atrium Core 9.0
Page 1983 of 2268
Home

<xsd:element name="z1D_Edition" type="xsd:string" />
<xsd:element name="z1D_Locale" type="xsd:string" />
<xsd:element name="z1D_Manufacturer" type="xsd:string" />
<xsd:element name="z1D_Part" type="xsd:string" />
<xsd:element name="z1D_PatchLastBuildID" type="xsd:string" />
<xsd:element name="z1D_ProductModelVersion" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SignatureProductAssociation_WSResponse" type="s0:CreateOutputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>
Input arguments
ProductKey
The product key.
SignatureId
The signature ID.
Short_Description
Status
Submitter
Return value
Request_ID
Returned for successful association of product.
SLI_Modify_Service function
Modifies a storage location entry.
Web service URL
serverName_
/PDL_SLIInterface_WS
WSDL operation
<wsdl:operation name="SLI_Modify_Service">
<wsdl:input message="s0:SLI_Modify_ServiceSoapIn" />
<wsdl:output message="s0:SLI_Modify_ServiceSoapOut" />
</wsdl:operation>
BMC Atrium Core 9.0
Page 1984 of 2268
Home
WSDL messages
<wsdl:message name="SLI_Modify_ServiceSoapIn">
<wsdl:part element="s0:SLI_Modify_Service" name="parameters" />
</wsdl:message>
- <wsdl:message name="SLI_Modify_ServiceSoapOut">
<wsdl:part element="s0:SLI_Modify_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="SLI_Modify_Service" type="s0:SetInputMap" />
- <xsd:complexType name="SetInputMap">
- <xsd:sequence>
<xsd:element minOccurs="0" name="Deployable" type="s0:DeployableType" />
<xsd:element minOccurs="0" name="SLIApplicationSize" type="xsd:string" />
<xsd:element minOccurs="0" name="SLIAuthor" type="xsd:string" />
<xsd:element minOccurs="0" name="SLIComments" type="xsd:string" />
<xsd:element minOccurs="0" name="SLICopyright" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"
minOccurs="0"
name="SLICreateDate" type="xsd:dateTime" />

name="SLIDevelopmentContact" type="xsd:string" />
name="SLIKeywords" type="xsd:string" />
name="SLILocation" type="xsd:string" />
name="SLIModifiedDate" type="xsd:dateTime" />
<xsd:element minOccurs="0" name="SLIReadMe" type="xsd:string" />

<xsd:element minOccurs="0" name="SLISize" type="xsd:string" />
<xsd:element minOccurs="0" name="SLIState" type="s0:SLIStateType" />
<xsd:element minOccurs="0"
</xsd:sequence>
name="SLISupportContact" type="xsd:string" />

name="SLIType" type="s0:SLITypeType" />
name="Change_History" type="xsd:string" />
</xsd:complexType>
<xsd:element name="SLI_Modify_ServiceResponse" type="s0:SetOutputMap" />
- <xsd:complexType name="SetOutputMap">
<xsd:sequence />
</xsd:complexType>

Deployable
Boolean value indicating whether the service is deployable, valid values are Yes and No.
SLILocation
The path of the storage location entry.
Short_Description
SLIState
Value indicating the state of the storage location; valid values are Active and Inactive.
Manufacturer
BMC Atrium Core 9.0
Page 1985 of 2268
Home
Model_Version
The name of the product model.
Patch_ID
The ID from the patch table.
PatchInstanceID
The patch instance ID of the product from the PDL:SLIInterface form.
PMV_Instance_ID
The product model version instance ID from the PDL:SLIInterface form.
ProductInstanceID
The product instance ID from the PDL:SLIInterface form.
ProductName
The product name.
InstanceId
The instance ID from the PDL:SLIInterface form.
Submitter
SLIType
The storage location type; where valid values are Marimba and Other.
Return values
Request_ID
Returned for successful modification.
SLI_Query_Service function
Queries a storage location based on the request ID from PDL:SLIInterface.
Web service URL
serverName_
WSDL operation
<wsdl:operation name="SLI_Query_Service">
<wsdl:input message="s0:SLI_Query_ServiceSoapIn" />
<wsdl:output message="s0:SLI_Query_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="SLI_Query_ServiceSoapIn">
<wsdl:part element="s0:SLI_Query_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="SLI_Query_ServiceSoapOut">
<wsdl:part element="s0:SLI_Query_ServiceResponse" name="parameters" />
</wsdl:message>
BMC Atrium Core 9.0
Page 1986 of 2268
Home
XSD schema
<xsd:element name="SLI_Query_Service" type="s0:GetInputMap" />
- <xsd:complexType name="GetInputMap">
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SLI_Query_ServiceResponse" type="s0:GetOutputMap" />
- <xsd:complexType name="GetOutputMap">
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="Deployable" type="s0:DeployableType" />

name="Model_Version" type="xsd:string" />
name="PMV_Instance_ID" type="xsd:string" />
<xsd:element name="ProductInstanceID" type="xsd:string" />

<xsd:element name="ProductName" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="SLIApplicationSize" type="xsd:string" />

name="SLIAuthor" type="xsd:string" />
name="SLIComments" type="xsd:string" />
name="SLICopyright" type="xsd:string" />
<xsd:element name="SLIDevelopmentContact" type="xsd:string" />

<xsd:element name="SLIKeywords" type="xsd:string" />
<xsd:element name="SLILocation" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="SLIReadMe" type="xsd:string" />
name="SLISize" type="xsd:string" />
name="SLIState" type="s0:SLIStateType" />
<xsd:element name="SLIType" type="s0:SLITypeType" />

<xsd:element name="Patch_ID" type="xsd:string" />
<xsd:element name="Change_History" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>

Request_ID
Request ID of the storage location from the PDL:SLIInterface form.
Return values
Storage location
BMC Atrium Core 9.0
Returned for the Request_ID entered in the PDL:SLIInterface form.
Page 1987 of 2268
Home
SLI_QueryList_Service function
Queries storage locations based on the qualification from the PDL:SLIInterface form.
Web service URL
serverName_
WSDL operation
<wsdl:operation name="SLI_QueryList_Service">
<wsdl:input message="s0:SLI_QueryList_ServiceSoapIn" />
<wsdl:output message="s0:SLI_QueryList_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="SLI_QueryList_ServiceSoapIn">
<wsdl:part element="s0:SLI_QueryList_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="SLI_QueryList_ServiceSoapOut">
<wsdl:part element="s0:SLI_QueryList_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="SLI_QueryList_Service" type="s0:GetListInputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SLI_QueryList_ServiceResponse" type="s0:GetListOutputMap" />
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
<xsd:element name="Deployable" type="s0:DeployableType" />
<xsd:element name="Model_Version" type="xsd:string" />
<xsd:element name="PMV_Instance_ID" type="xsd:string" />
<xsd:element name="ProductInstanceID" type="xsd:string" />
<xsd:element name="ProductName" type="xsd:string" />
BMC Atrium Core 9.0
Page 1988 of 2268
Home
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="SLIComments" type="xsd:string" />
name="SLICopyright" type="xsd:string" />
<xsd:element name="SLIDevelopmentContact" type="xsd:string" />

<xsd:element name="SLIKeywords" type="xsd:string" />
<xsd:element name="SLILocation" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="SLISize" type="xsd:string" />
name="SLIState" type="s0:SLIStateType" />

<xsd:element name="Change_History" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

Qualification
example: 'ProductName'="new product"
Return values
Storage location
Returned for the qualification entered in the PDL:SLIInterface form.
SLI_QueryListFields_Service function
Queries storage locations based on the entered fields in the request. This operation returns the
storage location details for the first matching request.
Web service URL
serverName_
WSDL operation
<wsdl:operation name="SLI_QueryListFields_Service">
<wsdl:input message="s0:SLI_QueryListFields_ServiceSoapIn" />
<wsdl:output message="s0:SLI_QueryListFields_ServiceSoapOut" />
</wsdl:operation>
BMC Atrium Core 9.0
Page 1989 of 2268
Home
WSDL messages
<wsdl:message name="SLI_QueryListFields_ServiceSoapIn">
<wsdl:part element="s0:SLI_QueryListFields_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="SLI_QueryListFields_ServiceSoapOut">
<wsdl:part element="s0:SLI_QueryListFields_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="SLI_QueryListFields_Service" type="s0:GetListInputMap1" />
- <xsd:sequence>
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Model_Version" type="xsd:string" />

<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="ProductInstanceID" type="xsd:string" />

name="ProductName" type="xsd:string" />
<xsd:element name="SLIAuthor" type="xsd:string" />

<xsd:element name="SLIComments" type="xsd:string" />
<xsd:element name="SLICopyright" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="SLIReadMe" type="xsd:string" />

<xsd:element name="SLISize" type="xsd:string" />
<xsd:element name="SLIState" type="s0:SLIStateType" />
<xsd:element name="SLISupportContact" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SLI_QueryListFields_ServiceResponse" type="s0:GetListOutputMap1" />
- <xsd:sequence>
- <xsd:complexType>
- <xsd:sequence>
<xsd:element name="Deployable" type="s0:DeployableType" />
BMC Atrium Core 9.0
Page 1990 of 2268
Home

<xsd:element name="Model_Version" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="ProductInstanceID" type="xsd:string" />

name="ProductName" type="xsd:string" />
<xsd:element name="SLIComments" type="xsd:string" />

<xsd:element name="SLICopyright" type="xsd:string" />
<xsd:element name="SLICreateDate" type="xsd:dateTime" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

<xsd:element name="SLISize" type="xsd:string" />

<xsd:element name="SLISupportContact" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="SLIType" type="s0:SLITypeType" />

name="Patch_ID" type="xsd:string" />
name="PatchInstanceID" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

ProductName
The name of the product.
Return values
Storage location
Returned for the fields entered in the PDL:SLIInterface form.
SLI_Submit_Service function function

Creates a storage location entry for the product.
Web service URL
serverName_
/PDL_SLIInterface_Create_WS
BMC Atrium Core 9.0
Page 1991 of 2268
Home
WSDL operation
<wsdl:operation name="SLI_Submit_Service">
<wsdl:input message="s0:SLI_Submit_ServiceSoapIn" />
<wsdl:output message="s0:SLI_Submit_ServiceSoapOut" />
</wsdl:operation>
WSDL messages
<wsdl:message name="SLI_Submit_ServiceSoapIn">
<wsdl:part element="s0:SLI_Submit_Service" name="parameters" />
</wsdl:message>
<wsdl:message name="SLI_Submit_ServiceSoapOut">
<wsdl:part element="s0:SLI_Submit_ServiceResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:element name="SLI_Submit_Service" type="s0:CreateInputMap" />
- <xsd:sequence>
<xsd:element minOccurs="0" name="Change_History" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

minOccurs="0" name="SLIApplicationSize" type="xsd:string" />
minOccurs="0" name="SLIAuthor" type="xsd:string" />
minOccurs="0" name="SLIComments" type="xsd:string" />
<xsd:element minOccurs="0" name="SLICopyright" type="xsd:string" />

<xsd:element minOccurs="0" name="SLICreateDate" type="xsd:dateTime" />
<xsd:element minOccurs="0" name="SLIDevelopmentContact" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
minOccurs="0" name="SLIKeywords" type="xsd:string" />

minOccurs="0" name="SLIModifiedDate" type="xsd:dateTime" />
minOccurs="0" name="SLIReadMe" type="xsd:string" />
minOccurs="0" name="SLISize" type="xsd:string" />

<xsd:element minOccurs="0" name="SLISupportContact" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="z1D_Action" type="xsd:string" />

minOccurs="0" name="Assigned_To" type="xsd:string" />
minOccurs="0" name="InstanceId" type="xsd:string" />
minOccurs="0" name="Manufacturer" type="xsd:string" />
minOccurs="0" name="Model_Version" type="xsd:string" />
<xsd:element minOccurs="0" name="ProductInstanceID" type="xsd:string" />

<xsd:element minOccurs="0" name="ProductName" type="xsd:string" />
<xsd:element minOccurs="0" name="Status" type="xsd:string" />
<xsd:element minOccurs="0" name="Submitter" type="xsd:string" />
BMC Atrium Core 9.0
Page 1992 of 2268
Home

</xsd:sequence>
</xsd:complexType>
</xsd:complexType>
<xsd:element name="SLI_Submit_ServiceResponse" type="s0:CreateOutputMap" />
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>

Deployable
Boolean value indicating whether the service is deployable, valid values are Yes and No.
SLILocation
The path to the storage location entry.
Short_Description
SLIState
Value indicating the state of the storage location; valid values are Active and Inactive.
z1D_Action
This required value should be set to CREATE.
PatchInstanceID
The patch instance ID of the product.
Submitter
SLIType
The storage location type; where valid values are Marimba and Other.
Return value
Request_ID
Returned after successful creation of the location.
Suite_Product_Association_WS function
Associates a product with a suite.
Web service URL
serverName_
/ PDL_Suite_Product_Association_WS
WSDL operation
<wsdl:operation name="Suite_Product_Association_WS">
<wsdl:input message="s0:Suite_Product_Association_WSSoapIn" />
<wsdl:output message="s0:Suite_Product_Association_WSSoapOut" />
</wsdl:operation>
BMC Atrium Core 9.0
Page 1993 of 2268
Home
WSDL messages
<wsdl:message name="Suite_Product_Association_WSSoapIn">
<wsdl:part element="s0:Suite_Product_Association_WS" name="parameters" />
</wsdl:message>
<wsdl:message name="Suite_Product_Association_WSSoapOut">
<wsdl:part element="s0:Suite_Product_Association_WSResponse" name="parameters" />
</wsdl:message>
XSD schema
<xsd:schema elementFormDefault="qualified" targetWeb service URL="urn:
PDL_Suite_Product_Association_WS">
<xsd:element name="Suite_Product_Association_WS" type="s0:CreateInputMap" />
- <xsd:sequence>
<xsd:element name="instanceId" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element

name="Submitter" type="xsd:string" />
name="Suite_ID" type="xsd:string" />
<xsd:element name="Suite_Instance_ID" type="xsd:string" />

<xsd:element name="Suite_Name" type="xsd:string" />
<xsd:element name="Vendor_Assignee_Groups" type="xsd:string" />
<xsd:element
<xsd:element
<xsd:element
<xsd:element
<xsd:element
name="z1D_ExistingIID" type="xsd:string" />

name="z1D_Manufacturer" type="xsd:string" />
name="z1D_Manufacturer2" type="xsd:string" />
name="z1D_ModelVersion" type="xsd:string" />
name="z1D_ModelVersion2" type="xsd:string" />

<xsd:element name="z1D_ProductName2" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
- <xsd:simpleType name="StatusType">
<xsd:enumeration value="New" />
<xsd:enumeration value="Assigned" />
<xsd:enumeration value="Fixed" />
<xsd:enumeration value="Rejected" />
<xsd:enumeration value="Closed" />
</xsd:restriction>
</xsd:simpleType>
<xsd:element name="Suite_Product_Association_WSResponse" type="s0:CreateOutputMap" />
BMC Atrium Core 9.0
Page 1994 of 2268
Home
- <xsd:sequence>
</xsd:sequence>
</xsd:complexType>

Product_ID
Product ID which is to be associated with a suite.
Product_Instance_ID
Product instance id with the about product ID.
Suite_ID
The suite product ID.
Suite_Instance_ID
The suite instance ID.
z1D_Manufacturer2
The manufacturer name of the suite.
z1D_ModelVersion2
The product model/version of the suite.
z1D_ProductName2
The suite product name.
z1D_Manufacturer
The manufacturer name of the product.
z1D_ModelVersion
The product model/version of the product.
z1D_ProductName
The product name.
Short_Description
Status
Submitter
Return value
Request_ID
Returned after successful association of the product with the suite.
BMC Atrium Core 9.0
Page 1995 of 2268
Home
Troubleshooting
The following topics provide information and instructions for responding to errors and for fine tuning
your BMC Atrium Core installation:
Working with logs
Working with error messages
BMC Atrium Core upgrade issues
BMC Atrium Core configuration issues
BMC Atrium Core Console and Atrium widget issues
BMC Atrium Core plug-in issues
BMC Atrium Core miscellaneous issues
BMC Atrium Integration Engine issues
Data model issues
Reconciliation Engine issues
Investigating CMDB Data Issues
CMDB Indexes
Tip
For information about issues corrected in this service pack, see Known and corrected
issues.
BMC Atrium Core 9.0
Page 1996 of 2268
Home
Working with logs

The following topics provide logging and debugging information for BMC Atrium CMDB, BMC
Atrium Integration Engine, and the BMC Remedy Action Request System (BMC Remedy AR
System) server:
BMC Atrium Core Maintenance Tool
AR System server logging
Normalization Engine logging
BMC Atrium Service Context logging
BMC Atrium Impact Simulator logging
BMC Atrium Integration Engine logging and debugging
BMC Atrium CMDB logging
BMC Atrium Core Console server-side logging
BMC Atrium Core Console client-side logging
BMC Atrium Core Maintenance Tool

This section covers the following topics:
Overview
Launching BMC Atrium Core Maintenance Tool
Maintenance Tool Activities
Troubleshooting issues using BMC Atrium Core Maintenance Tool
Related Information
Overview
Many BMC products use the Common Install Framework, which is an installation program.
Products using the Common Install Framework install the Maintenance Tool.
The Maintenance Tool provides a common tool to access diagnostics and utilities that are useful
when troubleshooting BMC Atrium Core related issues. The Maintenance Tool provides a common
tool to access diagnostics and utilities. You can use the Maintenance Tool to collect diagnostic
information, open and view log files, or search logs to identify issues. The BMC Atrium Core
Maintenance Tool also gives you access to installation and uninstallation logs.
Launching BMC Atrium Core Maintenance Tool

BMC Atrium Core Maintenance Tool can be launched in a normal manner as well as in silent mode.
For details, see Launching the BMC Atrium Core Maintenance Tool .
Note
BMC Atrium Core 9.0
Page 1997 of 2268
Home
If this is a new installation, the BMC Atrium Core Maintenance Tool resides in the
installation directory under<BMCAtriumCoreInstallationDirectory>\
atriumcore_home\atriumcore.
If this is an upgrade, the BMC Atrium Core Maintenance Tool might reside in a
folder named for your server. For example, a Microsoft Windows installation
directory path might be C:\Program Files\BMC Software\AtriumCore\
w23ee-doc-vm01\atriumcore.
Maintenance Tool Activities

The BMC Atrium Core Maintenance Tool utility has distinguished tabs, each designated, for you to
perform certain set of activities. You can perform the following activities using the Maintenance Tool
:
View and collect log information: From the Logs tab, you can view the logs related to
installation, uninstallation, and configurations. You can also use the Log Zipper utility to
collect the entire log and diagnostic information in a single zip file. For details, see Collecting
diagnostics using Log Zipper.
Enables product specific logs or configuration: From the Configuration tab, you can
configure the logging settings for normalization and reconciliation. You can also manage and
validate extensions from this tab.
Perform health check: From the Health Check tab, you can run a post installation health
check on your files. For details, see Performing health check.
Encrypt password: From the Encryption tab, you can generate an encrypted password to
use when running a silent installation. For details, see Encrypting passwords using the BMC
Atrium Core Maintenance Tool .
Deploy DSO mapping: From the DSO Mapping tab, you can deploy DSO mappings.
Follow the steps are specified in the DSO deployment wizard.
Troubleshooting issues using BMC Atrium Core Maintenance Tool

If an issue occurs while running Maintenance Tool, investigate it by performing the following.
1. Allow a minute for the Maintenance Tool to start.
The Maintenance Tool opens a command prompt window briefly and loads the components.
The user interface might take a minute to display.
2. If accessing the server remotely, verify the display environment is configured properly.
Maintenance Tool is a graphical display, so the display environment must be configured on
UNIX.
When accessing a Windows system remotely using Terminal Services, the Maintenance
Tool takes longer to display.
3.
BMC Atrium Core 9.0
Page 1998 of 2268
Home
3. Verify you access the server with a user with correct permissions.
The Maintenance Tool leverages the environment configured during installation, including
environment variables and permissions to files and the JVM environment for the
Maintenance Tool. Accessing the OS as the user who performed the installation is a good
method to ensure the proper environment is available.
4. Run the Maintenance Tool from the command line, which does not require a graphical user
interface.
See To run Log Zipper from the command line .
Related Information
BMC Remedy AR System Maintenance tool
BMC Remedy IT Service Management Maintenance tool
BMC Service Request Management Maintenance tool
BMC Service Level Management Maintenance tool
Launching the BMC Atrium Core Maintenance Tool

This section covers the following topics:
To launch the BMC Atrium Core Maintenance Tool
To run the BMC Atrium Core Maintenance Tool in silent mode
To launch the BMC Atrium Core Maintenance Tool

1. Access the system where BMC Atrium Core is installed.
2. Navigate to the directory where BMC Atrium Core is installed.
This is the directory identified by the environment variable ATRIUMCORE_HOME.
3. Change directories to the atriumcore directory.
4. Run the Maintenance Tool:
On Windows, go to your installation directory and double-click
On UNIX, go to your installation directory and run ./AtriumCoreMaintenanceTool.sh.
Each time that you run the BMC Atrium Core installer or uninstaller, a log file is created and a tab in
the BMC Atrium Core Maintenance Tool is created. The tab's name reflects the date and time the
installer or uninstaller is run.
In each log, errors are highlighted in red, and warnings are highlighted in yellow .
To run the BMC Atrium Core Maintenance Tool in silent mode

You can run the BMC Atrium Core Maintenance Tool silently by entering the -silent parameter at
the command line. You can use the -silent option to run the log zipper, encryption, or DSO
mappings.
1.
BMC Atrium Core 9.0
Page 1999 of 2268
Home
1. Open a command window and then navigate to the directory where the BMC Atrium Core
Maintenance Tool is installed.
If this is a new installation, the Maintenance Tool resides in the installation directory under <
bmcAtriumCoreInstallationDirectory>\atriumcore_home\atriumcore.
2. Run the installer with the -i silent option.
On Windows, enter:
AtriumCoreMaintenanceTool.cmd -i silent <tabName> <commandName>
On UNIX, enter:
AtriumCoreMaintenanceTool.sh -i silent <tabName> <commandName>
For example, to run the log zipper for BMC Atrium Core, enter:
AtriumCoreMaintenanceTool.cmd -i silent -logs -zip_logs
By default, the output is zipped and then stored in the Users profile folder. For example:
C:\Users\Administrator\AppData\Local\Temp\2\AtriumFoundationLogs.zip
To specify a different output file name or location, add the -output_file=<
output_file_option> parameter. For example:
AtriumCoreMaintenanceTool.cmd -i silent -logs -zip_logs -output_file
=C;\AtriumCore7700.zip
To display help, enter AtriumCoreMaintenanceTool -help.
Collecting diagnostics using Log Zipper

Log Zipper is a feature of the Maintenance Tool which collects logs, configuration, and environment
information to a zip file which are necessary for debugging. This simplifies the process of providing
diagnostics to other administrators or to Customer Support for analysis.
Important
If you set IATEMPDIR environment variable to a directory other than the default
temporary directory, use the Log Zipper to zip the log files that are saved to the
directory to which IATEMPDIR is set.
Version and Compatibility of Log Zipper and Maintenance Tool
The Maintenance Tool and Log Zipper are installed and upgraded with the product.
They cannot be installed or upgraded independent from the product. The Registry
Version and Model Version are different from the product version. The features
available in the Maintenance Tool are determined by:
Version of Common Install Framework
Version of the product which uses them
BMC Atrium Core 9.0
Page 2000 of 2268
Home
Features utilized by the product

The Log Zipper output file generated by an earlier version of the Maintenance Tool
can be viewed by a later version of the Maintenance Tool.
The Registry Version in the ProductRegistry.xml file and the Model Version in the
OperatingSystemData.xml file indicate the version of the Log Zipper used to
create the file. In general, it is easier to note the version of the product in the
Product Registry to know what features are available in the Maintenance Tool, and
ignore the Registry Version and Model Version.
Use the Log Zipper for failures related to installation as well as failures that can happen
post-installation. Because the zipped log file name is based on date and time, you can overwrite the
zip file if you run the logzipper command at intervals less than one minute apart. You can zip BMC
Atrium CMDB installation logs as well as logs of other installed components.
Note
If you are running a Telnet session, you must open a new Telnet window to view logs or
prepare log files for BMC Customer Support.
To run the Log Zipper

To run the All Log Zipper
To run Log Zipper from the command line
To view installation and uninstallation log files
To troubleshoot issues with zipping logs

1. In the BMC Atrium Core Maintenance Tool, click the Logs tab.
2. Click Zip Logs.
To prepare the log files from the command line, go to the directory where BMC Atrium Core
Maintenance Tool is installed, run the following command to have the logs zipped and
created in the TEMP directory:
Windows: AtriumCoreMaintenanceTool.cmd -console -logzipper
UNIX: ./AtriumCoreMaintenanceTool.sh -console -logzipper
In the TEMP directory (Windows) or the /var/tmp servers folder (UNIX), a zip file is
created with the date and time appended to the file name:
AtriumCoreLogs_mmddyyyy_hhmmss.zip.
3. Provide the AtriumCoreLogs_mmddyyyy_hhmmss.zip output file, located in your temp
directory, to BMC Customer Support.
BMC Atrium Core 9.0
Page 2001 of 2268
Home

2. Click Zip All Logs.
In the TEMP directory (Windows), the /var/tmp/ server folder (HP-UX and Solaris), and /tmp
(Linux and AIX) servers folder, a zip file is created with the date and time appended to the
file name: AllLogs-iBMC-3Y1F5BS.adprod.bmc.com.zip.
3. Provide the AllLogs-iBMC-3Y1F5BS.adprod.bmc.com.zip output file, located in your temp
To run Log Zipper from the command line

Run Log Zipper from the command line to collect diagnostics to a file without launching the
Maintenance Tool. This procedure is useful when issues prevent launching or using the
Maintenance Tool user interface.
The zip_all_logs command - when available - performs the same action as running
Maintenance Tool and clicking Zip All Logs. This generates an archive file with the Log Zipper
output file for each product installed on the system.
Run the Log Zipper from the command line as shown below:
Windows: %ATRIUMCORE_HOME%\atriumcore\AtriumCoreMaintenanceTool.cmd --silent --logs -zip_logs

Windows: %ATRIUMCORE_HOME%\atriumcore\AtriumCoreMaintenanceTool.cmd --silent --logs -zip_all_logs
UNIX: $ATRIUMCORE_HOME/atriumcore/AtriumCoreMaintenanceTool.sh --silent --logs -zip_logs
UNIX: $ATRIUMCORE_HOME/atriumcore/AtriumCoreMaintenanceTool.sh --silent --logs -zip_all_logs
To view installation and uninstallation log files

You can view the installation and uninstallation log files from the BMC Atrium Core Maintenance
Tool.
2. Click Install Log or Uninstall Log.
A tab for each installation log or uninstallation log is displayed.
To browse for a specific log file, click Browse to Log instead.
3. Click the tab for the log you want to view.
To troubleshoot issues with zipping logs

1. Verify there is sufficient space in the temp directory.
Log Zipper will collect files and create the zip file in the user temporary directory.
2.
BMC Atrium Core 9.0
Page 2002 of 2268
Home
2. Remove older or unnecessary files from the product logs directory

Many products configure Log Zipper to collect all files in a particular directory, which will
increase the time to run and the size of the resulting file if there are many files in the
directory.
3. Open the Maintenance Tool configuration file and search for errors.
In the Maintenance Tool, click Configuration Log to view the configuration log in the log
viewer. Errors encountered by the Maintenance Tool are written in the configuration log.
4. Choose Edit > Filter to filter on Details that contain Adding file.
5. In the filtered log entries, check what was the last file or directory Log Zipper attempted to
add to see if an error was encountered.
AR System server logging

The BMC Remedy AR System server also provides error logs, such as arerror.log and arapi.log.
The arerror.log file records all AR System server error messages, such as notifying you that your
AR System server stopped responding, and so on.
For example, you might receive an ARERR 92 Timeout during database update error on
the BMC Atrium Core client. One of the possible causes for this timeout error might be that the AR
System server stopped responding. To troubleshoot this error, try to reproduce the error and
examine other logs to identify the cause of the error.
The arapi.log file traces all AR System API calls that are run on the server. Both arerror.log and
arapi.log files are located by default in the C:\Program Files\BMC Software\ARSystem\Arserver\
Db subdirectory of your AR System server installation directory.
If you enable the Filter and SQL logging options , the log files are created under the Program Files
\BMC Software\ARSystem\Arserver\Db subdirectory of your installation directory by default (
Windows ) or <serverInstallationDirectory>/db (UNIX ). You can change the file names and
location of any of these logs at any time.
Make sure that you examine the arerror.log and cmdbengdebug.log files for any CMDB Engine
library loading errors, If any errors occurred when loading the library during AR System server
starts up, BMC Atrium Core might not function correctly.
In addition to logging errors to the cmdbengdebug.log file, BMC Atrium Core also writes to the
arerror.log file under certain circumstances, such as the following scenarios:
If the RPC program was not registered when making a BMC Atrium Core API call from a
BMC Atrium Core client, an error is written to arerror.log. This error occurs because the AR
System server did not load the CMDB Engine library.
If the OBJSTR:Class form that holds BMC Atrium CMDB metadata is not available on the
server, an ARERR 9755 error is written to arerror.log, such as the following example, and
the CMDB Engine library fails to load:
BMC Atrium Core 9.0
Page 2003 of 2268
Home
Thu May 03 15:01:21 2007 390600 : Error encountered while initializing (

Initialization routine) the shared library (ARERR 9755) Thu May 03 15:01:
21 2007 bmc.cmdb.cmdbEngine Thu May 03 15:01:22 2007 390600 : Form does
not exist on server : OBJSTR:Class (ARERR 303)
For more information about these AR System server log files, see Troubleshooting in the BMC
Normalization Engine logging

The Normalization Engine logs errors in the following log files:
neAPI.log Records the messages that are generated by the Normalization Engine API
calls.
neContinuous.log Records the messages that are generated by the Normalization
Engine continuous job processing.
neJob.<DatasetId>.<NNNN>.log Records the messages that are generated by the
Normalization Engine batch job processing. The DatasetId component in the file name
indicates the dataset ID on which the normalization activity is to be performed and the NNNN
component is a four-digit sequence number, for example, neJob.BMC.SAMPLE.0000.log
nePluginServer.log Records information, such as the Normalization Engine is starting up
, the cache is loading up, and so on.
The Normalization Engine logs, which classify the messages into error, warning, information, and
debug categories, are enabled by default. Each entry in the log provides the following details:
File name and line number The file name and line number on which the error occurred.
User name The user that started a specific Normalization Engine job. This information is
not logged in the neContinuous.log and neBatch<timeStamp>.log files.
TID The thread that the Normalization Engine job used when the message was generated
.
Message The message for the log entry.
You can specify the following additional parameters for logging in the Configuration Editor window
of the Normalization Engine console.
API Log File Location Enables you to specify a directory location different than the default
location on your system where the log files are to be written. The Normalization Engine log
files are located in the <atriumInstallationDirectory>/Logs directory by default.
API MAx File Size (MB) Enables you to specify a maximum size, in megabytes (MB), for
your log file. When the log file reaches the specified limit, the system automatically creates a
backup of the log file and continues to store the log entries in a new log file. The default
value for the CMDB-Max-Log-File-Size parameter is set to 5 MB.
BMC Atrium Core 9.0
Page 2004 of 2268
Home
API Log Level Specifies the level of logging for the log files. These levels determine the
types of messages that are logged for the Normalization Engine. The logging levels are
inclusive of their preceding levels. The debug levels are:
Error Logs messages for error.
Warning Logs messages for warnings.
Information Logs informational messages. This the default logging level.
Debug Logs additional details for errors, which are used for debugging purposes.
This is the highest level of logging.
For more information about setting the log file parameters for the Normalization Engine, see the
BMC Atrium CMDB Normalization and Reconciliation information.

BMC Atrium Service Context log file
To enable BMC Atrium Service Context logging
To disable BMC Atrium Service Context logging
To view the BMC Atrium Service Context log
BMC Atrium Service Context log file

BMC Atrium Service Context logs errors in the ServiceContext.log file (or in the
AtriumPluginSvr.log file for upgraded servers). The log file is stored in the <
BMC_Atrium_installDirectory>\Logs folder. Each entry in the log provides the following details:
Thread The thread that the transaction used when the message was generated
Timestamp The date and time of the log entry
Log Type The type of log entry:
Debug (Default ) Logs detailed information for errors, which is used for debugging
purposes. This is the highest logging level.
Information Logs informational messages.
Error Logs messages for errors.
Fatal Logs messages and details for fatal errors.
All these logging levels are inclusive of their preceding levels. For example, if you set
the logging level at Debug, you receive log messages for Fatal, Error, Warning, Info,
and Debug types.
Message The message for the log entry
You can configure a number of logging parameters in the shared logging plugin. For more
information, see http://logging.apache.org/log4j/1.2/index.html .
BMC Atrium Core 9.0
Page 2005 of 2268
Home
To enable BMC Atrium Service Context logging

a. Log on to BMC Remedy AR System.
b. In the navigation pane of the Home page, select BMC Atrium Core > Service
Context Administration.
2. In the Logging tab, choose the logging level from the Specify the Logging Level list.
Your changes take effect immediately.
To disable BMC Atrium Service Context logging

2. In the Logging tab, select OFF from the Specify the Logging Level list.
Your changes take effect immediately.
To view the BMC Atrium Service Context log

2. In the Logging tab, click View Log.
The log file opens in the appropriate text file viewer.
BMC Atrium Impact Simulator logging

BMC Atrium Impact Simulator logs errors in the ais.log and ais_cell.log files. The ais.log file
records messages generated by the BMC Atrium Impact Simulator plug-in, such as notifying you
that BMC Atrium Impact Simulator is starting up and that the BMC Atrium Impact Simulator receiver
started on a specific port number. The ais_cell.log file records errors that are generated by the
BMC Atrium Impact Simulator computation cell.
BMC Atrium Impact Simulator plug-in logging
To enable BMC Atrium Impact Simulator plug-in logging
BMC Atrium Impact Simulator plug-in logging

BMC Atrium Impact Simulator uses the Apache log4j mechanism to log messages. Each entry in
the log provides the following details:
BMC Atrium Core 9.0
Page 2006 of 2268
Home
Thread The thread that the transaction used when the message was generated.
Log Type The type of log entry: debug, information, warning, error, or fatal.
You can specify additional logging options for BMC Atrium Impact Simulator plug-in in the
log4j_pluginsvr.xml configuration file. The debug level parameter specified level of logging that
you require for your BMC Atrium Impact Simulator plug-in transactions. To set the debug logging to
a different level, add CMDB-Debug-Level: <loggingLevel> to the configuration file and restart the
AR System server. The debug levels are:
Debug Logs messages for severe errors, which are used for debugging purposes. This is
the highest logging level.
Information Logs informational messages. This is the default logging level.
Error Logs messages for errors.
Fatal Logs messages and details for the fatal errors.
For more information about the additional parameters that you can specify for the BMC Atrium
Impact Simulator plug-in, see http://logging.apache.org.
To enable BMC Atrium Impact Simulator plug-in logging

1. From the <AtriumInstallation>/AtriumCore/<hostName>/cmdb/plugins/shared/ directory,
open the log4j_pluginsvr.xml file.
2. In the file, search for the Logger for AIS string.
3. For the com.bmc.atrium.filterplugin.ais and com.bmc.atrium.ais loggers, set the level
value parameter to DEBUG.
Your changes will take effect shortly or after the next time you restart the AR System server.

You can refer to the following log files to troubleshoot issues with Atrium Integrator:
Mid tier logs
Atrium Integrator Carte server logs
ARSYS.ARDBC.PENTAHO plug-in logs
Atrium Integrator Spoon logs
AIE to AI migration utility logs
Development-to-production utility logs
Atrium Integrator Maintenance tool logs
Atrium Integrator install and upgrade logs
aiexport utility logs
BMC Atrium Core 9.0
Page 2007 of 2268
Home
Mid tier logs

The mid tier log file provides details of all the Atrium Integrator related tasks you can perform from
the Atrium Integrator consoles. You can get information about:
Issues related to creating, running, stopping, and deleting jobs
List of jobs
List of job run status
Issues related to creating and deleting data store connections
Issues related to creating and deleting job schedules
Mid tier log location
The mid tier logs are located in the following directory:
Mid-tierInstallationDirectory\Logs
You can also configure mid tier log locations to different file.
If you are running the Tomcat web server, the Atrium Integrator console log files are located
in the following directory on the computer where you installed the mid tier:
C:\Program Files\Apache Software Foundation\Tomcat 6.0\logs\stdout_ currentDate.
log
Configuring mid tier log locations to a different file

For better debugging, you can configure the mid tier log location to a different file.
To configure mid tier log location to a different file

1. Open the log4j.properties file from the following location:
ARInstallationDirectory\midtier\WEB-INF\classes\log4j.properties
2. Add the following information in the log4j.properties file:
log4j.rootLogger=DEBUG, atrium
log4j.appender.atrium=org.apache.log4j.RollingFileAppender
log4j.appender.atrium.File=_ARInstallation Directory_/midtier/logs/<filename>.log
log4j.appender.atrium.MaxFileSize=25MB
log4j.appender.atrium.MaxBackupIndex=10
log4j.appender.atrium.layout=org.apache.log4j.PatternLayout
log4j.appender.atrium.layout.ConversionPattern=%p %t %c - %m%n
3. Save the file.

4. Open the services-config.xml file from the following location:
ARInstallationDirectory\midtier\WEB-INF\AtriumIntegrator\flex\services-config.xml
5. Change the target level=WARN parameter to DEBUG.
6. Restart the mid tier web server.
BMC Atrium Core 9.0
Page 2008 of 2268
Home

The Atrium Integrator Carte server log files contains following information about job and
transformation execution:
Job start
Job stop
Transformation start
Transformation stop
Atrium Integrator Carter server log directory location:
ARInstallationDirectory\ARServer\Db
Refer to the following files:
arcarte.log
arcarte-stdout-YYYY-MM-DD.log
arcarte-stderr-YYYY-MM-DD.log
ARSYS.ARDBC.PENTAHO plug-in logs

For detailed information about the error messages related to the ARSYS.ARDBC.PENTAHO
plug-in.
ARSYS.ARDBC.PENTAHO plug-in log location:
ARInstallationDirectory\ARServer\Db
Refer to the arjavaplugin.log file
Atrium Integrator Spoon logs

Logging file for Atrium Integrator Spoon is located at in the following directory:
%temp%\Spoon.log file
AIE to AI migration utility logs

status of the migration process. You can also refer to the log files for troubleshooting information.
AIE to migration utility log location:
ARInstallationDirectory\diserver\data-integration\ngie\log
MigrationInfo.txt
Migrationdbg.log
BMC Atrium Core 9.0
Page 2009 of 2268
Home
Development-to-production utility logs

The development-to-production utility logs provide logging information about migration of jobs and
transformation from one computer to another. This log generated when you execute to the
development-to-production utility.
Development-to-production utility log location:
ARInstallationDirectory\diserver\data-integration\ngie\log
devtoprodout.txt
devtoproderror.txt
Atrium Integrator Maintenance tool logs

Atrium Integrator Maintenance tool logs provide logging information about jobs you import using the
tool.
Atrium Integrator Maintenance utility log location:
TEMP directory on Windows or the /var/tmp directory on UNIX
Refer to the atriumintegrator_configuration_log.txt file
Atrium Integrator install and upgrade logs

When you are installing or upgrading Atrium Integrator, logging information about jobs and
transformations that are imported is available at the following location:
TEMP directory on Microsoft Windows or the /var/tmp directory on UNIX
Refer to the atriumintegrator_install_log.txt file
aiexport utility logs

When you use the aieexport utility to take backup of jobs before upgrading, logging information is
available at the following location:
ARInstallationDirectory\diserver\data-integration
Refer to the atriumintegrator_install_log.txt file
BMC Atrium Integration Engine logging and debugging

You can diagnose BMC Atrium Integration Engine errors and verify the completion of data
exchanges by using the logging and debugging facilities in BMC Atrium Integration Engine. The
error logging, which is specified in the aie.cfg file, aids in long-term management of data
exchanges.
Enabling debug logging
Log messages
BMC Atrium Core 9.0
Page 2010 of 2268
Home
Data exchange log messages

Debug messages
Enabling debug logging

You can configure and test data exchanges by using the debug option. The debugging files provide
detailed operational information to diagnose errors in a data exchange. You can log various levels
of debug information from the Data Exchanges Information window.
To enable debug logging

1. On the Data Exchanges Information window, select the Advance Settings tab.
2. In the Enable Debug Logging field, click Yes.
3. In the Debug File Path field, browse to select the location for the debug files.
If you enable debug logging but do not specify a path for the file, the log is written to the
default debug path that you specified during installation of BMC Atrium Core. In the Debug
File Creation area, perform one of the following steps:
To create new log files and write the contents of the previous log files to the
dataExchangeName_timeStamp.bak file, click Create Backup.
To preserve the log files and their contents, click Append To Existing. New
information is appended to the existing file or is wrapped to the top of the file,
depending on the value in the Max Debug Size field.
4. In the Max Debug Size field, type the maximum size (in bytes) for the log file.
Note
You cannot set the log file size smaller than 4096 because that could be the length
of a single log line. When the log file reaches the maximum limit, depending on the
Log-File Creation settings, either the backup file is created or the new information
wraps to the top of the file, overwriting the old information.
5. In the Enable Thread Based Logging field, click Yes to create thread-based log files.
The name of the log file would be formatted as follows:
dataExchangeName_threadNumber.dbg
6. In the Debug Level area, select any of the following check boxes:
API Calls Logs information about all API calls made by BMC Atrium Integration
Engine. Information is logged on entry and exit of every API call.
SQL Statements Logs SQL commands sent to the database. Information is logged
for each SQL command issued, including a time stamp.
Record Summary Logs summary information for each record. Summary
information includes whether the record is being added, updated, or deleted, and
whether that operation was successful.
BMC Atrium Core 9.0
Page 2011 of 2268
Home
Record Details Logs detailed level information for each record. Details are
provided at the field level. Information can include the value for each Source field,
how it is getting converted to the Destination field after applying any rules, and
whether the record is successfully added, updated, or deleted.
7. Click Apply To All Exchanges.
The debug settings are applied to all exchanges that are in the Active state.
8. Click Save.
Log messages
Log messages record all major events about data exchanges and individual record transfers. All log
events are recorded both in the BMC Atrium Integration Engine log file and the AIE:Log form.
Log messages provide broad information about events and errors. Use the log of debug events to
help you understand the nature of problems that you encounter and how to correct them. Log
messages are sorted into the following event categories:
Service Status Indicates when a data exchange starts and when it ends.
Session Statistic Provides statistics about the number of records processed for the main
mapping of a data exchange. The count includes records added, updated, or not transferred
due to an error.
Service Error Indicates an error that prevents the data exchange from taking place.
Transfer Warning Indicates that a transfer was made despite a possible problem, such as
data truncated to fit a field. The key of the request is provided in the message text.
Transfer Error Indicates that a transfer was not made due to a problem, such as a data
conversion error. The error message indicates the key of the record that failed and any
associated AR System server error messages. More detailed information about why a record
was not transferred is recorded in the debug file (if debugging is activated).
Adapter Error Indicates that the adapter could not be used by BMC Atrium Core. This
could be the result of an invalid registry entry, a . dll file not in the correct path, and so on.
Each category has both informational messages and error messages. You can use the log
message categories to determine what kind of workflow to generate. For example, you might want
workflow to send notifications, based on log message numbers or categories, to the individuals in
your company who are responsible for managing various parts of the data exchanges.
Data exchange log messages

The following table lists log messages that you might receive during a data exchange. Some
messages contain placeholders, such as %1, %2, and so on. These placeholders represent text
that is inserted during run time.
Log file messages
BMC Atrium Core 9.0
Page 2012 of 2268
Home
ID
number
Message
Description
3301
BMC Remedy Link starting to
The BMC Atrium Integration Engine service started a data exchange
process requests <%1>.
session at the time indicated.
BMC Remedy Link Terminating <%
An error condition caused the BMC Atrium Integration Engine service to

terminate at the indicated time.
3302
1>.
3303
No Field Mapping entries

defined for VendorApp: <%1>.
No requests exist on the Data Field Mapping tab of the AIE:ARMappingInfo

form for the BMC Atrium Integration Engine service to use. The BMC
Atrium Integration Engine service does not process requests without field
mapping rules defined.
3304
Malloc failed.
The BMC Atrium Integration Engine service ran out of available memory
and cannot continue. This is a fatal error.
3305
No Rules defined for field
No rules were defined for the specified field mapping. The BMC Atrium
mapping <%1>; field mapping
Integration Engine service ignores this request and continues. After rules
are defined, the BMC Atrium Integration Engine service uses this request.
definition ignored.
3306
Failed to update form <%1>

request-id <%2>.
The BMC Atrium Integration Engine service received an error while trying to
process the specified form and request ID. An additional error message
precedes this error, indicating that a call to the AR System server failed.
3307
Failed to create request in

form <%1>.
The BMC Atrium Integration Engine service received an error from the AR
System server that was trying to create a request in the specified form.
3308
Failed to add request <%1>to

form <%2>.
The BMC Atrium Integration Engine service received an error while trying to
add a unique identifier to the specified form. Additional errors precede this
one, indicating which calls to the AR System server failed.
Failed to open configuration
The BMC Atrium Integration Engine service could not find or open aie.cfg.
file <%1>.
Verify that the configuration file exists and is accessible.
Required configuration
The specified configuration parameter was missing or typed incorrectly.
parameter is missing -- <%1>.
Add or correct the entry in aie.cfg.
Form <%1>does not exist or is
The specified form does not exist or is not accessible. Verify that the form
not accessible.
exists and that the login used by the BMC Atrium Integration Engine service
has permission to create, modify, and delete requests.
3313
No valid field mapping rules

are defined; daemon cannot run
.
No valid requests exist in the corresponding mapping consoles for AR and

CMDB. Correct the existing requests' rules, or create valid rules.
3314
Failed to load message DLL -- <
The BMC Atrium Core service could not load the indicated message .dll file.
3310
3311
3312
%1>.
3315
Failed to delete request <%1>

for form <%2>.
3316
The BMC Atrium Integration Engine service could not delete the specified
request in the form. The BMC Atrium Integration Engine service deletes
requests that do not have a matching primary form request. Make sure that
the account being used by the BMC Atrium Integration Engine service has
permission to delete requests.
One or more required fields
The specified form is missing one or more required fields. Use the
are missing from form <%1>.
respective Mapping Information windows for BMC Remedy Action Request

System Server (BMC Remedy AR Server) forms, CI classes, and
relationship classes to create or modify all the field mappings.
3317
BMC Atrium Core 9.0
Page 2013 of 2268
Home
ID
number
Message
Description
A fatal setup error occurred;
A nonrecoverable error occurred while the BMC Atrium Integration Engine
service cannot run until it is

corrected.
service was being set up to process requests. Previous messages indicate

what is wrong.
3318
A setup error occurred; the

service will try again at its
next scheduled time.
A recoverable error occurred while the BMC Atrium Integration Engine

service was being set up to process requests. A previous message
indicates what is wrong.
3319
Setup completed successfully,

starting to process requests.
The BMC Atrium Integration Engine service completed setup and will begin
a data exchange.
3320
Failed to update form <%1>

request <%2>.
The BMC Atrium Integration Engine service received an error from the AR
System server while trying to update the indicated request in the specified
form.
Could not find the field

mapping name <%1>for request <
The BMC Atrium Integration Engine service was unable to locate the
indicated field mapping name in the specified form for the indicated request
%2>in form <%3>.
. The request is not updated.
No data was returned using

field mapping definition <%1>
The BMC Atrium Integration Engine service did not receive data from the
AR System server for the indicated request.
3321
3322
for request <%2>.

3323
BMC Remedy Link finished

processing requests <%1>.
The BMC Atrium Integration Engine service completed a data exchange at

the indicated time.
3324
BMC Remedy Link does not have

a license, and cannot be run.
The BMC Atrium Integration Engine service does not have a license.
3325
Session <%1>statistics: AR
Statistics about the BMC Atrium Integration Engine service transactions: <
%1> -- Name of the session ID tag from the AIE:DataExchange form. <%2>
-- Number of AR System keys processed. <%3> -- Number of external data
store keys processed.
System requests: <%2>, Vendor

requests: <%3>.
3326
Session <%1>statistics:
Requests added: <%2>, updated:
<%3>, errors: <%4>, warnings:

<%5>.
3327
Session <%1>: Request <%2>

error: record ignored due to
error.
3328
3329
Session <%1>: Request <%2>
The record was not exchanged for the named session ID tag and the
named data key. Verify that the session ID tag and the data key are correct
in the field mapping.
warning: one or more fields
The fields were not processed for the named session ID tag and the named
data key. Verify that the session ID tag and the data key are correct in the
not processed.
field mapping.
Adapter <%1>: Cannot find
An BMC Atrium Integration Engine adapter is not present at the specified

path. Check the BMC Atrium Integration Engine installation directory.
adapter file at <%2>.

3330
Statistics about the BMC Atrium Integration Engine service transactions: <
%1> -- Name of the session ID tag from the AIE:FieldMapping form. <%2> - Number of requests added. <%3> -- Number of requests updated. <%4> - Number of requests ignored due to an error. <%5> -- Number of requests
updated and added, but some fields were ignored due to an error.
Adapter <%1>: Failed to load

adapter <%2>.
This issue can occur on UNIX and Windows computers. The adapter library
might fail to load due to incorrect environment variable settings. For
example, this issue might occur on a UNIX computer if the
LD-LIBRARY-PATH environment variable does not contain the correct
path.
3331
BMC Atrium Core 9.0
Page 2014 of 2268
Home
ID
Message
Description
Adapter <%1>: GetProcAddress()
The BMC Atrium Integration Engine service was unable to get function
failed.
address in the Adapter library.
Adapter <%1>: Failed to
The BMC Atrium Integration Engine service failed to initialize adapter object
initialize adapter: <%2>.
. Check external data store configuration parameters.
Adapter <%1>: Failed to create
The BMC Atrium Integration Engine service failed to allocate memory for
adapter object.
number
3332
3333
adapter object: <%2>.

3334
3336
Adapter <%1>: Failed to

terminate the adapter: <%2>.
The BMC Atrium Integration Engine service failed to close the adapter
connection and release resources.
Adapter <%1>: Failed to open
The BMC Atrium Integration Engine service failed to open an adapter
connection to data source: <%2
connection with data store.
>.
3337
3339
There is another BMC Atrium
Another BMC Atrium Integration Engine process is running on this
Core process running on this

machine, engine exit.
computer. Exit the specified instance of BMC Atrium Integration Engine.
Active event request without a
The data exchange is activated with improper configuration.
configured data exchange. Data

exchange: <%1>.
3340
%s adapter cannot obtain a

license as the maximum number
of exchange for a Demo license
has exceeded. Data exchanges
using that adapter cannot run.
The adapter cannot obtain a license because the maximum number of

exchanges for a Demo license has been exceeded.
Debug messages
This topic discusses debug messages, debug files, debug logging, and data exchange statistics for
BMC Atrium Integration Engine.
Debug message types
Using the instanceName_aiemain.dbg debug file
Using an exchangeName.dbg debug file
Initialization phase debug logging
Processing phase debug logging
Data exchange statistics
Debug message types

BMC Atrium Integration Engine generates debug messages that help you detect errors and events
in the data exchange process. These debug messages are of the following types:
instanceName_aiemain.dbg A special, high-level debug file that records details and

problems with the BMC Atrium Integration Engine service. It does not record events that
occur for individual data exchanges.
BMC Atrium Core 9.0
Page 2015 of 2268
Home
exchangeName.dbg After each data exchange starts, the BMC Atrium Integration
Engine service creates a unique debug file for the exchange.
instanceName_aieEventCleanup.dbg Logs messages for event-driven data exchanges
that are not active.
instanceName_aieEventListener.dbg Logs messages when the Verify and Run Now
commands or the event-driven data exchange is not working correctly.
instanceName_aieEventMgr.dbg Logs messages specific to the current event-driven
data exchange.
Using the instanceName_aiemain.dbg debug file

When you start the BMC Atrium Integration Engine service, you have the option of running it with
debugging enabled or not, depending on whether you specify the debug startup parameters on the
command line.
If you specify the debug startup parameters, the BMC Atrium Integration Engine service creates the
instanceName_eiemain.dbg file and records diagnostic information about the initialization errors.
In addition to startup information, the instanceName_eiemain.dbg file records high-level
information about data exchanges found, licenses issued, licenses absent, and event requests.
Consult instanceName_eiemain.dbg if your data exchange fails to start and no exchangeName.
dbg file is created, or if an event request fails to run.
Note
Only one instanceName_eiemain.dbg debug file is created regardless of how many data
exchanges are configured.
The following text is an example of instanceName_eiemain.dbg:
Starting to look for changes to data exchange definitions

Service has detected 1 active data exchanges on AR System
Location of 'FlatFile' adapter obtained
License granted to FlatFile.
Adapter Version: 7.5.00
Thread started to manage exchange: SamplePullExchange_2
Starting threads to manage event driven requests
Immediate async thread started.
Event Request cleanup thread started.
Waiting for 5 minutes to look for changes to data exchange definitions.
BMC Atrium Core 9.0
Page 2016 of 2268
Home
Using an exchangeName.dbg debug file

If you enable the logging of debug events, when a data exchange starts, the BMC Atrium
Integration Engine service creates a unique debug file for it, assigning it the name of the data
exchange. For example, if the data exchange is named GetDiskDetail, the debug file will have the
name GetDiskDetail.dbg.
Note
If you configure multiple concurrent data exchanges on the Main tab of the AIE:
DataExchange form, the BMC Atrium Integration Engine service debug files are assigned
the name of the data exchange with a sequence number appended to it. Using the
example in the previous paragraph, if two concurrent data exchanges are configured, the
debug file names are getdiskdetail_1.dbg and getdiskdetail_2.dbg.
Each data exchange debug file provides a list of all rules entered in the Data Exchange application
in the order that they are entered on the respective Mapping Information window for BMC Remedy
Action Request System Server (BMC Remedy AR Server) forms, CI classes, or relationship
classes. The debug file also indicates on which tabs of the forms these rules are entered.
Note
AIE:DataMapping, AIE:CMDBDataMapping, and AIE:CMDBRelMapping are
backend forms used to store information. You cannot interact directly with these forms.
Each data exchange debug file records the following events as they take place when a data
exchange is run:
Data retrieved
Any values generated by rule syntax
Data conversions performed
Data updated, created, or deleted
Errors or warnings
For detailed information about the problems that occur in specific data exchanges, enable the log of
debug events in aie.cfg.
BMC Atrium Core 9.0
Page 2017 of 2268
Home
Initialization phase debug logging

During the initialization phase, the BMC Atrium Integration Engine debug facilities record all data
exchange and data handling rules.
The following example shows the information collected when all Debug Level options are selected
on the Advanced Settings tab of the Data Exchanges Information window.
StartDataHandlers: Connection established to both AR/CMDB and vendor

>>>ARS Form Fields:
Field mappings in: 'FlatFileSamplePull'
Rule 1: <First Name (id: 536870914)> Set to data type: 4 (Character)
Rule 2: <Salary (id: 536870916)> Set to data type: 3 (Real)
Rule 3: <Gender (id: 536870917)> Set to data type: 6 (Enum)
>>>ARS Form Key Fields:
Key Rule 1: <Last Name (id: 536870913)> Set to data type: 4 (Character)
>>>ARS System Query:
No query defined. All entries will be processed.
>>>Vendor Rules:
Field mappings in: 'FlatFileSamplePull'
Rule 1: <FNAME> Set to data type: 4 (Character)
Rule 2: <SALARY> Set to data type: 3 (Real)
Rule 3: <GENDER> Set to data type: 2 (Integer)
>>>Vendor Keys:
Key Rule 1: <LNAME> Set to data type: 4 (Character)
>>>Vendor Query:
No query defined: All entries will be processed.
StopDataHandlers: Disconnected from both AR/CMDB and Vendor application{{s}}
Processing phase debug logging

During the processing phase, the debug file shows all rules retrieved from the Data Exchange
application and the page of the respective Mapping Information window for BMC Remedy Action
Request System Server (BMC Remedy AR Server) forms, CI classes, or relationship classes from
which it was retrieved, and the data type of the data defined by the rule.
The debug file identifies the success or failure of the data transfer and provides a detailed error
message for each error.
The following example shows the error messages when all Debug Level options are selected on
the Advanced Settings tab of the Data Exchanges Information window.
Start comparing list of records on Mon Jul 02 16:29:21 2008

SessionID=SamplePullExchange
direction=VendorDataIntoAR
updateType=Both New and Changed
AR System Data Server
Data obtained from Source for mappings: 'FlatFileSamplePull'
BMC Atrium Core 9.0
Page 2018 of 2268
Home
Rule 1: 'FNAME', Value: 'Mary'

Rule 2: 'SALARY', Value: '135'
Rule 3: 'GENDER', Value: '1'
Key Rule 1: 'LNAME', Value: 'Poulos'
Setting
Rule
Rule
Rule
field values of Target for mappings 'FlatFileSamplePull'

1: <First Name (id: 536870914)> set to 'Mary'
2: <Salary (id: 536870916)> set to '135'
3: <Gender (id: 536870917)> set to '1'
Key Rule 1: <Last Name (id: 536870913)> set to 'Poulos'

Adding entry Poulos to form 'AIE:FlatFileSample'
Data obtained from Source for mappings: 'FlatFileSamplePull'
Rule 1: 'FNAME', Value: 'Tom'
Rule 2: 'SALARY', Value: '234'
Rule 3: 'GENDER', Value: '0'
Key Rule 1: 'LNAME', Value: 'Smith'
Setting field values of Target for mappings 'FlatFileSamplePull'
Rule 1: <First Name (id: 536870914)> set to 'Tom'
Rule 2: <Salary (id: 536870916)> set to '234'
Rule 3: <Gender (id: 536870917)> set to '0'
Key Rule 1: <Last Name (id: 536870913)> set to 'Smith'
Adding entry Smith to form 'AIE:FlatFileSample'
Data exchange statistics

The BMC Atrium Integration Engine service debug file also lists the data exchange statistics. When
a data exchange starts, the exchangeName.dbg file records the number of records obtained from
each data store. When a data exchange stops, the exchangeName.dbg file shows statistics of the
number of records actually transferred. For each data exchange, only the statistics for the main
mapping are recorded in the debug file. Statistics for other data mappings are not recorded.
Number of AR System Keys obtained 0.

Number of Vendor Keys obtained 0.
Session statistics: AR requests: 0, Vendor requests: 5
Session statistics: Requests added: 5, updated: 0, deleted: 0, errors: 0, warning
Sleep until next poll interval or scheduled time for data transfer
StopDataHandlers: Disconnected from both AR/CMDB and Vendor application.
BMC Atrium CMDB logging

This section contains logging information about the various BMC Atrium CMDB components, such
as the APIs, Reconciliation Engine, Class Manager, and web services.
Server-side API logging
Java API logging
Java API configuration properties
Reconciliation Engine errors in the log file
Web services logging
Setting log levels for BMC Atrium Core web service logs
BMC Atrium Core 9.0
Page 2019 of 2268
Home
Server-side API logging

BMC Atrium CMDB logs the engine processing in the cmdbengdebug.log file, which helps you to
debug your API program. When you enable logging, the BMC Atrium CMDB records details about
operations, such as SynchMetaData, graph query, and export and import. For more information
about related API functions, see C API functions and C API data structures.
The BMC Atrium CMDB Engine classifies the messages into error, warning, and information
categories. The engine logging is enabled by default and the CMDB-Debug-Flag parameter is
ignored.
Each entry in the log provides the following details:
You can specify the following additional parameters for the logging option in the ar.cfg (ar.conf )
configuration file, depending on your platform:
CMDB-Debug-Level Specifies the level of logging that you require for your API calls.
These levels determine the types of messages that are logged for the calls. The logging
levels are inclusive of their preceding levels.
For example, if you set the debug level to 3, you receive log messages for levels 1, 2, and 3.
To set the debug logging to a different level, add CMDB-Debug-Level: <loggingLevel>
to the configuration file and restart the AR System server. The debug levels are:
1: Error Logs messages for fatal or severe errors.
2: Warning Logs messages for warnings. This the default logging level.
3: Information Logs informational messages.
4: Trace Logs trace messages, which are used for debugging errors.
5: Detail Logs additional details for the errors. This is the highest level of logging.
Note
The CMDB Engine logs all warnings and error messages by default. If you
attempt to lower the debug logging level to 1, cmdbEngine automatically
updates it to 2. However, if you need finer logging you can still set the
logging level to 5.
BMC Atrium Core 9.0
Page 2020 of 2268
Home
CMDB-Log-File-Location Enables you to specify the directory location on your

system where the log file is written. You can specify any location on your system.
On Windows, the log file is written to the Program Files\ARSystem\Arserver\db
subdirectory of your installation directory by default. On UNIX, it is created under
serverInstallationDirectory/db.
CMDB-Max-Log-File-Size Enables you to specify a maximum size, in kilobytes (KB),
for your log file (for example, CMDB-Max-Log-File-Size: 50000 ). When the log file
reaches the specified limit, the system automatically creates a backup of the log file and
continues to store the log entries in a new log file.
The default value for the CMDB-Max-Log-File-Size parameter is 0, which specifies an
unlimited size for the log file.
Java API logging

The BMC Atrium CMDB Java API processing can be logged by setting parameters in the
log4j_cmdbapi.xml file, which helps you to debug your Java API program. When you enable
logging, the BMC Atrium CMDB records details about the Java calls you make in your program,
including the list of the calls, the input arguments, and the return values for each call.
To enable logging
1. Copy the log4j_cmdbapi.xml file from the cmdb\sdk\bin subdirectory of your installation
directory and paste it to a location on your local drive.
2. After you copy the log file to the new location, add the directory path to the Java class path.
For example:
CLASSPATH-%CLASSPATH%;C:/AtriumCore/cmdb/sdk64/bin
Note
The log file is generated in the directory where the program is executed.
The BMC Atrium CMDB Java API classifies the messages into error, warning, information,
and debug categories. The logging levels are inclusive of their preceding levels. For example
, if you set the debug level to 3, you receive log messages for levels 1, 2, and 3.
1: Fatal Logs messages for severe errors that cause premature termination.
2: Error Logs messages for other runtime errors or unexpected conditions.
3: Warning Logs messages for incorrect usage of the API calls. The runtime issues that
are logged might be incorrect but not wrong. This is the default logging level.
4: Information Logs informational messages, such as the list of Java calls made by the
client.
BMC Atrium Core 9.0
Page 2021 of 2268
Home
5: Debug Logs details for the calls, such as the list of arguments and the return values for
each call.
6: Trace Logs finer level of details for debugging errors.
Log Type The type of log entry: fatal, warning, error, information, or debug.
To change the logging level for Java API, set the value element with the appropriate setting for the
com.bmc.cmdb.api logging component. For more information about BMC Atrium CMDB Java
logging, see http://logging.apache.org/log4j/1.2.
Java API configuration properties

If you notice that the server response time is slow when executing your Java program, you can
modify the timeout properties in the cmdbapi_sample.properties Java API configuration file.
The configuration file is located in the sdk\bin subdirectory of your BMC Atrium Core installation
directory. You can configure the following properties in the configuration file:
minimumSupportedServerCMDBRpcVersion Minimum CMDB RPC Version
supported by JAVA API. The default value is 3.
maxCMDBProxiesPerServer Maximum number of CMDB Proxy connections that you
can specify per server. The default value is 100.
timeoutNormal Timeout value in seconds for the server. You can specify values for the
timeoutLong and timeoutXLong parameters for an extended time out time for the server.
timeoutCMDBMetaData Timeout value for meta data operations. The default value is
259200 seconds.
To override the default values:
1. Rename the cmdbapi_properties.sample file to cmdbapi.properties.
2. Modify the configuration properties in the file as appropriate.
3. Place the cmdbapi.properties file in the directory that is specified in the Java ClassPath.
For more information about related Java API functions, see the BMC Atrium CMDB Javadoc Help.

The Reconciliation Engine logs all activities that it performs: Identification, Compare, Merge, Delete,
and Purge. A log file for a job is created each time the Reconciliation Engine runs that job. The
Reconciliation job logging is enabled by default.
The Reconciliation job logging topic provides information about log details, naming conventions,
viewing events, and interpreting log entries.
BMC Atrium Core 9.0
Page 2022 of 2268
Home
Log entry details

Log file naming convention
Viewing Reconciliation job events in the log file
To view the event for the log
To analyze Reconciliation job log files
Interpreting entries in the log file
Log entry details

Log Type The type of log entry:
Error Logs detailed messages for errors and warnings (default).
Info Logs class-level details, such as dataset name and class name.
Debug Logs trace messages, which are used for debugging errors.
All these logging levels are inclusive of their preceding levels. For example, if you set
the Logging Level at Debug, you receive log messages for Error, Info, and Debug
types. You can specify the Logging Level for the log files from the Modify Server
Configuration window of the Reconciliation Engine Console.
You can specify additional settings for the log files in the Modify Server Configuration window of the
Reconciliation Engine Console. For more information about these settings, see Reconciling data.
Log file naming convention

The Reconciliation job log files use the following naming convention:
jobName_ctr.log
jobName is the name of the job that you created in the Reconciliation Manager (for example,
BMCAsset - Identification and Purge).
ctr is a numeric value that starts from 1 and is incremented when a new log file is created for the
job run. The Reconciliation Engine continues to log errors in a new log file when an existing log
reaches its size limit.
For example, if multiple files are created for the BMCAsset - Identification and Purge job run, the
job log files will be named as:
BMCAsset - Identification and Purge_1.log
BMCAsset - Identification and Purge_2.log
Viewing Reconciliation job events in the log file

When the log file for the Reconciliation job is created, an event associated to the job is added to the
Reconciliation Engine Console. This event contains the job file name and location.
BMC Atrium Core 9.0
Page 2023 of 2268
Home
To view the event for the log

1. Log in to the BMC Remedy Mid Tier.
2. Select BMC Atrium Core Console > Reconciliation Manager .
3. From the navigation link on the left, click Job History.
The Job History Console is displayed.
4. From the Jobs table on the top of the window, choose the specific job.
The Related Runs table is populated with the run status of the job.
5. Select the specific job run for the job.
The Related Events table is populated with event information for the job.
6. Click the RE Log File & Location event and click View.
The Job Event Information window is displayed.
7. Click the Diary field to view the log file path information.
To analyze Reconciliation job log files

The general process of analyzing Reconciliation job logs is the following:
1. Open the first job log in a text editor
2. Disable line wrap, so you can see the activity more clearly by scrolling to the right in the log.
3. To find a particular Configuration Item (CI) in the log, search for its instanceid or
ReconciliationIdentity value.
4. If the Reconciliation job run generated multiple logs, search in each of the log files.
5. When you identify the particular CI, note the value of the thread ID (TID) on that line.
6. Search up and down in the file for lines with that TID to view the processing of that CI.
7. If the particular CI is not found, search for the class of the CI to see how or if the class was
processed.
Interpreting entries in the log file

The Reconciliation job log is a multi-threaded program with all threads writing to the same log file.
The log files are divided by activity names. Each of these activities has a start or run entry,
indicating the start of the activity, and an end or completed entry indicating the end of the activity.
The following examples illustrate both these entries.
Example 1: Starting an activity
[Tues Apr 24 2007 12:10.08.4748] [INFO] [TID: 000011]: Running activity: BMC Topology Import - Identificatio
Example 2: Ending an activity
[Tues Apr 24 2007 12:10.08.4748] [INFO] [TID: 000011]: Activity completed: BMC Topology Import - Identificat
BMC Atrium Core 9.0
Page 2024 of 2268
Home
Each entry contains a thread ID (TID) that identifies a unique activity. If multiple instances need to
be identified, the Reconciliation job creates separate threads for each instance identification.
Therefore, the log file contains mixed entries for various threads instead of having one section for
each thread.
The following code is an example of a Reconciliation job log file.
[2007/03/30 10:35:36.1370] [DETAILS] [TID: 003720] : Started waiting for all the threads to finish
[2007/03/30 10:35:39.7710] [DETAILS] [TID: 002696] : Started identifying instance <class = QA_Patch2_No_Iden
[2007/03/30 10:35:39.7710] [ TRACE ] [TID: 002696] : Found matching rule group <Patch002-Identify D2 against
[2007/03/30 10:35:39.7710] [ TRACE ] [TID: 002696] : Applying rule <'Character_Field' = $Character_Field$> a
[2007/03/30
[2007/03/30
[2007/03/30
[2007/03/30
[2007/03/30
10:35:39.7710]
10:35:39.7710]
10:35:39.7810]
10:35:39.7810]
10:35:39.7810]
[DETAILS]
[DETAILS]
[ ERROR ]
[ ERROR ]
[ ERROR ]
[TID:
[TID:
[TID:
[TID:
[TID:
002696]
002696]
002696]
002696]
002696]
:
:
:
:
:
Substituting values in the qualification

Replaced field <id = 536870999 and name = Character_Fie
Found multiple matches (instances) for class <QA_Patch2
for qualification <'Character_Field' = <Character_Field
<Character_Field = All Match Error During Identificatio
[2007/03/30 10:35:40.1310] [ INFO ] [TID: 002696] : Processed instance without finding a match for instance
[2007/03/30 10:35:40.1310] [ ERROR ] [TID: 002696] : Cannot identify the instance of class <QA_Patch2_No_Ide
[2007/03/30 10:35:40.1310] [ INFO ] [TID: 002696] : Cancelled the processing of rest of the sub-tree for ins
[2007/03/30 10:35:40.6720] [DETAILS] [TID: 003720] : Finished waiting
In this example, the Identification Rule looks for a match based on the value of the
Character_Field attribute. An error is generated for this job because the Reconciliation Engine
finds multiple matches in the lookup dataset against which the CI is to be identified. As a result of
the error, the Configuration Item (CI) in the source dataset is not identified and the Reconciliation ID
remains 0.
Configuring the deletion of Reconciliation Engine job log files

You can configure how and when Reconciliation Engine log files are deleted for automated cleanup
, as explained in the following sections:
Deleting log files for reconciliation job runs
To configure deletion of reconciliation job log files
Deleting 0 byte reconciliation job log files
Deleting log files for reconciliation job runs

For each run of a reconciliation job, the Reconciliation Engine creates a log file. To avoid filling a
hard drive with log files, you can configure how many of these log files to save. For example, if you
want to save the log files for three runs of a particular reconciliation job, only the three most recent
log files are saved. Older log files are deleted. You can configure this setting for each reconciliation
job.
BMC Atrium Core 9.0
Page 2025 of 2268
Home
The log file for a job run has a record of the deletion of a previous log file:
Example:
[2011/09/22 17:59:30.4960] [INFO] [TID: 0000007180] :Deleted log file: C:\Program Files
\BMC Software\AtriumCore\Logs\t1_135.log
To configure deletion of reconciliation job log files

2. In the Job Editor, select Number of job runs to retain in logs to specify the job runs to
retain in job logs.
If you want to retain ALL the job logs for all the job runs, then select the All check box.
Deleting 0 byte reconciliation job log files

If the logging level is set to Error, the Reconciliation Engine creates a new 0 byte log file for each
run of a reconciliation job, even when the job is successful. You can configure the deletion of 0 byte
log files for individual reconciliation jobs.
To configure the deletion of the 0 byte log files for a reconciliation job
2. In the Job Editor, enable Delete files on exit.
The Reconciliation Engine deletes any 0 byte log files that are created during runs of this
reconciliation job.
Restricting the Reconciliation Engine log file size

In the Reconciliation Engine if the logging level is set to debug, the arrecond.log file that stores the
logs becomes large in size. It can grow to a size that is in multiple Gigabytes (GB). As a result, it is
difficult to open the log file to analyze logs.
To control the file size of the log file, you can edit the configuration options from the Server
Configuration. A value of zero indicates that the limit on the maximum file size is not specified. In
that case, the log file takes the default value. The default value is of 20480KB (20MB). You can
specify the log file size value in the range from 0 to 2097152 KB (2GB).
BMC Atrium Core 9.0
Page 2026 of 2268
Home
When the file size of the arrecond.log file reaches the maximum size, the Reconciliation Engine
automatically renames this file to arrecond_1.log and writes further logs to the arrecond.log file.
Thus, the arrecond.log file is always the latest log file, and the arrecond_highestNumber.log is
the latest backup file.
Reconciliation Engine errors in the log file

The Reconciliation Engine logs errors that can help you to troubleshoot reconciliation issues.
To debug Reconciliation Engine errors using the log file

1. Search for the entry in the Reconciliation Engine log file that contains [ERROR] in its
description.
2. Note the thread ID (TID) specified in this error entry.
3. Trace back to the beginning of the log file while looking for more entries with the specific TID
.
You will find several entries for the specific TID. Each entry reports the task that the
Reconciliation Engine performs at each stage.
Web services logging

The BMC Atrium Core web services provide logs that can help you to troubleshoot issues related to
web service operations.
Note
The BMC Atrium Core web services use the BMC Atrium CMDB APIs to communicate
with the AR System server. Therefore, you can also examine the BMC Atrium CMDB API
logs for any errors. For more information about the BMC Atrium CMDB API logging, see
Server-side API logging.
BMC Atrium Core web services deployment logs

BMC Atrium Core web services deployment logs are located in the
AtriumCoreInstallationDirectory/Logs directory.
BMC Atrium Core web service logs

BMC Atrium CMDB web service logs provide information about troubleshooting TIBCO or other
web service issues. The web services log files are located in:
AtriumCoreInstallationDirectory/shared/tomcat/logs/ if the Tomcat path is bundled with

BMC Atrium Core.
TOMCAT_HOME/logs if you are using your own Tomcat installation.
The following code is an example of the output from invoking the GetClass method of the
atrium_classes web service.
BMC Atrium Core 9.0
Page 2027 of 2268
Home
BMC Atrium WS [ INFO ] Thread:1402 Date:2009-08-20T23:20:44.025+0530

Class:com.bmc.atrium.ws.classes.atrium_classes
Method:getClass
File:atrium_classes.java Line:1644
+ Operation exited normally
+ Artifacts follow:
------------------------------------------------------------------------<typ:GetClassOutput xmlns:typ="http://atrium.bmc.com/2009/01/classes/types">
<classInfo>
<properties>
<regular>
<isAbstract>NO</isAbstract>
<exposure>USED_VISIBLE</exposure>
<hiddenPerms/>
<visiblePerms>-1098;-1099;-1090;-1091;</visiblePerms>
<categorizationSubclass>false</categorizationSubclass>
<description>Class that stores configuration items (CIs) relating to collections
of managed system elements. The managed system elements provide computing capabilities
and serve as aggregation points to relate one or more of the following elements:
file systems, operating systems, processors, and memory (volatile storage, nonvolatile,
or storage). The BMC_ComputerSystem class is the primary class that you will use to
model the computers in your organization. You can use the attributes in this class to
identify the purpose of each computer CI in your organization. For example,
the class contains several attributes that represent any network-addressable system,
such as a server, a workstation, or a network device (router, switch, hub, load
balancer,
firewall, and so forth), as well as mainframes, printers, and virtual systems.
So CMDB planners might use the PrimaryCapability element to define a vendor-specific
switch used in their network, making it easy to import this data from a vendor
as an industry-standard item in their CMDB. They could also define computer systems
further by placing them in one of its subclasses: BMC_Mainframe, BMC_Printer, or
BMC_VirtualSystem. The BMC_ComputerSystem class corresponds to the DMTF
CIM_ComputerSystem class.</description>
<isFinal>false</isFinal>
<isSingleton>false</isSingleton>
<author/>
<auditInfo>
<auditType>NONE</auditType>
<qualifierString/>
</auditInfo>
</regular>
</properties>
<indexList/>
<customCharacList/>
<superclassNameId>
<namespaceName>BMC.CORE</namespaceName>
<className>BMC_System</className>
</superclassNameId>
<classId>BMC_COMPUTERSYSTEM</classId>
<classType>REGULAR</classType>
<formName>BMC.CORE:BMC_ComputerSystem</formName>
</classInfo>
<status/>
BMC Atrium Core 9.0
Page 2028 of 2268
Home
<extensions>
<clas:ClassDeprecationInfo xmlns:clas="http://atrium.bmc.com/2009/08/extensions/classes"
>
<classId>BMC_COMPUTERSYSTEM</classId>
<isDeprecated>false</isDeprecated>
<mappedClass xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</clas:ClassDeprecationInfo>
</extensions>
</typ:GetClassOutput>
==================================================================
Setting log levels for BMC Atrium Core web service logs
You can use the atrium_serviceconfig service to configure logging level for the deprecated cmdbws
and the BMC Atrium Core web services. These levels determine the types of messages that BMC
Atrium Core logs for each web service call.
The bmc.cmdbws.log.level property enables you to set logging levels for the cmdbws web
services. To set logging levels for all other BMC Atrium Core web services, use the
bmc.atrium.log.level property. The default logging level for the web services is set to WARN.
The various logging levels are:
Info Lowest level possible. It provides the entrance and exit points for operation and
loading operations.
Error Contains the same information as Info, and includes fault messages or other error
conditions.
Warning Contains the same information as Error and includes information about warnings
.
Debug Contains the same information as Warning and includes debug level statements.
Each log line provides the service class and method name that the error occurred in, along
with artifacts (like incoming and outgoing SOAP messages, or stack traces).
Trace The highest level of logging possible. Contains the same information as Debug,
and includes trace level statements. Each line also provides the filename and line number in
which the log occurred.
For more information about configuring BMC Atrium Core web services, see Getting started with
BMC Atrium Core Web Services.
BMC Atrium Core Console server-side logging

The BMC Atrium Core Console server-side processing is recorded in the mid tier and application
server logs. The mid tier log file location depends on the application sever that you have installed.
For example, for an Apache Tomcat application server installed on the mid tier, the log is stored in
the BMC Remedy Action Request System serverInstallation/tomcat/logs/stdout_currentDate.
log file. Mid tier logs are located in the AR System serverInstallation/mid tier/logs subdirectory of
the AR System installation.
BMC Atrium Core 9.0
Page 2029 of 2268
Home
For more information about mid tier logging, see BMC Remedy Mid Tier logging in the BMC
For more information about application server logging, see BMC Atrium Core web services
deployment logs.
BMC Atrium Core Console client-side logging

BMC Atrium Core logs the BMC Atrium Core Console client-side processing in the flashlog.txt file,
which helps you to debug user interface errors. To log the client-side processing, install and
configure the 7, 0, 14, 112 or newer version of Adobe Flash Player Debugger. The BMC Atrium
Core Console requires a minimum of Adobe Flash Player version 9 to run.
To determine your Adobe Flash Player Debugger version
To configure your Adobe Debug Flash Player Debugger
Note
The Adobe Flash Player log combines messages from all its instances running on your
computer. For example, if you were running two instances of Adobe Flash Player with
CNN.com and BMC Atrium Core each on the same computer, you might find intermixed
log messages from both these instances.
To determine your Adobe Flash Player Debugger version

Use the following methods to determine the version of the Adobe Flash Player Debugger that you
have installed. If the version you determined using each method differs, the debug logging might
encounter issues. In such a case, uninstall all versions of the Adobe Flash Player Debugger and
install again.
Determining Adobe Flash Player Debugger version
Using this
component
Perform these steps
BMC Atrium
Core Console
Right-click inside the BMC Atrium Core Console and select About Adobe Flash Player version.
The version of the Adobe Flash Player installed is displayed, but this will not distinguish between the release and
debug player.|
Adobe website
1. Go to http://helpx.adobe.com/flash-player/kb/find-version-flash-player.html. Follow the steps give on this
page to install the Flash player, if you do not have one.
2. http://helpx.adobe.com/flash-player/kb/configure-debugger-version-flash-player.html Follow the steps
given on this page to install the download the debugger version of Flash Player.
Note: Adobe moves this content occasionally. You can usually find the new location by searching for "debug
flash player" with Google or equivalent search engine.
BMC Atrium Core 9.0
Page 2030 of 2268
Home
To configure your Adobe Debug Flash Player Debugger

When you install BMC Atrium Core, the following files are copied to the webapps directory of your
installation for the client-side logging:
Readme.txt Contains information about downloading, installing, and configuring the
Adobe Flash debugger.
mm.cfg Contains the configuration information to enable logging on the client side. Copy
this file to the location specified in the readme.txt file for your operating system.
The location of the flashlog.txt log file depends on your operating system, as listed in the
following table.
Log file location by operating systems
Operating system
Log file location
Windows 95, Windows 98, Windows ME,

Windows 2000, Windows XP
C:\Documents and Settings\<userName>\Application Data\

Macromedia\Flash Player\Logs
Windows Vista
C:\Users\<userName>\AppData\Roaming\Macromedia\Flash
Player\Logs
Apple Macintosh OS X
/Users/<userName>/Library/Preferences/Macromedia/Flash
Player/Logs/
Linux
/home/<userName>/.macromedia/Flash_Player/Logs/

Log Type The type of log entry such as warning, error, or information.
Working with error messages

The following topics describe error messages and explain how to interpret them:
Service Model error messages
Atrium Integrator error messages
Federation plug-in error messages
Product Catalog error messages
BMC Atrium Core Console active link error messages
BMC Atrium CMDB C API error messages
Reconciliation Engine error messages
BMC Atrium Core Console filter error messages
BMC Atrium Service Context error messages
Atrium Impact Simulator error messages
BMC Atrium Core 9.0
Page 2031 of 2268
Home
Service Model error messages

The following topics list the error number, message type, message text, description, and solution
for Unified Service Model plug-in and business object layer error messages:
Unified Service Model plugin error messages
Business object layer messages

The following table lists the error number, message text, description, and solution for Unified
Service Model plugin errors.

Error
number
Message
Type
Message, description, and solution
191000
Error
Parameter {0} is not of type character.

Description The parameter you specified is not of data type character.
Solution Specify a parameter of the type character.
191001
Error
The instance ID/Name is not of type character.

Description The instance ID or name you specified is not of data type character.
Solution Specify an instance ID or name of the type character.
191002
Error
The description is not of type character.

Description The description you specified is not of data type character.
Solution Specify a description of the type character.
191003
Error
Missing required parameter: {0}.

Description You did not specify a mandatory parameter.
Solutionl Specify a value for the given parameter.
191004
Error
Too few parameters specified for function <{0}>.

Description You have not specified the requisite parameters for the given function.
Solution Check the qualifier used to query the CMDB:USMAPIInterface vendor form. Also check the
atrium-ar-kit-USM.log or{{AtriumPluginSvr.log}} in the Logs folder for more information.
191005
Error
CMDBBOException occurred: {0}.

Description The given exception occurred in the business object layer.
Solution See the error details in the appropriate log file.
191006
Error
Unknown command was passed to the filter: <{0}>.

Description You specified an incorrect function name in the qualifier.
Solution Check the qualifier used to query the CMDB:USMAPIInterface vendor form.
191007
Error
An unknown error has occurred in {0}. Error: {1}.

Description An unknown error has occurred.
191008
Error
Invalid qualifier encountered.

Description You specified an incorrect qualifier.
Solution Check the qualifier used to query the CMDB:USMAPIInterface vendor form.
BMC Atrium Core 9.0
Page 2032 of 2268
Home
Error
number
Message
Type
191009
Error
The specified business service <{0}> was not found in <{1}>.

Description The given business service was not found in the specified lookup dataset.
Solution Check that the specified business service instance ID and lookup dataset are correct.
191013
Error
The specified service offering <{0}> was not found in <{1}>.

Description The given service offering was not found in the specified lookup dataset.
Solution Check that the specified service offering ID and lookup dataset are correct.
191014
Error
The specified requestable offering <{0}> was not found in <{1}>.

Description The given requestable offering was not found in the specified lookup dataset.
Solution Check that the specified requestable offering ID and lookup dataset are correct.
191015
Error
Missing qualifier.
Description You did not specify a qualifier to query the CMDB:USMAPIInterface vendor form.
Solution Specify a qualifier to query the CMDB:USMAPIInterface vendor form.
191016
Error
Missing required parameter. Method={0} Parameter={1}.

Description You did not specify the given mandatory parameter for the given method.
Solution Specify the given parameter.
191017
Error
Unknown parameter {1} passed to function {0}.

Description You specified an unknown parameter for the given function.
Solution Check the given parameter name in the qualifier.
191018
Error
The default service offering for business service <{0}> was not found.
Description The default service offering for the given business service was not found.
Solution If the business service type is unknown, select a valid business service type. The default service
offering will be automatically generated.
191019
Error
{0} exception occurred in {1}. Message: {2}.

Description The given exception occurred.
191020
Error
An invalid price was specified: {0}. Correct format is amount currency. Ex: 1.23
USD.
Description You specified an invalid price.
Solution Specify the price followed by the currency identifier.
191023
Error
Delivery requestable offering can not be linked to global default service

offering.
Description The delivery requestable offering cannot be linked to the global default service offering.
Solution Either link the requestable offering to a non-global default service offering, or make the
requestable offering a non-delivery requestable offering.
191024
Error
The specified contract <{0}> was not found in <{1}>.

Description The given contract was not found in the given lookup dataset
Solution Confirm that the specified contract ID and lookup dataset are correct.
191025
Error
The specified option choice <{0}> was not found in <{1}>.

Description The given option choice was not found in the given lookup dataset.
Solution Confirm that the specified option choice ID and lookup dataset are correct.
191026
Error
The specified contract line <{0}> was not found in <{1}.

Description The given contract was not found in the given lookup dataset.
Solution Confirm that the specified contract line ID and lookup dataset are correct.
191027
Error
BMC Atrium Core 9.0
Page 2033 of 2268
Home
Error
number
Message
Type
The specified requestable offering <{0}> is not an add on requestable offering.

Description The given requestable offering is not an add on requestable offering.
Solution Specify a valid requestable offering.
191028
Error
The specified service offering line with the given service request Id <{0}> is
not found in <{1}>.
Description The given service offering with the given service request ID was not found.
Solution Specify a valid service ID for the given service offering.
191029
Error
The specified price object <{0}> was not found in <{1}>.

Description The given price object was not found in the specified lookup dataset.
Solution Confirm that the price object ID and lookup dataset are correct.
191031
Not able to find an organization with companyId <{0}> in dataset <{1}>.

Description An organization for the given company ID was not found in the given dataset.
Solution Check that the company ID and dataset are correct.
191032
The specified add on line with the given service request Id <{0}> is not found
in <{1}>.
Description The given add on line was not found in the specified lookup dataset.
Solution Check that the service request ID and lookup dataset are correct.
191033
The specified active add on line with the given Name <{0}> is not found in <{1}
>.
Description The given active add on line was not found in the specified lookup dataset.
Solution Check that the add on line name and lookup dataset are correct.
Business object layer messages

The following table lists the number, message text, description, and solution for service model error
messages.
BMC Atrium CMDB business object layer messages

Error
number
Message
type
120411
Error
An unknown error occurred in the BOL API while calling the CMDB Atrium CMDB or
AR APIDescription.
Description An error occurred in the business object layer while calling the BMC Atrium CMDB or BMC
Remedy AR System API description.
Solution Check the appropriate log file for details.
120412
Error
The business object class is not valid or is not a known business object class.
Description The given business object class is invalid.
Solution Specify a valid business object class.
120413
Error
Unknown error occurred while fetching the business object instance from the
data store.
Description An error occurred while fetching the business object instance from the data store.
Solution Specify a valid business object class.
120414
Error
BMC Atrium Core 9.0
Page 2034 of 2268
Home
Error
Message
number
type
Invalid query.
Description The given query is invalid.
Solution Specify a valid query.
120415
Error
Cannot instantiate an instance of the business object class.

Description An error occurred while instantiating an instance of the business object class.
120416
Error
An unknown error occured while trying to create a CMDB CI Instance for one of
the business objects.
Description An error occurred while creating a BMC Atrium CMDB CI instance for one of the business
objects.
*Solution * Check the appropriate log file for details.
120417
Error
An unknown error occured while trying to create a CMDB Relationship Instance

between two of the business objects.
Description An error occurred while creating a BMC Atrium CMDB relationship instance for one of the
business objects.
120418
Error
An unknown error occured while trying to create CMDB Impact Instance for a CMDB
Relationship.
Description An error occurred while trying to create an impact instance for a relationship between business
objects.
120419
Error
An unknown error occured while trying to generate Instance Id for a CMDB CI.
Description An error occurred while generating an instance ID for a CI.
120420
Error
An unknown error occured while trying to generate Instance Id for a CMDB

Relationship.
Description An error occurred while generating an instance ID for a relationship class.
120421
Error
An unknown error occured while trying to update a CMDB CI instance for one of
Description An error occurred while updating a CI instance for one of the business objects.
120422
Error
An unknown error occured while trying to update CMDB Impact Instance for a CMDB
Relationship.
Description An error occurred while updating an impact instance for a relationship class.
120423
Error
An unknown error occured while trying to delete a CMDB CI instance for one of
Description An error occurred while deleting a CI instance for one of the business objects.
120424
Error
An unknown error occured while trying to delete CMDB Impact Instance for a CMDB
Relationship.
Description An error occurred while deleting an impact instance for a relationship class.
120425
Error
BMC Atrium Core 9.0
Page 2035 of 2268
Home
Error
number
Message
type
The operation is rejected due to connection restraints.

Description The operation was not completed due to connection problems with BMC Atrium CMDB server.
Solution Check that the BMC Atrium CMDB server is up and running and that your login credentials are
correct.
120427
Error
Violation to the rule where: The association between a delivery requestable

offering and service offering is 1 to 1.
Description You are trying to associate more than one service offering to a delivery requestable offering,
or more than one delivery requestable offering to a service offering.
Solution Delete the previous associations before creating a new association.
120428
Error
Update made to the contract line is invalid.

Description You made an invalid update to the contract line.
Solution Check the arguments you specified for updating the contract line.
120429
Error
Update made to the contract is invalid.

Description You made an invalid update to the contract.
Solution Check the arguments you specified for updating the contract.
120430
Warning
The contract line doesn't associate with any contract.

Description The contract line is not associated with a contract.
Solution Associate the contract line with a contract.
120431
Error
The lifecycle status of the contract associcated to the contractline can't be

determined.
Description The lifecycle status of the contract associated with the contract line cannot be determined.
Solution Check that the contract associated with the contract line has the proper status set.

The following table lists the error number, message type, message text, description, and solution
for each Atrium Integrator error.

Error number
Message
type
NGIE000001
Error
Error retrieving DatasetIds for the selected target data store.

Solution Verify the BMC Remedy AR System server details specified in the target data store
connection.
NGIE000002
Error
Error retrieving CI Types for the selected target data store.

connection. Also confirm that one or more some target attributes have been mapped to the source
column on the CI Mapping page of the Integration Job Builder wizard.
NGIE000003
Error
Error retrieving CI Relationships for the selected CI Types.

connection. Also confirm that a relationship has been selected for the selected CIs on the CI
TypeRelationships page of the Integration Job Builder wizard.
NGIE000004
Error
BMC Atrium Core 9.0
Page 2036 of 2268
Home
Error number
Message
type
Job Creation failed.

Solution Verify the data entered in the Integration Job Builder wizard pages and check your
connection to the Pentaho server.
NGIE000005
Error
Error retrieving CI attributes for the selected CI Type.

Solution Confirm connectivity to BMC Atrium CMDB by clicking the Test Connection button in the
Manage Data Store tool. Also verify that the CI Class is defined correctly for the selected CI Type.
NGIE000006
Error
Error retrieving Schemas for the source.

Solution Confirm connectivity to BMC Remedy AR System by clicking the Test Connection button in
the Manage Data Store tool.
NGIE000007
Error
Error retrieving Tables for the schema.

the Manage Data Store tool. Also check whether the schema has any table defined.
NGIE000008
Error
Error retrieving Views for the schema.

the Manage Data Store tool. Also check whether the schema has any view defined.
NGIE000009
Error
Error retrieving Files for the source.

the Manage Data Store tool. Check whether an entry has been created in the NGIE: FileMetaData
form.
NGIE000010
Error
Error retrieving Columns for the source.

Solution Check your connection to the Pentaho server and verify that the table or view is defined
correctly in the source database.
NGIE000011
Error
No Columns available for the selected source.

Solution Confirm that the source database table has valid columns.
NGIE000012
Error
Error retrieving fields from the selected file.

Solution Confirm connectivity to BMC Atrium CMDB by clicking the Test Connection button in the
Manage Data Store tool. Check whether an entry has been created in the NGIE: FileMetaData form.
NGIE000101
Error
Failed to connect to Atrium Integrator.

Solution Check your connection to the Pentaho server.
NGIE000102
Error
Failed to get list of NGIE Jobs.

Solution Check the following:
Your connection to the Pentaho server.
Verify that the <AtriumCoreInstallationDirectory>\cmdb\plugins\shared\
pluginsvr_config.xml file, contains the following entry: BMC.ARDBC.ATRIUM.NGIE
Verify that all the .jar files listed in the BMC.ARDBC.ATRIUM.NGIE section of the
pluginsvr_config.xml file exist at the specified locations.
NGIE000103
Error
Failed to delete NGIE job.

Solution Check your connection to Atrium Integrator. Also confirm that the Carte server is running.
NGIE000104
Error
Failed to start NGIE job.

Solution Confirm that the Carte server is running.
NGIE000105
Error
Failed to stop NGIE job.

Solution Check your connection to Atrium Integrator. Also confirm that the Carte server is running.
BMC Atrium Core 9.0
Page 2037 of 2268
Home
Error number
Message
type
NGIE000106
Error
Failed to get list of job runs.

Solution Check your connection to the Pentaho server. Also check whether there is an entry in the
NGIE: JOBLOG form.
NGIE000107
Error
Failed to get list of job runs.

Solution Check your connection to the Pentaho server. Also check whether there is an entry in the
NGIE: JOBLOG form.
NGIE000201
Error
Error creating data store.

NGIE000202
Error
Error updating data store.

NGIE000203
Error
Error deleting data store.

NGIE000204
Error
Error getting data stores.

NGIE000205
Error
Error getting data store types.

NGIEA000303
Error
Error occurred while trying to connect to the data store.

Solution Check the data store connection details.
NGIEA000304
Error
Error occurred while trying to connect to the data store.

Solution Check the data store connection details.
NGIEA000305
Error
Please check the name and path details.

Solution Verify the directory path and check whether the folder specified in the path exists on the
Atrium Integrator server.
NGIEA000310
Error
Error publishing the job to the repository.

Solution Check your connection to the repository database server. After you fix the connection, you
can copy the job and transformation files saved in the user profile on the mid tier (C:\Documents and
Settings\Administrator_jobName_ ) to the Spoon repository.
NGIEA000311
Error
Error publishing the transformation to the repository.

Solution Check your connection to the repository database server. After you fix the connection, you
can copy the job and transformation files saved in the user profile on the mid tier (C:\Documents and
Settings\Administrator_jobName_ ) to the Spoon repository.
NGIEA000315
Response column in Transformation Options for one or more CI Types is not

set.
Solution Check whether the source column to be updated has been specified for the Response area
in the Transformation Options tab for the CI Mapping and Relationship Mappings pages of the
NGIEA000316
Delta column in Transformation Options for one or more CI Types is not set
.
Solution Check whether the source column to be used for Delta has been specified for the Delta
area in the Transformation Options tab for the CI Mapping and Relationship Mappings pages of the
BMC Atrium Core 9.0
Page 2038 of 2268
Home
Federation plug-in error messages

The following topics provide information about troubleshooting BMC Remedy AR System and
JDBC plug-in federation errors:
AR System plug-in error messages
JDBC plug-in error messages
AR System plug-in error messages

for the BMC Remedy AR System plug-in errors.
BMC Remedy AR System plug-in error messages
Error
Message
number
type
140100
Error
Method <{0}> not supported.

Description You are attempting to use a method that is not supported for the specified class.
Solution Make sure that the method that you are attempting to use on the specified class is available for
the class type.
140101
Error
Error loading plug-in configuration for plug-in <{0}> - <{1}>; Check the
plug-in configuration.
Description An internal occurred when loading the plug-in for the configuration.
Solution Make sure that the plug-in configuration that you specified in the Federation Manager is correct.
140102
Error
No entry found with entry id <{0}> from table <{1}>.

Description An internal error occurred when querying the specified table for the given entry ID.
Solution Make sure that the entry ID is correct for the table that you specified and execute the query again.
140103
Error
Plug-in configuration for plug-in <{0}> not defined.

Description You did not specify the plug-in configuration for the given plug-in.
Solution Make sure that you define the plug-in configuration in the Federation Manager.
140104
Error
Form Name cannot be null when filter type is filter on specific form name. Form
Name=<{0}>, filter type: <{1}>
Description You selected the Specified Forms option for the retrieve method of the plug-in but did not
specify an AR System form name for the filter.
Solution Make sure that you specify an AR System server form name for the filter.
140105
Error
Number format exception while processing user input. Server Port = <{0}>,
filterFormType = <{1}>, lastChangedSince filter = <{2}>
Description A data type mismatch error occurred because you provided a non-integer value for the given
input parameters.
Solution Make sure that you specify integer values for the given input parameters.
140106
Error
Data Type Conversion failed for value <{0}> with sql type <{1}>.
Description The data type of a value that you specified in the qualification does not match the data type of
the SQL table column.
Solution Make sure that:
The data type of the value and the SQL table column specified in the qualification match.
The value that you specified for the table column does not exceed its data limit.
BMC Atrium Core 9.0
Page 2039 of 2268
Home
Error
number
Message
type
140107
Error
Number format exception occurred while data type conversion for plug-in <{0}> :
<{1}>.
Description A data type mismatch error occurred because you provided a non-integer value for the plug-in.
This does not match with the type of plug-in you selected.
The data type matches the plug-in type that your specified.
*The integer value that you specified is correct for the plug-in.

for the JDBC plug-in errors.

Error
number
Message
type
130100
Error
Method <{0}> not supported.

Description You are attempting to use a method that is not supported for the specified class.
Solution Make sure that the method that you are attempting to use on the specified class is available for
the class type.
130101
Error
Error loading plug-in configuration for plug-in <{0}> - <{1}>; Check the
plug-in configuration.
Description An internal occurred when loading the plug-in for the configuration.
Solution Make sure that the plug-in configuration that you specified in the Federation Manager is correct.
130102
Error
Error fetching entry with entry id <{0}> from table <{1}> - <{2}>.
Description An internal error occurred when querying the specified table for the given entry ID.
Solution Make sure that the entry ID is correct for the table that you specified and execute the query
again.
130103
Error
No entry found with entry id <{0}> from table <{1}>.

Description The entry ID that you specified for the table does not exist.
Solution Modify the entry ID to the one that exists in the table.
130104
Error
Error fetching entries for given qualification from table <{0}> - <{1}>.
Description The qualifications you specified in the query are incorrect.
Solution Make sure that the:
The data type of the table columns and the values match
The value does not exceed the maximum limit of the table column
The table columns that you specify in the query exist
The table name that you specify in the query exists
130105
Error
No entries found in the table <{0}>.

Description The data that you are attempting to query is not found in the specified table.
Solution Make sure that the data you are attempting to query exists in the table for the given qualification
.
BMC Atrium Core 9.0
Page 2040 of 2268
Home
Error
number
Message
type
130106
Error
Error fetching table names from data source - <{0}>

Description The table name that you specified in the query is incorrect.
Solution Make sure that the table that you specified in the qualification exists.
130107
Error
Error fetching column names from table <{0}> - <{1}>.

Description The column name that you specified in the query is incorrect.
Solution Make sure that the column that you specified in the qualification exists.
130108
Error
Plug-in configuration for plug-in <{0}> not defined.

Description You did not specify the plug-in configuration for the given plug-in.
Solution Make sure that you define the plug-in configuration in the Federation Manager.
130109
Error
Data Type Conversion failed for value <{0}> with sql type <{1}>.
Description The data type of a value that you specified in the qualification does not match the data type
of the SQL table column.
The data type of the value and the SQL table column specified in the qualification match.
The value that you specified for the table column does not exceed its data limit.
130110
Error
Number format exception occurred while data type conversion for plug-in <{0}>
: <{1}>.
Description You are attempting to use an incorrect value in the qualification for a field of Number format.
Solution Make sure that the value that you specify for the numeric field is of Number format.

for each BMC Atrium Product Catalog (Product Catalog) error.
Error
number
Message
type
48509
Error
You cannot create a company from a Spoke system.

Description You are attempting to create a company on a BMC Remedy ITSM system that is configured
as a spoke.
Solution Make sure that you create a company on a BMC Remedy ITSM system that is configured as a
hub.
48510
Error
This system is a Hub server, you must provide a Spoke server name to register
a company.
Description You did not select a spoke server from the Spoke Server list on the Hub and Spoke tab
when creating a company.
Solution Select the registered spoke server on which you want to create the company.
105001
Error
Enter the mandatory fields 'Product Categorization Tier 1', 'Product

Categorization Tier 2', 'Product Categorization Tier 3', 'Product Name', '
Manufacturer', 'Suite Definition', 'Origin', 'Status-PDC' and 'Product Type'.
Description You did not specify values for the required fields listed in the error message when creating a
product.
Solution Specify values for the required fields.
BMC Atrium Core 9.0
Page 2041 of 2268
Home
Error
number
Message
type
105002
Error
Please do enter the mandatory fields 'Product Model/Version', 'Requires

Contract' and 'Model/Version State'.
Description You did not specify values for the required fields listed in the error message when creating a
product.
Solution Specify values for the required fields.
105003
Error
Please do enter the mandatory field 'Patch Last Build ID'.

Description You did not specify a value for the required field listed in the error message when creating a
product.
Solution Specify a value for the Patch Last Build ID field.
105004
Error
This Signature ID does not exist in Signature Table.

Description The signature that you are attempting to associate to the product does not exist.
Solution Make sure that the Signature ID exists in the PCT:Signature form.
105005
Error
Company $Company$ does not exists.

Description The Company that you are attempting to associate to the product does not exist.
Solution Make sure that the company exists in the COM:Company form.
105006
Note
Product has been created successfully. Product Catalog Key is $PCTKey$.

Description The product with the given Product Catalog Key was successfully created.
105007
Error
The selected combination of Approved Flag and Blacklisted Flag is Invalid.

Description The combination of values that you specified for the Blacklisted Flag and the Approved Flag
when creating a product is invalid.
Solution Check the values that you specified for the Approved Flag and Blacklisted Flag fields.
105008
Note
Saved successfully.
Description The record that you created has been saved.
105009
Note
The Company record that you are trying to create already exists. Please enter
a different Company name if you want to create a new Company record.
Description The company name that you specified for the new company record already exists.
Solution Specify a unique company name for the company.
105010
Note
The selected patch has been successfully related with $420000400$ and
associated status flags.
Description An association with the product patch and the Managed/Blacklisted/Hidden flags and
Company field was successfully created.
105011
Note
The selected version has been successfully related with $420000341$ and
associated status flags.
Description An association with the product version and the Managed/Blacklisted/Hidden flags and
Company field was successfully created.
105012
Error
This record already exists. Please verify or reselect your field entries and
try again.
Description You are attempting to create a duplicate record.
Solution Specify unique values for the record.
105013
Error
Select a Company value.

Description The Company field cannot contain a NULL value when you create a product Version and
Company association.
Solution Specify a value in the Company field.
105014
Note
BMC Atrium Core 9.0
Page 2042 of 2268
Home
Error
Message
number
type
Setting associated versions as hidden for product $240001002$ and company

$1000000001$.
Description The product versions of the given Product and Company were successfully set as Hidden.
105015
Note
Setting associated versions as blacklisted for product $Product Name$ and

company $Company$.
Description The product versions of the given product and company were successfully set as
BlackListed.
105016
Note
Setting associated versions as approved for product $Product Name$ and company
$Company$.
Description The product versions of the given product and company were successfully set as Approved.
105021
Error
Please fill in the mandatory fields: PCTKey, SignatureId.

Description You are attempting to create a signature and product association with NULL values in the
PCTKey and SignatureId fields.
Solution Specify values for the PCTKey and SignatureId fields.
105022
Error
Please fill in the mandatory fields: Logical Data Group, Version, Attachment.
Description You did not specify values for the required fields listed in the error message when you were
creating a signature.
Solution Specify values for the Logical Data Group, Version, and Attachment fields.
105023
Error
Select a Product or Model Version to delete.

Description You are attempting to delete a product that does not exist.
Solution Before you click Delete, specify a product or model version.
105024
Error
Select a Product, Model Version or Patch to delete.Description You are attempting to

delete a product that does not exist. Solution Before you click Delete, specify a product, model version,
or patch.
105025
Note
Choose a Product Catalog View.

Description You are attempting to search for products in the Product Catalog without specifying search
criteria. This operation is invalid.
Solution Before you click Search, select a location or product in the Product Catalog View list to search.
105026
Error
The combination of Selection Type, Selection Code, and Locale already exist.
Please select different values.
Description The combination of Selection Type, Selection Code, and Locale that you specified already
exists.
Solution Specify values for the fields as listed:
For Selection Code: any values.
For Selection Code: any number between -2147483647 and 2147483647.
For Locale the possible values are: zh_CN, ru, ja, it, de, ko, fr, es and en.
105027
Warning
Software Library Item can't be created for empty (NULL) 'Model/Version'.

Description You are attempting to save a software item with a NULL value in the Model/Version field.
Solution Specify a value for the Model/Version field.
105028
Note
Entry Saved.
Description The record that you created on the current form was saved.
105029
Error
BMC Atrium Core 9.0
Page 2043 of 2268
Home
Error
number
Message
type
The selected combination of Patch Life Cycle Status is Invalid with Version
Life Cycle combination.
Description The combination of values that you specified for the Patch Life Cycle Status and Version Life
Cycle fields is invalid.
Solution Select appropriate values.
105030
Error
The selected combination of Version Life Cycle Status is Invalid with Product
Life Cycle combination.
Description The combination of values that you specified for the Version Life Cycle Status and Product
Life Cycle fields is invalid.
Solution Select correct values.
105031
Error
The selected combination of Approved Flag and Blacklisted Flag is Invalid.

Description The combination of values that you specified for the Blacklisted Flag and the Approved Flag
when creating a product is invalid.
Solution Check the values that you specified for the Approved Flag and Blacklisted Flag fields.
105050
Information
Product $Discovered Product$ has been successfully created as alias of

Existing Product $z1D_ExistingProduct$.
Description The discovered product has been successfully added in the BMC Atrium Product Catalog as
an alias of the product mentioned in the message.
105051
Information
Manufacturer $Discovered Manufacturer$ has been created as Alias of Existing

Manufacturer $z1D_ExistingManuf$ successfully.
Description The discovered manufacturer has been successfully added in the BMC Atrium Product
Catalog as an alias of the manufacturer mentioned in the message.
105053
Warning
Are you sure you want to delete discovered product"$Discovered Product$)" ?."
Description Your action will delete the product that was discovered. Make sure you click OK only if you
want to delete the product.
105054
Information
Manufacturer $z1D_Manufacturer$ has been successfully added to the

Normalization Alias form as an alias of $Manufacturer$.
Description The manufacturer has been successfully added to the Normalization Alias form as an alias
of the = manufacturer mentioned in the message.
105055
Information
Product $z1D_Product$ has been successfully added as Alias of $Product Name$

to Normalization Alias form.
Description The product has been successfully added to the Normalization Alias form as an alias of the
product mentioned in the message.
105056
Information
The product $Product Name$ has been successfully updated.

Description The product you modified has been successfully saved.
105057
Information
Alias $NameAlias$ of manufacturer $Existing Manuf Name$ has been successfully

created.
Description An alias name for the manufacturer has been successfully created.
105058
Error
Attribute Name is required field.

Description Attribute Name is a required field.
Solution Make sure that you specify a value for the Attribute Name field.
105059
Error
AliasName is required field.

Description Alias Name is a required field.
Solution Alias Name is a required field.
105060
Warning
BMC Atrium Core 9.0
Page 2044 of 2268
Home
Error
number
Message
type
"Are you sure you want to make the Discovered product $420000518$ an alias of
$420000548$ ?.Clicking O.K. will mark the product $420000518$ Offline."
Description You are attempting to assign an alias for the discovered product that will mark it as Offline.
Solution Assign the alias only if you want to mark the discovered product as Offline.
105061
Error
Product having status "Enabled" cannot be deleted. Only Offline products can
be deleted.
Description You are attempting to delete a product that is currently available.
Solution Mark the product as Offline before you delete it.
105062
Error
Offline product cannot be made Alias of another product.

Description You are attempting to create an alias for a product that is currently unavailable.
Solution Mark the product as Enabled before you create an alias for it.
105063
Error
An entry with the product name does not exist. Create an alias of existing
product.
Description The product name that you specified does not exist.
Solution Create an alias for the product with the new name.
105064
Error
An entry with the manufacturer name does not exist. Enter a different
manufacturer name.
Description The manufacturer name that you specified does not exist.
Solution Make sure that the specified manufacturer exists in the BMC Atrium Product Catalog.
105065
Error
User $z1D_LoggedInUser$ does not have permissions for company $z2TF Company (
PDA)$.
Description You do not have the required permission to access the given company.
Solution Contact your system administrator to request access to the given company.

The following tables lists the error number, message type, message text, description, and solution
for each BMC Atrium Core Console error that is generated by active links.
Error
number
Message
type
13015
Error
Auditing not enabled for any class.

Description The Audit option is not enabled for any class in the Common Data Model (CDM). To view
audit history, at least one class must be audit enabled.
Solution Contact your CMDB administrator to make sure the Audit option for classes is enabled both at
the class and attribute level.
13204
Error
You do not have access to any audited entry for this instance.
Description You are attempting to view the audit history of the instance. You do not have access
permissions to perform this operation.
Solution Contact your CMDB administrator.
13205
Warning
There is no audited entry for this instance.

Description The instance for which you want to view audit history has no data.
Solution Make sure there is data for the specific instance.
20152
Warning
BMC Atrium Core 9.0
Page 2045 of 2268
Home
Error
number
Message
type
Close operation canceled. No changes were saved.(OBJSTR:OnCancel_Cancel_Close/

Undisplay)
Description Your changes were not saved.
Solution To save your changes before closing a form, use the Cancel button.
120065
Error
You must provide ID Values for a Custom Selection.(OBJSTR:

AttributeDef_CheckCustomSelection )
Description You did not specify ID values for the field values when creating a custom selection field.
Solution Specify ID values for the custom selection field.
120217
Warning
BMC has reserved the range of enum IDs from 0 to 10,000. To prevent ID
conflicts, do not use ID values from this enum set.
Description You have chosen a value between 0 and 10,000.
Solution Choose a value 10,001 onwards.
125002
Error
Please specify Data Type.(OBJSTR:AttributeDef_OnSelect_CharacteristicsTab01)

Description You did not specify a data type for a field on the Characteristics tab.
Solution Specify a data type for the field.
125003
Error

Description You did not specify the data type for a field on the Characteristics tab.
Solution Specify a data type for the field on the Characteristics tab.
125004
Error

Solution Specify a data type for the field on the Characteristics tab.
125005
Error

Solution Specify a data type for the field on Characteristics tab.
125005
Error

Solution Specify a data type for the field on Characteristics tab.
125006
Error
Namespace and Class Name must be entered before you can add or search
attributes.(OBJSTR:ClassDef_Attrib_AddSearchBtns_CheckForClassAndNamespace_Msg
)
Description You did not specify a namespace and class name for the attribute.
Solution Specify a namespace and class name.
125007
Error
There is already an existing class with class name $490001100$ in the

namespace $400109900$.(OBJSTR:ClassDef_ChkDuplicateClass02)
Description The class name that you specified is not unique within the class namespace.
Solution Specify a different name for your class.
125008
Error
Invalid superclass. Class $400103900$ is a final class and cannot be used as a

superclass.(OBJSTR:ClassDef_ChkSuperclassIsNotFinalClass02)
Description You are attempting to derive a subclass from a final class.
Solution You cannot derive a subclass from a final class.
125009
Error
Namespace and Class Name are required subclasses.(OBJSTR:

ClassDef_OnSaveChkReqsubclasses)
Description You did not specify the class name and namespace attributes for the subclass.
Solution Specify the class name and namespace attributes.
BMC Atrium Core 9.0
Page 2046 of 2268
Home
Error
Message
number
type
125010
Error
Class 1, Class 2, Role 1, Role 2, and Association Enforcement are required

subclasses for relationship classes.(OBJSTR:
ClassDef_OnSaveChkReqsubclassesForRelationship)
Description You did not specify the required attributes for the relationship class.
Solution Specify these values before saving.
125012
Error
This attribute is already part of the Index.(OBJSTR:IdxCon-AttribAlreadyExist)

Description You are attempting to specify an attribute for the index that is already in use.
Solution Specify a different attribute.
125013
Error
Please enter the Index Name first.(OBJSTR:IdxCon-GainFocusProperty_tbl)

Description You must specify a name for the index before you create it.
Solution Specify an index name.
125014
Error
There is already an index by the name of: $400111200$. Please use a different
name.(OBJSTR:IdxCon-IndexNameLooseFocus01a)
Description You are attempting to specify an attribute for the index that is already in use.
Solution Specify a different attribute.
125028
Error
Please select an Attribute from Class 1 and Class 2.(OBJSTR:

WRdlg-cmdMapWeakRel01)
Description You did not specify the attribute that you want to propagate in the weak relationship.
Solution You must specify an attribute from Class 1 and Class 2.
125029
Error
Invalid data type mismatch. You can only map Attributes with the same data
type.(OBJSTR:WRdlg-cmdMapWeakRel02)
Description The data types of the attributes that you specified do not match.
Solution Make sure that the data types of the attributes match.
125030
Information
Attribute '$400009700$' has been saved.(OBJSTR:AttributeDef_SaveChanges )

Description The attribute number specified in the message is saved.
BMC Atrium CMDB C API error messages

for errors that are generated by BMC Atrium CMDB C API.
C API error messages
Error
number
Message
type
120000
Error
The CMDB API session is not initialized. (CMDB_ERROR_SYSTEM_NOT_INITIALIZED)

Description You did not initialize the CMDB API session in your API calls.
Solution You must call the CMDBInitialization function before calling another BMC Atrium CMDB C
API function.
120001
Error
A fatal error occurred during CMDB initialization. The CMDB system cannot be
initialized. (CMDB_ERROR_SYSTEM_CANNOT_BE_INITIALIZED)
Description A system error prevented the CMDB from being initialized.
120002
Error
BMC Atrium Core 9.0
Page 2047 of 2268
Home
Error
number
Message
type
Class does not exist. (CMDB_ERROR_NO_SUCH_CLASS)

Description The class that you are attempting to view does not exist in the CMDB.
Solution Specify a valid class name or class ID.
120003
Error
A required parameter is empty. (CMDB_ERROR_REQUIRED_PARAM_EMPTY )

Description You did not specify a value for a required function parameter.
Solution Provide a non-empty parameter to the BMC Atrium CMDB C API function call.
120004
Error
Attribute does not exist. (CMDB_ERROR_NO_SUCH_ATTRIBUTE )

Description The attribute that you are attempting to view does not exist.
Solution Provide a valid attribute name or ID.
120005
Error
The supplied attribute data type is not supported. (

CMDB_ERROR_UNSUPPORTED_ATTRIBUTE_DATA_TYPE )
Description The data type specified for the attribute does not exist in the CMDB.
Solution Make sure that the supplied attribute data type is valid for BMC Atrium CMDB. For more
information about data types, see "AR_DATA_TYPE" section of the ar.h file.
120006
Error
Instance not found. (CMDB_ERROR_INSTANCE_NOT_FOUND)

Description The specified instance is not found.
Solution Specify a valid instance ID.
120007
Error
CMDB system error occurred during processing. (CMDB_ERROR_SYSTEM_ERROR)

Description An unexpected system error occurred during CMDB processing.
120009
Error
The class name is not unique. The class name is already in use. (
CMDB_ERROR_CLASS_NAME_ID_NOT_UNIQUE )
Description The specified class name already exists within the given namespace.
Solution Specify an unused class name.
120011
Error
Class already exists. (CMDB_ERROR_CLASS_ALREADY_EXISTS )

Description A class with the specified class ID already exists.
Solution Create a class with a different class ID.
120014
Error
The attribute name is not unique. The attribute name is already in use. (
CMDB_ERROR_ATTRIBUTE_NAME_NOT_UNIQUE )
Description An attribute with the specified name already exists.
Solution Specify an unused attribute name.
120015
Error
Attribute already exists. (CMDB_ERROR_ATTRIBUTE_ALREADY_EXISTS )

Description An attribute with the same attribute ID already exists.
Solution Specify a different attribute ID.
120016
Error
The default enumeration value is invalid. (CMDB_ERROR_INVALID_ENUM_DEFAULT )

Description The default value specified for the enumeration attribute is not one of its defined values.
Solution Specify an enumeration value that is defined for the attribute.
120017
Error
The specified list format is not valid. (CMDB_ERROR_INVALID_LIST_FORMAT )

Description The format is L n, where n is the maximum number of items.
Solution Modify the list format to L n.
120018
Error
(CMDB_ERROR_EXCEED_MAX_LIST_ITEMS )
Description The number of semicolon-separated items in a character attribute exceeds the number
defined in the List format.
Solution Decrease the number of items in the attribute for the current instance or change the attribute's
definitions to increase the number defined in its List Format.
BMC Atrium Core 9.0
Page 2048 of 2268
Home
Error
number
Message
type
120019
Error
The relationship role names must be different. (

CMDB_ERROR_ROLE_NAMES_MUST_BE_DIFFERENT )
Description You cannot create a relationship class with two roles of the same name.
Solution Provide a different role name for each role.
120020
Error
An invalid cardinality value was supplied. (

CMDB_ERROR_INVALID_CARDINALITY_VALUE )
Description The cardinality that you specified is not one of the defined values.
Solution Specify a valid cardinality value.
120021
Error
Cannot create a relationship class that is derived for a non-relationship

class. (CMDB_ERROR_SUPERCLASS_MUST_BE_REL_CLASS )
Description You are attempting to derive a relationship class from a class of another type.
Solution Make sure that you derive a relationship only from a relationship class.
120022
Error
The role name does not match the superclass role name. (
CMDB_ERROR_ROLE_NAME_DOES_NOT_MATCH_SUPERCLASS )
Description When you create a derived relationship class, the role name properties must match the
superclass's role name properties.
Solution Supply the same role name as the superclass.
120023
Error
The Configuration Item Class for the role is not a derived class of the
superclass's role. (CMDB_ERROR_CLASS_ROLE_NOT_SUPERCLASS_DERIVED )
Description When you create a derived relationship class, the configuration item role classes must be
the same as or derived from the superclass's configuration item role classes.
Solution Derive a role class from the super class's role class.
120024
Error
The cardinality of the derived relationship class cannot be less restrictive

than the superclass. (CMDB_ERROR_SUBCLASS_CARDINALITY_LESS_RESTRICTIVE )
Description If the superclass cardinality is one-to-many, the derived class cardinality can be one-to-one
but cannot be many-to-many.
Solution Specify a cardinality that is the same as the superclass or is more restrictive than the superclass
.
120025
Error
The supplied relationship parameter cannot be modified. (

CMDB_ERROR_RELATIONSHIP_PARAM_CANNOT_BE_CHANGED)
Description You cannot modify the relationship parameter.
Solution Do not attempt to modify the relationship parameter.
120026
Error
The supplied class type is invalid. (CMDB_ERROR_INVALID_CLASS_TYPE )

Description The class type that you specified is not one of the system-defined class types.
Solution Select a valid class type--CI or Relationship.
120027
Error
The class type cannot be modified. (CMDB_ERROR_CLASS_TYPE_CANNOT_BE_CHANGED )

Description You cannot modify the class type.
Solution Do not attempt to modify an existing class type.
120028
Error
The attribute cannot be set. (CMDB_ERROR_ATTRIBUTE_CANNOT_BE_SET )

Description You cannot set the attribute.
120029
Error
The attribute information is corrupt. (CMDB_ERROR_ATTRIBUTE_INFO_CORRUPT )

Description Information for the attribute is corrupt.
120030
Error
BMC Atrium Core 9.0
Page 2049 of 2268
Home
Error
number
Message
type
Invalid instance operation on the abstract class. (

CMDB_ERROR_INVALID_ABSTRACT_CLASS_INST_OPERATION )
Description You are attempting to perform an abstract class operation on an instance.
Solution Perform the operation on a non-abstract class.
120031
Error
The parameters for the categorization class are invalid. (

CMDB_ERROR_INVALID_CATEGORAIZATION_SUBCLASS )
Description The parameter value that you specified for the categorization class does not match the class
definition.
Solution Make sure that the parameters for the categorization class are correct.
120032
Error
The parameters for the final class are invalid. (CMDB_ERROR_INVALID_FINAL_CLASS

)
Description The parameter value that you specified for the final class does not match the class definition.
Solution Make sure that the parameters for the final class are correct.
120033
Error
The parameters for the singleton class are invalid. (

CMDB_ERROR_INVALID_SINGLETON_CLASS )
Description The parameter value that you specified for the singleton class does not match with the class
definition.
Solution Make sure that the parameters for the singleton class are correct.
120034
Warning
The specified export item type is invalid. (CMDB_WARN_INVALID_EXPORT_ITEM_TYPE )

Description The item type you are attempting to export is invalid.
Solution The export item should be either of type CMDB-ITEM-TYPE-META-DATA (1) or
CMDB-INSTANCE-DATA (2).
120035
Error
The permission list must be a list of group IDs separated by semicolons. (

CMDB_ERROR_PERMISSION_LIST_INVALID )
Description You are attempting to use an invalid character to separate group IDs in a list.
Solution Use semicolons to separate the groups IDs in the permission list.
120036
Error
The specified query graph does not have a starting node. (

CMDB_ERROR_QUERY_GRAPH_HAS_NO_STARTNODE )
Description You omitted the starting node parameter in a graph query.
Solution Make sure that you specify the starting node information in the graph query.
120037
Error
A specified node is ambiguous. (CMDB_ERROR_QUERY_GRAPH_HAS_AMBIGUOUS_NODE )

Description More than one node has the same name for the query graph.
Solution Use an extension ID to distinguish between nodes within the same class and namespace.
120038
Error
Creating more than one instance in a singleton class is not allowed. (

CMDB_ERROR_INVALID_SINGLETON_CLASS_INST_OPERATION )
Description You can create only one instance from a singleton class.
Solution Do not create more than one instance from a singleton class.
120039
Error
The operation violates the cardinality constraint of the relationship. (

CMDB_ERROR_RELATION_CARDINALITY_CHECK )
Description The operation that you are performing violates the cardinality constraint of the relationship.
Solution Using the BMC Atrium Explorer, make sure that the operation does not violate the cardinality
constraint.
120040
Error
The relationship endpoint instance does not exist. (

CMDB_ERROR_RELATION_END_PT_DOES_NOT_EXIST )
Description You are attempting to create a relationship for a CI instance that does not exist.
Solution Make sure that the instance exists.
BMC Atrium Core 9.0
Page 2050 of 2268
Home
Error
Message
number
type
120041
Error
Required attributes are not allowed in categorization classes. (

CMDB_ERROR_CATSUBCLASS_REQD_ATTR_NOT_ALLOWED )
Description You are specifying the entry mode option as Required for the categorization class. This
option is not allowed.
Solution Change the entry mode to Optional.
120042
Error
Because the relationship superclass is a weak relationship, this class must

also be a weak relationship. (CMDB_ERROR_SUBCLASS_MUST_BE_RS_WEAK_REFERENCE )
Description You cannot derive a regular relationship subclass from a weak relationship superclass.
Solution Define this class as a weak relationship.
120043
Error
Invalid cardinality for the weak relationship. (

CMDB_ERROR_INVALID_CARDINALITY_FOR_WEAK_REFERENCE )
Description You are attempting to specify an incorrect cardinality for a weak relationship.
Solution Set the cardinality for a weak relationship to either one-to-many or one-to-one.
120044
Error
The weak instance is already associated with another lead instance. (

CMDB_ERROR_WEAK_INSTANCE_ALREADY_ASSOCIATED )
Description You are attempting to specify more than one lead instance for a weak instance.
Solution Dissociate the weak instance before trying to associate it with another lead instance.
120045
Error
The weak class of the weak relationship cannot be abstract. (

CMDB_ERROR_NO_WEAK_RELATION_ABSTRACT_CLASS_ALLOWED )
Description You cannot create a weak class of the abstract type for a weak relationship.
Solution Define the weak class of the weak relationship as non-abstract.
120046
Error
Setting lead class reference values is not allowed. (

CMDB_ERROR_SETTING_LEAD_CLASS_REF_DISALLOWED )
Description You cannot modify the attributes propagated from the lead class.
Solution Do not attempt to modify propagated, read-only attributes values.
120048
Error
You cannot set a primary key characteristic on an attribute. (

CMDB_ERROR_CANNOT_MODIFY_PRIMARY_KEY_ON_ATTRIBUTE )
Description You can set an attribute as the primary key only using a unique index.
Solution You must set the primary key characteristic using an index.
120049
Error
The primary key must be a unique index. (CMDB_ERROR_PRIMARY_KEY_ISNT_UNIQUE )

Description The attribute that you are attempting to set as primary key contains duplicate values.
Solution Specify a unique index as the primary key.
120050
Error
You can have only one primary key per class. (

CMDB_ERROR_MORE_THAN_ONE_PRIMARY_KEY_DISALLOWED )
Description You are attempting to set more than one primary key for a class.
Solution Specify only one primary key per class.
120051
Error
The weak class for the weak relationship class cannot be a categorization
class. (CMDB_ERROR_NO_RHS_CATSUBCLASS_FOR_WEAK_REFERENCE )
Description You are attempting to create the right-hand class as a categorization class in a week
relationship.
Solution Define the weak class as a noncategorization class.
120052
Error
The specified index could not be found. (CMDB_ERROR_NO_SUCH_INDEX)

Description The index that you specified might be incorrect.
Solution Make sure that the index that you provide exists.
120053
Error
BMC Atrium Core 9.0
Page 2051 of 2268
Home
Error
number
Message
type
The class cannot be deleted because this class has instance data. (
CMDB_ERROR_DELETE_CLASS_FAILED_DATA_EXISTS )
Description You are attempting to delete a class that contains data.
Solution To delete a class that contains data, specify Delete With Data as the delete option.
120054
Error
The class cannot be deleted because there are class dependencies on this class
. (CMDB_ERROR_DELETE_CLASS_FAILED_DEPENDECIES_EXISTS )
Description You are attempting to delete a class that has a subclass or is a CI instance for a relationship.
Solution To delete a class with dependencies, specify Delete With Dependencies as the delete option.
WARNING: The Delete With Dependencies option also deletes all dependent classes even if they contain
data.
120055
Warning
This class is a derived class of the class being deleted. (

CMDB_WARN_DELETE_CLASS_FAILED_DEP_REG_CLASS )
Description This is a warning that the class being deleted had a derived class.
120056
Warning
An endpoint for this relationship class is the class being deleted. (

CMDB_WARN_DELETE_CLASS_FAILED_DEP_REL_CLASS )
Description This is a warning that a CI instance for the specified relationship class is being deleted.
120057
Warning
This class is a weak class of the relationship class being deleted. (

CMDB_WARN_DELETE_CLASS_FAILED_DEP_WEAK_REF_CLASS )
Description This is a warning that the specified weak class of the relationship class is being deleted.
120058
Error
The source attribute on the lead class for attribute propagation does not
exist. (CMDB_ERROR_NO_SUCH_SOURCE_ATTRIBUTE_FOR_WEAK_REL )
Description You are attempting to propagate an attribute that does not exist in the source class.
Solution Make sure that the source attribute exists in the lead class.
120059
Error
The target attribute on the weak class for attribute propagation does not
exist. (CMDB_ERROR_NO_SUCH_TARGET_ATTRIBUTE_FOR_WEAK_REL )
Description You are attempting to propagate a nonexistent attribute of the weak class.
Solution Make sure that the target attribute exists in the weak class.
120060
Error
The data types for the source and target attributes do not match. (
CMDB_ERROR_ATTRIBUTE_DATATYPE_MISMATCH_FOR_WEAK_REL )
Description The attributes being propagated from the lead and weak classes must have the same data
type.
Solution Make sure that the data type of the propagated attributes matches.
120061
Error
The specified target attribute on the weak class cannot be a derived attribute
from a superclass. (CMDB_ERROR_TARGET_WEAK_ATTR_CANNOT_DERIVED_ATTR )
Description You are attempting to specify a derived attribute as the target attribute in the weak class.
Solution Specify a target attribute for the weak class that is not derived from its superclass.
120062
Error
Permissions for a categorization class must be the same as the permissions for
the superclass. (CMDB_ERROR_CATGORIZATION_SUB_PERM_LIST_INVALID )
Description The categorization class permissions must match the permissions of its superclass.
Solution Make sure that the categorization class permissions match those of its superclass.
120063
Error
Instances cannot be deleted from this form. (

CMDB_ERROR_INSTANCE_DELETE_ON_FORM_DISALLOWED)
Description You cannot delete an instance from the regular subclass form.
Solution Delete the instance by using the join form of the class.
120064
Error
BMC Atrium Core 9.0
Page 2052 of 2268
Home
Error
number
Message
type
The system failed to create a unique identifier. (CMDB_ERROR_CREATE_GUID_FAILED

)
Description The system was unable to generate a unique identifier.
Solution If required, restart your process to generate the GUID.
120067
Error
An entry in the import item list is invalid. (CMDB_ERROR_IMPORT_ITEM_ITEM )

Description An item in the specified import directory is not available.
Solution Make sure that the item exists in the specified directory.
120068
Error
Data type does not match the data type defined for this attribute. (
CMDB_ERROR_MISMATCHING_ATTR_DATATYPE )
Description The value that you specified for the attribute does not match the attribute definition.
Solution Specify appropriate values that match the attribute data type definition.
120069
Error
Attribute value does not fall within the limits defined for this attribute. (
CMDB_ERROR_ATTRIBUTE_VALUE_OUT_OF_LIMITS )
Description The attribute value that you specified is not within the defined range for the attribute.
Solution Make sure that the attribute value is within the defined range.
120070
Error
Index list is invalid. (CMDB_ERROR_INVALID_INDEX_LIST )

Description You specified an invalid index list.
Solution Make sure that the index properties that are specified in the error message are valid.
120071
Error
Setting the form name class characteristic is not allowed. (

CMDB_ERROR_SETTING_FORM_NAME_CHARAC_DISALLOWED )
Description The Form Name characteristic is an invalid option for the class.
Solution You cannot set the Form Name class characteristic.
120072
Error
The data type for the class characteristic value is invalid. (

CMDB_ERROR_INVALID_DATATYPE_FOR_CLASS_CHARAC )
Description The value that you specified for class characteristic subclasses does not match its data type.
Solution Specify a valid value for the class characteristic.
120073
Error
The namespace name is too long. Must be 70 or fewer characters. (

CMDB_ERROR_NAMESPACE_NAME_TOO_LONG )
Description The namespace name that you specified cannot exceed its character limit.
Solution Specify a namespace name that is 70 or fewer characters.
120074
Error
The class name is too long. Must be 80 or fewer characters. (

CMDB_ERROR_CLASS_NAME_TOO_LONG )
Description The class name that you specified cannot exceed its character limit.
Solution Specify a class name that is 80 or fewer characters.
120075
Error
The subclass namespace must match the superclass namespace. (

CMDB_ERROR_SUBCLASS_SUPERCLASS_NAMESPACE_MISMATCH)
Description The namespace that you specified for the subclass does not match its superclass.
Solution Specify the same subclass namespace as the superclass.
120076
Error
No value supplied for a required attribute. (

CMDB_ERROR_REQUIRED_ATTRIBUTE_VALUE_MISSING )
Description You did not specify a value for a required attribute.
Solution Specify a value for the required attribute.
120077
Error
BMC Atrium Core 9.0
Page 2053 of 2268
Home
Error
number
Message
type
Modifying the namespace name after class creation is not allowed. (

CMDB_ERROR_MODIFY_NAMESPACE_NAME_IS_DISALLOWED )
Description You cannot modify the namespace name after the class is created.
Solution If required, delete this class and create a new one.
120078
Error
The supplied character is not allowed in the name. (

CMDB_ERROR_CHARACTER_DISALLOWED_IN_NAME )
Description You specified invalid characters for the name.
Solution Create an alphanumeric name containing any of the wildcard characters: underscore (_) or
period (.).
120079
Error
The attribute name is too long. Must be 80 or fewer characters. (

CMDB_ERROR_ATTRIBUTE_NAME_TOO_LONG )
Description The attribute name that you specified cannot exceed its character limit.
Solution Specify an attribute name that is 80 or fewer characters.
120080
Error
Invalid value for the entry mode. (CMDB_ERROR_INVALID_ATTRIBUTE_ENTRY_MODE )

Description You specified an invalid value for the entry mode subclasses.
Solution Specify one of the valid values: 0-None, 1-Required, 2-Optional, 3-System, or 4Display_Only.
120081
Error
Field ID is not unique within the class or within the class hierarchy. (
CMDB_ERROR_ATTR_FIELD_ID_NOT_UNIQUE)
Description The field ID you specified is already in use within the specified class hierarchy.
Solution Specify a different field ID.
120082
Error
Invalid data type for the attribute characteristic. (

CMDB_ERROR_INVALID_DATATYPE_FOR_ATTR_CHARAC )
Description The data type that you specified for the attribute characteristic is invalid.
Solution Specify one of the valid values: 0-None, 1-View_Perms, 2-Change_Perms, 3-Hidden, 4Primary_Key, 5-Propogated_Owner, 6-Create_Mode, 7-Audit_Option, or 8-Namespace.
120083
Error
Setting the primary key attribute characteristic is not allowed. (

CMDB_ERROR_SETTING_PRIMARY_KEY_CHARAC_DISALLOWED )
Description The primary key characteristic is an invalid option for the attribute.
Solution You cannot set the primary key attribute characteristic.
120084
Error
Setting the propagated owner attribute characteristic is not allowed. (

CMDB_ERROR_SETTING_PROP_OWNER_CHARAC_DISALLOWED )
Description The propagated owner characteristic is an invalid option for the attribute.
Solution You cannot set the propagated owner attribute characteristic.
120085
Error
The namespace for the relationship endpoint class does not match the namespace
of the relationship class. (CMDB_ERROR_REL_END_POINT_CLASS_NAMESPACE_MISMATCH )
Description You are attempting to create a CI instance in a namespace different from that of the
relationship class.
Solution Specify a CI instance from the same namespace as the relationship class.
120086
Error
Enum name is invalid. (CMDB_ERROR_ENUM_NAME_INVALID)

Description The enumeration name you specified is invalid.
Solution Specify an attribute ID that is unique within the class hierarchy.
120087
Error
Attribute ID is not unique within the class or within the class hierarchy. (
CMDB_ERROR_ATTRIBUTE_ID_NOT_UNIQUE )
Description You specified an attribute ID that is not unique within the class hierarchy.
Solution Specify a unique attribute ID within the class hierarchy.
BMC Atrium Core 9.0
Page 2054 of 2268
Home
Error
Message
number
type
120088
Error
Invalid data type for the attribute limit structure. (

CMDB_ERROR_INVALID_ATTR_LIMIT_DATA_TYPE )
Description You specified an invalid value for the attribute limit structure.
Solution The data type for the attribute limit structure must either match the data type of the attribute or
be NULL.
120089
Error
You do not have access to the class. (CMDB_ERROR_NO_ACCESS_TO_CLASS )

Description You do not have permissions to access the class.
120090
Error
You do not have access to the attribute. (CMDB_ERROR_NO_ACCESS_TO_ATTRIBUTE )

Description You do not have permissions to the access the attribute.
120092
Error
The dataset ID and Reconciliation Identity combination is not unique. (

CMDB_ERROR_DATASET_ID_RECON_ID_NOT_UNIQUE )
Description The combination of reconciliation ID and dataset ID is not unique.
Solution Change one of these values to make the combination unique.
120093
Error
The class ID is not valid.CMDB_ERROR_INVALID_CLASS_ID

Description No such class with the class ID that you specified exists.
Solution Verify that you have specified the correct class ID.
120094
Error
The direction provided for graph query is not valid. (

CMDB_ERROR_QUERY_GRAPH_INVALID_DIRECTION )
Description You specified an invalid direction value for the graph query.
Solution Specify one of these valid values: 0-Direction_Out, or 1-Direction_In.
120095
Error
Current object store API version is deprecated. (

CMDB_ERROR_CURRENT_API_IS_DEPRECATED )
Description You are attempting to use an API call that is now deprecated.
Solution Upgrade to the current version of the CMDB API.
120096
Warning
Instances skipped during import. (CMDB_WARN_IMPORT_INST_SKIPPED )

Description Certain instances were not imported during the import activity.
120097
Information
Instance import summary. (CMDB_INFO_IMPORT_INST_SUMMARY )

Description This message signifies that the instance import summary follows.
120098
Error
The deleteOption value specified is invalid. (CMDB_ERROR_INVALID_DELETE_OPTION

)
Description You specified an invalid delete option for the class.
Solution Specify one of these valid values: CMDB_DELETE_CLASS_OPTION_NONE,
CMDB_DELETE_CLASS_OPTION_WITH_DATA, or CMDB_DELETE_CLASS_OPTION_ALL_DEPENDENCIES
.
120099
Error
The metadata status value specified is invalid. (

CMDB_ERROR_INVALID_META_DATA_STATUS )
Description You specified an invalid value for the metadata status.
Solution Specify one of these valid values: CMDB_META_DATA_STATUS_DELETE_PENDING or
CMDB_META_DATA_STATUS_CHANGE_PENDING.
120100
Error
One of the endpoints specified for the relationship has an invalid class ID. (
CMDB_ERROR_INVALID_REL_ENDPOINT_CLASS_ID )
Description You specified an invalid class ID for one of the CI instances in the relationship.
Solution Specify a valid class ID for the instance.
BMC Atrium Core 9.0
Page 2055 of 2268
Home
Error
number
Message
type
120101
Error
Internal system error. (CMDB_ERROR_ACCESS_TLS_BLOCK_FAILED )

Description Access to the thread local storage block failed.
120102
Error
A version string in the SHARE:Application_Properties form is invalid. (

CMDB_ERROR_UNRECOGNIZED_VERSION_PATCH_STRING )
Description The version string for the CMDB patch is invalid.
Solution Replace the patch string with a valid version string.
120103
Error
Cascade Delete cannot be enabled for the relationship because its cardinality
is invalid for cascade deletes. (CMDB_ERROR_INVALID_CASCADE_DELETE_VALUE )
Description You specified an invalid cascade delete option for the relationship.
Solution Specify a cardinality of one-to-many or one-to-one for the relationship.
120104
Error
Reconciliation job cannot be started. (CMDBRE_ERROR_START_JOB_RUN_FAILED)

Description An internal error has caused your reconciliation job to fail.
Solution Contact BMC Customer Support for help.
120105
Error
Failed to cancel reconciliation job. (CMDBRE_ERROR_CANCEL_JOB_RUN_FAILED)

Description An internal error has caused an unsuccessful cancellation of your reconciliation job.
Solution Contact BMC Customer Support for help.
120106
Error
Job that is already in queue. (CMDBRE_ERROR_JOB_ALREADY_QUEUED)

Description You are attempting to start a job that is already in queue.
Solution Wait until the job finishes to start it again.
120107
Error
Failed to cancel a job not running. (CMDBRE_ERROR_JOB_NOT_RUNNING)

Description You are attempting to cancel a job that is not running.
Solution Before you cancel a job, make sure that the job is running.
120108
Error
Failed to find the specified job. (CMDBRE_ERROR_JOB_LOOKUP)

Description The job that you are referring to does not exist.
Solution Make sure that the associated job ID is correct.
120109
Error
Failed to start an inactive job. (CMDBRE_ERROR_INACTIVE_JOB_START)

Description You are attempting to start an inactive job.
Solution A job must be in an active state before you start it.
120110
Error
Job does not exist. (CMDBRE_ERROR_JOB_NOT_EXIST)

Description The job that you are referring to does not exist.
Solution Make sure that the job exists.
120111
Error
Failed to start a job, which is already running. (CMDBRE_ERROR_JOB_ALREADY_RUN

)
Description You cannot start a job that is already running.
Solution Wait until the currently running job is completed and start it again.
120113
Error
Number of IDs and Values does not match. (

CMDB_ERROR_ENUM_ID_VALUE_LEN_MISMATCH)
Description The number of IDs and their values that you specified do not match.
Solution Make sure that the number of IDs and the values match.
120114
Error
Invalid Enum ID. (CMDB_ERROR_ENUM_ID_INVALID)

Description You have specified an invalid Enum ID.
Solution Make sure that the Enum ID is valid.
120116
Error
BMC Atrium Core 9.0
Page 2056 of 2268
Home
Error
number
Message
type
The session ID in the supplied control structure is invalid. (

CMDB_ERROR_INVALID_AUDIT_COPY_TYPE)
Description The session ID that you specified for the login information is invalid.
Solution Make sure that the control structure is correct and your API session is correctly initialized.
120117
Error
You can not set the audit type as "Log" as the derived class has audit type as
"Copy". (CMDB_ERROR_INVALID_AUDIT_LOG_TYPE)
Description If you specified the Copy audit option for your derived class, its superclasses cannot contain
the Log audit option setting.
Solution Make sure that the superclass and subclasses have the same audit option settings.
120120
Error
Invalid dataset ID reference by the instance. (CMDB_ERROR_INVALID_DATASET_ID)

Description The dataset ID that you specified for the instance is invalid.
Solution Perform the Set, Create, and Delete operations. If the DatasetId attribute value is given in the
attribute value list, make sure that the ID is the same as the DatasetId passed in the API call signature.
120121
Error
The dataset ID does not exist. (CMDB_ERROR_NO_SUCH_DATASET)

Description The dataset ID that you specified does not exist.
Solution Make sure that the If instance for the dataset ID that you specified exists in the BMC.CORE:
BMC_Dataset class. If the problem persists, restart the AR System server.
120122
Error
The source dataset ID is missing. (CMDB_ERROR_DATASET_OVERLAY_SOURCE_MISSING)

Description You did not specify the source dataset ID.
Solution Make sure that the source dataset exists and is provided.
120123
Error
An internal error occurred. (CMDB_ERROR_DATASET_UNDERLAY_INTERNAL_ERROR)

Description The specified class ID and reconciliation ID for the underlay dataset do not exist.
Solution Make sure that the specified class ID and reconciliation ID exist.
120124
Error
Access to the dataset denied. (CMDB_ERROR_DATASET_NO_PROPER_ACCESS)

Description You are attempting to access a dataset for which you do not have appropriate access.
Solution Make sure that the access for the dataset is not set to read-only or writable by the client.
120125
Warning
Federated data corruption. (CMDB_WARNING_DATASET_CACHE_LOADING)

Description An internal error occurred when accessing federated data.
120126
Error
Federation foreign key expansion failed. (

CMDB_WARNING_FOREIGN_KEY_EXPAND_FAILED)
Description An error occurred when attempting to expand a federated link.
Solution Make sure that the federated foreign key link has the appropriate BMC_FederatedKeyLink
class name.
120127
Error
The session ID in the supplied control structure is invalid. (

CMDB_ERROR_BULK_TRAN_API_SESSION_ID_BAD)
Description The API session information that you specified in the bulk transaction function is incorrect.
Solution Make sure that the control structure is correct and that your API session is correctly initialized.
120128
Error
Cannot start another bulk transaction because a bulk transaction has already
been started. (CMDB_ERROR_BULK_TRAN_ALREADY_BEGUN)
Description You cannot start more than one bulk transaction function at a time.
Solution Make sure no other bulk transaction function is in progress.
120129
Error
BMC Atrium Core 9.0
Page 2057 of 2268
Home
Error
number
Message
type
The attempted operation cannot be performed because the bulk transaction has
not started.(CMDB_ERROR_BULK_TRAN_NOT_BEGUN)
Description You are attempting to perform a bulk transaction operation before starting a bulk transaction
session.
Solution The attempted operation can be performed only after a bulk transaction session is started.
120130
Error
Failed to promote class, which has abstract superclass. (

CMDB_ERROR_SUPERCLASS_OF_TYPE_ABSTRACT)
Description You are attempting to promote a class that is derived from an abstract class.
Solution You cannot promote a class that is derived from an abstract class.
120131
Error
Federation launch failed. (CMDB_ERROR_FEDLINK_LAUNCH_FAILED)

Description The federation link that you are attempting to launch failed.
120132
Error
Superclass not found. (CMDB_ERROR_SUPER_CLASS_NOT_FOUND)

Description The superclass that you specified is not found.
Solution Make sure that the specified superclass exists.
120133
Error
The CMDB RPC port specified is invalid. (CMDB_ERROR_RPC_SOCKET_RANGE)

Description The RPC port that you specified for the BMC Atrium Core is invalid.
Solution Specify a valid CMDB RPC port number. Valid port numbers are 0, 390696, and 390697 (Admin
thread).
120134
Error
Failed to parse the qualification. (CMDB_ERROR_FAILED_TO_RUN_QUALIFICATION)

Description The application failed to parse the specific qualification.
Solution Correct the qualification based on the error message description provided.
120136
Error
The requested object was not found in the import buffer. (

CMDB_WARNING_REQUESTED_IMPORT_OBJECT_NOT_FOUND)
Description The import item list object (class or attribute) that you requested does not exist in the .xml (
import) file.
Solution Make sure that the requested import object (class or attribute) exists in the .xml (import) file.
120137
Error
Cannot import instance because the instance ID already exists. (

CMDB_ERROR_INSTANCE_ID_ALREADY_EXISTS )
Description The instance ID that you specified already exists.
Solution Specify a unique instance ID for the instance or select an import option other than 1.
120138
Error
Invalid import data option. (CMDB_ERROR_INVALID_DATA_IMPORT_OPTION)

Description The import option value that you specified is incorrect.
Solution Select the correct import option.
120139
Error
The CoreDatasetId specified already exists. (CMDB_ERROR_DUPLICATE_DATASET_ID)

Description The CoreDatasetId that you specified already exists.
Solution Specify a different CoreDatasetId.
120140
Error
Attribute does not belong to the class specified. (

CMDB_ERROR_ATTRIBUTE_BELONGS_TO_SUPERCLASS)
Description The attribute that you specified is inherited from a superclass and cannot be deleted from
this subclass.
Solution Delete the specified attribute from the superclass.
120141
Error
Can't set MarkAsDeleted to "No" on the relationship instance because one or

both of the relationship endpoints are MarkAsDeleted. (
CMDB_ERROR_REL_ENDPOINT_MARK_AS_DELETED)
Description You are attempting to set MarkAsDeleted to No for a relationship instance for which one or
BMC Atrium Core 9.0
Page 2058 of 2268
Home
Error
Message
number
type
both endpoints are soft deleted (MarkAsDeleted).

Solution Set MarkAsDeleted to No on both endpoints of the relationship before setting
MarkAsDeleted to No on the relationship instance.
120142
Error
Audit type Copy is not set for this class. (CMDB_ERROR_NO_AUDIT_COPY_CLASS )

Description You are attempting to retrieve Copy audit data from a class whose audit type is set to a
value other than Copy.
Solution You cannot retrieve Copy audit data from a class whose audit type is set to a value other than
Copy.
120143
Error
Modifying the attributes of a relationship endpoint is not allowed. (

CMDB_ERROR_MODIFYING_REL_ENDPOINT_VAL_DISALLOWED)
Description You are attempting to modify attributes such as, Source.ClassId, Source.InstanceId,
Destination.ClassId, and Destination.InstanceId of a relationship instance.
Solution You cannot modify the attributes of a relationship instance.
120144
Warning
Delete class is failed because it has audit data. (

CMDB_WARN_DELETE_CLASS_FAILED_AUDIT_DATA)
Description You are attempting to delete a class (without dependencies) and the class or its subclasses
has auditing turned on.
120145
Error
Class ID and qualification information exceeded the limit of 4,096 bytes. (

CMDB_ERROR_RE_START_JOB_RUN_INFO_EXCEED_LIMIT)
Description After encoding, the combined length of your specified classQualList and datasetList
parameters exceeds the 4,096-byte limit on qualifications passed to the CMDBStartJobRun function.
Solution Divide the classQualList information into more than one API call.
120146
Error
Instance ID is not unique. (CMDB_ERROR_DUPLICATE_INSTANCE_ID)

Description The instance ID that you specified for the new instance already exists.
Solution Specify a unique instance ID for the instance.
120147
Error
Bad decimal value was supplied. (CMDB_ERROR_ATTRIBUTE_BAD_DECIMAL_VALUE)

Description The value that you specified for the decimal attribute is invalid.
Solution Make sure that you specify a value in correct format for the decimal attribute.
120148
Error
Cannot modify the InstanceId attribute value. Once an instance is created, the
InstanceId value cannot be modified. (
CMDB_ERROR_MODIFYING_INSTANCE_ID_VAL_DISALLOWED)
Description You are attempting to modify the instance ID of an existing instance.
Solution You cannot change the instance ID of the instance. Verify your attribute value list when you
modify the instance.
120149
Error
Out of memory error. Cannot allocate additional memory. (

CMDB_ERROR_OUT_OF_MEMORY)
Description An internal error occurred when performing an operation.
120150
Error
A zero byte memory allocation was performed. Report this error message to your
administrator. (CMDB_ERROR_ZERO_BTYE_MEMORY_ALLOCATION)
Description An internal error occurred when performing an operation.
120151
Error
BMC Atrium Core 9.0
Page 2059 of 2268
Home
Error
number
Message
type
The list of class or attribute definitions to export is empty. (

CMDB_ERROR_STRUCT_EXPORT_ITEM_EMPTY)
Description You did not specify the list of class or attribute definitions to export in the CMDBExportDef
function.
Solution Specify the list of class or attribute definitions to export in the exportItemList parameter of
the CMDBExportDef function.
120152
Error
Nested subquery cannot contain recursive query. (

CMDB_ERROR_QUERY_INVALID_OBJECT_SEQUENCE)
Description The sequencing of the query objects is invalid.
Solution Alternate the ordering of query objects between CI (C) and Relationship (R) types (for example
C-R-C-R-C).
120153
Error
The qualification operator provided in the query is invalid. (

CMDB_ERROR_INVALID_QUERY_QUAL_OP)
Description The qualification operator that you provided in the query is invalid.
Solution Specify one of the following values for the qualification operator:
1--(CMDB_QUERY_QUAL_OP_NONE)
2--(CMDB_QUERY_QUAL_OP_AND)
3--(CMDB_QUERY_QUAL_OP_OR)
4--(CMDB_QUERY_QUAL_OP_NOT)
5--(CMDB_QUERY_QUAL_OP_SIMPLE)
6--(CMDB_QUERY_QUAL_OP_SET)
120154
Error
The alias supplied in the selector list is invalid. Make sure the alias in the
selector list matches with the alias specified in the query list. (
CMDB_ERROR_INVALID_ALIAS_IN_SELECTOR_LIST )
Description The alias that you specified for the class does not exist.
Solution Make sure the alias that you specified in the selector list matches the alias specified in the query
list.
120156
Error
There is a mismatch between aliases in the selector list and the query list. (
CMDB_ERROR_ALIAS_MISMATCH)
Description You are attempting to specify two different sets of objects in the selector list and query list.
Solution Make sure that the objects that you specify in the selector list is a subset of the objects in the
query list.
120157
Error
The selector list provided for the value set operation is invalid. (
CMDB_ERROR_INVALID_VALUESET_QUERY_SELECTOR )
Description You are attempting to specify either no attributes or multiple attributes in the selector list of
the value set operation.
Solution Specify only one attribute in the selector list of the value set operation.
120159
Error
You cannot query data using class. BMC.FED:BMC_FederatedBaseRelationship or

BMC.FED: BMC_FederatedBaseElement. (CMDB_ERROR_QUERY_DISALLOWED_FOR_CLASS)
Description You are attempting to create a query for the federated abstract classes listed in the error
message. Because abstract classes do not have any attributes, you cannot construct a query that uses
them. This error might occur if:
The start node of your query is the BMC_FederatedBaseElement class.
The BMC_FederatedBaseRelationship class is specified in the relationship list.
Solution Do not include the given abstract classes in your query.
BMC Atrium Core 9.0
Page 2060 of 2268
Home
Error
number
Message
type
120160
Warning
The abstract class specified will not contain a view because it has no
subclasses. (CMDB_WARN_ABSTRACTVIEW_NO_SUBCLASS_FOR_VIEW)
Description To create a database view for an abstract class, first derive a subclass from the given
abstract class. Creating a view from an abstract class is not allowed.
120167
Error
Query processor has encountered an internal error.(CMDB_ERROR_QUERY_INTERNAL)

Description An internal error occurred with the query processor.
120168
Error
An invalid value set type has been specified in the query qualification. (
CMDB_ERROR_INVALID_QUERY_VALUESET_TYPE)
Description You specified an invalid value set type in the query qualification.
Solution Make sure that the value set type that you specified in the query is either
1- (CMDB_QUERY_QUAL_VALUESET_TYPE_VALUESET) or 2- (
CMDB_QUERY_QUAL_VALUESET_TYPE_QUERY).
120169
Error
An invalid simple query operation has been specified in the query

qualification. (CMDB_ERROR_INVALID_QUERY_SIMPLEOP)
Description You specified an invalid simple query operation type in the query qualification.
Solution Make sure that the simple query operation type that you specified in the query qualification is
one of the following values:
1--(CMDB_QUERY_QUAL_SIMPLEOP_EQUAL)
2--(CMDB_QUERY_QUAL_SIMPLEOP_GREATER)
3--(CMDB_QUERY_QUAL_SIMPLEOP_GREATER_EQUAL)
4--(CMDB_QUERY_QUAL_SIMPLEOP_LESS)
5--(CMDB_QUERY_QUAL_SIMPLEOP_LESS_EQUAL)
6--(CMDB_QUERY_QUAL_SIMPLEOP_NOT_EQUAL)
7--(CMDB_QUERY_QUAL_SIMPLEOP_LIKE)
120173
Error
String Operation on a null pointer was attempted. (

CMDB_ERROR_NULL_STRING_POINTER_OPERATION)
Description An internal error occurred when performing a string function.
120174
Error
Federation class attribute cannot have default values. (

CMDB_ERROR_FEDERATED_ATTRIBUTE_DEFAULT_NOT_ALLOWED)
Description An attribute of the federated class contains a NULL value.
Solution Make sure that the federated class attribute contains a value other than NULL.
120175
Error
The federation relationship has no join condition qualification. (

CMDB_ERROR_MISSING_RELATIONSHIP_LINK_QUALIFICATION)
Description You are attempting to create a federated relationship for a class with no qualification (for
example, 'InstanceId' = $RequestId$ ).
Solution The federated relationship specified in the query does not appear to have any join condition.
Specify a value for the CMDB_CLASS_CHARAC_RELATION_LINK_QUALIFIER characteristic for the
federated relationship class.
120176
Error
You are not allowed to create attributes on this federation class. (

CMDB_ERROR_FEDERATED_ATTRIBUTE_CREATE_NOT_ALLOWED)
Description You are attempting to create attributes for a Federated Relationship class or an abstract
Federated Data class.
Solution Create attributes for only nonabstract federated data classes.
120177
Error
BMC Atrium Core 9.0
Page 2061 of 2268
Home
Error
number
Message
type
You are not allowed to create a federation subclass. (

CMDB_ERROR_FEDERATED_SUBCLASSING_NON_ALLOWED)
Description You are attempting to create a federated subclass.
Solution Federated classes and subclasses are created based on the external data that you want to
federate with BMC Atrium CMDB. You cannot create a subclass of a federated class.
120179
Error
Federation class cannot have indices. (CMDB_ERROR_FEDERATED_INDEX_NOT_ALLOWED)

Description You are attempting to create indices on a federated class.
Solution Federated classes cannot have indices. Create an index in your external data store.
120180
Error
Audit is not allowed on federation classes. (

CMDB_ERROR_FEDERATED_AUDIT_NOT_ALLOWED)
Description You are attempting to set the Audit option for a federated class.
Solution Auditing is not supported on federated classes.
120181
Error
The federation characteristic specified is invalid. (

CMDB_ERROR_FEDERATED_INVALID_CHARACTERISTIC)
Description You are attempting to specify an invalid class characteristic for a federated class.
Solution Specify only those characteristic that are defined for federation. For more information about
these characteristics, see the BMC Atrium Core Developer's Reference Guide
120182
Error
Federation relationship class cannot be weak. (

CMDB_ERROR_FEDERATED_WEAK_RELATION_NOT_ALLOWED)
Description You are attempting to propagate a federated relationship as a weak relationship.
Solution You cannot propagate a federated relationship as a weak relationship.
120183
Error
There are more than one federated data interfaces for the given federated data
class. (CMDB_ERROR_FEDERATED_MORE_THAN_ONE_INTERFACE_MATCH)Description You are
attempting to create multiple federated data interfaces for the given federated data class. Solution Make
sure that only one federated data interface exists for each federated data class.
120184
Error
The given federated interface is not a launch type interface. (

CMDB_ERROR_FEDERATED_NOT_LAUNCHABLE_FEDERATION)
Description You are attempting to launch a federated interface that is not of the Launch type.
Solution Specify the correct federated interface for the launch.
120185
Error
This operation is not allowed on federation class. (

CMDB_ERROR_FEDERATED_OPERATION_NOT_ALLOWED)
Description You are attempting to perform an operation that is not supported for a federated class. This
error occurs if you attempt to call:
The CMDBGetInstance, CMDBGetlistInstance, CMDBGetInstanceBLOB, or
CMDBGetmultipleInstances function on federated relationship classes.
The CMDBExportData, CMDBImportData, CMDBCreateInstance, CMDBDeleteInstance,
CMDBSetInstance, or CMDBGraphQuery function on federated data and federated relationship
classes.
Solution Do not perform the listed operations.
120186
Error
No such external data source exists. (CMDB_ERROR_FEDERATED_NO_SUCH_VENDOR)

Description The vendor plug-in that you specified for the federated class does not exist.
Solution Make sure that such a vendor exists.
120187
Error
BMC Atrium Core 9.0
Page 2062 of 2268
Home
Error
Message
number
type
No such table exists in the given external data source. (

CMDB_ERROR_FEDERATED_NO_SUCH_VENDOR_TABLE)
Description The vendor table that you specified for the federated class does not exist.
Solution Make sure that such a vendor table exists.
120188
Error
No such field exists in the given table of the external data source. (
CMDB_ERROR_FEDERATED_NO_SUCH_VENDOR_FIELD)
Description The vendor field that you specified for the federated class does not exist.
Solution Make sure that such a vendor field exists.
120189
Error
Data type of the attribute does not match the data type of the field in the
external data source. (CMDB_ERROR_FEDERATED_ATTRIBUTE_DATATYPE_MISMATCH)
Description The data type of the vendor field does not match the federated attribute to which the
federated data is to be imported.
Solution Match the vendor field data type and make sure that it matched the data type of the federated
attribute.
120190
Error
The limit for the attribute does not fall within the range defined for the
corresponding field in the external data source. (
CMDB_ERROR_FEDERATED_EXCEEDS_EXTERNAL_LIMIT)
Description The limit of a federated class attribute that you are creating exceeds the field limit of the
external field to which it is mapped. For example, if the limit of the external field is a maximum size of 5
characters, you cannot set the attribute limit to 10 characters.
Solution Specify the attribute limit of the federated class greater than that of the external field.
120191
Error
BMC Remedy AR System plugin server for BMC Atrium CMDB federation is not
running. (CMDB_ERROR_FEDERATED_PLUGIN_SERVER_NOT_RUNNING)
Description The plug-in server for the federation is not running.
Solution Restart the plug-in server before you perform any federation operation.
120192
Error
Federated relationship class cannot be the first or last query object.(

CMDB_ERROR_FEDERATED_INVALID_QUERY_OBJECT_INDEX)
Description You are attempting to create a query for the federated data class with the federated
relationship class as the first or the last object in the query.
Solution Make sure that your query follows the C->R->C construct, where C indicates class and R
indicates federated relationship.
120193
Error
You must provide a source or destination when querying a federated

relationship. (CMDB_ERROR_FEDERATED_FEDREL_MISSING_SOURCE_DEST)
Description This error occurs when you specify a federated relationship as one of the query objects for
the CMDBQueryByPath function, with no query objects before or after the federated relationship query
object. The source dataset from which to import the data is not specified.
Solution Specify query objects before and after the federated relationship object in your
CMDBQueryByPath function.
120194
Error
Federation Access Method must be of type 'Class'. (

CMDB_ERROR_FEDERATED_ACCESS_METHOD_MUST_BE_CLASS)
Description You are attempting to create an instance of the BMC.CORE.CONFIG:
BMC_FederatedDataInterface class for which the FederationAccessMethod attribute is set to a
value other than Class.
Solution Set the FederationAccessMethod attribute to Class.
120195
Error
BMC Atrium Core 9.0
Page 2063 of 2268
Home
Error
number
Message
type
Federation Action Type must be of type 'Data'. (

CMDB_ERROR_FEDERATED_ACTION_TYPE_MUST_BE_DATA)
Description You are attempting to create an instance of BMC.CORE.CONFIG:
BMC_FederatedDataInterface class for which the FederationActionType attribute is set to a
value other than Data.
Solution Set the FederationActionType attribute to Data.
120196
Error
You must provide a qualification to search this federated class. (

CMDB_ERROR_FEDERATED_QUERY_NO_RESTRICTIVE_QUAL)
Description You are attempting to create a query for a federated data class that requires a qualification.
Solution If you set the CMDB_CLASS_CHARAC_REQUIRES_QUALIFIER_FOR_QUERY characteristic as 1,
specify a qualification for the federated data class.
120197
Error
Federated classes are not supported for this action. (

CMDB_ERROR_FEDERATION_CLASSES_NOT_SUPPORTED)
Description The action that you are performing is not supported for a federated data class.
Solution Verify the action that you are performing.
120200
Error
Super class and subclass class types are not the same. (
CMDB_ERROR_QUERY_QUALIFIER_NOT_ALLOWED)
Description You specified qualification against a federated relationship class query object when querying
by using the CMDBQueryByPath function. This operation is not allowed.
Solution Do not include a qualification for the federated relationship class query object.
120202
Error
The structure CMDBGraphWalkState is invalid. (

CMDB_ERROR_GW_INVALID_GRAPH_STATE_STRUCTURE)
Description You are either attempting to modify the CMDBGraphWalkState structure, or you did not call
the CMDBGraphWalkBegin function before calling the CMDBGraphWalkNext function.
Solution Do not modify the CMDBGraphWalkState structure. Also, call the CMDBGraphWalkBegin
function before calling the CMDBGraphWalkNext function.
120203
Warning
No more chunks available. (CMDB_WARN_GW_NO_MORE_CHUNK)

Description The query has completed the search. No more CIs or relationships exist that match the
query that you executed.
120204
Error
The relation passed in CMDBGraphWalkRelationList is not of type Relationship

or Federated relationship. (CMDB_ERROR_GW_CLASS_NOT_RELATIONSHIP_TYPE)
Description You are attempting to specify a CI class in the CMDBGraphWalkRelationList structure
for the graph walk.
Solution Make sure that the class that you specify is of the relationship or federated relationship type.
120205
Warning
This class will be ignored from the CMDBGraphWalkSelectOrAndFilterList array

because this is of relationship type. (CMDB_WARN_GW_CLASS_IGNORED_FROM_LIST)
Description You are attempting to assign the CMDBGraphWalkSelectOrAndFilterList array with a
BMC_Dependency class. This operation is not allowed
120206
Warning
The query matched more than the maximum number of results specified by the
CMDB server. (CMDB_WARN_MAXIMUM_QUERY_RESULST_LIMIT)
Description The number of rows matched by your query exceeds the number specified for the
CMDB-Max-Results-Per-Query parameter in the ar.cfg configuration file.
Solution Either specify additional qualifications for the query to return fewer rows or increase the number
specified for the CMDB-Max-Results-Per-Query parameter.
120207
Error
BMC Atrium Core 9.0
The operation or tag used in the federated relationship qualification is not

supported for walking the graph. (
CMDB_ERROR_GW_OP_OR_TAG_NOT_SUPPORTED_FED_RELSHIP)
Page 2064 of 2268
Home
Error
number
Message
type
Description The qualification you defined for the federated relationship class contains operations that the
graph walk function cannot perform.
Solution Update the federated relationship class definition to exclude the following illegal operations and
tags: Illegal operation:AR_COND_OP_FROM_FIELD (External) Illegal tags:AR_STAT_HISTORY (Status
History field)AR_VALUE_SET (In clause)
120208
Error
The qualification used for the query API has too many levels of nesting
involved. (CMDB_ERROR_EXCEED_MAXIMUM_QUAL_NESTING_LEVEL)
Description The query qualification you defined contains too many AND/OR operators. By default, a
maximum of 500 AND/OR operators are allowed in the qualification.
Solution Perform the following steps:
Change the complex qualification to use fewer AND/OR operators.
Try using an IN operation in the qualification.
Set the environment variable MAXIMUMQUALLEVEL to a value higher than 500 to increase the
maximum qualification level. The default level is set to 505.
If you modified the stack memory allocated for the binaries to a higher value, you can increase the
memory allocation for the cmdbapi, cmdbengine libraries. By default, the cmdbapi,
cmdbengine libraries are built with 1 MB stack memory.
120209
Error
Configuration label is missing. (CMDB_ERROR_CONFIGURATION_LABEL_NOT_FILLED)

Description You failed to provide a configuration label for the instance of the BMC.CORE.CONFIG:
BMC_UIComponent (CMDB Server configuration instance) class that you are attempting to update or
create. (Attribute Name: ComponentName, field ID: 530017300)
Solution Make sure that you specify a value for the ComponentName attribute of the CMDB Server
configuration instance.
120213
Error
Graph format is not supported by the server.

Description You used the BMC Atrium CMDB client to request a Query By Path with the result format of
Graph to a server that does not support the graph output.
Solution Request the output in the list format instead, or connect to a server that supports graph output.

for each Reconciliation Engine error.
Error
number
Message
type
101000
Error
Cannot create a new thread of execution.

Description An error in the operating system might have occurred.
101008
Error
The job is already running.

Description You are attempting to start a job that is already running.
Solution Wait until the current job run is completed and then restart the job.
101010
Error
Cannot find job definition with this name.

Description The job definition name that you specified does not exist.
Solution To resolve this issue:
BMC Atrium Core 9.0
Page 2065 of 2268

1.
Home
Error
number
Message
type
1. Make sure that the job definition name is correct.

2. Stop the Reconciliation Engine (arrecond.exe ) process and start it again.
3. If you still encounter this error after performing the previous steps, enable BMC Remedy AR System
API logging to verify any AR System issues.
Note: If you do not see any problems in the API log, you might need to restart the AR System server.
101011
Error
Cannot find job definition with this ID.

Description The job definition ID that you specified does not exist.
1. Make sure that the job definition ID is correct.
3. If you still encounter this error after performing the previous steps, enable AR System API logging to
verify any AR System issues.
101012
Error
The job is not active.

Description The job that you are attempting to run is not available.
Solution Modify the Change Pending job status to Active before you run it again.
101013
Error
Activity run failed because in the object store cache class does not exist.
Description The activity that you attempted to run failed because the cache data for the Reconciliation
Engine job definition does not exist.
1. Make sure that the job definition is correct.
101014
Error
Error in loading datasets.

Description An error occurred with the Reconciliation Engine cache data for job definitions or with BMC
Atrium Core class metadata.
101015
Error
Error in creating dataset entry.

BMC Atrium Core 9.0
Page 2066 of 2268

3.
Home
Error
Message
number
type
101016
Error
Rename failed, dataset name <{1}> already exists.

Description You are attempting to rename a dataset with a name that already exists for a different dataset.
Solution Specify a unique name for the dataset.
101017
Error
Rename failed, dataset <{1}> does not exist.

Description The dataset that you are attempting to rename does not exist.
101018
Error
Error in loading job definitions.

101019
Error
Loading of configuration definition failed as there is no previous steps.

101020
Error
Error in loading activity definitions.

BMC Atrium Core 9.0
Page 2067 of 2268

3.
Home
Error
number
Message
type
101021
Error
Error in loading job schedules.

101022
Error
Error in loading activity qualifications

101023
Error
Error in loading group definitions.

101024
Error
Error in loading attribute precedences

BMC Atrium Core 9.0
Page 2068 of 2268
Home
Error
number
Message
type
101025
Error
Error in loading activity to group associations

101026
Error
Error in loading identification rules.

101027
Error
Error in loading comparison rules.

101028
Error
Activity run failed because there are no datasets.

101029
Error
Activity run failed because there is no object store class cache.

BMC Atrium Core 9.0
Page 2069 of 2268

1.
Home
Error
number
Message
type

101032
Error
Error in loading unique datasets from the association Table.

Description You specified incorrect job definitions for the Reconciliation Engine job.
Solution Correct the identification rule in the job definition.
101033
Error
Class id of one endpoint is NULL for relationship class.

Description The class ID attribute for one of the endpoints in the relationship class contains a NULL value.
Solution This error occurs because of incorrect data. Specify a value for the class ID attribute.
101034
Error
Reconciliation identity of one endpoint is NULL for relationship class.

Description The reconciliation ID attribute for one of the endpoints in the relationship class contains a
NULL value.
Solution This error occurs because of incorrect data. Specify a value for the class ID attribute.
101036
Error
Activity run because dataset id not found for target dataset name.
101037
Error
Attribute name <{1}> not found in class <{2}> of namespace <{3}>.

101038
Error
Attribute id <{1}> not found in class <{2}> of namespace <{3}>.

BMC Atrium Core 9.0
Page 2070 of 2268

3.
Home
Error
Message
number
type
101039
Error
Attribute of AR field id <{1}> not found in class <{2}> of namespace <{3}>.

101040
Error
Class name <{1}> of namespace <{2}> does not exist.

Description Within the specified dataset, the class name does not exist.
101041
Error
Class id <{1}> of namespace <{2}> does not exist.

Description Within the specified dataset, the class ID does not exist.
101042
Error
Relationship <{1}> of namespace <{2}> has no lead class.

Description Within the specified dataset, the relationship does not exist.
101043
Error
BMC Atrium Core 9.0
Page 2071 of 2268
Home
Error
number
Message
type
Error in opening log file.

Description The Reconciliation Engine cannot access the log file.
Solution Verify that you have sufficient disk space on your system and that you have the appropriate
permissions to write to the file system.
101044
Error
In merge activity <{1}>, dataset merge precedence set value is empty.Error in

opening log file.
101045
Error
Dataset merge precedence set <{1}> has no entry.

101046
Error
In merge activity <{1}>, there is no source dataset specified.Description An error

occurred with the Reconciliation Engine cache data for job definitions or with BMC Atrium Core class
metadata.Solution Perform the following steps to resolve this issue:
101047
Error
Error in loading dataset merge precedence sets.

Solution Perform the following steps to resolve this issue:
BMC Atrium Core 9.0
Page 2072 of 2268
Home
Error
number
Message
type
101048
Error
Memory allocation failed.

Description The AR System server failed to allocate the memory that you are attempting to allocate.
Solution Perform the following steps to resolve this issue:
1. Make sure that the AR System server has allocated enough system resources to support both AR
System and Reconciliation Engine operations.
2. From BMC Remedy Developer Studio, reduce the number of concurrent Reconciliation Engine
threads.
3. Increase the virtual memory.
No
Error
error
number
Found multiple matches in the dataset: Cannot identify the instance of class <
className>with instance ID <instanceId>.

Description More than one instance of the specified class was found in the dataset.
Solution See Troubleshooting multiple CI matches in BMC.Asset.
ARERR
120092
Error
ARERR [120092] The dataset ID and Reconciliation Identity combination is not

unique.
Description You are attempting to merge a CI that has more than one instance with the same dataset ID
and Reconciliation ID combination.
Solution See Resolving multiple CI matches in the source dataset.
No
error
number
Error
No
error
number
Error
No
error
number
Error
No
error
number
Error
Cannot find the endpoint of relationship::<className>:Merging of record failed.

Description You are attempting to merge an orphan instance.
Solution See Missing endpoints during the Merge activity.
Algorithm: Including child CIs and committing together.
Description The option that you specified in the Include child CIs? menu is complicated.
Solution See CIs merge more than once during a Merge activity .
The Reconciliation Engine log only shows two unique TIDs (Thread IDs).
Description The number of activities that you are attempting to run require more than the total number of
threads that you allocated.
Solution See Resolving Reconciliation Engine performance issues due to insufficient thread settings .
The Reconciliation Engine demonstrates performance issues due to incorrect
database settings.
Description You encounter Reconciliation Engine performance issues, such as the job takes a long time to
complete or the Reconciliation Engine freezes.
Solution See Resolving Reconciliation Engine performance issues due to incorrect database settings .
BMC Atrium Core Console filter error messages

for each error that is generated by the filters.
CMDB Console filter error messages
Error
number
Message
type
20163
Error
No entry found in SHARE:AssociationType with associationTypeId = $500000041$.(

OBJSTR:Lookup Association Name5)
Description The association type that you specified is not found.
Solution Make sure that the association type exists.
BMC Atrium Core 9.0
Page 2073 of 2268
Home
Error
number
Message
type
20279
Error
The relationship $490005100$ between $490021100$ and $490021101$ is defined as

1 to 1, and there is already an association of type $490005100$ between this
$490021101$ and another $490021100$, or between this $490021100$ and another
$490021101$.(BSM:AUD_AssocEnforce1-1Relationship 2)
Description You are attempting to create a relationship for an instance that is already related to another
instance.
Solution Make sure that the instance name is correct. To create more than one relationship for the
specified instance, specify a many-to-one or one-to-many cardinality for it.
20280
Error
The relationship
"1 to Many", and
this $490021101$
ManyRelationship
$490005100$ between $490021100$ and $490021101$ is defined as

there is already an association of type $490005100$ between
and another $490021100$.(BSM:AUD_AssocEnforce12)
instance.
20281
Error
The relationship $490005100$ between $490021100$ and $490021101$ is defined as

"Many to 1," and there is already an association of type $490005100$ between
this $490021100$ and another $490021101$.(BSM:AUD_AssocEnforceMany1Relationship 2)
instance.
20366
Error
No entry found in SHARE:MenuItem_LT with Developer Name = $300132000$.(OBJSTR:

Lookup Localized String5)
Description The localized string for the menu item is not found.
20369
Error
No entry found in SHARE:Object with Form Name = $-5$.(OBJSTR:Lookup Form Name5)

Description The form name that you specified is not found.
50030
Error
Invalid instance related operation on this abstract class.(OBJSTR:

Instance_CheckAbstractClassNoInstantiate)
Description You cannot derive an instance from an abstract class.
Solution Make sure that the superclass name that you specified for the instance is correct.
50038
Error
Class $400124700$ is a Singleton class and can only have one instance.(OBJSTR:
Instance_CheckSingleton02)
Description You cannot derive more than one instance from a singleton class.
Solution Make sure that the class name that you specified for the singleton class is correct.
50040
Error
The role <number> instance does not exist. The Class ID and Instance ID
combination was not found. Class ID: $490008100$, Instance ID: $490008000$.(
OBJSTR:Instance_CheckRelationshipEndpoint <endpointNumber>)
Description The instance ID specified in the role number for the specified class is not found.
Solution Make sure that the Instance ID for the specified Class ID exists.
50044
Error
BMC Atrium Core 9.0
Page 2074 of 2268
Home
Error
Message
number
type
Weak relationship instance cannot be created. Weak instance is already

associated to another lead instance.(OBJSTR:Instance_RelWeakRef: <className>: <
stepNumber>)
Description You cannot specify the instance as a weak instance more than once. This instance is already
a part of another weak relationship.
Solution Make sure that the instance name that you specified for the weak instance is correct.
50046
Error
Modifications to the lead class references values are not allowed.(OBJSTR:

Instance_RelWeakRef:BMC: <className>: <stepNumber>)
Description You are attempting to modify the reference values of the lead class in a weak relationship.
Solution Do not modify the reference values for the lead class.
50063
Error
Instances cannot be deleted from this form.(OBJSTR:Instance_CheckDeleteOp)

Description You cannot delete an instance from the instance base form.
Solution Make sure that you are using the join form to delete the instance.
125016
Error
Duplicate subclasses ID $400004800$ for attribute $400009700$.(OBJSTR:

AttributeDef_CheckForDupsubclassesID_Msg)
Description The field ID that you specified for the attribute is already in use in the class.
Solution Specify a different field ID.
125016
Error
Duplicate subclasses Name for attribute $400009700$.(OBJSTR:

AttributeDef_CheckForDupsubclassesName_Msg)
Description The field name that you specified for the attribute is already in use in the class.
Solution Specify a different field name.
125017
Error
Data Type and Attribute Name must be specified.(OBJSTR:

AttributeDef_CheckRequiredsubclasses)
Description Data type and attribute name are required fields for the subclass.
Solution Specify values for these required fields.
125018
Error
Invalid subclasses ID for attribute $400009700$. Subclasses IDs below 100 are
reserved for Core subclasses.(OBJSTR:AttributeDef_CheckReservedsubclassesID)
Description The ID that you specified for the subclass is a reserved value.
Solution Make sure that the ID that you specify is not a system-reserved value. For more information about
reserved values, see the cmdb.h header file.
125019
Error
Invalid Default Value for selection subclasses.(OBJSTR:

AttributeDef_CheckSelectionDefaltValue)
Description The default value that you specified for the subclass is invalid.
Solution Specify a default value from the list of approved values.
125020
Error
There is already an existing class with class name $490001100$ in the namespace
$400109900$. Please specify a different class name.(OBJSTR:
Class_ChkDuplicateClass02)
Description The class name and namespace combination that you specified for the class is not unique.
Solution Make sure that the class name is unique within the specified namespace.
125021
Error
This is an invalid combination of the Abstract and Final subclasses.(OBJSTR:

Class-ChkAbstractFinal)
Description You are attempting to derive a subclass as an abstract and final class.
Solution Make sure that you specify only one class type for the subclass.
125025
Error
BMC Atrium Core 9.0
Page 2075 of 2268
Home
Error
number
Message
type
The relationship between $400126800$ and $400126900$ is defined as 1 to 1, and

there is already a relationship instance between $400126800$ and $400126900$.(
OBJSTR:Instance_Enforce1-1Relationship02)
Description The relationship cardinality for the specified instances is violated.
Solution Do not specify more than one relationship between the two instances.
125026
Error
The relationship between $400126800$ and $400126900$ is defined as "1 to Many,"

and there is already a relationship instance between $400126800$ and $400126900
$.(OBJSTR:Instance_Enforce1-ManyRelationship02)
125027
Error
The relationship between $400126800$ and $400126900$ is defined as "Many to 1,"

and there is already a relationship instance between $400126900$ and $400126800
$.(OBJSTR:Instance_EnforceMany-1Relationship02)
125033
Error
Spaces are not allowed in the Attribute Name Field.(OBJSTR:

AttributeDef_CheckSpaceInName02)
Description You are attempting to create an attribute name that has a blank character.
Solution Create attribute name fields with no space or wildcard characters.
125034
Error
Spaces are not allowed in the Class Name Field.(OBJSTR:Class_CheckSpaceInName02

)
Description You are attempting to create a class name that has a blank character.
Solution Create class name fields with no space or wildcard characters.
125035
Error
Spaces are not allowed in the Superclass Field.(OBJSTR:

Class_CheckSpaceInSuperClass02)
Description You are attempting to create a superclass field that has a blank character.
Solution Create superclass fields with no space or wildcard characters.

for BMC Atrium Service Context errors.
Error
number
Message
type
191100
Error
You do not have permission to access the instance. AR returned error <0>
Description
This error occurs when you try to open the Service Context Summary window for a Configuration Item (CI)
for which you do not have permissions.
For example, you have permissions to a business service CI, but you do not have permissions to its related
computer system CI. You can launch the Service Context Summary window from the business service CI,
BMC Atrium Core 9.0
Page 2076 of 2268
Home
Error
number
Message
type
but the error message appears when you try to show details for the related computer system CI.
Solution
Verify that you have view permissions to the CIs that you are trying to view in BMC Atrium Service Context.
191101
Error
Cannot connect to UDDI web services registry using BMC Remedy AR System server
configuration data. Contact your BMC Remedy AR System administrator.
Description
This error occurs when BMC Atrium Service Context cannot connect to the web services registry.
Solution
From the AR System Administration Console, choose System > General > Server Information. Verify the
configuration settings in the WS Registry Integration tab.
191102
Error
UDDI web services registry information not found in BMC Remedy AR System server
configuration. Contact your BMC Remedy AR System administrator.
Description
This error occurs when there is no configuration information for the web services registry.
Solution
Register the web service for your BMC application. For more information, see Registering the
ServiceContext web service for BMC applications.
191103
Error
Service Context plug-in is still initializing. Try after some time.

Description
This error occurs when you try to open the Service Context Summary window or the Service Context
Administration window when BMC Atrium Service Context is starting.
Solution
Wait a few seconds, then try to open the window again.
191104
Error
Fault exception: <0>

Description
This error occurs when the provider (the BMC product) returns an error to BMC Atrium Service Context.
Solution
Review the error message that is displayed, and refer to the documentation for the BMC product for more
information.
191105
Error
Invalid recon id <0> is passed. Reconcile your data.

Description
This error occurs when you try to open the Service Context Summary window for a CI that has not been
reconciled and therefore has no reconciliation ID.
Solution
Verify that you have selected a CI that is in the production dataset.
125055
Workflow
error
The maximum number of results has been exceeded. Only the first 1000 results
will be displayed.
Description
BMC Atrium Core 9.0
Page 2077 of 2268
Home
Error
number
Message
type
This error occurs when the number of results returned to BMC Atrium Service Context exceeds 1000.
Solution
Change BMC Atrium Service Context configuration settings so that fewer results are returned. For example,
change the time limit for certain attributes to show less history, or configure
max_search_related_levels to return fewer levels.
For more information, see Configuring attributes in the Service Context Administration window and
Configuring BMC Atrium Service Context cache and data retrieval settings .
125056
Workflow
125057
125058
errors
Error retrieving data. $<field_ID>$

Description
There was an error when BMC Atrium Service Context was retrieving data.
125059
125060
125061
Solution
Follow the instructions contained in $<field_ID>$.
191108
Error
Cannot connect to the configured web service.

Solution
Ensure that the web service URL is accessible from BMC Atrium CMDB. To trouble shoot, verify if the web
server is running and check the network connectivity.
191109
Error
Incorrect web service URL is configured. Configure the correct web service URL.
Solution
For information about configuring web service, see Testing connectivity with Service Context providers
Testing connectivity with Service Context providers
(8.1.00) Registering the Service Context web service for BMC applications

for each Atrium Impact Simulator error.
Error
number
Message
type
Error
No error
Description Zero indicates No error returned in the code, and users rarely see this error. You only see it
if there is a mistake in the logging.
Solution You can safely ignore this error.
191000
Error
Loop detected in model.

Description Atrium Impact Simulator returns an error message if the AIS cell finds a loop in the model,
which is unsupported.
Solution Remove the loop in your model; loops in your model can cause an unpredictable result. Review
BMC Atrium Core 9.0
Page 2078 of 2268
Home
Error
Message
number
type
the ais.log to find the actual CIs that create the error.
Note: You can turn off this error message if you want to allow loops, however, BMC recommends that you
remove the loop in your model.
191001
Error
Unable to connect to the AIS cell. Please contact administrator.

Description You typically see this error when the Atrium Impact Simulator plug-in is unable to connect to
the AIS cell, due to a configuration problem.
Solution
Make sure that the AIS service (Microsoft Windows) or the AIS daemon (UNIX and Linux) is running.
This service or daemon is labelled as the mcell process.
Make sure that the AIS:GlobalPreferences form is correctly configured. Frequently you find the
wrong IP address or host name. Sometimes you see the load-balancer host name or the cell host
name instead of the actual server host name or IP address. Correct these mistakes.
Review both the ais_cell.log or ais.log files to see if there is a bind error, that the AIS port is being
used by another process.
Review the mcell.dir file to make sure that each line that starts with cell includes a port number
that matches the entry in AIS:GlobalPreferences. If it doesn't match, change the entry in the form.
Correct the mcell.dir file to resolve short domain names and FQDN.
Test the availability of the cell after you make any changes. Otherwise, contact your system
administrator to troubleshoot the connectivity or network problems.
Note: This error does not apply to BMC Atrium Core 8.0.00 or later.
191002
Error
AIS plug-in encountered an authentication error when trying to connect to the

AR server.
Description You typically see this error if the password has been recently changed and the BMC Remedy
AR System server has not yet been restarted. The old password is still in use.
Solution
1. Review the logon credentials in the pluginsvr_config.xml and ar.cfg files, and make sure that they
match. The logon credentials specified in the pluginsvr_config.xml file override those in the ar.cfg
file.
191003
Error
No results were received from the AIS cell.

Description You typically see this error if the AIS cell was incorrectly configured.
Solution
1. Make sure the the AIS cell is running.
2. Examine the ais_cell.log or ais.log for errors.
3. Verify that the AIS cell is correctly configured.
191004
Error
Timeout waiting for results from the AIS cell.

Description You might see this timeout error if the AIS cell has stopped responding.
Solution Examine the ais_cell.log or ais.log for errors.
191005
Error
BMC Atrium Core 9.0
Page 2079 of 2268
Home
Error
number
Message
type
Timeout querying the CMDB.

Description One of the possible causes for this timeout error might be that the BMC Atrium CMDB or AR
System server has stopped responding.
Solution
1. Verify that the AR System server is still running.
2. Increase the Process Timeout setting for the AR System server.
191006
Error
Error while trying to retrieve information from the CMDB for CMDB query.
Description Exception returned (for example, with authentication) when performing a query.
Solution Check the ais.log for details about the exception.
191007
Error
An unknown error has occurred in the Atrium Impact Simulator plug-in.

Description Your system encountered a problem with no anticipated cause.
Solution Check the ais.log for details about the error.
191008
Error
Exception while sending the CI information to the Atrium Impact Simulator

engine.
Description You typically see this error when the Atrium Impact Simulator plug-in is unable to connect to
the AIS cell, due to a configuration problem.
Solution
1. Make sure that the AIS service (Windows) or the AIS daemon (UNIX and Linux) is running. This
service or daemon is labelled as the mcell process.
2. Review both the ais_cell.log or ais.log files for details about the error.
191009
Error
Exception while cleaning cache.

Description The current simulation is invalid.
Note: You should only click Refresh CI when you have actually modified the Configuration Item (CI) impact
model.
Solution
1. Close the simulation and try again.
2. If the problem continues, review both the ais_cell.log or ais.log files for details about the error.
191010
Error
No AIS cells configured in AIS:GlobalPreferences.

Description Atrium Impact Simulator cannot find a configuration to the primary, secondary, or load balance
cells, or to the default values of localhost, 1825, or ais.
Solution You must correctly specify the required attributes for each AIS cell in the AIS:GlobalPreferences
form. Make sure that you test the availability of the cell after you make any changes.

The following topics provide information for resolving issues with your BMC Atrium Core installation
:
BMC Atrium Core 9.0
Page 2080 of 2268
Home

Other common installation issues
Common uninstallation issues
BMC Atrium Integration Engine installation issues
Product Catalog installation issues
Web Services installation issues
BMC Atrium CMDB installation issues

The extension loader might not successfully copy data to your data model due to issues with the
BMC Remedy AR System server. Use the following procedure if the extension loader stops
responding or fails to run.
To troubleshoot extension loader process issues

1. In the AR System Administration Console, log on to the BMC Atrium CMDB server to verify
that you can connect to the AR System server.
2. To verify that you can access the BMC Atrium CMDB server, log on to the cmdbdriver
program and issue the glc command.
For more information about using cmdbdriver, see cmdbdriver program.
3. Make sure that the database server has at least 15 percent of space available and can grow
the transaction log as needed during the installation.
Tip
Set the auto-extend option in the database to make sure that the space on the
database server automatically extends.
4. If the extension loader stops responding, check the arerror.log or armonitor.log files to
make sure that the arserver.exe (Microsoft Windows) or arserverd (UNIX) server
process did not restart or stop responding.
During the installation, the Admin thread 390600 is busy, Therefore, you might receive
timeout messages when you try to access the AR System Administration Console.
5. If the AR System server stops responding during the extensions installation, abort the
installation and troubleshoot the AR System issue.
6. If you are installing the extensions as a non-root user, make sure that you use the same user
ID that you used to install the AR System server and BMC Atrium CMDB.
7. To verify that your system has sufficient space (at least 600 MB of free space and 1 GB of
temp space), perform the following steps:
a. Check the %TEMP% directory (Windows) or /tmp (UNIX) for space.
b.
BMC Atrium Core 9.0
Page 2081 of 2268
7.
Home
b. On Windows, check hard disk space using Explorer. On UNIX, use the df- k
command to verify that you have a reasonable amount of swap space on the system.
8. On UNIX, type ulimit -a from the console to verify that the ulimit settings are set high.
The following output is from a system that is functional. A default system has a process size
limit of 64 KB, which is not large enough for the BMC Remedy installer.
time (seconds) unlimited

file (blocks) unlimited
data (kbytes) unlimited
stack (kbytes) 8192
coredump (blocks) unlimited
nofiles (descriptors) 64
vmemory (kbytes) unlimited
9. On IBM AIX, perform the following steps:
Enter lsattr -E -l sys0 -a ncargs to make a note of the value from ncargs.
Enter chdev -l sys0 -a ncargs=128 to temporarily change ncargs to its
maximum for the system.
10. If any processes on AIX stopped responding, use the procstack -F ProcessID AIX
command to troubleshoot the issue.
11. On Windows, set the VM parameter in the boot.ini file to allow 32-bit programs to use 3 GB
of random access memory (RAM).

If any script files for the extensions that you want to install is missing or if the extensions directory
structure is incorrect when installing the extensions, you might encounter errors.
The following procedure provides instructions to troubleshoot extension loader issues. For more
information about the cmdbExtLoader program, see Managing BMC Atrium CMDB extensions.
To troubleshoot extension loader issues

1. Open the AtriumCoreMaintenanceTool.cmd utility and click the Generate Extensions
XML File tab to generate the XML file for the extensions.
The atriumcore_configuration_log.txt file, which is created when you generate the
extensions, reports any missing file errors.
2. Click the Validate Extensions XML File tab to validate the extensions.
3. If the extensions installation fails, click Browse to Log on the Log tab and look for SEVERE
error messages displayed in the log.
The log file path can be retrieved from the atriumcore_configuration_log.txt file.
Note
BMC Atrium Core 9.0
Page 2082 of 2268
Home
On some Windows systems, log files are not generated if the %TMP% and %
TEMP% variables do not point to the same location.
4. Verify that the cmdbdriver and driver scripts files are in UNIX format, without ^M
characters, otherwise you might encounter errors, such as CMDBdriver did not
produce a CMDBdriver.out file.
5. Examine the .out files to determine the output of the driver or cmdbdriver scripts.
Driver is a command line client for the AR System C API and cmdbdriver is a command
line client for the BMC Atrium CMDB C API. The .out files indicate whether a script was
successfully executed. In case of errors, specific error areas, such as AR System errors or
BMC Atrium Core errors and their reasons are provided.
6. Check the installation log files for the following warnings and errors:
Warnings The cmdbExtLoader might encounter AR System warning messages when
installing the extensions. Warnings mean that the extensions were installed with exceptions
to the requested operation. To troubleshoot warnings:
Check the log files to verify that the operation was completed successfully.
If the operation was completed successfully, import the records into the SHARE:
Application_Properties form.
Errors Check for the following types of errors in the log files:
Dependency failure The prerequisites listed in the package.xml file are not met.
Extension already exists The installer found an extension that was already
registered in the SHARE:Application_Properties form.
Extension already failed The installer found a failed extension from a previous
installation.
7. From a browser, query the SHARE:Application_Properties form to determine whether the
required components and versions are installed on the server.
8. If the .out file is not generated, perform the following steps:
a. Start the driver or cmdbdriver program.
For more information about using the cmdbdriver, see cmdbdriver program.
Note
If you encounter errors when running the executables, use the log and
init commands to log on to the cmdbdriver program and to initialize it.
b. Run the ex command to execute the script.
c.
BMC Atrium Core 9.0
Page 2083 of 2268
Home
c. At the File name of input file prompt, specify the OSD file for cmdbdriver or the
ARD file for driver.
These script files are located under the extensions directory. The script file for the
cmdbdriver program is named as OSD.txt and for the driver program is named
as ARD.txt.
Other common installation issues

Even though you successfully installed the BMC Atrium Core solution, you might encounter issues
when working with its specific components. The following topics contain troubleshooting information
for such post-installation issues:
Extension installation fails to complete
Special characters are not being displayed correctly
Running certain commands on UNIX results in JRE conflict error
BMC Atrium Core Console access or launch issues
Web services not restarting after a computer reboot on UNIX
Extension installation fails to complete

If the installation of extensions using the extension loader fails to complete or the process is
stopped before completion, the extension loader remembers the partial installation. If the
installation is attempted again and the extension loader finds a state in which proceeding would
result in data corruption, the extension loader stops the installation and returns an error message.
In this case, contact Customer Support. For more information about managing extensions, see
Managing BMC Atrium CMDB extensions.
Special characters are not being displayed correctly

If characters such as the trademark () and copyright () symbols are not being displayed
correctly, the Unicode setting for the Oracle database might have been cleared when installing
BMC Remedy Action Request System (BMC Remedy AR System). For more information, see
Unicode support.
Running certain commands on UNIX results in JRE conflict error

If you run admincmdline, tibcommander or start the ems, managementdaemon, or
adminserver from the command line and errors result, unset the library path for that UNIX
session prior to invoking the command.
BMC Atrium Core Console access or launch issues

After installation, if you can not access the BMC Atrium Core Console, receive a Page not found
error, or the console does not launch correctly:
Restart BMC Remedy Mid Tier
BMC Atrium Core 9.0
Page 2084 of 2268
Home
Make sure that the mid tier is configured to communicate with the appropriate BMC Remedy
AR System server. For more information about configuring the mid tier, see BMC Remedy
Mid Tier configuration in the BMC Remedy Action Request System (BMC Remedy AR
System) documentation.
Web services not restarting after a computer reboot on UNIX

On UNIX, processes related to web services are not started automatically after a computer restart.
1. Make sure that the $ATRIUMCORE_HOME environment variable is defined when BMC
Atrium Core components are installed.
2. Start the Tomcat server by using the startup.sh script which islocated at
TomcatServerInstallation/bin.
Common uninstallation issues

This topic contains troubleshooting information related to uninstallation.
On Microsoft Windows, if you see no CPU activity for an hour or more, check the AR System
server log, arerror.log, for any crashes or errors. For more information about arerror.log,
see AR System server logging.
On UNIX, if you see a message that the BMC Remedy AR System is terminated, search for
a stack trace for crashes or errors.
If the uninstallation process for BMC Atrium Core Web Services was performed improperly
or in the incorrect order, the Active Matrix Administrator directory might be left with a path
name that exceeds 255 characters. Attempting to delete the directory results in an error
because Windows might not allow the deletion of directories with path names longer than
255 characters.
BMC Atrium Integration Engine installation issues

When you install BMC Atrium Integration Engine, you might encounter workflow errors, such as:
UploadUtilityFiles(dukat,Demo,*****,0,D:\Program Files\AR System\AIE71p5\
dukat-0\utility,) 20:21:15
Failed to copy addeiefields.exe file: The specified plug-in failed to
initialize properly. Contact your AR System Administrator for assistance.
Failed to copy appspwd.exe file: Form does not exist on server
Failed to copy eiexfer.exe file: Form does not exist on server
Failed to copy db2helper.exe file: Form does not exist on server
Failed to copy filehelper.exe file: Form does not exist on server
Failed to copy rlohelper.exe file: Form does not exist on server
Failed to copy rlshelper.exe file: Form does not exist on server
Failed to copy xmlhelper.exe file: Form does not exist on server
BMC Atrium Core 9.0
Page 2085 of 2268
Home
This issue occurs when the BMC Atrium Core installer fails to copy the BMC Atrium Integration
Engine workflow utilities to the BMC AR System server directory. This workflow issue might cause
errors when you create data mappings or data exchanges.
To resolve this issue

1. Examine the BMC Atrium Integration Engine log file for import job or other errors.
If there are no errors in the log file, the error might have occurred due to workflow issues.
2. Manually copy the workflow utility files from the aie\utility\platformproductVersion
subdirectory of the BMC Atrium Core installation to the subdirectory of the AR System server
installation.
The following table lists the appropriate files to copy, depending on the platform you use.
Workflow utility files for specific platforms
Platform
Workflow utility files
Windows
Copy the following files to the AR System server installation directory:

addaiefields.exe
appspwd.exe
db2helper.exe
aiexfer.exe
filehelper.exe
rlohelper.exe
rlshelper.exe
xmlhelper.exe
UNIX and Linux
Copy the following files to the bin directory of your AR System server installation:
addaiefields
appspwd
db2helper, db2helper.sh
aiexfer
filehelper
Rlohelper, rlohelper.sh
Rlshelper
Xmlhelper
Product Catalog installation issues

This topic provides information about Product Catalog installation issues, such as the errors to
search for in the AR System configuration file and Product Catalog log files. Product Catalog is
installed as a part of BMC Atrium Configuration Management Database (BMC Atrium CMDB) and
cannot be removed or installed separately.
To troubleshoot Product Catalog issues

1. If the Product Catalog is not installed, perform the following steps:
a.
BMC Atrium Core 9.0
Page 2086 of 2268
Home
1.
a. In the ar.cfg file, look for the entry for CMDB-Inline-Normalization.

If the entry is missing or if it is not assigned a value of T, the Product Catalog was not
successfully installed. Therefore, the Normalization Engine features might not work.
b. Run the BMC Atrium Core installer again to install BMC Atrium CMDB.
2. If an error occurred when installing the application, examine the BMCAtriumPC.html log
located in the BMCAtriumCoreInstallationDirectory /Logs directory.
Error messages are written to the BMCAtriumPC.html and explain the reason for each
installation failure.
3. If the BMCAtriumPC.html log file contains an error message, examine the
BMCAtriumPC.log and BMCAtriumPC_error.log log files for more details.
Web Services installation issues

This topic describes installation issues related to Web Services Infrastructure, BMC Atrium Core
Web Services, and Web Services Registry.
Note
If the Tomcat startup console is displayed when you are installing the Web Services
Registry and the Web Services Infrastructure components, the errors and logging
statements are visible in the startup console. If the installer displays a message that the
installation of the Web Services Registry and the Web Services Infrastructure components
is successful, no action is required for the errors and logging statements that are visible in
the startup console.
BMC Atrium Core Web Services is inaccessible on the network

If BMC Atrium Core Web Services is inaccessible on the network, check the \etc\hosts file.
The computer should not resolve its name with the loopback IP address. An entry line like the
following could be the cause:
127.0.0.1 ashiko-vm1-rhel5.labs.bmc.com ashiko-vm1-rhel5
localhost.localdomain localhost
To resolve this issue, remove the host name and reboot the computer.
Web Services Registry installation fails

If you are installing all BMC Atrium Core features on a single computer and the installation of Web
Services Registry fails,verify that you have the recommended amount of RAM, 6 GB, on that
computer.
BMC Atrium Core 9.0
Page 2087 of 2268
Home
BMC Atrium CMDB installation issues

This topic provides information about BMC Atrium Configuration Management Database (BMC
Atrium CMDB) installation issues, such as, the errors to search for in the error log file, how to
enable SQL and API logging, and the steps to perform to determine any Normalization Engine
issues.
To troubleshoot BMC Atrium CMDB installation issues

1. Examine the logs in the BMCAtriumCoreInstallationDirectory/Logs directory.
If an error occurred when importing a particular file, a message is written to the
applicationName_error.log file (for example, BMCAtriumCMDB_error.log ). The message
indicates the reason for the import failure.
2. In the BMCAtriumCMDB_error.log file, note the timestamp of a failure entry, then sort by
Timestamp to view the entries immediately preceding that failure in chronological order.
If the installation error was caused by cmdbdriver, the command that triggered the
installation error might appear two or three lines before the Severe failure entry.
3. Examine the arerror.log for issues with the server. For more information about arerror.log,
see AR System server logging.
4. If the error message in the log does not describe the issue, enable SQL and API logging and
import the .DEF file again to reproduce the error with additional information.
You can enable the API and SQL logging options from the AR System Administration:
Server Information Log Files tab. On Microsoft Windows, these logging options create the
log files under the Program Files\AR System\<serverName>\AR Server\db subdirectory of
your installation directory by default. On UNIX, they are created under
serverInstallationDirectory/<serverName>/db. You can change their file names and
location at any time.
5. If any cmdbdriver commands failed during the installation, perform the following steps:
a. For UNIX, set the library path to the rik folder.
b. Run the command that triggered the installation error.
c. Remove the double quotes from RIK/driver/CMDBdriver.
d. In the -p not_displayed command, replace the not_displayed parameter with
the correct password.
e. Examine the logs using the Maintenance Tool. Alternatively, examine the logs in the
BMCAtriumCoreInstallationDirectory/Logs directory.
If an error occurred when importing a particular file, a message is written to the
applicationName_error.log file (for example, BMCAtriumCMDB_error.log). The

message indicates the reason for the import failure.
6. If the Normalization Engine API is not installed, perform the following steps:
a. In the ar.cfg file, look for the Server-Plugin-Alias: BMC.FILTERAPI.NORM.ENGINE
entry.
If the entry is missing, the installation did not succeed.
b. Run the BMC Atrium Core installer again.
7.
BMC Atrium Core 9.0
Page 2088 of 2268
Home
7. If the Normalization Engine plugin is not installed, perform the following steps:
a. Verify that the ne folder exists in ROOT\Software\AtriumCore\<hostName>\CMDB\
plugins.
If the entry is missing, then the installation did not succeed.
b. Run the BMC Atrium Core installer again.

The following topics contain information about troubleshooting your BMC Atrium Integrator
installation:
Working with the Atrium Integrator Maintenance Tool
Collecting Atrium Integrator installation and uninstallation log files
Working with the Atrium Integrator Maintenance Tool

The Atrium Integrator Maintenance Tool gives you access to installation, configuration,and
uninstallation logs. When you open the tool, the following tabs are displayed:
Logs
Load Content
Encrypt
Tip
If this is a new installation, the Maintenance Tool resides in the aint folder under the
Atrium Integrator installation directory.
To open the Atrium Integrator Maintenance Tool, on a Windows computer, go to your installation
directory and double-click AtriumIntegratorMaintenanceTool.cmd.
For a UNIX computer, go to your installation directory and run ./
AtriumIntegratorMaintenanceTool.sh.
In each log, errors are highlighted in red , and warnings are highlighted in yellow .
Collecting Atrium Integrator installation and uninstallation log files

You can view the installation and uninstallation log files from the Atrium Integrator Maintenance
Tool. For instructions on instantiating the Atrium Integrator Maintenance Tool, see Working with the
Atrium Integrator Maintenance Tool.
This topics describes how to view Atrium Integrator installation and uninstallation log files and how
to collect Atrium Integration installation log files for BMC Support.
To view logs
BMC Atrium Core 9.0
Page 2089 of 2268
Home
Collecting log files for debugging

To view logs
1. In the Atrium Integrator Maintenance Tool, click the Logs tab.
2. Click Install Log or Uninstall Log.
A tab for each installation log or uninstallation log is displayed.
To browse for a specific log file, click Browse to Log instead.
3. Click the tab for the log you want to view.
Note
If you are running a Telnet session, you must open a new Telnet window to view logs.
Collecting log files for debugging

The Log Zipper, part of the Atrium Integrator Maintenance Tool, provides a collection of log files
and characteristics that are necessary for debugging. Use the Log Zipper for failures related to
installation as well as failures that can happen post-installation. Because the zipped log file name is
based on date and time, you can overwrite the zip file if you run the logzipper command at intervals
less than one minute apart.
Note
If you are running a Telnet session, you must open a new Telnet window to prepare log
files for BMC Customer Support.

1. In the Maintenance Tool, click the Logs tab.
2. Click Zip Logs.
Tip
To prepare the log files from the command line, go to the directory where Atrium
Integrator Maintenance Tool is installed, run the following command to have the
logs zipped and created in the TEMP directory:
Windows: AtriumIntegratorMaintenanceTool.cmd -console logzipper
BMC Atrium Core 9.0
Page 2090 of 2268
Home
UNIX: ./AtriumIntegratorMaintenanceTool.sh -console logzipper
In the TEMP directory (Microsoft Windows) or the /var/tmp/server folder (UNIX), a zip file is
created with the date and time appended to the file name:
AtriumIntegratorLogs_mmddyyyy_hhmmss.zip.
3. Provide the AtriumIntegratorLogs_mmddyyyy_hhmmss.zip output file, located in your
temporary directory, to BMC Customer Support.

1. In the Maintenance Tool, click the Logs tab.
2. Click Zip All Logs.
In the TEMP directory (Microsoft Windows), the /var/tmp/server folder (HP-UX and Solaris),
and /tmp (Linux and AIX) servers folder, a zip file is created with the date and time
appended to the file name: AllLogs-iBMC-3Y1F5BS.adprod.bmc.com.zip.
3. Provide the AllLogs-iBMC-3Y1F5BS.adprod.bmc.com.zip output file, located in your temp
BMC Atrium Core upgrade issues

The following topics provide information on resolving issues with BMC Atrium Core upgrade:
Issues that might arise during the CDMChecker pre-upgrade check
Issue that might arise during the Product Catalog Pre-upgrade check
Other BMC Atrium Core upgrade issues
Related topics
Install and upgrade known and corrected issues

The following topics provide tips and solutions to problems that might occur when upgrading Atrium
Integrator:
Stopping concurrent processes
Fixing issues while backing up jobs and transformations
Stopping concurrent processes

As a prerequisite to upgrading the Atrium Integrator server, you must stop all other applications
except for the installer. These applications might consume processes that are required by the
Atrium Integrator installer for deploying the installation files and directories.
BMC Atrium Core 9.0
Page 2091 of 2268
Home
If some of the older files and directories are still being used by some processes, or if some
conflicting applications are still running, the installation program prompts you to run the Handle
utility. Running the Handle utility returns a list of processes that are still in use. You must stop these
processes before proceeding with the upgrade of Atrium Integrator.
You can use Handle to see a list of processes that might be using the Atrium Integrator server
7.6.04 files and directories.
Important
You can run the Handle utility on a Microsoft Windows computer only.
To obtain the Handle utility

1. From the Microsoft Windows Sysinternals Download website, obtain the executable file for
Handle.
2. The Handle executable file is saved as a zipped file (typically called Handle.zip) to your
default download folder.
3. Create a folder called Handle on your computer and extract the contents of the zipped file
here.
To stop concurrent processes

1. Run the Handle utility with the following command: handle.exe -u <Atrium
Integrator home path>.
For example, if Atrium Integrator is installed in the AtriumIntegrator directory located at C:\
Program Files (x86)\BMC Software, run the Handle utility with the following command:
handle.exe -u C:\Program Files (x86)\BMC Software\
AtriumIntegrator7604.
A list of processes that use the files and directories of Atrium Integrator is displayed on the
Command Prompt.
2. From the Task Manager, locate these processes using the PID value, and kill them.
Fixing issues while backing up jobs and transformations

While upgrading the Atrium Integrator server, the Atrium Integrator server installer might fail to
create a backup of some or all of your jobs or transformations. In event of such a failure, view
details of those jobs and transformations for which a backup failed. You can view these details from
the Atrium Integrator Spoon. Now proceed to correct issues with the jobs and transformations for
which a backup could not be created. Thereafter, create a backup of all your jobs and
transformations manually and then reinstate all your jobs and transformations into the Atrium
Integrator server.
BMC Atrium Core 9.0
Page 2092 of 2268
Home
Follow these steps ensures that all your jobs and transformations can be accessed from the Atrium
Integrator server.
Viewing your jobs and transformations from Atrium Integrator Spoon 7.6.04
If the installation program encounters issues while creating a backup of your jobs and
transformations, view details of those jobs and transformations for which a backup could not be
created. You can view these details from the Atrium Integrator Spoon 7.6.04.
To view your jobs and transformations from Atrium Integrator Spoon 7.6.04
1. From the server folder that resides in the installation directory of the Atrium Integrator server
7.6.04, open the data-integration folder.
For example, on a Microsoft Windows computer, you might find the server folder at C:\
Program Files (x86)\BMC Software\AtriumIntegrator7604 .
2. Open the Atrium Integrator Spoon 7.6.04.
On Windows, execute Spoon.bat.
On UNIX, execute ./Spoon.sh.
3. Proceed to view the jobs from Atrium Integrator Spoon 7.6.04 as described in the Atrium
Integrator 7.6.04 User's Guide.
Correcting issues with jobs and transformations

While upgrading the Atrium Integrator server, issues with your jobs and transformations might
cause their backup to fail completely or partially.
Issue with selecting Allow Unqualified Searches option
Issue with opening a transformation
Issue with transformations not loading on Atrium Integrator Spoon 8.1
BMC Atrium Core 9.0
Page 2093 of 2268
Home
Issue with selecting Allow Unqualified Searches option

If Allow Unqualified Searches is not selected while upgrading the Atrium Integrator server, a
backup of your jobs and transformations might fail.
Identifying this issue

Open the atriumintegrator_install_logs.txt file residing under the %TEMP% (Windows), /tmp (
Linux), or the /var/tmp (Solaris) folder. Search for error messages. If you encounter an error
message that indicates that the Allow Unqualified Searches check box is not selected, proceed to
fix this issue following the instructions in Workaround.
For example, your error message might look like this:
An unqualified search was issued and the server has been configured to
disallow unqualified searches.
Workaround
1. From a browser, open the AR System Administration Console.
3. Click the Configuration tab.
4. Select the Allow Unqualified Searches check box.
Note
You must restart your AR System server for the changes to come into effect.
Issue with opening a transformation

A transformation does not open from Atrium Integrator Spoon if there are issues with data store
connections related to that transformation.

After the upgrade completes, open the (Windows) aidevtoprodout.txt file or the (UNIX)
aiExporterr.txt file.
The aidevtoprodout.txt file resides at \diserver\data-integration\ngie\bin{}log folder
under the AR System home directory.
The aiExporterr.txt file resides at /diserver/data-integration/ngie/bin/log folder under the
AR System home directory.
Search for error messages indicating an error with data store connections that caused a particular
transformation to not open. Proceed to fix this issue as described in Workaround.
Workaround
BMC Atrium Core 9.0
Page 2094 of 2268
Home
1. Open the BM Atrium Integrator Spoon 7.6.04 as described in Viewing your jobs and
transformations from Atrium Integrator Spoon 7.6.04.
2. Open any job or transformation as described in the Atrium Integrator 7.6.04 User's Guide.
A list of all database connections gets populated under Database Connections in Explorer.
3. Open the data store connection because of which a particular transformation could not open.
Note
The aidevtoprodout.txt file and the aiExporterr.txt file list the details (including
the data store connection that might have an issue) of all the jobs and
transformations, a backup for which failed.
4. Edit this data store connection. For more information, see Editing a data store connection
in Atrium Integrator in the Atrium Integrator 7.6.04 User's Guide .
5. Repeat this procedure for all the transformations that could not open from Atrium Integrator
Spoon.
Issue with transformations not loading on Atrium Integrator Spoon 8.1

A transformation does not load on Atrium Integrator Spoon 8.1 if custom plugins from Atrium
Integrator Spoon 7.6.04 are not imported in to Atrium Integrator Spoon 8.1.

After the upgrade completes, open the (Windows) aidevtoprodout.txt file or the (UNIX)
aiExporterr.txt file.
The aidevtoprodout.txt file resides at \diserver\data-integration\ngie\bin\log folder under
the AR System home directory.
The aiExporterr.txt file resides at {}diserver\data-integration\ngie\bin{}log folder under
the AR System home directory.
Search for error messages indicating an error related to missing plugins that caused a particular
transformation to not open. Proceed to fix this issue as described in Workaround.
Workaround
1. Open the BMC Atrium Integrator Spoon 7.6.04 as described in Viewing your jobs and
transformations from Atrium Integrator Spoon 7.6.04.
2. Open one of the transformations listed as having an issue related to custom plugin in the
aidevtoprodout.txt or aiExporterr.txt file. Follow the instructions described in the Atrium
Integrator 7.6.04 User's Guide.
3. Obtain a list of plugins used by this transformation.
BMC Atrium Core 9.0
Page 2095 of 2268
3.
Home
Note
Plugins are also known as steps.
4. Repeat step 1 through step 3 for all the transformations that failed to load.
5. Obtain a list of all the plugins that these transformations use.
6. Match this list against the list of existing plugins that reside in the {}server\data-integration\
plugins{}steps folder under the AR System home directory.
The AtriumIntegrator7604 folder is created when a backup of jobs and

transformations does not succeed during an upgrade. For more information, see
Case two the backup of jobs and transformations is a complete or partial failure .
You should now have a list of all the plugins that are present in the Atrium Integrator 7.6.04
home directory, but are not present in the Atrium Integrator home directory.
7. From the {}server\data-integration\plugins{}steps folder under the Atrium Integrator
7.6.04 home directory, copy all the plugin folders that are not present in Atrium Integrator to {
}server\data-integration\plugins{}steps folder under the AR System home directory.
Creating a backup of your jobs and transformations
If the Atrium Integrator server fails to create a backup of your jobs and transformations during
upgrade, you must do so manually.
To create a backup of your jobs and transformations

1. From the utilities folder residing in the server directory, open the aiexportutility utility in a
text editor. The server folder resides under the Atrium Integrator server installation directory.
For example, you might find server under C:\Program Files (x86)\BMC Software\
AtriumIntegrator.
2. Set the $UTILITYPATH$, $OLD_AI_INSTALL_PATH$, and the $BMC_JAVA_HOME$
parameters to reflect the Java home path, the Atrium Integrator server 7.6.04 home path,
and the utilitiesfolder path respectively.
BMC Atrium Core 9.0
Page 2096 of 2268
Home
To set $OLD_AI_INSTALL_PATH$, replace the existing value of this parameter with

the path of the data-integration folder within the Atrium Integrator server 7.6.04
home directory. For example, if you installed the Atrium Integrator server on a
Windows computer, set $OLD_AI_INSTALL_PATH$ to C:\Program Files (x86)\BMC
Software\AtriumIntegrator7604\server\data-integration.
Replace the existing value of $UTILITYPATH$ with the path of the utilities folder
residing under the Atrium Integrator server installation directory. For example, if you
are upgrading the Atrium Integrator server on a Windows computer, set $
UTILITYPATH$ to C:\Program Files (x86)\BMC Software\AtriumIntegratorLatest\
server\utility.
Replace the existing value of $AR_SERVER_HOME$ with the current AR installation
path.
4. Run the aiexportutility utility.
When running the utility you must specify the old Atrium Integrator 7.6.04 installation path.
Specify the following path: C:\Program Files (x86)\BMC Software\AtriumIntegrator7604\
server
(Windows) run the aiexportutility. cmd file.
(UNIX) execute the ./aiexportutility.sh command.
A backup of all your jobs and transformations (as .kjb and .ktr files) is created in the
AI7604RepositoryBackup folder under the ARSystem directory. The ARSystem directory is
located at C:\Program Files\BMC Software.
Reinstating your jobs and transformations into the Atrium Integrator server
After you create a backup of yours jobs and transformations following the instructions in Creating a
backup of your jobs and transformations, reinstate the jobs and transformations into the Atrium
Integrator server.
To reinstate the jobs and transformations

1. Open the Atrium Integrator Maintenance Tool.
On Windows, go to your Atrium Integrator server installation directory and execute
AtriumIntegratorMaintenanceTool.cmd
On UNIX, go to your Atrium Integrator server installation directory and execute ./
AtriumIntegratorMaintenanceTool.sh
2. In the Atrium Integrator Maintenance Tool, click the Load Content tab, and click Next.
3.
BMC Atrium Core 9.0
Page 2097 of 2268
Home
3. Supply the same AR System server application service password that you set when you
installed the AR System.
4. Click Next to connect to the AR System server.
5. Provide the JRE path used by the Atrium Integrator server and click Next.
6. Provide the path to the AI7604RepositoryBackup folder and click Next to reinstate the jobs
and transformations. For example, if the AI7604RepositoryBackup folder resides under the
C:\Program Files\BMC Software\ARSystem directory, provide this path when prompted.
Issues that might arise during the CDMChecker pre-upgrade

check
During the pre-upgrade check, CDMChecker detects discrepancies in the Common Data Model (
CDM). You cannot upgrade BMC Atrium Core if CDMChecker detects customization in your CDM
that did not follow the standard guidelines.
Identifying issues with CDMChecker
Troubleshooting classes and attributes that are not active
Troubleshooting fields that are missing from AR forms
Identifying issues with CDMChecker

During upgrade, CDMChecker identifies the following issues:
When
CDMChecker
To troubleshot
To proceed with upgrade
#Classes are
not in the
Active state
Identify and delete

classes that are not
in Active state
To initiate the upgrade, in the installer, click Previous and

then resume with the upgrade.
#Attributes
are not in the
Active state
Identify and delete

attributes that are not
in Active state
To initiate the upgrade, in the installer, click Previous and
#Fields are
missing from
AR forms
Identify and delete

missing fields from
AR forms
After you fix the issue, uninstall the components that failed
to upgrade. And then run the BMC Atrium Core installer
again to initiate the upgrade.
Note: For BMC Atrium Web services, if upgrade fails, you
reports
errors if
Before an upgrade is
initiated.
(Errors are displayed in the
Pre-Checks for BMC
Atrium Core panel)
Before an upgrade is
initiated.
then resume with the upgrade.
Pre-Checks for BMC

Atrium Core panel)
Upgrade fails
Installation Summary
panel.)
need to do fresh install.
Troubleshooting classes and attributes that are not active

Typically, before an upgraded is initiated, CDMChecker identifies if certain classes or attributes are
inactive. It identifies if the classes or attributes are in Change Pending or Delete Pending
state. These errors are displayed in the Pre-Checks for BMC Atrium Core panel. You must
troubleshoot these issues and then proceed with the upgrade.
BMC Atrium Core 9.0
Page 2098 of 2268
Home
Note
If a class or an attribute is in the Change Pending state, investigate the cause. For more
information about resolving issues related to Change Pending state, see this comment on
BMC Communities.
For more information about classes and attributes in pending state, see knowledge article
KA289957 available at http://www.bmc.com/support/knowledge-base.You can view
published articles from the knowledge base by logging in to the Knowledge Base with your
Support credentials.
To identify and delete classes that are not in Active state

If some classes are in the Change Pending or Delete Pending state, CDMChecker
pre-upgrade check fails. In this case, open the OBJSTR:Class form to determine such states of the
classes and change them into active state or delete the state of those classes.
1. Open the the OBJSTR:Class form in search mode.
3. In the Advanced Search Bar, type the following query:
'Pending ID' != "0" OR 'System Status*' != "Active" OR 'OSStatus' !=
"Active" OR 'Record Status' != "Active" OR 'Status' != "Active" OR '
Session Status' != "Just Created"
In the query results, identify the rows in which classes are not built or deleted properly.
4. Delete all entries that have a Delete Pending state.
To Identify and delete attributes that are not in Active state

If some attributes are in the Change Pending or Delete Pending state, the CDMChecker
pre-upgrade check fails (indicated by a disabled Next button) and the upgrade stops. In this case,
query the OBJSTR:AttributeDefinition form to find out which attributes are in Delete Pending state
and delete these attributes.
1. Open the the OBJSTR:AttributeDefinition form in search mode.
3. In the Advanced Search Bar, type the following query:
'OSStatus' != "Active" OR 'Pending ID' != "0"
If this query returns any row, then these rows should be investigated as attributes that are
not built or deleted properly.
4. Delete those attributes that are in the Delete Pending state.
BMC Atrium Core 9.0
Page 2099 of 2268
Home
Troubleshooting fields that are missing from AR forms

If some fields are not present on some AR forms, but are present in the Attribute Definition form,
the CDMChecker pre-upgrade check fails and the upgrade stops. To troubleshoot, identify such
fields and delete them from the Attribute Definition form.
To identify and delete missing fields from AR forms

1. Open the missing-Fields.log file in a text editor. The missing-Fields.log file is available at
the following location:
<AtriumCore install directory>\BMC Software\AtriumCore\Logs
2. Search for errors related to missing fields.
For example, your error messages might look like this:
Error during ARGetMultipleFields in FindMissingFields Status: Field
does not exist on current form. Details: BMC.Core:BMC_BaseElement: <
767767002>
In class BMC.Core:BMC_BaseElement, for attribute upgrtest_Attb03
with attribute id OA-036109F846EB4A578066CE81CD9E66D3, could not
find corresponding AR field with ID=767767002 on form BMC.Core:
BMC_BaseElement.
In this example, an attribute with a name as upgrtest_Attb03 is missing from the
BMC.Core:BMC_BaseElement form.
3. Delete all the attributes that are missing from the AR forms.
4. Open the the OBJSTR:AttributeDefinition form in search mode.
5. Search all the attributes that could not be found in AR forms.
For example, if the missing_fields.log file recorded an attribute with a name as
upgrtest_Attb03 to be missing from BMC.Core:BMC_BaseElement form, search for this
attribute in the OBJSTR:AttributeDefinitions form.
6. Delete the attributes that are missing from the AR forms.
For example, delete the upgrtest_Attb03 attribute.
Issue that might arise during the Product Catalog Pre-upgrade

check
When you are upgrading BMC Atrium Core from a version earlier than 7.5.00, the Product Catalog
Pre-upgrade check verifies if all the instance IDs of records are unique in the SYS:Message form.
With BMC Atrium Core 7.5.00, the SYS:Message Box form was modified to ensure that the records
in this form had unique instance IDs. In versions earlier than 7.5.00, the instance IDs of records
were not necessarily unique. Since BMC Atrium Core 8.1 requires that the instance IDs of records
in the SYS:Message Box form be unique, an upgrade from a version earlier than 7.5.00 might fail if
a duplicate instance IDs are encountered by the Product Catalog Pre-upgrade check.
BMC Atrium Core 9.0
Page 2100 of 2268
Home
The Product Catalog Pre-upgrade errors are reported on the Pre-Checks for BMC Atrium Core
panel with the following error message:
PC pre upgrade validation failed. It could be due to customer records
that violate the form/table index constraints. check the logs for reason
& take corrective action before performing upgrade.
To troubleshoot Product Catalog Pre-upgrade check

1. Click Previous and come to the Thread Settings panel and then click Next.
This issue occurs as BMC Atrium Core installer behavior is dependent on the RIK utility
output in this case. If the AR System server is busy, the RIK utility returns an error due to
BMC Remedy AR System timeout that subsequently fails the pre-check that is run as part of
the BMC Atrium Core upgrade installation. Clicking the Back button and then clicking Next
causes the installer to invoke the RIK call. If the AR Server is not busy again, the precheck
would succeed.
2. If the above step does not resolve the issue, verify that all instance IDs of records in the SYS
:Message Box form are unique.
To verify:
a. In BMC Remedy User tool, open the SYS:Message Box form.
b. Search for all records.
c. Export these records to a .arx file.
d. Open the .arx file in a text editor and search for identical instance IDs.
e. Modify the instance IDs so that each one of them is unique.
f. Save the .arx file.
g. Import the .arxfile into the SYS:Message Box form.
Note
While importing the .arx file, set Handle Duplicate Request IDs By to
Update Old Record with New Record's Data and Match Duplicate
Request By to Custom Fields. Add the Message Tag and Locale fields.
Note
Ensure that there are no custom duplicates rows present, w.r.t composite
key: Message Tag (1000000135) and Locale(160).
Once you ensure that all the instance IDs are unique, stop the upgrade and restart it again.
BMC Atrium Core 9.0
Page 2101 of 2268
Home
Other BMC Atrium Core upgrade issues

This topic provides tips and solutions to troubleshoot issues that might occur when upgrading BMC
Atrium Core.
To troubleshoot miscellaneous upgrade issues

Check the memory usage of your computer during the upgrade.
Tip
On UNIX, use the Top command to check the memory usage and on Microsoft Windows,
use the Windows Task Manager.
If you see a malloc failed error, increase the virtual memory on your computer.
On Microsoft Windows, if you see no CPU activity for an hour or more, check the arerror.log
file, which is the BMC Remedy AR System server log, for any errors.
On UNIX, search for a stack trace for errors after you see a message that the AR System is
terminated.
Make sure that you install the AR System server and BMC Atrium Core in different
directories. If you install both these products in the same directory, certain library errors
might occur. BMC recommends that you accept the default location that is provided for these
products during installation.
BMC Atrium Core configuration issues

The following topics provide information for resolving common configuration issues that you might
encounter with BMC Atrium Core:
CMDB client managed transaction issues
Disabled Create button in the Product Catalog
Normalization plugin not working correctly
Dataset not configured correctly during normalization
Normalization Engine initialization errors
Troubleshooting BMC Atrium Service Context
CMDB client managed transaction issues

When implementing CMDB client managed transaction function calls, you will receive BMC
Remedy AR System error messages because the client managed transaction CMDB C API
functions rely on the corresponding AR System C API functions.
BMC Atrium Core 9.0
Page 2102 of 2268
Home
For more information on AR System C APIs, see Developing. For more information on the AR
System configuration file, see Configuring after installation in the BMC Remedy AR System online
documentation.
Guidelines for CMDB client managed transaction functions

The section includes general guidelines for implementing CMDB client managed transaction
functions.
Do not execute long running processes or APIs in the transaction.
Do not use the same transaction handle in multi-threaded API calls.
Make sure that the transaction is as small as possible to reduce the chance of deadlock.
When running concurrent transactions, make sure that there is no data overlap between
transactions.
To troubleshoot maximum client transactions error

If you receive the following AR System error 897, you may not have set a parameter in the AR
System configuration file (ar.cfg or ar.conf ).
Error (897): Maximum number of client transactions already in use.
In the AR System configuration file ( ar.cfg or ar.conf ), modify the
AR_SERVER_INFO_MAX_CLIENT_MANAGED_TRANSACTIONS parameter. Since the default is 0,
this parameter must be set prior to using client managed transaction functions. Note that the
maximum amount that can be set is 100.
Disabled Create button in the Product Catalog

Use this information if the Create button on the BMC Atrium Product Catalog Setup form is
disabled.
You do not have the required permissions to create a BMC Atrium Product Catalog setup. Contact
your system administrator.
Normalization plugin not working correctly

Use this information if the Normalization plugin is not working correctly.
To troubleshoot Normalization plugin

1. In the <ROOT>\Software\AtriumCore\<hostName>\Logs\AtriumPlugin.log file, search for
the message, Successfully loaded Java Plugin BMC.FILTERAPI.NORM.ENGINE.
If the entry is missing, some jar files might not have been installed.
2. Run the BMC Atrium Core installer again.
BMC Atrium Core 9.0
Page 2103 of 2268
Home
Dataset not configured correctly during normalization

Use this information if, during normalization, the dataset is not configured correctly to create or
update instances. Verify that the dataset settings are not preventing the common data model
update.
To troubleshoot the dataset configuration

1. Click Dataset Configuration, and verify that the dataset is not set to Trusted.
If the dataset is marked as Trusted, the data model changes are not normalized.
2. Verify the setting for Inline error handling:
If set to Reject, the CMDB is not updated if there is a normalization error. Enable
logging to see the error messages.
If set to Accept, the CMDB is updated even if there is a normalization error.
3. If the Normalization mode is set to Continuous, verify that the event or time is configured.
Normalization Engine initialization errors

Use this information if the Normalization Engine generates errors during initialization.
When you start the BMC Remedy AR System server after installing BMC Atrium Core, you might
encounter the following error in the AtriumPlugin.log:
<BMC.FILTERAPI.NORM.ENGINE>Initialization of NE is not done. Will try again after 2

minutes WARN ( ?:? ) - <BMC.FILTERAPI.NORM.ENGINE>Maximum number of attempts reached whi
le trying to initialize - stopped initializing
This issue might occur due to the following reasons:

The User ID and Password that you specified for the AR System server are incorrect.
The Normalization Engine is waiting for the AR System server to complete the start up
process. Therefore, it could not connect to the AR System server.
The Product Catalog version that you installed is not the latest.
To troubleshoot Normalization Engine initialization errors

Perform the following steps to resolve this issue:
1. Examine the neAPI.log file for additional error details.
2. If the error occurred due to incorrect user name and password, try to connect to the AR
System server with a user User ID that does not have a password (for example, the Demo
user).
3.
BMC Atrium Core 9.0
Page 2104 of 2268
Home
3. If the error occurred due to connection issues, verify that the AR System server is running
using the Ping MS DOS command from the computer on which the Normalization Engine is
installed.
4. If you are not able to connect to the server, your network might be down. This issue can also
occur if the Normalization Engine is accessing another AR System server.
5. From the SHARE:Application_Properties form, verify that the Product Catalog version that
you have installed is the latest.
For more information about Product Catalog version compatibility, see http://www.bmc.com/support
/reg/remedy-compatibility-tables.html?c=n
Troubleshooting BMC Atrium Service Context

The Service Context Web Service adapters provide a common interface for the BMC Atrium
Service Context feature to talk to various content providers (ITSM, SRM, and so on). A provider is
called by the Atrium Service Context plug-in; the provider then talks to its specific application and
returns the requested data back to BMC Atrium Core. Each provider registers its Web Service
location (WSDL) in the BMC Atrium UDDI registry. The Atrium plug-in is then able to detect what
providers are available, and call each provider to get information.
Note
A UDDI Server must be configured with the BMC Remedy AR System installation. You
can check this by navigating to the WS Registry Integration tab on the Server
Information form. In this tab, you should see your configured Registry Location along with
the Registry Admin User and Password.
If you have problems (for example, you cannot see the BMC IT Service Management attributes ), try
the following troubleshooting tips.
#To verify that the BMC Atrium Web Services Registry is properly configured
#To verify the Web Services are registered correctly in the UDDI
#To verify that the Adapter is published in the UDDI Registry
#To configure BMC Atrium Single Sign-On if the IT Service Management attributes are not
displayed
To verify that the BMC Atrium Web Services Registry is properly configured
Make sure that you have a valid configured server for the UDDI registry. You sometimes encounter
problems with Fully Qualified Domain Names (FQDNs).
2. Open the Server Information window.
3. Click the WS Registry Information tab.
4.
BMC Atrium Core 9.0
Page 2105 of 2268
Home
4. To verify that there is a valid configured server, open the URL from in the Registry Location
field, and validate that it opens the UDDI console.
If the URL does not work, make sure that the domain name is qualified correctly.
5. If you update the Registry Location, click Update Registry.
6. Set Flush Web Service End Point Cache to Yes.
7. Click OK.
To verify the Web Services are registered correctly in the UDDI

Each provider must register itself inside the UDDI registry. For BMC Remedy AR System providers
(for example, BMC IT Service Management, SRM, or SLM) the registration is done through the AR
System Web Service Registry form. This allows the administrator to easily add and update entries
to the UDDI server.
During the BMC IT Service Management installation, a record for the Service Context feature is
created (even if the administrator chooses not to configure Service Context at install time). This
allows the user to easily configure Service Context any time after installation.
1. Open the AR System Web Services Registry form from the BMC Remedy AR System
Administration Console (System > General > Web Services Registry ).
2. Search for the record where Business Name is set to BMC and Application Name is set to
ITSM.
3. Make sure that Registration Status is set to Registered.
4. Copy the End Point URL.
5. Log on to the computer where the AR System server is installed.
6.
BMC Atrium Core 9.0
Page 2106 of 2268
Home
6. Paste the URL into a web browser.

You should be able to open the web service without errors.
To verify that the Adapter is published in the UDDI Registry

1. Open the AR System Web Services Registry Query form from the BMC Remedy AR System
Administration Console (System > General > Web Services Registry Query ).
2. Search for the record where Business Name is set to BMC and Application Name is set to
ITSM.
3. Make sure that the WSDL URL and End Point URL are present.
If the record does not exist or the URLs are not present, you must register them in the UDDI .
To configure BMC Atrium Single Sign-On if the IT Service Management attributes

are not displayed
If you implemented BMC Atrium Single Sign-On and the IT Service Management attributes are not
displayed in the Service Context Administration window, it is possible that the Not Enforced URI
Processing list is not configured properly. You must add the web services URI to the not-enforced
list.
BMC Atrium Core 9.0
Page 2107 of 2268
Home
You can verify if BMC Atrium Single Sign-On is correctly configured by copying and pasting the
End Point URL into a web browser on the computer where the AR System server is installed. You
should not be forced to log on to view the web service.
If you are forced to log on, then perform the following steps:
1. Navigate to Start > All Programs > BMC Software > BMC Atrium SSO > Administrator to
open the BMC Atrium SSO Admin Console.
2. Edit the mid tier agent and add /arsys/services/ to the Not Enforced URI Processing*
list. For more information about editing agents on BMC Atrium Single Sign-On, see
Administering for the applicable BMC Atrium Single Sign-On version.
3. Restart the BMC Atrium SSO Tomcat service.
5. Restart the Mid Tier.
The IT Service Management attributes should now be correctly displayed.
Note
If you manually integrated BMC Atrium Single Sign-On, make sure that the /arsys/
services/* value is present in the not-enforced.txt file on the Mid Tier computer. For
more information, see:
Installing BMC Atrium Single Sign-On with the AR System server and Mid Tier
Manually configuring mid tier for BMC Atrium Single Sign-On user authentication.
BMC Atrium Core Console and Atrium widget

issues
The following topics provide troubleshooting information about issues related to the BMC Atrium
Core Console and Atrium Widgets, such as BMC Atrium Explorer and Atrium Query:
Atrium widget issues
BMC Atrium Explorer issues
Atrium widgets and the mid tier issues
BMC Atrium Core console or widget error messages
Atrium widget issues

This section provides possible solutions for resolving Atrium widget issues.
BMC Atrium Core 9.0
Page 2108 of 2268
Home
To resolve Atrium widget issues

1. Confirm whether you can access the following BMC Remedy Mid Tier URL from a browser.
http://<midTierName>:<portNumber>/arsys
2. Verify that you can log in to the mid tier.
If you receive an authentication error ( ARERR 623), see Troubleshooting ARERR 623. For
additional mid tier troubleshooting steps, see Atrium widgets and the mid tier issues .
3. Make sure that BMC Remedy Flashboards is working.
If a Server Not Found or Page Not Found error message is generated when you
access the BMC Atrium Core Console, confirm whether you have installed the mid tier
correctly. You must resolve this error before you proceed to the next step.
4. To verify that the Atrium Widgets are working, perform the following steps:
a. Log in to the BMC Atrium Core Console.
If an error is generated when opening the BMC Atrium Core Console, see BMC
Atrium Core console or widget error messages .
b. Click Application Launcher > Explorer > Classes from the navigation pane.
You must be able to view the list of CI classes in the navigation pane.
BMC Atrium Explorer issues

This section provides troubleshooting information for common BMC Atrium Explorer issues.
BMC Atrium Explorer issues and solutions
Issue/Error number
Cause
Solution
Send failed with the

BMC Atrium Explorer
login screen
If you reboot your computer on which you have installed

the mid tier and the AR System server, the mid tier might
start up before the AR System server is back online.
Restart the mid tier after the AR

System server starts up.
This issue occurs if you have installed other BMC

applications on the mid tier.
Duplicate CI names in
source datasets due to
inconsistent default
CI naming in the BMC
Atrium Explorer
If you create new BMC_ComputerSystem CIs in a new

View from the BMC Atrium Explorer and save the CIs with
the default value in the Name attribute, duplicate CIs are
When you create new CIs in a View

, change the value in the Name
attribute.
created in the source dataset.

This issue occurs when you close the BMC Atrium Explorer
session after creating new CIs and then create CIs in a
new session. Duplicate CIs in the source dataset will cause
issues when you reconcile the new CIs with the
BMC.ASSET dataset.
The OK button is
If you create a new filter from the BMC Atrium Explorer and
Make sure that the Filter Name
disabled when creating
specify a name in the Filter Name field that is more than 32

characters long, the OK button is disabled (Grayed out).
does not exceed its maximum

character limit.
a new filter
This issue occurs because the your Filter Name exceeds
BMC Atrium Core 9.0
Page 2109 of 2268
Home
Issue/Error number
Cause
Solution
the maximum length allowed for the field. In such a case,

the Filter Name text box is displayed with a Red border.
This denotes that an error occurred. To view the error
message, mouse over the Filter Name text box.
New classes,
attributes, or other
This issue occurs if the cache memory on the mid tier is

slow.
Flush the cache memory on the mid

tier after you create new objects in
objects not visible in

the BMC Atrium
Explorer
Error loading
This issue occurs on 64-bit Windows computers with a
Federation Manager and

Atrium Impact
Tomcat-based mid tier installation.
To troubleshoot this issue:

1. Click Start > Run and type
regedit.
Simulator
2. In the Registry, locate the

HKEY_LOCAL_MACHINE
folder and go to SOFTWARE
\Wow6432Node\Apache
Software Foundation\
Procrun 2.0\Tomcat5\
Parameters.
3. Verify whether the value in
the Parameters key is set to
path=C:\PROGRA~1\BMC.
This path is incomplete.
4. If yes, set the Parameters
key to path=C:\Program
Files (x86)\BMC Software\
AR Server\midtier\
WEB-INF\lib.
Atrium widgets and the mid tier issues

For the Atrium Widgets to work properly, the mid tier must be correctly configured and running. Any
issues with the mid tier might result in Atrium widget errors. The following procedure provides the
steps to resolve mid tier issues on a Windows computer.
For instructions about resolving mid tier issues on a UNIX computer, see BMC Remedy Action
Request System Mid Tier information.
To troubleshoot the mid tier

1. Make sure that the mid tier is installed.
An entry for the BMC Remedy Mid Tier must appear in the Add/Remove programs list on
your Windows computer.
2. Depending on the application server you are using for the mid tier, perform the following
steps:
a. ServletExec Choose NewAtlanta > Administration and verify that the ARSYS
application is installed.
b.
BMC Atrium Core 9.0
Page 2110 of 2268
2.
Home
b. Apache Tomcat From the Control Panel on your Windows computer, verify that the
Apache Tomcat service is started.
By default, this service uses port 8080. Perform the following steps to verify if Tomcat
is set up correctly:
Type *http://server:8080* on your browser Address field. You should be able to
view the application server home page.
Verify if you have an arsys.xml file installed in your apache-tomcat\conf\
Catalina\localhost subdirectory. If you do not view this file, reinstall the mid
tier and the Apache Tomcat application server.
Tip
To restart the application server, either stop the Apache Tomcat
service or use Microsoft IIS administration to stop the ISAPI plug-in.
ServletExec is usually installed as an ISAPI plug-in.
3. Launch any of the Atrium Widgets to verify that it is working.

If the BMC Atrium Explorer is not working, see Atrium widget issues for troubleshooting
steps.
BMC Atrium Core console or widget error messages

This section provides a list of error messages that might be generated when you access BMC
Atrium Core Console or Atrium Widgets.
Troubleshooting ARERR 9280

You are attempting to connect to a server that is not configured in the AR System server list.
The error message is Mid tier authentication error.
1. Make sure that the server name you specify in the server name field exists in the mid tier AR
System server list.
2. Verify that adding a short name, such as RoboServer and a fully qualified name, such as
RoboServer.mydomain.com works.

The login credentials that you specified for the mid tier might be incorrect.
BMC Atrium Core 9.0
Page 2111 of 2268
Home
The error message is Server not present in the configured servers list <
serverName>.
1. From the Start menu, choose Programs > Action Request System > BMC Remedy Mid
Tier > Configure ARSYSTEM on localhost.
2. Enter the password in the BMC Remedy Mid Tier - Configuration Tool login window.
3. Click the AR Server Settings link.
4. Check DELETE/EDIT for your server in the AR Server Settings table and click Edit.
5. Enter your mid tier administrator password in the Admin Password field.
6. The password you specify on this window must match with the password in the Connections
Settings tab of the BMC Remedy AR System Administration: Server Information form.
7. For more information about configuring mid tier password settings, see Changing the mid tier
configuration password.

This error might occur if you did not specify the correct password or Data Visualization Module
server name in the mid tier, or if you did not install BMC Atrium Core on the Data Visualization
server.
The error message is No module with name "AtriumWidget" was found in the
following configured module server [] .
To resolve this module name not found error:
If no server name was specified in the error message, provide a server name in the Data
Visualization Module Server (s) field on the General Settings page in the BMC Remedy Mid
Tier Configuration Tool.
Make sure that BMC Atrium Core is installed on the server that you specified in the Data
Visualization Module Server (s) field.
BMC Atrium Core plug-in issues

Several BMC Atrium Core plug-ins are installed and configured during the BMC Atrium Core
installation.
Plug-in Instances
Plug-in Configuration
Advantages of centralized configuration
Troubleshooting plug-in issues
Plug-in Instances
There are two instances of BMC Atrium Core plug-ins:
BMC Atrium Core 9.0
Page 2112 of 2268
Home
Normalization Engine plug-in server (this is a dedicated plug-in server)

Shared plug-in server (this server loads the following plug-ins)
Atrium Impact Simulator plug-in
Deprecation plug-in
Notification plug-in
Event Engine plug-in
Service Context plug-in
Unified Service Modeling plug-in
Dynamic Service Modeling plug-in
Plug-in Configuration
For versions earlier to 9.0, the pluginsvr_config.xml file and ar.cfg file is used to make any
changes to the plug-in configuration.
From version 9.0, the plug-in configuration is read from the pluginsvr_config.xml file and ar.cfg
file only during the start up of BMC Remedy AR System server. To make any changes to the
plug-in configuration, use the AR System Administration: Plugin Server Configuration form and
AR System Administration: AR System Configuration Generic UI form.
Note
From 9.0 onwards, you should avoid editing the pluginsvr_config.xml file, ar.cfg file and
log4j_pluginsvr.xml file.
For more information, see Updating plug-in configuration settings and see AR System
Configuration Generic UI form in BMC Remedy Action Request System documentation.
Advantages of centralized configuration

The Plugin Server Configuration form and AR System Configuration Generic UI form are
centralized configuration forms which have the following advantages:
Management of configuration data is simplified.
Sharing of configuration settings across servers is simplified.
Data is stored directly in the database and the data is more secure.
Server restart is not required after modifying the forms for logging changes.
File system access is not required.
For more information on Centralized configuration, see Centralized configuration
in BMC Remedy
BMC Atrium Core 9.0
Page 2113 of 2268
Home
Troubleshooting plug-in issues

To effectively resolve plug-in issues see the following topics:
Atrium Impact Simulator plug-in
Deprecation plug-in
Notification plug-in
Normalization Engine plug-in
Event Engine plug-in
Service Context plug-in
Unified Service Modeling plug-in
Dynamic Service Modeling plug-in
Atrium Impact Simulator plug-in troubleshooting

The Atrium Impact Simulator (AIS.FILTERAPI) plug-in is responsible for handling commands form
the user interface, organizing the simulation information and creating results. The plug-in uses the
filter interface to receive commands such as add input, update input, or simulate. The AIS plug-in is
responsible for queuing the CMDB for all the components and relationships and calculating the
impact for the simulation.
Plug-in type
Order of operations
Configuration information
Troubleshooting tips
To enable JAVA plug-in server logging
Related topics
Plug-in type
The Atrium Impact Simulator (AIS) is a Java plug-in that runs as a part of the Java plug-in server.
Order of operations
1. Init The plug-in reads the configuration and logs the AIS and environment information. It
also determines the BMC Remedy AR System server and port that it needs to connect to run
the queries.
2. New simulation This call takes place when a record for the form AIS:Simulation is created
. The plug-in logs into the AR server with the Remedy Application Service User, then
impersonates the user that created the simulation.
3. Add Input The instance ID and the dataset ID are passed in whenever a record for the
AIS:SimulationCis form is created. The AIS plug-in then checks if it has already queried for
the model for this Configuration Item (CI) in the cache. If it has not, then it queries to get
information about the head CI. Then, performs a graphwalk query to all the CIs that are
consumers of this CI with relationships that have impact (versions earlier to 7.6.03 used
BMC Atrium Core 9.0
Page 2114 of 2268
3.
Home
graph query API and BMC_Impact relationships). For each CI and relationship returned the
plug-in converts the information to an AISInstance and adds them to the plug-in's
AISImpactEngine for later calculations.
4. Simulate When the record for the AIS:Simulation has a filter command set to simulate,
this information is passed to the AIS plug-in.
5. The plug-in then checks if it matches two criteria:
Do any of the models have a non default value for impact computation model or
propagation model?
Do all the inputs have the same status?
If both of these criteria are met, the AIS plug-in recognizes that the results are the
same as the query and that the status will be the same as the inputs. If the criteria are
not met then the plug-in sets the status of the Configuration Items (CIs) in the
AISImpactEngine of the plug-in and start the calculations. The plug-in will retrieve the
results and create records in AIS:SimulationCis with the information and the record
type set to Result. During this process it updates the progress in the AIS:Simulation
form. When the simulation is complete it sets the progress to complete. This progress
is used by the user interface to display the progress to the user in the progress screen
that closes when the simulation is complete.
6. Make CSV While integrating with Change Management, the plug-in can create a CSV file
based on the results. This file is created in the temporary servers directory then attached to
the AIS:Simulation record for that simulation.
BMC Atrium Core 9.0
Page 2115 of 2268
Home
The AR System Administration: Plugin Server Configuration form contains the basic
information of the plug-in that is loaded by the plug-in server. It also contains some configuration
information. The configuration information that can be changed by the user are described below.
BMC.ARDBC.ATRIUM.AIS.userDefined.override_ar_server_host By default the AR server
used by the plug-in will be the one listed in the one in ar.conf. The user can override this by
changing this setting.
BMC.ARDBC.ATRIUM.AIS.userDefined.override_ar_server_port By default the port for
the AR server will be the one listed in the one in ar.conf. The user can override this by
BMC.ARDBC.ATRIUM.AIS.userDefined.override_ar_system_user By default the user
credentials used for connecting to AR are treated as Remedy Application Service User
credentials. You can use other user credentials for this.
Tip
The new user needs to be an administrator though.
BMC.ARDBC.ATRIUM.AIS.userDefined.override_ar_system_password The password for

the Remedy Application Service User is read and decrypted from the ar.conf file. The user
can override this value. If the value is found to be in plain text it will be read in and replaced
with the encrypted version.
allow_loops The AIS front end gives an error message if the AIS cell finds a loop in the
model. This is consistent with the documentation that AIS does not support models with
loops. It is possible to turn off this error message.
See Updating plug-in configuration settings.
Most of the issues that have been encountered can be diagnosed by looking at the log for
the plug-in (ais.log).
If the ais.log file located at ...AtriumCore/Logs/ does not contain enough information it may
be necessary to change the log level to include debug messages in the log. This logging
also provides many timing metrics for performance issues. To turn on debugging for AIS.
To enable JAVA plug-in server logging

1. Open the AR System Administration: Plugin Server Configuration form.
2.
BMC Atrium Core 9.0
Page 2116 of 2268
Home
2. On the Plugin Server Configuration tab change the logging level from INFO to DEBUG.
See Logging Configurations in Setting plug-in server options
Request System documentation.
in BMC Remedy Action
3. Click Apply.
Related topics
Deprecation plug-in troubleshooting

The primary purpose of the Deprecation plug-in (BMC.ARDBC.DEPRECIATION.PLUGIN) is to
support the create, read, update, delete operations on instances in the deprecated classes in the
BMC Atrium CMDB. When a class is deprecated by a later version of the Configuration
Management Database (CMDB), the deprecation plug-in handles BMC Atrium CMDB API calls
from client apps using the old class.
Plug-in type
Plug-in initialization
AR System server connectivity
Troubleshooting steps
Plug-in type
The Deprecation plug-in is a Java-based ARDBC plug-in, which is available for versions 7.6.03 and
later. It loads in the Shared plug-in server for BMC Atrium Core.
Plug-in initialization
In the initialization code, to create a connection pool for BMC Remedy AR System server, CMDB
spawns a thread, and creates some AR Server connections for Remedy Application Service users
which are used internally. This thread loads the CMDB metadata cache which is used internally.

The deprecation plug-in connects to AR System server for the getEntry() and
getListEntryWithFields() calls. The get calls on the deprecated class invokes the server
again.
The Deprecation plug-in receives its configuration from the following, it refers to AR System
Administration: AR System Configuration Generic UI form for the following parameters
Server-Connect-Name
Server-Name
TCD-Specific-Port
BMC Atrium Core 9.0
Page 2117 of 2268
Home
The properties for the Remote Procedure Call (RPC) queue for CMDB as well as for AR System
are read from the AR System Administration: Plugin Server Configuration form. The server
name, user name and password properties can also be overridden via this form. The default time
interval for checking the CMDB cache is set as 15 minutes in this file, which can be changed.
See Updating plug-in configuration settings and see AR System Configuration Generic UI form
BMC Remedy Action Request System documentation.
in
Troubleshooting steps
Enable server-side API, filter, and SQL logging.
Check the filter log for a message like this:
The specified plug-in does not exist.
BMC.ARDBC.DEPRECATION.PLUGIN
The message generates an ARERR 8755 error.
If you see the message, verify that the AR System Administration: AR System
Configuration Generic UI form has the plug-in entry:
Server-Plugin-Alias: BMC.ARDBC.DEPRECATION.PLUGIN
BMC.ARDBC.DEPRECATION.PLUGIN <server-name>:9556
On the server, verify that AtriumPluginServer is running and the plug-in file deputilplugin<
versionNumber>.jar file is in the installPath/AtriumCore/cmdb/plugins/deprecation
folder.
BMC Atrium Core 9.0
Page 2118 of 2268
Home
Check the AtriumPluginServer.log file in the installPath/AtriumCore/Logs folder to check

if there is any exception caused by this plug-in. If there is an exception, then fix the cause of
this exception and restart the server.
Enable logging for the Depreciation plug-in.
2. On the Plugin Server Configuration tab change the logging level from INFO to
DEBUG. See Logging Configurations in Setting plug-in server options
Remedy Action Request System documentation.
in BMC
3. Click Apply.
Notification plug-in troubleshooting

The name of the Notification plug-in is BMC.FILTERAPI.NOE. Applications that rely on
Configuration Item (CI) and relationship data stored in BMC Atrium Configuration Management
Database (BMC Atrium CMDB) sometimes needs to know whether CIs and relationships have been
added, changed, or deleted.
For example, you might provide an email service using multiple servers. Any change to these
servers could impact the email service. Consuming applications, such as an email service
monitoring application, might have the logic to identify the potential impact of changes to the
servers, but they first must be notified of the changes to those servers.
The Notification Engine enables you to define the context in which CIs and relationships are
considered to be important, and enables applications to be notified whenever a relevant change is
made to those CIs and relationships.
Plug-in type
BMC Remedy AR System and Notification Engine error messages
Plug-in type
The Notification plug-in is a Java plug-in that runs as a part of the Java plug-in server and is named
BMC.FILTERAPI.NOE.

The Notification plug-in connects to the BMC Remedy AR System server using the BMC Remedy
AR System Java API.
The Notification plug-in receives its configuration from the following:
The AR System Administration: AR System Configuration Generic UI form allows
enabling / disabling the plug-in functionality
BMC Atrium Core 9.0
Page 2119 of 2268
Home
Need to add the parameter QRD-Enabled: T (T for enabling and F for disabling)
See AR System Configuration Generic UI form in BMC Remedy Action Request System
documentation..
The AR System Administration:Plugin Server Configuration form allows configuring the
plug-in.
Details of the plug-in parameters
Note
The AR System Administration:Plugin Server Configuration form allows

configuring the logging.
Notification Engine code, forms, and workflow objects use QRD and NOE
nomenclature.
BMC Remedy AR System and Notification Engine error messages

BMC Remedy AR System and Notification Engine error messages you might encounter most often
when using the Notification Engine.
Notification Engine server error information is logged in the CMDBInstallDirectory/Logs/
noeapi.log file. Enable server side plug-in logging by setting debug level in the log4j configuration
file mentioned above.
BMC Atrium Core 9.0
Page 2120 of 2268
Home
Common error messages found while using the Notification Engine

Error
Description
140505
This Notification Engine error message indicates that the specified Subscription ID does not exist. This error can appear
when you make a getNotifications call or attempt to unsubscribe using an invalid ID.
140506
This Notification Engine error message indicates that the client request cannot be completed because of one of the
following reasons:
The query execution timed-out from the BMC Remedy AR System or your database.
The load on the server is heavy.
Let your system stabilize, and wait for the server load to lessen. If the problem persists, other applications (such
as BMC Remedy Mid Tier, BMC Atrium Explorer, and so on) are likely to experience similar problems, and you
might need to restart your BMC Remedy AR System and Notification Engine computers. If the problem was
caused by a BMC Remedy AR System timeout, set the client timeout values on the ARServerUser object as
follows:
ar.setTimeoutLong(arg0);
ar.setTimeoutNormal(arg0);
ar.setTimeoutXLong(arg0);
140507
This Notification Engine error message indicates that the subscription request failed due to runtime exceptions. Try your
subscription request again. If the problem persists, review the server log to investigate the problem.
140508
This Notification Engine error message indicates that the subscription request failed because the subscription query is
taking too long to process.
Consider making your query into smaller, sub-queries to avoid timeouts during subscription and at run time. Once you
have reduced the large query into smaller pieces, attempt your subscription again. Additionally, you can set the client
timeout values on the ARServerUser using the following parameters:
140509
This Notification Engine error message indicates that the query execution timed-out from the BMC Remedy AR System
or your database. Set the client timeout values on the ARServerUser object using the following parameters:
140510
This Notification Engine error message indicates that the Notification Engine plugin API timed out. To resolve this
problem, increase the Filter API RPC Timeout setting:
1. In BMC Remedy Mid Tier, open the AR System Administration Console.
3. On the Server Information form, click the Timeouts tab.
4. In the Filter API RPC Timeout (seconds) field, enter a higher timeout setting.
140511
This Notification Engine error message indicates that the password used to connect the Notification Engine plugin
server to the BMC Remedy AR System server is incorrect. If you change the BMC Remedy AR System Application
Service password, you must also change that password in the Notification Engine plugin configuration file. Because the
password is encrypted, complete the following procedure to ensure that the passwords for the Notification Engine plugin
server and BMC Remedy AR System server are the same:
1. Open the BMC Remedy AR System configuration file ( ar.cfg on Microsoft Windows and ar.conf on UNIX) for
editing.
2. Copy the encrypted password of the Remedy-App-Service-Password line.
3. Open the installationDirectory/AtriumCore/cmdb/plugins/shared/ pluginsvr_config.xml file for editing.
BMC Atrium Core 9.0

4.
Page 2121 of 2268
Home
Error
Description
4. In the <! Plugin for Notification engine --> section, paste the encrypted password between the
opening and closing <ar_system_password> tags.
5. Save the pluginsvr_config.xml file.
Normalization Engine plug-in troubleshooting

The primary purpose of the Normalization Engine plug-in (BMC.FILTERAPI.NORM.ENGINE) is to
normalize the instances using the Product Catalog data. Based on the product catalog entry this
plug-in normalizes the Category, Type, Item values of a Configuration Item (CI). This plug-in can
also help creating the product catalog if needed. This plug-in runs on all the servers in a
server-group environment, however only the Administration server schedules jobs at the start-up.
Normalization modes
BMC Atrium Core normalization functionality
Plug-in type
Normalization Engine plug-in issues
Normalization modes
Normalization can be done in three different ways:
Inline mode In this mode, the normalization of CI is done before it gets saved in the
system. This is a synchronous operation and user can experience a wait when creating a CI.
Continuous mode In this mode, normalization of CI will be done after CI gets saved in the
system. In this mode CI's can be processed by either based on time interval or based on
number of CIs.
Batch mode In this mode, all the CI's of the classes that are configured for normalization
will be normalized in batch mode. Using this mode jobs can be scheduled to run at different
times to ease load on the system.
BMC Atrium Core normalization functionality

The BMC Atrium Core product version 7.6.03 and later have the following functionality which can
be configured on a dataset:
Relation Name Normalization Creates a relation name to a pre-defined name as per
CMDB best practices.
Auto Impact Feature Creates the Impact model based on the pre-defined rules.
Version Normalization feature Sets the attribute MarketVersion on the CI based on rules.
These rules are user defined.
BMC Atrium Core 9.0
Page 2122 of 2268
Home
Suite Rollup Feature Combines the products into suites for licensing purpose.
Instance Level security feature - Sets the read/write permissions on a CI based on the user
defined rules.
Note
Except for the Suite Rollup Feature all other features supports inline normalization.
Plug-in type
The Normalization Engine plug-in is a Java plug-in that runs as a part of Java plug-in Server.

The Normalization Engine plug-in connects to the BMC Remedy AR System server using the AR
System API.
The plug-in receives its configuration from the following:
Configuration for this plug-in is maintained in the AR System Administration:Plugin Server
Configuration form.
Gets Server-Connect-Name from the AR System Administration:AR System
Configuration Generic UI form in server group environments.
BMC Atrium Core 9.0
in
Page 2123 of 2268
Home
Normalization Engine plug-in issues

Following are some common errors that are frequently observed.
Plug-in server not responding

When you see the Plug-in server not responding error message, the normalization plug-in
is either not started or taking too long to respond. Check the nePluginServer.log file for the
message Initialization complete - Normalization Engine is ready to process
requests. If you do not see this error message, the plug-in has not started. At this time scan the
log file for any obvious error messages like Authentication failed or Port in use. Based
on further scanning appropriate steps can be taken.
If the plug-in starts successfully, using Normalization Engine interface change the API level to
Debug mode and perform the test again. Check the neApi.log. If you do not find entries in the log
file, it means that the plug-in is not receiving the calls.
In either scenario, involve the development team for further resolution.
When I run batch job it does not normalize all the CIs
When you run a batch job it normalizes only Failed CIs, Not Normalized, and Modified since last
normalization CIs only. If you want to normalize all the CIs, check the Normalize all instances flag
in the SystemConfig tab and restart the job.
Server group environment NE is not connecting

Normalization plug-in uses Server-Connect-Name from AR System Administration:AR
System Configuration Generic UI form in the server group environment. Make sure that it can be
pinged from the machine where Normalization Engine plug-in is running.
Normalization provides logging information for different modes of normalization. This plug-in has
API logging, Continuous logging, and Batch mode logging. Based on the need of the situation
appropriate logging can be turned to Debug level using the Normalization interface. All the log files
are stored in the <InstallerFolder>/AtriumCore/Logs folder.
The log file details are given below:
Neapi.log API logging
neContinuous.log Continuous mode logging
neBatch.log* Batch mode logging
nePluginServer.log General plug-in related errors
BMC Atrium Core 9.0
Page 2124 of 2268
Home
Event Engine plug-in troubleshooting

The Event Engine (BMC.FILTERAPI.EVENT_ENGINE) plug-in is also called the Event Engine
Channels plug-in. The plug-in provides a near real-time, responsive and scalable, publish and
subscribe mechanism for notifying changes to Configuration Items (CIs) stored in BMC Atrium
BMC Atrium CMDB Core Event Channels diagram
Event flow for a subscriber
Event flow for a publisher
BMC Atrium CMDB Core Event Channels diagram

The following diagram presents the key modules that implement the BMC Atrium CMDB Core
Event Channels. Each of the modules is described in details in the subsequent section.
Note
BMC Atrium Core 9.0
Page 2125 of 2268
Home
Currently BMC supports changes done by BMC Atrium CMDB only. Other channels such
as Complex Query Processor, DSM/AUI/NE, and RE are not implemented but shown for
conceptual clarity.
Event flow for a subscriber

At a high level, the following are the flow of events for a subscriber:
1. A subscriber subscribes to a channel, for example, CMDB CI Feed Channel
2. An internal connection is established with the event delivery mechanism (AR Alert) and
ensured that a call back routine (that implements a known event interface, described in later
sections) is available.
3. When the event, in our example above, a CI Change event for an instance of
BMC_ComputerSystem class, is received by AR Alert, it calls the call back routine and
passes the CI Change Event object.
4. The call back routine, to be written by the subscriber, calls the getChangedCI() function
on the CI Change Event object which returns in the current example, a CMDBInstance
object representing the changed CI of the BMC_ComputerSystem class.
5. The event contains all the system wide configured attributes. If the subscriber application is
interested in all ComputerSystems except Desktops and Laptops, it can check primary
capability attribute to discard all CI's that represent Desktops & Laptops and process all
other CI's.
Event flow for a publisher

At a high level, the following are the flow of events for a publisher:
1. CMDB Server detects a newly created CI.
2. CMDB Server creates a new entry in the CI Event Form containing the relevant information
about this CI using the Publisher API.
3. The Publisher API checks if the class is configured for change events, then looks at the
system-wide configuration of attributes for the specific class, and stores only those attributes
as name-value pairs in a field on the CI Event form.
4. The creation of this entry triggers a filter API call on the Event Engine (a filter Plug-in).
5. The Event Engine keeps the entry in a queue specific to the CI Events and returns the call.
6. A background thread in the plug-in fetches the entry, picks up the subscribers for the CI
Channel, builds a string message that contains relevant data, and creates a new alert (
containing the message) in the Alert Event Form.
7. AR Alert picks up this event and sends it to the intended subscriber the subscriber then
processes the event.
8. The subscriber then processes the event.
BMC Atrium Core 9.0
Page 2126 of 2268
Home

The Event Engine plug-in connects to the BMC Remedy AR System server using the BMC Remedy
AR System Java API.
The plug-in receives its configuration from the following:
The AR System Configuration Generic UI form allows enabling and disabling the plug-in
functionality.
See AR System Configuration Generic UI form in BMC Remedy Action Request System
9.0 documentation.
The AR System Administration:Plugin Server Configuration form allows configuring the
plug-in.
Enable the server side plug-in logging by setting the logging level to DEBUG.
2. On the Plugin Server Configuration tab change the logging level to DEBUG. See Logging
Configurations in Setting plug-in server options in BMC Remedy Action Request System
documentation.
3. Click Apply.
BMC Atrium Core 9.0
Page 2127 of 2268
Home
Service Context plug-in troubleshooting

The Service Context (BMC.ARDBC.ATRIUM.SERVICECONTEXT) plug-in is the backend logic that
supports BMC Atrium Service Context. For more information about BMC Atrium Service Context,
see Overview of BMC Atrium Service Context .
Plug-in type
Related topics
Plug-in type
The Service Context plug-in is a Java-based ARDBC plug-in.

This plug-in is invoked whenever there is a request going to the vendor form, CMDB.SC:
ServiceContextAPI, or federated class, BMC.FED:Servicecontext.
The configuration information for Service Context is documented in Additional configuration steps
for BMC Atrium Service Context. .
The configuration information is logged in the AR System Administration:Plugin Server
Configuration form.
BMC Atrium Core 9.0
Page 2128 of 2268
Home
The AR System Administration: Plugin Server Configuration form contains the
configurations for the logs that can be used for troublehsooting. For more information, see
Logging Configurations in Setting plug-in server options
For the Service Context plug-in, the default logger is com.bmc.atrium.federation.srvcctx

and its appender is bmc.servicecontext.appender.
Related topics
Unified Service Modeling plug-in troubleshooting

The primary purpose of the Unified Service Modeling (USM) plug-in is to provide an interface that
offers convenience for working with business services. This plug-in provides an interface for BMC
Remedy AR System applications like BMC Service Request Management and BMC Cloud Lifecycle
Management to access USM related features through the vendor form. The plug-in name is
BMC.ARDBC.ATRIUM.API.
Important
The USM plugin is used for specific purposes in BMC products and it cannot be used for
any other purpose in this release.
Plug-in type
Communication with back office applications
How to turn on logging for debugging
Plug-in type
The Unified Service Modeling plug-in is a Java-based ARDBC plug-in available in BMC Atrium
Core versions 7.6.04 and above. This plug-in is for internal BMC usage.
Communication with back office applications

The USM plug-in invokes the USM functionality through the getListEntryWithFields and
getEntry queries that are performed against the vendor form CMDB:USMAPIInterface. Queries
are passed as a series of parameters and values, where the first parameter indicates the USM API
function to perform. For example: "function" = "cmdbROCreate".
BMC Atrium Core 9.0
Page 2129 of 2268
Home
The general syntax for the query is:

"parameter1" = "value1" AND "parameter2" = "value2" AND ...

AR Server invokes this plug-in when you issue queries against the vendor form CMDB:
USMAPIInterface. The USM plug-in makes CMDB/AR APIs using the plug-in context that is passed
through the ARDBC interface (getListEntryWithField, getEntry, and so on).
The USM plug-in receives its configuration from the AR System Administration:Plugin Server
Configuration form.
The following table lists the supported configuration parameters:

User Defined Elements
Default Value
BMC.ARDBC.ATRIUM.API.userDefined.perform_reconcile
false
BMC.ARDBC.ATRIUM.API.userDefined.golden_dataset
BMC.ASSET
BMC.ARDBC.ATRIUM.API.userDefined.reconcile_jobname
BMC Sample - Identification and Merge
BMC.ARDBC.ATRIUM.API.userDefined.reconcile_dataset_source
BMC.SAMPLE
BMC.ARDBC.ATRIUM.API.userDefined.reconcile_dataset_target
BMC.ASSET
BMC.ARDBC.ATRIUM.API.userDefined.reconcile_wait_interval
BMC.ARDBC.ATRIUM.API.userDefined.reconcile_wait_in_secs
20
The AR System Administration:AR System Configuration Generic UI form should have the
configuration information as follows:
BMC Atrium Core 9.0
Page 2130 of 2268
Home
Server-Plugin-Alias: BMC.ARDBC.ATRIUM.API BMC.ARDBC.ATRIUM.API <host name>:port number

in
The logs related to USM plug-in can be found in the following locations:
Atrium shared plugin server log <cmdb install>\Logs\AtriumPluginsvr.log
USM plugin log <cmdb install>\Logs\atrium-ar-kit-USM.log
How to turn on logging for debugging

3. Click Apply.
Dynamic Service Modeling plug-in troubleshooting

The Dynamic Service Modeling (DSM) plug-in is the background engine that wakes up periodically
and queries to see if there are any new Configuration Items (CIs) or modified CIs that meet the
criteria in the saved queries for a specified CI. If a CIs is found, a relationship is created to relate it
to the specified CI. It uses its own sandbox dataset to make changes and then runs an
Reconciliation Engine job to BMC.ASSET. For more information on this feature, see Service model
overview and related child pages.
DSM plug-in allows you to dynamically relate physical CIs to a technical service. For example, the
Web Farm Technical service could have a query that finds any web server with web_aus_ in the
front part of the name.
Plug-in type
Related topics
Plug-in type
The Dynamic Service Modeling plug-in is a Java plug-in that runs as a part of Java plug-in server.

The DSM plug-in uses the Atrium Shared java plugin server, which uses shared code from the
BMC Remedy AR System Java plug-in server (but runs as its own process). DSM connects to the
server using the system administrator credentials in ar.conf file.
BMC Atrium Core 9.0
Page 2131 of 2268
Home
It is a background process configured to be a filter on the configuration forms for DSM, which
allows the process to dynamically react to configuration changes made by the User Interface. It
also has a timer that periodically wakes up and performs the queries to see if anything is new. This
time period can be specified by you.
The Dynamic Service Modeling plug-in receives its configuration from the following:
The AR System Administration: AR System Configuration Generic UI form has the
plug-in connection information as the user name and password used to connect to AR
System server.
Armonitor.cfg runs the Atrium Shared plug-in server.
AR System Administration: Plugin Server Configuration form contains the configuration
information of the DSM plug-in.
If there are authentication errors in a server group environment, navigate to the AR System
Administration: Plugin Server Configuration form and on the Plugin Server
Configuration tab you can change the following User Defined Elements:
DSM.FILTER.userDefined.override_ar_server_host By default the AR server used
by the plug-in will be the one listed in the one in ar.conf. You can override this by
DSM.FILTER.userDefined.override_ar_server_port By default the port for the AR
server is the one listed in the one in ar.conf. You can override this by changing this
setting.
DSM.FILTER.userDefined.override_ar_system_user By default the user used to
connect to the AR System is the Remedy Application Service User. You can use
different user credentials for this. However, the new user needs to be an administrator
.
BMC Atrium Core 9.0
Page 2132 of 2268
Home
DSM.FILTER.userDefined.override_ar_system_password The password for the

Remedy Application Service User is read and decrypted from the ar.conf file. You can
override this value. Enter the new password, save the file, and restart the AR System
server. When the DSM plug-in loads it reads in the plain text password, encrypt it, and
write it back to the file so that the password is no longer in plain text.
in
<AtriumCore>/logs/dsm.log, <AtriumCore>/Logs/AtriumpluginSvr.log, and
AtriumCoreSvr.log file log errors if any.
To set the log level:

3. Click Apply.
Related topics
Updating plug-in configuration settings

You can modify the configuration information for the Normalization Engine plug-in and Shared
plug-ins using the Plugin Server Configuration form.
To modify the plug-in settings

1. Open the BMC Remedy AR System Administration Console and navigate to System >
General > Plugin Server Configuration.
2. Select the Plugin Server Instance for the plug-in.
BMC Atrium Core 9.0
Page 2133 of 2268
Home
For example:
If the Normalization Engine plug-in is running on <Host> and <Port1>, Plugin Server
Instance is as follows:
PluginServer_<Host>_<Port1>
If the Shared plug-in, is running on <Host> and <Port2>, the Plugin Server Instance is
as follows:
PluginServer_<Host>_<Port2>
3. Click the Plugin Configuration tab, and from the Plugins list, select the plug-in. For more
information on Plugin Configuration tab, see Working with Java plug-ins
in BMC Remedy

4. Click Modify.
5. In the Modify Existing Plugin form, modify the data as needed.
BMC Atrium Core 9.0
Page 2134 of 2268
Home
For example, in the User Defined Elements section, perform the following:
To edit the setting value, select a user-defined element and edit the Setting Value.
To add an element, click the plus sign and enter the following information:
Setting Name Use the following syntax (note that pluginName is
automatically populated based on the value entered in the Plugin Name field):
pluginName.userDefined.settingName
Setting Value You must define values for both Setting Name and Setting
Value. (Note that if you add two values for the same setting name, only the first
value is applicable.)
6. Click OK.
For more information on Plugin Server Configuration tab and Global Plugin Server
Configuration tab see Setting plug-in server options and Setting global plug-in server options
in BMC Remedy Action Request System documentation.
BMC Atrium Core miscellaneous issues

The following topics provide troubleshooting information about miscellaneous issues, such as,
auditing, class form generation, permissions, and federation interface issues:
Data decompression issue in cmdbdriver
Data Visualization Form module issue
Verifying version information for BMC Atrium CMDB components
Web services startup issue
BMC Atrium CMDB permission issues
Business service CIs not available in the Service Catalog issue
Auditing issues
Class form generation issues
Atrium Impact Simulator permissions issue
BMC Atrium Core 9.0
Page 2135 of 2268
Home
Federation issues
Troubleshooting Data load or Performance Issue in Atrium Core
Data decompression issue in cmdbdriver

If you are using the cmdbdriver program to retrieve data in bulk and it returns a large chunk of
data, you might receive an error message that states, Decompression has failed. For
example, you might receive this error with cmdbdriver commands such as impdt and gli.
The Decompression has failed error occurs when a result-set returned from the BMC Atrium
CMDB database to the BMC AR System server was too large to decompress.
To resolve this issue, make sure that there is enough space available for the AR System server in
the %TEMP% and %TMP% directories.
Data Visualization Form module issue

If the Data Visualization Form module that you created and the BMC Atrium Core module use
different versions of the same third-party open-source library, you might receive an error message.
Because the BMC Remedy Mid Tier (mid tier) expects only the library versions that the BMC Atrium
Core module uses, it generates an error message when it finds different versions.
For example, you might have a Data Visualization Form module that uses the commons-lang
version 2.1 third-party library for Apache Commons, which is different from the commons-lang
version 2.4 that BMC Atrium Core uses.
To avoid this issue, deploy only those versions of third-party libraries on the mid tier that BMC
Atrium Core uses.
Verifying version information for BMC Atrium CMDB

components
When troubleshooting issues with BMC Atrium Core or when contacting Customer Support, you
might require version information, such as version number, and the build date and time of various
BMC Atrium CMDB components.
To view product version information
To view C API version information
To view Java API version information
To view product version information

You can view the BMC Atrium CMDB (as well as other products) version installed in your
environment by querying the SHARE:Application_Properties form.
BMC Atrium Core 9.0
Page 2136 of 2268
Home
To view C API version information

For the BMC Atrium CMDB C API, you can view the version information from Windows Explorer.
1. On Windows, navigate to the sdk\bin subdirectory of your BMC Atrium Core installation
directory.
2. Right-click any DLL file (for example, cmdbapi77.dll ) and choose Properties from the menu
.
3. Click the Details tab.
4. The CMDB C API version number is displayed in the Product Version field.
Note
The version information for the C API is not available on UNIX systems.
To view Java API version information

1. Open a command-line window and navigate to the appropriate directory:
Windows Program Files\BMC Software\AtriumCore\cmdb\sdk\bin .

UNIX BMC Software/AtriumCore/cmdb/sdk/bin .
2. Type java -jar cmdbapi77.jar.
Note
On Windows, you can view the version information for JAR files, such as
cmdbapi77.jar, by double-clicking the file.
From the command line, the version information for the BMC Atrium CMDB Java API is displayed
information as follows:
BMC Atrium Core 9.0
Page 2137 of 2268
Home
By right-clicking the .jar file from Windows, the version information is displayed as follows:
Web services startup issue

If you have installed web applications that use the BMC Atrium CMDB Java APIs on a single
application server, you might not be able to run the BMC Atrium Core web services successfully.
For example, if you are running the BMC Atrium Console and the BMC Atrium CMDB web service
on the same instance of Apache Tomcat, you might encounter this issue.
Two web applications that use the same java classes to load native object libraries cannot coexist
on an application server, unless the native object libraries are pre-loaded from a common location.
To resolve this issue, deploy the BMC Atrium CMDB web service and the mid tier on separate
application server instances.
BMC Atrium CMDB permission issues

When working with BMC Atrium CMDB, you might encounter issues with accessing data by using
the BMC Atrium Core Console, such as classes not being visible in the list of objects.
The following table lists various scenarios in which you might encounter a permissions issue and
provides information about how to resolve the issue. For more information about BMC Atrium
CMDB permissions, see Managing permissions in BMC Atrium Core .
Troubleshooting permissions issues in BMC Atrium CMDB

Error description
Solution
Can view the class in the list of objects, with its attributes, but cannot view
the instances of the class.
Make sure that you have CMDBRowLevelSecurity

access.
Can view the class in the list of objects, with its attributes, and can view
the instance; cannot modify the instances of the class.
Make sure that you have the CMDB Data Change

and CMDBWriteSecurity access.
Can view the class in the list of objects, with its attributes, and can view
the instances of the class; modifying the instances of the class results in a
permissions error.
Make sure that you have CMDBWriteSecurity

access, CMDB Data Change role, and Change
permission for the attribute.
Cannot view the class in list of objects.
Make sure that you have the CMDB Data View role
and Visible permission for the class.
BMC Atrium Core 9.0
Page 2138 of 2268
Home
Error description
Solution
Can view the class in list of objects, but cannot view the attributes of the
class.
Make sure that you have the Attribute View

permission.
Can view the class in list of objects, but cannot modify the instance data
Make sure that you have CMDB Data Change role
by using workflow started in another class.
and CMDBWriteSecurity access.
Business service CIs not available in the Service Catalog issue

If you created a BMC_BusinessService Configuration Item (CI) using the BMC Atrium Explorer
or any other BMC application, and did not specify the ServiceType attribute, the CI might not be
available in the Service Catalog. This is because the Service Catalog displays only instances of
BMC_BusinessService where the attribute is set to BusinessService or TechnicalService
.
Other BMC applications that create BMC_BusinessService CIs, such as BMC Atrium Explorer
and BMC Impact Model Designer, do not correctly set the value for ServiceType. To make sure
that your BMC_BusinessService CIs appear in the Service Catalog, use the Service Catalog to
create them. If an existing business service CI does not appear in the Service Catalog, edit the
value of ServiceType to make it appear.
Auditing issues
If you do not see any audit history for your class definitions even though you have configured the
correct audit options, perform the following procedure to troubleshoot the issue. For information
about how to use the auditing feature, see Tracking changes to CIs and relationships .
To troubleshoot Copy Auditing issues
To troubleshoot Audit form issues
To troubleshoot Log Auditing issues
To troubleshoot other Auditing issues
To troubleshoot Copy Auditing issues

Verify that the audit form exists in BMC Remedy Developer Studio. The naming convention of the
form is <classFormName_AUDIT>. The audit form is created when you synchronize the class.
To troubleshoot Audit form issues

1. Enable API logging.
2. Examine the cmdbengdebug.log file for any errors.
This log file is located in the Program Files\BMC Software\ARSystem\Arserver\Db
subdirectory of your installation directory.
To troubleshoot Log Auditing issues

1. Verify that a log form is specified for the class.
2.
BMC Atrium Core 9.0
Page 2139 of 2268
Home
2. Verify that the audited values are saved in a Diary field.

3. Enable filter logging to save information about Log Auditing operations.
If you enable API and SQL logging options, log files are created under the program files\
ARSystem\Arserver\db subdirectory of your installation directory by default ( Windows ) or <
serverInstallationDirectory>/db (UNIX ).You can change their file names and location at
any time.
To troubleshoot other Auditing issues

1. Verify that the Audit Type field on the Auditing tab of the class is set to either Copy or Log.
2. Verify that the qualification specified in the Qualification field on the Audit tab of the class
executes with no errors.
3. Examine the attributes that have the Audit Option set to either Audit or to Audit and Copy.
If you encounter an error when saving an instance of the class, it means that the changes
that you made to the class definitions are incorrect and auditing will not be performed for the
class.
Class form generation issues

This section provides troubleshooting information about the Sync-UI utility that enables you to
synchronize forms in BMC Atrium Configuration Management Database (BMC Atrium CMDB) with
other BMC applications. For more information about generating forms, see Generating forms for
other applications.
CMDB Sync-UI command issues
About warnings generated when synchronizing BMC Atrium CMDB forms with other BMC
applications
CMDB Sync-UI command issues

When you synchronize the BMC Atrium Core class forms with the forms in other applications by
using the Sync-UI command, you might encounter errors, such as a missing entry in the Application
Pending form, or corresponding BMC Atrium Core forms not created in the other application. Use
the following procedure to troubleshoot these issues.
See Generating forms for other applications for more information.
Warning
Do not open the updated forms in BMC Remedy Developer Studio when synchronization
is in progress. The BMC Remedy AR System server uses the Admin thread to open forms
and perform the synchronization process. Therefore, if you try to open forms during the
synchronization process, you might encounter performance issues and the data in the
forms might be incomplete.
BMC Atrium Core 9.0
Page 2140 of 2268
Home
To troubleshoot CMDB Sync-UI issues

1. When you create a class in BMC Atrium Configuration Management Database (CMDB),
verify that a record is created in the SHR:SchemaNames form.
2. After you click the Update Asset UI button, verify that a record is created in the Application
Pending form.
3. Verify that the arcmdbd server process is running.
Tip
To view the processes that are running on a Windows computer, open the Task
Manager and click Processes. On UNIX, type the ps -ef command at the prompt.
4. Examine the arerror.log file for any errors logged for the arcmdbd server process.
For more information about arerror.log, see AR System server logging.
5. Verify that the record in the Application Pending form is deleted.
After the arcmdbd server process starts, it deletes the record.
6. Examine the output in the CMDBSynchronizeUI_<integer>.log file.
A log file using this naming convention is created when the user interface in the BMC
Remedy Asset Management application is updated. This log file is located in the
AtriumCore\logs folder of your installation directory.
Tip
If you do not see an Application UI synchronization completed entry in
the log file, the operation is still in progress.
7. Verify that the CMDB shared library file is in the same directory as the arcmdbd server
process. The CMDB shared library file name is one of the following depending on your
environment:
(Unix ) libcmdb2asset.sl (also, possibly with .so or .dll extensions)
(Windows ) cmdb2asset_win64.dll
8. If the synchronization process was not successful, view the arapi.log or arsql.log file for
detailed information about any errors that might have occurred.
If you enable API and SQL logging options, log files are created under the program files\
ARSystem\Arserver\db subdirectory of your installation directory by default ( Windows ) or <
serverInstallationDirectory>/db (UNIX ). You can change their file names and location at
any time.
BMC Atrium Core 9.0
Page 2141 of 2268
Home
About warnings generated when synchronizing BMC Atrium CMDB forms with
other BMC applications
When you synchronize forms in BMC Atrium Configuration Management Database (CMDB) with
other BMC applications, such as BMC Remedy Asset Management, you might receive warnings as
listed:
[DATE TIME] [WARNING] [TID: 00000n]: Could not create Field: FIELD_NAME on form
FORM_NAME on server: [SERVER] [DATE TIME] [WARNING] [TID: 00000n]: Message: Field does
not exist on current form - nnnnnnnn
These warnings, which are recorded in the CMDBSynchronizedUI.log, indicate that the resulting
UI form has a missing field. However, you can safely ignore these warnings if the field meets the
following conditions:
The field does not correspond to an attribute defined by the superclass.
The field corresponds to an attribute defined by a categorization class.
In such cases, the SyncUI process finds fields defined by a categorization class on the parent form
. You should not create these fields on the UI form because they are not defined by the super class.
Atrium Impact Simulator permissions issue

To view data and to work with the CIs in Atrium Impact Simulator, you must have the Atrium Impact
Simulator User role and the permissions to query the CIs stored in BMC Atrium CMDB. The role
and the permissions are mapped to the CMDB Data View group by default.
If you encounter a permissions issue with Atrium Impact Simulator, verify with your system
administrator that you have the required role and permissions.
Federation issues
The following topics provide information about troubleshooting federation issues:
Federation Launch Definition issues
RPC error when creating federation plug-in
Federation plug-in loading issue
Federation data class issue
Invalid column lengths in federated classes with an IBM DB2 database
Federation Launch Definition issues

For information about federation and how to configure federation data, see Configuring federated
data in BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 2142 of 2268
Home
Note
BMC Atrium Core uses the classes in the BMC.CORE.CONFIG namespaces to store
federated data. Do not modify these class definitions because doing so might cause errors
.
Federation access method--URL

1. Open a browser and paste the value in the Access String field into the Address list.
2. In the Address list, replace attribute parameters such as $Name$ with their values from the
CI.
3. Verify that the link that you specified displays the correct page.
RPC error when creating federation plug-in

When you create a plug-in to connect to an external data source for retrieving federated data, you
might encounter the following error:
Exception while processing RPC call. java.io.IOException: An established
connection was aborted by the software in your host machine at
sun.nio.ch.SocketDispatcher.write0(Native Method) at
sun.nio.ch.SocketDispatcher.write(Unknown Source) at
sun.nio.ch.IOUtil.writeFromNativeBuffer(Unknown Source) at
sun.nio.ch.IOUtil.write(Unknown Source) at
sun.nio.ch.SocketChannelImpl.write(Unknown Source) at
com.bmc.arsys.arrpc.nio.ArNioXdrTcpEncodingStream.streamFlush(Unknown
Source) at org.acplt.oncrpc.XdrTcpEncodingStream.flush(Unknown Source)...
This error occurs when the external data source that you are connecting to (for example, the Oracle
database) contains several tables and large volumes of data. To resolve this issue, add the
following parameters to the ar.cfg (ar.conf ) configuration file and restart the AR System server:
For the ardbc plug-in Server-Plugin-Default-Timeout: 120
For the filter plug-in Filter-Api-Timeout: 60
If you encounter the plug-in error even after you add these entries to the AR System configuration
file, increase the timeout period (in seconds) and retry until the issue is resolved.
Federation plug-in loading issue

When you create a federation plug-in using the Configure Repository Plugins And Adapters option
in the Federation Manager, the Loaded column in the plug-in editor displays the status of the
plug-in. A value of No in this column indicates that your plug-in did not load successfully. This issue
might occur if you provided an incorrect user name and password, or an incorrect connection string.
BMC Atrium Core 9.0
Page 2143 of 2268
Home
To troubleshoot plug-in loading issues

1. After adding the plug-in, reopen the plug-in editor to refresh the plug-in status.
If the plug-in loaded successfully, the Loaded column displays a value of Yes.
2. If the Loaded column displays a value of No, from the AtriumCore <installDir>\Logs
directory, open the AtriumPluginSvr.log file and check for errors.
3. Depending on the type of plug-in you created, open one of the following log files and check
for errors:
Federation-ar.log If you created an AR System plug-in
Federation-cmdbf.log If you created a cmdbf plug-in
Federation-jdbc.log If you created a jdbc plug-in
4. After fixing the errors, restart the AR System server and the mid tier.
5. From the BMC Atrium Core Console, open the Federation Manager and check the status of
the plug-in again.
Federation data class issue

You might receive validation errors (120186-120190), such as incorrect table or field mapping with
the external data store when you create a federated data class. These issues can occur if the
maximum length of the field in the external store does not match the field length in the federated
data class or if the table name that you specified in the plug-in adapter is incorrect.
Note
If you are unable to create a federated data class, make sure that the plug-in for your data
store is loaded. If the plug-in is not loaded, see Federation plug-in loading issue.
To troubleshoot federated data class issues

1. Log in to the AR System driver program.
For more information about logging in to the driver program, see the Developing an API
program in the BMC Remedy Action Request System online documentation.
2. To retrieve a list of external schema candidates, type the glxsc command.
3. At the Schema Type prompt, type 5 and verify that the vendor table that you created is listed
in the results.
4. To retrieve a list of external field candidates, type the gmxfc command.
5. At the Schema Type prompt, type 5.
6. At the Vendor name prompt, type the vendor name that you created.
7. At the Vendor table name prompt, specify the name of the table that you are mapping from
the external data store.
8.
BMC Atrium Core 9.0
Page 2144 of 2268
Home
8. Confirm that the properties of the external data store, such as the Field type, External
Field Name, and Maximum length, are correct.
The vendor table and field properties should match the class and attribute properties that
you specified for the federated data class.
Invalid column lengths in federated classes with an IBM DB2 database

Federation problems with an IBM DB2 database can occur under the following conditions:
When creating a federated class that brings in data from a DB2 database, you create a federated
relationship class to retrieve the data. In this federated relationship class, you create a qualification
that relates the source class in the BMC Atrium CMDB to the federated class. For example,
specifying 'Name' = $ComputerName$, creates a relationship between the Name field of the
source class and the ComputerName field of the federated class.
But when you are creating a query and the size of the field in the source class exceeds the field
column length of the federated class, a DB2 error is returned. For example, your DB2 database has
a field (FNAME ) with a column length of 10 characters. If the field referenced in the source class
exceeds 10 characters (as in 'BMC_Account_1' = Fed_Class.FNAME ), the 10-character limit
is exceeded and you see the following error:
SQLCODE -302, Error: THE VALUE OF INPUT VARIABLE OR PARAMETER NUMBER IS
INVALID OR TOO LARGE FOR THE TARGET COLUMN OR THE TARGET VALUE
To troubleshoot federated data class issues

Change the column width of the key attribute in the federated source to be equal to or greater than
the comparable field in the source class.
Troubleshooting Data load or Performance Issue in Atrium

Core
The Inline Normalization mode which is the real time mode, normalizes the CIs before they are
saved in BMC Atrium CMDB. Inline Normalization can be set for the selected dataset at the
Normalization Engine level and at the CMDB engine Level which is the system level .
BMC best practices suggest that do not turn OFF Inline Normalization at CMDB engine level. If you
require to turn OFF inline Normalization, it is recommended to turn OFF inline Normalization for
selected datasets at the Normalization level.
If you still require to turn OFF inline Normalization at CMDB engine level for performing certain
operations, make sure that you turn ON the Inline Normalization mode after the data load is
complete. For regular scenarios, it is highly recommended that the Inline Normalization mode
should always be turned ON at the CMDB engine level.
BMC Atrium Core 9.0
Page 2145 of 2268
Home
Given a scenario, where you want to initially load a large number of CIs (1M or more) into the
system, which is mostly a one-time activity, ONLY in such limited scenarios, it is recommended to
turn OFF the Inline Normalization Mode. When you turn OFF the Inline Normalization mode, the
communication between the Atrium CMDB server to the Normalization Engine is suspended. This
will load the CIs in the system, and the CIs are not sent to the Normalization Engine for further
processing. Ideally, the Normalization Engine checks if the Dataset present in the CI is enabled for
Inline Normalization. To see different kind of Normalization status setup, see Normalization status.
After the CIs are loaded in the system, you must turn on the Inline normalization mode and restart
the AR System server and Atrium CMDB server if you want to normalize the data.
Important Information
Only the batch jobs continue to function as scheduled, irrespective of the state of
the Enable Inline Normalization check box.
The CMDB engine level inline normalization setting takes precedence over the
dataset level inline normalization.
If Inline Normalization mode at the CMDB Engine level is turned OFF, the Inline
and Continuous modes of Normalization do not function.
System Level Configuration

Perform the following steps to turn ON/OFF the Inline Normalization mode at CMDB engine level.
1. In the CMDB Configuration window, check or uncheck the Enable Inline Normalization
check box. By default this is checked.
2. Save and close the file.
3. Restart the AR System Server.
Dataset Level Configuration

Perform the following steps to turn ON/OFF the Inline Normalization mode for the selected dataset
and Normalization Engine level.
2. In the Dataset Configuration tab, check or uncheck the Inline Normalization check box for
the desired dataset. Unchecking the Inline Normalization check box turns OFF the Inline
Normalization mode for that dataset.
3. Click Save
BMC Atrium Core 9.0
Page 2146 of 2268
Home

If you are unable to view the CMDB Dashboard ensure that you are able to launch Smart
Reporting console and navigate to BMC Remedy Smart Reporting and check if you can view
the CMDB Dashboard added by default.
If you explicitly remove or delete the CMDB Dashboard tab from Smart Reporting console,
the default view that has been set in Smart Reporting is displayed in Atrium console. Ensure
that you add the CMDB Dashboard as a tab..
In case you do not view the CMDB Dashboard in the expected locale, you may have to
manually set the correct preference in BMC Smart Reporting. For more information, see
Setting the locale and time zone for BMC Remedy Smart Reporting .
BMC Atrium Integration Engine issues

The following topics provide information about troubleshooting various BMC Atrium Integration
Engine issues, such as data exchange, data mapping, and other common issues:
BMC Atrium Integration Engine data exchange issues
BMC Atrium Integration Engine data exchange errors
Server groups incorrectly used when triggering data exchanges
Troubleshooting Run Now, Verify, or Test Connection buttons not responding
Troubleshooting data mapping issues in BMC Atrium Integration Engine
BMC Atrium Integration Engine service issues
SQL adapter not working in UNIX or Linux environment with BMC Atrium Integration Engine
Instance management issues in BMC Atrium Integration Engine
Rule Helper does not populate views and tables
BMC Atrium Integration Engine RPC port error
Displaying new attributes in the Data Field Mapping in BMC Atrium Integration Engine
window
Data exchanges not running correctly in BMC Atrium Integration Engine
BMC Atrium Integration Engine data exchange issues

Your data transfer might fail if the data exchange definitions are not configured correctly. Use the
following steps to troubleshoot common data exchanges issues.
To troubleshoot data exchange issues

1. If BMC Atrium Integration Engine does not generate a debug file, verify whether you enabled
debugging by selecting Yes for the Enable Debug Logging option on the Advanced
Settings tab of the Data Exchanges Information window.
Running BMC Atrium Integration Engine in debug mode generates a debug file that you can
use to diagnose issues. For more information about setting fields on the Advanced Settings
BMC Atrium Core 9.0
Page 2147 of 2268
Home
tab of the Data Exchanges Information window, see the BMC Atrium Integration Engine
User's Guide. For information about data exchange errors, see BMC Atrium Integration
Engine data exchange errors.
2. On the Data Mappings tab of the Data Exchange Console, make sure that the data
exchange is linked to at least one data mapping. Otherwise, the data exchange will not be
executed.
3. Before you run the data exchange, confirm that your data exchange is configured correctly
by using the Verify button on the Data Exchange Console. If you encounter data exchange
performance issues, make sure that your system has enough memory, according to the
following formulas:
To estimate memory for a first time transfer, use this formula:
Number of data keys per exchange * 1.2 KB * Number of records
in vendor data
For example, you have three data keys in your exchange and 10,000 records in your
external data store:
3 * 1.2 KB * 10,000 = 36000 KB or 36 MB
To estimate memory if updating records, use this formula:
Number of data keys per exchange * 1.2 KB * Number of records
in vendor data + Number of records in AR target form
For example, you have three data keys in your exchange, 10,000 records in your
external data store, and 11,000 records in your BMC Remedy Action Request System
Server (BMC Remedy AR Server) target form:
(3 x 1.2 KB * 10,000) + (1.2 KB * 11,000) = 49200 KB or 49.2 MB
If your system does not have sufficient memory, create multiple data exchanges with
a query to reduce the number of records transferred at one time.
4. Verify that 8-bit characters are used in the external data store user name and password. You
must use only 8-bit characters in English strings.
5. If you cannot verify a data exchange because the Data Exchange button froze at the Get
Results stage, perform the following steps:
a. On the top-right corner of the BMC Atrium Integration Engine Console, click the Close
link to close the form.
b. Reopen the Data Exchange form.
6. If you triggered a data exchange by using the Application Pending form or the aiexfer
workflow utility, and the data exchange does not occur, perform the following steps:
a. Open the data exchange in the BMC Atrium Integration Engine Console.
b. Change the Execute Exchange As option to Event Driven Only.
c. Verify that the record appears in the Application Pending form with a Pending status.
d. Restart the BMC Atrium Integration Engine service.
e. Verify that the status of the record changes to Deleted in the Application Pending form
.
f. If logging is enabled, review the exchange log in the debug directory.
BMC Atrium Core 9.0
Page 2148 of 2268
Home
BMC Atrium Integration Engine data exchange errors

When configuring and running data exchanges, you might encounter data handling, database
connectivity, and BMC Remedy AR System filter and active link errors as described in the following
topics:
Data Handler failed to load
Adapter.OpenConnection completed with errors
ARERR 39 Filter/escalation 'set fields' process timed out
EIEMSG 3309
EIEMSG 3338
ARERR 341 Cannot run the requested process
ORA-12514: TNS:listener does not currently know of service requested
SQL server returning "()" or "-" for NULL values
Data Handler failed to load

This error occurs if the library path for UNIX or Linux refers to an invalid data store location.
Perform the appropriate action depending on the database that you installed:
IBM DB2 Verify that the AIE_DB2_LIB_DIR path is in the instance script, such as aie001
.
Oracle Verify that the AIE_ORACLE_LIB_DIR path is in the instance script.
Adapter.OpenConnection completed with errors

This error occurs when BMC Atrium Integration Engine is unable to connect to the external data
store during a data exchange.
Full error message:
Error: Adapter.OpenConnection completed with errors issued.
StartDataHandlers: Vendor Data Handler failed to start.
1. Verify that you specified the correct BMC Remedy AR System server user name and
password.
2. Test the external data store connection by using the Test Connection button on the
Connection Settings tab before you trigger the data exchange. For more information about
setting fields on the Connection Settings tab of the Data Exchanges Information window, see
the BMC Atrium Integration Engine User's Guide .
BMC Atrium Core 9.0
Page 2149 of 2268
Home
ARERR 39 Filter/escalation 'set fields' process timed out

This error occurs when the aiexfer workflow utility generates a delayed response in executing the
request.
Full error message:
Error: ARERR 39 Filter/escalation 'set fields' process timed out before
completion. Set fields active link running a process failed (ARERR 1603)
1. Navigate to AR System Administration Console > System > General > Server
Information > Timeouts.
2. Increase the Process Timeout setting for the AR System server. The default value for the
timeout setting is 5 seconds.
EIEMSG 3309
Error EIEMSG 3309 is not an error. This message is displayed when the data exchange starts.
EIEMSG 3338
When a data exchange starts and you encounter error EIEMSG 3338, it implies that there is an
error in fetching keys from the external data source. Data exchange will not happen because the
key list is not created. To troubleshoot the issue, refer to the Exchange.dbg file.
ARERR 341 Cannot run the requested process

This error occurs when the BMC Atrium Integration Engine process cannot find the aiexfer workflow
utility.
Full error message:
Error: ARERR 341 Cannot run the requested process. Set fields active link
running a process failed (ARERR 1603)
1. Verify whether the installer copied the aiexfer utility in the
bmc AR System installation directory.
2. If not, verify whether BMC Atrium Integration Engine was successfully installed.
ORA-12514: TNS:listener does not currently know of service requested

This is an Oracle database connection issue. If the data exchange that you scheduled does not
yield any results, the cause might be incorrect database settings.
Full error message:
ORA-12514: TNS:listener does not currently know of service requested in
connect descriptor
1. Examine the BMC Atrium Integration Engine debug file and search for any database errors.
2.
BMC Atrium Core 9.0
Page 2150 of 2268
Home
2. If you encounter an ORA-12514 issue in the debug file, examine the TNSNAMES.ora file.
3. Search for the service name for the appropriate SID.
4. If the SID for the service specified in the TNSNAMES.ora file does not match with the SID
on the Connection Settings tab in BMC Atrium Integration Engine, change the name on the
Connection Settings tab.Verify that the Oracle listener service is running on the Oracle
database computer by running the lsnrctl command.
5. After you correct the database connectivity parameters for Oracle in the BMC Atrium
Integration Engine, test the Connection again.
SQL server returning "()" or "-" for NULL values

When you run a data exchange to transfer data from an SQL Server external datastore to AR
System forms and if CONCAT is used with strings and NULL in the SQL database, the SQL server
might return "()" or "-" for NULL values in the AR System forms.
1. Log in to the AR System server on which you have installed BMC Atrium Integration Engine.
2. Open the AIE:VendorParamLookup form in the Search mode.
3. Search for the data exchange for which the incorrect value has been transferred to the AR
System forms.
4. Open the entry for the CONCAT_NULL_YIELDS_NULL param name.
5. In the Param Value field, change the value to 1 and save the form.
6. Re-run the data exchange.
Server groups incorrectly used when triggering data exchanges

If the Data Exchange that you scheduled is not triggered on the correct server in a server group
environment, your connection settings for the Data Exchange might be incorrect. Data Exchanges
should connect to the Server Group Alias, and not to a specific server.
To set the correct server in the server group for a data exchange
1. Open the Connection Settings tab on the Data Exchange Console.
2. Verify that the AR System server specified for the data exchange is the name of the Server
Group Alias and not the name of a particular server group computer (for example, MyServer)
.
For server groups, the data exchange must point to the Server Group Alias. Otherwise, the priority
rankings that you set for a specific service in a server group environment will not take effect. These
rankings are set on the AR System Server Group Operation Ranking form.
Troubleshooting Run Now, Verify, or Test Connection buttons

not responding
When you click the Run Now, Verify, or Test Connection buttons on the Data Exchange console,
BMC Atrium Integration Engine might not respond due to:
BMC Atrium Core 9.0
Page 2151 of 2268
Home
Installation issues with BMC Atrium Integration Engine

Issues with the port that you configured for BMC Atrium Integration Engine
Issues with the aiexfer workflow utility
To troubleshoot issues with the Run Now, Verify, or Test Connection buttons
1. Verify whether the installer copied the aiexfer utility in the AR System installation directory.
2. If the utility is not copied, verify whether BMC Atrium Integration Engine was successfully
installed.
3. Verify whether the BMC Atrium Integration Engine instance that is executing the current data
exchange is running.
4. From the <AIEInstallationDirectory>/debug folder, open the <AIEInstance>_
EventListener.dbg file and make sure that the BMC Atrium Integration Engine instance is
listening to the port that you configured for it.
5. Go to AR System Administration Console > System > General > Server Information >
Timeouts and increase the Process Timeout setting for the AR System server.
Troubleshooting data mapping issues in BMC Atrium

Integration Engine
Use the following procedure to troubleshoot data mapping issues with the BMC Atrium Integration
Engine.
To troubleshoot data mapping issues

1. If all your records are not transferred to the destination data source and no errors are
generated in the data exchange debug file, verify that you are using the correct data key for
the primary key mapping.
The primary key field for the data exchange, which is specified on the Primary Key
Mapping tab of the mapping consoles for AR System, BMC Atrium CMDB, and Relationship
data exchanges, must have unique values.
Note
AIE:DataMapping and AIE:CMDBDataMapping are backend forms used to store
data. You must use the AIE:MappingInfo form where the primary key mapping can
be referred.
2.
BMC Atrium Core 9.0
Page 2152 of 2268
Home
2. Verify that the BMC Remedy AR System or BMC Atrium CMDB data field size is large
enough to accommodate the data. Otherwise, you might receive AR System API or BMC
Atrium CMDB API error messages.
For example, in BMC Atrium Integration Engine, if a field is created to hold the contents of a
functional location number, such as 0001-001-AA-01, the size of that field must be at least
the size of the largest possible value.
3. Verify that you specified default values set for the BMC Atrium Integration Engine required
and core fields. Otherwise, you might receive AR API or CMDB API error messages.
For example, in case of CMDB Data Mapping, you must map fields, such as Name and
DatasetId.
4. If you configured rules to manipulate the data from the data source, make sure that you use
them correctly.
Your data exchange might stop abruptly if the data mapping rules are violated. For more
information about data mapping rules, see the BMC Atrium Integration Engine User's Guide .
5. Make sure that you have not selected any < systemGenerated > numbered fields for your
data mappings.
When you check the following options and select < systemGenerated > from the menu list
on the corresponding console forms for AR System, the options generate a numbered field:
Maintain Change History for Fields The field must be of the Diary data type.
Update Record Only if Checksum for Mapped Field Has Changed The field must be
of the Integer data type.
6. If you are trying to create CIs using BMC Atrium Integration Engine where Region, Site
Group, and Site fields are mapped with different field types other then Menu and String
type, the following error is displayed:
The Location Information is not valid.

Please use the menus provided on the Region, Site Group and Site fields or the
type ahead return
function on the Site field to select this information.
AddEntry: CMDB API returned error during CMDBCreateInstance rc = 2
To troubleshoot
Region, Site Group, and Site are a Menu type field and hence the actual value must be
used.
For additional information also see, https://kb.bmc.com/infocenter/index?page=content&id=S
:KA343272
BMC Atrium Integration Engine service issues

The following topics provide information about resolving the BMC Atrium Integration Engine service
issues:
AR System server stopped when running the BMC Atrium Integration Engine service on
UNIX
BMC Atrium Core 9.0
Page 2153 of 2268
Home
Troubleshooting a fatal BMC Atrium Integration Engine service error
AR System server stopped when running the BMC Atrium Integration Engine
service on UNIX
If you use the same terminal window as the AR System server to start and stop the BMC Atrium
Integration Engine service, the AR System server disconnects abruptly. The system displays the
following error message when you type the (Ctrl+C) command to stop the BMC Atrium Integration
Engine service:
390600: Another copy of the server is already running on the same RPC
socket
390600: AR System server terminated fatal error encountered
To avoid stopping the BMC Atrium Integration Engine service

Use different terminal windows to start the AR System server and the BMC Atrium
Integration Engine service.
To start the service in the background, type ./<AIEInstanceId>start parameters,
and to stop the service, type ./<AIEInstanceId>stop, where <AIEInstanceId> is the
ID associated with a particular instance of BMC Atrium Integration Engine. For example,
aie001 might be the ID associated with the first instance of BMC Atrium Integration Engine
that you install.
Tip
If you have more than one instance of BMC Atrium Integration Engine installed on your
computer, make sure that your data exchange is using the correct instance ID.
Troubleshooting a fatal BMC Atrium Integration Engine service error

If the BMC Atrium Integration Engine service stopped responding due to a fatal error and the <
AIEServiceInstance>_eiemain.dbg log file contains the following entry, there could be an data
transfer issue:
A fatal setup error occurred. The service cannot run until it is
corrected. (EIEMSG 3317)
This error occurs when BMC Atrium Integration Engine cannot transfer data. When the value in the
ChunkSize parameter is reduced, BMC Atrium Integration Engine collects data in smaller chunks
and avoids overloading AR System and BMC Atrium CMDB.
BMC Atrium Core 9.0
Page 2154 of 2268
Home
To troubleshoot BMC Atrium Integration Engine service EIEMSG 3317 fatal error
1. Examine the dataexchange.dbg file for any size errors, such as the following entry:
CMDBGetListIntances Error: (120149) Size: 5379225, Type: calloc,
Source File: .\aroscinstanceutil.cpp, Line Number: 2012
2. If the error occurred due to a size issue, make sure that the value specified for the
ChunkSize parameter in the aie.cfg file is less than 50000.
A size error might occur when BMC Atrium Integration Engine cannot transfer data. When
the value in the ChunkSize parameter is reduced, BMC Atrium Integration Engine collects
data in smaller chunks and avoids overloading AR System and BMC Atrium CMDB.
SQL adapter not working in UNIX or Linux environment with

The BMC Atrium Integration Engine can integrate data from the MS SQL Server. To communicate
with SQL Server, the BMC Atrium Integration Engine uses the SQL OLEDB APIs, which are
proprietary to Microsoft. These APIs are not supported on UNIX or Linux.
To access Microsoft SQL Server from a UNIX computer, write a custom adapter using the Adapter
Developer Kit provided with the BMC Atrium Integration Engine, and any third-party driver.
Instance management issues in BMC Atrium Integration

Engine
When you use the Instances Console in the BMC Atrium Integration Engine to create, delete, start,
or stop an instance service, you might encounter issues due to the following reasons:
Error creating, deleting, starting, or stopping instances might occur if the BMC Atrium
Integration Engine service encountered a connection issue.
Generates a timeout error before completing the process might occur if the connection to
the server takes longer than the timeout period specified in the AR System Administration
Console.
In a server group environment, creates the instance on primary server but not on secondary
server might occur if the primary and secondary server settings are incorrect.
Fails to update the Instance Console even though the instance is successfully created,
deleted, started, or stopped might occur if the AR System server does not respond.
Note
To run the aiexfer utility in a server group environment, access it from the primary server.
BMC Atrium Core 9.0
Page 2155 of 2268
Home
To enable logging when executing instance management commands, you need to use the
command line.
To troubleshoot instance management issues
Aiexfer command line parameters
Aiexfer command examples
To troubleshoot instance management issues

1. Enable detailed logging for your instance management commands.
2. If you are connecting to the BMC Atrium Integration Engine service on a remote computer,
verify that the service is running.
You can view the instance name and port number in the aiexferutil.out log if you have
enabled detailed logging.
3. If you installed BMC Atrium Integration Engine in a server group, perform the following steps:
a. Access the EIE:BackUpLoadFlag form.
b. Clear the Hide check box in the Properties dialog for the Internal Instance Name,
Host, and IsPrimaryServer fields.
c. Access the AIE:BackUpLoadFlag form and search for all BMC Atrium Integration
Engine service instances.
d. Verify that all host computers in the server group have the same values in the Internal
Instance Name field.
The internal instance names of all host computers should be the same.
e. Verify that only one of the host computers in the server group has the
IsPrimaryServer flag is set to Yes.
All other host computers in the server group should have a value of No in the
IsPrimaryServer field.
4. Go to AR System Administration Console > System > General > Server Information >
Timeouts and increase the Process Timeout setting for the AR System server.
The default value for the Timeout setting is 5 seconds.
5. As a workaround, execute your instance management commands from the command line
prompt.
Aiexfer command line parameters

The following table lists the commands that you can use with the aiexfer utility.
Command
Description
-CI/-DI/START/-STOP
The type of instance management command to execute:

CI --Create an instance
DI --Delete an instance
START --Start an instance
STOP --Stop an instance
-n
BMC Atrium Core 9.0
The alias name of the instance
Page 2156 of 2268
Home
Command
Description
-t
The type of start up for the aiexfer utility:

3 --Manual
2 --Automatic
-l
The user name for the AR System server login.
-p
The password for the AR System server login.
-x
The name of the AR System server to use.
-a
The host name of the BMC Atrium Integration Engine instance.
-rpcport
The RPC port number to use.
-inst (optional)
The internal name of the BMC Atrium Integration Engine instance. This name is needed only for remote
installations.
-os
BMC Atrium Integration Engine is installed on Windows and UNIX
-ir (optional)
The status of the instance (whether running) specified in the -inst parameter:'YES' --If running 'NO' --If
not running This name is needed only for remote installations.
-d (optional)
Enable detailed logging for the instance management commands.
-path (optional)
The location of the BMC Atrium Integration Engine installation directory. Include the path up to the service
subdirectory in the installation directory, for example, D:\Program Files\BMC Software\AtriumCore\aie\
service
-noi
Number of instances; the value is always 1
-del
For delete operations. Combine the AIE hostname and Internal instance name. Separate AIE hostname and
Internal instance name with a comma.
-st
For start operations. Combine the AIE hostname and Internal instance name. Separate AIE hostname and
-stp
For stop operations. Combine the AIE hostname and Internal instance name. Separate AIE hostname and
Aiexfer command examples

Although the -path parameter is optional, include it in the aiexfer command to specify the exact
BMC Atrium Integration Engine installation directory. Otherwise, the BMC Atrium Integration Engine
might use an incorrect installation directory value that is specified in the ATRIUMCORE_HOME
environment variable.
The following code constructs show examples of the aiexfer parameters to use with the create,
delete, start, and stop instance management commands.
Creating an instance example

aiexfer -CI -noi "1" -n "aie" -t 3 -l "Demo" -p "" -x "vm1-w23-prem10" -a
"VM1-W23-PREM10" -rpcport "0" -inst "ARS_VM1-W23-PREM10(0)_EIE_VM1-W23PREM10_Inst_006" -os "WINDOWS" -ir "No" -d
BMC Atrium Core 9.0
Page 2157 of 2268
Home
Deleting an instance example

aiexfer -DI -del "VM1-W23-PREM10,ARS_VM1-W23-PREM10(0)_EIE_VM1-W23-PREM10
_Inst_006;" -l "Demo" -p "" -x "vm1-w23-prem10" -a "VM1-W23-PREM10" rpcport "0" -d
Starting an instance example

aiexfer -START -st "VM1-W23-PREM10,ARS_VM1-W23-PREM10(0)_EIE_VM1-W23PREM10_Inst_007;" -l "Demo" -p "" -x "vm1-w23-prem10" -a "VM1-W23-PREM10"
-rpcport "0" -d
Stopping an instance example

aiexfer -STOP -stp "VM1-W23-PREM10,ARS_VM1-W23-PREM10(0)_EIE_VM1-W23PREM10_Inst_007;" -l "Demo" -p "" -x "vm1-w23-prem10" -a "VM1-W23-PREM10"
-rpcport "0" -inst "ARS_VM1-W23-PREM10(0)_EIE_VM1-W23-PREM10_Inst_007" -d
Rule Helper does not populate views and tables

When you specify the connectivity parameters on the Database Field Menus Console of the
Configuration tab and click the Load Tables & View Names button, the tables and views might not
be populated.
This issue might occur if the Rule Helper Utility encounters database connectivity problems or
incorrect information, such as incorrect values for the database name, SID, Alias, login name, or
password.
To troubleshoot the missing required tables and views

1. Access the Logging tab and select the Active Link logging option.
2. From the Database Field Menus Console, click Load Tables & View Names.
3. Access the Logging tab, deactivate logging, and open the log file created.
4. Search for the following string in the log file. <ACTL> Process: rlshelper -ax ... ar "..." -al "..." -ap "..." -os ... -ol ... -op "..." -od ... -to <
ACTL> Success
Note
The parameters displayed in the log file might vary depending on the adapter used.
For more information about using different adapters with BMC Atrium Integration Engine,
see the BMC Atrium Integration Engine User's Guide .
5. Note the command that appears before the string: -ax ... -ar "..." -al "..." -ap
"..." -os ... -ol ... -op "..." -od ... -to .
6.
BMC Atrium Core 9.0
Page 2158 of 2268
Home
6. From the command prompt, go to the Bin subdirectory of your BMC Atrium Integration
Engine installation directory.
In the bin directory you will find the rule helpers binaries.
7. Run the command that you noted in step 5.
8. If the command runs successfully, go to the Database Field Menus Console and click
Refresh Table List.
You should be able to view the Database Field Menus. For information about populating a
table or table fields from external datastores, see the BMC Atrium Integration Engine User's
Guide.
9. In the command that you noted, replace the password variable with a text string to verify that
it is not an encryption issue.
BMC Atrium Integration Engine RPC port error

If you receive an RPC port error, confirm whether BMC Atrium Integration Engine is using any port
numbers reserved for BMC Atrium CMDB. For more information about the BMC Atrium CMDB
reserved port numbers, see the BMC Atrium Integration Engine User's Guide .
If any of the BMC Atrium CMDB APIs fail, verify that you can call the same function with the
cmdbdriver program. If the function fails using the cmdbdriver program, check for errors in the
AR System server and BMC Atrium CMDB log file. For more information about AR System and
BMC Atrium CMDB logging, see Reconciliation Engine issues.
Displaying new attributes in the Data Field Mapping in BMC

Atrium Integration Engine window
If you added an attribute for a class in BMC Atrium CMDB and the new attribute does not appear
on the Data Field Mapping window, perform the following steps.
To display newly added BMC Atrium CMDB attributes on the Data Field Mapping
window
1. Access the AIE:FieldNames form.
2. Click Search.
3. Select the BMC Atrium CMDB class to which you added attributes.
4. Delete the new attributes from the AIE:FieldNames form.
5. Save the AIE:FieldNames form and open the specific mapping from the CI Class Mapping
Console.
The attribute list on the Data Field Mapping table is refreshed.
BMC Atrium Core 9.0
Page 2159 of 2268
Home
Data exchanges not running correctly in BMC Atrium

Integration Engine
If you restore a BMC Remedy AR System database on a computer from another environment, and
then upgrade BMC Atrium Integration Engine, existing data exchanges may not run correctly as
they may point to the old AIE instances. To fix this issue, clean the old AIE instances and ensure
that the data exchanges point to the new AIE instances.
To clean old AIE instance entries

1. Access for the AIE:backUpLoadFlag form.
2. Click Search.
3. Delete the AIE instance entries belonging to the old AIE setup.
4. Save and close the AIE:backUpLoadFlag form.
To assign the correct instance to data exchanges

1. Open the AIE Console.
2. Select a data exchange and click Open.
3. In the Instance Name field, select the new AIE instance.
4. Click Save.
5. Click Close.
6. Repeat steps 2 Data exchanges not running correctly through step 5 Data exchanges not
running correctly for each data exchange.
Data exchanges are now executed correctly.

To view the troubleshooting tips video for Atrium Integrator issues, see
Integrator troubleshooting .
BMC Atrium
The following topics provide information for resolving errors that might occur when you execute a
data transfer job:
Atrium Integrator errors
Atrium Integrator console issues
Atrium Integrator Spoon issues
Atrium Integrator data exchange migration issues
Atrium Integrator migrated jobs issues
BMC Atrium Core 9.0
Page 2160 of 2268
Home
Atrium Integrator errors

The following table lists errors you might encounter while using Atrium Integrator.
Error Message
Solution
Error
retrieving
Verify the BMC Remedy AR System server details specified in the target data store connection.
DatasetIds for
the selected
target data
store.
Error
retrieving CI
Types for the
selected
target data
store.
Verify the BMC Remedy AR System server details specified in the target data store connection. Also confirm
that one or more some target attributes have been mapped to the source column on the CI Mapping page of
the Integration Job Builder wizard.
Error
retrieving CI
Relationships
for the
selected CI
Types.
Verify the BMC Remedy AR System server details specified in the target data store connection. Also confirm
that a relationship has been selected for the selected CIs on the CI Type Relationships page of the
Error
retrieving CI
attributes for
the selected
CI Type.
Confirm connectivity to BMC Atrium CMDB by clicking the Test Connection button in the Manage Data Store
tool. Also verify that the CI Class is defined correctly for the selected CI Type.
Error
Confirm connectivity to the external data store by clicking the Test Connection button in the Manage Data
retrieving
Schemas for
Store tool.
the source.
Error
retrieving
Tables for the
schema.
Confirm whether the schema for the external data store has any table defined. Also, check whether the user
you have specified has permissions to access the tables.
Error
retrieving
Views for the
schema.
Confirm whether the schema for the external data store has any view defined. Also, check whether the user
you have specified has permissions to access the views.
Error
retrieving
Files for the
source.
Confirm whether an entry has been created for the files in the NGIE: FileMetaData form. To troubleshoot
data retrieval or connection errors for CSV or XML data source types, you can refer to the aifileout.txt and
Error
retrieving
fields from
the selected
file.
Confirm whether an entry has been created for the selected file in the NGIE: FileMetaData form. Also,
confirm whether an entry has been created in the NGIE: FileMetaData form for all the columns that are
defined in the selected file. To troubleshoot data retrieval or connection errors for CSV or XML data source
types, you can refer to the aifileout.txt and aifileerr.txt log files that are stored in the following directory:
BMC Atrium Core 9.0
aifileerr.txt log files that are stored in the following directory:
ARInstallationDirectory\diserver\data-integration\ngie\bin\log
Page 2161 of 2268
Home
Error Message
Solution
Failed to
connect to
See, No jobs are displayed in Atrium Integrator console.
Atrium
Integrator.
Failed to get
list of NGIE
Jobs.
See No jobs are displayed in Atrium Integrator console.
Failed to get
list of job
runs.
Failed to get
list of job
runs.
Error getting
data stores.
Error
publishing the
job to the
repository.
This error can occur while migrating jobs or creating a job from Atrium Integrator console. If you are
migrating a job, refer to the migration db logs to resolve the issue. If you are creating a job, refer to the
midtier log file to resolve the issue. After you resolve the issue, you can copy the job and transformation files
saved in the user profile on the mid tier (For example, C:\Documents and Settings\Administrator\<
jobName>) to the Atrium Integrator Spoon repository.
Error
publishing the
transformation
to the
repository.
Check your connection to the repository database server. After you fix the connection, you can copy the job
and transformation files saved in the user profile on the mid tier (For example, C:\Documents and Settings\
Administrator\<jobName>) to the Atrium Integrator Spoon repository.
Atrium Integrator console issues

The following topics provide information for resolving some common Atrium Integrator console
issues:
Job fails to run in Atrium Integrator console
Job not starting in the Atrium Integrator console
Job not displayed on the Atrium Integrator console
No jobs are displayed in Atrium Integrator console
Atrium Integrator jobs with XML or CSV files as input give date format error
Not able to create datastore connection with Oracle service name
CSV or XML data is not populated with remote Atrium Integrator Carte server
Job fails to run in Atrium Integrator console

If the Job Name in the left side of the Atrium Integrator console is in red and has a
job failed to run.
BMC Atrium Core 9.0
next to it, the
Page 2162 of 2268
Home
If the Logging Details area in the Atrium Integrator console does not provide enough information for
you to debug the error, you can open the following forms in a browser and search for the
corresponding job or transformation entry:
Form name
Description
UDM:JobLog
This form provides details about the job run. For more information, see Job Log form.
UDM:JobEntryLog
This form provides details about every entry in a job such as start, set variable, and sub transformations. For
more information, see Job Entry Log form.
UDM:
TransformationLog
This form provides details about the transformation run. For more information, see Transformation Log form.
UDM:StepLog
This form provides details about the step run. For more information, see Step Log form.
UDM:
RepositoryObject
This form provides a list of all jobs and transformations in the BMC Remedy AR System database. For more
information, see Repository Object form.
To troubleshoot a job that failed to run

1. In the Atrium Integrator console, select the failed job.
2. In the History tab, click next to the last run of the failed job.
3. Click Logging details (below the Job Run Details area).
Logging Details in the Atrium Integrator console
4. In the Logging Details area, click View Log Details

The log file appears.
Log file in the Atrium Integrator console
BMC Atrium Core 9.0
Page 2163 of 2268
Home
5. Click Export to File and save the log file to the location you want.
6. If the log file does not contain enough information for you to debug the error, open the job in
For information about opening a job in Atrium Integrator Spoon, see Editing Atrium Integrator
jobs and transformations
7. Click Run
8. In the Execute a job dialog box, change Log level to Row level (very detailed).
9. To run the job, click Launch.
10. After the job completes running, follow the steps in Atrium Integrator Spoon issues.
Note
To set interval in seconds to reconnect to BMC Remedy AR System server, update
the RetryInterval(Seconds) field in the n the aiplugin.properties file located at: <
AR serverInstallDirectory>/diserver/data-integration/ngie/conf
Job not starting in the Atrium Integrator console

To trouble shoot issues related to a job not starting in Atrium Integrator console, follow the tasks
listed in the table:
BMC Atrium Core 9.0
Page 2164 of 2268
Home
Verify
Steps
If Atrium Integrator Carte is

running
You can start a job from the Atrium Integrator console only if the Atrium Integrator Carte server is
running.
For more information, see
Mid-tier logs
If the Atrium Carte Server is running and if the job is still not starting, see the mid-tier logs.
For more information see, Mid-tier logs.
ARSYS.ARDBC.PENTAHO
plug-in logs
If the mid-tier log identifies a issue related to the ARSYS.ARDBC.PENTAHO plug-in, see the plug-in
logs.
For more information, see ARSYS.ARDBC.PENTAHO plug-in logs.
User permissions to start
If the ARSYS.ARDBC.PENTAHO plug-in log identifies a user permission issue, update permissions
the job
in the UDM:PermissionInfo form.

For more information, see:
Permission Info form
Instance execution status
If there is instance related issues such as a duplicate instance or you are unable to delete an
instance, update the UDM:ExecutionInstance form.
For more information, see Execution Instance form
Job not displayed on the Atrium Integrator console

If a job was created successfully through the Integration Job Builder wizard but does not appear on
the Atrium Integrator console, consider the following possible causes:
The ARDBC plug-in might not be available on the server on which you installed the Atrium
Integrator Spoon application.
Some .jar files might be missing.
To troubleshoot Atrium Integrator console issues

1. Open the following file:
ARInstallationDirectory\pluginsvr\pluginsvr_config.xml
2. Ensure that the pluginsvr_config.xml file contains the following entry:
ARSYS.ARDBC.PENTAHO
3. Ensure that all the .jar files listed in the ARSYS.ARDBC.PENTAHO section exist at the
specified locations.
4. Open the following file:
ARInstallationDirectory\pluginsvr\log4j_pluginsvr
5.
BMC Atrium Core 9.0
Page 2165 of 2268
Home
5. Search for the com.bmc.arsys.pdi entry and change the value from warn to debug as:
<logger name="com.bmc.arsys.pdi">
<level value="debug">
</logger>
6. Create another job by using the Integration Job Builder wizard, and then open the following
file to review the debug logs:
ARInstallationDirectory\Arserver\Db\arjavaplugin.log
No jobs are displayed in Atrium Integrator console

If no jobs are displayed in the Atrium Integrator console, verify that the user is assigned to one of
the following roles:
AI Admin
AI User
For more information, see Atrium Integrator permissions
Atrium Integrator jobs with XML or CSV files as input give date format error
When you are running a job with XML or CSV files as input and if a date format error message is
displayed, change the Date format in the Select Values step. The date format must be as provided
in the Get data from XML step for XML and Text file input step for CSV. For more information, see
Changing the field type in the XML or CSV step input in Atrium Integrator Spoon .
This issue applies only to delta jobs.
Not able to create datastore connection with Oracle service name

From Atrium Integrator console you cannot create data store connection with Oracle service name.
You need to use Atrium Integrator Spoon.
To create datastore connection with Oracle service name

1. Create a new data store connection for Oracle database in Atrium Integrator Spoon.
2. To work with SERVICE_NAME instead of Oracle SID:
In the Access list, select Native (JDBC).
Leave the Host Name field and the Port Number field blank.
Enter service description in the Database Name field.
For example,
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=
PRIMARY_NODE_HOSTNAME)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=
SECONDARY_NODE_HOSTNAME)(PORT=1521))) (CONNECT_DATA=(
SERVICE_NAME=DATABASE_SERVICENAME)))
3. Enter DB Username and Password.
4.
BMC Atrium Core 9.0
Page 2166 of 2268
Home
4. Click OK.
CSV or XML data is not populated with remote Atrium Integrator Carte server
CSV or XML data may not get populated with remote Atrium Integrator Carte server due to the
following reasons:
Job_FileMetaLoader is not started. To troubleshoot, see Job not starting in the Atrium
Integrator console.
Source files are not present on the configured server.
Atrium Integrator Spoon issues

Error handling in Atrium Integrator Spoon
The following topics provide information for resolving some common Atrium Integrator Spoon
issues:
Atrium Integrator Spoon logging
Atrium Integrator jobs created in Windows with target source connection as localhost do not
run on UNIX or Solaris
XML or CSV jobs created on UNIX or Solaris do not run in Atrium Integrator Spoon Windows
client
Error connecting to a Microsoft SQL Server database using Windows Authentication in
Job and transformation run history is not displayed in Atrium Integrator console
Atrium Integrator Spoon logging

When you run a job or transformation in Atrium Integrator Spoon, the Execution Results area in the
Atrium Integrator Spoon window displays the results.
To troubleshoot Atrium Integrator Spoon errors

1. In the Execution Results area, click Refresh
to get the latest results.
Execution Results area in the Atrium Integrator Spoon window
3.
BMC Atrium Core 9.0
Page 2167 of 2268
Home
3. Click Show error lines

The job or transformation errors are displayed.
4. To get more information about the errors, double-click the Error logging step.
The text file output dialog box displays the location of the error file in the Filename field.
5. Open the specified file to see the error details.
Atrium Integrator jobs created in Windows with target source connection as

localhost do not run on UNIX or Solaris
If you create a job on the Microsoft Windows OS with target connection as local host, the job will
not run on UNIX or Oracle Solaris because neither of these platforms support the localhost
command. To troubleshoot this issue, open the migrated job and replace the local host server
name with the actual server name and then run the job.
XML or CSV jobs created on UNIX or Solaris do not run in Atrium Integrator Spoon
Windows client
You cannot run XML or CSV jobs that were created on UNIX or Oracle Solaris directly on Atrium
Integrator Spoon Windows client.
To run XML or CSV jobs created on UNIX or Solaris in Atrium Integrator Spoon Windows client
1. Copy the XML or the CSV files from UNIX or Solaris to the computer where the Atrium
Integrator Spoon Windows client is installed.
2. Open the job on Atrium Integrator Spoon Windows client
3. Update the new file path.
Error connecting to a Microsoft SQL Server database using Windows

Authentication in Atrium Integrator Spoon
On a 32-bit JVM, Windows Authentication when connecting to a Microsoft SQL Server in Atrium
Integrator Spoon works correctly. But, Windows Authentication displays an error on a 64-bit JVM.
Use the following steps to fix the error.
1. Navigate to the following directory:
AtriumIntegratorInstallationDirectory\server\data-integration\libswt\win32
2. Rename the ntlmauth.dll file as ntlmauth_32.dll.
3. Navigate to the following URL:
http://sourceforge.net/projects/jtds/files/jtds/1.2.5/jtds-1.2.5-dist.zip/download
4. Download the jtds-1.2.5-dist.zip file and unzip it.
5. Copy the jtds-1.2.5-dist\x64\SSO\ntlmauth.dll file to the following directory:
AtriumIntegratorInstallationDirectory\server\data-integration\libswt\win32
6.
BMC Atrium Core 9.0
Page 2168 of 2268
Home
6. Close the Atrium Integrator Spoon window.

7. Launch Atrium Integrator Spoon.
8. Open your job or transformation.
9. Double-click the table input step.
10. Click New (next to the Connection field).
11. In the Database Connection dialog box (General tab), specify appropriate values for the
following fields:
Connection Name
Host Name
Database Name
Port Number
12. Select the Options tab.
13. In the Parameter column, enter domain and in the Value column, enter the domain of the
database server.
14. Click Test to ensure that the database connection is valid.
15. Click OK.
Job and transformation run history is not displayed in Atrium Integrator console
If you create a job in the Atrium Integrator Spoon, the job and transformation run history of such
jobs is not displayed in the Atrium Integrator console.
To display the job run history in Atrium Integrator console

2. Click Edit > Settings. The Job Properties dialog box is displayed.
3. Click the Log tab.
4. Click Job.
6. Enter UDM:JobLog form name in the Log table field.
7. Click Job Entry.
9. Enter UDM:JobEntryLog form name in the Log table field.
10. Click OK.
To display the transformation run history in Atrium Integrator console

2. Click Edit > Settings. The Transformation Properties dialog box is displayed.
4. Select Transformation.
6. Enter UDM:TransformationLog form name in the Log table field.
7. Click Step.
9.
BMC Atrium Core 9.0
Page 2169 of 2268
Home
9. Enter UDM:StepLog form name in the Log table field.

10. Click OK.
Related topic
Atrium Integrator data exchange migration issues

When migrating data exchanges to Atrium Integrator, you may encounter the following issues:
Migrated job not running in Atrium Integrator
List of data exchanges is not displayed in AIE to AI Migration tool
Password encryption error occurred while migrating data exchanges
Error when creating CI mapping using Region, Site Group, and Site fields
status of the migration process. If there are errors in the migration process, you can view the
following files for detailed information:
MigrationInfo.txt
Migrationdbg.log
The log files are located in the following directory:
Migrated job not running in Atrium Integrator

If you are unable to run a migrated job in Atrium Integrator, perform the following steps to verify that
the data exchange settings and parameters were successfully migrated:
In Atrium Integrator console, open the Manage Data Store Connections window and then
open the source and target data store connections for the migrated job. If the Database
Host Name field displays the fully qualified domain name, change the value to the server
name.
In a browser, open the UDM:RAppPassword form and search for the BMC Remedy AR
System server that is specified for the target data store connection. Confirm that the
password for the Remedy Application Service user is specified in the RApp Password
field.
In Atrium Integrator Spoon, open the CMDBOutput step for the transformation to confirm
that the key mapping and data mappings have been accurately migrated. In case of any
errors in the migration, you must manually edit the data mappings.
BMC Atrium Core 9.0
Page 2170 of 2268
Home
List of data exchanges is not displayed in AIE to AI Migration tool

When you click Get Exchanges in the AIE to AI Migration Tool, the list of exchanges might not
appear if the password of the source connection that is defined for a BMC Atrium Integration
Engine data exchange is less than 120 bytes.
To resolve this issue, change the password of the source connection, open the BMC Atrium
Integration Engine Console, select the data exchanges on the Connection tab, and then update
the password of the source connection.
Password encryption error occurred while migrating data exchanges

When you migrate the data exchanges, the password encryption error might be displayed in the
Status messages area if the password of the source connection that is defined for a BMC Atrium
Integration Engine data exchange is less than 120 bytes.
To resolve password encryption error

1. Change the password of the source connection.
2. Open the BMC Atrium Integration Engine console.
3. Select the data exchanges on the Connection tab.
4. Update the password of the source connection.
Error when creating CI mapping using Region, Site Group, and Site fields
If you are trying to create Configuration Items (CIs) using Atrium Integrator where Region, Site
Group, and Site fields are mapped with different field types other then Menu and String type, the
following error is displayed:
The Location Information is not valid.

Please use the menus provided on the Region, Site Group, and Site fields or the type
ahead return function on the Site field to select this information.
AddEntry: CMDB API returned error during CMDBCreateInstance rc = 2
To troubleshoot CI mappings
Region, Site Group, and Site are Menu type fields and the actual value must be used. You can
use the Add Constant step in Atrium Integrator Spoon to map the constant value. Or you can use
the DB Lookup step to fetch the data from the reference table.
For additional information also see, https://kb.bmc.com/infocenter/index?page=content&id=S:
KA343272
Atrium Integrator migrated jobs issues

The following topics explain how you can troubleshoot issues with migrated jobs:
Verifying jobs with BMC Atrium CMDB as input and table as output
BMC Atrium Core 9.0
Page 2171 of 2268
Home
Verifying jobs with table as input and BMC Atrium CMDB as output
After migrating XML or CSV data exchanges, fields in the input step are not populated
Verifying rules after migration to Atrium Integrator
AR System data is not populated in table
Brackets are added before data even though such data is not there in SQL server columns
Working with issues related to SCCM installation
To troubleshoot issues with migrated jobs, open the job in Atrium Integrator Spoon and verify the
details that you have provided at each step.
Verifying jobs with BMC Atrium CMDB as input and table as output
For Jobs with BMC Atrium CMDB as input and table as output, use the InsertUpdate step.
To verify jobs with BMC Atrium CMDB as input and table as output
1. Open the job in BMC Atrium Integrator Spoon. For more information, see Opening Atrium
Integrator job or transformation.
2. Double-click the CMDBInput step.

The CMDBInput dialog box appears.
BMC Atrium Core 9.0
Page 2172 of 2268
Home
3. Verify the BMC Atrium CMDB input details.

4. Click OK.
5. Double-click the InsertUpdate step.
The Insert/Update dialog box appears.
6. Verify if the fields in the The key(s) lookup the value(s) table are listed accurately in the
Updatefields table and the Tablefield and Stream field mapping is set to Yes.
7. Click OK.
8. Double-click the User Defined Java Class step.
The User Defined Java Class dialog box appears.
9. Verify if the rules are migrated correctly.
a. Double-click the Set Rules step.
b. Click Test Class.
10. Click OK.
11.
BMC Atrium Core 9.0
Page 2173 of 2268
Home

12. Verify the job details in the target database table.
Verifying jobs with table as input and BMC Atrium CMDB as output
For jobs with table as input and BMC Atrium CMDB as output, constants are added.
To verify jobs with table as input and BMC Atrium CMDB as output
1. Open the job in Atrium Integrator Spoon. For more information, see Opening Atrium
Integrator job or transformation.
2. Double-click the Table Source step.

The Table input dialog box appears.
3. Click Edit and verify:

Target database name: Source DB name
User: Source DB user
4. Click OK.
5. Double-click the Add constants step.
The Add constant values dialog box is displayed.
BMC Atrium Core 9.0
Page 2174 of 2268
5.
Home
6. Verify the constant values.

7. Click OK.
The CMDBOutput dialog box appears.
9.
BMC Atrium Core 9.0
Page 2175 of 2268
Home
9. Verify the BMC Atrium CMDB output details.

10. Click Edit and verify:
AR System server name
TCP Port
11. Click OK.
12. (Optional ) If the job contains rules, verify if the rules are migrated properly.
See Verifying rules after migration to Atrium Integrator .
13. Run the job.
14. Verify the job details in BMC Atrium CMDB.
After migrating XML or CSV data exchanges, fields in the input step are not
populated
While migrating XML or CSV data exchanges from BMC Atrium Integration Engine to Atrium
Integrator, if the file location is different, the fields in input step are not populated. Go to the Atrium
Integrator console, select the connector, and re-migrate the jobs.
To populate fields in XML or CSV input step

1. In the Atrium Integrator console, click Manage Data stores.
2. Select the XML or CSV connector.
3. Click Refresh.
4. Re-migrate the job in overwrite mode by using the AIE to AI Migration Tool.
Verifying rules after migration to Atrium Integrator

After migrating rules to Atrium Integrator, verify if rules are migrated correctly.

2. Double-click the Set Rules step.
3. Click Test Class.
AR System data is not populated in table

AR System data is not populated into the table if the mapping between the AR Input step and the
Table output step fails.
To map ARInput step and Table output step

1. Open the transformation.
2. Double-click the Table output step.
3. In Table Output dialog box, select the Specify Database fields option.
4. Click OK.
5. Save and run the transformation.
BMC Atrium Core 9.0
Page 2176 of 2268
Home
Brackets are added before data even though such data is not there in SQL server
columns
This issue is specific to Microsoft SQL server. To troubleshoot this issue, on the Microsoft SQL
server, set the SET CONCAT_NULL_YIELDS_NULL option to OFF and run the job again.
Working with issues related to SCCM installation

After installing Microsoft System Center Configuration Manager (SCCM) it is possible that you will
encounter the following issues:
Incorrect location of error log file
Failure when running Normalization Engine jobs
Incorrect location of error log file

If you have installed SCCM, you may not be able to locate the error log file. All error log files related
to BMC Atrium Integrator jobs are saved in ngie/bin folder. Hence, you should make sure that the
error logging plugin has the correct file location.
Perform the steps given below to update the file location:
(Click on the image to zoom in)

1. In the Pentaho Integration console, open the Error Logging plugin.
2. In the Filename box, update the error log file location to include ngie/bin folder.
3. Click OK.
Note
You must also change the error log file location for the DATA_PATH_1 variable. You can
find this variable under the Parameters tab in SCCM_CMDB_Import main job properties.
BMC Atrium Core 9.0
Page 2177 of 2268
Home
Failure when running Normalization Engine jobs

SCCM installer is shipped with Atrium Integrator, Normalization Engine, and Reconciliation Engine
jobs. Normalization Engine jobs might fail to run after the Atrium Integrator jobs. In such a case,
make sure that each transformation that SCCM has discovered has data mapped to Category /
Type / Item / ManufactureName / Model. It is mandatory to have the data in this format in order to
normalize that instances that Atrium Integrator creates.
Data model issues

This section provides instructions about verifying your data model. You can view and troubleshoot
issues with your data model by using the cmdbdiag program and by using manual steps.
Verifying your data model manually
Verifying your data model using the cmdbdiag program
Cleaning up CMDB data by using the CI and Relationship Correction Tool option
Troubleshooting a failed data model change
In addition, you can validate the Common Data Model (CDM) definitions by running the Atrium
Maintenance Tool and performing the health check as described in Performing health check.
Review the CDMChecker validation results. If validation fails, check the missing_fields.log file
generated in the AtriumCore/Logs directory.
Verifying your data model manually

Perform the following steps to verify that the class definitions in your data model are correct.
To manually verify your data model

1. Examine the arerror.log and cmdbengdebug.log files for any errors about starting the
cmdbEngine.
Search for the string cmdbEngine to find errors. When cmdbEngine is started, it validates
the class definitions. The following example shows the error message that you might view in
arerror.log:
Mon Dec 11 16:10:18 2006 390600 : The specified super class with
given classId is not found. : Class ID:
OB005056C00008PlV3RQU3oZAAHO8C, Super Class ID:
OB005056C00008F1V3RQd#IYAAD90C (ARERR 120132)
For more information about arerror.log, see AR System server logging. For more
information about cmdbengdebug.log, see BMC Atrium Core Console server-side logging .
2. Run the CDMChecker command line executable in the same directory as cmdbdriver, with
the -g parameter.
3.
BMC Atrium Core 9.0
Page 2178 of 2268
Home
3. Run cmdbdiag and provide logon credentials.

If cmdbdiag logs on, it tells you that the Configuration Management Database (CMDB) is
responding to BMC Atrium CMDB API calls. Alternatively, run the Health Check from BMC
Atrium Core Maintenance Tool.
Note
If you receive an AR 91 RPC call failed error, verify that cmdbEngine is running.
This error might also occur if the class definitions in the your data model are incorrect.
cdmchecker commands
cdmchecker -x <filename> -u <username> -p <password> -s <server> -t <tcp
port>
Exports the CDM to an .xml file specified by the <filename>. The XML format is the format used
by the regular CMDB Export API.
cdmchecker -c <filename> -u <username> -p <password> -s <server> -t <tcp
port> -ch
Compares the target CDM with the CDM in the xml file specified by <filename>. This option is
useful to determine the customizations in the environment. Run CDMChecker with the -x option on
a QA box and use this file for the -c option in the problematic environment. CDMChecker points
out the class differences, the new attributes, the changed attributes, and so on. Additionally you
can use the -ch option with the -c option to view the differences in classes, attributes
characteristics and custom characteristics in the output. Using -ch is optional.
cdmchecker -m -u <username> -p <password> -s <server> -t <tcp port>
Compares the CMDB Class meta data with the underlying AR forms and points out the differences.
This is the CDMChecker validation performed by the Health Check and written to
missing_fields.log.
cdmchecker -g -u <username> -p <password> -s <server> -t <tcp port>
This option determines if there are classes and attributes in pending state.
Verifying your data model using the cmdbdiag program

The cmdbdiag program is a command-line tool, which is located in the cmdb\server64 directory of
your BMC Atrium Core installation. This program allows you to check for any invalid data in BMC
Atrium Configuration Management Database (BMC Atrium CMDB) and correct it.
Working with the Data Integrity Checker option
BMC Atrium Core 9.0
Page 2179 of 2268
Home
To start the cmdbdiag program

To troubleshoot invalid relationships
To troubleshoot invalid dataset IDs
To troubleshoot invalid CI relationships
Working with the Data Integrity Checker option

The Data Integrity Checker validates BMC Atrium CMDB for the various issues based on the menu
option you choose. If the Data Integrity Checker finds invalid data, it creates a report that contains
information about the invalid relationship instances and datasets.
To start the cmdbdiag program

When you launch cmdbdiag, provide your BMC Remedy AR System logon credentials for the
computer hosting BMC Atrium Core.
1. Navigate to the appropriate location where you copied the cmdbdiag program and perform
the following step:
On Windows, double-click cmdbdiag.exe.
On UNIX, type cmdbdiag.
2. From the initial screen for the cmdbdiag program, log on to the AR System server. The
cmdbdiag program Main Menu appears.
To troubleshoot invalid relationships

Check for invalid relationships relationship instances that point to nonexistent Configuration Item
(CI) instances or relationships that contain incorrect endpoint information, such as incorrect dataset
ID or class ID.
1. Start the cmdbdiag program.
2. At the Main Menu prompt, type 1.
3. At the Data Integrity Checker prompt, type 1.
4. At the All datasets [y, n] prompt, perform the appropriate action:
To view invalid relationships for all datasets, type y.
To view invalid relationships for a specific dataset, press Enter and provide a dataset
ID.
5. Enter a name for the output file, or press Enter to accept the default file name.
If you enter a file name manually, specify an absolute path for the file (for example, C:\
DIC_Invalid_Relationships.txt). Otherwise, the program saves the report file in the same
directory as the cmdbdiag program.
To troubleshoot invalid dataset IDs

Check for invalid dataset IDs Incorrect dataset IDs specified for CI and relationship instances. A
dataset ID might be incorrect if it refers to:
A nonexisting dataset
BMC Atrium Core 9.0
Page 2180 of 2268
Home
Contains a value of 0 or NULL

4. Specify a name for the output file or press Enter to accept the default file name.
If you manually enter a name, you must specify an absolute path for the file (for example: C:\
dataset_ids.txt ). Otherwise, the program saves the report file in the same directory as the
cmdbdiag program.
To troubleshoot invalid CI relationships

Check for relationship cardinality issues invalid relationships that are caused by a violated
relationship cardinality, which occurs when a relationship between CI classes does not fall into one
of the following categories:
One to one
One to many
Many to one
To check for relationship cardinality issues for all datasets, type y.
To check for relationship cardinality issues for a specific dataset, press Enter and
provide a dataset ID.
4. Specify a name for the output file or press Enter to accept the default file name,
test_cardinality.txt.
If you manually enter a name, you must specify an absolute path for the file (for example: C:\
DIC_Cardinality.txt ). Otherwise, the program saves the report file in the same directory as
the cmdbdiag program.
5. To exit the Data Integrity Checker option, type 4.
Cleaning up CMDB data by using the CI and Relationship

Correction Tool option
The following topics explain how to use the CI and Relationship Correction Tool option to clean up
data in BMC Atrium Configuration Management Database (BMC Atrium CMDB):
Resetting reconciliation identities
Deleting instances in a dataset
Correcting invalid relationship instances
Deleting orphan relationships
Deleting relationships that violate cardinality
Deleting instances for a given class
BMC Atrium Core 9.0
Page 2181 of 2268
Home
Correcting orphaned weak members

Deleting orphaned weak members
Resetting reconciliation identities

This procedure resets reconciliation IDs to 0, which allows the Reconciliation Engine to assign
correct reconciliation IDs during the next reconciliation process.
You might need to reset reconciliation IDs of Configuration Items (CIs) in your source or destination
dataset if they are identified incorrectly or if your reconciliation rules are configured incorrectly.
When you reset reconciliation IDs by using the By Class option, IDs of component instances related
to weak relationships are also reset. For example, if you reset the IDs of BMC_ComputerSystem
instances, the IDs of components (such as BMC_DiskDrive and BMC_Monitor ) that are related
to those instances through BMC_HostedSystemComponents relationships are also reset.
To reset reconciliation identities

For information about starting the cmdbdiag program, see Verifying your data model using
3. At the CI and Relationship Correction Tool submenu prompt, type 1.
4. At the By dataset or class prompt, perform the appropriate action:
To reset reconciliation IDs in all datasets, type class.
Enter the namespace within which the class exists, or press Enter to accept the
default value of BMC.CORE.
Enter the name of the class.
Type y to reset reconciliation IDs for all instances of the class, or press Enter to reset
the reconciliation ID for specific instances.
If you are resetting IDs for all instances in the class, skip to the next step. If you are
resetting IDs for specific instances, enter the number of instances for which you want
to reset the reconciliation IDs.
Enter the ID of the first instance for which you want to reset the reconciliation ID and
follow the prompts to specify each instance that you want to reset.
To reset reconciliation IDs in a specific dataset, press Enter and provide a dataset ID.
5. At the Do you want to continue prompt, type y to reset reconciliation identities
Deleting instances in a dataset

Use this procedure to delete instances that you no longer need (for example, datasets created in a
test environment). When deleting instances, their relationships are also deleted automatically to
maintain data integrity.
BMC Atrium Core 9.0
Page 2182 of 2268
Home
To delete instances in a dataset

2. Log in to the AR System server and type 2 at the Main Menu prompt.
To delete instances in all datasets, type y.
To delete instances in a specific dataset, press Enter and provide a dataset ID.
Correcting invalid relationship instances

Use this procedure to delete relationships for which either of the Configuration Item (CI) endpoints
does not exist. For each endpoint of a relationship instance, the program can correct the class ID,
dataset ID, and reconciliation ID.
To troubleshoot invalid relationship instances

2. For information about starting the cmdbdiag program, see Verifying your data model using
3. Log in to the BMC Remedy AR System server and at the Main Menu prompt, type 2.
To correct invalid relationship instances in all datasets, type y.
To correct invalid relationship instances in a specific dataset, press Enter and provide
a dataset ID.
If you enter a file name manually, you must specify an absolute path for the file (for example,
C:\CorrectRelationshipsReport.txt ). Otherwise, the program saves the report file in the
same directory as the cmdbdiag program.
7. At the Do you want to continue? prompt, type y to correct invalid relationships.
Deleting orphan relationships

Use this procedure to delete relationships that might have nonexistent Configuration Item (CI)
endpoints.
To delete orphan relationships

2.
BMC Atrium Core 9.0
Page 2183 of 2268
Home
To delete orphan relationship instances in all datasets, type y.
To delete orphan relationship instances in a specific dataset, press Enter and provide
a dataset ID.
C:\DeleteOrphanedRelsReport.txt ). Otherwise, the program saves the report file in the
same directory as the cmdbdiag program.
6. At the Do you want to continue prompt, type y to delete orphan relationships.
Deleting relationships that violate cardinality

Use this procedure to delete relationships that might have violated the one-to-one, one-to-many, or
many-to-one cardinality.
To delete relationships that violate cardinality

To delete violated cardinality relationships in all datasets, type y.
To delete violated cardinality relationships in a specific dataset, press Enter and
provide a dataset ID.
5. If you want to delete all the instances in violation automatically, type y at the Do you want to
automatically delete all instances? [y, n] prompt.
6. Type y again to confirm automatically deleting all instances in violation. Otherwise, press
Enter to accept the default value of n (no).
The automatically delete option deletes instances based on their create date and time. The
violated instance that is created most recently will be deleted. A copy of the deleted instance
is saved in an XML file called <instanceId>.xml in the current directory.
If you type n at the prompt, the list of violated instances is displayed and you are prompted
for confirmation before deleting each instance. An XML backup is generated.
7. Enter a file name for the output file, or press Enter to accept the default file name.
C:\FixCardinalityViolations.txt ). Otherwise, the program saves the report file in the same
directory as the cmdbdiag program.
BMC Atrium Core 9.0
Page 2184 of 2268
Home
Deleting instances for a given class

Use this procedure to delete instances of a class altogether to clean up data. When you delete
instances of a given class, the orphaned weak relationship is also deleted to maintain data integrity.
To delete instances for a given class

To delete instance for a class in all datasets, type y.
To delete instance for a class in a specific dataset, press Enter and provide a dataset
ID.
4. Enter the namespace name of the class for which you want to delete all instances.
5. Enter the class name to which the instances that you want to delete belong.
6. At the Do you want to continue prompt, type y to delete all instances of the specified class.
If you type n at the prompt, the CI and Relationship Correction Tool sub-menu is displayed.
For orphaned weak members, you are prompted to choose to fix or delete the weak member
. For orphaned weak relationships, you are prompted to choose to delete the weak
relationship.
Correcting orphaned weak members

A weak member of a weak relationship is orphaned when you delete a strong member and leave
the weak member of the composite relationship pointing to a nonexistent Configuration Item (CI)
instance.
You can correct an orphaned weak member of a weak relationship by setting NULL values for the
attributes that are propagated from the strong member. When you correct a weak member, it
remains in the BMC Atrium CMDB as an independent CI instance with no relationships.
If you correct orphaned weak relationships for all datasets, attributes of orphaned instances of all
classes are set to NULL. If you correct orphaned weak relationships of a specific class in any
dataset, only the instances of that specific class are corrected.
To correct orphaned weak members

2. Log on to the BMC Remedy AR System server and at the Main Menu prompt, type 2.
4.
BMC Atrium Core 9.0
Page 2185 of 2268
Home
4. At the Fixing Orphaned Weak Members menu, type 1 to correct orphaned weak members in
all datasets. If you want to correct orphaned weak relationship members for a specific class,
skip to step 5.
a. At the All datasets [y, n] prompt, type y to correct orphaned weak members in all
datasets.
b. At the Do you want to continue prompt, type y.
c. To correct orphaned weak members in a specific dataset, press Enter and provide a
dataset ID.
5. At the Fixing Orphaned Weak Members menu, type 2 to correct orphaned weak members
for a specific class.
a. At the All datasets [y, n] prompt, type y to correct orphaned weak members in all
datasets.
b. To correct orphaned weak members in a specific dataset, press Enter and provide a
dataset ID.
c. Enter the namespace name of the class for which you want to correct all orphaned
weak members.
d. Enter the class name to which the orphaned weak members that you want to correct
belong.
Deleting orphaned weak members

Use this procedure to delete an orphaned weak member of a weak relationship. A weak member of
a relationship is orphaned when you delete a strong member and leave the weak member of the
composite relationship pointing to a nonexistent Configuration Item (CI) instance.
To delete orphaned weak members

2. Log on to the BMC Remedy AR System server and at the Main Menu prompt, type 2.
4. At the Deleting Orphaned Weak Members menu, type 1 to delete orphaned weak members
in all datasets. If you want to delete orphaned weak relationship members for a specific class
, skip to step 5.
a. At the All datasets [y n] prompt, type y to delete orphaned weak members in all
datasets.
b. At the Do you want to continue prompt, type y.
c. To delete orphaned weak members in a specific dataset, press Enter and provide a
dataset ID.
5. At the Deleting Orphaned Weak Members menu, type 2 to delete orphaned weak members
for a specific class.
a. At the All datasets [y, n] prompt, type y to delete orphaned weak members in all
datasets.
b.
BMC Atrium Core 9.0
Page 2186 of 2268
5.
Home
b. To delete orphaned weak members in a specific dataset, press Enter and provide a
dataset ID.
c. Enter the namespace name of the class for which you want to delete all orphaned
weak members.
d. Enter the class name to which the orphaned weak members that you want to delete
belong.
Troubleshooting a failed data model change

If the class or the attribute that you modified in the Class Manager displays a Change Pending icon
or if its status changes to Error, your changes might not have been saved to your data model.
1. In the Class Manager, click Table View.
2. Click the Status column to sort by Status.
If classes have a status of Change Pending, allow them more time to complete the
synchronization process.
For any classes which display a status of Error, mouse over the Status to display the error
message. The error message typically describes the reason for the failure.
To view more information on error messages, see Working with error messages.
Verify the underlying AR System data structures are consistent with the current
CMDB class definitions
1. Launch BMC Atrium Core Maintenance Tool
2. Perform the Health Check.
3. Verify the output for CDMChecker reports the status of Successful.
If necessary, collect more verbose logs to capture the failure by enabling CMDB Server side
logging as described in Server-side API logging.
Additional diagnostics
1. Enable API, SQL, and Filter logging.
2. Recreate the failure.
3. Disable the logs.
4. Launch BMC Atrium Core Maintenance Tool and click Zip All Logs. This step captures both
AR System and BMC Atrium Core Logs.
5. Launch AR System Maintenance Tool on the system running Mid-Tier and click Zip All Logs
.
BMC Atrium Core 9.0
Page 2187 of 2268
Home
Reconciliation Engine issues

The following topics provide information about troubleshooting various Reconciliation Engine issues
, such as Reconciliation Engine job, log, and definition export issues:
Reconciliation Engine startup issues
Reconciliation Engine configuration issues
Reconciliation Engine job issues
Reconciliation Engine unidentified instances issue
Reconciliation Engine logging issues
Reconciliation Engine multiple CI match issues
Reconciliation Engine merge activity issues
Reconciliation performance issues
Reconciliation Engine startup issues

The Reconciliation Engine process is started using armonitor.cfg on Microsoft Windows or
armonitor.conf on UNIX. If the Reconciliation Engine is not running, perform the following steps:
1. Open the armonitor.cfg (armonitor.conf) file.
2. Verify that the configuration file contains an entry for the arrecond process and that and it is
not commented out.
3. Depending on the platform you have installed, perform the following steps:
Microsoft Windows In the armonitor.cfg file, the value specified for the -i
parameter must be the same as the Monitor-directory parameter in the
armonitor.cfg file.
UNIX In the arrecond.sh script file, make sure that the -i parameter points to /etc
/arsystem/<ARInstanceName>/.
For more information about the armonitor.cfg file, see armonitor.cfg or
armonitor.conf in the BMC Remedy AR System online documentation.
4. If you modified the armonitor.cfg file, restart the AR System service to run the
Reconciliation Engine process.
Reconciliation Engine configuration issues

The BMC Atrium Core server notifies the Reconciliation Engine when configuration changes are
made using the Settings link from the navigation bar on the Reconciliation Manager tab. The
Reconciliation Engine then periodically checks whether a signal failed to be successfully delivered.
Note
BMC Atrium Core 9.0
Page 2188 of 2268
Home
If the configuration changes are not immediately implemented in the Reconciliation Engine
, you might need to query the Application Pending form to view the configuration changes
record. The record will no longer be visible if the changes have been implemented. If you
are still able to view the record, wait for a few minutes and then try again.
To make sure that the configuration changes are implemented in the Reconciliation
Engine
1. Query the Application Pending form for the configuration changes record.
If you do not view the record anymore, it means that the changes have already taken affect.
2. If you view the record in the Application Pending form, you might need to wait longer for the
changes to be implemented.
Reconciliation Engine job issues

The following topics provide general information about failed and aborted jobs.
Failed jobs
Aborted jobs
The following topics provide information about troubleshooting other Reconciliation Engine job
issues:
Reconciliation Engine aborted jobs due to being abruptly restarted
Reconciliation Engine aborted jobs due to insufficient memory
Reconciliation Engine aborted jobs and the Class ID does not exist error
Reconciliation Engine jobs that do not start
Reconciliation Engine jobs that do not finish
Failed jobs
If a fatal error occurs during any activity that is processing information, the job is canceled. As a
result a related event is created, which you can view on the Administrative Information tab of the
Reconciliation menu, identifying the job, the activity that failed, and the reason for the failure.
However, in case of non-fatal instance errors, the job might continue to run. An error event is still
created, but the job moves to the next activity. The instance for which the error was generated is
not successfully identified or merged. To resolve this issue, correct the error with the instance and
either manually identify and merge the instance, or use the BMC Atrium CMDB C API
CMDBStartJobRun function.
The Reconciliation Engine does not automatically retry jobs that fail or attempt to catch up with jobs
that were not executed (for example, the service was down). Failed jobs are started at the next
scheduled time, if a schedule exists. Unless the problem is corrected, the job will continue to fail.
BMC Atrium Core 9.0
Page 2189 of 2268
Home
Aborted jobs
To determine the cause of the incomplete job issue, use the troubleshooting steps discussed in this
section. When you manually start a job or when the Reconciliation Engine runs a scheduled job, it
can be aborted or paused for the following reasons:
ARERR 101008 The job is already running If the Reconciliation Engine
attempts to start a job that is already running, the job is aborted or paused.
ARERR 101041 Class id <classId> of namespace <namespace> does not
exist If the IDs of the class name or attribute name specified in the Precedence Group
does not exist, the job is aborted or paused. This error message is displayed if the Class
Instance ID and the Attribute Instance ID attributes of the class and attribute
specified in the Precedence Group contain a NULL value.
Failure with a temporary file. No space left on device. If the
Reconciliation Engine stopped responding because of insufficient temporary disk space for
BMC Remedy AR System server operations, the job that was already running is aborted or
paused.
Unspecified details in the job If you did not specify the required details in the
job definition, such as dataset ID, the job is aborted or paused.
Malloc failed on server If the computer on which you are running the
Reconciliation Engine does not have enough memory, all jobs that are currently running are
aborted or paused.
Rebooting AR System server abruptly If the Reconciliation Engine job is running
and you reboot the AR System server, the job is aborted or paused. To resolve the aborted
job error that results from restarting the AR System server, restart the job.
Reconciliation Engine aborted jobs due to being abruptly restarted

If you abruptly restarted the Reconciliation Engine, the Related Runs table might indicate that the
job has started, but the job might not be actually running.
To troubleshoot issues caused due to abrupt restarting of the Reconciliation Engine

1. Log in to the BMC Atrium Core Console and navigate to:
Application Launcher > Applications > Reconciliation
2. Click the History tab.
3.
4.
5.
6.
From the Show all Job Runs With Status list, select Started.
Specify the start date and end date for the job.
Make sure that there are no records displayed in the results table.
Log on to your BMC Remedy AR System server as an Administrator.
7. Open the Reconciliation Job Runs form in Search mode and click the Search button on the
toolbar.
8. Select the record that has a value of Started in the Run Status column.
9. From the main menu, choose Actions > Delete.
10.
BMC Atrium Core 9.0
Page 2190 of 2268
Home
10. Verify that the Application Pending form contains no extra records that instruct the
Reconciliation Engine to trigger the same job.
Extra records that trigger the same job might be created when you manually start a job and
click the Start Job button several times.
11. To resolve the unspecified details error, examine the arrecond.log and the Reconciliation
Engine log file for errors.
If you did not specify a path for the Reconciliation Engine log file using the Settings option
on the Reconciliation Manager console, the arrecond.log and Reconciliation Engine log files
are located in the C:\Program Files\BMC Software\AtriumCore\logs subdirectory of by
default. For more information about setting the log file location for the Reconciliation Engine,
see Reconciliation Engine logging.
Reconciliation Engine aborted jobs due to insufficient memory

If your computer does not have enough memory space, your reconciliation jobs might abort. For
more information about the software and hardware requirements for BMC Atrium Core, see the
BMC Atrium Core installation information.
To troubleshoot jobs aborted due to insufficient memory

1. Check the arerror.log file to determine whether problems with the BMC Remedy AR System
server or arrecond executable occurred.
For more information about the arerror.log file, see AR System server logging.
2. Monitor the amount of memory available on your computer and check the processes that are
consuming large amounts of memory.
3. Add more disk space to the server TEMP disk or redirect TEMP to another disk that has
more disk space.
4. Examine arrecond.log and the Reconciliation Engine job log files to determine the operation
that the Reconciliation Engine was performing when the insufficient memory error was
generated.
For more information about Reconciliation Engine logs, see Reconciliation Engine logging.
5. Make sure that the server has enough resources, such as virtual memory and space for
BMC Atrium CMDB tasks.
Due to intensive data manipulation, the Reconciliation Engine might need to use more virtual
memory than available.
6. If the reconciliation job uses the Copy activity, make sure that Copy Relationship field is set
to By Qualifier to avoid insufficient memory issues.
Reconciliation Engine aborted jobs and the Class ID does not exist error
You might encounter the Class ID of namespace does not exist error message if the
class ID you specified is hidden, if a class with such a name does not exist, or if the class ID field is
blank.
BMC Atrium Core 9.0
Page 2191 of 2268
Home
To troubleshoot classId does not exist error message

1. In BMC Remedy Developer Studio, search for the RE:Precedence form.
2. Double-click the Debug_pag field that contains the Debug tab.
3. Clear the Visible box on the Display page and save the form.
4. Search for the Precedences form from the Object List.
5. Open the Precedences form in Search mode and click Search again.
6. Select the specific precedence from the Search results list and make sure that the Class
Instance ID and the Attribute Instance ID fields are not blank.
7. Delete the job entry that is assigned with the given Precedence Group.
8. In the Reconciliation Manager Console, create the job entry again and run the job.
Reconciliation Engine jobs that do not start

Perform the following procedure when you notice that Reconciliation Engine jobs on the Job History
Console are not running even though they were scheduled to run.
To troubleshoot scheduled jobs that did not start

1. Log on to the BMC Atrium Core Console and click Reconciliation.
For information about logging on to the console, see Navigating the interface.
2. Click the Administrative Information tab and verify that the Job status for the specific job is
set to Active.
3. Verify that the arrecond.exe process (Reconciliation Engine) is running and that its process
ID (PID) is not changing every minute.
The Reconciliation Engine process ID must remain the same, which denotes that the
dispatcher is not abruptly restarting.
4. In the armonitor.log file, check whether there is an entry indicating that the arrecond.exe
process is restarting every few seconds.
5. Verify that the Reconciliation Engine is connected to the correct BMC Remedy AR System
server instance.
For information about how to verify that the Reconciliation Engine is connected to the correct
AR System server instance, see Step 8 of Reconciliation Engine logging issues.
Tip
To verify that a specific process is running on a Microsoft Windows computer, view
the Processes tab on the Task Manager. On UNIX, use the ps - ef | grep <
processName> command.
6. If the Reconciliation Engine is not running or if it is not connecting to the AR System server,
search the arerror.log, and armonitor.cfg (armonitor.conf ) files for errors.
7.
BMC Atrium Core 9.0
Page 2192 of 2268
Home
7. Wait for a few seconds for the record in the Application Pending form to be processed and
the job to start.
The job usually starts within a few seconds when the dispatcher is running correctly. The
dispatcher instructs the Reconciliation Engine to perform tasks based on the entry in the
Application Pending form.
Tip
Search for the Application Pending form and open it in Search mode to view the job
record.
8. Perform the following steps to verify that the dispatcher is running:

a. To verify that the dispatcher is configured to run, search for the arsvcdsp.exe
process in the armonitor.cfg file.
b. From the Microsoft Windows Task Bar or UNIX console, verify that the dispatcher
process is running and that its process ID is not changing every minute.
The dispatcher process ID must remain the same, which denotes that the dispatcher
is not abruptly restarting.
9. If the dispatcher is not running, wait for the amount of time specified in the Polling Interval
field on the Server Configuration Editor dialog box.
Tip
You can also reduce the Polling Interval time. This ensures that the arrecond.exe
process polls the Reconciliation Engine job queue more often.
10. If the arrecond and arsvcdsp processes are running, but the Application Pending entry is
not processed, perform the following steps to enable dispatcher logging.
a. In the ar.cfg (ar.conf ) configuration file, set the Dispatch-Log-File entry to <
fullPath>/dispatch.log.
b. Restart the AR System server.
11. For jobs that are started by way of workflow or Execute Job activities, verify that the job
name is correct and that the status of the specified job is Active on the Job History Console.
12. Examine arerror.log to verify that the server was down for maintenance during a scheduled
run of the Reconciliation Engine Job.
Reconciliation Engine jobs that do not finish

At times, the Reconciliation Engine might take several minutes to update the status of your job to
Successful or Failed. This might cause you to believe that the job did not finish. In such a case,
perform the following procedure to verify that the job is still running and that the Reconciliation
Engine did not generate any errors.
BMC Atrium Core 9.0
Page 2193 of 2268
Home
To troubleshoot Reconciliation Engine scheduled jobs that did not finish

1. Check the arerror.log log to determine whether any errors occurred with the BMC Remedy
AR System Server or the arrecond.exe process.
If the AR System server or the arrecond.exe process stops responding, they are restarted
and the status of the Reconciliation Engine job is changed to Aborted. However errors, such
as ARERR 93 in the arerror.log log, can point to failures caused by performance or AR
System connection issues.
2. Check the Reconciliation Engine Job log for any information about Reconciliation Engine
activities.
Verify that the last line of the Reconciliation Engine Job log indicates that an activity was
completed.
3. Check the Reconciliation Engine Job logs for any plug-in errors.
For example, an ARERR 8755 The specified plugin does not exist error
message might indicate an issue with the BMC Service Impact Manager extensions to the
BMC Atrium CMDB.
Tip
The Reconciliation Engine job logs follow the <jobName>_<fileNumber> naming
convention, where the job name refers to the name of the job to be executed and
the file number indicates the number of files created for the job + 1. If you specified
a file size limit, multiple files for a single job run will be created, for example,
MergeComputers_1, MergeComputers_2, and so on.
4. Check the arrecond.log log for errors.
Reconciliation Engine unidentified instances issue

If the Reconciliation Engine cannot find a match for an instance after applying all the identification
rules, or if the instance is part of an Identification group that you did not specify to be auto-identified
, the instance remains unidentified.
In such a case, you must manually identify the instance or modify the identification rules. For
information about manually identifying data, see Manually identifying data by using the
To troubleshoot the unidentified instances issue

1. Log in to the BMC Atrium Core Console and click Reconciliation.
For information about logging in to the console, see Navigating the interface.
2.
BMC Atrium Core 9.0
Page 2194 of 2268
Home
2. Click the History tab and verify that the specific job was successfully executed after the
modified date of the configuration item (CI).
Reconciliation Engine jobs are typically named after the dataset that is used in the job. To
determine the datasets that the job identifies, from the Administrative Information tab view
the Identification activity.
3. Verify that the Dataset ID of the CI matches one of the defined Dataset IDs.
4. Verify that a qualification group is defined for the Identification activity.
5. If a qualification group is defined, verify that the CI meets the qualification.
6. Verify that the superclass and subclasses of the unidentified instance are included in the
Identification rule of the Identification Group.
7. Perform the following steps to troubleshoot the issue using Reconciliation Job Logs.
a. Choose a test case from the Manual Identification Console, and click View.
b. Note the value in the Name, Instance ID, Class ID, Dataset ID, and Modified Date
fields.
8. Click Edit Server Configuration on the toolbar and configure the following settings for the
Reconciliation Engine log:
a. Max Log File Size (kilobytes) = 20000
This setting enables you to zip the multiple log files for the same job and save them to
another system in case the log files exceed 20 megabytes (MB).
b. Logging level = Debug
9. Start the Reconciliation Engine Job again and wait for it to complete.
10. Search for the Instance ID of your test instance in the Job log to find the entry, such as the
following entry:
[DETAILS] [TID: 000006]: Started identifying instance <class = BMC.CORE:

BMC_ComputerSystem, instance id = OI 1F94C10B39834F35BFDB59EEC3791F96>
Note
The DETAILS and TRACE entries appear only if you set the logging level to Debug
.
For information about how to search the log file for the identifying instance entry, see
Interpreting entries in the log file .
Reconciliation Engine logging issues

If the Reconciliation Engine contains incorrect log path settings or insufficient permissions to write
to the log directory, or if the Reconciliation Engine stopped responding, logging might be abruptly
stopped.
BMC Atrium Core 9.0
Page 2195 of 2268
Home
To troubleshoot Reconciliation Engine logging issues

1. Log in to the BMC Atrium Core Console.
For information about logging in to the console, see Navigating the interface.
2. From the Application Launcher, click Reconciliation.
3. Click Edit Server Configurationon the toolbar and configure the following settings on the
Server Configuration Editor window.
a. From the Logging Level list, select Info.
Setting this option enables the log to capture information about warnings and error
messages. This level also includes class level and dataset level information.
b. In the Maximum Log File Size (kilobytes) list, type 1000.
This sets the maximum size of the log file to 1000 KBs.
c. In the Log File Path field, specify the correct log path.
When you specify the log file path, make sure that:
The directory exists on the BMC Remedy AR System server.
It is a directory, not a file name.
The Reconciliation Engine has permissions to create files in that directory.
For testing purposes, specify a short log file path with no spaces.
On Microsoft Windows, for example, C:\RELog.
On UNIX, for example, /tmp/RELog/.
If you do not specify a log file path or if the log file path is empty, the
Reconciliation Engine log is generated in the Db subdirectory of your AR
System server installation directory by default. For more information about the
log settings, see Reconciliation Engine logging.
4. In the ar.cfg (ar.conf ) configuration file, verify that the settings you configured in step 3 are
updated on the AR System server.
The ar.cfg configuration file contains AR System server configuration changes. This file is
located in the C:\Program Files\BMC Software\ARSystem\Conf subdirectory of your AR
System server installation directory. For more information about the ar.cfg file, see ar.cfg or
ar.conf in the BMC Remedy Action Request System online documentation.
Tip
You can also manually update the ar.cfg or ar.conf file to match the entries in the
Modify Server Configuration window of the Reconciliation Manager and restart the
Reconciliation Engine to configure the settings.
5.
BMC Atrium Core 9.0
Page 2196 of 2268
Home
5. If you configured the server configuration settings (see step 3) using the BMC Atrium Core
Console and if these settings are not updated in the ar.cfg or ar.conf file, query the
Application Pending form for records where 'Category' = "Reconciliation".
This enables you to verify that the Application Pending form contains an Update-Config
record for the Reconciliation Engine.
6. On the AR System server, verify that:
The Reconciliation Engine is running.
The process name for the Reconciliation Engine is arrecond.exe on Windows and
arrecond on UNIX.
The value in the process ID field is not changing.
Tip
To verify that the process ID frequently changes, note its value every few
minutes.
When the Reconciliation Engine process stops abruptly, the armonitor configuration
file restarts the process and a new process ID is assigned to it. Therefore, the
changing process ID value indicates that the Reconciliation Engine is constantly
restarted.
7. Verify that the arrecond.log file exists on the AR System server.
The Reconciliation Engine creates the arrecond.log and a log file named <
reconciliationJobName_integer>.log, for example, BMCAsset - Identification_5.log. The
arrecond.log tracks Reconciliation Engine scheduling. For more information about
Reconciliation Engine logging, see Reconciliation Engine logging.
8. Perform the following steps to verify that the ar.cfg (ar.conf) configuration file is set up
correctly:
a. Open the armonitor.cfg (armonitor.conf ) file on the AR System server.
The armonitor.cfg file contains the commands that the armonitor binary executes.
On Windows, this configuration file is located in the C:\Program Files\BMC Software
\ARSystem\Conf subdirectory of your AR System server installation directory. On
UNIX, it is located in the /etc/arsystem/<ARInstanceName>/ subdirectory. For more
information about the armonitor.cfg file, see armonitor.cfg or armonitor.conf in the
BMC Remedy Action Request System online documentation.
b. In the configuration file, search for the line entry that runs the arrecond.exe
executable (Windows) or arrecond.sh(UNIX).
Tip
To view the arrecond.sh script, open it in a UNIX editor.
c.
BMC Atrium Core 9.0
Page 2197 of 2268
Home
c. Note the value that is specified for the -i parameter.

The value specified for this parameter is a directory name, which must be the same
as the AR System server installation directory.
d. If the directory name for the -i parameter is different than the AR System server
installation directory, change it to match the AR System directory name.
Reconciliation Engine multiple CI match issues

Reconciliation jobs might fail because the Reconciliation Engine finds multiple matches in the
source or target (BMC.Asset) dataset. The jobs fail under the following circumstances:
The Configuration Items (CI) remains unidentified in the source dataset after an Identification
activity and the Reconciliation Engine log shows the message, The dataset ID and
Reconciliation Identity combination is not unique . This error occurs when
you create a new CI to represent a rediscovered object rather than unmarking a soft-deleted
CI.
The Configuration Items (CI) remains unidentified in the source dataset after an Identification
activity and the Reconciliation Engine log shows the error message, Found multiple
matches in the dataset: Cannot identify the instance of class <
className> with instance ID <instanceId> . This error occurs because the Find
in Dataset field for the specific Identification Rule contains two or more CIs that share the
same value for the attribute defined in the Identification Rule.
The following topics provide information on resolving these issues:
To resolve duplicate CIs in the source dataset
To resolve duplicate CIs in the BMC.Asset target dataset
Flowchart of duplicate CIs in the source dataset
Flowchart of duplicate CIs in the BMC.Asset target dataset
Related topics
To resolve duplicate CIs in the source dataset

1. In the BMC.CORE:BMC_BaseElement form, search for the CI in the source dataset using
the specific reconciliation ID and dataset ID.
The search might return more than one CI in the Source dataset with the same reconciliation
ID and dataset ID.
2. If the search returns multiple CI records, determine whether any of them has been soft
deleted. If so, delete the soft-deleted CI.
3. If the duplicate CI is not soft deleted, reexamine the Identification Rule to verify that the
qualification that you specified fails to return unique CIs. If so, make appropriate corrections
to the qualification.
4. Run the Reconciliation Engine Identification activity to identify the CI.
BMC Atrium Core 9.0
Page 2198 of 2268
Home
To resolve duplicate CIs in the BMC.Asset target dataset

1. In the BMC.CORE:BMC_BaseElement form, search for the duplicate CIs using the attribute
values specified in the Find in Dataset field and any other attributes that you defined in the
Identification Rule.
For example, if you specified BMC.ASSET in the Find in Dataset field and 'TokenId' !=
$\NULL$ AND'TokenId' = $TokenId$ in the Qualification field of the Identification
Rule, search for the duplicate CIs using these values in the Datasetid and Tokenid fields on
the BMC.CORE:BMC_BaseElement form.
2. Perform the following steps to determine the problem:
Reexamine the Identification Rule to verify that the qualification that you specified fails
to return unique CIs. If so, make appropriate corrections to the qualification.
Examine the quality of data in the BMC.ASSET dataset. If you find multiple CIs in the
dataset that represent the same CI instance in your environment, delete all other
duplicate entries.
Only one CI must exist in the Find in Dataset with the specific dataset ID and
reconciliation ID combination.
3. Run the Reconciliation Engine Identification activity to identify the CI.
Flowchart of duplicate CIs in the source dataset

The following figure illustrates the overall steps you need to perform to troubleshoot the duplicate
CIs in your source dataset issue.
BMC Atrium Core 9.0
Page 2199 of 2268
Home
BMC Atrium Core 9.0
Page 2200 of 2268
Home
Flowchart of duplicate CIs in the BMC.Asset target dataset

The following figure illustrates the overall steps you need to perform to troubleshoot the duplicate
CIs in your source dataset issue.
BMC Atrium Core 9.0
Page 2201 of 2268
Home
Related topics
Reconciliation Engine merge activity issues

When you create a Merge activity in your reconciliation job, the Reconciliation Engine might
generate errors if it finds erroneous endpoint information or if the job attempts to merge the same
Configuration Items (CIs) multiple times.
The Reconciliation Engine fails to merge CIs during a Merge activity because of missing
endpoint for a relationship. The error message displayed in the Reconciliation Engine log
includes Cannot find the endpoint of relationship::<className> . This error
occurs if you manually modify a CI and fail to modify its relationship, causing data integrity
issues.
During a Merge activity, the same CI seems to be merged more than once. The error
message displayed on the Job History Console includes Algorithm: Including child
CIs and committing together. This error likely occurred because you selected
Commit Together or Commit Separately for the Include Child CIs? option of the Merge
activity but did not use a Qualification group to restrict the CIs to be merged. In this case, a
child CI in a composite object is merged once on its own and once as part of the composite
object.
This topic explains the solutions for erroneous endpoint information and CIs merged multiple times;
To resolve missing endpoints during the Merge activity
To resolve CIs merged multiple times
Related topics
To resolve missing endpoints during the Merge activity

1. Reset reconciliation ID to 0 for all instances in the specific dataset.
2. Start the Identification and Merge activity.
To resolve CIs merged multiple times

Select the Stand Alone option for the Include Child CIs? option of the Merge activity.
Alternatively, attach a Qualification group to the activity to exclude CIs that will also be
merged as part of a composite object.
Related topics
BMC Atrium Core 9.0
Page 2202 of 2268
Home
Reconciliation performance issues

The Reconciliation Engine might demonstrate performance issues if it finds that the number of
threads you configured for the AR System server were insufficient or if the database settings that
you specified were incorrect.
The Reconciliation Engine log file contains no more than one or two different thread IDs (TID
). This indicates that the AR System server is not configured to use multi-threads.
This problem might occur if you have not configured the Reconciliation Engine to create
multiple threads for different activities.
If the Reconciliation Engine takes more time than usual to complete a job, make sure your
database setting are correct. This issue can occur because of any of the following reasons:
The default cursor_sharing parameter in Oracle 10g is set to exact.
The Oracle database instance is allocated only a small amount of memory.
SQL Server is allocated insufficient amount of space in the tempdb database.
The following topics provides solutions for insufficient thread and incorrect database settings
To resolve insufficient thread settings
To resolve incorrect database settings
Stack trace for thread crashes
Related topics
To resolve insufficient thread settings

1. Log in to the BMC Atrium Core Console as an administrator, and click Reconciliation from
the Application Launcher menu.
2. Click Edit Server Configuration on the toolbar and specify 390698 or 390699 in the RPC
Socket field of the Server Configuration Editor window.
3. Click Save.
After you make the RPC Socket changes, the ar.cfg (ar.conf ) configuration file is updated
with the RE-RPC-Socket: 390698 or 390699 entry.
4. Log in to your AR System server.
5. Open the AR System Administration: Server Information form in Search mode and click
Search on the toolbar.
The Server Information for your AR System server is displayed.
6. Select the Ports and Queues tab.
The thread information for the server is displayed in the Server Queue table.
7. In the Server Queue table, increase the Max threads for any of the types of threads: Fast,
List, or Private.
BMC Atrium Core 9.0
Page 2203 of 2268
Home
The threads that you specify here are used when processing activities. BMC recommends that you
create CPU x 5 for the List queue and CPU x 3 for the Fast queue or CPU x 1.5 for the Private
queue. After you increase the threads, the ar.cfg(ar.conf ) configuration file is updated with an
entry for each of the thread types, for example, Private-RPC-Socket: 390698 2 4.
Warning
If you assign too many threads, for example 10 or 15, for any of these types, it can cause
a system resource issue. The number of threads you can assign for activities depends on
the number of CPU cores available in your computer and the number of connections the
database can accept. To avoid the Reconciliation Engine from locking out any users, BMC
recommends that you create 1.5 threads times the number of CPU cores where maximum
number of threads configured is n-1 compared to the max fast or list thread.
To resolve incorrect database settings

1. In Oracle, set the cursor_sharing parameter to force or similar to boost performance by
up to 30%.
2. Request your Oracle DBA to run Oracle Statspack.
This enables you to identify the database performance bottleneck.
3. Allocate extra dedicated disk space for the tempdb database in SQL Server.
4. Verify that:
The attributes used in qualification are also indexed if you are using a qualification in
the Identification Group.
The index statistics are regularly updated.
5. Request your Oracle DBA to collect and analyze the Automatic Workload Repository (AWR)
performance reports that were logged during the execution of the reconciliation job.
Stack trace for thread crashes

In BMC Atrium Core, stack trace information for thread crashes is logged in the arrecond.log file.
You can send the stack trace information to Customer Support to determine the file, function, and
line number that caused the crash. This feature requires no configuration and is available by default
.
When a thread crash occurs, the arrecond.log file contains an entry, as shown in the following
example. When you see the Thread Id <idnumber> crashed entry, provide BMC Support with
the Stack Begin line through the Stack End line. These lines provide information for locating the
function and line number.
2011/11/22 16:19:45.7414 [ ERROR ] TID: 0000000008 : Thread Id <000008> crashed

2011/11/22 16:19:45.7422 [ ERROR ] TID: 0000000008 : Stack Begin:
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:_1cGREUtilSDumpStackTraceUnix6Fl_v+0x110
BMC Atrium Core 9.0
Page 2204 of 2268
Home
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:REThreadImplDeath+0xe8
/lib/sparcv9/libc.so.1:0xcd9d4
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:UnixThreadStartRoutine+0x17c
/lib/sparcv9/libc.so.1:0xcd69c
2011/11/22 16:19:45.7558 [ INFO ] TID: 0000000001 : Reconciliation Engine started
2011/11/22 16:19:45.7561 [ ERROR ] TID: 0000000008 : Stack End
2011/11/22 16:19:45.7564 [ ERROR ] TID: 0000000015 : Thread Id <000015> crashed
2011/11/22 16:19:45.7568 [ ERROR ] TID: 0000000015 : Stack Begin:
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:_1cGREUtilSDumpStackTraceUnix6Fl_v+0x110
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:REThreadImplDeath+0xe8
/lib/sparcv9/libc.so.1:0xcd9d4
/opt/bmc/AtriumCore/cmdb/server/bin/arrecond:UnixThreadStartRoutine+0x17c
/lib/sparcv9/libc.so.1:0xcd69c
2011/11/22 16:19:45.7619 [ ERROR ] TID: 0000000015 : Stack End
2011/11/22 16:19:45.8370 DETAILS TID: 0000000001 : + getServerGroupState
Related topics

The Drift Management installer writes notes, warnings, error messages, and other information to
various log files. Drift Management also creates automatic incidents in BMC Incident Management.
This topic describes the log files, including their location, the types of information they contain, and
how to read the information. This topic also describes how to resolve issues in automatic incident
creation from Drift Management.
Installation logging
Automatic incident creation issues
Installation logging
Reviewing the log file details
Using log files to troubleshoot an installation
Reviewing the log file details

When the installation is finished, the installer also creates detailed log files for the Drift
Management application (BMC_Configuration_Drift_Management_InstallDetails.log ) and help (
BMC_Configuration_Drift_Management_Online_Help_InstallDetails.log ).
By default, these detailed log files are created in the Logs folder in the following locations. These
Logs folders are easily identified by the date and time in the name
BMC Atrium Core 9.0
Page 2205 of 2268
Home
C:\Program Files\AR System Applications\<ARS-server>\BMC Configuration Drift Management\

Logs\<folder-create-date&time>
/usr/arsystem/<ARS-server>/BMC_Configuration_Drift_Management/Logs/<folder-create-date&
time>/
For example (with Windows and UNIX):
C:\Program Files\AR System Applications\drifter\BMC Configuration Drift Management

Online Help\Logs\12.15.2008_at_02_34_52_PM_PST
/usr/arsystem/perflab12.labs.bmc.com/BMC_Configuration_Drift_Management Online Help/Logs
/09.07.2008_at_03_33_49_PM_PDT/
These logs list in detail the success of each of the steps the installation. The following describes the
various error-related severity levels :
Error-related severity levels listed in the details log
Severity
Description
Critical
Indicates that a condition affecting service has occurred. Immediate corrective action is required.
Major
Indicates that a problem with relatively high severity level has occurred, for example, the RIK (Remedy Installation Kit)
failed to import a certain .def or .arx file. It is likely that the normal use of the service will be affected.
[01/Oct/2008:09:56:13 \-0700|] [ARImportAction] major - - [ERROR] Import failed: C:\Program Files\AR

System Applications\dca2-vm-01\BMC Configuration Drift Management\BMC_Configuration_Drift_Management\ar\
dsmapp\en\dsm_roles.arx
Minor
Indicates that a problem with relatively low severity level has occurred. It is unlikely that the normal use of the service
will be affected.
[01/Oct/2008:09:56:16 \-0700|] [ARImportAction] minor - - [ERROR] Failed to import: C:\Program Files\AR

System Applications\dca2-vm-01\BMC Configuration Drift Management\BMC_Configuration_Drift_Management\ar\
dsmapp\en\dsm_roles_for_chg_int.arx.
For additional details please refer to:
C:\Program Files\AR System Applications\dca2-vm-01\BMC Configuration Drift Management\

BMC_Configuration_Drift_Management\ar\dsmapp\en\Logs\dsmapp_error.log
Warning
Indicates that a problem that affects service will or could occur. Diagnostic and corrective action is recommended.
Info
Indicates that the message output is normal (that is, what was expected). For example, a process begins, a process
finishes, status information is displayed, messages about the installed products, and so on. Samples include the
following messages:
[01/Oct/2008:10:03:35 \-0700|] [ARImportAction] info - - RIK path: C:\Program Files\AR System Applications
\dca2-vm-01\BMC Configuration Drift Management\Common_Components\rik\rik.exe
[09/Oct/2008:20:02:28 \-0700|] [PrecheckerAction] info - - environment[0]/product-family[0]/product[1]/

name = BMC Atrium CMDB
BMC Atrium Core 9.0
Page 2206 of 2268
Home
Severity
Description
[09/Oct/2008:20:02:28 \-0700|] [PrecheckerAction] info - - environment[0]/product-family[0]/product[2]/
name = BMC Configuration Drift Management Change Management Extension
Note: These entries are very useful for troubleshooting.

Audit
Indicates an event that occurs during the normal execution flow of the Drift Management installer program.
[01/Oct/2008:10:03:38 \-0700|] [ARImportAction] audit - - Import successful: C:\Program Files\AR System

Applications\dca2-vm-01\BMC Configuration Drift Management\BMC_Configuration_Drift_Management\ar\dsmfnd\en
\dsm_SYSMenuItems_cfg.arx
In the following sample detail log file, the header specifies details about the server the application
was installed on, the date of installation, and so on:
Host: dca2-vm-01
Created: 1189202767075; Fri Sep 07 15:06:07 PDT 2008
Version: 0
Roll: never;unlimited
The following selections from the details log file walk you through the types of messages you might
see, for example, if the install was successful, if there were errors, or if there were fatal errors.
Details include, for example, the internal module name (SetRIKPathAction) that is being performed
by the installer. These are helpful when debugging the installation for diagnostic purposes. You do
not need to worry about details with the status of info, though they can be helpful for
troubleshooting.
[07/Sep/2008:15:06:07 \-0700|] [SetRIKPathAction] info - - Extracted RIK location: C:\

Documents and Settings\Administrator\Local Settings\Temp\150214.tmp\rik
[09/Oct/2008:20:02:28 \-0700|] [PrecheckerAction] info - - environment[0]/

product-family[0]/product[3]/name = BMC Remedy Change Management
You should pay careful attention to details with the status of audit. The following messages indicate
actions that have been performed. These actions are successful.
[01/Oct/2008:09:14:58 \-0700|] [PrecheckerAction] audit - - BMC Drift Management

prerequisite check complete with status: Pass
[01/Oct/2008:09:14:58 \-0700|] [CheckerPanel] audit - - Enforcing prerequisite check
BMC Atrium Core 9.0
Page 2207 of 2268
Home
Other messages describe in detail those actions that have failed for some reason. The different
states of their failures are indicated, for example, major, minor, warning, and so on.
[01/Oct/2008:10:03:35 -0700] [ARImportAction] major - - [ERROR] Failed to process: C:\

Program Files\AR System Applications\dca2-vm-01\BMC Configuration Drift Management\
BMC_Configuration_Drift_Management\ar\dsmapp\en\set_CMDB_Roles.drm. For additional
details please refer to: C:\Program Files\AR System Applications\dca2-vm-01\BMC
Configuration Drift Management\BMC_Configuration_Drift_Management\ar\dsmapp\en\Logs\
set_CMDB_Roles.log
[01/Oct/2008:10:06:38 \-0700|] [ARImportAction] minor - - [ERROR] Failed to import: C:\

Program Files\AR System Applications\dca2-vm-01\BMC Configuration Drift Management\
BMC_Configuration_Drift_Management\ar\dsmchg\en\dsm_chg_roles.arx. For additional
details please refer to: C:\Program Files\AR System Applications\dca2-vm-01\BMC
Configuration Drift Management\BMC_Configuration_Drift_Management\ar\dsmchg\en\Logs\
dsmchg_error.log
Using log files to troubleshoot an installation

Messages in the log files are clearly defined - for example, [ERROR ] - that indicate the category of
the message. Each message includes a timestamp or called routine, if applicable. Installation step
outlines have no prefixes.
You can monitor the last update to the log files to ensure an installation is still running.
To troubleshoot an installation
1. Before the actual installation starts and while you are still defining the settings in the installer
programs, you can review the BMC_Configuration_Drift_Management_InstallDetails.log
and BMC_Configuration_Drift_Management_Online_Help_InstallDetails.log log files to
view the underlying progress of your installation, which logs messages have been created at
a given point in the installation, and so on.
You can find these files in the %TEMP% folder for Windows or the /tmp directory for Solaris.
In these log files, search in particular for failures with Status: ERROR.
2. If you abort the installation, the BMC_Configuration_Drift_Management_InstallLog.log
and BMC_Configuration_Drift_Management_Online_Help_InstallLog.logsummary log
files are written to the following locations:
User's Home directory defined in their environmental variable (Windows)
User's root directory (Solaris)
3. After the installation, review the final versions of the log files for failures.
You can find these files in the Logs folder, identified by the date and time in the name, for
example:
C:\Program Files\AR System Applications\dca2-vm-01\BMC Configuration Drift

Management\Logs\10.01.2008_at_02_36_10_PM_PDT
BMC Atrium Core 9.0
Page 2208 of 2268
Home
Search for errors with critical, major, minor, or warning status.
Automatic incident creation issues

If you come across issues during automatic incident creation from Drift Management, verify the
settings described below.
Ensure that you have assigned a user to both Drift management permission group and BMC
Remedy ITSM Permission group. For more information on permission groups, see Drift
Management Permission groups.
Ensure that while creating Incident Rules, Assignment Engine Integration is set to Yes.
To configure the Assignment Engine navigate to the Incident Rules form of the BMC
Remedy ITSM - Incident Management. For more information on configuring incident rules,
see Incident rules in the BMC Service Desk 8.1 online documentation.
For a user to be able to view a template, ensure that the Assigned Group Name of the
template is same as Support Group Name of the user. For more information on configuring
assignment settings for templates, see Configuring assignment settings for incident
management templates in the BMC Remedy IT Service Management 8.1 online
documentation.
If you have customized a form, such that you make an optional field as required, then while
creating incidents, ensure that you pass dummy values in these fields through templates.
Investigating CMDB Data Issues

Symptoms which indicate a CMDB Data or Reconciliation Issue
There are several different ways an issue with CMDB data can be discovered:
Reconciliation job runs have errors, which are displayed in red in the status bar or displayed
as a red job run icon when the reconciliation job completes.
Multiple Matches Found error reported in Reconciliation job logs.
HostedSystemComponent cardinality violation error reported in the
Reconciliation job logs.
Could not find Endpoint in Relationship error reported in Reconciliation job logs
.
Data updates from Asset Management are not propagating
When users search for a CI, multiple CI's are reported, indicating there are duplicates
Tools for investigating CMDB data issues

There are three primary methods for investigating CMDB data issues:
Using the cmdbdiag utility on the CMDB server to check for and correct known data issues.
BMC Atrium Core 9.0
Page 2209 of 2268
Home
Performing database queries to get counts of data matching conditions of a data failure.
Choosing representative examples of Reconciliation failures and analyzing Reconciliation
Job logs and data exports to identify the root cause of failure.
Recommended sequence to investigate CMDB data issues

When symptoms of CMDB data issues occur, it is a good practice to verify CMDB data using the
following steps:
1. Use cmdbdiag to fix data issues.
2. Assess data distribution in the CMDB using queries.
3. Investigate duplicate computer systems in CMDB if duplicates exist in the golden dataset.
4. Modifying reconciliation identification rules to avoid duplicates.
5. Removing duplicate CIs and re-identifying them.
Database queries for evaluating CMDB data distribution

Total number of CIs and relationships
Before looking at data that needs to be corrected, run these queries to determine the total amount
of data distribution within the datasets grouped by classes.
To find
Database query
Number of CIs per DatasetId
SELECT DatasetId, COUNT(*) FROM BMC_CORE_BMC_BaseElement GROUP BY DatasetId;
Number of relationships by
Dataset
SELECT DatasetId, COUNT(*) FROM BMC_CORE_BMC_BaseRelationship GROUP BY

DatasetId;
Number of CIs by Dataset,

ClassId
SELECT ClassId, DatasetId, COUNT(*) FROM BMC_CORE_BMC_BaseElement GROUP BY

ClassId, DatasetId ORDER BY DatasetId;
Number of relationships by
DatasetId, ClassId
SELECT ClassId, DatasetId, COUNT(*) FROM BMC_Core_BMC_BaseRelationship GROUP BY

Unidentified CIs by DatasetID, ClassId

To find
Query
Reasons for this query
Number of
unidentified
Cis in the
golden
dataset,
BMC.ASSET
SELECT ClassId, COUNT(*) FROM

BMC_CORE_BMC_BaseElement
WHERE ReconciliationIdentity = '0'
AND DatasetId= 'BMC.ASSET'
There should never be any unidentified CIs in the golden dataset.

This can cause unpredictable behavior. This typically means the CIs were
created directly in BMC.ASSET instead of going through Reconciliation.
Number of
unidentified
relationships
in the golden
dataset,
BMC.ASSET

BMC_CORE_BMC_BaseRelationship
AND DatasetId= 'BMC.ASSET'
GROUP BY ClassId ORDER BY

ClassId;
Investigate how they were created and correct them if the query returns
more than zero,
There should never be any unidentified relationships in the golden

dataset. Check whether the related CIs are identified as described above,
then correct the relationships.
This condition is extremely rare, and would only happen if relationships
were created directly in BMC.ASSET.

ClassId;
BMC Atrium Core 9.0
Page 2210 of 2268
Home
To find
Query
Number of
unidentified

BMC_CORE_BMC_BaseElement
Investigate identification errors during reconciliation. Always begin with

investigating the BMC_ComputerSystem class because unidentifed
Cis in a
specified
source
DatasetId
In this
example, we

AND DatasetId = 'BMC.ADDM'
ClassId;
computers will also prevent components from being identified. If the

results do not include BMC_ComputerSystem, then investigate
identification rules from classes where the computer would be a host. For
example: BMC_IPEndpoint, BMC_Processor, etc.
used
DatasetId = '
BMC.ADDM'
Number of
unidentified

BMC_CORE_BMC_BaseRelationship
relationships
in a specified

AND DatasetId= 'BMC.ADDM'
source
DatasetId
Investigate identification errors during reconciliation. Results of this query

will reflect the results of the above query for CIs.

ClassId;
In this
example, we
used
DatasetId = '
BMC.ADDM'
CIs which are soft-deleted or orphans

To find
Query
Number of
soft-deleted
CIs by
DatasetId,
ClassId
SELECT ClassId, Datasetid, COUNT(*)

FROM BMC_CORE_BMC_BaseElement
where MarkAsDeleted = 1 GROUP BY
This will help you understand the impact of not purging data.
Retaining data in the production dataset is not considered best
practice, and can cause unexpected behavior if the Hostname,
Domain, or SerialNumber are reused by another computer
system that is replacing the original resource.
Number of
soft-deleted
relationships
by DatasetId,
ClassId
SELECT ClassId, Datasetid, COUNT(*)

FROM
BMC_CORE_BMC_BaseRelationship where
MarkAsDeleted = 1 GROUP BY ClassId,
DatasetId ORDER BY DatasetId;
This will help you understand the impact of not purging data.
Same as above.
Query of
SELECT Status, HostName, Domain,
This will return a list of areas of risk for reused hostnames which
identification
attribute values
SerialNumber, TokenId, isVirtual, Name

FROM
remain as purged data in BMC.ASSET. Check if any of the

Hostname or SerialNumbers for these soft-deleted computer
for soft-deleted
hosts in golden
BMC_CORE_BMC_ComputerSystem where
MarkAsDeleted = 1 AND DatasetId = '
systems will be re-used by new hosts in the environment. If so,

purge the data in golden dataset.
dataset
BMC.ASSET' ORDER BY HostName
CIs in golden dataset but not in any source dataset

It is a best practice that data in the golden dataset should be merged from a source dataset. For
some features such as Atrium Explorer, the changes are made through a sandbox dataset which is
then removed.
BMC Atrium Core 9.0
Page 2211 of 2268
Home
To find
Query
Computer
Systems
SELECT Name, InstanceId,

ReconciliationIdentity, DatasetId FROM
The result indicates ComputerSystems which exist in

BMC.ASSET but are not presently in any other dataset. This
which exist in
the
BMC_CORE_BMC_ComputerSystem WHERE
DatasetId = 'BMC.ASSET' AND
can occur if either: the data was created directly in BMC.ASSET

, or if the data was created in another dataset and purged from
BMC.ASSET
dataset but
ReconciliationIdentity NOT IN (SELECT

ReconciliationIdentity FROM
the source dataset or sandbox dataset.
not in any
source
BMC_CORE_BMC_ComputerSystem where
DatasetId != 'BMC.ASSET')
dataset.
Note: This
query can
consume a
lot of
database
resources
and may not
finish.
CIs in golden
dataset
SELECT ClassId, COUNT( * ) FROM

BMC_CORE_BMC_BaseElement WHERE
The result indicates cases where CIs are directly created in

BMC.ASSET. This indicates a need a enable the sandbox or
which were
not merged
DatasetId = 'BMC.ASSET' AND

AttributeDatasourceList IS NULL GROUP BY
following recommended procedure to import data to a source

dataset and reconcile into the golden dataset. This differs from
from a
sandbox or
ClassId
the above query because the above query also returns results
that were created properly and then purged from the source
source
dataset
dataset.
Investigating issues with duplicate data in CMDB

Successful identification between multiple source datasets requires each of the following:
Each data provider populates data to the same classes in the CMDB, but into different
source datasets.
Each data provider populates values to the attributes used for identification.
Each data provider populates identical values to the attributes used for identification.
Reconciliation identification rules look for a match on the identification attributes, from the
most restrictive to less restrictive combination of attribute values.
Reconciliation tries to identify the CI in the second source dataset after the first one has
been identified and merged into the golden dataset
Reconciliation identification rules ignore default values such as NULL or 0 in identification
attributes.
Data providers do no populate non-unique, non-default values like "N/A" or "None" to
identification attributes.
If host names are re-used by different computer systems, they are purged from the golden
dataset before the new computer system using it is leveraged
Note
BMC Atrium Core 9.0
Page 2212 of 2268
Home
Some of these requirements depend on implementation decisions and quality of data

before Reconciliation is attempted. Below is a good sequence of steps to follow to
determine which requirements are met.
To check for ...
Query or operation
Results and next steps
Duplicate
ReconciliationIdentity
Perform a query in the ARSystem database for

the specified DatasetId, for example:.
The query should return no results for any value of

given for DatasetId.
within a specified
DatasetId
BMC.ADDM:
SELECT ReconciliationIdentity, COUNT(*)
A defect in CMDB 7.6.04 failed to prevent this condition.

Updating to CMDB version 7.6.04 SP 3 or later
FROM
BMC_CORE_BMC_COMPUTERSYSTEM
addresses the defect.

Next, investigate to determine why the identification rule
WHERE DatasetId = 'BMC.ADDM'
found a match - this may be due to data issue or

reconciliation issue.
GROUP BY ReconciliationIdentity HAVING
Finally, fix the data , see Removing duplicate computer

systems from the CMDB
COUNT (*) > 1 ;

Duplicate values of
IntegrationId
attribute
Perform a query in the ARSystem database for

the specified DatasetId and attribute, for
example BMC.ADDM and ADDMIntegrationId
SELECT COUNT(*),ADDMIntegrationId FROM
BMC_CORE_BMC_BASEELEMENT
WHERE DatasetId = 'BMC.ADDM'
Hosts with duplicate

identification
attribute values
within a specified
DatasetId
The query should return no results for the IntegrationId,

DatasetId combination.
Check if the discovery source has multiple CIs with the
same value of the IntegrationId, or if one of the CIs is
considered deleted in the discovery source. This may
indicate a deletion was not propagated to the source
dataset in CMDB.
GROUP BY ADDMIntegrationid HAVING

COUNT (*) > 1 ;
Also check if the attribute used as an IntegrationId is

recycled, or re-used by the discovery source after it is
considered deleted. This is another case where you
would not want to leave-soft-deleted data in the CMDB.
See Investigating soft-deleted data issues
Examine identification rules for the class and

make a list of all attributes used for
identification.
If this returns any results, it means the data in the

identification attributes is insufficient to uniquely identify
a CI. See section below on "Solving Reconciliation
issues by adding identification attributes".
Then perform a query in the ARSystem

database for a match on all these attributes
within a dataset.
SELECT Hostname, isVirtual FROM
BMC_CORE_BMC_ComputerSystem
WHERE DatasetId = 'BMC.ASSET'
GROUP BY HostName, Domain, SerialNumber,
TokenId, isVirtual HAVING COUNT(*)>1;
Computer System
Identification
attributes not
populated
Perform a query in the ARSystem database:

SELECT Name, instanceid, DatasetId FROM
WHERE TokenId = '0' AND SerialNumber IS
NULL AND Hostname IS NULL;
BMC Atrium Core 9.0
Computer Systems without values for TokenId,

SerialNumber, or Hostname are the primary attributes
for identifying a computer system.
If none of these three attributes are populated,
Reconciliation is unlikely to find a match with data
populated by another data source. See section below
on "Solving Reconciliation identification issues using an
IntegrationID attribute"
Page 2213 of 2268
Home
To check for ...
Query or operation
Results and next steps
Identification
attribute value
Perform a query in the ARSystem database:
View the results to verify the identification attribute

values are populated to both datasets in the same
consistency for
Computer Systems
SELECT Name, SerialNumber, Hostname,

Domain, TokenId, isVirtual FROM
format, with consistent values and case. Also scan for

meaningless values like N/A, None, or Unknown.
ORDER BY Hostname, SerialNumber,
DatasetId, TokenID;
Identification
attribute value
consistency for weak
members between
datasets
Perform a query in the ARSystem database, for

example, on the BMC_OperatingSystem class:
View the results to verify the Name value is used

consistent across datasets.
SELECT Name, DatasetId, TokenId FROM

BMC_CORE_BMC_OperatingSystem
For example, if the Name attribute is used to identify

OperatingSystems, it is important that both data
sources provide the same value of the operating system
Name. Viewing the query results on classes of interest
will keep the results list short enough to scan.
If the OperatingSystem Name is different for different
datasets, consider using Normalization before running
GROUP BY Name, DatasetId, TokenId;
reconciliation.
Sequence of
operations
Select an example of a CI duplicated in the

golden dataset which is merged from two
source datasets with identical values for
identification attributes.
Avoid this situation by scheduling reconciliation jobs

appropriately so identification and merging of the first
source dataset is complete, before the second
reconciliation job runs.
Check whether the CreateDate of both CIs in

the golden dataset are later than the Modified
Date of both CIs in the source datasets. This
indicates the CIs were both identified before
either was merged to the golden dataset.
Removing duplicate computer systems from the CMDB

To remove duplicate computer systems from the CMDB, perform the following steps:
1. Identify and address duplicate computer systems in source datasets
2. Identify duplicates in the golden dataset referenced by other applications
3. Remove duplicates from the golden dataset
4. Link current discovered hosts to the correct computer system in the golden dataset.
Note
A proposed change to reconciliation would ignore hosted system components and hosted
access points which are not related to any computer system during identification. Another
proposed change to cmdbdiag would add a feature to remove hosted system components
or hosted access points which are not related to any computer system. Either of both of
these changes would address symptoms of duplicates from CI's that are not computer
systems. The focus of this page is removing duplicate computer systems and the
components which are related to it, which addresses the largest user impact.
BMC Atrium Core 9.0
Page 2214 of 2268
Home
Identifying and addressing duplicate CIs in a source dataset

Check if the computer system exists twice in any source dataset before attempting to resolve
duplicates in the target dataset. There are two causes for duplicate computer systems in a source
dataset:
The discovery product or it's integration to CMDB failed to update the computer system to be
soft-deleted in the soruce dataset.
For example, in BMC Atrium Discovery and Dependency Mapping, configure aging limits to
ensure non-existant nodes are deleted and configure Continuous Synchronization to ensure
the update is passed to CMDB. Remember that it is the responsibility of the discovery
product to provide updates to the CMDB on changes to the CI, so if the discovery product is
retired or no longer scans the computer system without removing it, this can also leave the
data in the source dataset obsolete.
The attributes of the computer system changed, and the discovery product discovered it a
second time and considers it to be a different computer system.
Discovery products for servers such as BMC Atrium Discovery and Dependency Mapping
use different discovery mechanisms than discovery products for workstations such as BMC
BladeLogic Automation for Clients, and each works well with their target application.
Investigate the specific computer system, discovery product, and situation which allowed the
discovery product to be discovered twice. In some causes, it may appear to be a duplicate
computer system but actually be a separate one.
The best guideline on resolving duplicates in source datasets is to identify and resolve the issue at
the discovery product and push the changes through the integration as normal. If the computer
system does not exist in the discovery product, use the procedure below to remove duplicates in
the source dataset as well as the golden dataset.
Identifying duplicates in the golden dataset referenced by other applications

The ReconciliationIdentity is used as a unique identifier within several BMC Remedy IT Service
Management Suite application features. This related information will be de-linked or lost if the value
of ReconciliationIdentity changes. This will happen if either:
The ReconciliationIdentity is reset (set to 0)
The CI is removed from the golden dataset, the source CI is re-identified, and then
re-merged into BMC.ASSET.
To determine the items related to a CI in BMC Remedy Asset Management, access Asset
Console and click View.
Click through the pages
General
Specifications
Work Info
BMC Atrium Core 9.0
Page 2215 of 2268
Home
Contracts
People
Relationships
Relationship Details
Financials
Outages
Impacted Areas.
Most of this information is stored in ITSM forms and related by the ReconciliationIdentity, so
changing the value of ReconciliationIdentity would de-link all of this information.
The first created computer system will have the related information in most cases, both because it
has been present longer and also because Asset Management personnel will find duplicate
computer systems when trying to relate information to it. Thus, it is often the case that the computer
system which was added last will be the one which should be deleted but the procedure above
helps to validate that conclusion.
For more information on queries for identifying duplicate CI's, see Investigating issues with
duplicate data in CMDB .
You can use the AR DRIVER utility to execute the queries, which can be helpful when automating
the process. For more information on using the AR DRIVER utility, see the blog Identifying weak
Reconciliation Identification rules with ARDRIVER.
Note
If you are modifying a CI created in a class container that is different from the "CURRENT
" container, then you can still use the ReconciliationIdentity in the same dataset.
For example, if you load existing BMC_COMPUTERSYSTEM record into
BMC_BASEELEMENT form, then ClassId of the record does not match the container
class (BMC_COMPUTER vs. BMC_BASEELEMENT). The record will be the same with a
duplicate REID in same dataset.
Be careful when editing CIs in this way until a fix for this issue is available.
Deleting duplicate computer systems from the golden dataset

After identifying which of the duplicate computer systems will be deleted, and moving over any
related information to the computer system which will be retained, use this procedure to delete the
duplicates:
Set the Cascade Delete option for the two relationship classes:
BMC_HostedAccessPoint
BMC Atrium Core 9.0
Page 2216 of 2268
Home
BMC_HostedSystemComponents.
See Defining class properties in the Class Manager and Relationships in the Data Model for more
information about this process. After making the change, deleting the computer system will also
delete related hosted system components and IP endpoints.
Delete the computer system.
Update BMC_HostedAccessPoint and BMC_HostedSystemComponents classes to revert changes
to the Cascade Delete option.
Alternatively - instead of updating these relationship class definitions temporarily, you can use the
CMDBDRIVER to delete duplicate CI's. Deleting CI's with CMDBDRIVER also removes weak
relationships in the process. For more information on using CMDBDRIVER see the knowledge
article, Cleaning duplicate CMDB CIs in bulk.
Linking current discovered hosts to the correct computer system in the golden
dataset
After deleting the duplicate computer system from the golden dataset and from source datasets if
necessary, use this process to link the discovered computer system to merge to it:
1. Identify the correct and current computer system in the source dataset by investigating as
described above.
2. Reset the Reconciliation Identity of the corresponding computer system in the source
dataset.
3. Either manual identification to identify the CI in the source dataset with the one in the golden
dataset or run the updated reconciliation job which addresses the issue.
Modifying reconciliation identification rules to avoid duplicates

After investigating and ruling out other potential causes of duplicate CIs, the issue may be that
uniquely identifying a CI with the out of box identification rules is not possible. Below are three ways
to address this situation.
Solving reconciliation identification issues by adding identification attributes

If the combination of identification attributes is not sufficient to uniquely identify a CI, it may be
necessary to add another attribute to be used for identification.
For example, LPARs are populated to the BMC_ComputerSystem class.
The attributes used to identify Computer Systems include: Hostname, Domain, SerialNumber,
isVirtual, and TokenId. Several LPARs on a host may have the same values for all five of these
attributes, so these attributes alone are not sufficient to uniquely identify the LPAR. To make the
description of the LPARs more unique, an attribute could be added to the BMC_ComputerSystem
class, and used in identification rules.
BMC Atrium Core 9.0
Page 2217 of 2268
Home
For example, if the PartionId attribute were discovered from the LPAR and populated to an attribute
on the ComputerSystem, this attribute plus the other five may be sufficient to uniquely identify the
LPAR.
This is the most general solution, but it requires more steps. You should:
1. Identify a suitable attribute or add one to the BMC_ComputerSystem class.
2. Have each discovery source populate the attribute with a consistent value which can be
discovered from the LPAR.
3. Update Reconciliation identification rules to use this attribute.
Note
The example problem occurred in earlier versions of BMC Atrium Discovery and
Dependency Mapping (ADDM) and BMC Atrium CMDB Suite (CMDB). It was resolved in
BMC Atrium Discovery and Dependency Mapping version 9.0 and Atrium CMDB version
8.1, by adding and populating the PartitionId attribute just as described above. On earlier
versions of the product, the workaround described in Knowledge article KA344625 was
used, which is an example of the approach described below: Solving reconciliation
identification issues using an IntegrationId attribute.
Solving Reconciliation identification issues using an IntegrationID attribute

Many methods of bulk loading data to the CMDB use an IntegrationId attribute as a foreign key to
the CI in the discovery product or data source. Examples of IntegrationIds include:
ADDMIntegrationId used by BMC Atrium Discovery and Dependency Mapping product
CDIntegrationId used by BMC BladeLogic for Server Automation and BMC BladeLogic for
Client Automation products
SMSParentID used by some integrations which load data from Microsoft System
Management Configuration Manager (SCCM)
Since the IntegrationId is a unique identifier within the dataset, it may be tempting to use it as an
identification attribute.
The IntegrationId attribute is not a good primary identification attribute because:
The value will be NULL for CIs merged from other datasets
No CIs in the target dataset will have a matching value of the IntegrationId, until after the CI
is identified and merged to the target dataset.
For these reasons, the IntegrationId is only useful as an additional identification attribute to handle
the case of re-identification of a dataset, or for CIs which are only populated by one data source.
BMC Atrium Core 9.0
Page 2218 of 2268
Home
To investigate if the solution will be viable

1. Determine if there is only one data provider which populates the class in the CMDB. For
example, BMC Atrium Discovery and Dependency Mapping populates the
BMC_SoftwareServer class, but no other known data sources populate that class at this time
.
2. Determine if there is only one data provider which populates the CI to the CMDB. For
example, it is common to have one data provider for servers and another discovery source
for laptops and workstations. If there is a logical separation of the devices discovered by
different data sources, this also makes it possible to match on an IntegrationId attribute.
3. Determine which other identification rules besides Computer System encounter multiple
match errors during reconciliation.
4. Add the IntegrationId attribute to also be included in those identification rules.
5. Determine whether the value of IntegrationId utilized is ever re-used, or if there are
scenarios where the value of IntegrationId may change.
The areas of risk are when the CI is not found and removed from the discovery source and
then re-discovered by the discovery source at a later time. This is the situation when several
discovery providers either re-use the integrationid for a different CI, or change the value of
the IntegrationId for the same computer system. A persistent, predictable value of
IntegrationId is needed to use it for identification. For an example of this approach, see
Knowledge article KA344629.
Solving Reconciliation identification issues by adding a fallback identification rule

If you select the Generate IDs option for the source dataset in the Identify activity, reconciliation
will generate a new identify if no matches are found in the target dataset with any of the
identification rules. If duplicate CIs are created, that means none of the identification rules found a
match and the CI was auto-identified.One way to address this is to add another identification rule to
be run after all of the existing ones. The goal is to add a less restrictive match than earlier
identification rules. For example, if the hostname will be unique to the enterprise a fallback
identification rule can be added to match only on hostname.
Always query on your data in the source dataset to ensure this attribute is as unique as expected
before implementing a fallback rule. For example, LPARs generally create multiple computer
systems with the same hostname value, so matching on hostname is not viable as an out of box
rule. Adding a fallback identification rule that is too open can introduce over-reconciliation, where
two different computer systems merge into the same one in the target dataset, so be careful to
validate your assumptions about uniqueness within your environment.
Testing reconciliation job changes to address duplicate CI's

Remove duplicate CI's from the target dataset before testing reconciliation changes. See Removing
duplicate CI's from the CMDB for more details on this process. You must test on a development or
QA server. It may be helpful to test with a few representative computer systems, or to remove all
data from the target dataset as a simple way to meet the requirement of no duplicate CI's in the
target dataset to validate reconciliation changes.
BMC Atrium Core 9.0
Page 2219 of 2268
Home
To test changes to the reconciliation job, use cmdbdiag to reset the ReconciliationIdentity
for the CIs to be tested. This causes the identification activity to attempt to identify the CIs again.
See Resetting reconciliation identities for more details.
Test each of the following scenarios:
1. No data exists in target dataset, data in source dataset is un-identified.
This is a simple case where issues are rarely uncovered, but it is the initial situation for data
population.
2. Data already exists in the target dataset, but the entire source dataset is unidentified.
This is an uncommon situation, but it is a good stress test that confirms that the
reconciliation rules are effective in identifying all the data, independent of the order the data
was discovered and populated to the target dataset.
3. Two or more source datasets are populated with some of the same computer systems, but
some different computer systems.
This is a test that the computer systems are identified as the same in the target dataset, and
not duplicated.
4. Data already exists in the target dataset from multiple source datasets, and both source
datasets are entirely unidentified.
This is a more comprehensive stress test.
Using CMDB Data Analyzer to Investigate CMDB Data Issues

The CMDB Data analyser tool is available from Service Pack 1 and later. The CMDB Data Analyzer
is available for performing certain data analysis operations. This topic describes details about the
CMDB Data Analyzer. The CMDB Data Analyzer is a collection of tools that enable you to perform
data analysis and also identify data inconsistencies in any CMDB dataset. The CMDB Data
Analyzer is installed along with the BMC Atrium 90SP1. The CMDB Data Analyzer can be used
with the following CMDB versions: 8.1, 8.1SP2, 9.0, and 9.0SP1.
BMC Atrium Core 9.0
Page 2220 of 2268
Home
Pre-requisites
Ensure that Java 1.8 is installed on the system from where you want to run the
CMDB Data Analyzer.
Ensure that the JAVA_HOME environment variable is set.
When to use the CMDB Data Analyzer

CMDB Data Analyzer has been created to assist with identifying data issues within your CMDB and
can help you find inconsistencies and errors such as finding duplicates in a dataset to assist
deletion before pushing the dataset to production, detect certain reconciliation errors such as
BMC Atrium Core 9.0
Page 2221 of 2268
Home
multimatch error that occurs due to duplicate CI instances, identify Weak CI classes that do not
have any relationships, finding CIs that are not reconciled, and identify the Soft deleted CI
instances.
Note
BMC recommends running Data Analyzer on source datasets, to pre-identify the possible
duplicate CIs as most of the duplicate CIs are created during initial data load, when the
source data is copied to production.
What can you do with the CMDB Data Analyzer

With CMDB Data Analyzer you can do the following:
Identify Duplicate CIs

This tool identifies the duplicate CIs in the given CMDB dataset. Duplicate CIs in the CMDB data
can lead to reconciliation failures, multimatch errors, and incorrect data in consuming applications.
Duplicate CIs are identified as per the standard Reconciliation Engine identification rules and
custom rule set that are defined in the system.
Identify Orphan CI Instances

This tool identifies the orphaned CI instances. An Orpaned CI is an instance of weak CI class that
does not have any relationships. Finding Orphan CI operation is only applicable to a production
dataset.
Identify Soft Deleted CIs

This tool identifies the Soft Deleted CI instances. A Soft Deleted CI is the one which has the
mark-as-deleted attribute set to Yes.
Identify non-reconciled CIs/Relationship CI instances

This tool identifies those CI instances that are not reconciled. A non-reconciled CIs is the one
without a ReconID.
Identify Classes without RE Identification rule

The classes without RE identification rules are the ones that have no identification rules defined at
the class level.
BMC Atrium Core 9.0
Page 2222 of 2268
Home
Who can use the CMDB Data Analyzer

A CMDB Configuration Administrator and CMDB Configuration Manager will use the CMDB Data
Analyzer.
In order to access the CMDB Data Analyzer the following permissions are required:
AR Administrator
How to use the CMDB Data Analyzer

The CMDB Data Analyzer is installed along with BMC Atrium and is deployed at the following
location
<Atrium Installation directory>\AtriumCore\cmdb\utils\DataAnalyzer
The following table describes the files in the CMDB Data Analyzer installation directory.
File Name
Description
app.properties
The app.properties file stores the AR server details that you enter while logging into the tool. It contains the
parameters that are used, such as, AR server details, hostname, user name, and password. When your AR
server details are authenticated, all the parameter details are stored in this file. Alternatively you can manually
enter the AR Server details in the app.properties file before launching CMDB Data Analyzer.
The app.properties file contains an encrypted password. BMC recommends not to enter this
information manually.
The app.properties file contains the following properties:

findduplicates.config.formsWithLargeData - Add a comma separated list of classes that have the
highest data load in your system, to dedicate a thread for processing. This is recommended in very high
data load environments (CIs>3 Million) for better performance.
findduplicates.config.groupBypermits - Set this value to a low number when the number of CIs in the
system are very high. Set this to 1 if database timeouts occur when the data volume is very high.
WeakCIClasses
The WeakCIClasses.txt file stores a list of weak CI classes from which the orphaned CI instances are searched.
BMC provides an out of the box list of weak CI classes from which the orphaned CI instances are searched. If
you want to search orphaned CI instances from a weak CI class that is not listed in this file, you should first add
the weak CI class name to this file. You can modify the list of the Weak CI classes.
Important Information
BMC recommends the following for optimum performance:
Run the CMDB Data Analyzer during off-peak hours if you have a large data
environment.
BMC Atrium Core 9.0
Page 2223 of 2268
Home
Copy the zip file to another computer where AR and CMDB are not installed,
extract the contents in the zip file and run the CMDB Data Analyzer. Make sure that
AR Server and the computer where the CMDB Data Analyzer is installed are in the
same LAN.
Run the Find Duplicate CIs operation per class or by selecting a certain group of
classes when the volume of CIs in the CMDB system is very high( ~5M +) or if the
duplicates that may exist in a class are high(~+ 400K). Note that, if a single class
has large data( ~5M +), then this may be resource intensive for the DB even if the
utility is run per class.
Increase the heap size in the cmdb-data-analyzer.bat file if the HTML output report
generation time is high due to high number of duplicates.
Launching the CMDB Data Analyzer

The following steps describe how to generate results using the CMDB Data Analyzer.
1. Launch the BMC CMDB Data Analyzer.
On Windows, go to your installation directory and execute
cmdb-data-analyzer.bat.
On UNIX, go to your installation directory and execute ./cmdb-data-analyzer.sh
2. In the BMC CMDB Data Analyzer, click Configure. The AR Server Details window is
displayed.
3. In the AR Server Details window, provide the following information

AR Server Host Name - The Host name of AR Server
Port - The Port of AR Server
User - The user must be have access to the AR administrator group.
BMC Atrium Core 9.0
Page 2224 of 2268
3.
Home
Password - A valid password

4. Click Save.
The fields in CMDB Data Analyzer are enabled. Now you can perform various data analysis
operations. You must click Change to configure a different AR server.
5. In the From Dataset list, select a dataset.

6. Select the Duplicate CI Instances check box.
7. Click Select to select specific classes from a list of classes.
The Select Classes window is displayed.
8. Select the required classes and click the >> button, and click OK.
9. Select the Use Custom Rules to Find Duplicates check box to use custom Reconciliation
Engine rules to identify duplicate CIs. If you do not select this check box, standard rules are
applied.
10. In the View Results as section, select HTML. The results of CMDB Data Analyzer are
generated in HTML by default. You can also select the Text format to view results.
11.
BMC Atrium Core 9.0
Page 2225 of 2268
Home
11. Select the Save Copy of Results at AR Server check box to store the results in the Atrium:
DataAnalyzerReportStore form. You must access the Atrium:DataAnalyzerReportStore form

from BMC Midtier by directly entering the form name in the URL.
12. Click View Results.
The results are displayed in the default browser window.
As illustrated in the steps you can select a data analysis operation from the available list of
operations and view the results. Alternatively, you can also select multiple or all the available
data analysis operations and then click View Results to generate the results. The output
files are generated in the Reports folder in the installation directory.
BMC Recommendation
When you install or upgrade 90SP1, CMDB Data Analyzer will be deployed in the
AtriumCore installation directory - <Atrium Installation directory>\AtriumCore\cmdb\utils\
DataAnalyzer.
Archiving the CMDB Data Analyzer results

The records generated by the CMDB Data Analyzer are archived based on the schedule defined in
the server's archiving policy. By default, the results that were generated 2 days prior to the current
date are purged. You can increase the duration to preserve older results by opening the form in the
developer studio and changing the archiving properties of the form.
Troubleshooting the CMDB Data Analyzer

To troubleshoot any issues that occur in the CMDB Data Analyzer, you can refer to the
cmdbdataanalyzer.log file. By default the cmdbdataanalyzer.log file is present in the logs folder of
your installation directory. You can configure the log settings (logging path and log level) in the
log4j.xml. Set the level value parameter in the log4j.xml file to DEBUG to get detailed logs. To
handle any issues that occur in the CMDB Data Analyzer, you can refer to logs or if required,
capture the logs and send the data to Support team. The log4j.xml file is available in the
AtriumCore installation directory - <Atrium Installation directory>\AtriumCore\cmdb\utils\
DataAnalyzer
Current Limitations
The HTML report is not supported on Linux and Solaris platforms.
A typo in the OOTB rules data for class BMC_NTDomain in the RE:Automation:
Identification_Rules form exists. The attribute name for DomainGUID should be corrected to
DomainGuid if an error occurs while processing the class BMC_NTDomain.
BMC Atrium Core 9.0
Page 2226 of 2268
Home
CMDB Indexes
This topic lists the out-of-the-box CMDB indexes that should always exist. If any index listed on this
page is missing, it may lead to performance issues. To resolve any performance issue that may
occur due to the missing index, you must add the missing index in the system.
List of out-of-the-box Indexes.

The following table displays the out-of-the-box indexes that must always exist in your system.
BMC.CORE:BMC_BaseElement
BMC.CORE:BMC_BaseRelationship
179
179
400079600
400079600
400131300
400131300
400127400,400129200,400129100,1
400127400,400129200,400129100,1
400131200
400131200
530060100,6,400129100,400129200
530060100,6,400129100,400129200
530060100,6,400129200
530060100,6,400129200
400129200,400129100
400129200,400129100
240001002
400131000,400130900
530060200,400127400
490008000,490009100
530010100,400127400
490009000,490008100
530060100,6,400127400,400129200
490008000,490008100,1
490009000,490009100,1
179,400129200,400079600,490009000,490008000,1
400129200,490008000
490008100,400128800
400127400,400129200,400129100,1
400130900
Steps to add missing indexes.

1. Open BMC Remedy Developer Studio and log in.
2. From the AR System Navigator tab, expand the source server and under All Objects
select Forms.
3. In the forms window, double-click the BMC.CORE:BMC_BaseElement to open it.
4. Select the Definitions tab.
5.
BMC Atrium Core 9.0
Page 2227 of 2268
Home
5. In the Definitions tab, click the Indexes panel.

6. Click New.
7. Select the new index.
a. To add fields to the index, click Add and complete the Field Selector dialog box for
each field.
You can combine multiple fields into a composite index.
You can enter as many as 16 fields.
You should add the fields in the order you want them indexed, or you can use
the Up and Down buttons to put them in the correct order.
Each indexed field must be less than or equal to 255 characters, but the
composite Index can have a total length greater than 255.
You can use the Remove and Remove All buttons to remove fields form the
index.
8. Save the form.
Repeat the above steps for the BMC.CORE:BMC_BMC_BaseRelationship form to add the
missing indexes.
BMC Atrium Core 9.0
Page 2228 of 2268
Home
Support information
This topic contains information about how to contact Customer Support and the support status for
this and other releases.
Contacting Customer Support

If you have problems with or questions about a BMC product, or for the latest support policies, see
the Customer Support website at http://www.bmc.com/support. You can access product documents
, search the Knowledge Base for help with an issue, and download products and maintenance. If
you do not have access to the web and you are in the United States or Canada, contact Customer
Support at 800 537 1813. Outside the United States or Canada, contact your local BMC office or
agent.
Support status
As stated in the current BMC Product Support Policy, BMC provides technical support for a product
based on time rather than number of releases.To view the support status for this release, see the
BMC Atrium CMDB Support page.
End of life for BMC Atrium Integration Engine

The page Future product changes does not exist.
BMC Atrium Core 9.0
Page 2229 of 2268
Home
Additional resources
The following hyperlinks provide information outside of the BMC Atrium Core online documentation
that you might find helpful:
BMC Communities, BMC Atrium Core community
Search the BMC Support Knowledge Base filtered by Atrium CMDB
Query to find Top KA Lists across all product communities.
BMC Educational Services, BMC Atrium Core learning path
BMC Global Services, BMC Atrium Core offerings
www.bmc.com information about BMC Atrium Core
Documentation for Related Products
BMC Remedy AR System
BMC Atrium Dashboard and Analytics
BMC Remedy IT Service Management
BMC Atrium Core Product Catalog Data
BMC Atrium Core 9.0
Page 2230 of 2268
Home
Index
9
90 enhancements 57
a
abstract 160, 169
access 88, 90, 184, 197, 198, 199, 267, 273, 275, 290, 291, 294, 295, 347, 350, 390, 402, 425,
686, 697, 763, 1051, 1060, 1069, 1143, 2084
access dashboard 264
accessing 267, 292, 294, 371, 384, 1050
acknowledge 1097
actions 285, 286
activation 1344
activefederatedincontext 1388
activities 207, 208, 210, 212, 212, 213, 947, 947, 951, 962, 964, 966, 969, 972, 1024, 1025
activity 998, 1017, 1222, 2202
adapter 2149, 2155
adapters 1118, 1121, 1131, 1181
adding 489, 668, 670, 678, 680, 770, 773, 819, 898, 901, 909, 913, 923, 1024, 1025, 1122, 1125, 1128,
1132, 1135, 1139, 1143, 1148
addition 213
addm 260, 459, 464, 468, 504
addm integration 260
addresses 223
adjacent 1347, 1348
administration 387, 1154, 1154, 1155, 1157, 1158
administration console 1049
advanced 331, 476, 852
advanced settings 231
advantages 414
advatanges 416
ai error log 2177
aie to ai migration tool 841, 842, 844, 845, 845, 847, 847, 848, 849, 850, 851, 852, 853, 856, 857,
858, 862, 862, 863
aiexfer 2151, 2155
algorithms 1182, 1183
alias 494, 499, 500, 502, 503, 504, 944
BMC Atrium Core 9.0
Page 2231 of 2268
Home
aliases 467, 476, 479, 498, 874, 927, 1179

all objects option 1069
apache 90, 140, 222, 236, 1258, 1259, 1259, 1261, 1262, 1263, 1264, 1275, 1324
api 425, 955, 958, 960, 1231, 1232, 1233, 1235, 1246, 1247, 1248, 1249, 1250, 1252, 1255, 1255, 1256, 1256, 1257,
1328, 1331, 1333, 1333, 1337, 1337, 1338, 1338, 1338, 1339, 1339, 1340, 1340, 1341, 1341, 1342, 1342, 1343, 1344,
, 1345, 1346, 1346, 1347, 1347, 1347, 1348, 1348, 1349, 1349, 1350, 1350, 1351, 1352, 1352, 1353, 1353, 1354, 1354
1355, 1356, 1356, 1357, 1357, 1358, 1358, 1359, 1359, 1359, 1360, 1361, 1361, 1362, 1363, 1363, 1364, 1364, 1365,
, 1366, 1367, 1367, 1368, 1369, 1370, 1370, 1371, 1372, 1372, 1373, 1373, 1374, 1374, 1374, 1375, 1375, 1375, 1376
1376, 1377, 1377, 1377, 1378, 1380, 1380, 1381, 1381, 1382, 1382, 1382, 1383, 1383, 1385, 1388, 1389, 1390, 1391,
, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403, 1404, 1405, 1405, 1406, 1407, 1408, 1408, 1411, 1413, 1414, 1415
1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426, 1426, 1427, 1429, 1430, 1430, 1431, 1432, 1433, 1433, 1434,
, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445, 1446, 1446, 1447, 1447, 1448, 1449, 1453, 1453, 1455, 1456, 1457
1458, 1461, 1465, 1467, 1472, 1472, 1473, 1473, 1475, 1475, 1476, 1477, 1477, 1478, 1479, 1479, 1479, 2004, 2019,
, 2021, 2022, 2047, 2102, 2136
application 1049
applications 142, 255, 255, 259, 267, 273, 275, 278, 280, 285, 286, 294, 295, 323, 1185, 2140
approve 476, 485
approved 512
ar 1143
architecture 80, 80, 82, 85, 90, 136, 688, 1231, 1232, 1233
archives 1259
archiving 1229
archiving policy 1229
ardbc 1131
ar forms 833
arguments 1388, 1389, 1390, 1391, 1391, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403, 1404, 1405, 1405, 1406,
1407, 1408, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426, 1426, 1427, 1429,
, 1430, 1431, 1432, 1433, 1433, 1434, 1435, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445, 1446, 1446, 1447, 1453
arithmetic 1360
armonitor 1021
ar system 345
ar system server 137
assessment 181
asset 455
assigning 897
assignment groups 2209
associating 680
association 516
atrium 255, 259, 690
atrium core 39, 57
atrium core best practices 122
atrium core console 267, 271, 273, 275, 278, 280, 285, 286, 294, 295, 2030, 2045, 2073, 2084, 2108,
2108
BMC Atrium Core 9.0
Page 2232 of 2268
Home
atrium explorer 72, 75, 255, 255, 259, 273, 275, 280, 285, 286, 289, 308, 311, 313, 314, 315,
316, 317, 317, 320, 323, 324, 327, 331, 336, 343, 344, 345, 346, 347, 350, 355, 357, 359, 360, 362
, 363, 366, 368, 368, 369, 371, 372, 373, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 547,
564, 566, 568, 680, 1182, 1190, 1191, 2109, 2139
atrium explorerservice context 384
atrium impact simulator 72, 137, 299, 300, 300, 301, 305, 306, 306, 307, 308, 310, 311, 564, 565,
566, 568, 571, 1997, 2006, 2078, 2114, 2142
atrium integration engine 2010, 2011, 2012, 2012, 2015, 2085, 2147, 2147, 2149, 2151, 2152, 2153, 2154, 2154,
2155, 2155, 2158, 2159, 2159, 2160
atrium integrator 76, 85, 137, 139, 141, 179, 227, 290, 291, 687, 688, 689, 690, 690, 691, 692,
692, 694, 697, 697, 699, 699, 699, 700, 701, 701, 702, 704, 705, 707, 708, 711, 712, 712, 713, 713
, 714, 715, 715, 716, 716, 716, 723, 724, 725, 727, 728, 729, 729, 730, 730, 732, 737, 738, 738,
738, 739, 739, 741, 743, 746, 748, 753, 758, 759, 760, 761, 763, 764, 764, 765, 767, 768, 770, 773
, 801, 802, 805, 808, 808, 809, 809, 810, 811, 811, 812, 813, 813, 817, 817, 818, 819, 821, 822,
823, 824, 825, 826, 826, 827, 829, 831, 832, 833, 834, 834, 837, 837, 840, 841, 842, 844, 845, 845
, 847, 847, 848, 849, 850, 851, 852, 853, 856, 857, 858, 862, 862, 863, 1997, 2007, 2036, 2089, 2089,
2089, 2091, 2091, 2092, 2093, 2093, 2096, 2097, 2151, 2160, 2161, 2162, 2162, 2164, 2165, 2166, 2166, 2166, 2167,
, 2167, 2168, 2168, 2168, 2169, 2170, 2170, 2171, 2171, 2171, 2171, 2172, 2174, 2176, 2176, 2176, 2177
atrium integrator console 699, 712, 727, 728, 729, 730, 730, 732, 737, 738, 738, 738, 739, 739,
741, 743, 746, 764, 817, 817, 821, 822, 823, 824, 2162, 2162, 2164, 2165, 2166, 2166, 2166, 2167
atrium integrator maintenance tool 834, 834
atrium integrator spoon 139, 291, 690, 692, 694, 699, 699, 700, 716, 716, 723, 724, 725, 727, 738,
761, 764, 765, 767, 768, 770, 773, 801, 802, 805, 808, 808, 809, 809, 810, 811, 811, 812, 813, 816
, 818, 824, 825, 826, 826, 827, 829, 831, 832, 833, 2167, 2167, 2168, 2168, 2168
atrium product catalog 414, 414
attachment 1237, 1241, 1333
attribute 987, 1391
attributedatasourcelist 987
attributegetstruct 1333
attributelimit 1333
attributelimitlist 1337
attributenameid 1337
attribute permissions 402
attributes 73, 73, 155, 167, 168, 168, 172, 173, 192, 193, 295, 297, 347, 350, 357, 366, 471, 520
, 529, 535, 537, 539, 542, 545, 553, 554, 559, 563, 714, 730, 877, 918, 987, 1072, 1075, 1112, 1133,
1135, 1139, 1183, 1189, 1331, 1333, 1333, 1337, 1337, 1338, 1338, 1338, 1339, 1357, 1358, 1358, 1361, 1377, 1377,
, 1382, 1398, 1401, 1408, 1419, 1435, 1436, 1441, 1477, 2138, 2159
attributevaluelist 1338
attributevaluelistlist 1338
attributevaluestruct 1338
attriubtes 548
audit 539, 1339, 1339, 1340, 1413
auditinfostruct 1339
BMC Atrium Core 9.0
Page 2233 of 2268
Home
audits 366
auditvaluelistlist 1340
authentication 2131, 2168
authority 1032
automatic incident creation 2209
availability 138, 201, 236, 247, 299, 300, 300, 301, 305, 306, 306, 308, 310, 311, 564, 565, 566,
568, 571, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151, 2155
available 1324
axis2 90, 140, 222, 236, 1258, 1259, 1259, 1261, 1262, 1263, 1264, 1275, 1324
b
bar 950, 972
base 1183
baseline 1037, 1052, 1063, 1063, 1063, 1064, 1066
batch 202, 889, 929, 937, 955, 963
begin 1389, 1390, 1429
beginclientmanagedtransaction 1390
benefits 77, 80, 201
best practice 883, 1072
best practices 107, 107, 108, 109, 109, 133, 142, 202, 216, 219, 314, 960
blacklisted 512
bladelogic 459, 464, 468, 504
blob 1415
bmc 71, 454, 455, 464, 955
bmc asset 71, 363, 369, 371, 372, 373, 670, 680, 683, 684, 685, 686, 951, 980
bmc asset management 71, 184, 201, 372, 382, 383, 384, 426, 684, 1188
bmc atrium cmdb 71, 72, 72, 72, 73, 74, 75, 85, 88, 89, 229, 229, 229, 240, 241, 242,
242, 243, 243, 244, 244, 244, 245, 245, 246, 247, 248, 249, 250, 405, 519, 520, 521, 523, 527, 528
, 529, 535, 537, 539, 541, 542, 542, 543, 545, 547, 548, 549, 550, 1116, 1117, 1118, 1121, 1132, 1133,
1135, 1139, 1142, 1143, 1154, 1154, 1155, 1157, 1158, 1159, 1161, 1182, 1183, 1185, 1188, 1189, 1189, 1195, 1196,
, 1219, 1220, 1221, 1222, 1225, 1225, 1231, 1232, 1233, 1246, 1247, 1249, 1250, 1252, 1255, 1255, 1256, 1256, 1257
1465, 1467, 1997, 2019, 2027, 2047, 2088, 2102, 2136, 2138, 2140, 2140, 2142, 2142, 2159, 2172, 2174, 2181, 2182,
, 2183, 2183, 2184, 2185, 2185, 2186
bmc atrium console 1257
bmc atrium core 70, 72, 72, 73, 73, 74, 75, 75, 76, 85, 89, 89, 90, 90, 90, 90,
93, 223, 235, 236, 236, 237, 237, 238, 239, 240, 389, 390, 392, 393, 399, 402, 402, 404, 405, 407
, 411, 1226, 1249, 1250, 1252, 1255, 1255, 1256, 1256, 1257, 1264, 1381, 1381, 2003, 2029, 2030, 2080, 2081, 2082,
2084, 2084, 2084, 2084, 2085, 2085, 2085, 2086, 2087, 2091, 2100, 2102, 2102, 2102, 2103, 2104, 2104, 2109, 2110,
, 2112, 2135, 2136, 2136, 2142, 2142, 2143, 2143, 2144, 2145, 2145
bmc atrium core maintenence tool 226
bmc atrium discovery and dependency mapping 179, 184, 190, 955
BMC Atrium Core 9.0
Page 2234 of 2268
Home
bmc atrium integration engine 222, 841, 842, 844, 845, 845, 847, 847, 848, 849, 850, 851, 852,
853, 856, 857, 858, 862, 862, 863
bmc bladelogic client automation 179, 184, 190, 426
bmc change management 426
bmc cloud lifecycle management 1032, 2129
bmc contributor 1997, 2209, 2210, 2212, 2214, 2217
bmc impact solutions 173
bmc internal 55, 973, 2227
bmc products 173
bmc remedy ar system 80, 89, 137, 138, 139, 140, 165, 173, 200, 223, 255, 257, 425, 697, 819,
1021, 1029, 1117, 1128, 1131, 1133, 1143, 1155, 1159, 1163, 1250, 1255, 1259, 1345, 1446, 1997, 2003, 2039, 2119,
, 2154, 2160, 2176, 2187
bmc remedy change management 310
bmc remedy data import 1163
bmc remedy it service management 1142, 1185, 1190
bmc remedy itsm 71, 345
bmc remedy mid tier 2007
bmc remedy migrator 1165, 1171
bmc service desk 382, 383, 384
bmc service impact manager 213, 300, 300, 565
bmc service level management 71
bmc service request management 666, 2129
bmc sim 213, 300, 300, 565
bmc uicomponent 549
boolean 315
bpcu 1188
browser 259, 1051
browsers 425
browsing 810
bsm 142
building 918
bulk 202, 505, 508, 508, 509, 510, 511, 517
bulk entry 1385, 1405
bulk entry transaction 1385, 1389
bulk load 88
bulk loads 812
business 215, 218, 219, 289, 670, 671, 678, 680, 2034
business services 1088, 2139
button 2103
c
BMC Atrium Core 9.0
Page 2235 of 2268
Home
c 1231, 1246, 1247, 1250, 1252, 1255, 1255, 1256, 1256, 1257, 1328, 1331, 1333, 1333, 1337, 1337, 1338, 1338, 1338
1339, 1339, 1340, 1340, 1341, 1341, 1342, 1342, 1343, 1344, 1344, 1345, 1346, 1346, 1347, 1347, 1347, 1348, 1348,
, 1349, 1350, 1350, 1351, 1352, 1352, 1353, 1353, 1354, 1354, 1355, 1356, 1356, 1357, 1357, 1358, 1358, 1359, 1359
1359, 1360, 1361, 1361, 1362, 1363, 1363, 1364, 1364, 1365, 1365, 1366, 1367, 1367, 1368, 1369, 1370, 1370, 1371,
, 1372, 1373, 1373, 1374, 1374, 1374, 1375, 1375, 1375, 1376, 1376, 1377, 1377, 1377, 1378, 1380, 1380, 1381, 1381
1382, 1382, 1382, 1383, 1383, 1385, 1388, 1389, 1390, 1391, 1391, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403,
, 1405, 1405, 1406, 1407, 1408, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426
1426, 1427, 1429, 1430, 1430, 1431, 1432, 1433, 1433, 1434, 1435, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445,
, 1446, 1447, 1447, 1448, 1449, 1453, 1453, 1455, 1456, 1457, 1458, 1461, 1465, 1467, 1472, 1472, 1473, 1473, 1475
1475, 1476, 1477, 1477, 1478, 1479, 1479, 1479, 2047, 2102, 2136
cache 813, 1189
cache settings 231
calbro 311, 316, 324, 434
calbro services 172, 174, 179, 184, 193, 199, 205, 311, 316, 383, 678, 680
cancel 958, 1083, 1391
canceljobrun 1391
cancelling 943
cardinality 158, 1361, 2184
carte 2167
carter server 819
carte server 692, 697
cascade 355
cascading 158
categorization 160, 168, 168, 169, 203, 438, 454, 454, 455, 459, 461, 464, 464, 466, 467, 468, 470
, 471, 474, 475, 927
category 889
causes 1094, 1094
cdm 73, 73, 151, 154, 155, 155, 158, 160, 165, 166, 166, 167, 168, 168, 168, 169, 172, 172, 173
, 173, 179, 294, 295, 297, 519, 520, 521, 523, 527, 528, 529, 535, 537, 539, 541, 542, 542, 543,
545, 547, 548, 549, 550, 553, 554, 558, 563, 574, 629, 884, 1020, 1185, 1477, 2098, 2117
cdm2html 173, 550
cdmchecker 2098, 2178, 2187
cdm class 459
cdm denormalization 634
challenges 153
change 65, 310
change management 299, 300, 300, 310, 311, 455, 1040
change request 310, 1094, 1094, 1097, 1105, 1106
changes 165, 173
changing 357, 738, 808, 809, 811, 1108, 1190
character 1333
characters 2084
check 2100
BMC Atrium Core 9.0
Page 2236 of 2268
Home
checker 2098
checklist 730
checksum 813
child 746
children 360
choices 666, 668
chunkeditem settings 231
ci 179, 454, 461, 464, 464, 467, 468, 468, 474, 492, 494, 515, 713, 713, 743, 746, 869, 874, 877,
878, 969, 1109, 1435, 2125, 2139, 2171, 2179, 2181, 2182, 2182, 2183, 2183, 2184, 2185, 2185, 2186, 2198
ci editor 1190
cim 73
cis 82, 168, 174, 177, 179, 184, 191, 201, 205, 206, 207, 207, 208, 210, 212, 212, 213, 213, 280,
285, 286, 289, 294, 297, 299, 300, 300, 305, 306, 306, 308, 310, 311, 311, 313, 314, 315, 316, 317
, 320, 323, 346, 347, 350, 355, 357, 359, 360, 362, 363, 366, 368, 368, 371, 372, 373, 376, 377,
380, 381, 520, 529, 545, 564, 565, 566, 568, 571, 680, 715, 812, 871, 872, 874, 877, 884, 884, 885
, 899, 901, 927, 940, 949, 969, 1009, 1109, 1111, 1112, 1139, 1142, 1143, 1148, 1149, 1163, 1174, 1174, 1331,
1346, 1373, 1374, 1406, 1429, 1430, 1430, 1453, 1453, 1458, 1461, 1477, 2210, 2212
ci type selection 743, 746
class 407, 1163, 1188, 1394, 1402
classes 73, 73, 160, 165, 167, 169, 172, 173, 295, 297, 347, 350, 357, 380, 519, 528, 529, 537,
539, 541, 547, 548, 553, 554, 558, 559, 563, 708, 889, 893, 898, 918, 923, 924, 1020, 1117, 1118, 1133
, 1135, 1139, 1143, 1148, 1165, 1169, 1171, 1174, 1174, 1182, 1183, 1185, 1189, 1220, 1331, 1337, 1339, 1340, 1341
1341, 1342, 1359, 1375, 1375, 1411, 1416, 1437, 1473, 1476, 2117, 2138, 2142, 2144, 2145, 2185, 2187
class manager 73, 173, 294, 295, 297, 519, 537, 541, 542, 542, 559, 1135, 1139, 1447
classnameid 1340
classnameidlist 1341
class permissions 402
class properties 523
classrelationship 1341
classtypeinfo 1342
cleaning 967
cli 1159, 1165
client 139, 184, 692, 699, 2030
client managed 1385, 1405, 1434, 1440
client managed transaction 1385, 1390, 2102
clients 1256
clm 1032
clone 492
clusters 138, 201, 236, 247, 571, 702, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151,
2155
cmdb 82, 83, 84, 85, 150, 151, 153, 153, 174, 174, 174, 177, 178, 179, 179, 179, 181, 182,
184, 190, 200, 201, 730, 811, 816, 869, 1422, 1453, 1997, 2140
cmdb2asset 1182, 1185, 1188
BMC Atrium Core 9.0
Page 2237 of 2268
Home
cmdb atrium cmdb 2022

cmdb best practices 122
cmdb dashboard 264
cmdbdiag 2179, 2182, 2214
cmdbdriver 1155, 1173, 1174, 1174, 1220, 1255, 1256, 1465, 1467, 1469, 1470, 1472, 1472, 1473, 1473, 1475, 1475,
1476, 1477, 1477, 1478, 1479, 1479, 1479, 2136
cmdb engine logging 233
cmdbf 84, 89, 192, 1122, 1133
cmdbgraphquery 1447, 1455, 1456, 1457, 1458, 1461
cmdbgraphwalk 1453, 1453
cmdbgraphwalkbegin 1479
cmdbgraphwalkend 1479
cmdbgraphwalknext 1479
cmdb output 816
cmdbquerybypath 1447, 1448, 1449
cms 82, 83, 84, 85
code sample 1237, 1241
command line 563, 1159, 1165, 1467, 1469
commands 1155, 1469, 1470, 1472, 1475, 1475, 1476, 1477, 1477, 1478, 1479, 1479, 1479
common 1039, 1235
common data model 73, 73, 151, 154, 155, 155, 158, 160, 165, 166, 166, 167, 168, 168, 168,
169, 172, 172, 173, 173, 179, 294, 295, 297, 519, 520, 521, 523, 527, 528, 529, 535, 537, 539, 541
, 542, 542, 543, 545, 547, 548, 549, 550, 553, 554, 558, 563, 574, 629, 1020, 1185, 1476, 1477, 2117
common information model 73
companies 428, 476, 478
company 428, 429, 431, 478, 483, 484
company alias 431
compare 207, 363, 966, 998, 1001, 1002, 1017, 1017, 1019
comparing 207, 306, 363, 1112
comparision 966
comparison 363, 862, 862, 863, 1105, 1111, 1171
comparison job 1037, 1052, 1081, 1109
comparison jobs 1077, 1079
comparison service 1109
compiler 1252
component 1385, 1422
components 71, 72, 72, 72, 73, 73, 74, 75, 75, 76, 85, 203, 213, 215, 267, 278, 280,
285, 286, 390, 414, 415, 1246, 1247, 1249, 1252, 1331, 1378, 1380, 1380, 1381, 1381
concept 70, 70, 71, 72, 72, 73, 73, 74, 75, 75, 76, 76, 77, 77, 77, 79, 80, 80,
82, 83, 84, 85, 85, 88, 89, 89, 90, 90, 90, 90, 93, 93, 136, 136, 137, 138, 138, 139
, 140, 142, 151, 153, 153, 154, 155, 155, 158, 160, 166, 166, 167, 168, 168, 168, 169, 172, 172,
173, 173, 174, 174, 174, 177, 178, 179, 179, 179, 181, 182, 184, 190, 191, 192, 193, 193, 197, 198
, 199, 200, 201, 201, 201, 202, 203, 205, 205, 206, 207, 207, 208, 210, 212, 212, 213, 213, 213,
BMC Atrium Core 9.0
Page 2238 of 2268
Home
215, 216, 218, 219, 222, 222, 223, 255, 255, 257, 259, 275, 280, 285, 286, 289, 295, 298, 299, 300
, 300, 301, 311, 313, 314, 315, 316, 317, 369, 375, 376, 380, 382, 414, 415, 416, 417, 418, 419,
426, 527, 553, 558, 564, 565, 566, 571, 574, 662, 683, 688, 689, 690, 691, 692, 692, 694, 697, 697
, 699, 699, 699, 701, 704, 705, 729, 730, 739, 840, 842, 844, 845, 845, 847, 847, 848, 849, 850,
851, 852, 862, 862, 863, 870, 872, 877, 878, 882, 883, 884, 884, 890, 892, 947, 947, 948, 949, 950
, 952, 958, 962, 966, 966, 973, 1020, 1021, 1023, 1034, 1035, 1037, 1063, 1116, 1118, 1121, 1133, 1157, 1162,
1163, 1165, 1169, 1171, 1175, 1178, 1181, 1182, 1182, 1195, 1256, 1259, 1259, 1261, 1262, 1263, 1264, 1465
concepts 1457
conditions 315, 316
configuration 79, 226, 231, 387, 496, 497, 504, 539, 566, 568, 571, 686, 730, 811, 920, 921, 945,
953, 973, 1021, 1021, 1022, 1248, 1470, 2019, 2022, 2025, 2089, 2102, 2102, 2103, 2103, 2104, 2104, 2109, 2117, 21
, 2131, 2158, 2188
configuration item 1088
configuration items 168, 174, 177, 179, 184, 191, 201, 205, 206, 207, 207, 208, 210, 212, 212, 213,
213, 280, 285, 286, 289, 294, 297, 299, 300, 300, 305, 306, 306, 308, 310, 311, 311, 313, 314, 315
, 316, 317, 320, 323, 346, 347, 350, 355, 357, 359, 360, 362, 363, 366, 368, 368, 371, 372, 373,
376, 377, 380, 381, 564, 565, 566, 568, 571, 680, 812, 871, 872, 874, 877, 884, 884, 885, 899, 901
, 927, 940, 949, 969, 1139, 1142, 1143, 1148, 1149, 1163, 1174, 1174
configuration management 80
configurations 941, 944, 1028, 1028
configure 938, 1105, 1107
configuring 228, 229, 229, 231, 235, 235, 236, 236, 237, 238, 239, 240, 240, 241, 242, 242, 243,
243, 244, 244, 278, 344, 894, 923, 929, 935, 938, 941, 942, 955, 969, 1022, 1024, 1025, 1032, 1116, 1182
, 1185, 1191
connect 697
connecting 768
connection 711, 851
connections 729, 730, 730, 732, 737, 738, 738, 738
connectivity 1218, 2131
considerations 138, 138, 139, 140, 169, 200
console 425, 425, 506, 507, 692
consoles 267, 273, 275, 278, 280, 285, 286, 290, 291, 294, 295, 298
continuous 202, 929, 935, 955, 955, 963, 972
contributor unapproved 2210, 2214, 2217
contributor updated 62, 236, 1022, 1025
control 347, 350
controlling 184
controls 376
conventions 976
conversion 1225
converstion 1225
copy 212, 998, 1004, 1005, 1009, 1385, 1413
copying 343, 378
BMC Atrium Core 9.0
Page 2239 of 2268
Home
copy options 1005

copy relationships 1005
corrected 47
correlating 1094
cost 666, 668, 671
create 499, 500, 913, 935, 1234, 1235, 1237, 1241, 1245, 1391, 1394, 1396, 1397, 1398, 1400, 2103
createattribute 1391
createclass 1394
createguid 1396
createinstance 1397
createmultipleattributes 1398
createmultipleinstances 1400
creating 324, 327, 331, 336, 347, 350, 366, 378, 381, 429, 433, 438, 559, 568, 670, 678, 680, 684,
715, 715, 716, 732, 739, 739, 741, 743, 746, 761, 819, 826, 829, 832, 894, 899, 901, 905, 909, 913
, 918, 950, 951, 955, 955, 967, 975, 976, 978, 979, 1024, 1025, 1032, 1046, 1048, 1052, 1058, 1059, 1063,
1063, 1064, 1067, 1067, 1069, 1075, 1076, 1077, 1081, 1122, 1125, 1128, 1132, 1135, 1139, 1143, 1148
creating change request 1097
creation 222, 566
csv 2166, 2167, 2168, 2176
cti 168, 494, 872
currency 816, 1333
current 963
custom 443, 445, 453, 543, 743, 870, 884, 913, 1131, 1176
custom configuration tab 1049
customer 666, 668, 671
customer support 2229
customize 1075, 1088, 1104
customized 967
customizing 1101, 1191
custom qualification set 1069
d
dashboard 264
data 79, 89, 160, 169, 174, 174, 174, 177, 178, 179, 179, 179, 181, 182, 184, 190, 191, 192, 193
, 193, 197, 198, 199, 200, 201, 201, 201, 202, 203, 205, 205, 206, 207, 207, 208, 210, 212, 212,
213, 241, 243, 298, 323, 414, 417, 452, 454, 464, 467, 812, 826, 833, 950, 1101, 1104, 1163, 1229, 1344
, 1355, 1407, 1413, 1431, 2136, 2136, 2144, 2145, 2147, 2149, 2151, 2152, 2160, 2166, 2170, 2170, 2171, 2171, 2171
2176, 2176, 2177
data analyzer 2220
data archiving 1229
database 711, 1121, 2145
BMC Atrium Core 9.0
Page 2240 of 2268
Home
database connection 809

databases 88, 192, 223, 1125
data exchanges 842, 844, 845, 845, 847, 847, 848, 849, 850, 851, 852, 853, 856, 857, 858, 862,
862, 863
data field 2159
data handler 2149
data layer 83, 84
data mappings 808
data model 73, 154, 179, 519, 519, 520, 521, 523, 527, 528, 529, 535, 537, 539, 541, 542, 542,
543, 545, 547, 548, 549, 550, 553, 554, 558, 563, 574, 1139, 1185, 1385, 1476, 2178, 2178, 2179, 2181, 2182
, 2182, 2183, 2183, 2184, 2185, 2185, 2186, 2187, 2210
dataset 504, 909, 986, 1004, 1010, 1017, 1058, 1375, 2104, 2179, 2198
datasets 71, 75, 76, 85, 89, 89, 184, 205, 206, 207, 208, 210, 212, 280, 298, 347, 350, 355,
357, 363, 369, 371, 372, 373, 670, 680, 683, 684, 685, 686, 691, 901, 905, 909, 921, 924, 938, 943
, 950, 951, 960, 985, 987, 1017, 1028, 1028, 1179, 1180, 1181, 1189, 1376
data sources 179, 192, 297, 683, 684, 685
data store 712, 1117, 1135, 1139, 1142, 1143, 1149, 2166
data stores 729, 730, 730, 732, 737, 738, 738, 738, 833, 1132
data structures 1328, 1331, 1333, 1333, 1337, 1337, 1338, 1338, 1338, 1339, 1339, 1340, 1340, 1341, 1341, 1342,
1342, 1343, 1344, 1344, 1345, 1346, 1346, 1347, 1347, 1347, 1348, 1348, 1349, 1349, 1350, 1350, 1351, 1352, 1352,
, 1353, 1354, 1354, 1355, 1356, 1356, 1357, 1357, 1358, 1358, 1359, 1359, 1359, 1360, 1361, 1361, 1362, 1363, 1363
1364, 1364, 1365, 1365, 1366, 1367, 1367, 1368, 1369, 1370, 1370, 1371, 1372, 1372, 1373, 1373, 1374, 1374, 1374,
, 1375, 1375, 1376, 1376, 1377, 1377, 1377, 1378, 1380, 1380, 1381, 1381, 1382, 1382, 1382, 1383
data transfer 700
data type 1133
data types 730
date 1333
db2 2142, 2145
debug 2011, 2020, 2027, 2029, 2030, 2089, 2151
decomposing 219
decompression 2136, 2145
default 184, 884, 955, 1108
default permissions 407
defects 57
defining 357, 438
definition 222, 1135
definitions 203, 1010, 1028, 1028, 1117, 1163, 1165, 1180, 1220, 1408, 1432
definitive hardware library 203, 414, 415, 416, 417, 417, 418, 419, 893
definitive media library 72, 178, 192, 203, 414, 415, 416, 417, 417, 418, 419, 874, 893
delete 212, 491, 515, 516, 517, 541, 913, 998, 1013, 1015, 1062, 1063, 1066, 1069, 1083, 1086, 1234, 1235,
1241, 1401, 1402, 1403, 1404
deleteattributes 1401
deleteclass 1402
BMC Atrium Core 9.0
Page 2241 of 2268
Home
delete data 1013

deleteinstance 1403
delete job 826
deletemultipleinstances 1404
deleting 165, 355, 378, 504, 685, 819, 901, 905, 909, 913, 967, 967, 1025
deletion 158, 184, 2025
delivery 666, 668, 671
denormalization 634
denormalized cmdb 634
deployment 136, 136, 137, 138, 138, 139, 140, 142
deprecate class editor 554, 559
deprecating 553, 554, 558
deprecation 553, 554, 559, 563, 2117
design 216
desk 455
destination 158, 249, 350, 355, 574, 1058
details 292, 823, 824, 966, 2205
developer studio 255, 257
development 255, 1162, 1163, 1163, 1165, 1165, 1169, 1171, 1173, 1174, 1174, 1175, 1176, 1178, 1179, 1180, 1181
dhl 203, 414, 415, 416, 417, 417, 418, 419, 492, 893
diagnostic information 1997
diagnostics 1997, 2003, 2004, 2005, 2006, 2007, 2010, 2011, 2012, 2012, 2015, 2019, 2020, 2021, 2022, 2025
diagram 688, 692, 694
diagrams 80, 574
differences 1259
disabling 901, 905, 909, 913, 941, 943, 972
disaster 201
disaster recovery 138, 201, 236, 247, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151,
2155
discovery 179, 179, 182, 190, 461, 468, 468, 474, 504, 927
display 278, 280, 285, 286, 295, 508, 1191, 2084
distributed 201, 240, 241, 242, 242, 243, 243, 244, 244, 244, 245, 245, 246, 247, 248, 249, 250,
1029, 1032
distributed server option 1189
dml 72, 178, 192, 203, 414, 415, 416, 417, 417, 418, 419, 492, 874, 893
documentation 173, 426
drfit console 1088
drift 1039, 1112
drift console 1085, 1086, 1097
drift correlation 1107
drift dashboard 1101, 1101
drift management 1033, 1034, 1035, 1036, 1040, 1046, 1048, 1050, 1051, 2205, 2205, 2208, 2209
drift report 1101
BMC Atrium Core 9.0
Page 2242 of 2268
Home
drift reports 1079, 1083, 1085, 1086, 1101, 1102

drifts 1052, 1085, 1088, 1093, 1094, 1094, 1094, 1097
drift types 1079
drivers 1125
dsm 680
dso 240, 241, 242, 242, 243, 243, 244, 244, 244, 245, 245, 246, 247, 248, 249, 250, 1029, 1032, 1189
dso mapping 1997
duplicate 2209, 2212, 2214
duplicates 811, 2220
dynamic 670, 680, 960, 2131
dynamic service modeling 2131
dynamic service models 680
e
edgelistlist 1373
editing 343, 357, 686, 716, 716, 723, 724, 725, 737, 764, 765, 767, 768, 770, 773, 801, 802, 808,
808, 809, 809, 810, 811, 811, 813, 817, 817, 818, 819, 825, 901, 913, 1024, 1025, 1135, 1139
eligibility 174
embedding 257
enable 913
enabling 901, 905, 909, 913, 972, 1032
encryption 2171
end 1405, 1405, 1430
endbulkentrytransaction 1405
endclientmanagedtransaction 1405
end points 1427
end to end 93, 1245
engine 387
entries 203, 417, 438, 442, 443, 467, 468, 470, 476, 476, 478, 483, 491, 492, 496, 504, 505, 506,
893, 897, 1176
entry 475
enum 1333
environment 85, 181, 1385, 1447
environments 1162, 1163, 1163, 1165, 1165, 1169, 1171, 1173, 1174, 1174, 1175, 1176, 1178, 1179, 1180, 1181
error 2041, 2045, 2073, 2076, 2078, 2111
error messages 2020, 2021, 2022, 2029, 2031, 2032, 2032, 2034, 2036, 2039, 2039, 2040, 2041, 2045, 2047, 2065,
2073, 2076, 2078, 2084, 2104, 2109, 2111, 2119, 2142, 2142, 2143, 2143, 2145, 2149, 2154, 2154, 2159, 2161, 2162,
, 2164, 2165, 2166, 2166, 2166, 2167, 2171, 2171, 2171, 2172, 2174, 2189, 2190, 2191, 2191, 2192, 2193
errors 924, 2010, 2019, 2020, 2021, 2022, 2022, 2025, 2027, 2031, 2039, 2039, 2040, 2047, 2065, 2084, 2104, 2109,
2119, 2122, 2131, 2142, 2142, 2143, 2143, 2145, 2149, 2154, 2154, 2159, 2161, 2162, 2162, 2164, 2165, 2166, 2166,
, 2167, 2171, 2171, 2171, 2172, 2174, 2189, 2190, 2191, 2191, 2192, 2193, 2208
BMC Atrium Core 9.0
Page 2243 of 2268
Home
event channel 2125

event driven 764
event engine 2125
events 1195, 1196, 1198
example 414, 418, 1237, 1243, 1449, 1453, 1457, 1458, 1472, 1473, 1473
examples 172, 174, 179, 184, 193, 199, 205, 216, 311, 316, 383, 461, 678, 680, 890, 1075, 1169,
1171, 1241
exchange 2147, 2149, 2170, 2170, 2171, 2171, 2171
exchanges 2012, 2015, 2151, 2160, 2176
exclude orphaned weak cis 967
exclude set 1037
exclude sets 1069, 1075, 1076
execute 212, 998, 1012
execution 207, 850, 1002
expand 1235, 1406
expandparametersforci 1406
exploring 809
export 467, 517, 834, 1028, 1331, 1342, 1343, 1344, 1382, 1385, 1407, 1408, 1475
export configuration tool 837
exportdata 1407
exportdef 1408
exporting 298, 379, 826, 831, 833, 941, 944, 1028, 1174, 1176, 1179, 1180
exportitem 1342, 1343, 1344
exportitemlist 1343
exportitemstruct 1344
exports 1220
exposed 1264
expressions 918
extension 2084
extension loader 1154, 1158, 2081, 2082, 2084
extensions 155, 166, 166, 167, 168, 168, 168, 169, 172, 172, 173, 173, 297, 1020, 1154, 1154, 1155,
1157, 1158, 1159, 1161, 1219, 1220, 1221, 1222, 1225, 1225
external 833
f
fail 973
failover 138, 201, 236, 247, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151, 2155
fail safe 973
failures 924
fault tolerance 138, 201, 236, 247, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151, 2155
features 45, 870, 878, 882, 883, 884, 884, 894, 897, 898, 901, 905, 909, 913
BMC Atrium Core 9.0
Page 2244 of 2268
Home
federatedactiveinfo 1344
federatedarinfo 1345
federated data 1116, 1118, 1121, 1131, 1135, 1139, 1143
federatedinterface 1388, 1425
federated link 1189
federated links 1142

federation 85, 89, 168, 178, 191, 192, 193, 193, 301, 323, 1116, 1117, 1118, 1121, 1131, 1132, 1133,
1135, 1139, 1142, 1148, 1149, 1181, 1331, 1344, 1345, 1385, 1388, 1425, 1479, 2039, 2039, 2040, 2142, 2142, 2143,
, 2144, 2145
federation manager 323, 1117, 1118, 1131, 1132, 1135, 1139, 1142, 1143, 1148, 1149, 2143
field id 168, 172
field type 809
file 942, 2026
files 488, 489, 1248, 1259
filter 1086, 1105, 1106, 1353, 1353, 2073
filter reports 264
filters 359, 360, 362, 368, 376, 380, 381, 1196
final 169
find duplicates 2220
finding 317
fixed 57
fixes 45
flag 483
flags 1353, 2145
flash 2030, 2229
flow 201
folding 336
foreign key 193
form 259, 471, 481, 2136
format 2166
formats 315
forms 160, 192, 193, 257, 442, 443, 445, 542, 1128, 1161, 1165, 1176, 1182, 1183, 1185, 1185, 1188, 1255,
2140
free 1385
function 863, 2102

functionality 1275
functions 1383, 1385, 1388, 1389, 1390, 1391, 1391, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403, 1404, 1405, 14
, 1406, 1407, 1408, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426, 1426, 1427
1429, 1430, 1430, 1431, 1432, 1433, 1433, 1434, 1435, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445, 1446, 1446,
, 1447, 1448, 1449, 1453, 1453, 1455, 1456, 1457, 1458, 1461, 1465, 1467, 1475, 1477
BMC Atrium Core 9.0
Page 2245 of 2268
Home
g
general 741
general settings 231
generate 985
generating 1185
get 1234, 1237, 1241, 1245, 1333, 1346, 1346, 1347, 1347, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421, 14
1423, 1424, 1425, 1426, 1426
getattribute 1408
getattributes 1419
getclass 1411
getcmdbuicomponent 1422
getcopy 1413
getcopyauditdata 1413
getinstance 1414, 1415
getinstanceblob 1415
getinstances 1421
getjobrun 1423
getlist 1416, 1417
getlistclass 1416
getlistinstances 1417
getlistjobrun 1424
getmultipleattributes 1419
getmultipleinstances 1421
getobjectlist 1346
getobjectstruct 1346
getrelatedfederatedincontext 1425
getrelationshiplist 1347
getrelationstruct 1347
getserverport 1426
getversions 1426
global 943
goals 77, 93, 151, 218
graph 1347, 1348, 1348, 1349, 1369, 1372
graphadjacentlist 1347
graphadjacentstruct 1348
graphlist 1348
graph query 1243, 1427, 1455, 1456, 1457, 1458, 1461
graphqueryresult 1372
graphstruct 1349
graphwalk 1349, 1350, 1350, 1351, 1352, 1352, 1353, 1353, 1354, 1429, 1430, 1430, 1447, 1453, 1453, 1479
graphwalkbegin 1429
graphwalkend 1430
BMC Atrium Core 9.0
Page 2246 of 2268
Home
graphwalknext 1430
graphwalkobjectlist 1349
graphwalkobjectstruct 1350
graphwalkquerystruct 1350
graphwalkrelation 1351
graphwalkrelationlist 1352
graphwalkresultstruct 1352
graphwalkselectorandfilter 1353
graphwalkselectorandfilterstruct 1353
graphwalkstatestruct 1354
group 549, 948
grouping 184, 315
groups 213, 368, 392, 393, 399, 454, 704, 1040, 1048
guid 1396
guidelines 166, 167, 172, 179, 190, 192, 202, 216, 219, 314, 1058, 1069, 1072, 1075, 1076
guids 1221
h
handle 2091
header 1383
headers 1248, 1252
health check 226, 1997
help 550
hidden 362
hide 508
high availability 138, 201, 236, 247, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151,
2155
history 366, 728, 822, 950, 964
home 39
http 141, 1235
https 141
hub 429
hub and spoke 429
i
icons 543
id 184, 885, 940, 945, 949, 952, 1029, 1032, 2203
identification 953, 982, 985, 986, 1023, 1024, 2209, 2212, 2217
identify 206, 481, 945, 946, 947, 952, 953, 962, 969, 974, 978, 979, 980, 986, 1023, 1024, 1109, 1111
identifying 558
BMC Atrium Core 9.0
Page 2247 of 2268
Home
identity 2191, 2194, 2195, 2198

ids 1032
ignore 969
ignoring 969
image 542
images 379
impact 299, 300, 300, 301, 305, 306, 306, 308, 310, 311, 357, 564, 565, 566, 568, 571, 870, 882,
905
impactcomputationmodel 571
impactpropagationmodel 571
impactweight 571
implementation 153, 199, 890
import 436, 442, 443, 453, 1028, 1163, 1178, 1331, 1355, 1383, 1385, 1431, 1432, 1475
importdata 1431
importdatasummarystruct 1355
importdef 1432
importing 442, 753, 758, 759, 761, 764, 765, 767, 768, 770, 773, 801, 802, 808, 808, 809, 809, 810
, 811, 811, 813, 813, 825, 826, 826, 827, 829, 831, 832, 833, 941, 944, 1028, 1155, 1174, 1179, 1180,
1472
importing data 687
importitem 1354
importitemstruct 1356
inactive 963
incident 455
incident management 1040, 2209
incident request 1097
include set 1037
include sets 1069, 1075, 1075
increasing 813
indentify 951
index 1356, 1357, 2227
indexes 537, 1189
indexlist 1356
indexstruct 1357
individual 438
information 966
infrastructure 137, 140, 142, 222, 236, 1258, 1259, 1259, 1261, 1262, 1263, 1264, 1275
inheritance 155
initial 202, 1109, 1109
initialization 1159, 1433, 1446, 2104, 2117
inline 202, 929, 935
install 436, 2007
BMC Atrium Core 9.0
Page 2248 of 2268
Home
installation 142, 150, 224, 1157, 1159, 1161, 1999, 2000, 2080, 2081, 2082, 2084, 2084, 2084, 2084, 2084, 2085,
2085, 2086, 2087, 2088, 2089, 2089, 2089, 2205, 2208
installations 1222
installing 563
instance 549, 1234, 1397
instance groups 368
instancelist 1357
instance permissions 404, 405, 1043
instances 71, 72, 72, 73, 73, 75, 82, 83, 89, 168, 174, 177, 179, 184, 191, 201, 205, 206
, 207, 207, 208, 210, 212, 212, 213, 213, 280, 285, 286, 289, 294, 297, 299, 300, 300, 305, 306,
306, 308, 310, 311, 311, 313, 314, 315, 316, 317, 320, 323, 346, 347, 350, 355, 357, 359, 360, 362
, 363, 366, 368, 368, 371, 372, 373, 376, 377, 380, 381, 564, 565, 566, 568, 571, 680, 812, 871,
872, 874, 877, 884, 884, 885, 899, 901, 927, 940, 949, 969, 1143, 1163, 1174, 1174, 1198, 1331, 1346, 1357
, 1358, 1385, 1400, 1403, 1404, 1414, 1415, 1417, 1421, 1440, 1443, 1453, 1458, 1461, 1477, 1479, 2138, 2155, 2194
2198
instancestruct 1358
integration 255, 255, 257, 259
integration job builder 699, 700, 707, 708, 712, 713, 713, 714, 715, 715, 716, 739, 739, 741, 743,
746, 753, 758, 759, 819
integration job details 728
integrity 243
interface 264, 267, 273, 275, 278, 280, 285, 286, 290, 295, 297, 301, 376
interfaces 1142, 1143, 1148, 1149
interoperability 142
interrupted 929
interval 1189
intial 812
ipv4 223
ipv6 223
issues 45, 47, 57, 1996, 1997, 1999, 2000, 2003, 2004, 2005, 2006, 2007, 2010, 2011, 2012, 2012, 2015, 2019,
2020, 2021, 2022, 2022, 2025, 2026, 2027, 2029, 2073, 2076, 2078, 2080, 2081, 2082, 2084, 2084, 2084, 2084, 2084,
, 2085, 2085, 2086, 2087, 2088, 2089, 2089, 2089, 2091, 2091, 2091, 2092, 2093, 2093, 2096, 2097, 2098, 2100, 2102
2102, 2102, 2103, 2103, 2104, 2104, 2108, 2108, 2109, 2110, 2111, 2112, 2114, 2119, 2122, 2125, 2128, 2129, 2131,
, 2136, 2136, 2136, 2138, 2139, 2140, 2140, 2142, 2142, 2142, 2142, 2143, 2143, 2144, 2145, 2145, 2147, 2147, 2149
2151, 2151, 2152, 2153, 2154, 2154, 2155, 2155, 2158, 2159, 2159, 2160, 2160, 2161, 2162, 2162, 2164, 2165, 2166,
, 2166, 2167, 2167, 2167, 2168, 2168, 2168, 2170, 2170, 2171, 2171, 2171, 2171, 2172, 2174, 2176, 2176, 2176, 2177
2178, 2178, 2179, 2181, 2182, 2182, 2183, 2183, 2184, 2185, 2185, 2186, 2187, 2188, 2188, 2188, 2189, 2190, 2191,
, 2192, 2193, 2194, 2195, 2198, 2202, 2203, 2209
it 151
item 1342, 1343, 1344
itemtypeattribute 1358
itemtypeclass 1359
itil 76, 77, 77, 77, 79, 80, 82, 174, 1036
BMC Atrium Core 9.0
Page 2249 of 2268
Home
itsm 429, 471, 517, 889
j
java 223, 550, 1231, 1232, 1247, 1248, 1250, 1324, 2019, 2020, 2021, 2022, 2131, 2136
jdbc 1125, 1133, 2040
job 692, 953, 967, 980, 1010, 1013, 1015, 1017, 1077, 1083
job console 1077, 1078
job details 1083
job history 1083
job logs 1083
job run 885, 940, 1376, 1377, 1423, 1424, 1445
jobs 212, 212, 298, 700, 712, 716, 716, 716, 723, 724, 725, 727, 728, 729, 739, 739, 741, 743, 746
, 748, 753, 758, 759, 760, 761, 763, 764, 764, 765, 767, 768, 770, 773, 801, 802, 805, 808, 808,
809, 809, 810, 811, 811, 812, 813, 817, 817, 818, 819, 821, 822, 823, 824, 825, 826, 826, 827, 829
, 831, 832, 833, 834, 834, 837, 837, 840, 841, 842, 844, 845, 845, 847, 847, 848, 849, 850, 851,
852, 853, 856, 857, 858, 862, 862, 863, 885, 929, 935, 937, 940, 943, 945, 950, 951, 952, 955, 955
, 955, 958, 958, 958, 960, 962, 963, 964, 966, 966, 967, 967, 972, 973, 1012, 1023, 1024, 1025, 1028,
1028, 1179, 1180, 1226, 1376, 1377, 1391, 1423, 1424, 1445, 1479, 2019, 2021, 2022, 2025, 2093, 2093, 2096, 2097,
, 2164, 2165, 2166, 2166, 2168, 2168, 2169, 2170, 2171, 2172, 2174, 2176, 2176, 2176, 2177, 2189, 2190, 2191, 2191
2192, 2193
job trigger 1226
join 1185
jre 2084
k
knowledge management 455
known 47
l
labels 545
last load 1112
launch 193, 1116, 1117, 1121, 1132, 1135, 1142, 1143, 1148, 1149, 1181, 2084
launching 255, 259, 267, 273, 290, 291, 292, 294, 298, 808
layer 2034
layers 1191
layout 375, 376, 377, 1182
layouts 360
level 942
BMC Atrium Core 9.0
Page 2250 of 2268
Home
levels 387
libraries 1248, 1252
license 402, 509, 878
licenses 878, 893
lifecycle 510, 671
limit 1235
limitations 554, 842
limits 1333, 1337
linking 680, 1143
links 1143, 1148, 1149

linus 2155
list 743, 1337, 1338, 1338, 1339, 1340, 1341, 1343, 1346, 1347, 1347, 1348, 1349, 1352, 1353, 1353, 1356, 1357, 135
1358, 1363, 1364, 1364, 1370, 1373, 1373, 1374, 1374, 1375, 1375, 1377, 1377, 1380, 1381, 1382, 1382, 1383, 1416,
, 1424, 1426, 1435, 1445
listener 2149
listing 1324, 1473
load 137, 202, 2143, 2145
load balance 201
load balancing 138, 201, 236, 247, 701, 702, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131
, 2151, 2155
loading 306, 812, 1109, 1109
location 480
log 387, 942, 1997, 1999
log file location 2177
log files 2205, 2205, 2208
logging 233, 387, 941, 942, 1470, 2122, 2169, 2205

login 1173, 1234
logs 539, 856, 1997, 2000, 2003, 2004, 2005, 2006, 2007, 2010, 2011, 2012, 2012, 2015, 2019, 2020, 2021, 2022, 202
, 2025, 2026, 2027, 2027, 2029, 2029, 2030, 2031, 2089, 2089, 2142, 2143, 2167, 2187, 2195, 2203
m
maintenance 1154, 1997, 2007
maintenance tool 1997
maintenence 2089
maintentance 1999
manage 476, 485, 1077, 1085, 1093
managed 512
manage data store 729, 730, 730, 732, 737, 738, 738, 738
management 455, 662, 878, 2155
manage product console 500
managing 683
BMC Atrium Core 9.0
Page 2251 of 2268
Home
manual 438, 958, 986, 1143

manually 958, 963, 986
manufacturer 498, 499, 500, 502
manufacturername 877
manufacturers 438, 927
many to many 1165
many to one 1165
mapped 474
mapping 179, 454, 464, 474, 715, 767, 816, 832, 927, 1382, 2147, 2152, 2159
mapping data 459
mappings 247, 553, 559, 746, 849, 944, 2171
mark 502, 503
market version 893
matching instances 978
matrix 174
memory 2191
merge 207, 208, 210, 372, 945, 946, 947, 951, 952, 953, 962, 972, 974, 986, 987, 988, 989, 989,
992, 995, 997, 1023, 1025, 2202
merging 207, 208, 210
messages 2012, 2012, 2015, 2031, 2034, 2039, 2039, 2040, 2041, 2045, 2047, 2065, 2073, 2076, 2078, 2084, 2104,
2109, 2111, 2119, 2142, 2142, 2143, 2143, 2145, 2149, 2154, 2154, 2159, 2161, 2162, 2162, 2164, 2165, 2166, 2166,
, 2167, 2171, 2171, 2171, 2172, 2174, 2189, 2190, 2191, 2191, 2192, 2193
metadata 558, 1165, 1446
method 1133, 1135, 1142, 1149
methods 166, 191, 193, 1116, 1121, 1132, 1143, 1181
mid tier 2007, 2029, 2110, 2136
migrating 834, 841, 842, 844, 845, 845, 847, 847, 848, 849, 850, 851, 852, 853, 856, 857, 858, 862
, 862, 863
migration 840, 1162, 1163, 1163, 1165, 1165, 1169, 1171, 1173, 1174, 1174, 1175, 1176, 1178, 1179, 1180, 1181, 217
, 2170, 2171, 2171, 2171, 2171, 2172, 2174, 2176, 2176, 2176, 2177
migration job 829
minimal 137
missing index 2227
model 198, 487, 877, 2032, 2032
models 564, 565, 566, 568, 571, 574, 662, 666, 668, 670, 671, 678, 680, 2129, 2131
modes 929, 934
modification 520, 521, 1183
modifications 289, 1259, 1261, 1262, 1263
modify 499, 500, 1062, 1063, 1066, 1069, 1083
modifying 357, 686, 760, 819, 975, 1132, 1185
monitor 885, 940
monitoring 298, 728, 821, 822, 823, 824, 964, 973
ms sql 141
BMC Atrium Core 9.0
Page 2252 of 2268
Home
multenancy 421
multimatch 969
multi matched 950, 969
multi matches 950, 969
multiple 138, 201, 210, 242, 832, 1398, 1400, 1404, 1419, 1421, 1441, 1443, 1461
multiple instances 1237
multitenancy 197, 198, 199, 203, 417, 427, 434, 878
multithreading 1021
n
name 885, 940
names 1337, 1338, 1339, 1340, 1341, 1359, 1361
namespace 982
namespaces 347, 350, 527, 945, 1020, 1337, 1340
naming 172
navigating 267, 273, 275, 278, 280, 285, 286, 290, 291, 294, 295
navigation 264, 295
ne 387
ne best practices 132
nest 1359, 1368
nested 336
nestedquerystruct 1359
networks 223
new 45, 438, 670, 678
next 1430
nodelist 1373
nodelistlist 1374
nodes 1347, 1348, 1349, 1373, 1374
non reconciled 2220
normalization 74, 85, 132, 141, 201, 201, 202, 203, 205, 387, 414, 417, 418, 436, 492, 494, 496,
497, 498, 503, 504, 868, 869, 870, 871, 872, 874, 877, 878, 882, 883, 884, 884, 889, 890, 892, 892
, 894, 897, 898, 899, 901, 905, 909, 913, 918, 920, 921, 923, 924, 927, 929, 934, 935, 935, 937,
938, 941, 941, 942, 943, 943, 944, 1179, 2004, 2103, 2104, 2104, 2122, 2145
normalization best practices 132
normalization jobs 885, 940
normalizationstatus 871
notification 1195
notifications 1198, 2119
null 877, 988
numbering 172
BMC Atrium Core 9.0
Page 2253 of 2268
Home
o
object 1245, 2034
objectives 151
objects 1165, 1234, 1235, 1346, 1346, 1349, 1350, 1359, 1362, 1363, 1363, 1364, 1364, 2138
offset 1235
one to many 1165
one to one 1165
one way 244, 245, 245, 246, 247, 248, 249
ootb 884
openconnection 2149
opening 267, 273, 290, 291, 292, 294, 298, 310, 765, 1117
operands 1360, 1365, 1365, 1366, 1367, 1367, 1368
operating systems 223, 414, 419
operations 1235, 1237, 1241, 1243, 1245, 1360, 1383, 1385, 1388, 1389, 1390, 1391, 1391, 1394, 1396, 1397, 1398,
1400, 1401, 1402, 1403, 1404, 1405, 1405, 1406, 1407, 1408, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421,
, 1423, 1424, 1425, 1426, 1426, 1427, 1429, 1430, 1430, 1431, 1432, 1433, 1433, 1434, 1435, 1436, 1437, 1440, 1440
1441, 1443, 1444, 1445, 1446, 1446, 1447, 1447, 1448, 1449, 1453, 1453, 1455, 1456, 1457, 1458, 1461, 1475, 1478
optional 941
options 215, 278, 285, 286, 316, 344, 376, 420, 539, 666, 668, 671, 678, 737, 921, 944, 953, 1005,
1022, 1469, 1470
oracle 141, 2166
orientation 69
orphans 2185, 2186
out of the box 884
overivew 69
overlay 184, 684
overlays 1188
overview 70, 90, 155, 155, 158, 160, 197, 198, 199, 202, 203, 213, 215, 226, 255, 264, 264, 299,
301, 368, 369, 375, 382, 387, 414, 415, 416, 417, 418, 419, 424, 521, 553, 558, 662, 683, 687, 840
, 874, 920, 955, 989, 1023, 1063, 1085, 1086, 1101, 1109, 1116, 1118, 1121, 1133, 1142, 1162, 1163, 1175, 1182,
1182, 1195, 1231, 1248, 1249, 1258, 1331, 1383, 1385, 1447, 1448, 1449, 1453, 1453, 1455, 1456, 1457, 1458, 1461,
p
packages 1219, 1220, 1221, 1222, 1225, 1225, 1232, 1247, 1248, 1252
parameters 316, 563, 571, 671, 737, 847, 921, 1022, 1185, 1235, 1406, 1469, 1470
parent 746
parents 360
partition 184, 197
partitions 89
password 1108, 1999, 2171
patch 480, 485, 489, 489
BMC Atrium Core 9.0
Page 2254 of 2268
Home
patch 9 0 00 001 57
patches 45
path 845, 1433, 1473, 1478
paths 222
pause 958
pausing 962
payroll 1449
people form 1046
performance 201, 244, 701, 701, 702, 941, 1105, 1105, 2203
permissions 90, 197, 198, 199, 317, 347, 350, 384, 389, 390, 392, 393, 399, 402, 402, 404, 405,
407, 411, 424, 528, 686, 704, 763, 884, 892, 899, 946, 1040, 1040, 1046, 2138, 2142
personal 317
phases 153
planning 136, 136, 137, 138, 138, 139, 140, 150, 150, 151, 153, 153, 154, 155, 155, 158, 160, 165,
166, 166, 167, 168, 168, 168, 169, 172, 172, 173, 173, 174, 174, 174, 177, 178, 179, 179, 179, 181
, 182, 184, 190, 191, 192, 193, 193, 197, 198, 199, 200, 201, 201, 201, 202, 203, 205, 205, 206,
207, 207, 208, 210, 212, 212, 213, 213, 213, 215, 216, 218, 219, 222, 222, 223, 255, 844, 845, 845
platform 491
platforms 414, 419, 1246
plugins 141, 387, 692, 697, 1118, 1121, 1122, 1125, 1128, 1131, 1181, 2032, 2039, 2039, 2040, 2103, 2112, 2114,
2117, 2119, 2122, 2125, 2128, 2129, 2131, 2142, 2143, 2143, 2144
polling 1198
populate 436
populating 179, 179, 179, 181, 182, 184, 190, 200, 201
popup 360
port 697, 738
ports 141, 738, 941, 1426, 1444, 2159
ports threads 941
post 1234, 1237
post installation 226, 226, 227, 228
post validation 452
precedence 372, 953, 988, 992, 995, 997, 1023, 1025
precedence association 995, 997
precedence set 995, 997
preferences 1105, 1105
preparation 892
preparing 893, 950, 950
prequisities 1176
prerequisites 150, 205, 222, 305, 310, 347, 350, 366, 377, 384, 438, 909, 924, 938, 951, 1024, 1125,
1159, 1165, 1179
pre upgrade 2100
previewing 924
price 666, 668, 671
BMC Atrium Core 9.0
Page 2255 of 2268
Home
priority 897
private 317
problems in viewing dashboard 264
process 80, 494, 872, 874, 958, 1059, 1163
processes 93, 2091, 2149
process flow 436
product 425, 488, 498, 499, 500, 503, 506, 507
product catalog 72, 74, 85, 198, 201, 201, 203, 205, 414, 415, 416, 417, 418, 419, 420, 421,
422, 424, 425, 425, 426, 427, 429, 436, 438, 442, 443, 445, 454, 461, 470, 475, 476, 476, 479, 484
, 488, 490, 490, 492, 494, 496, 497, 498, 502, 503, 504, 504, 505, 508, 872, 874, 893, 897, 1175,
1176, 1178, 2041, 2086, 2100, 2103
product catalog components 414
product catalog console 499
product catalog data 436, 442, 452, 453
product change notice 65
product entry 479
production 363, 369, 371, 373, 466, 670, 680, 683, 684, 685, 686, 951, 1162, 1163, 1163, 1165, 1165,
1169, 1171, 1173, 1174, 1174, 1175, 1176, 1178, 1179, 1180, 1181
product name 877
products 203, 417, 438, 455, 490, 927, 2136, 2142
program 229
progress 950, 972
progress bar 950, 972
promoting 347, 350, 355, 357, 371, 373, 680
promotion 369, 372
propagation 420, 535, 1382, 1382
propertise 802
providers 1218
pruge 212
pruning 967
public 317
publishing 1196
purge 355, 962, 998, 1013, 1015
purging 685
purpose 77, 201
put 1234, 1241
q
qualification 213, 953, 960, 975, 976, 976, 979, 1001, 1360, 1375, 1435
qualification builder 1069, 1069, 1139
qualifications 978, 1139, 1143
BMC Atrium Core 9.0
Page 2256 of 2268
Home
qualification set 1037

qualification sets 1069, 1069, 1072
qualifier 1004, 1359, 1365, 1365, 1366, 1367, 1367, 1368
qualifierstruct 1359
queries 311, 313, 314, 315, 316, 317, 317, 320, 324, 327, 331, 336, 343, 344, 345, 368, 680, 1331,
1348, 1350, 1351, 1352, 1354, 1359, 1359, 1360, 1361, 1361, 1362, 1363, 1363, 1364, 1364, 1365, 1365, 1366, 1367,
, 1368, 1369, 1370, 1370, 1371, 1372, 1372, 1373, 1385, 1427, 1429, 1433, 1447, 1448, 1449, 1453, 1453, 1455, 1456
1457, 1458, 1461
query 255, 259, 1349, 1473, 1478, 1479
queryarithopstruct 1360
queryattributename 1361
querybypath 1433, 1473, 1478
querycardinality 1361
queryobject 1362
queryobjectlist 1363
queryobjectrelationship 1363
queryobjectselectorlist 1364
queryobjectselectorstruct 1364
queryqualifierandorstruct 1365
queryqualifiersetopstruct 1365
queryqualifiersimpleopstruct 1366
queryqualifiervaluesetstruct 1367
queryqualifiervaluestruct 1368
queryresultgraph 1369
querysortlist 1370
querysortstruct 1370
querystruct 1371
queue 229
queues 1021
quick 308
quick edit 548
r
rampart 1262, 1263
ranking 166
re 387
read 402, 1234, 1235, 1237
real 1333
re best practices 133
recategorize 468
reclassquallist 1375
BMC Atrium Core 9.0
Page 2257 of 2268
Home
reclassqualstruct 1375
recommendations 142, 166, 167, 172, 179, 190, 192, 202, 216, 219, 314, 347, 438, 670, 684, 685,
909, 920, 951, 955, 960, 967, 1021
recommmendations 883
reconcilation 958
reconciliation 75, 85, 184, 205, 206, 207, 207, 208, 210, 212, 212, 213, 298, 355, 369, 372, 373,
393, 683, 684, 685, 686, 945, 946, 947, 947, 948, 949, 950, 950, 951, 952, 955, 955, 955, 958, 958
, 962, 963, 966, 966, 967, 967, 972, 973, 975, 976, 976, 978, 979, 982, 986, 1001, 1001, 1005, 1009,
1012, 1013, 1015, 1020, 1021, 1022, 1023, 1025, 1028, 1028, 1029, 1032, 1180, 1331, 1375, 1375, 1375, 1376, 1376,
, 1385, 1445, 1479, 2004, 2019, 2022, 2025, 2026, 2027, 2065, 2182, 2188, 2188, 2188, 2189, 2190, 2191, 2191, 2192
2193, 2194, 2195, 2198, 2202, 2203, 2209, 2210, 2212, 2217
reconciliation best practices 133
reconciliation engine 1331, 1385, 2188, 2188, 2188, 2189, 2190, 2191, 2191, 2192, 2193, 2194, 2195, 2198, 2202,
2203
reconciliationidentity 949, 978
reconciliationmergestatus 947, 986
recording 1470
records 966, 967
recovery 201
redatasetlist 1375
redatasetpair 1376
redundancy 138, 201, 236, 247, 705, 812, 840, 920, 948, 1122, 1125, 1128, 1275, 2122, 2131, 2151, 2155
reference 47, 275, 280, 286, 289, 311, 317, 376, 420, 424, 425, 519, 520, 521, 542, 550, 563, 571
, 701, 871, 885, 921, 940, 953, 958, 964, 1176, 1231, 1232, 1233, 1246, 1247, 1249, 1250, 1252, 1255, 1255,
1256, 1257, 1264, 1328, 1331, 1333, 1333, 1337, 1337, 1338, 1338, 1338, 1339, 1339, 1340, 1340, 1341, 1341, 1342,
, 1343, 1344, 1344, 1345, 1346, 1346, 1347, 1347, 1347, 1348, 1348, 1349, 1349, 1350, 1350, 1351, 1352, 1352, 1353
1353, 1354, 1354, 1355, 1356, 1356, 1357, 1357, 1358, 1358, 1359, 1359, 1359, 1360, 1361, 1361, 1362, 1363, 1363,
, 1364, 1365, 1365, 1366, 1367, 1367, 1368, 1369, 1370, 1370, 1371, 1372, 1372, 1373, 1373, 1374, 1374, 1374, 1375
1375, 1375, 1376, 1376, 1377, 1377, 1377, 1378, 1380, 1380, 1381, 1381, 1382, 1382, 1382, 1383, 1383, 1385, 1388,
, 1390, 1391, 1391, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403, 1404, 1405, 1405, 1406, 1407, 1408, 1408, 1411
1413, 1414, 1415, 1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426, 1426, 1427, 1429, 1430, 1430, 1431, 1432,
, 1433, 1434, 1435, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445, 1446, 1446, 1447, 1448, 1449, 1453, 1453, 1455
1456, 1457, 1458, 1461, 1469, 1470, 1475, 1477, 1478, 1479, 1479, 1479, 2229
refresh 1189
registered 1324
registering 1131
registration 1155
registry 137, 140, 222, 236, 1258, 1259, 1259, 1264, 1275, 1324
regular 160, 169
rejobruninfo 1376
rejobruninfolist 1377
relation 870
relational algebra 315
BMC Atrium Core 9.0
Page 2258 of 2268
Home
relationship 484, 535, 715, 901, 1341, 1372, 1374, 1374, 1427
relationship ci 2220
relationshipresult 1374
relationshipresultlist 1374
relationships 73, 73, 74, 82, 158, 174, 177, 213, 280, 285, 286, 289, 294, 297, 299, 300, 300,
305, 306, 306, 308, 310, 311, 311, 313, 314, 315, 316, 317, 320, 323, 346, 350, 355, 357, 359, 360
, 362, 368, 476, 520, 523, 529, 554, 563, 564, 565, 566, 568, 571, 574, 680, 708, 713, 715, 746,
753, 882, 883, 905, 918, 1004, 1139, 1331, 1347, 1347, 1351, 1352, 1363, 1429, 1430, 1430, 1453, 1458, 1461, 2179
, 2181, 2182, 2182, 2183, 2183, 2184, 2185, 2185, 2186
release notes 45, 47
remediating 1085, 1093, 1094
remedy user 1051
remote 139
remove 1434
removeclientmanagedtransaction 1434
removing 355, 685, 819
rename 212, 998, 1010
replicate 241
replication 160, 169, 201
report 455, 966, 1017, 1019
reports 307, 363, 366, 1171
repository 692, 1133
requestable offering 215
requestable offerings 666, 668, 670, 678
request action 678
requests 666, 668, 678
requirements 150, 181, 223, 1247, 1248, 1252, 1256
rest api 1234, 1245
restarting 973
restrictions 289
result 1373, 1374
results 301, 950, 964, 1369, 1372, 1374, 1380, 1380
resume 958
resuming 962
retrieval 191, 193, 1116, 1117, 1121, 1132, 1133, 1135, 1181
return value 1388, 1389, 1390, 1391, 1391, 1394, 1396, 1397, 1398, 1400, 1401, 1402, 1403, 1404, 1405, 1405, 1406,
1407, 1408, 1408, 1411, 1413, 1414, 1415, 1416, 1417, 1419, 1421, 1422, 1423, 1424, 1425, 1426, 1426, 1427, 1429,
, 1430, 1431, 1432, 1433, 1433, 1434, 1435, 1436, 1437, 1440, 1440, 1441, 1443, 1444, 1445, 1446, 1446, 1447
review 470
reviewing 2205
rik 2100
risks 153
role 404
BMC Atrium Core 9.0
Page 2259 of 2268
Home
role based 197

roles 393, 399, 424, 704
rollup 870, 878
routines 1256
row level 197, 884, 899
row level access 404
rpc 229, 941, 1426, 1444, 2142, 2143, 2159
rule helper 2158
rules 336, 559, 849, 883, 884, 894, 897, 898, 899, 901, 905, 909, 913, 952, 1023, 1024, 1025, 2176
ruleset 982, 985
rulesets 298
run 964, 1435
running 305, 727, 817, 817, 818, 924
run process 1143
runqualificationforci 1435
s
sacm 77, 77, 77, 79, 80, 153
safe 973
sample code 1243
sample jobs 827
samples 137
sandbox 285, 289, 347, 350, 355, 357, 363, 368, 369, 371, 372, 373
saved 306, 320
scability 200
scans 190
sccm 2177
sccm error 2177
sccm troubleshooting 2177
scenarios 137, 138, 138, 139, 140, 174, 179, 184, 193, 199, 205, 311, 427, 554, 1039, 1072, 1076
schedule 937, 955, 966, 1083
schedules 190, 819, 929, 944, 955, 964, 966, 1179
scheduling 715
script 1473
scripts 1473
search 455, 476, 476, 1086
searches 317
searching 292, 311, 313, 315, 316, 317, 320
security 236, 884, 899
segregation 197
selector 1353, 1353, 1364, 1364
BMC Atrium Core 9.0
Page 2260 of 2268
Home
serer 466
server 138, 139, 229, 249, 692, 699, 948, 1426, 1444, 2029, 2168
server groups 138, 201, 236, 247, 705, 812, 840, 920, 945, 948, 1122, 1125, 1128, 1189, 1275, 2122, 2131,
2151, 2155
servers 201, 973, 1021, 1163, 1256
service 289, 455, 2032, 2032, 2034
service asset and configuration management 153
service catalog 75, 292, 662, 666, 668, 670, 671, 678, 680, 2131, 2139
service context 237, 238, 239, 240, 382, 383, 384, 1199, 1200, 1207, 1218, 1997, 2005, 2076, 2128
service level agreements 178
service level target 215, 671
service model 213, 213, 215, 216, 218, 219, 222, 662, 666, 668, 670, 671, 678, 680, 2131
service model editor 300
service offering 215
service offerings 666, 668, 670, 671, 678
service oriented architecture 90, 90, 236, 1275
services 75, 80, 151, 213, 213, 215, 216, 218, 219, 222, 292, 299, 300, 300, 305, 306, 306, 308,
310, 311, 564, 565, 566, 568, 571, 662, 666, 668, 670, 671, 678, 680, 1324, 2129, 2131, 2153, 2154, 2166
sessions 1433, 1447
set 975, 1365, 1367, 1436, 1437, 1440, 1440, 1441, 1443, 1444
setattribute 1436
setattributes 1441
setclass 1437
setclientmanagedtransaction 1440
setinstance 1440
setmultipleattributes 1441
setmultipleinstances 1443
sets 1001
setserverport 1444
setting 1032, 1189, 1189
settings 420, 566, 568, 571, 686, 848, 849, 850, 851, 852, 921, 944, 953, 1021, 1022, 1028, 1028, 1179
setup 920
shared 317, 387
sharing 381
side 2029, 2030
signature 481, 482
silent 1159, 1999
simple 327
simulating 299, 300, 300, 301, 305, 306, 306, 308, 310, 311, 564, 565, 566, 568, 571, 924
simulation 924
simulations 301, 305, 306, 306, 307, 308
single 138, 208
single instance 1241
BMC Atrium Core 9.0
Page 2261 of 2268
Home
singleton 169
site 433
site alias 433
sites 242, 428
size 942, 2026
sizing 200
slas 178
slm 878, 893
snapshot 1037, 1058, 1105
snapshot job 1052, 1060, 1062
snapshot job wizard 1060
snapshots 1058, 1059
soa 90, 90, 140, 222, 236, 1258, 1259, 1259, 1261, 1262, 1263, 1264, 1275, 1324
soft delete 1015
soft deleted 1015
soft deleted ci 2220
soft deletion 355
software 509, 878, 909
software license management 422
solaris 2168, 2168
solutions 70
sort 1235, 1370, 1370, 1377, 1377
sortlist 1377
sortstruct 1377
source 158, 208, 210, 350, 355, 574, 711, 712, 741
source data 810
source dataset 1037
source records 811
sp1 55, 57, 231, 233, 885, 937, 973, 1229, 2178, 2220, 2227
special 2084
spoon 139, 690, 2093, 2169
sql 1255, 2149, 2155, 2168, 2177
stacks 142
stages 151
staging 442, 443, 445
standard 951, 952, 953, 1023, 1024, 1025
start 1445
starting 267, 273, 290, 291, 292, 294, 298, 950, 955, 958, 958, 973, 1173
startjobrun 1445
startup 2188
statement of direction 65
states 300
statistics 966
BMC Atrium Core 9.0
Page 2262 of 2268
Home
status 420, 438, 483, 512, 542, 871, 885, 940, 950, 964, 1083, 1355
status codes 1235
stdedgeresult 1372
steps 716, 1063
stop 963
stopping 943, 950, 955, 958
storage 160, 174, 174, 174, 177, 178, 179, 179, 181, 182, 184, 190, 200, 201, 480
structure 314, 315
subclasses 982, 1183
subset 811
substituting 960
substitution 193
successes 153
suite 870, 878
suite rollup 909
suites 490, 490, 909
summary 384, 716, 759
support 223, 414, 419, 690
supported 2229
swlm 422, 878
synchmetadata 1446
synchronization 165, 1446, 2140, 2140, 2142
synchronizing 1188
sync ui 2140, 2140, 2142
syntax 563, 863
system 150, 1446
system administrator 1108
systeminit 1446
t
table 301
tables 2158
tagging 1109, 1112
target 711, 712, 741, 1037, 1052, 1067, 1069
targets 1067, 1067
target wizard 1067
task 165, 226, 264, 264, 267, 273, 278, 290, 291, 292, 294, 305, 306, 306, 308, 310, 320, 323, 347
, 350, 355, 357, 359, 360, 362, 363, 366, 368, 371, 373, 377, 381, 384, 387, 438, 523, 528, 529,
541, 542, 543, 545, 547, 548, 549, 559, 563, 568, 666, 668, 670, 671, 678, 680, 684, 685, 686, 702
, 732, 737, 738, 738, 739, 753, 758, 760, 761, 763, 764, 764, 765, 767, 768, 770, 773, 801, 802,
805, 808, 808, 809, 809, 810, 811, 811, 812, 813, 813, 817, 817, 818, 819, 821, 822, 823, 824, 825
BMC Atrium Core 9.0
Page 2263 of 2268
Home
, 826, 826, 827, 829, 831, 832, 833, 834, 853, 856, 857, 858, 893, 894, 897, 898, 899, 901, 905,
909, 913, 918, 920, 923, 924, 927, 929, 938, 941, 942, 943, 943, 944, 951, 955, 955, 958, 967, 967
, 969, 972, 1024, 1025, 1028, 1028, 1032, 1117, 1122, 1125, 1128, 1131, 1132, 1135, 1139, 1143, 1148, 1149, 1154,
1154, 1155, 1158, 1159, 1161, 1165, 1173, 1174, 1174, 1176, 1179, 1180, 1185, 1185, 1188, 1189, 1189, 1190, 1191,
, 1198, 1219, 1220, 1221, 1222, 1225, 1225, 1324, 1467, 2022
tasks 941
tcp 1426, 1444
technical 215, 219, 289, 670, 671, 678, 680
technical bulletins 47
template 743, 2209
templates 760
termination 1447
terminologies 862
terminology 692
testing 331, 737
test treedump 1324
thread 2203
threads 941, 1021, 1470
thresholds 549
timers 1470
time window 1107
tokenid 950
tomcat 141, 237
tool 1997, 2089
toolbar 317
toolbars 267, 273, 275, 278, 280, 285, 290, 295, 317
tooltip 547
topology 301, 375, 377
transaction 1385, 1390, 1405
transactions 1405, 1434, 1440
transfer 244, 245, 245, 246, 247, 248, 249, 250, 712, 713, 753, 758, 759, 761, 764, 765, 767, 768,
770, 773, 801, 802, 805, 808, 808, 809, 809, 810, 811, 811, 813, 813, 825, 826, 826, 827, 829, 831
, 832, 833
transformation 692
transformations 700, 716, 716, 723, 724, 725, 727, 728, 729, 739, 739, 741, 743, 746, 761, 764,
765, 767, 768, 770, 773, 801, 802, 805, 808, 808, 809, 809, 810, 811, 811, 813, 817, 817, 818, 821
, 822, 823, 824, 825, 826, 826, 827, 829, 831, 832, 833, 841, 842, 844, 845, 845, 847, 847, 848,
849, 850, 851, 852, 853, 856, 857, 858, 862, 862, 863, 2093, 2093, 2096, 2097
trigger 958, 1226
troubleshooting 856, 1996, 1997, 1999, 2000, 2003, 2004, 2005, 2006, 2007, 2010, 2011, 2012, 2019, 2020, 2021,
2022, 2022, 2025, 2026, 2027, 2027, 2029, 2029, 2030, 2031, 2032, 2032, 2034, 2036, 2039, 2040, 2041, 2045, 2047,
, 2073, 2076, 2078, 2080, 2081, 2082, 2084, 2084, 2084, 2084, 2084, 2085, 2085, 2085, 2086, 2087, 2088, 2089, 2089
2089, 2091, 2091, 2091, 2092, 2093, 2093, 2096, 2097, 2098, 2100, 2102, 2102, 2102, 2103, 2103, 2104, 2104, 2108,
BMC Atrium Core 9.0
Page 2264 of 2268
Home
, 2109, 2110, 2111, 2112, 2114, 2117, 2119, 2122, 2125, 2128, 2129, 2131, 2135, 2136, 2136, 2136, 2138, 2139, 2140
2140, 2142, 2142, 2142, 2142, 2143, 2143, 2144, 2145, 2145, 2147, 2147, 2149, 2151, 2151, 2152, 2153, 2154, 2154,
, 2155, 2158, 2159, 2159, 2160, 2160, 2161, 2162, 2162, 2164, 2165, 2166, 2166, 2166, 2167, 2167, 2167, 2168, 2168
2168, 2169, 2170, 2170, 2171, 2171, 2171, 2171, 2172, 2174, 2176, 2176, 2176, 2177, 2178, 2178, 2179, 2181, 2182,
, 2183, 2183, 2184, 2185, 2185, 2186, 2187, 2188, 2188, 2188, 2189, 2190, 2191, 2191, 2192, 2193, 2194, 2195, 2198
2202, 2203, 2205, 2208, 2209, 2210, 2212, 2214, 2217
two way 250
types 1079
u
uddi 90, 137, 140, 222, 236, 1233, 1258, 1259, 1259, 1264, 1275, 1324
ui 267, 273, 275, 278, 280, 285, 286, 290, 295, 301, 1331, 1378, 1380, 1380, 1385, 1422
uicomponentinfo 1378
uicomponentresult 1380
uicomponentresultlist 1380
unidentified ci 2220
unified 2032
unified service modeling 2129
uninstallation 2000, 2080, 2085, 2089, 2089
unix 1185, 1324, 2084, 2085, 2085, 2154, 2155, 2168, 2168
unknown 182, 877
unqualified 182
unresponsive 973
unsupported 1275
update 431, 1234, 1235
updates 45
updating 237, 243, 812
upgrade 150, 222, 223, 253, 2007, 2091, 2091, 2091, 2092, 2093, 2093, 2096, 2097, 2098, 2100, 2102, 2160
upgrading 834
url 1143, 1149
use case 889, 1245
use cases 554
user 390, 399, 1046
user access 411
user form 1046
users 93
user scenarios 383, 399, 421, 690, 707, 708, 711, 712, 712, 713, 713, 714, 715, 715, 716, 716,
716, 723, 724, 725, 727, 728, 729, 858, 878, 889, 890, 921, 929, 1128
uses 952
using 381, 975, 1049, 1149, 2208
using classes 1072
BMC Atrium Core 9.0
Page 2265 of 2268
Home
usm 2129
utility 553, 554, 559, 563, 924, 1385
v
validate 452
validation 452, 461
value 70, 689
values 1338, 1338, 1338, 1339, 1340, 1367, 1368
verification 1161
verifying 227, 729, 1135, 1139
version 485, 487, 508, 509, 511, 878
version 9 0 00 39, 57, 65, 2229
versioninfo 1381
versioninfolist 1381
version rollup 894, 897, 898
versions 893, 1256, 1381, 1381, 1426, 2136, 2229
video 57
videos 39, 94, 121, 122, 132, 133, 154, 260, 634, 761, 773, 842, 853, 1034, 2160
view 375, 476, 476
view dashboard 264
viewing 323, 362, 366, 716, 822, 823, 824, 857, 924, 966, 1019, 1052, 1083, 1085, 1086, 1088, 1101, 1102
views 280, 301, 368, 369, 371, 378, 379, 1183, 1185, 2158
virtual 362
virtualization 90
virtual machines 90
visualization 2136
vms 90
w
war 1259
weak 158, 535, 574, 1382, 1382, 2185, 2186
weakpropagateattrslist 1382
weakpropagatedattrs 1382
web services 90, 90, 137, 140, 222, 235, 235, 236, 236, 237, 826, 1231, 1233, 1249, 1250, 1258, 1259,
1259, 1261, 1262, 1263, 1264, 1275, 1324, 2019, 2027, 2029, 2085, 2085, 2087
web services registry 90, 236
what's new 39
widget 2108, 2108
widgets 255, 255, 257, 2110, 2111
windows 1185, 1324, 2085, 2168, 2168, 2168
BMC Atrium Core 9.0
Page 2266 of 2268
Home
wizard 1060, 1064, 1067

workarounds 47
workflow 958, 1001, 1002, 1039
workflows 165, 207
write 402
wsdl 1233
wss4j 1263
x
xml 1165, 1169, 1221, 1382, 1383, 2166, 2167, 2168, 2176
xml data 831
xmlexportitemlist 1382
xmlimportitemlist 1383
z
zipper 1997, 1999, 2000, 2089
BMC Atrium Core 9.0
Page 2267 of 2268
Home
Copyright 2005 - 2007, 2009 - 2015 BMC Software, Inc.

Copyright 2011 - 2015 BladeLogic, Inc.
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S.
Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service
marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered
trademarks are the property of their respective owners.
BladeLogic and the BladeLogic logo are the exclusive properties of BladeLogic, Inc. The BladeLogic trademark is registered with the
U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BladeLogic trademarks,
service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or
registered trademarks are the property of their respective owners.
AIX, DB2 and IBM are trademarks or registered trademarks of International Business Machines Corporation in the United States,
other countries, or both.
IT Infrastructure Library is a registered trade mark of AXELOS Limited.
ITIL is a registered trade mark of AXELOS Limited.
Linux is the registered trademark of Linus Torvalds.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
SAP is the trademark of SAP AG in Germany and in several other countries.
UNIX is the registered trademark of The Open Group in the US and other countries.
The information included in this documentation is the proprietary and confidential information of BMC Software, Inc., its affiliates, or
licensors. Your use of this information is subject to the terms and conditions of the applicable End User License agreement for the
product and to the proprietary and restricted rights notices included in the product documentation.
BMC Software Inc.
2101 CityWest Blvd, Houston TX 77042-2827, USA
713 918 8800
Customer Support: 800 537 1813 or contact your local support center
BMC Atrium Core 9.0
Page 2268 of 2268

BMC Atrium Core 9.0.01

Uploaded by

Document Information

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

BMC Atrium Core 9.0.01

Uploaded by

Copyright:

Available Formats

BMC Software Confidential. BladeLogic Confidential.