bmc atrium cmdb 2.1.00 installation and configuration guide · the bmc atrium cmdb 2.1.00...

234
www.bmc.com BMC Atrium CMDB 2.1.00 Installation and Configuration Guide August 2007

Upload: duongtuyen

Post on 24-Jul-2018

271 views

Category:

Documents


4 download

TRANSCRIPT

Page 1: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

www.bmc.com

BMC Atrium CMDB 2.1.00

Installation and Configuration Guide

August 2007

Page 2: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

If you have comments or suggestions about this documentation, contact Information Development by email at [email protected].

Contacting BMC Software

You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.

United States and Canada

Address BMC SOFTWARE INC2101 CITYWEST BLVDHOUSTON TX 77042-2827 USA

Telephone 713 918 8800 or800 841 2031

Fax 713 918 8000

Outside United States and Canada

Telephone (01) 713 918 8800 Fax (01) 713 918 8000

© Copyright 2005–2007 BMC Software, 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.

DB2 is a registered trademark of International Business Machines Corporation.

IBM is a registered trademark of International Business Machines Corporation.

ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX is a registered trademark of The Open Group.

BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.

Restricted Rights Legend

U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.

Page 3: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Customer Support

You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer Support by telephone or email. To expedite your inquiry, please see “Before Contacting BMC Software.”

Support Website

You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this website, you can

■ Read overviews about support services and programs that BMC Software offers.■ Find the most current information about BMC Software products.■ Search a database for problems similar to yours and possible solutions.■ Order or download product documentation.■ Report a problem or ask a question.■ Subscribe to receive email notices when new product versions are released.■ Find worldwide BMC Software support center locations and contact information, including email addresses, fax

numbers, and telephone numbers.

Support by telephone or e-mail

In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813 or send an email message to [email protected]. (In the Subject line, enter SupID:<yourSupportContractID>, such as SupID:12345.) Outside the United States and Canada, contact your local support center for assistance.

Before Contacting BMC Software

Have the following information available so that Customer Support can begin working on your issue immediately:

■ Product information

— Product name— Product version (release number)— License number and password (trial or permanent)

■ Operating system and environment information

— Machine type— Operating system type, version, and service pack— System hardware configuration— Serial numbers— Related software (database, application, and communication) including type, version, and service pack or

maintenance level

■ Sequence of events leading to the problem

■ Commands and options that you used

■ Messages received (and the time and date that you received them)

— Product error messages— Messages from the operating system, such as file system full— Messages from related software

Page 4: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation
Page 5: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Contents

Preface 9

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Best Practice and New icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9BMC Atrium CMDB documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 1 Installing BMC Atrium CMDB 15

System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16License requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Compatibility information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Tuning your system before installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Upgrading from previous versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

From version 2.0 or later. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18From version 1.1 patch 002. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Upgrading the BMC Atrium CMDB Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Improving upgrade performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Recommended available virtual memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Improving performance in a Sybase environment . . . . . . . . . . . . . . . . . . . . . . . . . . 23Prerequisites for upgrading to DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Upgrading memory limit in an HP-UX environment . . . . . . . . . . . . . . . . . . . . . . . 24Shutting down AR System applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Tuning upgrades in an Oracle environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Viewing the results of an upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Installing on an AR System server group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Installing and uninstalling on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Installing BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Installing Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Uninstalling from Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Installing and uninstalling on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Installing BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Enabling full installation on AIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Installing Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Uninstalling from UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Moving your installation to a different location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Moving a Windows installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Moving a UNIX installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Enabling the CI Distribution graph for BMC Remedy User clients . . . . . . . . . . . . . . . 49

Contents 5

Page 6: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Deploying optional web services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Deployment requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Deploying web service applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Accessing web services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

The extension loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Accessing the CMDB Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapter 2 Managing permissions 55

Defining users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Application roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Class and attribute permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Class permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Attribute permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Instance permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Default instance permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 3 Modifying the data model 63

The Class Manager tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Viewing or modifying a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Deleting a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Navigating class hierarchies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Creating a CI class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Creating a relationship class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Setting data storage and custom properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Working with attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Creating an attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Viewing, modifying, and deleting attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Setting class permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Working with indexes on the class form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Creating an index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Working with locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Propagating attributes for weak relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Defining icons and tooltips for a class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Tooltips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Change Pending entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Viewing Class Manager error messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Manually synchronizing metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Creating Data Model Help with cdm2html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Running with a Java command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Running with the cdm2html.bat file on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 91

6 Installation and Configuration Guide

Page 7: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter 4 Configuring federated data 93

The Federation Manager tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Creating a federated product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Creating a federated interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Linking a class or CI to a federated interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Chapter 5 Reconciling data 103

The Reconciliation Manager tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Reconciliation quick start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Default reconciliation definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

BMC Sample - Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113BMC Asset - Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113BMC Sample - Identification and Merge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Identifying data across datasets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Creating an Identification group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Creating an Identification activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Manually identifying data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Merging datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Independent Merge activities and AttributeDataSourceList . . . . . . . . . . . . . . . . 123Handling NULL values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Creating a Precedence group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Creating a Dataset Merge Precedence set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Creating a Merge activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Comparing datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Creating a Comparison activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Executing workflow against compared instances . . . . . . . . . . . . . . . . . . . . . . . . . 137

Creating datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Copying datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Renaming datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Deleting data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Purging soft-deleted data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Working with jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Creating a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Starting a job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Canceling jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Viewing job status, results, and history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Creating Qualification groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164The Advanced Qualification Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Using namespaces in reconciliation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Dynamic dataset and qualification values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

Substituting datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Substituting qualifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Server settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Modifying the server configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Configuring threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Exporting definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Contents 7

Page 8: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter 6 Other administrative tasks 175

Notification of BMC Atrium CMDB events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Publishing an event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Polling for instances of an event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Configuring the CI Relationship Viewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Restricting which relationships are displayed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Defining visual characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Controlling the layout of class forms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Forms in BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187Forms in BMC Remedy IT Service Management applications . . . . . . . . . . . . . . . 189Generating forms for other applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Setting the cache refresh interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Creating CMDB status alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Chapter 7 Logging BMC Atrium CMDB activity 195

Class Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Viewing the Synchronization Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Logging to a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

CI Relationship Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Reconciliation Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Auditing instance history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Appendix A CDM 1.1 class destinations 203

CI classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Relationship classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Glossary 215

Index 223

8 Installation and Configuration Guide

Page 9: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Preface

The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide describes how to install and configure the BMC Atrium Configuration Management Database (CMDB) application to manage data about your IT environment.

AudienceThis guide is intended for configuration managers, application administrators, asset analysts, and related IT professionals.

Best Practice and New iconsDocumentation for the BMC Atrium CMDB contains two icons:

Icon Description

The New icon identifies features or products that are new or enhanced with version 2.1.00

The Best Practice icon highlights processes or approaches that BMC has identified as the most effective way to leverage certain features in the application.

Preface � 9

Page 10: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

BMC Atrium CMDB documentationThe following table lists the documentation available for BMC Atrium CMDB.

Unless otherwise noted, softcopy documentation is available in the Docs directory of the product DVD and the Support site at http://www.bmc.com/support_home.

Title Document provides Audience Format

Common Data Model Diagram

Hierarchical diagram of all classes in the Common Data Model (CDM) including unique attributes and applicable relationships.

Administrators Print and PDF

Concepts and Best Practices Guide

Information about CMDB concepts and best practices for planning your BMC Atrium CMDB implementation.

IT leaders and administrators

Print and PDF

Data Model Help Description and details of superclasses, subclasses, attributes, and relationship classes for each class. Contains only information about the Common Data Model at first, but can be updated to include information about data model extensions you install.

Administrators HTML (product DVD only)

Developer’s Reference Guide

Information about creating API programs, using C and web services API functions and data structures, and a list of error messages.

Administrators and programmers

Print and PDF

Installation and Configuration Guide

Information about installing and configuring BMC Atrium CMDB, including permissions, class definitions, reconciliation, and federation.

Administrators Print and PDF

Javadoc API Help Information about Java classes, methods, and variables that integrate with BMC Atrium CMDB.

Programmers HTML (product DVD only)

Mapping Your Data to BMC Atrium CMDB Classes

Mappings of common IT objects to the appropriate class in which to store them, whether part of the Common Data Model or an extension. Also includes information about further categorizing instances using key attributes.

Administrators Spreadsheet, print and PDF

Master Index Combined index of all guides Everyone Print and PDF

Online Help Help for using and configuring BMC Atrium CMDB, available by clicking Help in the product interface.

Users and administrators

Product Help (available from Help links once installed)

Release Notes Information about new features, open issues, and resolved issues.

Everyone Print and PDF

10 Installation and Configuration Guide

Page 11: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB documentation

Troubleshooting Guide Information about resolving issues with BMC Atrium CMDB components, including API, filter, and console error messages and their solutions.

Administrators, programmers, and BMC Support personnel

Print and PDF

User’s Guide Information about using BMC Atrium CMDB, including searching for and comparing CIs and relationships, relating CIs, viewing history, and launching federated data.

Users Print and PDF

Title Document provides Audience Format

Preface � 11

Page 12: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Related documentationThe following table lists some documentation for related BMC products that might be of interest to BMC Atrium CMDB users. This documentation is available from the Support site at http://www.bmc.com/support_home.

Title Document provides Audience Format

BMC Atrium Integration Engine 7.1.00 User’s Guide

Information about how to establish a data transfer between third-party databases and BMC Atrium CMDB.

Administrators and developers

Print and PDF

BMC Configuration Management Configuration Discovery Integration for CMDB 7.1 Implementation Guide

Information about the following:� Transferring configuration data from BMC

Configuration Management to BMC Atrium CMDB

� Normalizing discovered software configuration data with the BMC Definitive Software Library before transferring it to BMC Atrium CMDB.

Administrators and developers

Print and PDF

BMC Foundation Discovery and BMC Topology Discovery Installation and Configuration Guide

Information about the configuration of a connection between BMC Atrium CMDB and the discovery data store from BMC Foundation Discovery and BMC Topology Discovery.

Administrators and developers

Print and PDF

BMC Foundation Discovery and BMC Topology Discovery User Guide

Information about the synchronization of the topology datastore with BMC Atrium CMDB.

Administrators and developers

Print and PDF

BMC Remedy Action Request System 7.1.00: C API Reference

Information about AR System data structures, C API function calls, and OLE support.

Administrators and programmers

Print and PDF

BMC Remedy Action Request System 7.1.00: Configuring

Information about configuring AR System servers and clients, localizing, importing and exporting data, and archiving data.

Administrators Print and PDF

BMC Remedy Action Request System 7.1.00: Form and Application Objects

Information about components necessary to build applications in AR System, including applications, fields, forms, and views.

Developers Print and PDF

BMC Remedy Action Request System 7.1.00: Installing

Procedures for installing AR System. Administrators Print and PDF

BMC Remedy Action Request System 7.1.00: Installing and Administering BMC Remedy Mid Tier

Information about the mid tier, including mid tier installation and configuration, and web server configuration.

Administrators Print and PDF

12 Installation and Configuration Guide

Page 13: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Related documentation

BMC Remedy Action Request System 7.1.00: Integrating with Plug-ins and Third-Party Products

Information about integrating AR System with external systems using plug-ins and other products, including LDAP, OLE, and ARDBC.

Administrators and developers

Print and PDF

Definitive Software Library 7.1 Administrator’s Guide

Information about installing and configuring DSL, updating vendor data, and connecting DSL to BMC Configuration Management and AR System databases.

Administrators Print and PDF

Title Document provides Audience Format

Preface � 13

Page 14: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

14 Installation and Configuration Guide

Page 15: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

1

Installing BMC Atrium CMDB

NOTE Before starting the installation procedure, see the Release Notes and latest technical bulletins for the latest installation issues and compatibility information, available at http://www.bmc.com/support_home.

This section explains how to install and uninstall BMC Atrium CMDB. It also includes instructions for installing the Help system, which must be done separately.

NOTE The CI Relationship Viewer component, which previously had to be installed separately, is now installed along with BMC Atrium CMDB.

If you obtained BMC Atrium CMDB by purchasing another BMC product, you must install BMC Atrium CMDB before installing that product. If you are not sure whether your product requires BMC Atrium CMDB, see the installation prerequisites in the documentation for that product.

The following topics are provided:

� System requirements (page 16)� License requirements (page 16)� Compatibility information (page 17)� Tuning your system before installing (page 17)� Upgrading from previous versions (page 18)� Improving upgrade performance (page 23)� Installing on an AR System server group (page 27)� Installing and uninstalling on Windows (page 28)� Installing and uninstalling on UNIX (page 41)� Moving your installation to a different location (page 48)� Enabling the CI Distribution graph for BMC Remedy User clients (page 49)� Deploying optional web services (page 50)

Chapter 1 Installing BMC Atrium CMDB 15

Page 16: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� The extension loader (page 52)� Accessing the CMDB Console (page 53)

System requirementsBefore installing BMC Atrium CMDB version 2.1.00, make sure your system meets the requirements in the following list, as well as any applicable requirements in the compatibility matrices in the Product Availability and Compatibility pages of the Customer Support website at: http://www.bmc.com/support_home.

� BMC Remedy Action Request System (AR System) 7.1.00 server with:

� The latest patch installed

For information about the latest recommended patch, see the BMC Atrium CMDB technical bulletins posted at http://www.bmc.com/support_home.

� Multi-server license

� User licenses if there are more than three users

For more information about licensing, see Action Request System 7.1.00: Configuring.

� BMC Remedy Administrator 7.1.00 and BMC Remedy User 7.1.00

� BMC Remedy Mid Tier 7.1.00 (for the CI Relationship Viewer)

� Java Runtime (J2SE) version 1.5.0_06 or higher, if you plan to use the Java API or web services API

NOTE The core functionality of BMC Atrium CMDB does not require J2SE.

� Internet Explorer version 6 or higher, to launch the CI Relationship Viewer from the web.

License requirementsIf not already present, the BMC Atrium CMDB installer automatically generates the BMC:Atrium CMDB Application license that the product requires on the AR System server. BMC Atrium CMDB also requires an AR System server with a multi-server license.

For information about adding licenses to an AR System server, see Action Request System 7.1.00: Configuring.

16 Installation and Configuration Guide

Page 17: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Compatibility information

Compatibility informationFor information about compatibility with other BMC Software products, see the Release Notes.

Tuning your system before installingBMC Software has found that setting the Next Request ID Block Size parameter to 10 improves performance when creating entries on an AR System server configured for multithreading. This includes creating instances in BMC Atrium CMDB, such as during bulk data load from a discovery application or a reconciliation Merge or Copy Dataset activity.

WARNING If you have custom workflow that depends on consecutive request IDs, a Next Request ID Block Size greater than 1 causes inconsistent results.

� To increase the Next Request ID Block Size

1 Using BMC Remedy User, navigate to File > Open > Object List.

The Object List window appears.

2 On the Find tab, search for the AR System Administration: Server Information form, and click Find.

The list is populated with available forms.

3 Select AR System Administration: Server Information, and click Search.

The Server Information window appears.

4 Enter the server name alias, and click Apply to retreive the server information.

5 Click the Configuration tab.

6 In the Next Request ID Block Size field, type 10.

7 Click OK.

Chapter 1 Installing BMC Atrium CMDB 17

Page 18: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Upgrading from previous versionsThis section explains how to upgrade from a previous version of BMC Atrium CMDB to version 2.1.00 and what happens when you do so from version 1.1 patch 002.

WARNING If you choose a new installation directory when you upgrade, you must remove the CMDB libraries in the PATH. To do this, you can remove the mid-tier location and the old CMDB installation directory location from the PATH.

� To upgrade BMC Atrium CMDB

1 Run the version 2.1.00 installer.

If the installer detects an older version on the system, it prompts you to indicate whether you want to proceed with the upgrade. For more information, see step 10 of “To install BMC Atrium CMDB on Windows” on page 28 or step 15 of “To install BMC Atrium CMDB on UNIX” on page 41.

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.

For information about this, see “Viewing the results of an upgrade” on page 26.

3 Upgrade your permissions assignments to fit the new permissions model.

For information about this, see “Upgrading permissions” on page 22.

From version 2.0 or laterYou can upgrade from BMC Atrium CMDB 2.0 or 2.0.1, with or without patches, to version 2.1.00.

WARNING Before upgrading a version 2.0 or 2.0.1 installation, navigate to the WEB-INF\lib directory of the BMC Remedy Mid Tier computer where you have installed the CI Relationship Viewer and delete the cmdbeng20.dll and cmdbsvr20.dll files. Otherwise, the upgrade will fail.

From version 1.1 patch 002This section explains the considerations when upgrading from BMC Atrium CMDB 1.1 patch 002 (BMC Atrium CMDB 1.1.00.002). It includes general information about how the data model is modified and what happens to your existing data. For detailed information about specific classes, see Appendix A, “CDM 1.1 class destinations.”

18 Installation and Configuration Guide

Page 19: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Upgrading from previous versions

NOTE Version 1.1.00.002 is the earliest version from which you can upgrade directly to version 2.1.00. If you have an earlier version of BMC Atrium CMDB, you must first upgrade it to 1.1.00.002 and then upgrade to 2.1.00.

For information about upgrading from version 1.0 to version 1.1, see the BMC Atrium CMDB 1.1 Installation and Configuration Guide.

For information about applying Patch 002 to version 1.1, see the BMC Atrium CMDB 1.1 Patch 002 Release Notes.

NOTE BMC Atrium CMDB 1.1 API clients cannot work with a version 2.1 server. For information about API compatibility, see the Developer’s Reference Guide.

Data model changesUpgrading from BMC Atrium CMDB 1.1 to version 2.1.00 involves a significant change to the Common Data Model. Many classes, particularly relationship classes, in version 1.1 of the CDM were removed in version 2.0 and a few new classes have been added.

Some classes, though removed from the CDM, are still used by other BMC Software products such as BMC Remedy Asset Management, BMC Foundation Discovery and BMC Topology Discovery, and BMC Impact Solutions. These classes are now considered extensions to the data model. They are installed by the product that uses them, and are stored in a namespace specific to that product.

In addition, some classes are moving within the hierarchy to inherit directly from a different superclass than before.

Migration of existing class and instance dataAs a result of the changes to the CDM in version 2.0, some classes and instances in your BMC Atrium CMDB must be migrated to the new data model. This section explains how different types of classes and their instances are treated in the upgrade. For detailed information about specific classes, see Appendix A, “CDM 1.1 class destinations.”

In some cases specified in this section, instances are promoted from their original class to a superclass. In such cases, the superclass to which instances are promoted receives a new attribute named BMC_PromotedClassID that holds the former class ID for all promoted instances so that you can search on those former IDs.

NOTE Whenever the upgrade installer modifies a CI class in any way, relationship instances in which those CIs are members are also modified to maintain the integrity of the relationships.

Chapter 1 Installing BMC Atrium CMDB 19

Page 20: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Classes that remain in the CDM

These classes are moved from the BMC namespace to BMC.CORE. Most of their attributes are also placed in BMC.CORE, but attributes that become extensions are placed in a different namespace or left without a namespace. Some classes are also renamed. No change to their instances is necessary.

WARNING If you have created any attributes on a relationship class, they are removed.

CI classes that are no longer used by BMC Software

These are 1.1 CI classes that are not part of the CDM or any extension owned by BMC in version 2.1.00. Instances of these classes, along with any attributes you added, are promoted to the nearest superclass that remains in the CDM and then the classes are deleted. Promoted attributes are not tagged with a namespace and are considered a custom extension.

If you have created a subclass of one of these classes, it is promoted to inherit directly from the superclass of the deleted class.

Exceptions to this rule are BMC_Site, BMC_Region, BMC_City, BMC_Geography, BMC_SLAConfiguration, and BMC_AggregateSLAMeasurement. These classes are deleted if they contain no instances and have no subclasses. Otherwise, the classes and any subclasses are left untouched and considered custom extensions.

Relationship classes that are no longer used by BMC Software

These are 1.1 relationship classes that are not part of the CDM or any extension owned by BMC in version 2.1.00. These classes, and any subclasses of them you have created, are left untouched and considered custom extensions.

Classes and attributes that become product-specific extensions

These are classes and attributes that are no longer part of the CDM in version 2.1.00, but are still used by some BMC Software products. The classes are retained with their original names and attributes, but moved to a namespace specific to the product and purpose that now owns them. When that product is later installed, it migrates the class to its 2.1.00 version, which might have different attributes than in version 1.1.

Classes you have created

These classes are left untouched and considered custom extensions, except when they are subclasses of a CI class that is no longer used by BMC Software. For more information, see “CI classes that are no longer used by BMC Software”

Classes that move within the hierarchy

These are classes that inherit directly from a different superclass in version 2.1.00 than they did in version 1.1. Instances and subclasses of these classes are migrated to the new location, and the classes are deleted from their old location.

20 Installation and Configuration Guide

Page 21: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Upgrading from previous versions

Upgrading reconciliation definitionsThe upgrade installer makes these changes to your BMC Atrium CMDB 1.1 reconciliation definitions to convert them to the new structure introduced in version 2.0.

� Because the namespace for classes in the Common Data Model (CDM) has changed from BMC to BMC.CORE and because some other classes have changed namespaces due to being removed from the CDM, namespaces associated with reconciliation definitions change as follows:

� The namespace associated with each Identification group changes, if necessary, to match the namespace of the class associated with the group (the class in the Class Name field).

� If any other type of group or any reconciliation activity has the BMC namespace associated with it, the following namespaces are added to the association: BMC.CORE, BMC.AM, BMC.SIM, BMC.APPLICATION, and BMC.SAP.

� If any reconciliation definition references a class or attribute that has been renamed, that definition is updated to reference the new name.

� The value of the Skip Auto-Identify of Master option for each Identification activity is reversed. That is because the option has been renamed to Auto-Identify Master Dataset, reversing its meaning from previous versions.

� An error message is logged as described in “Viewing the results of an upgrade” on page 26 when a class or attribute that has been removed from the CDM is found:

� As the Class Name or Attribute Name in an Identification, Exclusion, or Workflow Execution rule.

� In a qualification in an Identification rule, a Qualification group, or a Workflow Execution rule.

� A Dataset Merge Precedence set is created for each Merge activity, storing the same mappings of datasets to Precedence groups that were stored in the Merge activity itself in version 1.1. Each mapping is assigned an Order value that matches the order in which it appeared in the Merge activity. The Dataset Merge Precedence set takes the same name as the activity and is associated with it.

For more information about Dataset Merge Precedence sets, which were introduced in version 2.0, see “To merge datasets” on page 124.

Chapter 1 Installing BMC Atrium CMDB 21

Page 22: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Upgrading permissionsDue to the redesigned permissions model introduced in version 2.0, the permissions you assigned with BMC Atrium CMDB 1.1 cannot be upgraded. You must manually modify your existing users’ permissions:

� Class and attribute permissions—All class and attribute permissions are removed during the upgrade and replaced with defaults. This includes both BMC-provided groups, such as APP-Administrator and APP-Management, and user-defined groups. You must manually establish class permissions for any needed groups.

You should establish class permissions by giving your users one or more of the application roles provided with the BMC Atrium CMDB, which are described in “Application roles” on page 56. In cases where one class requires different permissions from the rest, add or remove permissions for that class as described in “Setting class permissions” on page 79.

� Instance permissions—Changes exist to all three attributes that controlled instance permissions in BMC Atrium CMDB 1.1. For more information, see “Application roles” on page 56 and “Instance permissions” on page 59.

� The ReadSecurity attribute no longer controls read access, and ReadSecurity values in your data are ignored. You must use one of the CMDB Data application roles to grant read access.

� The WriteSecurity attribute has been renamed CMDBWriteSecurity, and now acts in conjunction with application roles to control write access to specific instances. To maintain write access to an instance in version 2.0 for users or groups listed in the WriteSecurity attribute in version 1.1, you must assign them one of the CMDB Data View roles.

� The RowLevelSecurity attribute has been renamed CMDBRowLevelSecurity, and still controls row-level security to specific instances in a multitenancy environment. No action on this attribute is necessary.

Upgrading the BMC Atrium CMDB HelpTo upgrade the BMC Atrium CMDB Help from version 2.0 to 2.0.1, run the 2.0.1 Help installer. For more information about installing the Help, see “Installing Help” on page 32.

22 Installation and Configuration Guide

Page 23: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Improving upgrade performance

Improving upgrade performanceThis section offers best practices that will decrease the amount of time needed to run the installer for an upgrade.

Recommended available virtual memoryIf you are upgrading both the BMC Atrium CMDB and the ITSM suite of applications, BMC Software has found that having 4 GB of virtual memory available, as opposed to installed, provides the system with enough resources to process the upgrade at peak efficiency. However, if you are upgrading only BMC Atrium CMDB, then 2 GB of available virtual memory is sufficient.

NOTE In some cases, this exceeds the amount of available memory described by the AR System installation guide, BMC Remedy Action Request System 7.1.00: Installing.

Improving performance in a Sybase environmentFor Sybase, you can change your database options so that when you turn on the trunc log on chkpt, the transaction log is truncated if 50 or more rows are written to the log. The log is not truncated if less than 50 rows were written to the log.

If you leave this option turned off and never dump the transaction log, it continues to grow and you may run out of space in your database.

BMC recommends running this command to check the database transaction log:

isql>sp_dboption ARSystem, "trunc log on chkpt", true

Prerequisites for upgrading to DB2Before you upgrade to DB2, you must complete the following steps.

1 Log into DB2, and connect to your AR System database.

2 Create a buffer pool and use it for a temporary tablespace with a page size of 32k.

NOTE If you receive errors during the upgrade, you may need to increase the number of pages.

Chapter 1 Installing BMC Atrium CMDB 23

Page 24: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

3 Update the following DB2 configurations to the these values:

(CATALOGCACHE_SZ) = 1024(UTIL_HEAP_SZ) = 95000(APP_CTL_HEAP_SZ) = 40480(STMTHEAP) = 180000(LOGFILSIZ) = 4000(LOGPRIMARY) = 20(LOGSECOND) = 10(LOGBUFSZ) = 256

4 Use the get db cfg command to verify that all of the database configurations have been updated.

TIP BMC recommends that after you complete these steps, you should back up your database.

NOTE BMC has tested these settings with our systems, but this does not ensure these settings are optimal from a performance perspective.

Upgrading memory limit in an HP-UX environmentBefore you start an upgrade on HP-UX, you should review the currently running processes to see if the AR System server process, arserverd, is close to reaching the per process memory limit. The default per process limit on HP-UX is 2 GB. If the memory limit is close, then use the following procedure to increase its memory limit from 2 GB to 3 GB or to 4 GB.

NOTE If you are upgrading CMDB on HPUX, BMC recommends setting these environment variables for malloc() tuning:_M_ARENA_OPTS=16:8_M_SBA_OPTS=512:100:16export _M_ARENA_OPTS _M_SBA_OPTS

� To increase memory limit:

1 Do either of the following:

� Enter the following command to enable usage up to 3 GB:

chatr +q3p enable arserverd

� Enter the following command to enable usage up to 4 GB:

chatr +q4p enable arserverd

The chatr command changes the internal attributes and is used to modify the data page size for a specific executable.

24 Installation and Configuration Guide

Page 25: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Improving upgrade performance

2 Enter the following command to configure your file system for large files:

fsadm -F vxfs/dl large files

TIP To determine if a file system is configured for large files, use this command:usr/sbin/fsadm -F vxfs <mount-point>The output displays as either largefiles or nolargefiles.

3 Set ulimit -c to unlimited:

unlimit -c unlimited

4 Using the sam or kmtune utilities, increase your kernel configuration variable, maxdsiz. This number can vary and is determined by the system administrator.

The maxdsiz kernel parameter controls the amount of private data each process can handle. Increasing this value prevents an “out of process memory” error.

NOTE To increase the maxdsiz to 3 GB, you must increase the maxdsiz_64 to 3 GB.

Shutting down AR System applicationsBMC Software has found that shutting down the Reconciliation Engine and other applications related to AR System such as Approval Server and Email Engine before you upgrade improves the upgrade installer performance.

Tuning upgrades in an Oracle environmentBMC Software has found that changing some database and operating system settings can reduce considerably the time required to upgrade BMC Atrium CMDB installed with an Oracle database.

� To improve upgrade performance

1 In your Oracle database, do the following:

� Set the extent management for the SYSTEM tablespace to LOCAL.

� Increase the Redo log buffer to 1 MB or larger.

NOTE The following step applies only to systems running the UNIX operating system.

Chapter 1 Installing BMC Atrium CMDB 25

Page 26: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

2 If you are using a UNIX computer, turn on the write cache for all disks. On Windows, write cache is enabled by default.

To turn on write cache

a At the system prompt, type format -e.

This command displays all of the disks on the system.

b Select a disk from this list.

c At the prompt, type cache.

d At the prompt, type write_cache.

e At the prompt, type display.

This command displays whether the cache is on or off.

f At the prompt, type quit.

g At the prompt, type quit.

h At the prompt, type quit.

i Repeat step b through step h for each disk.

Viewing the results of an upgradeThe installer writes status messages to a log file, giving a detailed account of all changes made to your data model during the upgrade. If the upgrade fails and you have to run the installer again, it resumes after the last operation it completed rather than repeating operations that have already been completed.

The log file is named cmdbengdebug.log, and by default is written to <AR_System_server_dir>\ARServer\Db\. To specify a different location, edit the ar.cfg (Windows) or ar.conf file (UNIX) before running the installer and change the value of the CMDB-Log-File-Location parameter.

You will see these messages in the log file:

[WARNING] [TID: 004092] : UpdateCacheInfo -- Error Retrieving Federation Update information.... error code: 303[WARNING] [TID: 004092] : UpdateCacheInfo -- Error Retrieving Dataset Update information.... error code: 303[ INFO ] [TID: 001160] : Finished upgrade to version 2.1.0[WARNING] [TID: 001160] : WARNING: 8037 Index length longer than 255 bytes --[WARNING] [TID: 001160] : may not work on all databases[ INFO ] [TID: 001160] : Finished incremental upgrade.[WARNING] [TID: 001160] : WARNING: 8037 Index length longer than 255 bytes --[WARNING] [TID: 001160] : may not work on all databases

These warnings are normal, and you can ignore them.

26 Installation and Configuration Guide

Page 27: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing on an AR System server group

TIP Make a copy of the cmdbengdebug.log file to view after a successful upgrade. Even though the upgrade succeeded, you can use the log file to find out which instances you must migrate manually to keep your data in the CDM. It also tells you which classes the upgrade installer was unable to delete due to the existence of subclasses you created.

Installing on an AR System server groupThis section explains how to install BMC Atrium CMDB on a server group. It assumes you are familiar with managing an AR System server group. For information about server groups, including the Server Group Operation Ranking form, see BMC Remedy Action Request System 7.1.00: Configuring.

IMPORTANT If you deleted or modified the Server Group Operation Ranking form entries for BMC Atrium CMDB, which some users do to avoid error messages during AR System server startup, make sure you reestablish the rankings before you install BMC Atrium CMDB. The BMC Atrium CMDB ranking must be the same as the Administration ranking for each server in the group. If they are ranked differently, you might encounter errors during Class Manager operations.

� To install BMC Atrium CMDB on a server group

1 Stop the AR System server on all members of the server group except the server with an Administration ranking of 1.

WARNING If you do not stop the AR System server on the remaining members of the server group, the Administrator functionality might be taken over by another server during the installation. This might result in a partial installation on the active server.

2 Using the appropriate Windows or UNIX procedure, install BMC Atrium CMDB on the active server.

This installs executable files as well as other BMC Atrium CMDB components, such as forms, workflow, and data.

3 Start all of the remaining AR System servers in the server group.

4 On each of the remaining members of the server group, perform the same installation procedure you performed in step 2.

When the installer asks whether you want to share this server as part of the group, select that option.

This installs only the executable files.

5 Restart the system servers on all members of the server group.

Chapter 1 Installing BMC Atrium CMDB 27

Page 28: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Installing and uninstalling on WindowsThis section explains how to install and uninstall BMC Atrium CMDB and the online Help system on the same machine as your AR System server that uses a Windows operating system.

TIP To install the application more quickly, make sure that no users are logged in to the system during the installation. You can also select the Disable Escalations option to make sure that no escalations run during the installation process. For more information, see BMC Remedy Action Request System 7.1.00: Configuring.

Installing BMC Atrium CMDBThis section explains how to install BMC Atrium CMDB using a Windows operating system.

� To install BMC Atrium CMDB on Windows

NOTE Installation time varies depending on your system, and might take over an hour.

WARNING During installation, the BMC Atrium CMDB installer creates a private server that uses RPC number 390626. If your system already uses this RPC number for a private server queue, you must update the ar.cfg file to use a different RPC number for that queue. If you do not update the file, the RPC socket entry is overwritten during the installation process.

1 Make sure that the AR System server that the application connects to is running.

2 From the root folder of your installation CD or download, double-click setup.exe.

The Welcome window appears.

3 Click Next to proceed.

The Software License Agreement (SLA) window appears.

28 Installation and Configuration Guide

Page 29: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

4 Read the license agreement, and then click I Agree to accept it.

The AR Server Connection Information window appears.

Figure 1-1: AR Server Connection Information window

5 From the AR Server Name list, select the AR System server where you are installing BMC Atrium CMDB.

6 If you specified a port number when installing this AR System server, enter it in the Port Number field. If the server uses a portmapper to automatically select a port to use, leave this field blank.

Because communications with BMC Atrium CMDB go through AR System, the port you specify here is also used by other applications to communicate with the BMC Atrium CMDB.

7 If you specified an RPC port number when installing the AR System server, enter it in the RPC Port Number field.

8 Click Next.

The Administrator Logon Information Required window appears.

Figure 1-2: Administrator Logon Information Required window

Chapter 1 Installing BMC Atrium CMDB 29

Page 30: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

9 Enter the User Name and Password for an AR System Administrator user, then click Next.

The default administrator login for a new AR System installation is the Demo user name and no password. This gives you immediate administrator privileges as soon as the AR System server is installed.

IMPORTANT For optimum security, add a password for the Demo user name as soon as possible. For information about modifying AR System user information, see Action Request System 7.1.00: Configuring.

10 If you have an earlier version of BMC Atrium CMDB installed on this server, you are prompted to upgrade it. Choose Yes to upgrade, or No to exit the installer.

For more information about upgrading, see “Upgrading from previous versions” on page 18.

The Select additional language packs window appears.

Figure 1-3: Select additional language packs window

11 In the Select user languages area, select any additional languages you want to install.

This feature enables you to install localized views in multiple languages at one time. English views are always installed, whether or not you select any other user languages.

12 In the Select data language area, select the language you want to use for the data that is installed with BMC Atrium CMDB.

NOTE You can install only one data language at a time.

30 Installation and Configuration Guide

Page 31: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

13 Click Next.

The Choose Destination Location window appears.

Figure 1-4: Choose Destination Location window

14 Accept the default destination folder or click Browse to select another one, then click Next.

By default, the installation directory structure is as follows:

BMC Atrium CMDB

Logssdkserverutilsworkflow

15 If you are installing BMC Atrium CMDB on a machine that is part of a secondary server in a group, then the Share Server Environment window appears, and you must complete the steps in Table 1-1. Otherwise, skip to step 16.

Table 1-1: Steps for installing on a machine that is part of a secondary server in a group

For more information about server groups, see Action Request System 7.1.00: Configuring.

The installer begins installing BMC Atrium CMDB. When the installation procedure finishes, the Setup Complete window appears.

If you want Then

To install only the executable files and configuration entries necessary to use this machine as a secondary server

Select the Share Server Group box, and click Next.

To exit the installer Leave the Select the Share Server Group box deselected, and click Next.

Chapter 1 Installing BMC Atrium CMDB 31

Page 32: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

16 Click Finish.

Installation log files are available in the <CMDB_install_directory>\Logs folder.

NOTE With version 2.1.00, there is no need to manually copy files to enable the CI Relationship Viewer. The BMC Atrium CMDB installer completely enables this component.

NOTE For information on installing the Definitive Software Library, see the Definitive Software Library 7.1 Administrator's Guide.

Installing HelpThe Help system for BMC Atrium CMDB is installed separately from the application itself. You must perform the procedure in this section to install the online help.

Help is installed on a web server and launched with URLs sent from BMC Atrium CMDB. It does not require BMC Remedy Mid Tier. This web server does not have to be installed on the same machine as BMC Atrium CMDB. If you want Help to reside on a different machine, run the Help installer on the web server where Help is to be installed.

IMPORTANT You can install Help files on either Windows or UNIX systems. If you want to install Help files on multiple systems, you must run the installer locally on each individual system.

� To install Help for BMC Atrium CMDB on Windows

1 Make sure that:

� BMC Atrium CMDB is installed

� AR System server where the BMC Atrium CMDB is installed is running

� Web server for Help is running

32 Installation and Configuration Guide

Page 33: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

2 Navigate to the help folder of your installation CD or download, then double-click setup.exe.

The Welcome window appears.

Figure 1-5: Welcome window

3 Click Next, and then click I Agree to accept the license agreement on the next window.

Chapter 1 Installing BMC Atrium CMDB 33

Page 34: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

The Enter Required Information window appears.

Figure 1-6: Enter Required Information window

4 Enter the login and server information for the AR System server from which you want to install Help, and click Next.

You need the user name and password for an AR System administrator and the name of an AR System server. If you access the server on a particular port, enter that number in the Port Number field.

34 Installation and Configuration Guide

Page 35: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

The Select Web Server window appears.

Figure 1-7: Select Web Server window

5 Select an installed web server to deliver the requested Help files to users, and then click Next.

The Select Language Packs window appears.

Chapter 1 Installing BMC Atrium CMDB 35

Page 36: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

6 Select any additional language packs you want, and click Next.

The Choose Destination Location window appears.

Figure 1-8: Choose Destination Location window

7 Accept the default installation folder or browse and choose another folder, then click Next.

36 Installation and Configuration Guide

Page 37: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

The Confirm URL window appears, displaying the URL that BMC Atrium CMDB uses to launch Help from the designated folder.

Figure 1-9: Confirm URL window

8 Modify the URL as necessary, then click Next.

The Start Copying Files window appears.

Chapter 1 Installing BMC Atrium CMDB 37

Page 38: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

9 Review your settings, and click Install if they are correct. Otherwise, click Back and modify them.

The installer copies necessary files to the installation folder, and then the completion window appears.

Figure 1-10: Completion window

10 Select View Installation Log File if you want to examine the log after installation, and then click Finish to exit.

Uninstalling from WindowsThis section explains how to uninstall BMC Atrium CMDB from a Windows operating system, while leaving the AR System server installed.

� To uninstall the BMC Atrium CMDB on Windows

1 Navigate to the Windows Control Panel > Administrative Tools > Services > BMC Remedy Action Request System Server, and choose Action > Stop.

2 Navigate to the ar.cfg file.

NOTE By default, the ar.cfg file and the armonitor.cfg file are located at C:\Program Files\AR System\<server_name>\CONF\.

38 Installation and Configuration Guide

Page 39: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on Windows

3 In the ar.cfg file, delete the following lines:

RE-Log-File-Location: C:\Program Files\AR System Applications\<server_name>\BMC Atrium CMDB\Logs

Load-Shared-Library: cmdbsvr21.dll

Load-Shared-Library-Path: C:\Program Files\AR System Applications\<server_name>\BMC Atrium CMDB\server\bin

Plugin: "C:\Program Files\AR System Applications\<server_name>\BMC Atrium CMDB\server\bin\libcmdbconsolefilterapi21.dll"

4 Delete the following lines if they exist:

CMDB-Debug:CMDB-Debug-Level:CMDB-Log-File-Location:CMDB-Max-Log-File-Size:CMDB-Cache-Refresh-Interval:RE-Defn-Check-Interval: RE-Debug: RE-Debug-Level: RE-Max-Log-File-Size: RE-Polling-Interval: RE-RPC-Socket:

5 Choose File > Save and close the file.

6 In the armonitor.cfg file in the same folder, delete the following lines:

"C:\Program Files\AR System Applications\<server_name>\BMC Atrium CMDB\server\bin\arrecond.exe" -i "C:\Program Files\AR System\<server_name>" -m

"C:\Program Files\AR System Applications\<server_name>\BMC Atrium CMDB\server\bin\arcmdbd.exe" -i "C:\Program Files\AR System\<server_name>" -m

7 Choose File > Save and close the file.

8 From the AR System Applications directory, delete the BMC Atrium CMDB directory.

WARNING Verify the name and location of the install directory before deleting it. By default, this directory is located at C:\Program Files\AR System Applications\<server_name>.

9 Restart the AR System server by navigating to the Windows Control Panel > Administrative Tools > Services > BMC Remedy Action Request System Server, and choose Action > Start.

10 Log in to BMC Atrium CMDB with BMC Remedy Administrator, and delete all forms, menus, and applications with names beginning with BMC, BSM, CMDB, OBJSTR, and RE.

TIP For more information about forms, see the User’s Guide.

Chapter 1 Installing BMC Atrium CMDB 39

Page 40: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

11 With BMC Remedy User, log in to the AR System server where BMC Atrium CMDB is installed.

12 Open the SHARE:Application_Properties form in Search mode, and delete all entries for the CMDB Application ID OB00C04FA081BABZlxQAmyflAg1wEA.

To delete entries in a form with Remedy User, enter the ID and choose Actions > Delete from the menu.

13 Delete any entries from the SHARE:Applicaton_Properties form for BMC Atrium CMDB extensions installed by other products, such as BMC Impact Solutions or BMC Foundation Discovery and BMC Topology Discovery.

14 In the Group form, delete the Groups that start with CMDB and OBJSTR:

� CMDB Internal View

� CMDB Data Change Group

� CMDB Data View Group

� OBJSTR Class View

� OBJSTR Class Change

� CMDB Write Security

� CMDB Internal View Dynamic

15 In the Roles form, delete the Roles that start with CMDB:

� CMDB RE User

� CMDB RE Definitions Admin

� CMDB RE Manual Identification

� CMDB Data View All

� CMDB Data Change All

� CMDB Console User

� CMDB Console Admin

� CMDB Definitions Viewer

� CMDB Definitions Admin

� CMDB Data View

� CMDB Data Change

16 On the mid tier machine where you have installed the CI Relationship Viewer, navigate to the WEB-INF\lib directory of the BMC Remedy Mid Tier and delete the cmdbapi21.jar, cmdbjni21.dll, and cmdbapi21.dll files.

This completes the removal of the BMC Atrium CMDB applications and leaves the AR System intact.

40 Installation and Configuration Guide

Page 41: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on UNIX

Installing and uninstalling on UNIXThis section explains how to install and uninstall BMC Atrium CMDB and the online Help system on an AR System server using a UNIX operating system.

Installing BMC Atrium CMDB

IMPORTANT You must install BMC Atrium CMDB on the same system as the AR System server, and the installation must be performed locally. You must also log in either as root or as the same user who installed the BMC Remedy AR System server. Otherwise, the installer cannot restart the server to successfully complete the installation.

The BMC Atrium CMDB script writes log files to /usr/tmp/cmdb/ and/usr/arsystem/<server_name>/cmdb/Logs.

TIP To install BMC Atrium CMDB quickly, make sure that no users are logged in to the AR System server during the installation. You can also select the Disable Escalations check box to make sure that no escalations run during the installation process. For more information, see the BMC Remedy Action Request System 7.1.00: Configuring.

� To install BMC Atrium CMDB on UNIX

NOTE Installation time varies depending on your system, and might take over an hour.

WARNING During installation, the BMC Atrium CMDB installer creates a private server that uses RPC number 390626. If your system already uses this RPC number for a private server queue, you must update the ar.cfg file to use a different RPC number for that queue. If you do not update the file, the RPC socket entry is overwritten during the installation process.

1 Make sure that the AR System server that the application connects to is running.

2 Access the installation software.

If you are installing from the product installation CD:

a Mount the CD locally or remotely.

b Change to the directory containing the installation script as follows:

cd <CD-ROM_mount_point>/<CMDB_directory>

The BMC Atrium CMDB installation script is in the cdrom directory. For more information about mounting the CD, see Action Request System 7.1.00: Installing.

Chapter 1 Installing BMC Atrium CMDB 41

Page 42: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

3 Run the installation script:

./appinstall

4 At the licensing and maintenance prompt, press ENTER to accept the agreement.

5 At the choose server prompt, press ENTER to accept the default AR System server, or enter the AR System server to use with the application.

6 At the confirmation prompt, press ENTER to continue with the installation.

7 At the AR System installation directory prompt, press ENTER to accept the default directory, or enter the directory and path for the AR System.

By default, the installation directory structure is as follows:

CMDB

Logssdkserverutilsen<other_installed_locale>

8 At the confirmation prompt, press ENTER to confirm the AR System server installation directory.

The installer checks the ar.conf file to see if AR System is using the portmapper or if it is using a specified port.

9 At the TCP/IP port prompt, press ENTER to accept the default value, or enter another port number for the AR System server.

10 At the confirmation prompt, press ENTER to confirm the port number.

11 At the TCP/IP port prompt, press ENTER to accept the default value, or enter another port number for the AR System server.

12 At the confirmation prompt, press ENTER to confirm the port number.

13 At the AR System Administrator ID prompt, press ENTER to accept the default value, or enter another administrator ID.

The default administrator login for a new AR System installation is the Demo user name and no password. This gives you immediate administrator privileges as soon as BMC Atrium CMDB is installed. Before proceeding, secure your system by adding a password to this user name.

IMPORTANT For optimum security, add a password for the Demo user as soon as possible. For more information about controlling access and creating permissions roles, see Action Request System 7.1.00: Configuring.

14 At the AR System administrator password prompt, enter the AR System administrator password.

42 Installation and Configuration Guide

Page 43: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on UNIX

15 If you have a previous version of BMC Atrium CMDB installed, you are prompted to upgrade it. Enter Y to upgrade, or N to quit the installer.

For more information about upgrading, see “Upgrading from previous versions” on page 18.

16 At the Select language(s) from the following list prompt, select the number that corresponds to additional languages you want to install.

NOTE To select multiple languages, separate the numbers by a comma.

17 At the Select data language from the following list prompt, select the language you want to use for the data that is installed with BMC Atrium CMDB.

You can select only one data language during the install. When you select the data language, make sure that the view language for the data language is also selected.

18 At the installation directory prompt, press ENTER to accept the default directory for the application, or type n to enter another directory and path.

The installer checks to make sure the specified partition contains sufficient free disk space required to install the application.

19 At the confirmation prompt, press ENTER to confirm the installation directory.

20 If you are installing on a machine that is part of an AR System server group, the shared server prompt appears. Press ENTER to install BMC Atrium CMDB only on the local machine, or type y to install the product for use with the server group.

For more information about server groups, see Action Request System 7.1.00: Configuring.

21 At the load applications into AR System prompt, press ENTER to install the application or type n to extract the files to install later.

22 At the load sample data prompt, press ENTER to install sample data or type n to skip installation of sample data.

The installer copies files and loads workflow, which can take a long time.

23 At the restart prompt, press ENTER to restart AR System now or type n to restart AR System later. You must restart BMC Atrium CMDB before using the application.

Messages appear telling you that installation completed and prompting you to install Help.

NOTE With version 2.1.00, there is no need to manually copy files to enable the CI Relationship Viewer. The BMC Atrium CMDB installer completely enables this component.

Chapter 1 Installing BMC Atrium CMDB 43

Page 44: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Enabling full installation on AIX When installing on AIX, your ncargs system attribute must be set to 32 or higher to ensure that all directories are installed. To check your current ncargs value, type this command:

lsattr -E -l sys0 -a ncargs

If ncargs is not 32 or more, set it to 32 by typing this command:

chdev -l sys0 -a ncargs=32

Installing HelpThe Help system for BMC Atrium CMDB is installed separately from the application itself. You must perform the procedure in this section to install the online help.

Help is installed on a web server and launched with URLs sent from BMC Atrium CMDB. It does not require BMC Remedy Mid Tier. This web server does not have to be installed on the same machine as BMC Atrium CMDB. If you want Help to reside on a different machine, run the Help installer on the web server where Help is to be installed.

The installer puts an entry in the SHARE:Application_Properties form on the CMDB server. When you access the Help system, CMDB obtains the root Help URL from there, and builds a topic-specific URL to launch.

IMPORTANT You can install Help files on either Windows or UNIX systems. If you want to install Help files on multiple systems, you must run the installer locally on each individual system.

� To install Help for the BMC Atrium CMDB on UNIX

1 Make sure that:

� BMC Atrium CMDB is installed

� AR System server connecting to the applications is running

� Web server for Help is running

2 Change to the directory containing the Help files:

cd cdrom/help

3 Run the Help installation script:

./helpinstall

4 At the license agreement prompt, press ENTER.

Scroll through and review the user license and maintenance agreement.

44 Installation and Configuration Guide

Page 45: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on UNIX

5 At the licensing and maintenance prompt, press ENTER to accept the default value.

In a typical installation where BMC Atrium CMDB is installed on another system, a message appears indicating that no local BMC Atrium CMDB server was detected.

6 At the AR System server prompt, enter the name of the AR System server on which the application is installed.

7 At the TCP/IP port prompt, press ENTER to use the portmapper or enter the port number.

8 At the confirmation prompt, press ENTER to confirm the port number.

9 At the AR System administrator ID prompt, press ENTER to accept the default value or enter another administrator ID.

10 At the AR System administrator password prompt, enter the AR System administrator password.

11 Enter one of the following for the web server to use for Help:

� Enter the corresponding letter to automatically detect an Apache or iPlanet web server that you want to use for Help.

� Enter O to install the Help files on a different web server. If you select this option, you must configure your web server and specify the URL to the Help files in step 16.

� Enter N to install the Help files in the folder you specify, but without making them available on a web server. Skip to step 15.

12 At the web server configuration file prompt, enter the directory path to the configuration file on the web server for Help.

If the web server port number is not defined in the specified configuration file, a prompt appears for the port number.

13 Press ENTER to accept the HTTP port number of 80, or enter another port number.

14 At the confirmation prompt, press ENTER to accept the default value or type n to make any changes

15 At the Help install directory prompt, press ENTER to accept the default directory or enter the directory for the Help files.

The installer checks to make sure the target disk drive contains sufficient free space required to install the Help files.

16 If you are installing the Help files on a web server, a prompt appears for the URL to Help. Otherwise an application path prompt appears.

Make any changes to the URL for the web server or the path to the directory for the Help files or press ENTER to accept the default value.

Chapter 1 Installing BMC Atrium CMDB 45

Page 46: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

17 At the installation summary and confirmation prompt, press ENTER to continue or type n to make any changes.

After the Help files are copied, installation is complete and log file location messages appear.

Uninstalling from UNIXThis section explains how to uninstall BMC Atrium CMDB from a UNIX operating system, and leave the AR System server installed.

� To uninstall the BMC Atrium CMDB on UNIX

1 Log in to the system as root.

2 Change to the directory containing the armonitor file as follows:

cd /usr/ar/<AR_server>/bin/armonitor

To find out where your AR System server is installed, type the command: ps -ef | grep ar to see a list of results, including <AR_server>/bin/armonitor.

3 Stop the AR System server by entering the following command:

./arsystem stop

4 In the <AR_server>/conf/ar.conf file, delete the following lines:

Load-Shared-Library: libcmdbsvr20.so

Load-Shared-Library-Path: /usr/arsystem/<machine_name>/cmdb/server/bin

Plugin: /usr/arsystem/<machine_name>/cmdb/server/bin/cicomparefilterapi.so

RE-Log-File-Location: /usr/arsystem/<machine_name>/cmdb/Logs

5 Delete the following lines if they exist:

CMDB-Debug:CMDB-Debug-Level:CMDB-Log-File-Location:CMDB-Max-Log-File-Size:CMDB-Cache-Refresh-Interval:RE-Defn-Check-Interval: RE-Debug: RE-Debug-Level: RE-Max-Log-File-Size: RE-Polling-Interval: RE-RPC-Socket:

NOTE By default, the BMC Atrium CMDB is installed in the Atrium CMDB directory.

6 Save your changes.

7 Change to the directory containing the armonitor.conf file as follows:

cd /etc/arsystem/<server_name>/

46 Installation and Configuration Guide

Page 47: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Installing and uninstalling on UNIX

8 In the armonitor.conf file, delete the following lines:

/usr/arsystem/<server_name>/cmdb/server/bin/arrecond.sh/usr/arsystem/<server_name>/cmdb/server/bin/arcmdbd.sh

9 Save your changes.

10 In the /usr/arsystem/<server_name> directory, delete the cmdb directory.

WARNING Verify the name and location of the install directory before deleting it. By default, this directory is located at /usr/arsystem/<server_name>/cmdb.

11 Restart the AR System server by entering the following command:

./arsystem start

12 Log in to BMC Atrium CMDB with BMC Remedy Administrator, and delete all forms, menus, and applications with names beginning with BMC, BSM, CMDB, OBJSTR, and RE.

TIP For more information about forms, see the User’s Guide.

13 With BMC Remedy User, log in to the AR System server where BMC Atrium CMDB is installed, open the SHARE:Application_Properties form in Search mode, and delete all entries for the CMDB Application ID OB00C04FA081BABZlxQAmyflAg1wEA.

14 Delete any entries from the SHARE:Application_Properties form for BMC Atrium CMDB extensions installed by other products, such as BMC Impact Solutions or BMC Foundation Discovery and BMC Topology Discovery.

15 In the Group form, delete the Groups that start with CMDB and OBJSTR:

� CMDB Internal View

� CMDB Data Change Group

� CMDB Data View Group

� OBJSTR Class View

� OBJSTR Class Change

� CMDB Write Security

� CMDB Internal View Dynamic

16 In the Roles form, delete the Roles that start with CMDB:

� CMDB RE User

� CMDB RE Definitions Admin

� CMDB RE Manual Identification

� CMDB Data View All

� CMDB Data Change All

� CMDB Console User

� CMDB Console Admin

� CMDB Definitions Viewer

Chapter 1 Installing BMC Atrium CMDB 47

Page 48: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� CMDB Definitions Admin

� CMDB Data View

� CMDB Data Change

17 On the Mid Tier machine where you have installed the CI Relationship Viewer, navigate to the WEB-INF/lib directory of the BMC Remedy Mid Tier and delete the cmdbapi21.jar, cmdbjni21.dll, and cmdbapi21.dll files.

This completes the removal of the BMC Atrium CMDB applications, and leaves the AR System intact.

Moving your installation to a different locationYou can move the BMC Atrium CMDB installation to a different location on the same machine.

Moving a Windows installationThe following steps describe how to move the BMC Atrium CMDB installation to a different location on the same machine using a Windows environment.

1 Copy the installation directory to new location.

For example, C:\Program Files\AR System Applications\<AR-server-name>\BMC Atrium CMDB

2 In the ar.cfg file, modify the following paths:

� Load-Shared-Library-Path: <path of cmdb new-location>\BMC Atrium CMDB\server\bin

� CMDB-Install-Directory: <path of cmdb new-location>

� RE-Log-File-Location: <any path>

� Plugin: <path of cmdb new-location>\ BMC Atrium CMDB\server\bin\libcmdbconsolefilterapi21.dll"

3 In the armonitor.cfg file, modify the paths of arrecond.exe and arcmdbd.exe to reflect the new location paths.

4 Update the installation register entry as follows:

HKEY_LOCAL_MACHINE\Software\BMC Software\BMC Atrium CMDB\<version>\InstallDir key

NOTE For details about migrating the BMC Atrium CMDB installation to a different server, see the Developer’s Reference Guide.

48 Installation and Configuration Guide

Page 49: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Enabling the CI Distribution graph for BMC Remedy User clients

Moving a UNIX installationThe following steps describe how to move the BMC Atrium CMDB installation to a different location on the same machine using a UNIX environment.

1 Copy the installation directory to new location.

For example, /usr/arsystem/<AR-server-name>/cmdb

2 In /etc/arsystem/<AR-server-name>/armoniter.conf, modify the paths of arcmdbd.sh and arrecond.sh to reflect the new locations.

3 In arcmdbd.sh and arrecond.sh, modify the following:

� The paths of executables arcmdbd and arrecond to reflect the new paths.

� NLSPATH in both shell scripts, to reflect new locations.

� LD_LIBRARY_PATH in both shell scripts, to reflect new locations.

4 In the /usr/ar/<AR-server-name>/conf/ar.conf file, modify the path of following parameter, RE-Log-File-Location, to reflect the new location path.

NOTE For details about migrating the BMC Atrium CMDB installation to a different server, see the Developer’s Reference Guide.

Enabling the CI Distribution graph for BMC Remedy User clients

The CMDB Home tab contains a BMC Remedy Flashboards graph, or flashboard, that shows the distribution of CIs. To display a flashboard requires the BMC Remedy Mid Tier. Therefore, this flashboard is automatically visible to web clients because they are accessing the BMC Atrium CMDB through the Mid Tier. But you must change a server setting to make the flashboard visible to BMC Remedy User clients.

� To enable flashboards for BMC Remedy User clients

1 In BMC Remedy User, log in to your BMC Atrium CMDB server.

2 Open the AR System Administration: Server Information form in Search mode and find the record for your BMC Atrium CMDB server.

3 Click the Advanced tab.

4 In the Default Web Path field, type http://<server>:<port>/arsys/ where <server> is the name of your Mid Tier server.

Chapter 1 Installing BMC Atrium CMDB 49

Page 50: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 Click OK.

The next time you log in to BMC Atrium CMDB with BMC Remedy User, you see the flashboard showing the distribution of CIs among class types.

NOTE Make sure your BMC Atrium CMDB server is in the AR Server Settings list in the Mid Tier server’s configuration.

Deploying optional web servicesWeb services are applications that exchange data in response to requests from clients using transport protocols and XML-based standards. Web services are an optional feature that enable BMC Atrium CMDB to be used in a service-oriented architecture. The core functionality of BMC Atrium CMDB does not require web services.

The BMC Atrium CMDB publishes a web services API that provides you with access to instance data, the data model, reconciliation jobs, and more. For more information about using the web services API, see the Developer's Reference Guide.

Deployment requirementsYou can run web services on both your local BMC Atrium CMDB computer and on remote computers, such as those installed where BMC Remedy Mid Tier is installed.

Before installing web services, make sure your system meets the following requirements:

� Java Runtime (J2SE) version 1.5.0_06 or higher

� One of the following supported third-party web application servers:

� Apache Tomcat version 5.0x and 5.5x

� BEA WebLogic Server version 8.1

� New Atlanta ServletExec version 5

50 Installation and Configuration Guide

Page 51: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Deploying optional web services

Deploying web service applicationsBy default, the BMC Atrium CMDB installer places web services in the local <CMDB_install_directory>\sdk\cmdbws directory. The web services are not functional until you manually deploy them. This section describes how to manually deploy to supported third-party web service application servers. These application servers are supported:

� Tomcat

� WebLogic

� ServletExec

You can install the web service application servers on either the same machine as BMC Atrium CMDB or on a remote machine.

NOTE The following instructions apply to both Windows and UNIX environments.

� To deploy web services

1 Stop your application server and leave the AR System server and BMC Atrium CMDB running.

2 Copy the <CMDB_install_directory>\sdk\cmdbws\server\cmdbws directory to the appropriate directory for your application server:

� Tomcat—webapps

� WebLogic—<your_domain>/applications

� ServletExec—webapps

3 In the cmdbws/WEB-INF/cmdbws.properties file, set the following attributes:

� AR System server name

� Port number, if appropriate

4 In the cmdbws/conf/log4j.config file, set the following log file names:

� log4j.appender.eventLog.File=<install_directory>/logEvents.log

� log4j.appender.errorLog.File=<install_directory>/errorEvents.log

NOTE Use <install_directory> to indicate the machine on which you installed your application server, either the same machine as BMC Atrium CMDB or a remote machine.

5 If you are using Tomcat or WebLogic, skip to step 8. If you are using ServletExec, continue.

6 In the application.properties file, add the following lines:

� application.cmdbws.path=/cmdbws/

� application.cmdbws.location=<CMDB_install_directory>/cmdbws

Chapter 1 Installing BMC Atrium CMDB 51

Page 52: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

7 Do either of the following:

� If you are using a Windows environment, in the application.xml file, add the following lines:

<web-app><name>cmdbws</name><path>/cmdbws/</path><location>C:\cmdbws</location><naextensions>disabled</naextensions><filecaching>enabled</filecaching><servestatic>enabled</servestatic>

</web-app>

� If you are using a UNIX environment, in the application.xml file, add the following lines:

<web-app><name>cmdbws</name><path>/cmdbws/</path><location><CMDB_install_directory>\sdk\cmdbws\server\cmdbws</location><naextensions>disabled</naextensions><filecaching>enabled</filecaching><servestatic>enabled</servestatic>

</web-app>

8 Add the following directory to the PATH:

<Application server’s webapp directory>\webapps\cmdbws\WEB-INF\lib

9 Start your application server to run the web service.

Accessing web servicesThis section explains how to access web services.

� To access web services

� Go to the following URL for a Tomcat, WebLogic, or ServletExec server: http://<hostname>:<port>/cmdbws/server/cmdbws

The extension loaderBMC Atrium CMDB includes a component called the extension loader that is used for installing classes and attributes, AR System form data, and AR System workflow. For information about using the extension loader, see the Developer’s Reference Guide.

52 Installation and Configuration Guide

Page 53: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Accessing the CMDB Console

Accessing the CMDB Console You can access the CMDB Console with either BMC Remedy User or a browser. To access it with BMC Remedy User, click the CMDB Console link in the Quick Links pane of the Home Page. To access it with a browser, enter the URLhttp://<web_server>:<port>/arsys/apps/<AR_server>/AtriumCMDBConsole .

For more detailed instructions on accessing the CMDB Console, and for descriptions of each of its tabs, see the User’s Guide.

NOTE To make changes to your data model with the Class Manager, you cannot access the CMDB Console with a load balancer. A load balancer receives requests and sends them to whichever physical server has the most resources available to handle them.

If your environment uses a server group with a load balancer, you must bypass the load balancer and log in directly to the AR System server on which administrative tasks for the server group are performed. This is the server for which the Server Group Operation Ranking form shows an Administration value of 1. You cannot use the load balancer to log in because the load balancer might not direct you to the correct AR System server.

This only applies to modifications made through the Class Manager or equivalent API functions. When performing all other BMC Atrium CMDB tasks, you can log in using a load balancer.

Chapter 1 Installing BMC Atrium CMDB 53

Page 54: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

54 Installation and Configuration Guide

Page 55: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

2

Managing permissions

This section explains how to set up permissions for BMC Atrium CMDB, including access to different areas of the application and access to configuration data.

The following topics are provided:

� Defining users (page 56)� Application roles (page 56)� Class and attribute permissions (page 58)� Instance permissions (page 59)� Default instance permissions (page 60)

Chapter 2 Managing permissions 55

Page 56: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Defining usersTo give someone access to BMC Atrium CMDB, you must create an AR System user for them 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 them access to different parts of the application and its data.

This section discusses how AR System groups and roles are used in BMC Atrium CMDB. For information about creating users, see BMC Remedy Action Request System 7.1.00: Configuring. For information about working with groups and roles in general, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

Application rolesTable 2-1 lists the application roles available for BMC Atrium CMDB. For more information about these roles and how they interact with other BMC Atrium CMDB permissions, see the Concepts and Best Practices Guide.

Table 2-1: Permissions roles in BMC Atrium CMDB

Name Application Users with this role can

CMDB Data View BMC:Atrium CMDB View class instances. Works in conjunction with the CMDBRowLevelSecurity and CMDBWriteSecurity attributes. See “Instance permissions” on page 59.To perform these tasks from the CMDB Console, the CMDB Console User role is also required.

CMDB Data Change BMC:Atrium CMDB View, create, and modify class instances. Works in conjunction with the CMDBRowLevelSecurity attribute. See “Instance permissions” on page 59.To perform these tasks from the CMDB Console, the CMDB Console User role is also required.

CMDB Data View All BMC:Atrium CMDB View all class instances. Not dependent on the CMDBRowLevelSecurity attribute for row-level security.To perform these tasks from the CMDB Console, the CMDB Console User role is also required.

CMDB Data Change All BMC:Atrium CMDB View, create, and modify all class instances. Not dependent on the CMDBRowLevelSecurity attribute for row-level security.To perform these tasks from the CMDB Console, the CMDB Console User role is also required.

56 Installation and Configuration Guide

Page 57: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Application roles

CMDB Console User AtriumCMDBConsole � Access the CMDB Console, but cannot see the Administration menu or Job Summary on the CMDB Home tab

� Perform searches from the CMDB Console if they also have one of the two CMDB Definitions roles

� View federation definitions� Launch applications in context� View instance history from the CMDB Console if they

also have one of the two CMDB Definitions roles, row-level security on the audited instances, and permissions on the audit or log form

CMDB Console Admin AtriumCMDBConsole � Access the CMDB Console, including the Administration menu on the CMDB Home tab and, if they also have the CMDB RE User or CMDB RE Definitions Admin role, including the Job Summary

� Perform searches from the CMDB Console if they also have one of the two CMDB Definitions roles

� View, create, modify, and delete public searches� View, create, modify, and delete federation

definitions� Launch applications in context� View instance history from the CMDB Console if they

also have one of the two CMDB Definitions roles, row-level security on the audited instances, and permissions on the audit or log form

CMDB Definitions Viewer AtriumCMDBConsole � View class definitions� This role also enables class menus in the CMDB

Console windows for searching, creating, and comparing instances.

CMDB Definitions Admin AtriumCMDBConsole � View, create, modify, and delete class definitions� This role also enables class menus in the CMDB

Console windows for searching, creating, and comparing instances.

CMDB RE User REApplicationDeployable

� View jobs, activities, and groups� Start and cancel jobs� View the Job Summary on the CMDB Home tab if

they also have the CMDB Console Admin role

CMDB RE Definitions Admin

REApplicationDeployable

� View, create, modify, and delete jobs, activities, and groups

� Start and cancel jobs� View the Job Summary on the CMDB Home tab if

they also have the CMDB Console Admin role

CMDB RE Manual Identification

REApplicationDeployable

Manually identify instances

Table 2-1: Permissions roles in BMC Atrium CMDB

Name Application Users with this role can

Chapter 2 Managing permissions 57

Page 58: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

NOTE Users with the CMDB Data View and CMDB Data View All roles can create instances, but only for classes where all required attributes have either a default value or the Allow Any User to Submit option enabled. By default, this is not true for the classes in the Common Data Model.

� To assign a role to a user

� CMDB Data View and CMDB Data Change roles—Make the user a member of a group that is a member of the computed group mapped to the role.

These roles are mapped to computed groups provided with the BMC Atrium CMDB named CMDB Data View Group and CMDB Data Change Group, respectively.

� Other BMC Atrium CMDB roles—Make the user a member of the group that is mapped to the role, or map one of the user’s existing groups to the role.

For more information about AR System application roles and computed groups, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

Class and attribute permissionsYou can specify permissions on BMC Atrium CMDB data at both the class and attribute level.

Class permissionsYou can specify which groups and roles have Hidden permissions and which have Visible permissions on each class.

� Hidden—Members of these groups and roles can access the class through workflow, but cannot see its instances in the CI Relationship Viewer or open its form with BMC Remedy User or a web client.

� Visible—Members of these groups and roles can see and access the class in all ways: instances in the CI Relationship Viewer, the class form with BMC Remedy User or 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” on page 79.

WARNING Do not change permissions on the class forms with BMC Remedy Administrator. These permissions will be overwritten the next time a change is made to the class with the Class Manager.

Class permissions are equivalent to AR System form permissions. For more information about AR System form permissions, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

58 Installation and Configuration Guide

Page 59: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Instance permissions

Attribute permissionsYou can specify which groups and roles have View and Change 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 this, select the Allow Any User to Submit option.

You specify attribute permissions from the Permissions tab when viewing an attribute in the Class Manager. For more information, see “Creating an attribute” on page 74.

WARNING Do not change permissions on the attribute fields with BMC Remedy Administrator. These permissions will be overwritten the next time a change is made to the class with the Class Manager.

Attribute permissions are equivalent to AR System field permissions. For more information about AR System field permissions, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

Instance permissionsThe CMDB Data View and CMDB Data Change roles described in “Application roles” on page 56 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, a user must also have row-level security to that instance. Row-level security is controlled by an attribute that exists on every class. There is also an attribute that controls write security.

� CMDBRowLevelSecurity—A user who is a member of a group listed here has permission to view the instance, if they also have the CMDB Data Viewer or CMDB Data Admin role.

� CMDBWriteSecurity—A user who is a member of a group listed here has permission to modify the instance, if they also have row-level security and the CMDB Data Viewer role. This is useful for giving someone write security to a specific instance if you don’t want to give them write security to all instances with one of the CMDB Data Change roles.

For more information about instance permissions, see the Concepts and Best Practices Guide.

Chapter 2 Managing permissions 59

Page 60: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� To specify instance permissions

� Set the value of the CMDBRowLevelSecurity or CMDBWriteSecurity attribute to a group name or list of group names when creating or modifying an instance.

Default instance permissionsDefault instance permissions allow you to give row-level and write security for an entire class instead of specifying them every time you create an instance of the class.

NOTE If you supply values for CMDBRowLevelSecurity and CMDBWriteSecurity when creating an instance, those values are appended to these default permissions. Both values are saved at instance creation.

� To specify default permissions

1 Open the BMC.CORE.CONFIG:BMC_DefaultAccountPermissions form in New mode.

Figure 2-1: BMC.CORE.CONFIG:BMC_DefaultAccountPermissions form

2 In the MATCHAccountID field, type the name of a specific account or type default to match all accounts for which you don’t 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 don’t specify permissions.

60 Installation and Configuration Guide

Page 61: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Default instance permissions

4 In the ASSIGNRowLevelSecurity field, select or type the names of the groups and roles that should have row-level security for new instances, separated by spaces.

These can be any AR System group or role, such as those listed in “Application roles” on page 56. The field menu appends selections to the value currently in the field.

5 In the ASSIGNWriteSecurity field, select or type the names of the groups and roles that should have write security for new instances, separated by spaces.

NOTE 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 you want to create, you might want to type values in other attribute fields for general maintenance of this instance. For instance, you can set permissions on it by entering group names in the CMDBRowLevelSecurity and CMDBWriteSecurity fields or assign it to an account by typing an AccountName value. Do not enter values in the remaining fields.

6 Click Save to save the instance.

For more information about default instance permission, see the Concepts and Best Practices Guide.

Chapter 2 Managing permissions 61

Page 62: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

62 Installation and Configuration Guide

Page 63: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

3

Modifying the data model

This section explains how to add, remove, and modify classes using the Class Manager. Extending your data model should be carefully planned. For suggested strategies, see the Concepts and Best Practices Guide.

The following topics are provided:

� The Class Manager tab (page 64)� Creating a CI class (page 66)� Creating a relationship class (page 68)� Setting data storage and custom properties (page 71)� Working with attributes (page 73)� Setting class permissions (page 79)� Working with indexes on the class form (page 80)� Working with locales (page 82)� Propagating attributes for weak relationships (page 82)� Defining icons and tooltips for a class (page 83)� Change Pending entries (page 87)� Creating Data Model Help with cdm2html (page 88)

Chapter 3 Modifying the data model 63

Page 64: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

The Class Manager tabYou can manage your data model from the Class Manager tab.

Figure 3-1: CMDB Console—Class Manager tab

From here, you can create, view, modify, and delete CI and relationship classes and their attributes. You can also view a list of subclasses for a class.

Viewing or modifying a classYou can modify classes and their attributes, with the exception of a few class characteristics that can only be set when creating a class.

WARNING Never modify classes and attributes directly on class forms using BMC Remedy Administrator. Modifying the BMC Atrium CMDB data model requires more than just editing a form, and you might break some functionality.

You can use BMC Remedy Administrator to modify field layout and labels.

� To view or modify a class

1 From the CMDB Console, click the Class Manager tab to open the Class Manager.

2 From the Class Type list, select CI or Relationship.

3 From the table, select a class and click View.

The details of the class appear in the Class Information window.

64 Installation and Configuration Guide

Page 65: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

The Class Manager tab

4 Enter information in the specific fields that you want to modify.

For information about specific fields, see “Creating a CI class” on page 66 or “Creating a relationship class” on page 68.

5 Click Save, and then click Close.

In addition to modifying classes using the Class Manager, you can add views and workflow to the underlying class forms using BMC Remedy Administrator. For information about creating views, see BMC Remedy Action Request System 7.1.00: Form and Application Objects. For information about creating workflow, see BMC Remedy Action Request System 7.1.00: Workflow Objects.

Deleting a class

WARNING When you delete a class, all subclasses below it are deleted. If it is a CI class, all the relationship classes in which it participates or those subclasses participate are also deleted.

� To delete a class

1 From the CMDB Console, click the Class Manager tab to open the Class Manager.

2 From the Class Type list, select CI or Relationship.

3 From the table, select the class that you want to delete.

4 Click Delete, then click Yes to confirm.

Navigating class hierarchiesWhen viewing a list of classes in the Class Manager, you can move up or down a level in the class hierarchy or go directly to the base class.

� To move down one level

� Double-click a class.

Its direct subclasses are displayed. If it has no subclasses, the table is empty.

� To move up one level

� Click Back.

The direct superclass of the displayed classes, and its sibling classes, are displayed.

� To move to the top level

� Click Go To Root.

All subclasses for the base class are displayed. To see the base class itself, click Show All.

Chapter 3 Modifying the data model 65

Page 66: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Creating a CI classBMC Software recommends that you attempt to use the classes in the Common Data Model (CDM) as they were originally defined. However, there are sometimes good reasons to extend your data model. For best practices on extending the data model, see the Concepts and Best Practices Guide.

For information about relationship classes, see “Creating a relationship class” on page 68.

When you create a class, the Status is automatically set to Change Pending. Status can be any one of the following values:

� Change Pending—The Class Manager has not yet synchronized modifications with the AR System server. When a class is in Change Pending state, you can view the details of the synchronization by clicking View Log from the Class Manager.

� Active—The Class Manager has synchronized modifications with the AR System server.

� Delete Pending—The class will be deleted after changes have been synchronized with the AR System server.

TIP You can choose not to display a class in the Class Manager. This allows you to reduce clutter in the class table by only listing the CDM classes in which you are storing data. To hide a class, set its Exposure property to Hidden.

� To create a class

1 From the CMDB Console, click the Class Manager tab to open the Class Manager.

2 From the Class Type list, select CI.

Figure 3-2: Creating a class

From the Class Type list, select class.

Click Create to create a new class.

66 Installation and Configuration Guide

Page 67: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating a CI class

3 Click Create.

The Class Information window appears.

Figure 3-3: Class Information window

4 Enter the required information in the following fields:

a Namespace—Select a namespace from the list or type a name for a new namespace to use.

For more information about namespaces, see the Concepts and Best Practices Guide.

b Class Name—Enter a name that describes the class.

Class names are limited to alphanumeric characters and underscores.

5 Enter the following optional information:

a Superclass—Optionally, select an existing class. The new class will be a subclass of this class.

b Class Description—Enter a brief description of the class.

c Author—Enter the name of the person who created the class.

d Exposure—Select Visible for the class to be listed in the Class Manager, or select Hidden to hide it. Hidden classes are still accessible to queries, workflow, and reconciliation.

To view hidden classes, select the Show Hidden Classes option in the Class Manager.

6 Set the data storage and, optionally, custom properties on the General tab as described in “Setting data storage and custom properties” on page 71.

After you save the class, you cannot modify most of the fields on the General tab.

Chapter 3 Modifying the data model 67

Page 68: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

7 Optionally, perform the following tasks:

� Create attributes for the class on the Attributes tab as described in “Working with attributes” on page 73.

� Set permissions for the class on the Permissions tab as described in “Setting class permissions” on page 79.

� Create indexes for the class forms on the Indexes tab as described in “Working with indexes on the class form” on page 80.

� Enable auditing for the class on the Auditing tab as described in “To configure auditing for a class” on page 199.

8 Click Save.

A confirmation message appears.

Figure 3-4: Save confirmation dialog box

9 Click Yes to confirm.

The class you created is added to the list of other classes. If there are any errors creating the class, error messages are stored in the Synchronization Log. You can view the Synchronization Log while the class is in Change Pending state. To view the log, select the class in the Class Manager and click View Log.

Creating a relationship classRelationship classes include all the characteristics of a CI class. For information about these characteristics, see “Creating a CI class” on page 66. Relationship classes also have the following characteristics:

� Class 1 and Class 2—The two CI classes that are members of a relationship class. Class 1 is the source member and Class 2 is the destination member. If you need directionless or bi-directionally symmetric relationships, you can create two relationships with Class 1 and Class 2 flipped.

� Roles—If you want to use different or more specific names than “source” and “destination” for the roles that the two member classes play in a relationship class, you can specify them. The role names are used in the relationship class form as prefixes on the field labels of attributes pertaining to each member.

68 Installation and Configuration Guide

Page 69: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating a relationship class

� Cardinality—The BMC Atrium CMDB enforces the cardinality of a relationship class. Fulfilling a “many” cardinality means that multiple instances of the relationship exist.

� 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.

� Weak Reference—Applicable only if the left-hand cardinality is One. When this option is set to Yes, the relationship and its member instances form a composite object where the destination member is a weak entity.

� Cascade Delete—Applicable only if the left-hand cardinality is One. When this option is set to Yes, anytime a source member is deleted (or marked as deleted) the destination member is also deleted (or marked as deleted).

For instructions for creating relationship classes, see the next section, “Creating a relationship class.”

The procedures for modifying and deleting relationship classes are the same as for CI classes. See “Viewing or modifying a class” on page 64 and “Deleting a class” on page 65.

� To create a relationship class

1 From the CMDB Console, click the Class Manager tab to open the Class Manager.

2 From the Class Type list, select Relationship.

Figure 3-5: Class Manager Console—Showing relationships

You see a list of all the relationship classes.

Chapter 3 Modifying the data model 69

Page 70: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

3 Click Create.

The Class Information window appears with the Class Type field set to Relationship and the Status field set to Change Pending.

Figure 3-6: Class Information window—Creating a relationship class

4 Enter the required information in the following fields:

a Namespace—Select a namespace from the list or type a name for a new namespace to use.

For more information about namespaces, see the Concepts and Best Practices Guide.

b Class Name—Enter a name that describes the class.

Class names are limited to alphanumeric characters and underscores.

5 Enter the following optional information:

a Superclass—Select an existing class. The new class will be a subclass of this class.

b Class Description—Enter a brief description of the class.

c Author—Enter the name of the person who created the class.

d Exposure—Select Visible for the class to be listed in the Class Manager, or select Hidden to hide it. Hidden classes are still accessible to queries and workflow.

70 Installation and Configuration Guide

Page 71: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Setting data storage and custom properties

6 In the Relationship Type tab, enter the required information:

a Class 1—Select the CI class that is the source member of the relationship.

b Class 2—Select the CI class that is the destination member of the relationship.

c Cardinality—Select the cardinality for the relationship.

d Role 1—Specify the role Class 1 plays in the relationship.

The names you specify for Role 1 and Role 2 are used in the relationship class form as prefixes on the field labels of attributes pertaining to each member.

e Role 2—Specify the role Class 2 plays in the relationship.

7 Optionally, enter information in the following fields:

a Weak Reference—Select Yes to make this a weak relationship.

b Cascade Delete—Select Yes to automatically mark or delete the destination member when the source member is marked or deleted.

8 Set the data storage and, optionally, custom properties on the General tab as described in “Setting data storage and custom properties” on page 71.

After you save the class, you cannot modify most of the fields on the General tab.

9 Optionally, perform the following tasks:

� Create unique attributes for the class on the Attributes tab as described in “Working with attributes” on page 73.

� Set permissions for the class on the Permissions tab as described in “Setting class permissions” on page 79.

� Create indexes for the class forms on the Indexes tab as described in “Working with indexes on the class form” on page 80.

� Enable auditing for the class on the Auditing tab as described in “To configure auditing for a class” on page 199.

� Propagate attributes from the source class to the destination class on the Relationship Type tab as described in “Propagating attributes for weak relationships” on page 82.

10 Click Save.

Setting data storage and custom propertiesUse the General tab of the Class Information window to set the data storage properties and custom properties, and create locales for a class. For more information about data storage properties, see the Concepts and Best Practices Guide.

NOTE You cannot modify the Abstract, Final, Categorization, and Singleton fields on the General tab after you have created and saved a class.

Chapter 3 Modifying the data model 71

Page 72: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� To set data storage and custom properties

1 When viewing a class in the Class Information window, click the General tab.

Figure 3-7: General tab—Class Information window

2 Optionally, select or enter values in the following fields:

a From the Abstract list, select one of the following options:

� No—Not an abstract class.

� Abstract Regular—The class cannot hold any direct instances and will not cause a form to be created in the AR System.

� Abstract with Data Replication—The class cannot hold any direct instances, but instances of its subclasses will be replicated to a form that holds only the attributes of the superclass.

b Final—Select Yes if you do not want this class to have subclasses. Select No (the default) if you want to allow this class to be subclassed.

c Singleton—Select Yes to limit this class to only one instance. Select No (the default) to be able to create more than one instance of this class.

d Custom Properties—Enter additional information about the class. This field is a list of values formatted as follows:

<list_size>\<prop_id>\<data_type>\<prop_value>\<prop_id>\<data_type>\<prop_value>\...

where <data_type> is an integer representing an AR System data type as defined in the ar.h header file. For example, specify 2 for an integer and 4 for a character string. Therefore, a Custom Properties list containing two values, an integer with ID 1001 and value 5 and a string with ID 1002 and value “blue” would be formatted:

2\1001\2\5\1002\4\blue Dude

For more information about the ar.h file, see the Developer’s Reference Guide.

e Categorization Subclass—Select Yes to specify that this subclass store its attributes on the same AR System form as its superclass, rather than using 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.

3 Optionally, add locale information. See “Working with locales” on page 82.

4 Click Save.

72 Installation and Configuration Guide

Page 73: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with attributes

Working with attributesUse the Attributes tab of the Class Information window to manage the attributes of a class. You can modify unique attributes, but not attributes inherited from a superclass. You can also search for attributes of other classes and associate specific attributes from one class to another class.

You can specify custom enumeration values for a Selection attribute instead of the default, starting at 0 and incrementing by 1. This allows you to “leave space” when creating selections so that you can later add a selection between two others without invalidating existing data by changing the enumeration of existing selections.

An attribute can be one of twelve different data types, each of which has different characteristics to be set on the Characteristics tab of the Attribute window. Table 3-1 lists a set of characteristics for each data type, which are the same characteristics available for an AR System field of the same type. For more information about field types and their characteristics, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

Table 3-1: Characteristics of different data types

Data Type Characteristics

Attachment Field Input LengthAttachment Pool

Attachment Pool Not applicable for this data type

Character Default ValueMax LengthMenu NameMenu StyleQBE MatchPatternList Format

Currency MinMaxDefault ValueFunctional Currency TypesAllowable Currency Types

Date Default ValueMenu NameMenu StyleQBE MatchPattern

Chapter 3 Modifying the data model 73

Page 74: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Creating an attributeYou can add attributes to a new or existing class.

NOTE New attributes that you create are not automatically visible on the class forms. For information about laying out attribute fields on class forms, see “Controlling the layout of class forms” on page 186.

Date/Time Default ValueMenu NameMenu StyleQBE MatchPattern

Decimal Min MaxDefault ValuePrecision

Diary Default ValueMenu NameMenu StyleQBE MatchPattern

Integer MinMaxDefault Value

Real MinMaxDefault ValuePrecision

Selection (radio button, list, checkbox) Enum TypeValuesID ValuesDefault Value

Time Default ValueMenu NameMenu StyleQBE MatchPattern

Table 3-1: Characteristics of different data types

Data Type Characteristics

74 Installation and Configuration Guide

Page 75: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with attributes

� To create an attribute

1 Create a class.

See “Creating a CI class” on page 66.

2 Click the Attributes tab.

3 Select the Hide Display-Only Attributes checkbox if you do not want to see display-only fields in the Attributes table.

Figure 3-8: Attributes tab—Class Information window

4 Click Add.

The Attribute Information window appears with the Database tab as the active tab.

Figure 3-9: Database tab—Attribute Information window

5 On the Database tab, enter the following required information:

a Data Type—Select the data type for the class. Data type is the type of information that the attribute contains.

NOTE You cannot enter information in the Characteristics tab until you specify a data type.

Click Add to create a new attribute for a class.

Check the Hide Display-Only Attributes option to temporarily hide display-only fields in the table.

Chapter 3 Modifying the data model 75

Page 76: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

b Attribute Name—Enter the name of the attribute.

Make the name descriptive and indicative of the function. Names can be as many as 80 characters. Alphanumeric characters and underscores are allowed.

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 Administrator to create or edit the appropriate view of the class form. For more information about AR System views, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

6 Enter the following optional information:

a Namespace

Choose a namespace if this attribute should be in a different namespace from the class that contains it. To use the class namespace, leave this field blank.

b Field ID

This is the 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 for you, leave this field blank.

c Entry Mode

Entry mode 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:

� Display only—The attribute is used as a temporary field. The value of the attribute is not stored in the database.

� Optional—You can enter information for the attribute or leave it empty.

� Required—The attribute value must be filled in when a user creates an instance. The attribute appears with a bold label in the class form.

d Hidden—Select if you want the attribute to be hidden on the class form.

e Custom Properties—Enter additional information about the attribute. This field is a list of values formatted as follows:

<list_size>\<prop_id>\<data_type>\<prop_value>\<prop_id>\<data_type>\<prop_value>\...

where <data_type> is an integer representing an AR System data type as defined in the ar.h header file. For example, specify 2 for an integer and 4 for a character string. Therefore, a Custom Properties list containing two values, an integer with ID 1001 and value 5 and a string with ID 1002 and value “blue” would be formatted:

2\1001\2\5\1002\4\blue

For more information about the ar.h file, see the Developer’s Reference Guide.

76 Installation and Configuration Guide

Page 77: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with attributes

f Audit Option—Select whether changes to this attribute value trigger an audit (Audit), whether the attribute is written to the audit form (Copy), or both (Audit and Copy). The default is None. For more information about these options, see “Auditing instance history” on page 198.

g Description—Type a description of the attribute.

7 Click the Characteristics tab.

Figure 3-10: Characteristics tab—Attribute Information window

8 For Character attributes, fill in the following optional fields. For other data types, the optional fields are listed in Table 3-1 on page 73.

a Default Value—The value that will be saved for the attribute when a new instance is created if the user does not enter a value. The Default Value can be a static value or one of the keywords from the field menu. It must be of the same data type as the attribute.

b Max Length—The maximum amount of characters a user can enter in the attribute. The default is 255.

c Menu Name—Select an AR System menu to attach to the attribute to allow users to select a value.

d 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

Chapter 3 Modifying the data model 77

Page 78: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

e QBE Match—Select the Query By Example (QBE) matching to be used when searching on this attribute from the class form. The default is Anywhere.

� Anywhere—The search string matches if it is found anywhere in the attribute value.

� Leading—The search string matches if it is found at the beginning of the attribute value.

� Equal—The search string matches if it is exactly the same as the attribute value.

f Pattern—Select a pattern if you want to allow only certain types of values in the attribute, such as alphabetic characters or selections from an attached menu.

g List Format—If you want the attribute to contain a list of character values, enter the maximum 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.

9 Click the Permissions tab to set permissions for the attribute.

Figure 3-11: Permissions tab—Attribute Information window

78 Installation and Configuration Guide

Page 79: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Setting class permissions

10 Enter the following optional information:

a Attribute View Permissions—Select the groups and roles who have permissions to view the attribute.

b Attribute Change Permissions—Select the groups and roles who have permissions to change the attribute.

NOTE These fields accept both names and IDs of groups and roles, and the default permissions shipped with BMC Atrium CMDB are specified as IDs. For example, the role ID -1090 corresponds to the CMDB Data View All role. You can map an ID to its corresponding name by searching the Group and Roles forms.

c Allow Any User to Submit—Select this option to allow all users to set the attribute’s value when creating an instance of the class, even if they don’t have Change permission.

11 Click Save and then click Close.

Viewing, modifying, and deleting attributesYou can view, modify, and delete existing attributes of a class. However, you can only modify or delete unique attributes, not attributes inherited from a superclass.

Setting class permissionsYou use the Permissions tab of the Class Information window to manage the permissions for a class. For more information about class permissions and other BMC Atrium CMDB permissions, see the Concepts and Best Practices Guide.

� To specify permissions for a class

1 View a class.

See “Viewing or modifying a class” on page 64.

2 Click the Permissions tab on the Class Information window.

Figure 3-12: Permissions tab—Class Information window

3 In the Class Definition Hidden Permissions field, select one or more groups to have access to the class without being able to see it in lists of classes.

Chapter 3 Modifying the data model 79

Page 80: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 In the Class Definition Visible Permissions field, select one or more groups to have access to the class and be able to see it in lists of classes.

5 Click Save.

NOTE These fields accept both names and IDs of groups and roles, and the default permissions shipped with BMC Atrium CMDB are specified as IDs. For example, the role ID -1090 corresponds to the CMDB Data View All role. You can map an ID to its corresponding name by searching the Group and Roles forms.

Working with indexes on the class formYou use the Indexes tab of the Class Information window to define the indexes for a class form. You can create indexes on unique attributes only. To index an inherited attribute, create the index on the superclass. Display-only attributes cannot be indexed, because no values are stored for them.

Indexing can reduce database search time. You should index attributes that users search on frequently. If you create an index for a Character attribute, you can save search time by using a QBE Match setting of Leading or Equal instead of Anywhere.

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 created for it. The greater the number of indexes created for the class, the more time and disk space are required. Creating and modifying instances also takes longer for classes with many indexes.

Creating 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, you might want to avoid creating indexes during normal production hours. For more information about AR System indexes, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

Creating an indexThis section explains how to create indexes for a class.

NOTE You can also view, modify, or delete an index from the Indexes tab when viewing a class.

80 Installation and Configuration Guide

Page 81: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with indexes on the class form

� To create an index for a class

1 View a class.

See “Viewing or modifying a class” on page 64.

2 Click the Indexes tab.

Figure 3-13: Index tab—Class Information window

3 Click Add.

The Index Information window appears.

Figure 3-14: Index Information window

4 In the Index Name field, enter a name for the index.

5 From the Fields On Form list, select the fields to include in the index, and click Add.

The selected fields are added to the Fields in Index list.

6 From the Unique list, select Yes or No.

� Yes—The index is treated as a unique index and all values in the field need to be unique.

� No—Multiple instances can have the same value in the selected field.

Chapter 3 Modifying the data model 81

Page 82: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

7 From the Primary Key list, select Yes or No to specify whether the index is the primary key for this class.

8 To create additional indexes for this class, click New and repeat steps 4 through 7 for each index.

9 Click Close.

The new indexes are added to the index table.

Working with localesYou can add locale information for a class on the General tab of the Class Information window. However, in version 2.1.00, this information is stored but not used.

Propagating attributes for weak relationshipsYou 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 CI while viewing a destination CI, without having to follow the relationship and view the source CI.

To propagate a source attribute, you must map it to an existing attribute on the destination class. You should create new attributes on the destination class for this purpose, rather than map to an attribute provided by the CDM. This allows CDM attributes to serve their intended purpose and prevents you from accidentally overwriting propagated source CI values with values from somewhere else.

The attribute 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.

� To propagate attributes for a relationship

1 Create an attribute on the destination class for each attribute that will be propagated from the source class.

2 If a weak relationship class does not already exist between the two classes, create one.

See “Creating a relationship class” on page 68.

3 View the relationship class in the Class Information window.

See “Viewing or modifying a class” on page 64.

82 Installation and Configuration Guide

Page 83: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Defining icons and tooltips for a class

4 On the Relationship Type tab, click Weak Reference Propagated Attributes.

The Weak Reference Propagated Attributes window appears.

Figure 3-15: Weak Reference Propagated Attributes window

5 From the Class 1 list, select the source attribute to propagate and from the Class 2 list, select the destination attribute to map it to.

6 Click Map.

The attribute is added to the Mapped Relationship table.

7 Repeat steps 5 and 6 for each attribute you want to propagate.

8 To remove a mapped attribute, select it from the Mapped Relationship table and click Remove.

9 Click Save to save the mappings.

10 Click Save to save the class.

Defining icons and tooltips for a classThe CI Relationship Viewer displays a specific icon to represent each instance, and when you mouse over an instance it also displays a tooltip containing attribute values for the instance. Both the icon and the list of attributes in the tooltip are defined against a specific class, and you can add and modify icons and tooltips in your BMC Atrium CMDB.

Icons and tooltips are both stored as instances of the BMC.CORE.CONFIG:BMC_UIComponent class. You specify the properties of an icon or tooltip using the attributes with names beginning with Component.

Chapter 3 Modifying the data model 83

Page 84: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Icons There is an instance of BMC_UIComponent for each CI class in the CDM to define an icon to represent that class in the CI Relationship Viewer. 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 is not part of the CDM, that class is represented in the CI Relationship Viewer by a question mark icon.

You can use multiple 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 your icons for a locale where your original colors carry an unwanted meaning.

� Display different icons in different data consumer products. Because instances of BMC_UIComponent are available to any BMC Atrium CMDB client just like instances in your data model, those clients can make use of icons you store here. For example, BMC Foundation Discovery and BMC Topology Discovery displays these icons in its interface.

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 CI Relationship Viewer will display the icon of the nearest superclass that has an icon defined.

Figure 3-16: BMC_UIComponent icon instance

84 Installation and Configuration Guide

Page 85: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Defining icons and tooltips for a class

� To define an icon

Create or modify an instance of BMC_UIComponent, entering values for these attributes:

� ClassId—Type BMC_UICOMPONENT.

� ComponentAttachment—Attach the image file of your icon.

� 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—Optionally, type a name for the icon.

� ComponentQual—Optionally, type a qualification that specifies which instances of the class in ComponentRelatedClassId are represented by this icon. If no ComponentQual is specified, this icon represents 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”.

� If you use a selection attribute in the qualification, any references to its values must be in enumerated, not text, format. For example, to display a different icon for BMC_ComputerSystem when the value of an instance's PrimaryCapability attribute is "Storage" you must use this qualification: $PrimaryCapability$ = 3.

� ComponentRelatedClassId—Type the class ID of the class this icon represents. This can be different from the class name.

� 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—Optionally, 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.

� In this release, ComponentTag2 is stored but not used.

� ComponentTag3—Optionally, 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.

Chapter 3 Modifying the data model 85

Page 86: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� 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 CI Relationship Viewer, 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.

New and changed icons appear in the CI Relationship Viewer within ten minutes. To make them appear sooner, restart your Mid Tier.

Tooltips There is an instance of BMC_UIComponent for each CI class in the CDM to define a tooltip listing attribute values for that class in the CI Relationship Viewer. You can modify these tooltips, create new tooltips to represent classes outside of the CDM, or create multiple tooltips for the same class.

Figure 3-17: BMC_UIComponent tooltip instance

� To define a tooltip

� Create or modify an instance of BMC_UIComponent, entering values for these attributes:

� ClassId—Type BMC_UICOMPONENT.

� 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—Optionally, type a name for the tooltip.

86 Installation and Configuration Guide

Page 87: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Change Pending entries

� ComponentQual—Optionally, 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. This can be different from the class name.

� 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 CI Relationship Viewer.

� 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 CI Relationship Viewer, the tooltip with the highest precedence value is displayed.

� ComponentType—Select Tooltip.

New and changed tooltips appear in the CI Relationship Viewer within ten minutes. To make them appear sooner, restart your mid tier.

Change Pending entriesWhen you add or modify a class or attribute, a new entry appears in the table in the Class Manager Console with a status of Change Pending. If you are modifying an existing class, its original entry with Active status remains in the table. These two separate entries are not an error and do not represent duplicate classes: when the changes have been synchronized with the Class Manager Java API server, the Change Pending entry is merged into the Active entry and disappears from the Class Manager Console.

NOTE When modifying an existing class, each attribute you add or change results in a Change Pending entry for that class. For example, if you add three attributes and then save your changes, three Change Pending entries appear in the Class Manager Console.

You can view error messages from the Class Manager, cancel a failed pending change, and manually synchronize BMC Atrium CMDB metadata.

Chapter 3 Modifying the data model 87

Page 88: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Viewing Class Manager error messagesIf any errors resulted from creating or modifying classes, you can view them from the Class Manager interface or a log file. For more information about this, see “Class Manager” on page 196.

Manually synchronizing metadataAfter any change to a class or attribute is made with the Class Manager or a BMC Atrium CMDB API program, the class definitions are automatically synchronized with the AR System forms that hold class data and the workflow that enforces hierarchy and other rules.

If you believe that your class definitions have become out of synchronization with the class forms and workflow, you can manually start the synchronization process.

� To synchronize metadata

� Submit an entry to the RE:Job Operation form, setting the Command field to Sync-Meta-Data. Leave the Job Name field empty.

NOTE No Save button appears on this form in BMC Remedy User. To save an entry, press Ctrl+Enter or choose Actions > Save.

Creating Data Model Help with cdm2htmlBMC Atrium CMDB comes with Data Model Help that describes the classes and attributes in the CDM. In version 2.1.00, this help is now generated from a live BMC Atrium CMDB data model using the cdm2html utility. If you install other BMC Software products that extend the data model of your BMC Atrium CMDB or if you add classes or attributes yourself, your Data Model Help no longer reflects your actual data model. Cdm2html enables you to update your Data Model Help to reflect your current data model.

The cdm2html utility creates an HTML-based help system that provides information about your data model including class inheritance, attributes, and characteristics such as whether a class is abstract or a categorization class.

This help includes the descriptions found in the Class Manager in the Class Description field for classes and the Description field for attributes. If you have created your own classes or attributes, you should enter meaningful descriptions for them in the Class Manager before running cdm2html.

88 Installation and Configuration Guide

Page 89: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating Data Model Help with cdm2html

PrerequisitesCdm2html is a BMC Atrium CMDB Java API client, and requires the following:

� Java Runtime (J2SE) version 1.5 or higher

� Apache Xalan-Java version 2.7 or higher. This is bundled with BMC Atrium CMDB and installed in <CMDB_install_directory>\utils.

� All prerequisites for BMC Atrium CMDB Java API and AR System Java API clients as listed in the JavaAPI_Overview.html file of the Javadoc API Help.

RestrictionsCdm2html 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 your 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 your existing folder before generating.

� It is compatible only with BMC Atrium CMDB version 2.1.00.

� It does not create help for Hidden or Display Only attributes.

� Setting the Exposure to Hidden for a class in the Class Manager does not prevent cdm2html from generating help for the class. Help is generated for both Visible and Hidden classes.

Running with a Java commandThis section explains how to directly invoke cdm2html with a Java command from a Windows or UNIX command prompt. You must either add the following paths and files to your CLASSPATH environment variable before running cdm2html or include the -cp parameter at runtime to specify them:

� <Java_install_dir>\bin\java

� <CMDB_install_dir>\utils

� <CMDB_install_dir>\sdk\bin

� <CMDB_install_dir>\utils\cdmutil.jar

� <CMDB_install_dir>\sdk\bin\cmdbapi21.jar

� <CMDB_install_dir>\utils\xalan.jar

� <CMDB_install_dir>\sdk\bin\arapi71.jar

� <CMDB_install_dir>\sdk\bin\arcmn71.jar

� <CMDB_install_dir>\sdk\bin\arrpc71.jar

� <CMDB_install_dir>\sdk\bin\arutil71.jar

� <CMDB_install_dir>\sdk\bin\oncrpc.jar

� <CMDB_install_dir>\sdk\bin\commons-beanutils.jar

Chapter 3 Modifying the data model 89

Page 90: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� <CMDB_install_dir>\sdk\bin\commons-codec-1.3.jar

� <CMDB_install_dir>\sdk\bin\commons-collections-3.2.jar

� <CMDB_install_dir>\sdk\bin\commons-configuration-1.3.jar

� <CMDB_install_dir>\sdk\bin\commons-digester-1.7.jar

� <CMDB_install_dir>\sdk\bin\commons-lang-2.2.jar

� <CMDB_install_dir>\sdk\bin\commons-logging-1.1.jar

� <CMDB_install_dir>\sdk\bin\spring.jar

� <CMDB_install_dir>\sdk\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 <CMDB_install_directory>\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 current 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 hostname or IP address. The default value is localhost.

� -user—The AR System user to perform the operation. The default value is Demo. The user 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 AR System portmapper.

90 Installation and Configuration Guide

Page 91: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating Data Model Help with cdm2html

Here is an example command on Windows, assuming you did not add anything to CLASSPATH:

java -cp C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils>"C:\Program Files\Java\jdk1.5.0_11\bin\java" -cp "C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils\;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils\cdmutil.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\cmdbapi21.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils\xalan.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\arapi71.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\arcmn71.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\arrpc71.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\arutil71.jar;C:\Program Files\AR SystemApplications\MYSERVER\BMC Atrium CMDB\sdk\bin\oncrpc.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-beanutils.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-codec-1.3.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-collections-3.2.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-configuration-1.3.jar;C:\Program Files\AR System Applications\MYSERVER\BMCAtrium CMDB\sdk\bin\commons-digester-1.7.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-lang-2.2.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\commons-logging-1.1.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\spring.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin\log4j-1.2.14.jar;C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin" com.bmc.cmdb.cdmutil.cdm2html -outdir .HTMLHelp -indir C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils -user SysAdmin -password 1xR34Ut8

After running the utility, the outdir directory will contain a zipped version of the help and an html folder containing the unzipped help.

Running with the cdm2html.bat file on WindowsOn Windows, you can avoid typing in 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 environment variables:

� JAVA_HOME—Set to your Java installation directory, such as C:\Program Files\Java\jdk1.5.0_11\bin\java

� CMDBSDK—Set to your BMC Atrium CMDB SDK installation directory, such as C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\sdk\bin

The batch file is located in <CMDB_install_dir>\utils. Its parameter syntax is the same as for the direct Java command. Here is an example command:

cdm2html.bat -outdir .HTMLHelp -indir C:\Program Files\AR System Applications\MYSERVER\BMC Atrium CMDB\utils -user SysAdmin -password 1xR34Ut8

After running the utility, the outdir directory will contain a zipped version of the help and an html folder containing the unzipped help.

Chapter 3 Modifying the data model 91

Page 92: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

92 Installation and Configuration Guide

Page 93: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

4

Configuring federated data

This section explains how to configure links between classes or CIs and data in an external data store.

The following topics are provided:

� The Federation Manager tab (page 94)� Creating a federated product (page 95)� Creating a federated interface (page 96)� Linking a class or CI to a federated interface (page 99)

Chapter 4 Configuring federated data 93

Page 94: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

The Federation Manager tab The Federation Manager lets you manage the federated data that is available from instances in BMC Atrium CMDB.

Figure 4-1: CMDB Console—Federation Manager tab

From here, you can create, view, and modify federated products, federated interfaces, and federated links. For more information about these objects and how they interact, see the Concepts and Best Practices Guide.

For information about viewing federated data from a CI instance, see the User’s Guide.

94 Installation and Configuration Guide

Page 95: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating a federated product

Creating a federated productEach application that supplies federated data to BMC Atrium CMDB is considered a federated product. A federated product can supply more than one type of federated data, and therefore be linked to more than one federated interface.

� To create a federated product

1 From the CMDB Console, click the Federation Manager tab to open the Federation Manager.

2 In the navigation pane, under the Manage heading, click the Federated Products link.

The Federated Products window appears. The table shows all existing federated products, and the fields below show the details for the selected product.

Figure 4-2: Federated Products window

3 Click New.

The fields in the Details area are reset for you to type new information.

4 In the Name field, type a name for the product you want to register.

This name appears in the context menu for a CI when you right-click the CI in the CI Relationship Viewer.

5 In the Product Code field, type a product code for the application you want to register.

The Product Code can be any string you like, up to 254 characters. For example, the product code BMC uses for BMC Remedy Change Management is BMC_AR_CHANGE.

6 In the Description field, type a description of the application you want to register.

Chapter 4 Configuring federated data 95

Page 96: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

7 Click Save.

Your new entry is added to the federated products table.

Creating a federated interfaceA federated interface specifies the method for accessing a particular type of federated data from a specified federated product. It is the connection between your CIs and the federated data about them.

Federated interfaces can link to either a specific CI or an entire CI class. This gives you the ability to create one federated interface at design time instead of having to create a new interface every time you create an instance of the CI class.

A class-level federated 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 the Concepts and Best Practices Guide.

A federated interface uses one of these access methods to launch its federated product:

� AR—A query to an AR System form. You specify the server, form, view, and query string, and choose whether to launch the query in BMC Remedy User or a web client.

� URL—A Uniform Resource Locator (URL)

� Run Process—An executable on the BMC Atrium CMDB server machine. You can specify parameters in the access string.

� Manual—Instructions for finding data manually

� To create a federated interface

1 From the CMDB Console, click the Federation Manager tab to open the Federation Manager.

96 Installation and Configuration Guide

Page 97: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating a federated interface

2 In the navigation pane, under the Manage heading, click the Federated Interfaces link.

The Federated Interfaces window appears. The table shows all existing federated interfaces, and the fields below show the details for the selected interface.

Figure 4-3: Federated Interfaces window

3 Click New.

The fields in the Details area are reset for you to type new information.

4 In the Name field, type a name for this federated interface.

5 From the Owner Product field menu, choose the name of the product that supplies the data.

6 In the Description field, type a description for this federated interface.

7 In the Access Method list, select the method you want to use.

8 If your Access Method is:

� AR, complete the following steps:

a In the Launch Method list, select the launch method you want to use when the federated interface is launched from an API program:

� Native—Launch the query in BMC Remedy User

� Web—Launch the query in a browser

When the federated interface is launched from the CI Relationship Viewer, the form is opened in the same client that the CI Relationship Viewer is using.

b In the Server Name field, type the name of the server containing the form.

Chapter 4 Configuring federated data 97

Page 98: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

c In the Form Name field, type the name of the AR System form you want to query.

d In the View Name field, type the view of the form to display.

e In the Query field, type the qualification you want to use. Enclose field names in single quotes ('). You can use any combination of the following keywords:

� $<Attribute-Name>$—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 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, type the URL you want to use in the Access String field. For example,

http://xyz.com/catalog?id=$#KEY#$&name=$Name$

You can use any of the keywords listed for the Query field of the AR access method.

� Run Process, type the path to the executable in the Access String field. For example:

@@:c:\Program Files\WinZip\WINZIP32.EXE

You can use any of the keywords listed for the Query field of the AR access method.

NOTE Web clients cannot run processes on their local machine. To create a Run Process federated interface that can be launched from web clients, specify the @@ or @<server> option to run the process on the AR System server. For more information, see BMC Remedy Action Request System 7.1.00: Workflow Objects.

� Manual, type informative text in the Access String field. For example:

To find the master password for all accounts, open the company safe deposit box.

9 Click Save.

The federated interface appears in the table.

98 Installation and Configuration Guide

Page 99: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Linking a class or CI to a federated interface

Linking a class or CI to a federated interfaceA federated link connects a federated interface to a CI or class. A class-level link can optionally include a qualification that selects which of its instances are linked.

NOTE Federated links are not bidirectional. They only allow you to access external data from BMC Atrium CMDB. Though some BMC Software 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.

� To create a federated link

1 From the CMDB Console, click the Federation Manager tab to open the Federation Manager.

2 In the navigation pane, under the Manage heading, click the Federated Links link.

The Federated Links window appears. The table shows all existing federated links, and the fields below show the details for the selected link.

Figure 4-4: Federated Links window

3 Click New.

The fields in the Details area are reset for you to type new information.

Chapter 4 Configuring federated data 99

Page 100: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 In the Link Method list, select a Class or Instance link.

TIP A Class link is usually better because it allows multiple instances to access external data from a single federated link rather than requiring a link for each instance.

5 In the Source box, click Browse to browse for the class or instance to link.

a If your Link Method is Class, select the class from the Select Class window and then click OK.

Figure 4-5: Select Class window

b If your Link Method is Instance, search for the instance from the Select Instance window and then click OK.

The Select Instance window works like the Quick Search window on the CMDB Console tab. For information about using the Quick Search window, see the User’s Guide.

Figure 4-6: Select Instance window

6 In the Destination box, click Browse to browse for the federated interface to link.

100 Installation and Configuration Guide

Page 101: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Linking a class or CI to a federated interface

7 Search for the interface using the Select Instance window and then click OK.

Because the federated interface is an instance of the BMC.CORE:BMC_FederatedInterface class, the Class Type, Namespace, and Class Name fields are preset and disabled.

8 If your Link Method is Class, type a qualification in the Qualification field to specify which instances of the Source class are linked.

For example, type 'MarkAsDeleted' = $NULL$ to restrict the link to instances that have not been soft deleted.

9 In the Description field, type a description for the link.

10 Click Save.

The federated link appears in the table.

Chapter 4 Configuring federated data 101

Page 102: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

102 Installation and Configuration Guide

Page 103: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

5

Reconciling data

This section discusses 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.

The following topics are provided:

� The Reconciliation Manager tab (page 104)� Reconciliation quick start (page 105)� Default reconciliation definitions (page 112)� Identifying data across datasets (page 114)� Merging datasets (page 123)� Comparing datasets (page 133)� Creating datasets (page 141)� Copying datasets (page 143)� Renaming datasets (page 148)� Deleting data (page 150)� Purging soft-deleted data (page 153)� Working with jobs (page 155)� Creating Qualification groups (page 164)� Using namespaces in reconciliation (page 167)� Dynamic dataset and qualification values (page 168)� Server settings (page 170)� Exporting definitions (page 173)

Chapter 5 Reconciling data 103

Page 104: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

The Reconciliation Manager tabYou can manage the reconciliation of data between datasets from the Reconciliation Manager tab.

Figure 5-1: CMDB Console—Reconciliation Manager tab

From here, you can create, view, modify, and delete jobs, groups, and other reconciliation definitions. For information about creating definitions, see the appropriate section:

� “Creating Qualification groups” on page 164

� “Creating an Identification group” on page 115

� “Creating an Identification activity” on page 118

� “Creating a Precedence group” on page 125

� “Creating a Dataset Merge Precedence set” on page 129

� “Creating a Merge activity” on page 130

� “Creating a Comparison activity” on page 135

� “Creating a job” on page 155

� “Creating datasets” on page 141

104 Installation and Configuration Guide

Page 105: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Reconciliation quick start

Reconciliation quick startThis section gives you the high-level steps to set up basic reconciliation between three data sources, pointing to other sections for detailed procedures.

The following scenario is used for examples throughout this quick start:

� You have two discovery applications called Alpha and Beta, each of which populates a dataset by the same name in BMC Atrium CMDB. You also have a third dataset, Gamma, in which you manually modify CIs periodically.

� Discovery Alpha and Discovery Beta discover many of the same things, but slightly differently. Alpha discovers more detail about hardware while Beta discovers more detail about software.

� You want to merge data from the Alpha, Beta, and Gamma datasets into the BMC Asset dataset, which represents your current known environment and which you use as your production dataset to make business decisions.

� To set up reconciliation for the first time

Step 1 Create Identification groups. One or more should identify data in the Alpha dataset against data in the BMC Asset dataset, one or more should identify data in Beta against BMC Asset, and one or more should identify data in Gamma against BMC Asset.

Because you will be using independent Merge activities to merge data from your three source datasets into BMC Asset, you do not need an Identification group that identifies them against each other. For information about independent Merge activities, see “Independent Merge activities and AttributeDataSourceList” on page 123.

If your data is designed so that you can use the same identification rules to identify data for every class, then you can use a single Identification group for each dataset, defining that group for the BMC_BaseElement class so that it applies to all other CI classes in the Common Data Model (CDM) through inheritance as shown in Figure 5-2. If you cannot use the same rules across all classes, you need an Identification group for each class that uses a different rules.

Chapter 5 Reconciling data 105

Page 106: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 5-2: Sample Identification group for all classes

This Identification group contains only one rule, matching on the TokenId attribute. This rule is shown in Figure 5-3. You will probably want some more “fallback” rules in your Identification groups to attempt to identify a CI by some other attributes if your primary rule fails to find a match.

Figure 5-3: Sample Identification rule

For more information about Identification groups, see “Identifying data across datasets” on page 114.

106 Installation and Configuration Guide

Page 107: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Reconciliation quick start

Step 2 Assign precedence values from 0 to 1000 for all data in all three source datasets.

Precedence value determines which source dataset supplies the value to the target dataset in a marge, with the highest value winning. Your precedence scheme could be simple or complex, depending on your two discovery applications and your business rules. In our example scenario where Alpha has more hardware information and Beta more software information, you might set precedence as shown in Table 5-1. This gives Alpha a higher precedence than Beta for all classes except BMC_ApplicationSystem, BMC_Software, and their subclasses. Gamma has a higher precedence than both discovery datasets because you have decided that manually entered data is more trusted than discovered data.

This example only shows precedence values at the overall level and the class level, but you can also set them at the attribute level. For example, if you want the Alpha dataset to supply the Name value for software CIs, you could add attribute precedences for Beta for BMC_ApplicationSystem.Name and BMC_Software.Name with a value of 300. This brings Beta back down below Alpha for these two attributes, superceding the class precedences where Beta is higher.

NOTE Carefully choose which dataset gets the highest precedence value in each situation. The behavior described in “Independent Merge activities and AttributeDataSourceList” on page 123 means that once this dataset has supplied a value for an attribute, your other datasets can never overwrite that value. You would need to manually intervene to change the value.

Table 5-1: Example precedence values

Scope Alpha precedence value

Beta precedence value

Gamma precedence value

Overall 400 300 500

BMC_ApplicationSystem

450

BMC_Software 450

Chapter 5 Reconciling data 107

Page 108: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Step 3 Create Precedence groups. You need three of them, one for each dataset.

Use the value from the Overall row in Table 5-1 for the group’s Precedence Value, as shown in Figure 5-4.

Figure 5-4: Sample Precedence group for Beta dataset

Add class or attribute precedences such as the one shown in Figure 5-5 to specify exceptions from the dataset-level precedences established by the group.

Figure 5-5: Sample class precedence for Beta dataset

For more information about creating Precedence groups, see “Creating a Precedence group” on page 125.

108 Installation and Configuration Guide

Page 109: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Reconciliation quick start

Step 4 Create a Dataset Merge Precedence set to associate each Precedence group with the appropriate dataset, as shown in Figure 5-6.

Figure 5-6: Sample Dataset Merge Precedence set

For information about creating a Dataset Merge Precedence set, see “Creating a Dataset Merge Precedence set” on page 129.

Step 5 Create a job. This job will be used to identify data in Dataset Alpha and merge it into BMC Asset.

For information about creating a job, see “Creating a job” on page 155.

Step 6 Add an Identification activity to the job to identify data in the Alpha dataset.

Chapter 5 Reconciling data 109

Page 110: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Add the Alpha dataset to the Datasets and Identification Groups table paired with each of the Identification groups you created in step 1 on page 105, as shown in Figure 5-7. Add BMC Asset once, not paired with any group.

Figure 5-7: Sample Identification activity for Alpha

For information about creating an Identification activity, see “Creating an Identification activity” on page 118.

Step 7 Add a Merge activity to the job to merge data from the Alpha dataset to BMC Asset.

110 Installation and Configuration Guide

Page 111: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Reconciliation quick start

Add the Alpha dataset to the Source Datasets table. Below the table, select the Dataset Merge Precedence set you created in step 4 on page 109 and specify BMC Asset as the Target Dataset, as shown in Figure 5-8. Give this activity a higher Sequence number than the Identification activity so that it will run after that activity.

Figure 5-8: Sample Merge activity for Alpha

Chapter 5 Reconciling data 111

Page 112: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

For information about creating a Merge activity, see “Creating a Merge activity” on page 130. Figure 5-9 shows how the Activities tab of your job might look.

Figure 5-9: Sample activities for Alpha

Step 8 Assign a schedule to this job so that it will run.

You should schedule the job to run shortly after Discovery Alpha finishes loading data into BMC Atrium CMDB. For information about creating a job schedule, see “To create a job schedule” on page 157.

Step 9 Repeat steps 5 through 8 to create and configure jobs to reconcile the Beta and Gamma datasets.

You have successfully set up basic reconciliation for your datasets. Consider adding a Purge or Delete activity to prune unneeded or duplicate instances from source datasets before your Identification and Merge activities. For more information, see “Purging soft-deleted data” on page 153 and “Deleting data” on page 150.

Default reconciliation definitionsThis section explains the purpose of the various jobs, activities, and other definitions that ship with BMC Atrium CMDB. It also gives best practices for using them and pitfalls to avoid.

112 Installation and Configuration Guide

Page 113: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Default reconciliation definitions

BMC Atrium CMDB ships with three default jobs: BMC Sample - Purge, BMC Asset - Purge, and BMC Sample - Identification and Merge.

NOTE None of these jobs have schedules, so they will not run unless you add a schedule or start them using another method.

BMC Sample - PurgeThis job is defined for the BMC Sample dataset, and therefore is not intended for production use. It is intended to show a Purge activity that purges instances from a source dataset only if they are also soft deleted in a target dataset. For information about Purge activities, see “Purging soft-deleted data” on page 153.

BMC Asset - PurgeThis job purges all soft deleted instances with a reconciliation identity from the BMC Asset dataset. The Purge activity does not have the Verify Soft Deleted in Target Dataset option selected because in most installations, BMC Asset is itself the target dataset. You might want to add a schedule to this job so that it can prune BMC Asset for you. If you do, consider adding a Qualification group to restrict the Purge activity to instances that were last modified a certain interval ago. This prevents you from deleting instances that are likely to be rediscovered and unmarked as deleted in a source dataset.

BMC Sample - Identification and MergeThis job is intended to show a complete reconciliation cycle for the BMC Sample dataset, and contains activities that perform these tasks:

1 Identify BMC Sample data against BMC Asset.

Like the example in the section “Reconciliation quick start,” this one uses a single Identification group for all classes and relies on one Identification rule with no fallback.

2 Merge BMC Sample data into BMC Asset.

BMC Sample is given a precedence value of 10, almost the lowest possible, so that it won’t overwrite data in BMC Asset that came from real-life source datasets. The exception to that is the MarkAsDeleted attribute, which has a precedence value of 200 so soft deletes you perform in BMC Sample are more likely to propagate to BMC Asset.

Chapter 5 Reconciling data 113

Page 114: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

3 Purge soft-deleted instances from BMC Sample if also soft deleted in BMC Asset.

After a merge, you might want to get rid of instances that no longer exist in the source dataset. Rather than a Purge activity directly added to this job, this is implemented here as an Execute Job activity that calls the BMC Sample - Purge job. This allows you the flexibility of performing a purge without the Identification and Merge activities, and doesn’t require you to create another Purge activity.

4 Purge the same soft-deleted instances from BMC Asset.

If you purge soft-deleted instances from a source dataset, it’s a good idea to also purge them from the target dataset to avoid leaving behind orphan instances that will always remain marked as deleted. This purge is also implemented here as an Execute Job activity.

Identifying data across datasetsYou create an Identification activity to establish a common identity across instances in two or more datasets, confirming that they are the same real-life configuration item. The identity is stored as the ReconciliationIdentity attribute in each instance.

An Identification activity compares instances from two or more datasets and assigns the same identity to those instances that match. The identity of an instance in the master dataset for that activity is copied to matching instances in the other datasets. The master dataset should usually be the same dataset that is the target of your Merge activities. If you will use independent Merge activities to merge each of your source datasets into the target, then you should also use independent Identification activities, each of which identifies one dataset against that target.

An Identification activity assigns identity to an instance according to one of these scenarios:

� If one or more instances match an instance in the master dataset that already has an identity, that identity is applied to the other instances.

� If one or more instances match an instance in the master 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 master dataset.

� If an instance does not match any instance in the master 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 master dataset and its own dataset is not marked for automatic identification, the instance remains unidentified.

Unidentified instances cannot participate in Merge or Comparison activities, so you should manually identify them. For information and procedures, see “Manually identifying data” on page 121.

114 Installation and Configuration Guide

Page 115: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Identifying data across datasets

� To identify data using an Identification activity

Step 1 Optionally, create a Qualification group to define which instances participate in the activity. See “Creating Qualification groups” on page 164.

Step 2 Create Identification groups, each of which has rules that match instances between two datasets. See the next section, “Creating an Identification group.”

Step 3 Create a job to hold the Identification activity, if no job exists. See “Creating a job” on page 155.

Step 4 Create an Identification activity and associate these groups to it. See “Creating an Identification activity” on page 118.

NOTE Activities cannot be reused between jobs. If you delete a job, all its activities are also deleted.

Creating an Identification groupYou create an Identification group to be paired with a particular dataset in an Identification activity. It uses a sequence of Identification rules to identify instances from that dataset against those from other datasets in a particular order.

NOTE In an Identification activity, each participating dataset except the master dataset must be paired with an Identification group. If the activity involves three or more datasets, each dataset's Identification group must include Identification rules comparing it to all the other datasets. For instance, in an Identification activity involving datasets A, B, and C where C is the master, the Identification group paired with dataset A must have a rule that identifies its instances against B and a rule that identifies its instances against C, and the group paired with B must have a rule identifying against A and a rule identifying against C. Without these rules, a job that includes this activity will not run.

Each Identification group applies its rules to a specific class. Unless an activity using the group has its Explicit Flag selected, the group also applies to subclasses of the specified class, so you can use inheritance to minimize the number of Identification groups you create.

� To create an Identification group

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

Chapter 5 Reconciling data 115

Page 116: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

2 In the navigation pane, under the Create heading, click the Identification Group link.

The Identification Group Information window appears.

Figure 5-10: Identification Group Information window

3 Enter the following required information:

a In the Group Name field, enter the name of the group.

b Using the controls with the Namespace field, select one or more namespaces.

For more information, see “Using namespaces in reconciliation” on page 167.

c From the Class Name list, select the name of the class.

116 Installation and Configuration Guide

Page 117: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Identifying data across datasets

4 In the Identification Rules table, click Add.

The Identification Rule dialog box appears.

Figure 5-11: Identification Rule dialog box

5 Enter the following required information:

a From the Find in Dataset list, select the dataset where you want to find a match.

b In the Execution Order field, select or enter the rule execution order.

All rules in the group are processed according to this order. The value can be an integer from 0 to 1000, inclusive. The default value is 500.

c Optionally, select All Of from the Rules Option list.

When this option is selected, identification is done on the composite object level. If an instance is the source member in any weak relationships, it and its destination members are only identified if all of them match according to their respective rules.

NOTE If an error occurs while identifying a composite object, only the CI on which the error directly occurs and any CIs below it in the composite object will fail to be identified. This is true whether you select the All Of option or not. For instance, if a computer system has component relationships to a disk drive and a keyboard, and an error is made when attempting to identify the disk drive, the computer system and keyboard and relationships among them are still successfully identified. In previous versions of BMC Atrium CMDB, such an error would have prevented all three CIs and their relationship from being identified.

d In the Qualification field, enter a qualification.

This qualification specifies the criteria that match the class between datasets. For example, if you define the qualification 'IP Address' = $IP Address$, instances of the class are identified when they share the same IP address.

Use single quotes (') to enclose attribute names from the dataset that will be paired with this Identification group in an Identification activity, and use dollar signs ($) to enclose attribute names from the dataset in the Find in Dataset field.

Chapter 5 Reconciling data 117

Page 118: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

e To build an advanced qualification, click Advanced Qualification.

For more information about the Advanced Qualification Builder, see “The Advanced Qualification Builder” on page 166.

6 Click Save.

7 Repeat step 5 and step 6 for each Identification rule you want to add.

You need one Identification rule for each dataset against which you want to identify the dataset this group will be paired with.

8 Click Close.

The identification rules appear in the Identification Rules table.

9 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

10 Click Save.

Creating an Identification activityAn Identification activity identifies CIs in one or more datasets based on the Identification groups contained in it.

� To create an Identification activity

1 View a job from the Reconciliation Manager.

2 Click the Activities tab.

118 Installation and Configuration Guide

Page 119: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Identifying data across datasets

3 From the Select Type list, select Identification, and then click Add.

The Activity Type: Identification window appears.

Figure 5-12: Activity Type: Identification window

4 Fill in the following required fields:

Table 5-2: Activity Type: Identification window field descriptions

5 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

Chapter 5 Reconciling data 119

Page 120: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

6 Click the Identification tab (selected by default).

In this tab you associate the activity with one Identification group for each participating dataset.

7 In the Datasets and Identification Groups table, click Add.

The Relate Datasets and Groups dialog box appears.

Figure 5-13: Relate Datasets and Groups dialog box

8 From the Dataset list, select the first dataset you want to identify.

9 From the Group Name list, pair that dataset with the Identification group that contains the rules for identifying its data.

NOTE Identification groups that do not contain the Master Dataset need more Identification rules. For more information, see “Creating an Identification group” on page 115.

10 If you want instances from the dataset paired with this group to be assigned an automatically generated identity when the master dataset does not already have an identity, select Yes in the Mark Auto Identity field. Otherwise, leave it set to No.

In version 2.1.00, this setting applies to every class on which it is set. In previous versions, CIs that were components of a composite object would be assigned an automatically generated identity when the class of the parent CI of the composite object had this option set to Yes.

For example, if you set Mark Auto Identity to Yes on an Identification group defined for BMC_ComputerSystem, previous versions of BMC Atrium CMDB would automatically generate identities not just for a BMC_ComputerSystem CI, but for BMC_DiskDrive CIs and other component CIs that are destinations of a weak relationship with the computer system, even if the Identification groups for BMC_DiskDrive and the other classes had set Mark Auto Identity to No. In version 2.1.00, setting Mark Auto Identity to No prevents these components from receiving automatically generated identities.

11 Click Relate, and then click Close.

The dataset and group appear in the table.

12 Repeat step 7 through step 11 for each dataset you want to identify.

120 Installation and Configuration Guide

Page 121: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Identifying data across datasets

13 From the Master Dataset list, select a master dataset.

This dataset provides the identity that is assigned to instances in other datasets.

14 From the Auto-Identify Master Dataset list, select Yes or No.

a Select Yes if you want the master dataset auto-identified.

b Select No if you do not want the master dataset auto-identified.

15 From the Explicit Flag list, select Yes or No.

a Select Yes if you want to require that Identification groups be specified for every class.

b Select No if you want classes to be able to inherit Identification groups from their superclasses. You can still specify individual groups for any class.

16 Click the Qualification tab.

17 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select specifies the instances that are identified by this activity. To identify all instances, do not select a Qualification group.

18 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

19 Click Save, and then click Close.

The activity is added to the Activities table.

20 If you want to change the sequence of the activity, select the activity from the table, enter or select a number in the numeric field below the table, and click Update Activity Sequence.

Manually identifying dataIf the Reconciliation Engine cannot find a match for an object instance after applying all the identification rules, or the instance is part of an Identification group that you did not specify to be auto-identified, the instance remains unidentified. In this case, you must manually identify the instance or modify the identification rules.

You manually identify instances through the Manual Identification Console.

� To manually identify instances

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

Chapter 5 Reconciling data 121

Page 122: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

2 In the navigation pane, under the Reconciliation heading, click the Manual Identification link.

The Manual Identification Console appears.

Figure 5-14: Manual Identification Console

3 From the Class list, select a class that contains unidentified instances.

The instances appear in the Unidentified Instances and Identified Instances table.

4 In the Unidentified Instances table, select the instance you want to identify.

5 In the Identified Instances table, select the instance to supply an identity to the unidentified instance.

If you need to view attribute details about either instance, click View.

6 Click Apply Identity.

The unidentified instance is identified.

122 Installation and Configuration Guide

Page 123: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Merging datasets

Merging datasetsAfter 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.

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 will be written to the target dataset for each class and attribute.

NOTE In versions of the BMC Atrium CMDB prior to 2.0, precedence value was called weight.

Only instances that have reconciliation identities are merged. For more information about identification, see “Identifying data across datasets” on page 114.

Independent Merge activities and AttributeDataSourceListThough 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 Dataset Merge Precedence 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 one Merge activity versus independent Merge activities, see the Concepts and Best Practices Guide.

NOTE 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 Dataset Merge Precedence set associated with the Merge activity. Whichever Precedence group is paired with the “stored” source dataset in that Dataset Merge Precedence set supplies the precedence value for the attribute.

Chapter 5 Reconciling data 123

Page 124: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� To merge datasets

Step 1 Optionally, create a Qualification group to define which instances participate in the Merge activity. See “Creating Qualification groups” on page 164.

Step 2 Create Precedence groups, each of which sets precedence values for a dataset and its classes and attributes. See “Creating a Precedence group” on page 125.

Step 3 Create a Dataset Merge Precedence set to assign a Precedence group to each dataset participating in the Merge activity. See “Creating a Dataset Merge Precedence set” on page 129.

Step 4 Create a job to hold the Merge activity. See “Creating a job” on page 155.

Step 5 Create a Merge activity and associate the Dataset Merge Precedence set and Qualification group to it. See “Creating a Merge activity” on page 130.

NOTE Activities cannot be reused between jobs. If you delete a job, all its activities are also deleted.

Handling NULL valuesThe Defer if Null option, which you can set both for a Precedence group and for class and attribute precedences within that group, 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 will be 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 Software products set MarkAsDeleted to either “Yes” or NULL. Therefore, once 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 Comparison activities. Blanks also cannot be used in the MarkAsDeleted attribute because it is a selection, not character, attribute.

124 Installation and Configuration Guide

Page 125: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Merging datasets

Defer if Null = “No”This means the source dataset with the highest precedence value for an attribute will merge 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 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 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.

Creating a Precedence groupA Precedence group sets the precedence value for a dataset in a Merge activity. Each source dataset is paired with one, and that Precedence group 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 group, 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. For more information about Precedence groups, see the Concepts and Best Practices Guide.

A Precedence group 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 groups in different activities. Therefore, design your Precedence groups for flexibility. You will need fewer of them.

WARNING If used incorrectly, the Defer if Null option can cause instances that cannot be deleted. For information about this, see “Handling NULL values” on page 124.

� To create a Precedence group

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

Chapter 5 Reconciling data 125

Page 126: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

2 In the navigation pane, under the Create heading, click the Precedence Group link.

The Precedence Group Information window appears.

Figure 5-15: Precedence Group Information window

3 Enter the following required information:

a In the Group Name field, enter the name of the Precedence group.

b Using the controls with the Namespace field, select one or more namespaces.

For more information, see “Using namespaces in reconciliation” on page 167.

c From the Defer if Null list, select Yes or No.

� Yes—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 target dataset.

� No—Apply the precedence value for this dataset regardless of whether an attribute value is NULL.

The Defer if Null setting at the Precedence group level is overridden by the same setting in any Precedences defined for the group.

126 Installation and Configuration Guide

Page 127: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Merging datasets

d From the Combine List list, select Yes or No.

� Yes—If this Precedence group 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 group has the highest precedence value for the attribute, the Combine List option for that group determines whether values are appended.

� No—If this Precedence group 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 group overwrite the list in the target dataset.

A list-formatted attribute is a Character attribute that is intended to hold a list of values according to a specified format. For information about specifying a list format, see step g on page 78.

The Combine List setting at the Precedence group level is overridden by the same setting in any Precedences defined for the group.

4 In the Precedence Value field, enter or select a value for this Precedence group. The weight is 0 to 1000, inclusive, with higher numbers meaning a higher priority. The default weight is 500.

The Precedence Value at the Precedence group level is overridden by the value in any Precedences defined for the group.

5 From the Precedence Explicit list, select Yes or No.

� Select Yes to require explicit Precedence entries for classes and attributes.

� Select No for this Precedence group to apply to all classes and attributes for which a Precedence is not defined.

6 If you want to add Precedences for particular classes and attributes, continue with the rest of this procedure. If not, finish by clicking Save.

7 From the Type list in the Precedences table, select the type of Precedence to add and click Add.

If you selected Class, the Class Precedence Information dialog box appears with the Status and Namespace fields filled by default. If you selected Attribute, the Attribute Precedence Information dialog box appears.

Figure 5-16: Class Precedence Information dialog box

Chapter 5 Reconciling data 127

Page 128: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 5-17: Attribute Precedence Information dialog box

8 Enter the following required information:

a From the Class Name list, select the class to which this Precedence applies.

b If the Precedence is for an attribute, select it from the Attribute list.

c In the Precedence Value field, type or select a value from 0 to 1000, inclusive. Higher numbers mean a higher priority.

d From the Defer if Null list, select Yes or No.

� Yes—If the value of an attribute 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 target dataset.

� No—Apply the precedence value for this class or attribute regardless of whether an attribute value is NULL.

e From the Combine List list, select Yes or No.

� Select Yes to combine the data that is returned.

� Select No to not combine the data.

9 If the Precedence is for a class, select Yes or No from the Precedence Explicit list.

� Select Yes to require explicit Precedence entries for attributes.

� Select No for this class Precedence to apply to all attributes of the class for which a Precedence is not defined.

10 If the Precedence is for a class, click Add All Attributes if you want to automatically create Precedences for each attribute in the class.

This is useful if you have specified Yes for Precedence Explicit, because it allows you to modify the settings for only the attributes that need different values instead of adding Precedences for every attribute one at a time.

The attribute Precedences have the same Precedence Value, Defer if Null, and Combine List settings as the class Precedence.

11 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

128 Installation and Configuration Guide

Page 129: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Merging datasets

12 Click Save, and then click Close.

The Precedence appears in the Precedences table. If you clicked Add All Attributes, those attribute Precedences also appear.

13 Click Save.

Creating a Dataset Merge Precedence setA Dataset Merge Precedence set joins datasets and Precedence groups, and is reusable between Merge activities. Each Merge activity is linked to one Dataset Merge Precedence set that determines the precedence for each dataset that participates in the activity.

� To create a Dataset Merge Precedence set

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Create heading, click the Dataset Merge Precedence link.

The Dataset Merge Precedence Set window appears.

Figure 5-18: Dataset Merge Precedence Set window

3 Enter a Name for the set.

Chapter 5 Reconciling data 129

Page 130: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 Click Add.

The Dataset Merge Precedence Set Association window appears.

Figure 5-19: Dataset Merge Precedence Set Association window

5 Select a Dataset and a Precedence Group.

6 Type or select an Order for this pairing within the set.

If there is a tie for the highest precedence value on any attribute between Precedence groups in the set, the dataset and group with the lower Order number take precedence in merges.

7 Click Save.

Repeat step 5 through step 7 for each dataset and Precedence group that you want to pair together in this set.

8 Click Close.

Your new pairings appear in the table.

9 Click Save, and then click Close.

Creating a Merge activityYou can create a Merge activity.

� To create a Merge activity

1 View a job from the Reconciliation Manager.

2 Click the Activities tab.

130 Installation and Configuration Guide

Page 131: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Merging datasets

3 From the Select Type list, select Merge, and then click Add.

The Activity Type: Merge window appears.

Figure 5-20: Activity Type: Merge window

4 Fill in the following required fields:

Table 5-3: Activity Type: Merge window field descriptions

5 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

Chapter 5 Reconciling data 131

Page 132: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

6 Click the Merge tab (selected by default).

7 From the Dataset Merge Precedence list, select the Dataset Merge Precedence set to provide precedences for this activity.

8 From the Target Dataset list, select the dataset where merged instances should be written.

9 From the Include Child CIs list, select one of the following options:

Table 5-4: Child CI list options

Last Activity Time is a read-only field that displays the timestamp of the last time this activity was run in a job.

10 From the Force Attribute Merge list, select Yes or No.

� Yes—Merge all attributes even if their value has not changed in the source dataset since the last time this Merge activity ran.

� No—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.

Selection Description

Stand Alone Only the instances specified by the attached Qualification group are merged. This option is the default.

Yes; Commit Separately The merge includes not only instances specified by the attached Qualification group, but destination CIs in weak relationships with those instances and the relationships themselves.This option treats composite objects as one entity for merging purposes. For example, if your Qualification group selects a computer system instance, it and its components would all be merged. The individual CIs and relationships are merged in separate database transactions.

Yes; Commit Together Composite objects are merged as with the Yes; Commit Separately option, but each composite object merge is performed as one database transaction. If there is an error 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 Yes; Commit Separately.

132 Installation and Configuration Guide

Page 133: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Comparing datasets

11 In the Source Datasets table, click Add.

The Relate Datasets dialog box appears.

Figure 5-21: Relate Datasets dialog box

12 From the Dataset list, select a source dataset for the activity, and then click Relate.

Repeat this step for each source dataset that participates in the activity.

13 Click Close.

The datasets appear in the table.

14 Click the Qualification tab.

15 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select, together with the Algorithm, specifies the instances that are merged by this activity. To identify all instances, do not select a Qualification group.

16 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

17 Click Save, and then click Close.

Comparing datasetsYou 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 Comparison 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 compared instances” on page 137.

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.

Chapter 5 Reconciling data 133

Page 134: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 5-22: Comparison report

Only instances that have reconciliation identities are compared. For more information about identification, see “Identifying data across datasets” on page 114. You can also exclude individual attributes from being compared.

� To compare data using a Comparison activity

Step 1 Optionally, create a Qualification group to define which instances participate in the activity. See “Creating Qualification groups” on page 164.

Step 2 Optionally, create a Workflow Execution group, which specifies criteria for running workflow based on results of the comparison. See “Executing workflow against compared instances” on page 137.

Step 3 Create a job to hold the Comparison activity, if no job exists. See “Creating a job” on page 155.

Step 4 Create a Comparison activity and associate these groups to it. See the next section, “Creating a Comparison activity.”

134 Installation and Configuration Guide

Page 135: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Comparing datasets

Creating a Comparison activityA Comparison activity compares instances in one or more datasets, excluding any attributes specified by Exclusion rules contained in it.

NOTE In versions of the BMC Atrium CMDB prior to 2.0, Exclusion rules were called Comparison rules.

� To create a Comparison activity

1 View a job from the Reconciliation Manager.

2 Click the Activities tab.

3 From the Select Type list, select Comparison, and then click Add.

The Activity Type: Comparison window appears.

Figure 5-23: Activity Type: Comparison window

Chapter 5 Reconciling data 135

Page 136: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 Fill in the following required fields:

Table 5-5: Activity Type: Comparison window field descriptions

5 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

6 Click the Comparison tab (selected by default).

7 From the Dataset 1 and Dataset 2 lists, select the datasets you want to compare.

For any Workflow Execution rules you add to this activity, Dataset 1 is the left side and Dataset 2 is the right side.

8 If you want to exclude any attributes from being compared, click Add in the Add Exclusion Rules table. If not, skip to step 13.

The Exclusion Rules dialog box appears.

Figure 5-24: Exclusion Rules dialog box

9 From the Class Name list, select the class containing the attribute you want to exclude from the comparison.

10 From the Attribute Name list, select the attribute to be excluded.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

136 Installation and Configuration Guide

Page 137: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Comparing datasets

11 Click Exclude, and then click Close.

The Exclusion rule appears in the Add Exclusion Rules table.

12 Repeat step 8 through step 11 for each attribute you want to exclude from the comparison.

13 If you want to execute workflow from this activity instead of generating comparison reports, click the Workflow tab and select a Workflow Execution group from the Workflow Execution Group menu.

NOTE If you select a Workflow Execution group, no comparison report is generated by this activity. A Comparison activity can either generate reports or execute workflow.

For information about creating a Workflow Execution group, see the next section, “Executing workflow against compared instances.”

14 Click the Qualification tab.

15 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select specifies the instances that are compared by this activity. To compare all instances, do not select a Qualification group.

16 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

17 Click Save.

Executing workflow against compared instancesYou can use the results of a Comparison activity to trigger AR System workflow against the instances being compared instead of generating a comparison report.

For a given Comparison activity, you can specify a Workflow Execution group that can contain multiple Workflow Execution rules. Each rule operates against only one BMC Atrium CMDB class, and contains a qualification specifying criteria that executes an action.

The qualification can compare attributes from both datasets. When the Comparison 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 CMDB 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 Comparison activities is skipped.

Chapter 5 Reconciling data 137

Page 138: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

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.

NOTE You do not need a filter to create a Comparison 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 Comparison activity, see “Creating a Comparison activity” on page 135.

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.

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 for which you will compare a large number of instances.

� To create a Workflow Execution group and related workflow

1 From the Reconciliation tab of the CMDB Console, click Workflow Execution Group under the Create heading.

138 Installation and Configuration Guide

Page 139: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Comparing datasets

The Workflow Execution Group Information window appears.

Figure 5-25: Workflow Execution Group Information window

2 Type a Name for the group.

3 Using the controls with the Namespace field, select one or more namespaces.

For more information, see “Using namespaces in reconciliation” on page 167.

4 In the Workflow Execution Rules tab, click Add to add a new Workflow Execution rule.

The Workflow Execution Rule dialog box appears.

Figure 5-26: Workflow Execution Rule dialog box

Chapter 5 Reconciling data 139

Page 140: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 Select a Class Name.

The rule only operates against this class, and when building the Qualification you can only use attributes from this class.

6 Select an Execution Side to determine whether the Execution Code is written to the instance in the Left or Right dataset.

Left refers to the Dataset 1 specified for a Comparison activity, and Right refers to Dataset 2.

7 Type an Execution Code.

This is the unique string that is written to the CompareActionCode attribute when the Qualification is met. It can be up to 128 characters long.

8 Type or select an Execution Order to determine when this rule is executed in relation to the other rules in this group.

9 Type the Qualification that 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 ($). For example, here is the qualification to find a CI where the instance in Dataset 1 has an earlier installation date than the instance in Dataset 2 is:

'InstallationDate' < $InstallationDate$

Click Advanced Qualification to build it interactively. For more information about the Advanced Qualification Builder, see “The Advanced Qualification Builder” on page 166.

10 Click Save.

11 Repeat step 4 through step 10 for each separate piece of workflow you want to run using this group.

12 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

13 Click Save to save the new Workflow Execution group.

14 In BMC Remedy Administrator, create one filter for each Workflow Execution rule 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' = <Execution Code>

<Execution Code> represents the value you typed in step 7, and is different for every Workflow Execution rule you created.

� 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.

140 Installation and Configuration Guide

Page 141: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating datasets

For your new Workflow Execution group to take effect, you must attach it to one or more Comparison activities. For more information, see “Creating a Comparison activity” on page 135.

Creating datasetsYou can create datasets from the Reconciliation Manager. 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.

These are some of the dataset names and IDs used by BMC Software products:

Table 5-6: Dataset names and IDs

� To create a dataset

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Create heading, click the Dataset link.

The Dataset Information window appears.

Figure 5-27: Dataset Information window

3 In the Dataset Name field, type a unique name for the dataset.

Dataset name Dataset ID

BMC Asset BMC.ASSET

BMC Topology Import BMC.IMPORT.TOPO

BMC Configuration Import BMC.IMPORT.CONFIG

Chapter 5 Reconciling data 141

Page 142: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 In the Dataset ID field, 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.

NOTE 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 Dataset activity. For information about this, see “Renaming datasets” on page 148.

5 In the Accessibility field, select the level of accessibility for 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

This refers to whether instances can be created, modified, and deleted in the dataset. In most cases, choose Writable.

6 If you selected Writable by client only, type the client IDs of each BMC Atrium CMDB 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 values are:

Table 5-7: Values

For more information about this feature, see the Concepts and Best Practices Guide.

7 In the DatasetType field, select Regular or Overlay.

For information about overlay datasets, see the Concepts and Best Practices Guide.

8 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.

9 Click Save.

Client ID

BMC Impact Publishing Server 28

BMC Impact Service Model Editor 29

Reconciliation Engine 32

142 Installation and Configuration Guide

Page 143: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Copying datasets

Copying datasetsYou can copy instances from one dataset to another. You might do this to create baselines, snapshots, archives, future states, or other types of datasets.

Copying is done with the Copy Dataset activity, which has four options that affect how each other behaves. Table 5-8 on page 144 shows the Copy Dataset 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.

� 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 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 group 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 other three: 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.

Chapter 5 Reconciling data 143

Page 144: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Table 5-8 describes the behavior of the Copy Dataset activity for each combination of options.

Table 5-8: Option combinations for Copy Dataset activity

Settings used Behavior

Copy Relationships: By Qualifier

Collision Resolution: Overwrite

Include Child CIs: No

Identity Required: Yes

Only instances with a reconciliation identity are copied, and they replace existing instances. Only CIs and relationships in the Qualification group are copied.

Copy Relationships: Copy All

Collision Resolution: Overwrite

Include Child CIs: No

Identity Required: Yes

Only instances with a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Display Error

Include Child CIs: No

Identity Required: Yes

Only instances with a reconciliation identity are copied, unless they match existing instances, in which case an error is written. Only CIs and relationships in the Qualification group are copied.

Copy Relationships: Copy All

Collision Resolution: Display Error

Include Child CIs: No

Identity Required: Yes

Only instances with a reconciliation identity are copied, unless they match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Overwrite

Include Child CIs: Yes

Identity Required: Yes

Only instances with a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them.

Copy Relationships: Copy All

Collision Resolution: Overwrite

Include Child CIs: Yes

Identity Required: Yes

Only instances with a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them, and relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Display Error

Include Child CIs: Yes

Identity Required: Yes

Only instances with a reconciliation identity are copied, unless they match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them.

144 Installation and Configuration Guide

Page 145: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Copying datasets

Copy Relationships: Copy All

Collision Resolution: Display Error

Include Child CIs: Yes

Identity Required: Yes

Only instances with a reconciliation identity are copied, unless they match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them, and relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Overwrite

Include Child CIs: No

Identity Required: No

Instances with and without a reconciliation identity are copied, and they replace existing instances. No instances beyond those in the Qualification group are copied.

Copy Relationships: Copy All

Collision Resolution: Overwrite

Include Child CIs: No

Identity Required: No

Instances with and without a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Display Error

Include Child CIs: No

Identity Required: No

Instances with and without a reconciliation identity are copied, except identified instances that match existing instances, in which case an error is written. No instances beyond those in the Qualification group are copied.

Copy Relationships: Copy All

Collision Resolution: Display Error

Include Child CIs: No

Identity Required: No

Instances with and without a reconciliation identity are copied, except identified instances that match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes relationships to copied CIs where the other member exists in the target dataset.

Copy Relationships: By Qualifier

Collision Resolution: Overwrite

Include Child CIs: Yes

Identity Required: No

Instances with and without a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them.

Copy Relationships: Copy All

Collision Resolution: Overwrite

Include Child CIs: Yes

Identity Required: No

Instances with and without a reconciliation identity are copied, and they replace existing instances. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them, and relationships to copied CIs where the other member exists in the target dataset.

Table 5-8: Option combinations for Copy Dataset activity

Settings used Behavior

Chapter 5 Reconciling data 145

Page 146: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� To create a Copy Dataset activity

1 Optionally, create a Qualification group to define which instances participate in the activity. See “Creating Qualification groups” on page 164.

2 View a job from the Reconciliation Manager.

3 Click the Activities tab.

Copy Relationships: By Qualifier

Collision Resolution: Display Error

Include Child CIs: Yes

Identity Required: No

Instances with and without a reconciliation identity are copied, except identified instances that match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them.

Copy Relationships: Copy All

Collision Resolution: Display Error

Include Child CIs: Yes

Identity Required: No

Instances with and without a reconciliation identity are copied, except identified instances that match existing instances, in which case an error is written. In addition to instances in the Qualification group, the copy includes all weak relationships and CIs below them, and relationships to copied CIs where the other member exists in the target dataset.

Table 5-8: Option combinations for Copy Dataset activity

Settings used Behavior

146 Installation and Configuration Guide

Page 147: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Copying datasets

4 From the Select Type list, select Copy Dataset, and then click Add.

The Activity Type: Copy Dataset window appears.

Figure 5-28: Activity Type: Copy Dataset window

5 Fill in the required fields at the top of the window as you would for any other activity type.

6 Click the Copy Dataset tab (selected by default).

7 Select a Source Dataset and Target Dataset from the available menus.

8 In the Copy Relationships field, select which relationship instances to copy.

� By Qualifier—Copy only the relationships included in the Qualification group.

� Copy All—Copy relationships included in the Qualification group, and also restore direct relationships to instances in the target dataset.

9 In the Collision Resolution field, 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.

Chapter 5 Reconciling data 147

Page 148: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

10 In the Include Child CIs field, select whether to copy only the CIs included in the Qualification group or to also copy their related destination CIs to preserve composite objects.

� No—Copy only the CIs included in the Qualification group.

� Yes—Copy CIs included in the Qualification group, CIs related as destination members in a weak relationship, and those relationships.

11 In the Identity Required field, select whether to copy instances without a reconciliation identity.

� Yes—Copy only identified instances.

� No—Copy identified and unidentified instances.

12 Click the Qualification tab.

13 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select specifies the instances that are copied by this activity, though that set can be increased or decreased based on the options you select for the activity.

14 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

15 Click Save, and then click Close.

Renaming datasetsThe 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.

A Rename Dataset 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.

For example, if you had a dataset with the name “Scan - Current” and the ID “Scan01May2006” and used a Rename Dataset activity to rename it “Scan - Last Week,” you would then have two datasets:

Table 5-9: Dataset names and IDs

Dataset name Dataset ID

Scan - Last Week Scan01May2006

Scan - Current OS-B34DA0F996C0438299D3A2C68CF778C3(Generated GUID)

148 Installation and Configuration Guide

Page 149: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Renaming datasets

� To create a Rename Dataset activity

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 View a job from the Reconciliation Manager.

3 Click the Activities tab.

4 From the Select Type list, select Rename Dataset, and then click Add.

The Activity Type: Rename Dataset window appears.

Figure 5-29: Activity Type: Rename Dataset window

Chapter 5 Reconciling data 149

Page 150: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 Fill in the following required fields:

Table 5-10: Activity Type: Rename Dataset window field descriptions

6 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

7 From the Dataset list, select the dataset you want to rename.

8 In the New Dataset Name field, enter a new name for your dataset.

9 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

10 Click Save, and then click Close.

Deleting dataYou can delete instances from one or more datasets using a Delete Dataset activity. The Delete Dataset activity performs a physical delete, not a soft delete, and will delete instances regardless of whether they are soft deleted. You optionally restrict the instances to be deleted by using a Qualification group. You can also choose to delete only identified instances.

The Delete Dataset activity is similar to the Purge Dataset activity. For information about the Purge Dataset activity, see “Purging soft-deleted data” on page 153.

� To create a Delete Dataset activity

1 View a job from the Reconciliation Manager.

2 Click the Activities tab.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

150 Installation and Configuration Guide

Page 151: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Deleting data

3 From the Select Type list, select Delete Dataset, and then click Add.

The Activity Type: Delete Dataset window appears.

Figure 5-30: Activity Type: Delete Dataset window

4 Fill in the following required fields:

Table 5-11: Activity Type: Delete Dataset window field descriptions

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

Chapter 5 Reconciling data 151

Page 152: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

6 Click the Delete Dataset tab.

7 In the Datasets to Delete table, click Add.

The Relate Datasets dialog box appears.

Figure 5-31: Relate Datasets dialog box

8 From the Dataset list, select a dataset from which you want to delete data, then click Relate.

9 Repeat the previous step for each needed dataset, and then click Close.

The datasets appear in the table.

10 In the Delete Instances list, select an option.

� Identified & Unidentified—Both identified and unidentified instances are deleted.

� Identified—Only identified instances are deleted. This is the default.

� Unidentified—Only unidentified instances are deleted.

11 Click the Qualification tab.

12 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select specifies the instances that are deleted by this activity. To delete all instances, do not select a Qualification group.

13 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

14 Click Save, and then click Close.

152 Installation and Configuration Guide

Page 153: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Purging soft-deleted data

Purging soft-deleted dataYou can use a Purge Dataset 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 group.

The Purge Dataset activity is similar to the Delete Dataset activity. For information about the Delete Dataset activity, see “Deleting data” on page 150.

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 create a Purge Dataset activity

1 View a job from the Reconciliation Manager.

2 Click the Activities tab.

3 From the Select Type list, select Purge Dataset, and then click Add.

The Activity Type: Purge window appears.

Figure 5-32: Activity Type: Purge window

Chapter 5 Reconciling data 153

Page 154: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 Fill in the following required fields:

Table 5-12: Activity Type: Purge window field descriptions

5 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

6 Click the Purge Dataset tab.

7 In the Datasets to Purge table, click Add.

The Relate Datasets dialog box appears.

Figure 5-33: Relate Datasets dialog box

8 From the Dataset list, select a dataset from which you want to purge data, then click Relate.

9 Repeat the previous step for each needed dataset, and then click Close.

The datasets appear in the table.

10 From the Target Dataset list, select a target dataset against which you want to validate instances to be purged.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

154 Installation and Configuration Guide

Page 155: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with jobs

11 In the Purge Instances list, select an option.

� Identified & Unidentified—Both identified and unidentified instances are purged.

� Identified—Only identified instances are purged. This is the default.

� Unidentified—Only unidentified instances are purged.

12 From the Verify Soft Deleted in Target Dataset list, select either of the following values:

� Yes—An identified instance is only purged from one of the datasets in the Define Datasets table if an instance with the same reconciliation identity in the Target Dataset is also marked as deleted. Unidentified instances are deleted.

� No—The Target Dataset is ignored, and 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.

13 If you selected Yes, select the target dataset to verify in the Target Dataset field.

14 Click the Qualification tab.

15 From the Qualification Group list, optionally select a Qualification group.

The Qualification group you select specifies the instances that will be purged by this activity. To purge all instances, do not select a Qualification group.

16 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

17 Click Save, and then click Close.

Working with jobsA reconciliation job is a group of one or more reconciliation activities in a defined sequence. You cannot run an activity by itself. An activity can only run as part of a job.

Creating a jobAfter you have created a job and defined its schedule, you must create activities and relate them to the job. These activities are run when the job is run. After the job is run, you can view its history.

You should 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 a job” on page 157.

Chapter 5 Reconciling data 155

Page 156: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� To create a job

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Create heading, click the Job link.

The Job Information window appears.

3 In the Job Name field, enter the logical name of your job.

The name must be unique, and cannot contain any characters that are not allowed in filenames for the operating system of your server machine. For example, on a Windows server your job name cannot contain the characters\ / : * ? “ < > |

4 From the Job Status list, select Active. You can later disable the activity by changing this to Inactive.

5 Create a schedule for the job.

See the next procedure, “To create a job schedule.”

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.

See the appropriate procedures:

� “To create an Identification activity” on page 118

� “To create a Merge activity” on page 130

� “To create a Comparison activity” on page 135

� “To create a Copy Dataset activity” on page 146

� “To create a Rename Dataset activity” on page 149

� “To create a Delete Dataset activity” on page 150

� “To create a Purge Dataset activity” on page 153

7 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

8 Click Save, and then click Close.

The Reconciliation Manager appears.

156 Installation and Configuration Guide

Page 157: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with jobs

� To create a job schedule

1 From the Job Information window, click the Schedules tab.

2 Click Add.

The Job Schedule Information dialog box appears.

Figure 5-34: Job Schedule Information dialog box

3 Select the days of the week you want the job to run.

4 In the Schedule Time field, enter the time each week you want the job to run.

5 Click Save.

6 To add more schedules, repeat the procedure.

7 Click Save again, and then click Close.

The job schedule appears in the Schedules table.

Starting a jobSeveral methods of starting a job exist. You can use more than one of them with the same job.

With a scheduleUse this method to run a job repeatedly at regular intervals. You select a time and days of the week for the job to run. Each job can have multiple schedules. For instructions, see the procedure “To create a job schedule” on page 157.

Chapter 5 Reconciling data 157

Page 158: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

ManuallyYou can start a job manually from the Job History Console.

� To run a job manually

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Reconciliation heading, click the Job History link.

The Job History Console appears.

3 In the Jobs table, select the job you want to run, and click Start Job.

The job changes to Started.

Using a BMC Atrium CMDB API programThe 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 Developer’s Reference Guide. You can use these functions to dynamically substitute datasets or qualifications as described in “Dynamic dataset and qualification values” on page 168.

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 groups defined within the job are ignored, even if you did not dynamically specify qualifications.

Using a Run Process workflow actionYou can use a Run Process action with an active link, filter, or escalation. This is one method of performing event-driven reconciliation. Use the command Application-Command Reconciliation <operation> -o "<job_name>" where <operation> is either Trigger-Job or Cancel-Job. For example, to trigger a job named Merge Datasets, use this command:

Application-Command Reconciliation Trigger-Job -o "Merge Datasets"

If you want to dynamically substitute datasets or qualifications when running a job, you can include extra parameters to specify this. The syntax is

Application-Command Reconciliation Trigger-Job -o "<job_name>" -l "-c <class_ID> -q <qualification>";[...];"-w <working_dataset_name> -q <defined_dataset_name>";[...];

158 Installation and Configuration Guide

Page 159: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with jobs

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

Application-Command Reconciliation Trigger-Job -o "Merge Datasets" -l "-w TestSource -q BMC Configuration Import";"-w TestTarget -q BMC Asset"

Qualifications must be specified in AR System internal representation. To convert a qualification string into an internal representation, you can use the Application-Parse-Qual-L Run Process command.

For more information about dynamic dataset or qualification substitution, see “Dynamic dataset and qualification values” on page 168. For more information about Run Process commands, see BMC Remedy Action Request System 7.1.00: Workflow Objects.

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 groups defined within the job are ignored, even if you did not dynamically specify qualifications.

From another jobYou create an Execute Job activity to run another job. A job can contain multiple Execute Job activities, allowing you to create “umbrella jobs” that call several other jobs.

WARNING Do not use this activity to execute the same job of which it is a member. This creates an endless loop.

� To create an Execute Job activity

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 View a job from the Reconciliation Manager.

3 Click the Activities tab.

Chapter 5 Reconciling data 159

Page 160: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 From the Select Type list, select Execute Job, and then click Add.

The Activity Type: Execute Job window appears.

Figure 5-35: Activity Type: Execute Job window

5 Fill in the following required fields:

Table 5-13: Activity Type: Execute Job window field descriptions

6 From the Continue on Error list, select Yes or No.

� Yes—A job containing this activity continues to run if an error occurs in this activity.

� No—A job containing this activity terminates if an error occurs in this activity.

Field Description

Name The name of the activity

Status Select Active. You can later disable the activity by changing this to Inactive.

Namespace Select one or more namespaces using the controls with the Namespace field. Only classes in the selected namespaces can participate in the activity.For more information, see “Using namespaces in reconciliation” on page 167.

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.

160 Installation and Configuration Guide

Page 161: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with jobs

7 From the Job Name list, select the next job to execute.

8 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

9 Click Save, and then click Close.

Canceling jobsYou can cancel a job that is currently running.

� To cancel a job

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Reconciliation heading, click the Job History link.

The Job History Console appears.

3 In the Jobs table, select the job you want to cancel, and click Cancel Job.

The job changes to Canceled.

Viewing job status, results, and historyJob runs include the following information, which you can view from either the Job History Console or the History tab of the Job Information window:

� Start time—Job start time

� End time—Job end time

� Status—One of these values:

� Queued—The job is waiting to start.

� Running—The job is currently in progress.

� Canceled—A user canceled the job before it could complete.

� Aborted—The Reconciliation Engine process was stopped while the job was running.

� Completed—The job completed successfully.

� Warning—The job completed, but some activities were not successful.

� Error—The job could not complete and error messages were logged.

Chapter 5 Reconciling data 161

Page 162: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Each job run can also accumulate events, which are listed when you view job run information. Types of events include:

� Error—Error events generated by an activity contain details about how to solve the problem. These events can include information about datasets or objects causing the error.

� Warning—Warning events generated by an activity contain details about something that might be a problem, for example, the need to manually identify an object.

� Information—Informational events announce milestones, statistics, or results, such as the number of records found or created. These events might include attachments, for example, a Comparison activity might create an Information event with a comparison report attached.

Events include the following information:

� Event Name—Name of event

� Event Type—Information, warning, or an error

� Event Description—Detailed description of the event. For information about interpreting descriptions, see the next section, “Event descriptions.”

� Attachment—Attached files, like a comparison report

� Timestamp—Time the event occurred

Event descriptionsEach run of a Merge, Copy Dataset, Comparison, Delete Dataset, or Purge Dataset 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

Events pertaining to an activity can contain these headings.

� Number of records found: <number>—The number of instances processed by the activity. 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 Force Attribute Merge to No for a Merge activity or setting Identity Required to Yes for a Copy Dataset activity reduces the number of instances processed by the activity.

For a Merge, Copy Dataset, or Comparison 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.

162 Installation and Configuration Guide

Page 163: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Working with jobs

� Records created: <number>—The number of instances created in the target dataset by a Merge or Copy Dataset activity.

� Records modified: <number>—The number of instances modified in the target dataset by a Merge or Copy Dataset activity.

� Duplicate records not copied: <number>—The number of instances that were not copied by a Copy Dataset 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 Dataset or Purge Dataset activity.

� Comparison Report— The report generated by a Comparison activity that has no attached Workflow Execution group. For more information, see “Comparing datasets” on page 133.

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 job run recordsAfter your reconciliation jobs have run many times, you might not want to view the results of older runs in the Job History Console any longer. You can delete these records so that they no longer appear in the Job History Console.

� To delete job run records

1 With BMC Remedy User, log in to your BMC Atrium CMDB server.

2 Open the Reconcilation Job Runs form in Search mode and click Search to find all records in the form.

3 In the results pane, select the records you want to delete.

4 Choose Actions > Delete, then click OK in the confirmation dialog box.

Chapter 5 Reconciling data 163

Page 164: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Creating Qualification groupsA Qualification group 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 group participates in an activity where that group is used.

Multiple activities can use the same Qualification group.

� To create a Qualification group

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Create heading, click the Qualification Group link.

The Qualification Group Information window appears.

Figure 5-36: Qualification Group Information window

You can also create a Qualification group by clicking Create from the Qualification tab of an activity.

3 Enter the following required information:

a In the Group Name field, enter the name of the group.

b Using the controls with the Namespace field, select one or more namespaces.

For more information, see “Using namespaces in reconciliation” on page 167.

164 Installation and Configuration Guide

Page 165: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating Qualification groups

4 In the Qualifications table, click Add.

The Qualification Information dialog box appears.

Figure 5-37: Qualification Information dialog box

5 Enter the following required information:

a In the Name field, enter the name of the qualification.

b From the Status field, select Active. You can later disable the activity by changing this to Inactive.

c Namespace

d From the Class Name list, select the name of the class for which the qualification will return instances.

6 In the Description field, optionally enter a description of the qualification.

7 If you want the qualification to return CIs based on attribute values in related destination CIs, select a referring class name from the Referring Class Name list.

When you select a referring class, the qualification uses the attributes of a destination CI to return a source CI. For example, if your Class Name is BMC_ComputerSystem, you might specify BMC_DiskDrive in the Referring Class Name 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 Referring Class Name field is the destination member of a relationship to the instance of the Class Name field. It does not match when the Referring Class Name instance is the source.

8 In the Qualification field, type your qualification or click Advanced Qualification to build it interactively.

Use single quotes (') to enclose attribute names in the qualification. If you selected a Referring Class Name, build your qualification using attributes of the referring class. Otherwise, use the attributes of the class in the Class Name field.

For more information about the Advanced Qualification Builder, see “The Advanced Qualification Builder” on page 166.

Chapter 5 Reconciling data 165

Page 166: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

9 Click Save.

The qualification appears in the Qualifications table.

10 Repeat step 4 through step 9 for each qualification you want to add to the Qualification group.

11 Optionally, click the Administrative Information tab and add an assignment, help text, and change history entry.

12 Click Save, and then click Close.

The Qualification group is saved.

The Advanced Qualification BuilderThe Advanced Qualification Builder allows you to build qualifications interactively instead of typing them. It is accessible from any window in the Reconciliation Manager that has a Qualification field, and works similarly to the Advanced Search Bar in BMC Remedy User.

Figure 5-38: Advanced Qualification Builder and Selection List dialog boxes

� To build a qualification

1 Using the operators, keywords, or fields from the Qualification Information window, build your qualification.

2 Click Save.

The qualification appears in the Qualification field.

166 Installation and Configuration Guide

Page 167: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Using namespaces in reconciliation

Using namespaces in reconciliationYou can specify more than one namespace for all reconciliation definitions except jobs. This allows you to reconcile all classes, or to restrict reconciliation to the Common Data Model or to a particular set of data model extensions.

You can select one or more namespaces to participate in a reconciliation object or specify that all namespaces participate. You do this from an activity, group, or precedence window.

WARNING Inheritance of reconciliation definitions by a subclass only happens within the namespaces specified for the definition. This can be important if you use BMC Atrium CMDB with other BMC Software products that extend the CDM.

For example, in a Precedence group 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, and you can therefore change the precedence value of 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 group will have unpredictable results.

� To specify namespaces from an activity, group, or precedence window

Figure 5-39: Namespace field and related controls

1 Select the Use All Namespaces option, or click Edit.

The Modify Namespace List window appears.

Figure 5-40: Modify Namespace List window

Chapter 5 Reconciling data 167

Page 168: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

2 Choose a namespace from the Namespace menu and click Add.

The namespace is added to the list. Repeat this step for each namespace you want to participate in the reconciliation object.

3 Click Save.

The Modify Namespace List window closes and the namespaces appear in the parent window.

Dynamic dataset and qualification valuesWhen you execute a reconciliation job from either a BMC Atrium CMDB API program or a Run Process workflow action you have the option of dynamically specifying datasets, class qualifications, or both for the job.

Substituting datasetsSubstituting 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 that 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 Identification 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 groups 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. Figure 5-41 illustrates these scenarios.

Figure 5-41: Dynamic dataset substitution

Activity Datasets

Identification Dataset 1, Dataset 2, Dataset 3

Activity Source datasets Target dataset

Merge Dataset 1, Dataset 2 Dataset 3

Activity Datasets

Identification Dataset 4, Dataset 5, Dataset 3

Activity Source datasets Target dataset

Merge Dataset 4, Dataset 5 Dataset 3

Activity Datasets

Identification Dataset 1, Dataset 2, Dataset 6

Activity Source datasets Target dataset

Merge Dataset 1, Dataset 2 Dataset 6

Defined job

Dataset Working Dataset

Dataset 1 Dataset 4

Dataset 2 Dataset 5

Dataset Working Dataset

Dataset 3 Dataset 6

Called withdataset pairs

Runs with

168 Installation and Configuration Guide

Page 169: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Dynamic dataset and qualification values

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” on page 123.

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.

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 will fail.

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 Job activity.

For instructions for using this feature with workflow, see “Using a Run Process workflow action” on page 158. For instructions for using this feature with an API program, see the Developer’s Reference Guide.

Substituting qualificationsWhen you substitute a qualification, it replaces all Qualification groups 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.

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. Figure 5-42 on page 170 illustrates qualification substitution for both scenarios.

Chapter 5 Reconciling data 169

Page 170: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 5-42: Dynamic qualification substitution

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.

Server settingsBy default, the Reconciliation Engine is installed in:

� Windows—C:\Program Files\AR System Applications\<server_name>\Reconciliation Engine

� UNIX—/usr/arsystem/<server_name>/recon_engine

The Reconciliation Engine is managed by armonitor and is stopped and started with the AR System server. You can modify your Reconciliation Engine server configuration and set the number of threads.

Activity Qualifications

Identification 'MarkAsDeleted' = $NULL$

Merge 'MarkAsDeleted' = $NULL$

Copy 'AccountID' = "Acme"

Activity Qualification set

Identification ('ClassId' = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)) OR ('ClassId' = "BMC_Printer" AND 'CreateDate' > ($TIMESTAMP$ - 86400))

Merge ('ClassId' = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)) OR ('ClassId' = "BMC_Printer" AND 'CreateDate' > ($TIMESTAMP$ - 86400))

Copy (ClassId = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)) OR ('ClassId' = "BMC_Printer" AND 'CreateDate' > ($TIMESTAMP$ - 86400))

Activity Qualification set

Identification 'ClassId' = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)

Merge 'ClassId' = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)

Copy 'ClassId' = "BMC_ComputerSystem" AND 'CreateDate' > ($TIMESTAMP$ - 86400)

Defined job

Called with class/qualification pairs

Runs with

Class Qualification

BMC_ComputerSystem 'CreateDate' > ( $TIMESTAMP$ - 86400)

BMC_Printer 'CreateDate' > ( $TIMESTAMP$ - 86400)

Class Qualification

BMC_ComputerSystem 'CreateDate' > ( $TIMESTAMP$ - 86400)

170 Installation and Configuration Guide

Page 171: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Server settings

Modifying the server configurationYou can add Reconciliation Engine parameters to the ar.conf or ar.cfg file using the Modify Server Configuration window.

� To modify your server configuration

1 From the CMDB Console, click the Reconciliation Manager tab to open the Reconciliation Manager.

2 In the navigation pane, under the Reconciliation heading, click Settings.

The Modify Server Configuration window appears.

Figure 5-43: Modify Server Configuration window

3 Enter parameter values in any of the following fields:

Table 5-14: Modify Server Configuration window parameter descriptions

Parameter Description

Definition 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 The polling interval in seconds. The Reconciliation Engine “sleeps” until the next job is scheduled to run or for this interval, specified in seconds, whichever occurs first. Polling interval is used only when the dispatcher does not send a signal to the Reconciliation Engine. The default is 30 seconds.

Chapter 5 Reconciling data 171

Page 172: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Configuring threadsThe Reconciliation Engine is multithreaded, improving its performance when running jobs. The number of threads available to the Reconciliation Engine is determined by settings for the AR System server where it is installed.

The 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.

� To specify a maximum number of Reconciliation Engine threads

1 In BMC Remedy Administrator, create a private server queue. Specify an RPC program number, and in the Max Threads field, enter the maximum number of threads you want the Reconciliation Engine to use.

For more information about configuring server queues, see BMC Remedy Action Request System 7.1.00: Configuring.

RPC Socket The AR System server RPC socket that the Reconciliation Engine uses for processing. This can be used to specify a maximum number of threads. For more information, see “Configuring threads” on page 172.

Log File Path Location of log files. The default location is <install_dir>\Logs

Logging Level Amount of information to log. Values are:Error (1)—Error and warning messages including context such as instance, class, and dataset IDs. This is the default.

Info (3)—All information included in the Error option plus: job name, 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 (5)—All information included in the Info option plus trace messages

Maximum Log File Size When the log file reaches its maximum size, it is renamed using the current timstamp, and log messages continue to be written to the original file, which is now empty. A value of zero, which is the default, indicates no maximum.

Debug Mode Whether Reconciliation Engine logging is enabled. Set to T (True) to enable logging. Set to F (False) to disable logging.

Parameter Description

172 Installation and Configuration Guide

Page 173: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Exporting definitions

2 In the Reconciliation Manager’s Modify Server Configuration window, enter the same RPC number in the RPC Socket field that you used for the new server queue.

For more information, see “Modifying the server configuration” on page 171.

Exporting definitionsYou can export reconciliation definitions from one server and import them on another server. For information about this, see the Developer’s Reference Guide.

Chapter 5 Reconciling data 173

Page 174: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

174 Installation and Configuration Guide

Page 175: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

6

Other administrative tasks

This section explains how to perform various BMC Atrium CMDB administrative tasks.

The following topics are provided:

� Notification of BMC Atrium CMDB events (page 176)� Configuring the CI Relationship Viewer (page 183)� Controlling the layout of class forms (page 186)� Setting the cache refresh interval (page 192)� Creating CMDB status alerts (page 193)

Chapter 6 Other administrative tasks 175

Page 176: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Notification of BMC Atrium CMDB events BMC Atrium CMDB offers the capability to notify users when instances are created, deleted, or modified. You can create an 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 this information for each event instance:

� Event Type—A value you define for the purpose of categorizing the events you publish

� Event Name—A name you give the event

� Event ID—A GUID that uniquely identifies the event instance

� Change Type—The AR System operation 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.

Publishing an event An event is a particular 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 only occurs 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.

176 Installation and Configuration Guide

Page 177: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Notification of BMC Atrium CMDB events

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 identical fields to the class form for BMC_BaseElement. You must attach the filter to a BMC Atrium CMDB class form and enable it.

� To publish an event

1 With BMC Remedy Administrator, select the server where BMC Atrium CMDB is installed and choose File > New Server Object.

2 In the New Server Object dialog box, select Filter and click OK.

The Create Filter window appears.

3 Enter the following information on the Basic tab, as shown in Figure 6-1, on this page:

Table 6-1: Filter field name values

Filter field name Value

Form Name 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.

Execute On The operations that you want to trigger this event. Choose one or more of Submit, Modify, and Delete.

Run If Any AR System qualification 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"

Chapter 6 Other administrative tasks 177

Page 178: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 6-1: Create Filter window—Basic tab

4 Click the If Action tab, then create an action with these characteristics, as shown in Figure 6-2:

Table 6-2: Filter field name values

Filter field name Value

New Action Set Fields

Server Name CURRENT TRANSACTION

Read Value for Field From CURRENT TRANSACTION

Field Name zTmpOSChar1

Field Value "$<Field ID 1>$[;$<Field ID 2>$]..."

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 aren’t expanded into values. For example, to log the Item and NameFormat attributes, this string is:"$200000005$;$301089100$"

178 Installation and Configuration Guide

Page 179: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Notification of BMC Atrium CMDB events

Figure 6-2: Create Filter window—first If action

Chapter 6 Other administrative tasks 179

Page 180: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 Create another If action with these characteristics, as shown in Figure 6-3 on page 181:

Table 6-3: Filter field name values

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 you give this event

Event_Type The type you give this event

Event ID $PROCESS$ Application-Generate-GUID EVT

ClassID $ClassId$

Event_InstanceID $InstanceId$

Event_AttributeValues "["

ReconciliationIdentity $ReconciliationIdentity$

Event_LastREJobRunId $LastREJobrunId$

zTempFormName $SCHEMA$

zTempAttributeValues $<Field ID 1>$ [+ " ;" + $<Field ID 2>$...] + " "

This is a semicolon-delimited list of the field IDs of each attribute that should be included in the event. Whereas 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$

180 Installation and Configuration Guide

Page 181: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Notification of BMC Atrium CMDB events

Figure 6-3: Create Filter window—second If action

6 Save the filter.

7 Open the filters named CMDB:Event_SeparateListOfValues and CMDB:Event_SeparateListOfValuesCallGuide.

8 In both windows, select Enable and save the filter.

When your new filter executes, 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 our sample filter:

[Item, My item ; NameFormat, This format ]

Chapter 6 Other administrative tasks 181

Page 182: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Polling for instances of an event To be “notified” when an event occurs, you must poll the CMDB:Events form. You can do this with an AR System client or an AR System API program at any interval. Query the form for events that match your criteria, and use the results as you like. Figure 6-4 on page 182 shows the results of a sample query and the values for one entry.

Figure 6-4: Results of a search on CMDB:Events form

182 Installation and Configuration Guide

Page 183: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Configuring the CI Relationship Viewer

Configuring the CI Relationship Viewer You can configure the CI Relationship Viewer in several ways. You can restrict the relationships displayed by number of levels and other criteria, show specific icons and tooltips for a given CI class, and set overall display characteristics such as fonts, icons, and context menus.

TIP For the CI Relationship Viewer to properly launch from the web, you need to use Internet Explorer version 6 or higher. If you attempt to use any other type of web browser, you might encounter errors.

NOTE You can also configure the icons and tooltips displayed in the CI Relationship Viewer. For instructions, see “Defining icons and tooltips for a class” on page 83.

Restricting which relationships are displayedWhen users graphically view the relationships between instances using the CI Relationship Viewer they choose a filter to limit which relationships are shown. This is a different concept from an AR System filter. For information about using the CI Relationship Viewer, see the User’s Guide.

You use the Manage Filters link from the CMDB Console to create and modify the filters that are available to users in the CI Relationship Viewer. A filter can restrict the display by a combination of any of these factors:

� Namespace—Only relationships and their members that reside in the selected namespace are shown.

� Relationship class—Only relationships from the selected classes and their subclasses are shown.

� CI class—Only related CIs from the selected classes are shown. CIs from subclasses are not shown.

� Number of levels—Related CIs up to the specified number of levels away from the selected CI are shown. For example, if you specify 2 levels, CIs directly related to the selected CI and CIs directly related to those CIs are shown.

Chapter 6 Other administrative tasks 183

Page 184: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

� Relationship direction—Only relationships in the specified direction from the selected CI are shown. Upstream relationships are those where the selected CI is the destination member, and downstream relationships are those where the selected CI is the source member.

For example, if you wanted to be able to select a computer system and view its components, you would use a filter that showed downstream relationships.

In version 2.1.00, when you select Both directions, the setting applies to all CIs and relationships in the graph. That is, CIs directly related to the selected CI in both directions are shown, CIs directly related to those CIs in both directions are shown, and so on. In previous releases, only relationships that continued in the same direction were shown. That is, for a CI upstream of the selected CI only its upstream relationships were shown and only upstream relationships of those CIs were shown. The same applied downstream.

NOTE Each relationship level shown in the CI Relationship Viewer consists of a relationship instance and a CI instance. 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 create a filter

1 In the navigation pane of the CMDB Console, under the Administration heading, click the Manage Filters link.

The CI Relationship Viewer Filters window appears.

Figure 6-5: CI Relationship Viewer Filters window

184 Installation and Configuration Guide

Page 185: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Configuring the CI Relationship Viewer

2 Click New.

The editable fields are reset and enabled.

3 In the Filter Settings tab, enter information in these required fields:

a Filter Name—Type a name for the filter.

b Namespace—Select a namespace for the filter to show.

c Number of levels—Type or select the number of relationship levels from the selected CI to show.

d Short Description—Type a description of the filter to display in the filter list.

4 Optionally, enter information in these fields:

a Show Relationships—Select the relationship classes for which instances, along with those of subclasses, should be shown.

b Show Classes—Select the CI classes for which instances should be shown.

c Relationship Direction—Select the direction of relationships to be shown:

� Downstream—Relationships where the selected CI is the source member are shown.

� Upstream—Relationships where the selected CI is the destination member are shown.

� Both—Relationships in both directions are shown.

5 In the Display Settings tab, modify the following display settings as appropriate:

a Default layout—Defines whether icons in the CI Relationship Viewer will display in a Tree or a Radial layout.

b Grouping Threshold—If the number of CIs of the same class is greater than the value of the Grouping Theshold, those CIs will automatically be grouped (displayed together as a folder icon).

c Show All Items on Double-click Threshold—When a group (folder icon) is double-clicked, this value defines the maximum number of individual CIs that will display when their folder is double-clicked. The threshold can be set to a relatively small value to prevent inadvertently displaying large numbers of CIs from a large group.

6 Click Save.

Defining visual characteristics You can define visual characteristics of the CI Relationship Viewer, such as color, font, context menu selections, and more. For information about defining these characteristics, see the Developer’s Reference Guide.

Chapter 6 Other administrative tasks 185

Page 186: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Controlling the layout of class forms The default view in the join form for a new regular class is generated using the form for its superclass as a basis. The forms for CDM classes also have more usable views, using page fields to organize content instead of placing all attribute fields in one column.

BMC Atrium CMDB provides two 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, Asset Management has its own form for a Computer System class. This utility can automatically update the Asset Management form to reflect any changes to the CMDB Computer System class. This utility, formerly known as cmdb2asset, existed for versions of BMC Atrium CMDB prior to version 2.0 but was unsupported.

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 created is 20. For cmdb2asset forms, the maximum number of custom tabs is 50.

In addition, the position of the attributes within the custom tab may 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 may be reverted back to the default.

For more information about AR System views, see BMC Remedy Action Request System 7.1.00: Form and Application Objects.

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 your own 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.

186 Installation and Configuration Guide

Page 187: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Controlling the layout of class forms

Forms in BMC Atrium CMDB Figure 6-6 shows an example view, for BMC_ComputerSystem.

Figure 6-6: BMC.CORE:BMC_ComputerSystem form—BMC Atrium CMDB 2.1.00

You can modify the view of any class form using BMC Remedy Administrator. This does not affect views for its existing subclasses.

Views for new subclasses When you create a subclass using the Class Manager or an API program, the subclass inherits the view of its superclass form. Any modifications you previously made to the superclass form’s view are passed on to the subclass.

Attributes you create for the new subclass are added to its view according to the algorithm described in the next section.

Adding attributes to views When you create a new attribute on a class, it is added to the class form’s view using this algorithm:

1 The field is placed on the page field named Custom0, underneath the last existing field on the page. If this page 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 page field cannot be created.

2 If no space remains on the Custom0 page, a Custom1 page is created and the field is placed at the top of it. This continues up to a maximum of 50 page fields.

Chapter 6 Other administrative tasks 187

Page 188: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

3 If 50 page 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.

NOTE Page 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 you want. To allow users to see the new attributes, move them off the page 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. In this case, the class form is arranged according to a default view template. Figure 6-7 shows this view.

Figure 6-7: Default view template for new base classes

Attributes represented by AR System core fields are placed in a single column at the top of the view, and attributes you create are placed in page fields below.

As with any other class form, you can modify the view to suit your needs, and any subclasses you create of this class inherit that modified view.

188 Installation and Configuration Guide

Page 189: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Controlling the layout of class forms

Forms in BMC Remedy IT Service Management applicationsIf you have BMC Remedy IT Service Management (ITSM) 7.0 or later applications installed and want their forms to reflect changes you have made to the BMC Atrium CMDB data model, perform this procedure.

� To duplicate data model changes in ITSM forms

1 Open BMC Remedy User and log in to the server where BMC Atrium CMDB and BMC Remedy ITSM are installed.

2 Choose Tools > Options and click the Advanced tab.

3 In the Default Form View field, type CMDB2ASSET, then click OK.

4 Search the SHR:SchemaNames form (which appears as Schema Names in the Object List) and search 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.

5 Select the record for the form you need, and then click Update Asset UI.

The BMC Atrium CMDB generates a new version of the form you selected.

Generating forms for other applicationsSome 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 keeps them synchronized with extensions you make to the data model.

You must configure the generation of your forms in advance to specify how you want them created and then, after modifying your data model, launch form generation.

� To configure form generation for another application

1 Using BMC Remedy Administrator, create a companion form for each class in your data model for which you want to generate forms.

These companion forms are the forms your application uses as its interface to BMC Atrium CMDB data, so create the look and feel that you want. They should have the same field IDs as their counterparts in the BMC Atrium CMDB forms. For best layout, the view should contain a page holder with field ID 300025400. This allows new attributes to be added to hidden pages on the page holder instead of being stacked in the upper left corner of the form.

Chapter 6 Other administrative tasks 189

Page 190: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

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 an input length of 80:

� 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.

� 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—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 is optional, and must be blank if a Secondary Join Form is specified.

� Secondary Join Form—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 is optional, and 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 classes 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 Wait until synchronization completes and no classes are in Change Pending state.

If any classes are still in Change Pending state, the form generation utility aborts with an error.

190 Installation and Configuration Guide

Page 191: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Controlling the layout of class forms

2 Create an entry in the Application Pending form, specifying these field values as shown in Figure 6-8 on page 192:

� Category—CMDB

� Command—Sync-UI

� Other Short—<command_syntax>

<command_syntax> must include these required parameters:

Table 6-4: Required parameters

<command_syntax> can also include these optional parameters:

Table 6-5: Optional parameters

Parameter Description

-f <config-form-name> The name of the form created in step 2 on page 190

-g <form-name-field-id> The field ID of the Form Name field on the form created in step 2 on page 190

-c <class-keyword-field-id> The field ID of the Class Keyword field on the form created in step 2 on page 190

-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.

-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.

Parameter Description

-R Specifies that forms are also generated for all subclasses of the class specified with -C.

-p <primary-join-form-name-field-id> The field ID of the Primary Join Form field on the form created in step 2 on page 190. If you populated the Primary Join Form field, you must specify this parameter.

-s <secondary-join-form-name-field-id> The field ID of the Secondary Join Form field on the form created in step 2 on page 190. 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.

Chapter 6 Other administrative tasks 191

Page 192: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Figure 6-8: New Application Pending entry to launch form generation

Log messages for each form generation are written to <AR_Server_install_directory>\ARServer\Db\CMDBSynchronizeUI_<timestamp>.log.

NOTE You can use workflow to create these Application Pending entries, but as mentioned in step 1 on page 190, it cannot execute while any classes are in Change Pending state.

Setting the cache refresh interval The BMC Atrium CMDB caches five types of metadata to provide faster performance. This data includes classes, attributes, indexes, datasets, and federated links.

Updates you make to datasets and federated links using their AR System forms or the CMDB Console are not available in BMC Atrium CMDB until the cache is refreshed.

Updates you make to classes, attributes, and indexes using the Class Manager are automatically cached when your updates finish synchronizing with the AR System.

Updates you make to any of these five types of metadata 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 AR System configuration file.

192 Installation and Configuration Guide

Page 193: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Creating CMDB status alerts

� To set the cache refresh interval

1 Edit the configuration file for the AR System server where BMC Atrium CMDB is installed.

� On Windows, this file is <ARserver_install_dir>\CONF\ar.cfg.

� On UNIX, this file is <ARserver_install_dir>/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.

Creating CMDB status alerts You can create status alerts to appear in the CMDB Status Alerts table on the CMDB Home tab of the CMDB Console. For information about this, see the Developer’s Reference Guide.

Chapter 6 Other administrative tasks 193

Page 194: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

194 Installation and Configuration Guide

Page 195: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Chapter

7

Logging BMC Atrium CMDB activity

This section explains how to configure and view logs for several types of BMC Atrium CMDB activity.

The following topics are provided:

� Class Manager (page 196)� CI Relationship Viewer (page 197)� Reconciliation Engine (page 198)� APIs (page 198)� Auditing instance history (page 198)

Chapter 7 Logging BMC Atrium CMDB activity 195

Page 196: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Class ManagerAfter you create or modify a class or relationship, the Class Manager must synchronize the changes to the data model with the AR System server. During this synchronization, the class or relationship’s status is Change Pending. If the status remains Change Pending for a long time, synchronization errors might have occurred.

You can view error messages in the Synchronization Log from the Class Manager or by logging them to a file.

Viewing the Synchronization LogWhen a class or relationship with a status of Change Pending is selected in the Class Manager, the View Log button is enabled as shown in Figure 7-1.

Figure 7-1: Class Manager Console with View Log button enabled

When you click View Log, the Synchronization Log appears, showing any error messages associated with changes pending for the selected class or relationship.

Figure 7-2: Synchronization Log

Click View Log to view the Synchronization Log.

196 Installation and Configuration Guide

Page 197: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

CI Relationship Viewer

Logging to a fileYou can add these parameters to your ar.conf or ar.cfg file to control Class Manager logging:

Table 7-1: Class Manager logging parameters

CI Relationship ViewerThe CI Relationship Viewer is an AR System data visualization field, using the BMC Remedy Mid Tier to create graphs. The Mid Tier offers logging for data visualization module activity.

� To enable CI Relationship Viewer logging

1 Log in to the Mid Tier Configuration Tool

The default URL is http://<web_server>:<port>/arsys/shared/config/config.jsp and default password is arsystem.

2 Click Log Settings to open the Log Settings window.

The Log Directory field shows the path where Mid Tier logs are stored.

3 Select Data Visualization Module, then click Save Changes.

Parameter Description

CMDB-Debug Whether Class Manager logging is enabled. Set to T (True) to enable logging. Set to F (False) to disable logging.

CMDB-Debug-Level The level of debugging. Value is from 1 to 5, inclusive. Production environments should not use levels greater than 2, but the default is 3.Level description:1 Severe messages only2 Warning messages3 Informational messages4 Fine tracing messages5 Finer tracing messages

CMDB-Log-File-Location The path to the log files. The default path is <install_dir>\Logs.

CMDB-Max-Log-File-Size The maximum log file size. When the log file reaches its maximum size, it is renamed using the current timestamp, and log messages continue to be written to the original file, which is now empty. A value of zero, which is the default, indicates no maximum.

Chapter 7 Logging BMC Atrium CMDB activity 197

Page 198: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

4 Restart the Mid Tier.

For more information about Mid Tier logging and configuration, see BMC Remedy Action Request System 7.1.00: Installing and Administering BMC Remedy Mid Tier. For more information about data visualization fields, see BMC Remedy Action Request System 7.1.00: Integrating with Plug-ins and Third-Party Products.

Reconciliation EngineThe default Reconciliation Engine log file path is C:\Program Files\AR System Applications\<server_name>\Reconciliation Engine\Logs. You can set the following options for logging of Reconciliation Engine activity:

� Log file path

� Logging level

� Maximum log file size

� Whether logging is enabled

For information about setting these options, see “Modifying the server configuration” on page 171.

APIsYou can log activity both for BMC Atrium CMDB APIs and AR System APIs. For information about logging BMC Atrium CMDB API activity, see the Developer’s Reference Guide. For information about logging AR System API activity, see BMC Remedy Action Request System 7.1.00: C API Reference.

Auditing instance historyYou 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.

For more information about the following subjects, see the Concepts and Best Practices Guide:

� Types of auditing (Copy and Log)

� Using a qualification to specify which instances are audited

198 Installation and Configuration Guide

Page 199: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Auditing instance history

� Using the attribute Audit option to specify which attributes trigger an audit and which are written during an audit

For information about viewing instance history from the CMDB Console, see the User’s Guide.

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.

� To configure auditing for a class

1 View the class in the Class Manager.

See “Viewing or modifying a class” on page 64.

2 Click the Auditing tab.

Figure 7-3: Class Information window—Auditing tab

3 From the Audit Type field menu, choose Copy or Log.

NOTE 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 the Concepts and Best Practices Guide.

4 If you selected Log auditing, enter the name of your log form in the Audit Log Form field or accept the default form name CMDB:DefaultAuditLog.

This is the form where log entries are stored for this class. If the form you specify does not exist, it is created automatically.

Chapter 7 Logging BMC Atrium CMDB activity 199

Page 200: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

5 In the Qualification field, type a qualification to specify which instances of the class are audited.

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.

NOTE Leave this field blank if you are creating a new class. You can only add an audit qualification to an existing class. After you have saved your new class and it has reached Active state, you can modify it to add this qualification.

Click Advanced Qualification to build a qualification interactively. For more information about the Advanced Qualification Builder, see “The Advanced Qualification Builder” on page 166.

6 Click the Attributes tab.

7 Select an attribute that you want to be included in audits and click View.

The Attribute Information window appears.

Figure 7-4: Attribute Information window—Audit Option field

8 From the Audit Option field menu, select the needed option for this attribute:

� 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.

200 Installation and Configuration Guide

Page 201: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Auditing instance history

� 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: 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.

9 Click Save to save changes to the attribute, then click Close to close the window.

10 Repeat step 7 through step 9 for each attribute that should be included in audits.

11 Click Save to save changes to the class, then click Close to close the window.

Chapter 7 Logging BMC Atrium CMDB activity 201

Page 202: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

202 Installation and Configuration Guide

Page 203: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Appendix

A

CDM 1.1 class destinations

This appendix lists all classes in the Common Data Model for version 1.1 of BMC Atrium CMDB and explains what happens to each when you upgrade to version 2.1.00.

The following topics are provided:

� CI classes (page 204)� Relationship classes (page 210)

Appendix A CDM 1.1 class destinations 203

Page 204: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

CI classes Table A-1 lists the destinations for CI classes when you upgrade from BMC Atrium CMDB 1.1.

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

BMC_AccessPoint Yes

BMC_AdminDomain Yes

BMC_AggregateSLAMeasurement BMC_BaseElement Class deleted and instances promoted

BMC_Application Yes

BMC_ApplicationConnectivity BMC_BaseElement Class deleted and instances promoted. Subclasses promoted to inherit from BMC_LogicalEntity

BMC_ApplicationInfrastructure Yes

BMC_ApplicationServer Application extension

BMC_ApplicationService Yes

BMC_ApplicationSystem Yes

BMC_AssetBase Yes BMC_BaseElement Name change only

BMC_BIOS Yes BMC_BIOSElement Name change only

BMC_BusinessProcess Moved within the hierarchy. Now a subclass of BMC_Activity

BMC_Card Yes

BMC_CDROMDrive Yes

BMC_Chassis Yes

BMC_City If instances or subclasses exist, stays

BMC_Cluster Yes

BMC_ComputerSystem Yes

BMC_Connectivity BMC_BaseElement Class deleted and instances promoted. Subclasses promoted to inherit from BMC_LogicalEntity

BMC_ConnectivityGroup Yes

BMC_ConnectivitySegment Yes

BMC_DataBase Yes

BMC_DataBaseReplication BMC_BaseElement Class deleted and instances promoted. Subclasses promoted to inherit from BMC_LogicalEntity

204 Installation and Configuration Guide

Page 205: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

CI classes

BMC_DataBaseReplicationServer Application extension

BMC_DataBaseServer Application extension

BMC_DataBaseStorage Yes

BMC_DataBaseSystem BMC_ApplicationInfrastructure

Class deleted and instances promoted. Subclasses become subclasses of BMC_ApplicationInfrastructure with instances intact

BMC_DirectoryServer Application extension

BMC_DiskDrive Yes

BMC_DiskPartition Yes

BMC_DNSServer Application extension

BMC_EthernetPort BMC_NetworkPort Class deleted and instances promoted. PortType attribute set to EthernetPort

BMC_FDDIPort BMC_NetworkPort Class deleted and instances promoted. PortType attribute set to FDDIPort

BMC_FileSystem Yes

BMC_FileSystemShare BMC_Share Class deleted and instances promoted

BMC_FloppyDrive Yes

BMC_FTPServer Application extension

BMC_GenericGroup Yes BMC_Collection Name change only

BMC_Geography If instances or subclasses exist, stays

BMC_Group Class deleted, or if instances exist it stays as a custom extension. In either case, subclasses become subclasses of BMC_Collection with instances intact

BMC_HardwareCluster BMC_Cluster Class deleted and instances promoted. ClusterType attribute set to Hardware Cluster

BMC_HardwarePackage Yes

BMC_HardwareSystemComponent Yes

BMC_InventoryStorage BMC Remedy Asset Management extension

BMC_IPConnectivitySubnet Yes

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

Appendix A CDM 1.1 class destinations 205

Page 206: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

BMC_IPEndpoint Yes

BMC_IPXConnectivityNetwork Yes

BMC_J2EEAdminDomain J2EE extension

BMC_J2EEAppClientModule J2EE extension

BMC_J2EEApplication J2EE extension

BMC_J2EEApplicationServer J2EE extension

BMC_J2EECluster J2EE extension

BMC_J2EEEJBModule J2EE extension

BMC_J2EEJavaMailResource J2EE extension

BMC_J2EEJCAResource J2EE extension

BMC_J2EEJDBCResource J2EE extension

BMC_J2EEJMSResource J2EE extension

BMC_J2EEJNDIResource J2EE extension

BMC_J2EEJTAResource J2EE extension

BMC_J2EEModule J2EE extension

BMC_J2EEResource J2EE extension

BMC_J2EEResourceAdapterModule J2EE extension

BMC_J2EERMIIIOPResource J2EE extension

BMC_J2EEServlet J2EE extension

BMC_J2EEURLResource J2EE extension

BMC_J2EEWebModule J2EE extension

BMC_Keyboard Yes

BMC_LAN Yes

BMC_LANEndpoint Yes

BMC_LDAPServer Application extension

BMC_LNsGroup Yes BMC_LNsCollection Name change only

BMC_LoadBalancerServer Application extension

BMC_LoadBalanceSystem BMC_ApplicationInfrastructure

Class deleted and instances promoted

BMC_LocalFileSystem Yes

BMC_LocalPrinter BMC_Printer Merged with BMC_NetworkPrinter and moved within the hierarchy. Now a subclass of BMC_ComputerSystem.

BMC_LogicalComponent Yes BMC_LogicalEntity Name change only

BMC_LogicalSystemComponent Yes

BMC_LPAR BMC_VirtualSystem Class deleted and instances promoted

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

206 Installation and Configuration Guide

Page 207: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

CI classes

BMC_MailServer Application extension

BMC_Mainframe Yes

BMC_Media Yes

BMC_Memory Yes

BMC_Monitor Yes

BMC_MSIISServer Application extension

BMC_MSSQLDataBaseServer Application extension

BMC_NetworkConnectivity BMC_BaseElement Class deleted and instances promoted. Subclasses promoted to inherit from BMC_LogicalEntity

BMC_NetworkPort Yes

BMC_NetworkPrinter BMC_Printer Merged with BMC_LocalPrinter and moved within the hierarchy. Now a subclass of BMC_ComputerSystem.

BMC_NewsServer Application extension

BMC_NTDomain Yes

BMC_OperatingSystem Yes

BMC_OracleDataBaseServer Application extension

BMC_Organization Yes

BMC_OSPatch BMC_Patch Class deleted and instances promoted

BMC_Package Yes

BMC_Patch Yes

BMC_PhysicalLocation Yes

BMC_PointingDevice Yes

BMC_Processor Yes

BMC_Product Yes

BMC_ProtocolEndpoint Yes

BMC_Rack Yes

BMC_Region If instances or subclasses exist, stays

BMC_RemoteFileSystem Yes

BMC_SAPApplication SAP extension

BMC_SAPApplicationServer SAP extension

BMC_SAPBackgroundService SAP extension

BMC_SAPDatabaseSystem SAP extension

BMC_SAPDBResource SAP extension

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

Appendix A CDM 1.1 class destinations 207

Page 208: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

BMC_SAPDialogService SAP extension

BMC_SAPEnqueueService SAP extension

BMC_SAPGatewayService SAP extension

BMC_SAPMessageServerService SAP extension

BMC_SAPModule SAP extension

BMC_SAPPrinterResource SAP extension

BMC_SAPResource SAP extension

BMC_SAPService SAP extension

BMC_SAPSoftwareComponent SAP extension

BMC_SAPSpoolService SAP extension

BMC_SAPSystem SAP extension

BMC_SAPUpdateService SAP extension

BMC_SecureShellServer Application extension

BMC_Service BMC_BusinessService Moved within the hierarchy. Now a subclass of BMC_LogicalEntity

BMC_Share Yes

BMC_Site If instances or subclasses exist, stays

BMC_SLAConfiguration BMC_BaseElement Class deleted and instances promoted

BMC_Software Yes

BMC_SoftwareCluster BMC_Cluster Class deleted and instances promoted. Subclasses become subclasses of BMC_Cluster with instances intact

BMC_SoftwareServer Yes

BMC_SybaseDataBaseServer Application extension

BMC_System Yes

BMC_SystemComponent Yes

BMC_SystemResource Yes

BMC_SystemService Yes

BMC_SystemSoftware Yes

BMC_TapeDrive Yes

BMC_TCPEndpoint Yes BMC_CommunicationEndPoint

Merged with BMC_UDPEndpoint and renamed

BMC_TelnetServer Application extension

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

208 Installation and Configuration Guide

Page 209: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

CI classes

BMC_TokenRingPort BMC_NetworkPort Class deleted and instances promoted. PortType attribute set to TokenRingPort

BMC_UDPEndpoint BMC_CommunicationEndPoint

Merged with BMC_TCPEndpoint and moved within the hierarchy.

BMC_UPS Yes

BMC_UserCommunity Yes Moved within the hierarchy. Now a subclass of BMC_Collection

BMC_VirtualSystem Yes

BMC_VirtualSystemEnabler Yes

BMC_VMWare Yes

BMC_WAN Yes

BMC_WANPort BMC_NetworkPort Class deleted and instances promoted. PortType attribute set to WANPort

BMC_WebServer Application extension

Table A-1: CI class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

Appendix A CDM 1.1 class destinations 209

Page 210: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Relationship classes Most relationship classes from version 1.1 were removed from the CDM in version 2.0. Table A-2 lists the destinations for relationship classes.

To retain the ability to categorize relationships in detail given the fewer relationship classes available in version 2.0, a Name attribute is added to the base relationship class BMC_BaseRelationship. For instances that are promoted in the upgrade process, this attribute is populated with a short version of their old class ID. For example, when instances of BMC_BindsTo are promoted to be instances of BMC_Dependency, their Name attribute has a value of BINDSTO.

Use the Name attribute when creating new relationships. Future versions of BMC Software products will require that this attribute contain a normalized value. For information about these normalized values, see the Relationship Normalization Table in the Common Data Model Diagram, which is installed in the sdk\doc directory with BMC Atrium CMDB.

Table A-2: Relationship class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

BMC_AffinityDependency BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemAdminServicePort

BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemClientSAP BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemComputer BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemDependency

BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemHierarchy BMC_Component Class deleted and instances promoted

BMC_ApplicationSystemOS BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemProduct BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemSAP BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemServiceClientPort

BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemServicePort

BMC_Dependency Class deleted and instances promoted

BMC_ApplicationSystemServices Yes

BMC_BindsTo BMC_Dependency Class deleted and instances promoted

210 Installation and Configuration Guide

Page 211: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Relationship classes

BMC_ClusteredSystem BMC_Component Class deleted and instances promoted

BMC_Component Yes

BMC_ContainedDomain BMC_Component Class deleted and instances promoted

BMC_CSInIPSubnet BMC_MemberOfCollection Class deleted and instances promoted

BMC_CSInSegmen BMC_MemberOfCollection Class deleted and instances promoted

BMC_DataBaseDataStorage BMC_Component Class deleted and instances promoted

BMC_DataBaseReplicatedBy BMC_Dependency Class deleted and instances promoted

BMC_DataBaseReplicationMaster BMC_Dependency Class deleted and instances promoted

BMC_DataBaseReplicationTarget BMC_Dependency Class deleted and instances promoted

BMC_Dependency Yes

BMC_DeployedApplication BMC_Dependency Class deleted and instances promoted

BMC_DiskDrivePartition BMC_Dependency Class deleted and instances promoted

BMC_ElementLocation Yes

BMC_FileSystemPartition BMC_Dependency Class deleted and instances promoted

BMC_HostedAccessPoint Yes

BMC_HostedService Yes

BMC_HostedSystemComponents Yes

BMC_HostedVirtualSystem BMC_Dependency Class deleted and instances promoted

BMC_Impact BMC_Impact_1.1 BMC Impact Solutions extension, moved to namespace BMC.SIM. Renamed so that BMC Impact Solutions can install its own BMC_Impact class.

BMC_InIPSubnet Yes

BMC_InSegment Yes

BMC_InstalledPatch BMC_Component Class deleted and instances promoted

BMC_InstalledProduct BMC_HostedSystemComponents

Class deleted and instances promoted

Table A-2: Relationship class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

Appendix A CDM 1.1 class destinations 211

Page 212: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

BMC_InventoryBulkItems BMC_Dependency Class deleted and instances promoted

BMC_InventoryComputerSystems BMC_Dependency Class deleted and instances promoted

BMC_InventorySystemComponents BMC_Dependency Class deleted and instances promoted

BMC_IPSubnetsInGroup Yes BMC_IPSubnetInCollection Name change only

BMC_J2EEApplicationModule J2EE extension

BMC_J2EEClusterOfDomain BMC_MemberOfCollection Class deleted and instances promoted

BMC_J2EEDeployedApplication BMC_Dependency Class deleted and instances promoted

BMC_J2EEModuleUsesJ2EEModule BMC_Dependency Class deleted and instances promoted

BMC_J2EEServletsInModule BMC_Component Class deleted and instances promoted

BMC_J2EESystemOfDomain BMC_MemberOfCollection Class deleted and instances promoted

BMC_LNsInGroup Yes BMC_LNsInCollection Name change only

BMC_LoadBalancedSystem BMC_Component Class deleted and instances promoted

BMC_LoadBalancingSystem BMC_Component Class deleted and instances promoted

BMC_ManagedDataBase BMC_Component Class deleted and instances promoted

BMC_MemberOf BMC_MemberOfCollection Class deleted and instances migrated

BMC_MemberOfGroup BMC_MemberOfCollection Class deleted and instances promoted

BMC_ModuleResourceDependency BMC_Dependency Class deleted and instances promoted

BMC_PartOfDomain BMC_MemberOfCollection Class deleted and instances promoted

BMC_ProductInPackage BMC_Component Class deleted and instances promoted

BMC_ResourceDataBase BMC_Dependency Class deleted and instances promoted

BMC_ResourceProvidesAccessToElement

BMC_Dependency Class deleted and instances promoted

BMC_SAPApplicationAppSrv BMC_Dependency Class deleted and instances promoted

Table A-2: Relationship class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

212 Installation and Configuration Guide

Page 213: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Relationship classes

BMC_SAPApplicationModules BMC_Component Class deleted and instances promoted

BMC_SAPAppSrvServices BMC_ApplicationSystem Class deleted and instances promoted

BMC_SAPDBResourceApplicationSystem

BMC_Dependency Class deleted and instances promoted

BMC_SAPDBSystemDBSystem BMC_Dependency Class deleted and instances promoted

BMC_SAPDeployedApplication BMC_Dependency Class deleted and instances promoted

BMC_SAPModuleAppSrv BMC_Dependency Class deleted and instances promoted

BMC_SAPPrinterResourcePrinter BMC_Dependency Class deleted and instances promoted

BMC_SAPSoftwareComponentApplication

BMC_Component Class deleted and instances promoted

BMC_SAPSystemApplication BMC_Component Class deleted and instances promoted

BMC_SAPSystemAppSrv BMC_Component Class deleted and instances promoted

BMC_SAPSystemDBSystem BMC_Component Class deleted and instances promoted

BMC_SAPSystemSoftwareComponent BMC_Component Class deleted and instances promoted

BMC_SegmentsInGroup Yes BMC_SegmentInCollection Name change only

BMC_ServiceAccessByAP BMC_Dependency Class deleted and instances promoted

BMC_ServiceSLA BMC_Impact_1.1 (see “BMC_Impact” on page 211)

Class deleted and instances promoted. New class is a BMC Impact Solutions extension

BMC_SubHWComponent BMC_Component Class deleted and instances promoted

BMC_SystemBIOS BMC_HostedSystemComponents

Class deleted and instances promoted

BMC_SystemHardware BMC_HostedSystemComponents

Class deleted and instances promoted

BMC_SystemOS BMC_HostedSystemComponents

Class deleted and instances promoted

BMC_SystemPartition BMC_Component Class deleted and instances promoted

BMC_SystemResources BMC_HostedSystemComponents

Class deleted and instances promoted

Table A-2: Relationship class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

Appendix A CDM 1.1 class destinations 213

Page 214: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

BMC_SystemServiceServiceDependency

BMC_Dependency Class deleted and instances promoted

BMC_UseHardware BMC_Dependency Class deleted and instances promoted

BMC_UseResource BMC_Dependency Class deleted and instances promoted

BMC_VirtualSystemOS BMC_Dependency Class deleted and instances promoted

Table A-2: Relationship class destinations

1.1 class name In CDM 2.0?

Renamed to or instances promoted to

Remarks

214 Installation and Configuration Guide

Page 215: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Glossary

abstract classA class that has attributes but of which no instances can be created. An abstract class exists for the purpose of creating an organizational layer without a database join. See also data replication.

accountAn entity or party whose data is represented in BMC Atrium CMDB, and to whom specific levels of permission can be granted. Specifying instance permission by account enables BMC Atrium CMDB to support multitenancy.

activityAn individual reconciliation task that can be grouped together in a defined sequence to form a reconciliation job. You cannot run an activity by itself; only as part of a job. See also Comparison activity, Copy Dataset activity, Delete Dataset activity, Execute Job activity, Identification activity, Merge activity, Purge Dataset activity, Rename Dataset activity.

attributeA property or characteristic of a class, such as the IP address of a computer system. An attribute equates to a column on a database table or a field on an AR System form.

attribute permissionPermission to view or change the value in the attribute for any instance, assuming valid instance permissions.

attribute substitutionA method of data federation in context that uses placeholders to represent attributes from a linked class. Launching the link triggers the respective attribute values to be substituted for the placeholders.

auditA logging of attribute values and other information for purposes of tracking the history of changes to instance data. An audit is triggered when the value of one or more specified attributes changes or when the instance is created or deleted.

base classA class that has no superclass.

BMC Atrium Integration EngineA product that enables you to transfer large amounts of data between third-party data sources and both the AR System and BMC Atrium CMDB.

Business Service Management (BSM)The concept of prioritizing IT efforts to support the overall goals of the business.

cardinalityThe number of members a relationship class can have on each side. Cardinality can be one to one, one to many, many to one, or many to many.

cascading deleteTo automatically delete, or mark as deleted, the destination member of a relationship when the source member is deleted or marked.

Categories, Types, and Items (CTI)A method formerly used for categorizing assets in BMC Remedy Asset Management. Category, Type, and Item are each an attribute on the BMC_BaseElement class, so you can use CTIs in BMC Atrium CMDB.

Glossary 215

Page 216: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

categorization classA class that does not have its own AR System form, but stores its instance data in the form of its superclass, preventing the need for a database join.

CDMSee Common Data Model (CDM).

childSee destination.

CISee configuration item (CI).

CI classA class that defines a type of configuration item (CI), such as a computer system or software application.

CI Relationship ViewerA component of BMC Atrium CMDB that graphically displays the relationships between CIs. It can also be embedded in other AR System-based applications.

CI Relationship Viewer eventA message sent to the CI Relationship Viewer from AR System workflow to change its settings. The CI Relationship Viewer can also send AR System events.

CIMSee Common Information Model (CIM).

classMetadata in BMC Atrium CMDB that defines a type of object, usually a configuration item (CI) or relationship. Either of these types of class can store data as a regular class, categorization class, abstract class, or abstract class with data replication. You can apply the final class and singleton class options to it as well.

Class ManagerA component of BMC Atrium CMDB where you can view, create, modify, and delete the classes and attributes that make up the data model, as well as view a list of subclasses for each class.

class permissionsPermission to view instances of a class in the BMC Atrium CMDB interface or access them with AR System workflow.

CMDBSee Configuration Management Database (CMDB).

CMDB ConsoleThe main user interface of BMC Atrium CMDB, accessible from both web and BMC Remedy User clients.

CMDB Console UserAn application role. Members can perform searches from the CMDB Console and view federation definitions.

CMDB Console AdminAn application role. Members can perform searches from the CMDB Console, view, create, and modify federation definitions, and perform CMDB Console administrative tasks.

CMDB Data ChangeAn application role. Members can view, create, and modify instances if they have row-level security.

CMDB Data Change AllAn application role. Members can view, create, and modify instances independent of row-level security.

CMDB Data ViewAn application role. Members can view instances if they have row-level security.

CMDB Definitions AdminAn application role. Members can view, create, modify, and delete classes.

CMDB Definitions ViewerAn application role. Members can view class definitions.

CMDB Extended DataRelated data or CI attributes linked to or from BMC Atrium CMDB.

CMDB RE Definitions AdminAn application role. Members can view, create, modify, and delete reconciliation definitions and can start and cancel jobs.

216 Installation and Configuration Guide

Page 217: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Glossary

CMDB RE Manual IdentificationAn application role. Members can identify instances manually.

CMDB RE UserAn application role. Members can view reconciliation definitions and can start and cancel jobs.

cmdbdriverA utility that executes BMC Atrium CMDB C API functions from a command line, prompting for parameters.

Common Data Model (CDM)The object-oriented, hierarchical set of classes in BMC Atrium CMDB used to represent types of CIs and relationships. The CDM is based on industry standards such as the Common Information Model (CIM) and Microsoft’s Windows Management Instrumentation.

Common Information Model (CIM)A definition of management information developed by the Distributed Management Task Force (DMTF) that facilitates the exchange of management information between systems.

Comparison activityA Reconciliation Engine activity that compares identified instances between two datasets, either producing a report that shows the differences or executing workflow.

configuration dataData about your IT environment, consisting of CIs and relationships.

configuration item (CI)A physical, logical, or conceptual entity that is part of your IT environment and has configurable attributes. Examples include computer systems, buildings, employees, software, and business services. One of the two types of classes in BMC Atrium CMDB. See also relationship.

Configuration Management Database (CMDB)A database that stores information about your IT configuration, including both CIs and relationships.

consumerAn application that works with data in BMC Atrium CMDB. It might view the data or modify it. See also provider.

Copy Dataset activityA Reconciliation Engine activity that copies instances from one dataset to another.

CTISee Categories, Types, and Items (CTI).

data replicationAn option for abstract classes. With this option, the instances of all subclasses are replicated to a single form to allow you to search the abstract class as though it had data. Only the attributes inherited from the abstract class are replicated.

datasetA logical group of data in BMC Atrium CMDB. A dataset can represent data from a particular source, a snapshot from a particular date, or other purpose. The dataset used by BMC Software products for reconciled production data is named BMC Asset. See also overlay dataset.

Dataset Merge PrecedenceA pairing of a dataset with a Precedence group. Each Merge activity references a collection of these, called a Dataset Merge Precedence set.

defined datasetOne of a pair of dataset IDs that is specified when executing a job with dynamic dataset substitution. The job is executed with the working dataset in place of the defined dataset.

Definitive Software Library (DSL)A repository where approved software configurations are stored. Installed instances of the software can be checked against the DSL for compliance with licenses and policies.

Delete Dataset activityA Reconciliation Engine activity that deletes instances from one or more datasets without removing the dataset itself. See also cascading delete, hard delete, and soft delete.

Glossary 217

Page 218: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

destinationThe CI class defined as Class 2 in a relationship class, or an instance of that CI class as a member of such a relationship. Also known as the child member or weak member.

discoveryThe act of scanning your environment for configuration data.

discovery applicationAn application that scans your environment for configuration data and can act as a provider to BMC Atrium CMDB.

Distributed Management Task Force (DMTF)An organization appointed to facilitate the exchange of management information by promoting the initiation of industry standards and interoperability.

DMTFSee Distributed Management Task Force (DMTF).

DSLSee Definitive Software Library (DSL).

Enterprise Integration EngineSee BMC Atrium Integration Engine.

eventA particular type of change to the instances of specified classes. You can publish an event so that any instance of it is written to the CMDB:Events form. You can receive notification each time an instance of the event occurs by polling the form. See also CI Relationship Viewer event.

Exclusion ruleA rule that specifies an attribute to be excluded from participation in a Comparison activity.

Execute Job activityA Reconciliation Engine activity that executes a job.

extensionA logical set of classes and attributes, usually in its own namespace, that is not part of the Common Data Model (CDM).

extension loaderThe cmdbExtLoader program, which is used for installing data model extensions and importing other BMC Atrium CMDB data and metadata.

federated dataData linked from CIs in BMC Atrium CMDB but stored externally. Federated data might represent more attributes of the CIs or related information such as change requests on the CIs.

federated interfaceAn instance of the BMC_FederatedInterface class that specifies how to access a particular type of federated data. See also federated link.

federated linkThe connection between a class or CI and a federated interface.

federated productA product that holds federated data. It can be linked to more than one federated interface.

federationThe act of linking CIs in BMC Atrium CMDB to external data.

Federation ManagerA component of BMC Atrium CMDB that you can use to manage federated data. From the Federation Manager, you can view, create, and modify federated products, federated interfaces, and federated links.

filterA set of criteria for restricting the information displayed by the CI Relationship Viewer. This is different from an AR System filter.

final classA class that cannot have subclasses.

foreign key substitutionA method of federation that assigns a key from the federated product to each linked CI. Foreign key substitution is useful when no attributes that also exist in BMC Atrium CMDB are stored in the federated product.

218 Installation and Configuration Guide

Page 219: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Glossary

groupA set of a particular type of reconciliation definition that is referenced by an activity. See also Identification group, Precedence group, Qualification group, Workflow Execution group.

GUIDA globally unique identifier, automatically generated by the AR System server. GUIDs are used for instance IDs, reconciliation IDs, and other cases where a unique value is needed without human interaction.

hard delete The act of removing an instance from BMC Atrium CMDB.

Identification activityA Reconciliation Engine activity that matches instances from two or more datasets and assigns them the same identity, meaning that they represent the same real-life object.

Identification groupA set of Identification rules that collectively identify instances from a particular dataset against other datasets. Each dataset that participates in an Identification activity is paired with one Identification group.

Identification ruleA rule used when identifying instances between datasets. When two instances match the qualification for the rule, they are assigned the same reconciliation ID.

identitySee reconciliation ID.

incidentDefined by ITIL as any event that is not part of the standard operation of a service and which causes, or might cause, an interruption to, or a reduction in, the quality of that service.

incremental mergeA Merge activity that only processes instances that were created or modified since the activity was last run, saving otherwise useless processing time. Setting Force Attribute Merge to No makes a Merge activity incremental.

instanceAn actual incarnation of a particular class, represented as a record in BMC Atrium CMDB. Both CIs and relationships are instances of their respective classes.

instance IDA GUID that BMC Atrium CMDB applies to each instance to uniquely identify it.

instance permissionsThe right to view or modify a specific instance. These permissions are called row-level security and write security, respectively.

instantiateTo create an instance of a class.

ITILThe Information Technology Infrastructure Library (ITIL) is an internationally accepted set of best practices for management of IT services developed by the British government

jobA group of one or more reconciliation activities executed in sequence. You cannot run an activity by itself; only as part of a job. You can start a job manually, with a schedule, with an Execute Job activity, with workflow, or with an API program.

Merge activityA Reconciliation Engine activity that merges two or more datasets into a single complete and correct dataset based on precedence values that favor the strengths of each dataset.

metadataDefinitions that describe the data stored in BMC Atrium CMDB. Metadata includes classes in the data model and special classes to define things such as datasets and federation objects.

multitenancyThe separation of data and access so that a single BMC Atrium CMDB can contain the data of multiple parties, but each party can access only their own data. See also account and role.

Glossary 219

Page 220: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

namespaceA logical set of classes and attributes in the data model, usually related to a specific consumer or provider. The Common Data Model (CDM) uses the BMC.CORE namespace.

normalizeTo ensure that data of the same type follows the same text formatting conventions. This helps reconciliation by making it more likely for instances to match in an Identification activity.

orphanAn instance that has been physically deleted from source datasets but still exists in the target dataset into which they merge.

overlay datasetA dataset that provides a layer in which to make changes that are pending approval. API queries to the dataset seamlessly return its modified instances along with unmodified instances from the underlying regular dataset.

parentSee source.

Precedence groupThe definition of an overall precedence value for a dataset. It can optionally contain precedence values for specific classes and attributes within the dataset.

precedence valueA method of assigning weight to specific datasets, classes, and attributes in a Merge activity. Attribute precedence values override class precedence values, which override dataset precedence values.

production datasetThe dataset that serves as the single source of reference for your organization and from which you make business decisions. It acts as the target dataset in most Merge activities.

providerAn application, often a discovery application, that loads bulk data into BMC Atrium CMDB. See also consumer.

provisioningThe process of providing access to resources, such as printers, telephones, and such, and to information, such as permissions, databases, and so on.

publishTo make an event available so that instances of it can be written to the CMDB:Events form.

Purge Dataset activityA Reconciliation Engine activity that removes instances that have been marked as deleted from one or more datasets.

QualificationA Boolean statement that is evaluated to determine whether an instance should be included in an activity.

Qualification groupA set of Qualifications that can be used in various types of activity. An instance that meets one or more Qualifications in the group is included in the activity.

reconciliationThe process of managing data in multiple datasets using the Reconciliation Engine. The main activities of reconciliation are identifying, comparing, and merging datasets, though the Reconciliation Engine performs other activities as well.

reconciliation definitionAn entity defined in the Reconciliation Manager such as a job, activity, or group.

Reconciliation EngineThe component of BMC Atrium CMDB that reconciles data from different datasets.

reconciliation IDA GUID that the Reconciliation Engine assigns to instances in different datasets that represent the same real-life object.

Reconciliation ManagerThe component of BMC Atrium CMDB that you can use to manage reconciliation definitions.

220 Installation and Configuration Guide

Page 221: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Glossary

regular classA class that stores its instance data in its own AR System form. See also abstract class, categorization class.

related informationInformation about a CI that does not qualify as attributes of the CI, and should therefore not be stored in a Configuration Management Database (CMDB).

relationshipA connection between two CIs such as a dependency or membership. It is an instance of a relationship class. See also configuration item (CI).

relationship classA class that defines a type of relationship between CIs, such as a dependency or membership.

relationship filterSee filter.

Rename Dataset activityA reconciliation activity that renames a dataset without changing its ID, preserving references to the dataset from any reconciliation definitions.

roleA designation that grants permissions to more than one AR System group.

row-level securityThe permission required to view a specific instance. See also write security.

ruleOne or more criteria that, when met, cause an action. The types of rules used in BMC Atrium CMDB are Exclusion rule, Identification rule, and Workflow Execution rule.

rulesetA group of rules.

service level agreementA contract between a service provider and a purchaser that defines the level of service.

singleton classAn optional class characteristic that restricts the class to holding only one instance.

snapshotA set of data that represents a configuration at a certain point in time, usually stored in its own dataset. There can be multiple snapshots of a given configuration.

soft deleteThe act of marking an instance as deleted from BMC Atrium CMDB by setting the MarkAsDeleted attribute to Yes.

sourceThe CI class defined as Class 1 in a relationship class, or an instance of that CI class as a member of such a relationship. Also known as the parent member or strong member.

subclassA class that is derived from another class, which is called its superclass. The subclass inherits all the attributes of its superclass and any superclasses above it in the hierarchy, and can also participate in relationships defined for all superclasses.

superclassA class from which other classes, called subclasses, are derived.

synchronizationThe automatic process of creating AR System forms and workflow to represent a class that has just been created or modified. The class is not available until synchronization completes.

text normalizationSee normalize.

weak referenceSee weak relationship.

weak relationshipAn optional characteristic for relationship classes, signifying that the members of a relationship form a composite object that can be reconciled as one. The destination member is considered the weak member of a weak relationship, existing as part of the source member.

Glossary 221

Page 222: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

BMC Atrium CMDB 2.1.00

Windows Management Instrumentation (WMI)Microsoft's application of the Web-Based Enterprise Management initiative for an industry standard for accessing management information.

WMISee Windows Management Instrumentation (WMI).

workflowAR System objects such as active links, escalations, and filters that perform actions against data.

Workflow Execution groupA set of Workflow Execution rules. Each Comparison activity can optionally reference one Workflow Execution group.

Workflow Execution ruleA rule used when comparing instances between datasets. When a compared instance matches the qualification for the rule, specified AR System workflow is executed against the instance or the instance against which it is compared.

working datasetOne of a pair of dataset IDs that is specified when executing a job with dynamic dataset substitution. The job is executed with the working dataset in place of the defined dataset.

write securityThe permission required along with row-level security to modify or delete a specific instance.

222 Installation and Configuration Guide

Page 223: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Index

Aaccessing

BMC Atrium CMDB user interface 53CMDB Console 53web services 52

activities, removing from a job 156alerts, creating status 193APIs, logging 198application roles

CMDB Console Admin 57CMDB Console User 57CMDB Data Change 56CMDB Data Change All 56CMDB Data View 56CMDB Data View All 56CMDB Definitions Admin 57CMDB Definitions Viewer 57CMDB RE Definitions Admin 57CMDB RE Manual Identification 57CMDB RE User 57

applicationsgenerating forms for 189roles 56

AR SystemAPI activity logs 198computed groups 58field permissions 59form permissions 58installing BMC Atrium CMDB with server

group 43roles 58

AR System, shutting down applications 25ar.cfg, configuring 171ar.conf, configuring 171assigning permissions roles 58Attribute Information window 200attribute permissions 59attribute substitution 98attributes

adding to views 187deleting 79

attributes (continued)modifying 79viewing 79

attributes, propagating for weak relationships 82audience for this guide 9Audit Option field 200auditing

attribute options 200configuring, for a class 199overview 198

Auditing tab 199auto-identify datasets 120

Bbase classes, views 188Best Practice icon 9BMC Atrium CMDB

accessing the user interface 53cache refresh interval 192class forms 187Common Data Model classes 203–214creating status alerts 193documentation 10, 12event notification 176federated data 94installing on UNIX 41installing on Windows 28logging API activity 198permissions

attribute 58class 58default instance 60instance 59roles 56

rolesapplication 56permissions 56

sample filter 177sample form 177

Index 223

Page 224: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

BMC Atrium CMDB (continued)uninstalling on UNIX 46uninstalling on Windows 38

BMC Remedy Userenabling CI Distribution graph 49enabling flashboards 49

BMC Software, contacting 2BMC_DefaultAccountPermissions form 60

Ccaches, setting refresh interval 192canceling jobs 161change Pending entries 87Change Pending status 196changes, error messages for pending 196changing attribute permissions 59CI classes destination 204CI Distribution graph, enabling 49CI Relationship Viewer

configuring 183creating filters 184defining

icons 83tooltips 83visual characteristics 185

filtering relationships 183installing 15restricting displayed relationships 183

CI Relationship Viewer Filters window 184CIs

linking to federated interfaces 99upgrading classes 204

class destinations, about 204class forms, controlling the layout 186Class Information window 80, 199Class Manager

class hierarchies 65creating CI classes 66creating relationships 68deleting classes 65logs

about 196configuring 197location 197Synchronization 196

modifying classes 64Permissions tab 59tabs 64viewing error messages 88

class permissions, setting 79

classesadding attributes to forms 187Change Pending status 196Common Data Model 203–214configuring auditing 199controlling layout of forms 186creating CI 66deleting 65destinations for CI 204destinations for relationship 210forms for base 188forms, adding views and workflow 65generating help for 88icons 84indexing 80linking to federated instances 99modifying 64moved due to upgrading 20permissions

about 58default instance 60

remaining after upgrading 20tooltips 86unused

modified 20unmodified 20

upgrading CI 204upgrading relationship 210user-defined 20viewing hierarchies 65

CMDB Consoleaccessing 53URL 53

CMDB Console Admin role 57CMDB Console User role 57CMDB Data Change All role 56CMDB Data Change role 56CMDB Data View All role 56CMDB Data View role 56CMDB Definitions Admin role 57CMDB Definitions Viewer role 57CMDB Home tab 49CMDB RE Definitions Admin role 57CMDB RE Manual Identification role 57CMDB RE User role 57CMDB status alerts, creating 193CMDB:EventGenerator filter 177CMDB:Events form 176, 182CMDB:Sample:EventNotification form 177cmdb2asset utility 186CMDBRowLevelSecurity permission 59CMDBWriteSecurity permission 59

224 Installation and Configuration Guide

Page 225: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Common Data Model classes 203–214comparing datasets 133computed groups, AR System 58configuration items. See CIsconfiguring

ar.cfg and ar.conf 171auditing 199CI Relationship Viewer 183Class Manager logs 197federated data 93–101form generation 189Reconciliation Engine logs 198

consoles, Manual Identification 122Create Filter window 177creating

CI classes 66datasets 141federated links 99filters for CI Relationship Viewer 184forms for applications 189forms for ITSM 189icons for classes 83Identification groups 115indexes on the class form 80instance permissions 60instance permissions, default 60Precedence groups 125Qualification groups 164relationships 68status alerts 193tooltips for classes 83

custom properties, setting 71customer support 3customizing Class Manager logs 197

Ddata

See also federated datachanges to model 19migration due to upgrading 19

data modelchanges due to upgrading 19generating help for 88

data storage setting 71datasets

about 148auto-identifying 114comparing 133creating 141identifying instances 114

datasets (continued)merging data 123renaming 148

DB2, prerequisites for upgrading 23default instance permissions 60default reconciliation definitions 112defining

icons for classes 83, 85tooltips for classes 83, 86

deletingattributes 79classes 65indexes on the class form 80

Demo, default user name 30deploying web services 50destinations

CI class 204relationship class 210

documentation for BMC Atrium CMDB 10, 12

Eerror messages

viewing Class Manager 88viewing for pending changes 196

event typeserror 162information 162warning 162

eventsnotifying users of 176polling for instances 182publishing 176

Ffederated data, configuring 93–101federated interfaces

about 96access methods 96creating 96linking 99

Federated Interfaces window 97federated links

about 99creating 99

Federated Links window 99Federated Products window 95federated products, creating 95Federation Manager tab 94

Index 225

Page 226: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

fieldsAudit Option 200permissions 59

filtersCMDB:EventGenerator 177creating CI Relationship Viewer 184

flashboards, enabling for BMC Remedy User 49foreign key substitution 98forms

adding attributes to views 187base class 188BMC Atrium CMDB class 187BMC_DefaultAccountPermissions 60CMDB:Events 176, 182CMDB:Sample:EventNotification 177controlling layout of class 186generating for applications 189generating for ITSM 189launching generation 190permissions 58self-joins 189subclass 187

forms, BMC Atrium CMDB 187forms, BMC Remedy IT Service Management

applications 189

Ggenerating help for your data model 88graphs, enabling CI Distribution 49groups

computed 58creating Identification 115creating Precedence 125creating Qualification 164

Hhelp

generating 88installing on UNIX 44installing on Windows 32

hidden class permissions 58HP-UX, upgrading memory 24HTML help, generating 88

Iicons

about class 84Best Practice 9

icons (continued)defining class 83, 85New 9

Identification groups, creating 115Identification rules required 115identifying dataset instances 114If Action tab 178incremental merge 132, 158, 159indexes on the class form

defining 80deleting 80modifying 80viewing 80

Indexes tab 80installing

about 28CI Relationship Viewer 15on UNIX

BMC Atrium CMDB 41online help system 44

on WindowsBMC Atrium CMDB 28online help system 32

installing help 44instances

auditing history 198notifying users about 176permissions

about 59CMDBRowLevelSecurity 59CMDBWriteSecurity 59default 60specifying 60

polling event 182viewing relationships 183

interfaces, federated 96interval, setting cache refresh 192ITSM applications, generating forms for 189

Jjobs

canceling 161creating 155default 112initiating with workflow 158

Llaunching form generation 190licensing requirements 16linking federated interfaces 99

226 Installation and Configuration Guide

Page 227: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

logsAR System API activity 198BMC Atrium CMDB API activity 198Class Manager 196Reconciliation Engine 172, 198Synchronization 196

Mmanual identification 114Manual Identification Console 122merging data from datasets 123merging data, incrementally 132, 158, 159metadata, manually synchronizing 88methods, federated interface access 96modifying

attributes 79classes 64filters for CI Relationship Viewer 184indexes on the class form 80instance permissions 60instance permissions, default 60

NNew icon 9notifying users about events 176

Oopening

BMC Atrium CMDB user interface 53CMDB Console 53

Oracle, tuning upgrades 25

Ppasswords, Demo user name 30Pending entries, changing 87permissions

AR System field 59AR System form 58assigning roles 58attribute 58change attribute 59class 58, 79CMDB Console Admin 57CMDB Console User 57CMDB Data Change 56CMDB Data Change All 56CMDB Data View 56

permissions (continued)CMDB Data View All 56CMDB Definitions Admin 57CMDB Definitions Viewer 57CMDB RE Definitions Admin 57CMDB RE Manual Identification 57CMDB RE User 57default instance 60hidden class 58instance 59roles 56upgrading from previous versions 22view attribute 59visible class 58

Permissions tab 58, 59polling event instances 182Precedence groups, creating 125product support 3products, creating federated 95publishing events 176

QQualification groups, creating 164

Rreconciliation definitions, default 112Reconciliation Engine

logs 198modifying server configuration 171operations by way of workflow 158quick start 105–112

ReconciliationIdentity attribute 114refresh interval, setting cache 192relationship classes 210relationships

Change Pending status 196creating 68filtering in CI Relationship Viewer 183upgrading classes 210viewing instance 183

removing activities 156renaming datasets 148requirements

licenses 16system 16web service deployment 50

roles, assigning permissions 58running jobs 158

Index 227

Page 228: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Ssamples

CMDB:Sample:EventNotification form 177filter 177

schedules, weekly 158security, Demo user password 30Select Class window 100Select Instance window 100self-joins, forms 189server group, installing with 43SHR:SchemaNames form 189status

Change Pending 196creating alerts 193

subclasses, form views 187support, customer 3Sybase, improving performance 23Synchronization log 196system requirements, about 16

Ttabs

Auditing 199CMDB Home 49Federation Manager 94If Action 178Indexes 80Permissions 58, 59

technical support 3tooltips

about class 86defining class 83, 86

types of eventserror 162information 162warning 162

Uuninstalling

about 28UNIX 46Windows 38

UNIXinstalling

BMC Atrium CMDB 41online help system 44

uninstallingBMC Atrium CMDB 41, 46

upgradingabout 18changes to data model 19CI classes 204DB2 prerequisites 23improving performance, using Sybase 23memory, using HP-UX 24migrating data 19permissions 22procedure 18relationship classes 210using an Oracle environment 25viewing results 26

URLs, CMDB Console 53utilities, cmdb2asset 186

Vview attribute permissions 59Viewer. See CI Relationship Viewerviewing

attributes 79class hierarchies 65error messages for pending changes 196indexes on the class form 80Synchronization log 196

viewsadding attributes 187adding to class forms 65base class 188subclass 187

virtual memory recommendations 23visible class permissions 58

Wweb services

about deploying 50accessing 52deployment requirements 50

Windowsinstalling

BMC Atrium CMDB 28online help system 32

uninstallingBMC Atrium CMDB 28, 38

windowsAttribute Information 200CI Relationship Viewer Filters 184Class Information 80, 199Create Filter 177Federated Interfaces 97

228 Installation and Configuration Guide

Page 229: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

windows (continued)Federated Links 99Federated Products 95Select Class 100Select Instance 100

workflowadding to class forms 65executing against compared instances 137starting jobs with 158

Index 229

Page 230: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

230 Installation and Configuration Guide

Page 231: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Third-party product termsThe following terms apply to third-party products that are included with or in a BMC Software product as described in the BMC Software, Inc., License Agreement that is applicable to the BMC Software product.

Apache Software License, Version 2.0This product includes the Apache software product found at http://apache.org, and the Apache software product is distributed to us pursuant to the following terms and conditions:

Copyright (c) 2000-2004 The Apache Software Foundation. All rights reserved.TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions.

Page 232: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

GNU LESSER GENERAL PUBLIC LICENSEVarious media for this product contain JavaScript Vectorgraphics Library ("Library"), which is licensed under the terms of the GNU Lesser General Public License, Version 2.1 ("LGPL"). Copies of the LGPL and the source code of the Library are provided on a separate distribution disk for this product.l rights reservedNO WARRANTYBECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.The terms and conditions of the BMC Software agreement applicable to this product do not apply to the Library to the extent that any such term or condition imposes any further restriction on the exercise of any right with respect to the Library granted under the GPL. Certain object code of BMC software has been linked with the Library (the "Linked Software"). Although the terms of the LGPL are ambiguous and copyright law is uncertain with respect to application of the LGPL to Software, BMC is producing and distributing the Software in compliance with the LGPL to the extent the LGPL may apply. Accordingly, solely to the extent required by terms of the LGPL, the licensee of Software may modify the Software for the licensee's own use and reverse engineer the Software for debugging the permitted modifications.

Page 233: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation

*70089**70089**70089**70089*

*70089*

Page 234: BMC Atrium CMDB 2.1.00 Installation and Configuration Guide · The BMC Atrium CMDB 2.1.00 Installation and Configuration Guide ... Developer’s Reference Guide ... 12 Installation