Professional Documents
Culture Documents
03
Administrator’s Guide
August 2010
www.bmc.com
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 INC Telephone 713 918 8800 or Fax 713 918 8000
2101 CITYWEST BLVD 800 841 2031
HOUSTON TX 77042-2827
USA
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
If you have comments or suggestions about this documentation, contact Information Design and Development by email at
doc_feedback@bmc.com.
Support website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at
http://www.bmc.com/support. 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.
Contents 5
Status of classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Class instance icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Defining custom icons for a class instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
CI labels for classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Defining CI labels for a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Defining tooltips for a class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Defining Quick Edit attributes for a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Defining instance group thresholds for a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Creating Data Model Help with the cdm2html utility . . . . . . . . . . . . . . . . . . . . . . . . . . 68
cdm2html prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
cdm2html restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
cdm2html Java command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
cdm2html.bat file (Windows). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
6 Administrator’s Guide
Chapter 5 Migrating BMC Atrium Core data 127
Overview of migrating BMC Atrium Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Migration of BMC Remedy AR System data from source servers
to target servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Migrating BMC Atrium CMDB class definitions and instances . . . . . . . . . . . . . . . . . 129
Migrator command-line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Migrating class definitions with Migrator CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
CMDB metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
BMC Atrium CMDB instructions examples of data migration . . . . . . . . . . . . . . 134
Migrator CLI command examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Logging in to the cmdbdriver program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Exporting class instances with cmdbdriver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Importing class instances with cmdbdriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Migration of Product Catalog data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Exporting data from the Product Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Importing Product Catalog data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Creating custom data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Validating data in staging forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Importing the data into the BMC Atrium Product Catalog forms. . . . . . . . . . . . 152
Migrating normalization jobs and settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Migrating reconciliation jobs and dataset settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Exporting reconciliation definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Importing reconciliation definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Migrating BMC Atrium Integration Engine data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Exporting BMC Atrium Integration Engine data . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Importing BMC Atrium Integration Engine data . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Manually configuring federated data on your production server . . . . . . . . . . . . . . . 160
Contents 7
Chapter 7 Other administrative tasks 179
Notification of BMC Atrium CMDB events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Publishing an event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Notifications by polling for instances of an event. . . . . . . . . . . . . . . . . . . . . . . . . . 183
Atrium Explorer configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Control of the layout of class forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Modification of the views of forms in BMC Atrium CMDB . . . . . . . . . . . . . . . . . 185
Modifying views of forms in BMC Remedy IT Service Management
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Generating forms for other applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Setting the cache refresh interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Setting the DSO option for BMC Atrium CMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Changing the default CI editor in Atrium Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Appendix A Integrating BMC Atrium Core widgets with other applications 195
Integrating BMC Atrium Core widgets with other applications. . . . . . . . . . . . . . . . . 196
Launching BMC Atrium Core widgets from BMC Remedy AR System
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Embedding BMC Atrium Core widgets in BMC Remedy AR System
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Launching BMC Atrium Core widgets from non-BMC Remedy AR System
applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Index 217
8 Administrator’s Guide
BMC Atrium Core documentation
This section describes the complete set of BMC Atrium Core documentation,
including manuals, Help systems, videos, and so on.
Unless otherwise noted, documentation is available on the BMC Atrium Core
documentation media (DVD or Electronic Product Download bundle) and on the
BMC Customer Support site, free of charge, at http://www.bmc.com/support.
To find this documentation on the BMC Customer Support site, choose Product
Documentation > Supported Product A-Z List > BMC Atrium CMDB Enterprise
Manager > 7.6.03.
10 Administrator’s Guide
Title Description Audience
BMC Atrium Core 7.6.03 Information about configuring the Product Catalog System administrators, IT
Product Catalog and DML and DML, adding products, and creating aliases for managers, network
Guide products, manufacturers, and categorizations. managers, and other
qualified personnel who are
familiar with their
computing and networking
environment.
BMC Atrium Core 7.6.03 Information about new features, known issues, and Everyone.
Release Notes other late-breaking topics.
BMC Atrium Core 7.6.03: End-to-end high-level steps for bringing data into Configuration managers,
Taking Your Data Into BMC Atrium CMDB from a third-party source and application administrators,
Production End to End making it available in your production dataset. and asset analysts.
Note: This Flash video is available on your BMC
Atrium Core media. It is not available on the BMC
Customer Support site.
BMC Atrium Core 7.6.03 Information about resolving issues with BMC Application administrators,
Troubleshooting Guide Atrium Core components, including API, filter and programmers, and BMC
console error messages and their solutions. Support personnel.
BMC Atrium Core 7.6.03 Information about using BMC Atrium Core Web Application administrators
Web Services Help Services, including how to publish and find and programmers.
interfaces in the Web Services Registry, set versions,
disambiguate web services, configure security
policies and encryption, and use BMC Atrium Core
Web Services data structures and operations.
Note: This Help is provided in HTML, and is
available on your BMC Atrium Core media. It is
not available on the BMC Customer Support site.
BMC Atrium Integration Information about how to build adapters that can Developers that have a basic
Engine 7.6.03 ADK transfer information between an external data store understanding of BMC
Developer's Guide and either BMC Remedy AR System forms or BMC Atrium Integration Engine
Atrium CMDB. and want to build adapters
that can exchange data
between two data sources.
BMC Atrium Integration Help for using and configuring BMC Atrium Users that are responsible
Engine 7.6.03 Online Help Integration Engine. for setting up data transfer
integrations between
Note: This Help is provided in HTML, and is
external data stores and
available through the Help links in the BMC
either BMC Atrium CMDB
Atrium Integration Engine user interface. It is not
or BMC Remedy
available on the BMC Customer Support site.
AR System.
12 Administrator’s Guide
Chapter
1 Managing permissions
BMC Atrium Core provides several methods of controlling user access to data:
application roles, class and attribute permissions, and instance permissions. This
section explains how to set up permissions for BMC Atrium Core, including access
to different areas of the application and access to configuration data.
The following topics are provided:
Configuring user access to BMC Atrium Core components (page 14)
Groups installed with BMC Atrium CMDB (page 15)
BMC Atrium Core permission roles within applications (page 17)
Calbro Services example—BMC Atrium CMDB groups, roles, and users
(page 23)
BMC Remedy AR System license types required for data access in BMC Atrium
Core (page 25)
Class and attribute permissions on BMC Atrium CMDB data (page 25)
Roles, instance permissions, and row-level access (page 27)
Permission scenarios when managing user access to BMC Atrium CMDB data
(page 31)
NOTE
When you upgrade BMC Atrium Core, the installer does not create new groups
and does not modify existing role and computed group definitions. As a result, the
upgrade process does not break the existing groups, roles, and mappings that you
have configured for your system.
Step 1 Open the Group form and create a BMC Remedy AR System regular group
(Change group type) for the different levels of access you need defined.
Use the following direct access URL to open the Group form:
http://midTierServer:portNumber/arsys/forms/arSystemServer/Group
For example, create a regular group (CMDBAdmin) that you will use for all your
BMC Atrium Core administrators. You can also re-use regular groups that you
have previously created.
For general information about working with groups, see the BMC Remedy Action
Request System 7.6.03 Form and Application Objects Guide.
For detailed information about groups in the BMC Atrium Core solution, see
“Groups installed with BMC Atrium CMDB” on page 15.
Step 2 In the Group form, click Append Group to add the CMDBAdmin regular group to
a computed group (for example, CMDB Console Admin Group).
Step 3 Open the Roles form and map a group that you created in step 1 to the Production
state of the BMC Atrium Core roles that you want to associate with that group.
Use the following direct access URL to open the Roles form:
http://midTierServer:portNumber/arsys/forms/arSystemServer/Roles
Many roles already have groups mapped to them. For example, the CMDB
Console Admin role is mapped out-of-the-box to the CMDB Console Admin
Group in the Production state.
NOTE
If a group is already mapped to the role, add your group to that computed group
instead of modifying the mapping.
14 Administrator’s Guide
Groups installed with BMC Atrium CMDB
For general information about working with roles, see the BMC Remedy Action
Request System 7.6.03 Form and Application Objects Guide.
For detailed information about roles in the BMC Atrium Core solution, see
“BMC Atrium Core permission roles within applications” on page 17.
For examples of users with the groups and roles required to accomplish their
tasks, see “Calbro Services example—BMC Atrium CMDB groups, roles, and
users” on page 23.
Step 4 Open the Users form and create BMC Remedy Action Request System (AR System)
users.
Use the following direct access URL to open the User form:
http://midTierServer:portNumber/arsys/forms/arSystemServer/User
In the Group List field, select the regular groups associated with the access
permissions needed by each user.
NOTE
You cannot choose a computed group from the Group List field when creating a
user. This is why you had to create a regular group and then add it to the group
definition of the computed group.
For information about the BMC Remedy AR System license types to grant to
users of BMC Atrium Core, see “BMC Remedy AR System license types
required for data access in BMC Atrium Core” on page 25.
For information about creating users, see the BMC Remedy Action Request System
7.6.03 Configuration Guide.
Table 1-1 lists the default groups that are available when you install BMC Atrium
CMDB.
16 Administrator’s Guide
BMC Atrium Core permission roles within applications
18 Administrator’s Guide
BMC Atrium Core permission roles within applications
20 Administrator’s Guide
BMC Atrium Core permission roles within applications
22 Administrator’s Guide
Calbro Services example—BMC Atrium CMDB groups, roles, and users
Review carefully the groups and roles for other tasks that you might need to add
to your users. For more information, see:
“Groups installed with BMC Atrium CMDB” on page 15
“BMC Atrium Core permission roles within applications” on page 17
24 Administrator’s Guide
BMC Remedy AR System license types required for data access in BMC Atrium Core
Class permissions
You can specify which groups and roles have the following permissions on each
class:
Hidden—Members of these groups and roles can access the class through
workflow, but cannot see its instances in the Atrium Explorer 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 Atrium Explorer, 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 “Class and attribute permissions” on
page 45.
WARNING
Do not use BMC Remedy Developer Studio to change permissions on the class
forms. These permissions will be overwritten the next time a change is made to the
class with the Class Manager.
Attribute permissions
You can specify which groups and roles have the following permissions on each
attribute:
View—Members of these groups and roles can view the attribute in the class
form, but cannot modify its value.
Change—Members of these groups and roles can view and modify the attribute
value.
You can also specify that a user without Change permissions can set the attribute’s
value when creating an instance. To do so, select the Allow Any User to Submit
option.
You specify attribute permissions from the Permissions tab when viewing an
attribute (in the Attributes dialog box) from the Class Manager. For more
information, see “Class attributes” on page 47.
WARNING
Do not use BMC Remedy Developer Studio to change permissions on the attribute
fields. These permissions will be overwritten the next time a change is made to the
class with the Class Manager.
26 Administrator’s Guide
Roles, instance permissions, and row-level access
Table 1-4: Example instance permissions using roles and security attributes
InstanceId CMDBRowLevelSecurity CMDBWriteSecurity Joe can Joe can Jane can Jane can
attribute attribute read write read write
1 NULL NULL
2 NULL Service Desk
3 Service Desk NULL Yes
4 Service Desk Service Desk Yes Yes
5 Change Team NULL Yes Yes
Table 1-4: Example instance permissions using roles and security attributes (Continued)
InstanceId CMDBRowLevelSecurity CMDBWriteSecurity Joe can Joe can Jane can Jane can
attribute attribute read write read write
6 All Hands NULL Yes Yes Yes
7 All Hands Service Desk Yes Yes Yes Yes
Neither user can read or write to instances 1 and 2, which have no group specified
for row-level security. Neither write security nor the CMDB Data View and CMDB
Data Change permission roles have any effect without row-level security.
Best practice
You can automatically configure row-level security at the instance level using the
Normalization Engine. The Normalization Engine includes rules that set the row-
level and attribute-level permissions on CIs as you define them. For more
information, see the BMC Atrium CMDB 7.6.03 Normalization and Reconciliation
Guide.
If BMC Atrium CMDB represents just one organization, use the CMDB Data View
All and CMDB Data Change All roles for users. If you are using BMC Atrium
CMDB for a multitenancy environment, use the CMDB Data View and CMDB
Data Change roles with the CMDBRowLevelSecurity and CMDBWriteSecurity
attributes.
NOTE
BMC Remedy IT Service Management (ITSM) uses instance permissions by means
of the Company field. If you are planning to use BMC Remedy ITSM, see the BMC
Remedy IT Service Management Guide to Multi-Tenancy before implementing
instance permissions.
28 Administrator’s Guide
Roles, instance permissions, and row-level access
NOTE
In the Class Manager, you can find the BMC_DefaultAccountPermissions class as
a subclass of the BMC_ConfigBaseElement base class.
The AccountID and ClassId attributes of every new instance are compared
against the MATCHAccountID and MATCHAppliedToClassId attributes in
BMC_DefaultAccountPermissions. The BMC_DefaultAccountPermissions
instance with the lowest precedence number as shown in Table 1-5 supplies
permissions for the new instance. If no instance matches and you do not supply
values for the CMDBRowLevelSecurity or CMDBWriteSecurity attribute of the
instance, no user has that level of security for the instance.
Default permissions are applied to an instance only when it is created. If you later
change the permissions mappings in BMC_DefaultAccountPermissions, the
permissions on existing instances are not updated. In that case you must edit the
instances manually to match the new permissions.
NOTE
If you supply values for CMDBRowLevelSecurity and CMDBWriteSecurity when
creating an instance, those values are appended to the default permissions. Both
values are saved at instance creation.
30 Administrator’s Guide
Permission scenarios when managing user access to BMC Atrium CMDB data
NOTE
The class ID is case sensitive and might not be the same as the class name. For
example, the class with a name of BMC_ComputerSystem has a class ID of
BMC_COMPUTERSYSTEM. For more information about the class ID of a specific
class, see the BMC Atrium CMDB 7.6.03 Data Model Help.
4 In the ASSIGNRowLevelSecurity field, select or type the names of the groups that
you want to have row-level security for new instances, separated by spaces.
You can use any BMC Remedy AR System group or role, such as those listed in
“BMC Atrium Core permission roles within applications” on page 17. 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 that you
want to have write security for new instances, separated by spaces.
NOTE
In this procedure, you are creating a new instance of the
BMC_DefaultAccountPermissions class. In addition to the previously specified
attribute fields, which are relevant to the default permissions that you want to
create, you can set permissions on this instance by entering group names in the
CMDBRowLevelSecurity and CMDBWriteSecurity fields, or you assign it to an
account by typing an AccountName value. Do not enter values in the remaining
fields.
6 Click Save.
These methods can overlap, with the security of one method sometimes taking
precedence over another method. Table 1-7 lists different scenarios of how data
access-control might be configured for read and write access to a class and an
instance of that class, and what happens when Joe Unser, an employee at Calbro
Services, tries to read or modify that instance.
32 Administrator’s Guide
Chapter
As you evaluate your business environment and plan your data model, you might
determine that the Common Data Model (CDM) installed with BMC Atrium
CMDB is not sufficient to store information for some of your assets.
NOTE
Before extending the CDM, review the best practices in the BMC Atrium Core 7.6.03
Concepts and Planning Guide. Adding new classes and attributes are among the last
things you should consider.
34 Administrator’s Guide
Class Manager interface
To view a class
1 Open the Class Manager.
2 In the Base Classes section of the navigation pane, click a base class.
3 In the display pane, use the expand/collapse buttons to locate the class you want
to view.
4 Double-click the class you want to view.
36 Administrator’s Guide
More information about CDM and extension classes
The CI Class or Relationship Class dialog box appears. If you want to modify the
class, see the procedures in “Creating or modifying classes with the Class
Manager” on page 38.
WARNING
Do not use BMC Remedy Developer Studio to modify classes and attributes
directly on class forms. Modifying the BMC Atrium CMDB data model requires
more than just editing a form, and you might break some functionality.
Federated data and federated relationship classes appear in Class Manager. You
can update some properties of a federated class through Class Manager (for
example, Author). However, you cannot create attributes in these classes through
Class Manager. You modify these classes in Federation Manager, as described in
“Editing a federated data class” on page 94 and “Creating a federated relationship
class” on page 95.
Best practice
BMC Software recommends that you attempt to use the classes and attributes in
the BMC CDM as they were originally defined. However, you might have
corporate reasons to extend the data model. You can create your own classes or
extend classes by adding attributes, and these changes will be preserved across
upgrades.
Never modify the core CDM class attributes because upgrades across versions will
overwrite these customizations. Modifications to the CDM—for example,
changing the attribute field length in a class—will not be preserved during
upgrades.
For best practices for extending the data model, see the BMC Atrium Core 7.6.03
Concepts and Planning Guide. For information about the process for creating or
modifying a class, see “Process overview for creating or modifying classes” on
page 39.
38 Administrator’s Guide
Creating or modifying classes with the Class Manager
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
Best practice
BMC Software recommends that you set the Development Cache Mode option in
the Configuration tab on the AR System Administration: Server Information
window before you create or modify classes. Otherwise, you might experience
server crashes due to server memory exceeding 2 GB during copy of the server
cache. When you finish your changes to the data model, clear the Development
Cache Mode.
Step 1 Define the properties of the class, which include its type, how it stores data, and
(for relationship classes) the relationship type. For more information, see “Class
properties” on page 40.
Step 2 (optional) Specify permissions. If you do not specify permissions for a class, BMC
Atrium CMDB assigns default permissions. For more information, see “Class and
attribute permissions” on page 45.
Step 3 Define one or more attributes. For more information, see “Class attributes” on
page 47.
Step 4 (optional) Propagate attributes in a weak relationship. This step is necessary only if
you have created a relationship class that has a weak relationship in which the
attributes from one class should be propagated to another class. For more
information, see “Weak relationships between classes—Propagating their
attributes” on page 53.
Step 5 (optional) Specify indexes. Indexing can reduce database query time, so index
attributes that you expect users to use in queries frequently. For more information,
see “Class indexes” on page 55.
Step 6 (optional) Configure instance auditing for the class. Auditing enables you to track
the changes made to instances of a class. For more information, see “Auditing
instance history of classes” on page 57.
NOTE
When you use the Class Manager to create a new class, a delay of up to five
minutes might occur before a user can start creating instances of that class in
Atrium Explorer. This delay happens only rarely, typically in test environments,
and is caused by how admin cache memory works in the BMC Remedy AR System
when you create objects from a new form. In general, BMC Atrium Core users do
not experience delays in a production environment.
Class properties
The properties of a class define the class and how it stores data.
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
40 Administrator’s Guide
Creating or modifying classes with the Class Manager
42 Administrator’s Guide
Creating or modifying classes with the Class Manager
Roles—Refers to the relationship roles of the member classes. You can use the
default Source and Destination roles, or you can specify new roles when you
create a relationship class. Role names are used as prefixes on the field labels of
attributes pertaining to each member class.
Table 2-3 lists the properties defined in the Relationship Class dialog box, and how
you should enter information for those properties when creating a new class.
Table 2-3: Relationship type properties
Property Description
Class 1 Select a class to use as the source class.
Class 2 Select a class to use as the destination class.
Role 1 Enter a role name for Class 1. By default, this is Source.
Role 2 Enter a role name for Class 2. By default, this is Destination.
Cardinality Select a cardinality:
One to one—Each instance of Class 1 can have this relationship
with one instance of Class 2.
One to many—Each instance of Class 1 can have this relationship
with multiple instances of Class 2.
Many to one—Multiple instances of Class 1 can have this
relationship with each instance of Class 2.
Many to many—Each instance of Class 1 can have this
relationship with multiple instances of Class 2, and vice versa.
BMC Atrium CMDB enforces the cardinality of a relationship class.
Fulfilling a “many” cardinality means that multiple instances of
the relationship exist.
Cascade Delete Select the Cascade Delete check box to delete (or mark as deleted)
the destination member whenever the source member is deleted
(or marked as deleted). This field applies only to relationships with
a left-hand cardinality of One.
Weak Reference Select the Weak Reference check box to create a composite object
with the relationship and its member instances in which the
destination member is a weak entity. This field applies only to
relationships with a left-hand cardinality of One.
Propagated If you have selected classes in the Class 1 and Class 2 fields and you
Attributes have selected the Weak Reference check box, click Propagated
Attributes to map attributes between members of a weak
relationship. For more information, see “Weak relationships
between classes—Propagating their attributes” on page 53.
44 Administrator’s Guide
Creating or modifying classes with the Class Manager
NOTE
You cannot modify the Data Storage Method, Final, and Singleton fields after you
have saved a class.
4 (optional) In the Additional Information section of the More Information tab, enter
a description of the class in the Description field.
5 If the class is a relationship class, define relationship type properties as described
in Table 2-3 on page 44; otherwise skip this step.
6 Perform one of the following actions:
Action Steps
You want to provide additional Continue with the process described in “Process
information for the class overview for creating or modifying classes” on
page 39.
You are finished working with this 1 Click OK.
class 2 In the confirmation dialog box, click OK.
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
If you do not set permissions, BMC Atrium CMDB automatically assigns the
following default visible permissions:
CMDB Data Change
CMDB Data Change All
CMDB Data View
CMDB Data View All
For more information about BMC Atrium CMDB permissions, see the BMC Atrium
Core 7.6.03 Concepts and Planning Guide.
46 Administrator’s Guide
Creating or modifying classes with the Class Manager
Class attributes
The Attributes tab of the CI Class and Relationship Class dialog boxes helps you
manage the attributes of a class.
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
The Class Name column lists the selected class and the superclasses from which
the class inherits attributes. For example, the Attributes tab for the BMC_Patch class
lists the BMC_BaseElement, BMC_Patch, BMC_Software, and
BMC_SystemComponent classes. Click the arrow next to a class to show all of the
attributes for that class. Figure 2-2 shows the Attributes tab of the CI Class dialog
box for the BMC_Patch class, expanded to show the attributes from the BMC_Patch
and BMC_Software classes.
You can edit or delete attributes that are unique to a class, but not attributes that
are inherited from a superclass.
When creating an attribute of the Selection data type, you can specify custom
enumeration values instead of the default values, which start at 0 and increment
by 1. This allows you to leave unused any numbers between the values you choose.
The benefit is that you can later add a selection between two others without
invalidating existing data by changing the enumeration of the existing selections.
You can view, modify, and delete existing attributes of a class. However, you can
modify or delete only attributes that are unique to a class. You cannot modify or
delete attributes inherited from a superclass.
NOTE
New attributes are not automatically visible on the class forms. For information
about laying out attribute fields on class forms, see “Control of the layout of class
forms” on page 184.
48 Administrator’s Guide
Creating or modifying classes with the Class Manager
Table 2-5 describes the fields on the Attribute dialog box that appear according to
the Data Type selected for the attribute. All of these fields are optional. For more
information about these fields, see the BMC Remedy Action Request System 7.6.03
Form and Application Objects Guide.
Table 2-5: Attribute fields specific to data types (Sheet 1 of 3)
Fields Description Applicable data types
Allowable List of currency types allowed. Currency
Currency Types
Attachment Pool Name of the attachment pool to which the Attachment Field
attachment field belongs.
Default Value Value that is saved for the attribute when a Character
new instance is created if the user does not Currency
enter a value. The Default Value can be a Date
static value or a keyword from the field
Date/Time
menu.
Decimal
Diary
Integer
Real
Selection
Time
Enum Type Specifies the way in which selection-field Selection
options are ordered in the database.
Regular—BMC Remedy AR System
numbers the IDs beginning with 0 and
incrementing by 1.
Custom—You must number all of the IDs
manually. You can enter any value from 0
through 2147483647.
Functional List of currency types to which the value can Currency
Currency Types be converted when it is saved to the
database.
50 Administrator’s Guide
Creating or modifying classes with the Class Manager
Creating attributes
The Class Manager helps you create attributes for CI and relationship classes.
To create an attribute
1 In the Class Manager, open a class for editing.
2 In the CI Class or Relationship Class dialog box, click the Attributes tab.
3 In the Attributes tab, click New.
4 In the Attribute dialog box, enter information for the common fields, as listed in
Table 2-4 on page 48.
5 Enter information for the optional fields specific to your selection for the Data Type
field, as listed in Table 2-5 on page 50.
6 (optional) In the Permissions section, select groups and roles that can view and
modify the attribute.
If you do not specify permissions, BMC Atrium CMDB assigns the following
permissions:
View permissions Change permissions
CMDB Data View CMDB Write Security
CMDB Data View All CMDB Data Change
CMDB Data Change All
52 Administrator’s Guide
Creating or modifying classes with the Class Manager
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
Best practice
To propagate a source attribute, you must map it to an existing attribute on the
destination class. Create new attributes on the destination class for this purpose,
instead of mapping to an attribute provided by the CDM. Doing so allows CDM
attributes to serve their intended purpose and prevents you from accidentally
overwriting propagated source CI values with values from somewhere else.
The attribute that you propagate to on the destination class must be the same data
type as the attribute on the source class, and it cannot be inherited from a
superclass. When you set up propagation, the limit characteristics of the
destination attribute are modified to match those of the source attribute. For
example, if you propagate an integer attribute that has a Min value of 3 on the
source side to a destination attribute with a Min value of 1, the Min value of the
destination attribute changes to 3.
54 Administrator’s Guide
Creating or modifying classes with the Class Manager
Class indexes
Indexing classes can reduce database query time.
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
More time is required to modify a class (for example, adding new attributes) when
indexes have been specified for it. The greater the number of indexes specified for
the class, the more time and disk space are required. Specifying and modifying
instances also takes longer for classes with many indexes.
Best practice
Specifying or modifying indexes in a class that already holds a large number of
instances can take a significant amount of time and disk space. Therefore, you
should avoid creating indexes during normal production hours. For more
information about BMC Remedy AR System indexes, see the BMC Remedy Action
Request System 7.6.03 Form and Application Objects Guide.
56 Administrator’s Guide
Creating or modifying classes with the Class Manager
1 2 Specify
3
Define properties Define attributes
permissions
(optional)
4 Propagate
5 6
attributes Specify indexes Configure auditing
(optional) (optional) (optional)
For detailed information about auditing, including best practices, see the BMC
Atrium Core 7.6.03 Concepts and Planning Guide.
For information about viewing instance history in Atrium Explorer, see the BMC
Atrium CMDB 7.6.03 User's Guide.
NOTE
By default, no classes in the data model are configured for auditing. Choose an
auditing strategy wisely, limiting class auditing to business-critical situations. As
the number of classes with auditing increases, system performance might slow.
Audit types
You can specify the following types of audit when modifying a class:
Copy—Creates a copy of each audited instance. When you enable Copy
auditing for a class, each BMC Remedy AR System form pertaining to that class
is duplicated to create audit forms that hold audited instances. This includes
forms from superclasses, because they hold data for instances of their
subclasses.
Log—Creates an entry in a log form that stores all attribute values from the
audited instance in one field. When you enable Log auditing for a class, you
specify the name of the log form to use. If this form does not already exist, it is
created automatically. You can use the same log form with multiple classes.
NOTE
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 BMC Atrium Core 7.6.03 Concepts and Planning Guide.
58 Administrator’s Guide
Deleting a class
5 In the Qualification field, type a qualification to specify which instances of the class
are audited.
For example, the following qualification specifies that only instances in the
BMC.ASSET dataset are audited:
'DatasetId' = "BMC.ASSET"
If you want all instances to be audited when they are created and deleted and
when a selected attribute is changed, leave this field blank.
6 Click the Attributes tab.
7 Select an attribute that you want to be included in audits and click Edit.
8 From the Audit Option menu, select an option for this attribute, as described in
“Attribute audit options” on page 58.
9 In the Attribute dialog box, Click OK.
10 Repeat step 7 through step 9 for each attribute that should be included in audits.
11 In the Class dialog box, click OK.
12 In the confirmation dialog box, click OK.
Deleting a class
You can use the Class Manager to delete a class from the data model.
Best practice
Never delete classes or attributes from the BMC CDM. Deleting such classes or
attributes can cause problems during upgrade.
WARNING
When you delete a class, all of its subclasses and dependencies (such as audit
forms) are deleted. If it is a CI class, all of the relationship classes in which it or its
subclasses participate are also deleted.
You can also deprecate a class and its attributes from the data model (for example,
to improve the performance of the BMC Atrium CMDB or update the data model
to adjust to your business needs). For more information, see “Deprecating classes
and attributes in your data model” on page 203.
To delete a class
1 Open the Class Manager.
2 In the display pane, browse the data model until you have selected the class that
you want to delete.
3 In the toolbar, click the Delete Class button.
4 In the confirmation message, click Yes.
Status of classes
After you make any change to a class or attribute with the Class Manager or a BMC
Atrium CMDB API program, the class definitions are automatically synchronized
with the BMC Remedy AR System forms that hold class data and the workflow
that enforces hierarchy and other rules.
A class can be in one of the following statuses:
Change Pending—The Class Manager is in the process of updating BMC Atrium
CMDB.
Active—The Class Manager has synchronized modifications with BMC Atrium
CMDB.
Error—A Class Manager update or create operation has failed. Pause your
mouse pointer over the Error icon in the display pane to see the error message.
60 Administrator’s Guide
Class instance icons
The Class Manager displays the current status. In the tree view, a clock icon in the
corner of the class box indicates a status of Change Pending. When the clock icon
is not displayed, the status is Active.
In the table view, a Status column indicates the status of each class.
62 Administrator’s Guide
CI labels for classes
ComponentType—Select Icon.
Component Attachment—Specify the image file of an icon.
3 Save your changes.
New and changed icons are available to Atrium Explorer within ten minutes. To
make them available sooner, restart the mid tier. After waiting ten minutes or
restarting the mid tier, reopen Atrium Explorer.
A subclass uses the CI label settings of its superclass. For example, because the
BMC_System class uses the ShortDescription attribute for CI labels, the
BMC_ComputerSystem class also uses the ShortDescription attribute.
Classes have a prioritized list of attributes for CI labels to ensure that every CI has
a label in Atrium Explorer. If the first attribute is empty, then Atrium Explorer uses
the second attribute, and so on. If all listed attributes are empty, then Atrium
Explorer displays the class name as the CI label. This ensures that the CI label is
never empty.
You can configure different attributes to use for CI labels of a class by creating an
instance of the BMC_UIComponent form for that class. By default, classes that use
the ShortDescription attribute for CI labels do so because they inherit that
setting from a BMC_UIComponent form entry for the BMC_BaseElement class.
Classes that use the Name attribute have their own BMC_UIComponent form entries.
Consider the following suggestions when choosing new attributes to use for CI
labels:
Choose attributes that are likely to have clear values. Some attributes might
have no values or values that are not descriptive of the CI.
The default limit in Atrium Explorer for CI labels is 32 characters, so choose
attributes that allow you to identify CIs with fewer characters. For example,
avoid using the Description attribute, since the full description is likely to
exceed the display limit. You can change the character limit as part of the Atrium
Explorer options, available in the Atrium Explorer toolbar.
64 Administrator’s Guide
Defining tooltips for a class
To define a tooltip
1 Use the following direct access URL to open the BMC_UIComponent form:
http://midTierServer:portNumber/arsys/forms/arSystemServer/
BMC.CORE.CONFIG:BMC_UIComponent
2 Create or modify an instance of BMC_UIComponent, entering values for the
following attributes:
ClassId—Type BMC_UICOMPONENT.
ComponentLocale—Type the locale where this tooltip should be displayed.
When a client requests a tooltip under a locale for which there is no tooltip
defined, the en_US tooltip is displayed.
ComponentName—(optional) Type a name for the tooltip.
ComponentQual—(optional) Type a qualification that specifies which
instances of the class in ComponentRelatedClassId display the attributes
listed in this tooltip. If no ComponentQual is specified, this tooltip is displayed
for all instances of the class, subject to the values of ComponentLocale and
ComponentTag4.
Qualifications use dollar signs to enclose attribute names. For example, the
qualification $Name$ LIKE “Computer%” matches instances where the value
of the Name attribute begins with “Computer.”
ComponentRelatedClassId—Type the class ID of the class for which this
tooltip displays attribute values. The class ID is case sensitive, and might not
be the same as the class name. For example, the class with a name of
BMC_ComputerSystem has a class ID of BMC_COMPUTERSYSTEM. For more
information about the class ID of a specific class, see the BMC Atrium CMDB
7.6.03 Data Model Help.
ComponentString—Type the names of the attributes, delimited by commas,
for which values are displayed when a user mouses over an instance of the
class in ComponentRelatedClassId in the Atrium Explorer.
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.
66 Administrator’s Guide
Defining instance group thresholds for a class
68 Administrator’s Guide
Creating Data Model Help with the cdm2html utility
Best practice
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 new classes or attributes, enter meaningful descriptions for them in the
Class Manager before running cdm2html.
cdm2html prerequisites
The cdm2html utility is a BMC Atrium CMDB Java API client, and requires the
following software:
Java Runtime (J2SE™) version 1.5 or later.
Apache Xalan-Java version 2.7 or later. This is bundled with BMC Atrium
CMDB and installed in CMDBInstallDir\utils.
Prerequisites for BMC Atrium CMDB Java API and BMC Remedy AR System
Java API clients as listed in the JavaAPI_Overview.html file of the BMC
Atrium CMDB 7.6.03 Javadoc Help.
cdm2html restrictions
The cdm2html utility is subject to these restrictions:
It can be used only with a BMC Atrium CMDB that has English as its data
language.
It does not delete help files. If you delete a class from the data model and then
run cdm2html, the previously existing HTML file for that class remains
untouched. You should always generate Data Model Help into a new folder or
clean out the existing folder before generating.
It does not create help for Hidden or Display Only attributes.
CMDBInstallDir\sdk\bin\commons-lang-2.4.jar
CMDBInstallDir\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
CMDBInstallDir\utils. If you specify a relative path, it must begin with a
period (.) and be relative to the directory from which you are executing the
command.
-outdir—The path in which to generate the help files. If you specify a relative
path, it must begin with a period (.) and be relative to the directory from which
you are executing the command. The default is the current directory.
-server—The BMC Atrium CMDB server from which you want to export Data
Model Help. You can specify either a host name or IP address. The default value
is localhost.
-user—The BMC Remedy AR System user to perform the operation. The
default value is Demo. 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 BMC Remedy AR System portmapper.
70 Administrator’s Guide
Creating Data Model Help with the cdm2html utility
Here is an example command on Windows, assuming you did not add anything to
CLASSPATH:
java -cp C:\Program Files\BMC Software\AtriumCore\cmdb\utils>"C:\Program
Files\Java\jdk1.5.0_11\bin\java" -cp "C:\Program Files\BMC
Software\AtriumCore\CMDB\utils\;C:\Program Files\BMC
Software\AtriumCore\CMDB\utils\cdmutil.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\cmdbapi7603.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\utils\xalan.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\arapi7603.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\arcmn7603.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\arrpc7603.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\arutl7603.jar;C:\Program Files\AR
SystemApplications\AtriumCore\CMDB\sdk\bin\oncrpc.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\commons-beanutils.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\commons-codec-1.3.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\commons-collections-3.2.jar;C:\Program
Files\BMC Software\AtriumCore\CMDB\sdk\bin\commons-configuration-
1.3.jar;C:\Program Files\BMC Software\MYSERVER\BMCAtrium CMDB\sdk\bin\commons-
digester-1.7.jar;C:\Program Files\BMC Software\AtriumCore\CMDB\sdk\bin\commons-
lang-2.2.jar;C:\Program Files\BMC Software\AtriumCore\CMDB\sdk\bin\commons-
logging-1.1.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\spring.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin\log4j-1.2.14.jar;C:\Program Files\BMC
Software\AtriumCore\CMDB\sdk\bin" com.bmc.cmdb.cdmutil.cdm2html -outdir
.HTMLHelp -indir C:\Program Files\BMC Software\AtriumCore\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.
72 Administrator’s Guide
Chapter
You can configure BMC Atrium CMDB to display federated data. You can
configure federation through the retrieval and launch methods. The retrieval
method enables you to view federated data as if it were stored in BMC Atrium
CMDB. The launch method enables you to view federated data through another
application, such as a BMC Remedy AR System form. For more information about
federation, see the BMC Atrium Core 7.6.03 Concepts and Planning Guide.
The following topics are provided:
Federated data—Calbro Services example (page 74)
Federation Manager interface (page 74)
Administering plugins and adapters for federated data (page 75)
Managing data stores (page 87)
Administering the retrieval method of federation (page 89)
Administering the launch method of federation (page 98)
74 Administrator’s Guide
Administering plugins and adapters for federated data
Figure 3-1: Federation between BMC Atrium CMDB and federated database
Federated Federated
relationship relationship
Federated
CMDB data Federated Federated
classes data Class1 data Class2
Plugin for
Database 1
JDBC
adapter
Table 1 Table 2
Oracle Database1
As shown in Figure 3-1 by the downward arrows, BMC Atrium CMDB can
establish links from its own data to the external data source, but the external source
cannot establish links to BMC Atrium CMDB. Federated data is not bidirectional.
You can use any adapter in one or more plugins. For example, you might use a
single JDBC™ adapter to configure two different plugins, with each plugin
configured to connect with a different external database. BMC Atrium CMDB
includes three adapters at installation:
JDBC—Enables you to federate data from any JDBC-compliant database. For
more information, see “Creating a JDBC plugin” on page 77.
CMDBf—Enables you to federate data from any CMDBf-compliant CMDB. If
you have third-party CMDBs in your environment, you can use the CMDBf
adapter. For more information, see “Creating a CMDBf plugin” on page 81.
AR—Enables you to federate data from forms on any BMC Remedy AR System
servers. For more information, see “Creating an AR plugin” on page 83.
If you want to connect to an external data source of a different type, you must first
create a new adapter. For more information, see “Registering a federated data
adapter with BMC Remedy AR System” on page 86.
76 Administrator’s Guide
Administering plugins and adapters for federated data
JDBC
adapter
User/password User/password
Database1 Database2
Oracle databases
Table 3-1 on page 76 explains the federation concepts illustrated in Figure 3-2.
NOTE
If your BMC Atrium CMDB environment uses a server group, you must install that
driver in the same directory path on each server in the group.
Click Refresh to
verify that the
plugin is
properly loaded
3 In the Configure Repository Plugins and Adapters dialog box, click New.
4 In the General tab of the Details section, enter the following information for the
JDBC plugin:
78 Administrator’s Guide
Administering plugins and adapters for federated data
For example, Allen, the Calbro Services administrator, selects the JDBC adapter
and SQL Server database type, names the new plugin
SQLServer_Northwind_CalbroSJ, and enters the remaining parameters for the
Microsoft SQL Server server database.
5 (optional) Click the Filter Options tab of the Details section.
a Select the source of the data that you want to fetch.
By default, the JDBC Adapter fetches data from tables only. You can fetch the
data from views only, or both tables and views.
80 Administrator’s Guide
Administering plugins and adapters for federated data
14 If your BMC Atrium CMDB environment uses a server group, make sure the same
plugin is configured on all servers in the server group. Repeat the following steps
for each server:
a Copy the same plugin configuration information in the
pluginsvr_config.xml file for each server. Make the appropriate changes in
the <filename> and <pathelement> tags to correct the jar paths for the local
server if required.
b Copy and paste the Server Plugin Alias entry in the ar.cfg file. Change the
server name to the local server.
c Restart the server.
15 Close the Configure Repository Plugins and Adapters dialog box.
You now must create a data store to represent the external data in your database.
For more information, see “Managing data stores” on page 87.
NOTE
Do not use the CMDBf plugin to connect one BMC Atrium CMDB storing one type
of data (for example, Asset Management data) to another BMC Atrium CMDB
storing another type of data (for example, Change Management data). Only one
BMC Atrium CMDB should function as the single source of reference for all CIs in
your IT environment.
4 In the General tab of the Details section, enter the following information for the
CMDBf plugin:
For example, Allen, the Calbro Services administrator, would select the CMDBf
adapter, name the new plugin CMDB_PLUGIN_CalbrSJ, and enter the user name
and password to the CMDB. He would then enter an Access Point URL of
http://goldserver:9090/axis2/services/ThirdPartyCMDB_porttype,
and a WSDL URL of
http://goldserver:9090/axis2/services/
ThirdPartyCMDB_porttype?wsdl.
5 Click Add.
The Loaded column in the Configure Repository Plugins and Adapters dialog box
reads No for the new plugin.
6 In the list of repository plugins, select the new plugin.
7 Click Show XML.
8 In the Plugin XML dialog box, copy all of the text from <plugin> to <\plugin>,
including those tags.
9 On the plugin server computer, open the pluginsvr_config.xml file for editing.
82 Administrator’s Guide
Administering plugins and adapters for federated data
Creating an AR plugin
The following procedure includes an example for a Calbro Services administrator
that wants to create a custom AR plugin for the form on the BMC Remedy
AR System server used to store printer service records. In this case, creating an AR
plugin instead of a JDBC plugin is easier for federation because form names are
typically easier to read than table names from the AR System database.
For example, Allen, the Calbro Services administrator, would select the AR
adapter, name the new plugin ARServer_PLUGIN_CalbroSJ, and enter the user
name, password, server name, and port of the BMC Remedy AR System server.
5 (optional) Click the Filter Options tab of the Details section to fetch the data from a
particular type of form on the BMC Remedy AR System server.
You can retrieve data from the following forms:
Table 3-5: Form types from which you can retrieve data (Sheet 1 of 2)
Form Description
Regular Forms Default setting.
Specified Forms Enter the form in the Form Name field.
All Forms Includes all form types.
Join Forms Includes all join forms.
84 Administrator’s Guide
Administering plugins and adapters for federated data
Table 3-5: Form types from which you can retrieve data (Sheet 2 of 2)
Form Description
View Forms Includes all view forms.
Join Forms that Includes all join forms that depend on the form specified in the
depend on Form Name field.
Join Forms that are Includes all join forms that the form specified in the Form Name
depended on by field depend on.
Dialogs Includes all dialog forms.
Forms with Data Includes all forms with data in them.
Vendor Forms Includes all vendor forms.
6 In the Changed since field, enter the date and time to limit the forms to those
modified after the specified time.
7 In the Include Hidden Forms field, specify whether to include hidden forms (the
default value) or not.
8 Click Add.
The Loaded column in the Configure Repository Plugins and Adapters dialog box
reads No for the new plugin.
9 In the list of repository plugins, select the new plugin.
10 Click Show XML.
11 In the Plugin XML dialog box, copy all of the text from <plugin> to <\plugin>,
including those tags.
12 On the plugin server computer, open the pluginsvr_config.xml file for editing.
By default, the pluginsvr_config.xml file is in the InstallDir\BMC
Software\AtriumCore\cmdb\plugins\shared\ directory.
13 In the <pluginsvr_config> section of the pluginsvr_config.xml file, paste the
<plugin> text that you copied from the Plugin XML dialog box in step 11 as a new
<plugin> entry.
14 Save and close the pluginsvr_config.xml file.
The Loaded column in the Configure Repository Plugins and Adapters dialog box
displays No when you first create the new plugin.
15 Click Refresh.
The Loaded column in the Configure Repository Plugins and Adapters dialog box
now should display Yes for the new plugin. If the Loaded column continues to
display No, one of the following conditions exists:
An error occurred in connecting to the external data source. Examine the
AtriumPluginSvr.log file for errors. By default, the AtriumPluginSvr.log
file is in the InstallDir\BMC Software\AtriumCore\Logs\ directory.
The external data source returns no external tables. No errors are logged in this
case.
16 If your BMC Atrium CMDB environment uses a server group, make sure the same
plugin is configured on all servers in the server group. Repeat the following steps
for each server:
a Copy the same plugin configuration information in the
pluginsvr_config.xml file for each server. Make the appropriate changes in
the <filename> and <pathelement> tags to correct the jar paths for the local
server if required.
b Copy and paste the Server Plugin Alias entry in the ar.cfg file. Change the
server name to the local server.
c Restart the server.
17 Close the Configure Repository Plugins and Adapters dialog box.
You now must create a data store to represent the external data in your BMC
Remedy AR System form. For more information, see “Managing data stores” on
page 87.
To register an adapter
1 Open Federation Manager.
2 In the toolbar, click the Configure Repository Plugins and Adapters button.
3 In the Configure Repository Plugins and Adapters dialog box, click the Adapter
Registration tab.
4 Click New.
5 In the General tab of the Details section, enter the following information:
86 Administrator’s Guide
Managing data stores
6 (optional) In the More Information tab of the Details section, enter the following
information:
7 Click Register.
The adapter is now available to be used by a plugin. The Other Properties tab
appears when you create plugins using the new adapter. You can click inside the
cells in the Name and Value columns to add a new properties and values for your
custom adapter. Click the Add or Delete icons to add properties.
After you have created a data store, you can configure federated definitions using
the retrieval and launch methods, as illustrated in the following flowchart:
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
Manage data
stores and
definitions
button
2 In the toolbar, click the Manage data stores and definitions button.
3 In the Data Store dialog box, perform one of the following actions:
Action Steps
Create a new data store 1 Select Create new Data Store.
2 Enter a name that briefly describes the data store.
3 Provide a full description of the data store.
4 Click Next.
The new data store is created after you click Next.
Modify an existing data 1 Click the Edit button to modify the name or description of the
store data store.
2 Click Update to save your changes.
88 Administrator’s Guide
Administering the retrieval method of federation
For example, the Calbro Services administrator would select Create new Data
Store, provide a name of Federated Weight Data for Banking Servers,
describe the data store as Microsoft SQL Server database for Banking
Servers, and then click Next.
4 Select a federation method, and then click Next.
For example, the Calbro Services administrator would select Retrieval.
5 Proceed to one of the following sections, depending on the type of federation you
selected:
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
90 Administrator’s Guide
Administering the retrieval method of federation
Table 3-9 lists the supported CMDBf data types and their mapped BMC Remedy
AR System data types. Only the listed data types are created as attributes in BMC
Atrium CMDB federated data classes.
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
In the navigation pane, select an existing data store. Then in the Retrieval
Definitions tab, click New next to the Federated Data Classes table.
2 From the Repository list on the External Data Repository page, select the plugin
that you want to use to connect to the data store.
For example, the Calbro Services administrator would select the banking server
plugin, as created in “Creating plugins for federated data” on page 77.
NOTE
If you defined a plugin alias in the ar.cfg file that is different from the plugin
name, the alias is listed in the Repository field.
3 From Available Tables, select a table that you want to access on the external data
repository, and then click Next.
For example, the Calbro Services administrator would select the BankingServers
table.
4 On the Federated Data Class General Information page, review or provide the
following information, and then click Next:
A namespace for the new federated data class.
By default, new federated data classes are in the BMC.FED namespace. For more
information, see “Namespaces and partitioning the data model” on page 43.
(optional) A valid name for the class. You can use only the following characters:
a-z, A-Z, 0-9, and a period. By default, the Name field is auto-filled, based on the
table you selected previously.
(optional) The name of the person or company creating this class.
(optional) A description of the class.
For example, the Calbro Services administrator would select the BMC.FED
namespace and name the class CAL_BankingServers.
If your organization follows particular naming conventions when extending the
data model, apply those conventions to this class.
92 Administrator’s Guide
Administering the retrieval method of federation
5 On the Field Selection page, select the data fields on the external data source that
you want to make available through federation:
a From the Fields Available in the External Table list, select a field, and then click
Add.
b Continue adding fields to the Attributes in the CMDB Federated Class list until
you have added all of the fields that you want to be available in the new class.
c Use the Key Attribute menu to select a field in the new federated data class as
the key identifier for the class.
NOTE
Select a field that contains a unique value for each instance in the table. The key
identifier should be either a character or integer field on the external source of data.
When you submit the federated data class, the key field is created in BMC Atrium
CMDB as a character field. When the underlying vendor form that represents the
federated data class is created, the key identifier field is internally mapped to the
Request ID field (field ID 1).
d Click Next.
For example, the Calbro Services administrator would add the PrimaryKey, Name,
Priority, LastDataTransfer, and Workgroup fields as attributes in the new
federated data class, and would specify PrimaryKey as the key attribute.
6 Review or assign Hidden and Visible permissions for the new class, and then click
Next.
For more information about BMC Atrium CMDB permissions, see “Class and
attribute permissions on BMC Atrium CMDB data” on page 25 and “Class and
attribute permissions” on page 45.
7 On the Summary page, review the details for the federated data class, and then
perform one of the following actions:
Action Steps
Create the federated data class and 1 Select Create the Data Class and Continue with
then start the process of creating a Relationship Class Creation.
federated relationship class. 2 Click Next.
For more information about creating a federated
relationship class, see “Creating a federated
relationship class” on page 95.
Create the federated data class only. 1 Select Create the Data Class and then Exit.
2 Click Finish.
NOTE
You cannot modify the plugin name, table name, or key attribute associated with
a federated data class.
NOTE
Do not remove the key attribute from the federated data class.
7 Click OK.
94 Administrator’s Guide
Administering the retrieval method of federation
To edit an attribute
1 In Federation Manager, open the federated data class that you want to edit.
2 In the Edit Federated Data Class dialog box, click the Attributes tab.
3 In the list of attributes used in the federated class, click the edit button next to the
attribute that you want to edit.
4 In the Attribute - Edit dialog box, edit values for any of the following fields:
Attribute Name
Namespace
Any field that controls the storage capacity for the attribute (such as Max
Length)
5 Click OK to save the changes to the attribute.
6 In the Edit Class dialog box, click OK.
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
Best practice
Create a federated relationship that links the CI class to your federated data class.
Define a qualification that specifies which instances from the source class are
related to data in the destination class. This qualification requires matching an
attribute in the federated data class to an attribute in the CI class (for example,
matching IDs between two sets of CIs).
For best performance with your production system, remember that the more
federated data that you pull in with your qualification, the more likely you will
experience poor performance from the BMC Remedy AR System server. Your
qualification should return only a limited result set from the federated repository.
5 In the Source and Destination Classes page, select a source CI class for the
relationship.
By default, the current federated data class appears as the destination class.
For example, the Calbro Services administrator would select a source class of
BMC_ComputerSystem.
6 Click the Qualification Builder icon to create the qualification.
96 Administrator’s Guide
Administering the retrieval method of federation
Create a qualification for the relationship to specify which instances of the source
class are related to the data in the destination class. Creating a valid qualification
is necessary to create the link between the CI instance and the external data in the
federated class.
a Select an attribute from the source class. Attributes for the source class are
automatically enclosed in single quotation marks.
b Select an operator.
c Select an attribute from the destination class. Attributes for the destination class
are automatically enclosed in dollar signs.
For example, the Calbro Services administrator would build the following
qualification to relate computer systems to external information about the
banking servers:
'Name'=$Name$
d Click OK.
7 Click Next.
8 Assign Hidden and Visible permissions for the new class, and then click Next.
For more information about BMC Atrium CMDB permissions, see “Class
permissions” on page 25.
9 Review the details for the federated relationship class, and when you are satisfied
with the details click Finish.
If you created a successful match between records from the CI class and the
federated class, you can view them in Atrium Explorer. For example, see the
section on viewing federated instances in the BMC Atrium CMDB 7.6.03 User's
Guide.
98 Administrator’s Guide
Administering the launch method of federation
For example, you could use the URL method to access any website to which you
allow browser access, and you could use the AR System query method to access
data from an BMC Remedy AR System form.
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
Users can view the data using the access method that you specified by clicking the
Open Launch in Context Menu button in Atrium Explorer. For more information
about viewing federated data through Atrium Explorer, see the BMC Atrium
CMDB 7.6.03 User's Guide.
NOTE
BMC Remedy IT Service Management uses the launch method to integrate its
application suite out-of-the-box with the BMC Atrium CMDB. For example, you
can select a CI in Atrium Explorer and then click the Open Launch in Context
Menu button to view related change requests or related incidents.
When using the launch federation method, you must configure the following
components within BMC Atrium CMDB:
Data store—Defines an external source of data related to CIs. Data stores are also
known as federated products. For more information, see “Managing data
stores” on page 87.
Federated launch interface—Specifies a method of getting the data from a
federated product. Launch interfaces are also known as federated interfaces.
Federated launch link—Connects one or more CIs to the federated data by using
the method specified by a federated interface. Launch links are also known as
federated links.
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
Launch interfaces can link to either a specific CI or a set of CIs. This gives you the
ability to create one launch interface at design time instead of having to create a
new interface every time you create an instance of the CI class.
A class-level launch interface uses either attribute substitution or foreign key
substitution to access its federated data in the context of a given CI. For more
information about these concepts, see the BMC Atrium Core 7.6.03 Concepts and
Planning Guide.
A launch interface uses one of these access methods to launch its federated data
store:
AR—A query to a BMC Remedy AR System form. You specify the server, form,
view, and query string, and choose whether to launch the query in BMC
Remedy User or a web client.
URL—A Uniform Resource Locator (URL) for accessing web sites.
Run Process—An executable on the BMC Atrium CMDB server computer. You
can specify parameters in the access string.
Manual—Instructions for finding data manually.
4 In the Access Method list, select the method that you want to use.
5 Click Next.
6 In the Row Level Security window, select which groups and roles should have
row-level access for the federated launch interface.
The Public group is selected by default. This means that any user who can access
the UI can launch this federated interface. To view or modify a specific launch
interface, you must also have row-level access to that instance. For more
information, see “Roles, instance permissions, and row-level access” on page 27.
7 Click Finish.
The launch interface appears in the table.
Configuring federation
2 Retrieval method:
3 Retrieval method:
Create a federated Create a federated
1 class relationship
Create a federated
data store
2 Launch method:
3
Launch method:
Create a launch Create a launch link
interface
Linking by instance
Linking at the instance level creates a relationship between one instance in BMC
Atrium CMDB and an interface to a particular piece of federated data. You must
create a separate link for each instance from which you want to access federated
data. This type of launch link is useful when you want to restrict access to the
federated data. For example, if your CEO has the only monitor in your
environment for which an extended warranty was purchased, you might create a
link from that monitor instance in BMC Atrium CMDB to information about the
extended warranty.
Linking by class
Linking at the class level enables you to specify one link that connects, for example,
all computer systems in your environment to the incident records that pertain to
them. You can optionally specify that the link applies to only a subset of computer
systems by adding a qualification. Linking at the class level creates a relationship
between one BMC Atrium CMDB class and an interface to a particular piece of
federated data. This method is the best practice in most cases.
NOTE
Launch links are not bidirectional. They allow you only 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.
TIP
A Class link is usually better than an Instance link because it allows multiple
instances to access external data from a single launch link, rather than requiring a
link for each instance.
8 When you finish providing details for the launch link, click Next.
9 In the Row Level Security window, select which groups and roles should have
row-level access for the federated launch link.
The Public group is selected by default. This means that any user who can access
the UI can launch this federated link. To view or modify a specific launch link, you
must also have row-level access to that instance. For more information, see “Roles,
instance permissions, and row-level access” on page 27.
10 Click Finish.
The launch link appears in the table.
You can configure service models by creating relationships in the BMC Atrium
CMDB. Service models enable you to understand how the IT infrastructure
impacts the business services that IT provides.
You can also configure an impact model by creating impact relationships in
Atrium Explorer. With an impact model, you can run impact simulations in
Atrium Impact Simulator to determine how changes to a CI affect other CIs or
business services. For example, you could run a simulation to learn what devices
and applications in your network would be impacted if you were to take a server
offline.
The following topics are provided:
Overview of service and impact models (page 108)
Creating provider organizations (page 110)
Working in the Service Catalog (page 112)
Creating dynamic service models (page 116)
Manually creating impact models of services (page 119)
The following features of BMC SIM are not used with Atrium Impact Simulator:
BMC SIM schedules
Custom propagation models
Custom status computation models
Custom status
WARNING
Do not edit values for the InstanceId and ReconciliationIdentity fields. BMC
Atrium CMDB creates values for these fields automatically when you save the
instance, and workflow requires that these values remain unchanged.
5 Click Save.
6 Click Close.
7 Perform one of the following actions:
Action Steps or Procedure
Create new services in the Service 1 Open the Service Catalog.
Catalog. 2 Create a new business service or technical
service.
For more information, see:
“Working in the Service Catalog” on page 112
“Creating new services for the Service
Catalog” on page 113.
Promote changes to the BMC.ASSET 1 Click the Promote Sandbox Changes icon in
dataset if you are finished working in the toolbar.
the Sandbox dataset. 2 In the Promotion Preview Dialog, click
Later, you can copy the provider Promotion to promote the CI instances to the
organization CIs back to the Sandbox BMC Asset dataset.
dataset.
NOTE
You can also create or edit provider organizations or attributes in the CMDB
Console, If you do so, you must restart the BMC Atrium Core Console to see the
changes in the Service Catalog.
The services in a service model represent parts of your business. As you build a
service model, Service Catalog enables you to populate the service model from a
catalog of services and add new services. You can then view and edit services.
The Service Catalog enables you to:
View all services that have been defined
Sort the currently displayed set of services by any of their associated attributes
Create a new service
Copy services and organizations from production to a sandbox
NOTE
See “Creating provider organizations” on page 110 for information about setting
provider organizations and attributes in a service.
NOTE
The Service Offerings, Requestable Offerings, and Topology tabs are currently
disabled and are reserved for future use by BMC Software.
2 To copy all technical and business services and all organizations to your sandbox,
select Copy All Services and Organizations.
3 To choose the services and organizations, select Copy only Selected Services and
Organizations.
In the Business Services, Technical, and Provider Organizations tabs, complete the
following steps.
a In the Available in Production Dataset list, select a service or organization.
b Click the left arrow or right arrow to add or remove the service.
c To copy or remove all items, click the double left arrow or double right arrow.
4 Click OK to copy the services and organizations to your sandbox dataset.
6 Click the left (<) arrow or right (>) arrow to add or remove the service.
7 Click OK to map the Technical Service.
8 Click Save Service Information.
9 Perform one of the following actions:
Action Steps or Procedure
Create impact relationships. 1 Open Atrium Explorer.
2 In the Sandbox dataset, create an impact
relationships between CIs.
For more information about creating
relationships, see the BMC Atrium CMDB
7.6.03 User's Guide.
Promote changes to the BMC.ASSET Click the Promote Sandbox Changes icon in
dataset if you are finished working in the the toolbar.
Sandbox dataset.
Later, you can copy the service CIs back
to the Sandbox dataset.
NOTE
The Map IT Resources icon in Atrium Explorer is enabled only if you a select a
Business Service or Technical Service from the BMC.ASSET dataset and you have
administrative privileges.
The Map IT Resources dialog box appears. The Available Queries list shows the
queries available for the selected technical service.
6 In the Run queries every field, specify the time (by minutes, hours, or days) to run
the automated query.
The default is 30 hours.
7 Click Apply.
8 Click Close.
9 Wait for the queries to run in their specified time (for example, 30 hours).
10 Reopen the technical service and then expand its children.
The related CIs returned by the queries appear under the technical service in
Atrium Explorer.
To delete a query
1 Select a query from the list.
2 Click the Delete icon.
3 Click Yes when prompted.
Editing queries
To edit a query associated with a technical service, search for a technical service
instance in the BMC.ASSET production dataset, and click the Map IT Resources
icon in the toolbar.
Figure 4-4 shows a sample impact model created in Atrium Explorer. There are
four server CIs connected to a cluster CI, which is then connected to a technical
service CI.
The impact relationships in this impact model use the following default settings:
ImpactWeight—100
ImpactPropagationModel—DIRECT
By default, the ImpactComputationModel of the cluster is set to STANDARD.
If you do not modify the impact weight, propagation model, or cluster type default
values, the servers function independently of each other in the impact model. As a
result, if a server CI is unavailable, the predicted impact is that the cluster CI and
the technical service CI will likewise be unavailable, even though three other
servers are fully functional.
You can subsequently modify the impact model in various ways. For example, you
can modify the ImpactComputationModel setting of the cluster to
WEIGHTED_CLUSTER. The WEIGHTED_CLUSTER setting uses the
ImpactWeight value of each of the providers. If you do not modify the default
values from 100, all of these providers are considered equal in the impact model.
The impact of any single provider is a weighted averaged with the other providers.
As a result, when the provider is unavailable, there should be no impact to the
technical service.
You can also modify the impact weights and propagation model settings of the
relationships (for example, by setting the impact weight to 400 and the
propagation model to INCREASING). If you increase the ImpactWeight of one of
the providers, that server is now assigned more weight in the computed status
than the back-up servers. As a result, when the provider is unavailable, there now
should be a minor impact to the technical service.
Before you begin
You can easily test the impact model in Atrium Explorer. The following examples
assume that you created the impact model shown in Figure 4-4. The servers,
cluster, and technical service use their default settings.
5 Edit the impact weight of the impact relationship between two CIs (for example,
between one of the software servers and the cluster).
a Right-click the relationship and then select Edit.
b In the BMC_BaseRelationship form, click the Custom tab.
c In the ImpactWeight field, enter 400.
The ImpactWeight is an integer that is relative to the other providers to the
cluster. To change the behavior of the impact model and to provide more weight
to the provider in the computed status, you must change the weight relative to
the other values. The provider now has four times the weight relative to the
other servers.
d Click Save.
6 Run an impact simulation on the server CI (for example, setting the simulated
status to Unavailable).
Based upon these new values, one provider is considered four times more
important in the weighted average. When that provider is unavailable, the
predicted impact is that the cluster and the technical service will experience some
kind of impairment.
Figure 4-8: Impact on service with change to cluster and impact weight settings
When you run the actual simulation in Atrium Impact Simulator, you see that the
cluster and the technical service will experience minor impairment—the server’s
delivery of service is slightly affected.
For more information about impact states, see the BMC Atrium CMDB 7.6.03 User's
Guide.
You can migrate data from one BMC Atrium Core server to another. The most
common reason to migrate data from one server to another is to move your BMC
Atrium Core implementation into production.
The following topics are provided:
Overview of migrating BMC Atrium Core (page 128)
Migration of BMC Remedy AR System data from source servers to target
servers (page 128)
Migrating BMC Atrium CMDB class definitions and instances (page 129)
Migration of Product Catalog data (page 140)
Migrating normalization jobs and settings (page 153)
Migrating reconciliation jobs and dataset settings (page 154)
Migrating BMC Atrium Integration Engine data (page 156)
Manually configuring federated data on your production server (page 160)
Step 2 BMC Atrium CMDB class definitions and instances (see page 129)
Step 3 BMC Atrium Product Catalog product entries and configurations (see page 140)
NOTE
These procedures cover the steps for migrating only BMC Atrium Core settings
and data. If you have other BMC Software applications installed on your
development server that integrate with BMC Atrium Core, such as BMC Remedy
Asset Management, you must migrate that data separately.
NOTE
The source and destination are not stored in any of these XML files. As a result,
these files can be reused as needed for comparisons or difference reporting.
For more information about Migrator CLI, see the BMC Remedy Migrator 7.6.03
Migrator Guide.
Depending on your business needs, you can create different instructions. For
example, you can use the Migrator CLI to import classes or the workflow attached
to CMDB class forms, after you create, modify, or delete the class model on the
development server and then you want to import this model into the production
server. You also can use the Migrator CLI if you have added BMC Remedy AR
System workflow to the CMDB forms.
For more information, see “BMC Atrium CMDB instructions examples of data
migration” on page 134.
3 Run the migratorcli command and specify the CMDBMetaData.xml,
ExampleCMDBInstruction.xml, and CMDBConfiguration.xml files.
migratorcli –m –s Source -d Destination --classname “” –metatype
“CMDB” –y “CMDBMetaData.xml” –g “Migrator Configuration.xml” –u
Demo
Depending on your business needs, you can run different versions of the
migratorcli command. For more information, see “Migrator CLI command
examples” on page 136.
CMDB metadata
The following section uses sample entries to explain the metadata XML document
structure. The main root element can contain multiple <meta> items for each major
metadata type, such as CMDB.
<meta-data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="Migration Meta Data.xsd">
NOTE
In normal situations, do not modify the CMDBMetaData.xml files.
meta name
<meta name="CMDB" identifier-form="OBJSTR:Class" description="This is the
meta-data for the CMDB application design">
The root element for a specific metadata design such as CMDB and contains all the
form and object mappings that are specific to this element.
meta name—The name of the metadata item. It is used as the “owner” within the
instruction XML document when attempting to migrate or compare metadata
items within special items.
identifier-form—The main form that contains the true name of the metadata.
For CMDB, this is the form that contains the class name. This is known as the
root form from which all other forms are mapped.
description—Text that describes the document.
form name
<form name="OBJSTR:Class" unique-field-id="1" name-field-id="8" extends-
form="form-name">
Used to identify a specific form and how the data on that form relates to other
defines forms and/or to AR System Object(s).
form name—The name of the form on the AR System server.
unique-field-id—The unique identifier for the field. By default, 1 is used.
name-field-id—The field that contains the unique name of the entry. It is
typically used only when the mapping item is the main identifying form. This is
the field that is searched when a name is specified within the instruction
document.
extends-form—The name of the base form. Entries are mapped using the unique
IDs of this form and the form mapping that is defined for the extends form.
object type
<object type="Form" cascade="all">
For AR System object mapping, this element and its children are used to identify
the object to which this form mapping maps.
object type—The AR System object that does not include metadata.
cascade—The action to take if the parent entry is deleted. Options are:
all—Perfoms both creation and deletion of entries.
create-orphan—Creates only entries found on the source but are missing
from the destination. Does not delete extra entries found on the destination.
delete-orphan—Deletes extra entries found on the destination but not on the
source. Does not create extra entries found on the source.
<field id="1"/> and <text value=":"/>
These items are contained within the <object> element and are used to identify the
fields and text that make up the name of the AR System object. The name is built
based on the contents of the fields and the text value.
one-to-many form
<one-to-many form="formName" local-key-id="3" foreign-key-id="2"
cascade="all">
One-to-many mapping is used when a single entry in the main form is related to
many entries within the specified form.
one-to-many form—The name of the external form where many entries match
one entry locally.
local-key-id—The field ID of the local key used in the external form to make
multiple entries from the local form.
foreign-key-id—The unique field ID used on the remote form. It is not
required, because the unique-field-id defined on the form can be used.
Cascade —The action to take if the parent entry item is deleted. Options are:
all
create-orphan (not currently supported)
delete-orphan
The <local-keys> and <foreign-keys> can be used if multiple fields are used for
each corresponding attributes. These elements override the corresponding
attributes.
many-to-one form
<many-to-one form="formName" local-key-id="3" foreign-key-id="2">
This mapping type is used to define mapping of multiple entries in the local form
to a single entry in the foreign form. Because this mapping has no cascade option,
deleting or creating entries in this form does not affect the external form.
many-to-one form—The name of the external form, where one entry matches
many local entries.
local-key-id—The field ID of the local key used in the external form to make
multiple entries from the local form.
foreign-key-id—The unique field ID used on the external form. This ID is not
required because the unique-field ID defined on the form can be used.
one-to-one form
<one-to-one form="formName" local-key-id="" foreign-key-id="">
In this mapping, every entry in the local form maps to one entry within the
specified external form. Cascade is not defined for this mapping type.
one-to-one form—The name of the external form where one entry matches one
entry locally
local-key-id—The field ID of the local key used in the external form to make
multiple entries from the local form.
foreign-key-id—The unique field ID used on the external form. This ID is not
required because the unique-field ID defined on that form can be used.
many-to-many form
<many-to-many form="formName" local-key-id="3" foreign-key-id="5" mapping-
form="" source-field-id="2" destination-field-id="1">
This mapping allows mapping of multiple entries in the local form to multiple
entries in the external form. This mapping uses an intermediate form, in which the
unique fields from the local form are mapped to the unique fields on the external
form.
many-to-many form—The name of the external form where many entries matches
many local entries
local-key-id —The field ID of the local key used in the external form to make
multiple entries from the local form.
WARNING
If the comparison result file already exists, it is overwritten with the new file.
NOTE
In this command sequence, the –metatype is required because it defines the
mapping to use within the mapping file CMDBMetaData.xml.
NOTE
In this command sequence, the –metatype is required, because it defines the
mapping to use within the mapping file CMDBMetaData.xmlfile.
NOTE
You no longer need to define metadata mappings with the Migrator CLI; it
defaults to the CMDBMetaDataEnableDelete.xml mapping document. Otherwise,
use the -y parameter to specify the CMDBMetaData.xml mapping document.
4 At the Export instance data from all classes? (F): prompt, type T to
export all instance data.
If you press Enter to accept the default value of F, you must specify the namespace,
class, and attribute details for which you want to export the class definitions.
5 At the Dataset ID (): prompt, type the dataset ID from which you want to
export the instance data.
6 At the Filename for exported data: prompt, specify the file name in which to
save the exported instance data.
Make sure you specify the exact path for the file name, for example,
c:\ExportedInstanceData\CoreInstanceData.xml. If you specify a file name
that already exists, the contents of the file is overwritten.
Before attempting to import the data, you must understand how the required data
on each staging form is represented on the Product Catalog Console, as displayed
in Figure 5-2 on page 141.
Table 5-2 lists the set of staging forms required for importing custom titles into the
Product Catalog. Object refers to the item in Figure 5-1 on page 140. Console Area
refers to Figure 5-2.
When the Reporting Console opens, reports that are associated with the form
and that you have permission to access appear in the list. The list can include
reports of type AR System, BIRT, and Crystal. If no reports appear in the
Reporting Console list, you must create a new report of type AR System.
c To generate .arx output, select an AR System type report, as identified in the
Report Type field.
All the records that you selected are passed to the report.
If no reports appear in the Reporting Console list, then either there is no report
associated with this form, or you do not have permission to access it. In that case,
you must create a new report of type AR System.
d In the Destination field, select File.
e In the Format field, select AR Export.
f Enter a name for your report.
Change the file name to the form name, without using illegal characters.
g Click Run.
6 Repeat this procedure for each staging form that you are exporting.
Step 1 Create the data by loading it into the appropriate staging forms. (See page 144.)
Step 3 Import the data from the staging forms to the Product Catalog forms. (See
page 152.)
To import Product Catalog data provided by BMC, see the BMC Atrium Core 7.6.03
Product Catalog and DML Guide.
NOTE
When you import custom data, the BMC_Product and BMC_OperatingSystem
classes are populated with entries. No products exist for other classes.
NOTE
To load data using spreadsheets, you also need to create mapping files that specify
which spreadsheet fields map to the destination form fields.
You can manually create entries in each of the staging forms. The required fields
and sample data are shown in the following tables.
Table 5-4 through Table 5-12 list the fields in each of the staging forms.
Entries where the manufacturer country is not known can be marked with
country = "UNKNOWN" and countrycode = "ZY."
NOTE
Each application can have only one main executable file.
NOTE
If you have populated the signature, you must include this form for migrating
Product Catalog data.
NOTE
If you have populated the signature, you must include this form for migrating
Product Catalog data.
Importing the data into the BMC Atrium Product Catalog forms
After the data is successfully validated, you are ready to import the data into the
BMC Atrium Product Catalog forms.
PDL_ESIDappsCustom
PDL_ESIDappfilesCustom
PDL_ESIDsuitesCustom
PDL_ESIDsuiteappsCustom
4 Click Import.
5 When the import message appears, click Close.
NOTE
Do not save the file using Microsoft Notepad because it does not save the carriage
returns and line feeds (CR+LF) properly. Use a plain text editor that retains
CR+LF. Otherwise, importing the definitions fails.
NOTE
Before using the CLI on UNIX for the first time, you must add an entry to your
library path. The CLI also has several other options not described in the following
procedure, some of which might be necessary depending on your AR System
server environment. For more information about these topics, see the BMC Remedy
Action Request System 7.6.03 Integration Guide.
NOTE
The AIE menu is not available for other BMC Atrium Integration Engine consoles,
such as CI Class Mappings, Relationship Class Mappings, and AR System Form
Mappings.
3 In the Source Server Details area, review or enter the following information:
Server Name The server on which the data resides. (The value
for this field is automatically populated and you
cannot modify it.)
TCP Port The TCP port if you are not using the default port.
(The value for this field is automatically populated
and you cannot modify it.)
Admin Login Name The BMC Remedy AR System administrator user.
Admin Password (optional) The BMC Remedy AR System password.
5 For the Export All Exchanges option, accept the default option of Yes or select No
- Only Selected Ones.
6 If you select the No - Only Selected Ones option, a list of data exchanges appears
in the table.
7 Select the data exchanges you want to export.
8 Click Export.
The label of the Export button changes to Get Results.
9 Click Get Results.
One of the following messages appears.
Export in progress.
Export completed.
Export failed.
A detailed log is available in the result field.
NOTE
The AIE menu is not available for other BMC Atrium Integration Engine consoles,
such as CI Class Mappings, Relationship Class Mappings, and AR System Form
Mappings.
2 In the Export Configuration to File area, enter a valid directory path in the Output
Directory field.
3 Click Export.
The AIE_Configuration.arx file is created in the directory path that you specified.
This file contains configuration information for all data exchanges as well as data
mappings.
NOTE
If BMC Atrium Integration Engine 7.5.00 or later is installed on BMC Remedy
AR System 7.1.00 and BMC Atrium CMDB 2.1.00, use the BMC Remedy Import
utility or BMC Remedy Import CLI to import data. On other hand, if BMC Atrium
Integration Engine 7.5.00 or later is installed on BMC Remedy AR System 7.5.00
and BMC Atrium CMDB 7.5.00, you must use the BMC Remedy Data Import
utility or BMC Remedy Data Import CLI.
To import data
1 Open the AIE_Configuration.arx file to edit it.
2 Make the following changes in the AIE_Configuration.arx file:
Remove the configuration definition for the following forms:
EIE:BackupLoadFlag
EIE:ApplicationSettings
EIE:VendorConfiguration
NOTE
The form names in the AIE_Configuration.arx file use the EIE: prefix.
You can package and install BMC Atrium CMDB class and attribute extensions.
The following topics are provided:
Overview of BMC Atrium CMDB extensions (page 162)
Manually creating BMC Atrium CMDB extensions (page 162)
Accessing the Extension Loader (page 165)
Installing BMC Atrium CMDB extensions (page 165)
Verifying your installed extensions (page 169)
Packaging BMC Atrium CMDB extensions (page 171)
"<stage level=""RegisterExtensions"">
<rik_command>
<subcommand>appinfo</subcommand>
<log_dir>$BMC_CMDB_EXTENSIONS_DIRECTORY$</log_dir>
<log_name>BMCCMDBExtensionLoader</log_name>
<guid>ID00C04FA081BAg7YTQwYNXncALwcA</guid>
<property_name>Name</property_name>
<mode>ITSM-CMDB extension #1</mode>
<property_status>0</property_status>
<server_info_parameter>set</server_info_parameter>
<no_output_to_console/>
<no_new_log/>
<note>Installing ITSM-CMDB extension #1</note>
</rik_command>
<rik_command>
<subcommand>appinfo</subcommand>
<log_dir>$BMC_CMDB_EXTENSIONS_DIRECTORY$</log_dir>
<log_name>BMCCMDBExtensionLoader</log_name>
<guid>ID00C04FA081BAg7YTQwYNXncALwcA</guid>
<property_name>Version</property_name>
<mode>7.0</mode>
<property_status>0</property_status>
<server_info_parameter>set</server_info_parameter>
<no_output_to_console/>
<no_new_log/>
<note>Installing ITSM-CMDB extension #1</note>
</rik_command>
</stage>"
Define the version of BMC Remedy AR System:
<ar_version_condition operation="GREATER_THAN_OR_EQUALS_TO"
version_operand="7.6"/>
Define the minimum and maximum version of BMC Atrium CMDB:
"<version_condition guid=""OB00C04FA081BABZlxQAmyflAg1wEA""
operation=""GREATER_THAN_OR_EQUALS_TO"" version_operand=""1.0""/>
<version_condition guid=""OB00C04FA081BABZlxQAmyflAg1wEA""
operation=""LESS_THAN_OR_EQUALS_TO"" version_operand=""9.0""/>"
cmdbdriver commands
" <cmdb_driver_command>
<file_name>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$600-
CDMExtensions$/$200-CDMExtensions-OSD.txt</file_name>
<output>$BMC_CMDB_EXTENSIONS_DIRECTORY$$/$DriverLog</
output>
<note>Installing ITSM-CMDB extension #1</note>
</cmdb_driver_command>"
Extension already exists—The version of the extension in the file is same as that
found in the BMC Remedy AR System server.
New Version of Extension already exists—The version of the extension in the
file is smaller than that found in the BMC Remedy AR System server.
Extension already failed—An installation of the extension you are trying to
install has already failed. You are unable to complete the extension installation.
Contact BMC Customer Support to resolve the problem.
Extension in running state—A previous installation of the extension is already
running, such as when you stop the extension installation before it has
completed. You are unable to complete the extension installation. Contact BMC
Customer Support to resolve the problem.
Dependency Failure—The version conditions mentioned in the XML file (such
as the <ar_version_condition> and <version_condition> tags) do not
comply with that of BMC Remedy AR System server.
To install extensions
1 From the Configuration tab, select Run Extensions.
2 Click Browse to locate and select the ExtensionLoader.xml XML file with the
extension data.
3 Click Next.
4 Provide the following BMC Remedy AR System information, and then click Next:
5 Click Run.
An installation summary indicates if the generation succeeded or failed, including
a brief reason for the failure, such as “The structure of the XML is not proper.
Please ensure tags are closed properly.
6 For a failure, click View Log to find details.
a In the atriumcore_configuration_log.txt window, sort by Severity.
b Look for SEVERE messages highlighted in red.
c Select a message to display the details at the bottom of the window.
7 To return to the initial generation view, click Done.
5 To specify the port for the BMC Remedy AR System server, remove the # for the
following line, and replace <AR System TCP Port> with the port number.
BMC_AR_PORT=<AR System TCP Port>
6 Remove the # for the following line.
#BMC_CMDB_EXTENSIONS_FILE=<full_path_ to_
the_extension_loader_xml_file_including_the_file_name>
7 Replace the
<full_path_to_the_extension_loader_xml_file_including_the_file_nam
e> line with the path and name of the XML file with the extensions.
NOTE
On Windows, you must use double slashes in the path.
For example:
C:\\Program Files\\ExtLoader\\ExtensionLoader.xml
8 Save the file with a .ini extension.
# AR Server Properties
##################################################################
# AR user. Uncomment the below line and replace the <AR System
Admin User> with the AR Username
#BMC_AR_USER=<AR System Admin User>
# AR password. Uncomment the below line and replace the <AR System
User Password> with the AR Password
#BMC_AR_PASSWORD=<AR System User Password>
# AR server Name. Uncomment the below line and replace the <Server
Alias> with the AR Server Name
#BMC_AR_SERVER_NAME=<Server Alias>
# AR port. Uncomment the below line and replace the <AR System TCP
Port> with the AR Server Port No:
#BMC_AR_PORT=<AR System TCP Port>
##################################################################
# Extension Loader Properties
##################################################################
# Extension Loader XML File.Uncomment the line with
BMC_CMDB_EXTENSIONS_FILE and replace the
# <full_path_ to_
the_extension_loader_xml_file_including_the_file_name> with the
Extension Loader XML file
# Please note that the windows file path must be specified as
C:\\Program Files\\ExtLoader\\extLoader.xml"
#BMC_CMDB_EXTENSIONS_FILE=<full_path_ to_
the_extension_loader_xml_file_including_the_file_name>
NOTE
When you specify a GUID for the BMC Atrium CMDB dependency in your
package.xml file, make sure you use the same GUID as shown in the example.
This is the GUID stored in the SHARE:Application_Properties AR System form
for the BMC Atrium CMDB.
NOTE
The <minversion> and <maxversion> elements are optional. Use them to restrict
the extension up to a specific existing application version, and do not use version
numbers that do not exist, such as BMC Atrium CMDB 99.99.9.
3 Save the package.xml file under the extension subdirectory you created in
“Exporting class definitions by using cmdbdriver.”
After the script stops executing the activity file, the extension loader reads these
log comments to verify whether the script execution was successful. The cout
command closes the log entry file.
Example: Activity file
oout
OSDriver.out
imp //activity type
1 // Number of class or instance defintions to import
TEST // Class name
SampleClass // Namespace
1 // metadata or instance data choice. 1 indicates
metdata.
.
cout
term
q
When the extension loader executes the activity file shown in this example, the
class definitions for the Test class will be imported. You can specify multiple
cmdbdriver commands in your activity file, for example, your script file can
contain both export and import commands.
NOTE
If you create the activity file in Windows format, make sure you use the DostoUnix
command to convert the file from Windows format to UNIX before you run it.
2 Type oout and OSDriver.out output file name in the beginning of the file as
shown in the previous example.
You must specify the oout command and the OSDriver.out output file for the
activity script. The extension loader program generates an error if you skip this line
in the activity file.
NOTE
You must name the output file for the oout command as OSDriver.out. If you
specify any other file name, the extension loader program generates an error.
3 Specify the type of activity the extension loader must perform, such as ARD or OSD.
4 Specify the number of class definitions or instance data objects you want to export
or import.
5 Specify the class name and namespace for the OSD activity.
You can perform various BMC Atrium CMDB administrative tasks, including
configuring Atrium Explorer.
The following topics are provided:
Notification of BMC Atrium CMDB events (page 180)
Atrium Explorer configuration (page 184)
Control of the layout of class forms (page 184)
Setting the cache refresh interval (page 191)
Setting the DSO option for BMC Atrium CMDB (page 191)
Changing the default CI editor in Atrium Explorer (page 192)
Publishing an event
An event is a type of change to instances of a specified class or classes. For example,
you can publish an event that occurs whenever an instance of BMC_Printer is
modified. You can also further restrict an event so that it occurs only if attribute
values match a specified qualification. For example, you can publish an event that
occurs only when an instance of BMC_Printer is modified and its Availability
is Low. An event is inherited by all subclasses of the class on which it is published.
When an event is published, any instance of it that occurs is written to the
CMDB:Events form.
NOTE
A sample filter named CMDB:EventGenerator is included with BMC Atrium
CMDB. This filter creates event instances when the Availability attribute is set
to Low. You can modify it to fit your needs or save a copy to use as a template. The
sample filter is disabled and attached to a sample form named
CMDB:Sample:EventNotification that has fields identical to those on the class form
for BMC_BaseElement. You must attach the filter to a BMC Atrium CMDB class
form and enable it.
For more information about filters, see the BMC Remedy Action Request System
7.6.03 Workflow Objects Guide.
To publish an event
1 In BMC Remedy Developer Studio, select File > New Filter.
2 In the New Filter dialog box, select the server where BMC Atrium CMDB is
installed, and then click Finish.
3 In the Untitled Filter window, enter the following information:
6 Click Save.
7 Open the filters named CMDB:Event_SeparateListOfValues and
CMDB:Event_SeparateListOfValuesCallGuide.
8 In both windows, select Enable and save the filters.
When the new filter runs, these two filters convert the attribute field IDs to field
names and format those in pairs with their values, placing the resulting string into
the Event_AttributeValues field. Here is an example Event_AttributeValues value
for the sample filter:
[Item, My item ; NameFormat, This format ]
WARNING
Do not modify the ObjectStoreView view (ID 399999100) of the class form for any
class in the BMC.CORE or BMC.CORE.CONFIG namespaces. Your changes could be
overwritten by future releases of patches to the BMC Atrium CMDB. Instead, copy
ObjectStoreView to a new view for that form and modify the new view. There is
no risk to modifying the ObjectStoreView view of class forms in other
namespaces.
NOTE
Panel fields created by this process, and any attribute fields placed in the upper left
corner of the view, are created as Hidden. This prevents users from seeing the new
attributes until you have had the opportunity to place them in the location that you
want. To allow users to see the new attributes, move them off the panel field or
make hidden fields visible.
Primary Join Form (optional) If you specify a form name here, the form
generated is a join of this form as the primary join
form and the BMC Atrium CMDB class form as the
secondary join form. This field must be blank if a
secondary join form is specified.
Secondary Join Form (optional) If you specify a form name here, the form
generated is a join of the BMC Atrium CMDB class
form as the primary join form and this form as the
secondary join form. This field must be blank if a
primary join form is specified.
Forms are not necessarily generated for every entry in this form when the form
generation utility runs. You specify the forms that are generated for each run of the
utility with parameters explained in the following procedure.
NOTE
If you do not specify a primary join form or secondary join form, the form
generated is a self-join of the BMC Atrium CMDB class form as both the primary
and secondary join forms. Unless you have other data you want to display with
BMC Atrium CMDB data, you should leave both fields blank.
Parameter Description
-f ConfigFormName The name of the form created in step 2 on page 188.
-g FormNameFieldID The field ID of the Form Name field on the form created in
step 2 on page 188.
-c ClassKeywordFieldID The field ID of the Class Keyword field on the form
created in step 2 on page 188.
Parameter Description
-C ClassID The class ID of the class for which a form is generated. You
must provide either this parameter or -t, but not both.
Note: The class ID is case sensitive, and might not be the
same as the class name. For example, the class with a
name of BMC_ComputerSystem has a class ID of
BMC_COMPUTERSYSTEM. For more information
about the class ID of a specific class, see the BMC
Atrium CMDB 7.6.03 Data Model Help.
-t TimeStamp A UNIX epoch time value. Forms are generated only for
classes modified after this time and all of their subclasses.
You must provide either this parameter or -C, but not
both.
Parameter Description
-R Specifies that forms are also generated for all
subclasses of the class specified with -C.
-p PrimaryJoinFormNameFieldID The field ID of the Primary Join Form field on
the form created in step 2 on page 188. If you
populated the Primary Join Form field, you
must specify this parameter.
-s The field ID of the Secondary Join Form field
SecondaryJoinFormNameFieldID on the form created in step 2 on page 188. If
you populated the Secondary Join Form field,
you must specify this parameter.
-D Enables debugging for this operation.
Debugging increases the details that are
written to the log file.
Log messages for each form generation are written to one of the following
locations:
On Windows: ARServerInstall\Arserver\Db\CMDBSynchronizeUI.log
On UNIX: ARServerInstall/Db/CMDBSynchronizeUI.log
NOTE
You can use workflow to create these Application Pending entries, but as
mentioned in step 1 on page 189, it cannot be executed while any classes are in
Change Pending state.
Appendix A Integrating BMC Atrium Core widgets with other applications 195
BMC Atrium CMDB 7.6.03
Table A-2 lists the parameters required to launch the Atrium Query form.
Appendix A Integrating BMC Atrium Core widgets with other applications 197
BMC Atrium CMDB 7.6.03
7 Select the Active Link, and, in the Permissions tab, specify permissions for the
active link.
8 On the BMC Remedy Developer Studio toolbar, click Save.
Your active link is now saved.
NOTE
The AtriumWidget value in the Module type list does not appear if you have not
installed the BMC Atrium CMDB application on your system.
From the Definition list, select the Atrium Query or Atrium Explorer.
From the Server list, select the server hosting the widget.
6 On the Database tab, specify a name for the Data Visualization field in the Name
text box.
7 Create an active link that executes when the Data Visualization field is initialized
and specify the following details for the active link:
On the Basic tab:
Specify a name for the active link.
From the Form Name list, select the form name.
On the If Action tab:
From the New Action list, select Set Fields.
From the Read Value for Field From list, select the form name on which the
data visualization field is placed.
From the Name list, select the name of the Data Visualization field you
created.
In the Value field, set the required parameters for launching the widget.
Atrium Explorer:
(((((((( "namespace=" + $Namespace$) + ",classname=") + $Class
Name$) + ",datasetid=") + $Dataset ID$) + ",instanceid=") + $CI
ID$) + ",filtername=") + “Components and Dependencies”
Atrium Query:
(( "resultsetLocation=" + $Resultset Location$) +
",datasetid=") + $Dataset ID$
In the examples, the field names, such as $Namespace$ and $Class Name$ are based
on the field names of a form. You must provide these field names as you have
specified in your form. You might also specify string values as shown in the
example.
NOTE
The namespace, classname, datasetid, instanceid, and filtername parameters are
Atrium Explorer-defined keywords.
Appendix A Integrating BMC Atrium Core widgets with other applications 199
BMC Atrium CMDB 7.6.03
Table A-4 lists the parameters and field ID mappings that are required to launch
the Atrium:Query form.
Table A-4: Atrium Query parameters—non-AR System applications
NOTE
Launching the widgets requires that you log in to the BMC Remedy Mid Tier. You
can supply a login ID and password in a POST command as part of the URL.
2 Press Enter.
The BMC Remedy Action Request System login screen appears.
3 Type a user name and password in the login screen, and click Log In.
The specified widget opens in the browser.
Appendix A Integrating BMC Atrium Core widgets with other applications 201
BMC Atrium CMDB 7.6.03
This section explains how to deprecate classes and attributes in your data model.
You might need to deprecate one or more objects in your data model to adapt to
your changing business needs, and evolving technology and services.
The following topics are provided:
Overview of the deprecation process (page 204)
Use cases for deprecating your data model (page 205)
Identifying the metadata to deprecate (page 209)
Creating deprecation mappings (page 209)
Installing the updated data model (page 213)
NOTE
BMC recommends that only the user or the application that creates a class
deprecates it. For example, if a discovery application extends the
BMC_SoftwareServer class, which ships with BMC Atrium Core, and creates an
OracleAppServer class, only the discovery application should deprecate the
OracleAppServer class.
You deprecate classes and attributes in your data model in the following steps:
Step 1 Identify the metadata to deprecate, as described in the procedure on page 209.
Step 2 Create the deprecation mappings, as described in the procedure on page 209.
Step 3 Install the updated data model, as described in the procedure on page 213.
BMC_BaseRelationship
HasImpact = y
Source.InstanceID
Destination.ClassID
Impact Direction = source.instanceID
Name = ImpactOnly
BMC_Impact
BMC_SystemComponent
BMC_HardwareSystemComponent
BMC_Keyboard BMC_PointingDevice
Layout
BMC_ApplicationSystem
BMC_ApplicationInfrastructure BMC_SoftwareServer
Type = J2EE
BMC_J2EEApplicationServer
Because the BMC_SoftwareServer subclass already contains all the attributes that
might be required to model a J2EE application server, Andy Admin decides to
deprecate the BMC_J2EEApplicationServer subclass. Andy sets the Type
attribute of the BMC_SoftwareServer subclass with a value of ‘J2EE’ to
differentiate between the software servers.
If you initiate a query from the superclass that has the subclass after deprecation,
the results returned will also include the instances that are migrated from
subclass. For example, as shown in Figure B-3, if you query the
BMC_SoftwareServer class, the results will also include the instances of
BMC_J2EEApplicationServer.
Deprecating attributes
You can deprecate the attributes of a class to rename or increase the data length of
the attribute. You cannot deprecate any System attributes of a class (for example,
ClassId and InstanceId).
IMPORTANT
You must map an attribute of a class with another attribute in the same class to
qualify the operation as an attribute deprecation. If you map an attribute of a class
with an attribute of another class, the operation is considered a class deprecation.
TIP
To edit an existing class mapping, click on the appropriate class mapping row and
click Edit.
Add Attribute
Mappings
button
Character types of
attributes must
match
5 From the Deprecate Action section, specify whether you want to delete or
deprecate the class.
Delete—Deprecates the class without a mapping. The class property is set to
Deprecated, indicating that the class and its data are to be deleted in a future
version of the data model.
Replace—Deprecates the class and uses a mapping to replace it with a different
class. Data is moved to the class that you specify in the Replacement Class
selection list, and the class is to be deleted in a future version of the data model.
When you click Replace, the Replacement Class field is enabled.
6 From the Class to Deprecate menu, select the class to deprecate from the selection
list.
7 In the Application field, type or select the application that wants to deprecate the
class or attribute.
The application is usually the owner of the class or attribute that wants to
deprecate the class or attribute (for example, BMC Atrium CMDB or BMC Remedy
Asset Management).
8 In the Version field, type or select the version number of the application in which
to deprecate or replace the class (for example, 7.6.03).
9 From the Replacement Class menu, select an appropriate replacement class to
which you want to migrate the data from the deprecated class.
The Attribute Mapping section is enabled.
10 In the Attribute Mapping section, click Map Attributes.
Complete the following steps for deprecating a class and its attributes:
a From the Attribute to Deprecate list, select the attribute that you want to
deprecate.
b From the Replacement Attribute list, select the attribute on the target class that
you want to replace it with.
c Click the Add Attribute Mapping button.
The attribute is then mapped to deprecate.
NOTE
Make sure that the datatype of the replacement attribute matches with the
datatype of the attribute to deprecate. For example, map a Character field only to
a Character field. Otherwise, an error might occur when migrating data to the
replacement class.
NOTE
Make sure that you select an attribute for which data exists in the class to
deprecate. Otherwise, data migration errors might occur.
b Select an operator.
c Select a keyword or type a value. If you type a value, enclose it in double
quotation marks.
13 Click OK.
You are prompted that you successfully created a class mapping.
14 Click OK.
The new mapping appears in the Class and Attribute Deprecation window.
If you want to update the data model on your local computer, run the utility from
the command line. If you want to update the data model on several computers, run
it with the installer.
Table B-1 lists the command-line parameters for the Deprecation utility.
Table B-1: Deprecation utility command-line parameters
Parameter Description Default values
-u User name (required) Demo
-p Password (required) ““
-s Server name (required) localhost
-t TCP port 0
-q AR RPC queue 0
-qCMDB CMDB RPC queue 0
-a Authentication string ““
-n Number of threads 2
-l Location of the log files c:\program files\BMC
(required) Software\AtriumCore\atrium
core\cmdb\sdk\bin\deputil.log
-trace Flag which turns on the debug By default, the logging is for INFO
logging. level.
If the -trace option is not used,
then it is set to off.
-L Maximum log file size 10 MB
-c Clean up the deprecated classes
and attributes
-cp The classpath environment
variable to set for Java
-Xms512m JVM memory setting for Java
-d Deprecate classes and attributes
using the mapping file
(required)
-fm Executes the data migration
again, post-deprecation, in case
of system failure
Index
A Atrium Explorer
associating queries with a technical service 116
abstract classes BMC Remedy AR System and 196
deprecating 208 configuring 184
with data replication 41 default CI editor, changing 192
without data replication 41 launching from browsers 200
Active status 60 Atrium Foundation Admin Computed group 16
adapters Atrium Foundation Admin regular group 16
about 75 Atrium Foundation Admin role 21
custom 86 Atrium Foundation Viewer Computed Group 16
registering 86 Atrium Foundation Viewer regular group 16
AIE Definitions Admin role 20 Atrium Foundation Viewer role 20
AIE User role 20 Atrium Impact Simulator
application roles BMC SIM 108
AIE Definitions Admin 20 cells in server group environments,
AIE User 20 implementing 109
Atrium Foundation Admin 21 User role 19
Atrium Foundation Viewer 20 without BMC SIM 109
Atrium Impact Simulator User 19 attribute permissions 26, 45
CMDB Console Admin 16, 19 attribute substitution 102
CMDB Console User 19 attributes
CMDB Data Change 18 adding to views 186
CMDB Data Change All 18 audit options 58
CMDB Data View 17 creating 52
CMDB Data View All 18 deleting 48
CMDB Data Viewer 19 deprecating 203, 208
CMDB Definitions Viewer 19 editing 94
CMDB RE Definitions Admin 20 namespaces 43
CMDB RE Manual Identification 20 propagating for weak relationships 53
CMDB RE User 16, 20 auditing
General Access 21 attribute options 58
NE Administrator 20 configuring for classes 58
NE User 20 overview 57
Unrestricted Access 21 author, setting 41
applications
generating forms for 188
groups 15
roles 17
assigning permissions roles 22
Index 217
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
B class permissions 45
class status 41
base classes, views 186 class types 41
best practices classes
multitenancy instance permissions 28 abstract with data replication 41
BMC Atrium Core widgets abstract without data replication 41
embedding in BMC Remedy AR System adding attributes to forms 186
forms 198 categorization 41
launching 196 CI labels 63, 64
launching from browsers 200 configuring auditing 58
BMC Remedy Action Request System. See BMC controlling layout of forms 184
Remedy AR System creating 38
BMC Remedy AR System default instance permissions 29
Atrium Explorer and 196 deleting 59
field permissions 26 deprecating 203
form permissions 26 final 41
groups 14 forms for base 186
licenses 25 generating help for 68
roles 22 icons 61
users 14 instance group thresholds 67
BMC Software, contacting 2 linking to federated instances 104, 105
BMC_DefaultAccountPermissions form 30 migrating 136
browsing data model 36 modifying 36, 38
business services namespaces 43
copying from production 114 permissions 25
properties 40
Quick-Edit attributes 66
C regular 41
cache refresh interval 191 roles 44
Calbro Services singleton 41
data model 34 status 60
federated data example 74 tooltips 65
users, creating 23 types 41
categorization classes 41 CMDB Console Admin Group computed group 16
cdm2html utility 68 CMDB Console Admin role 16, 19
cdm2html.bat file 71 CMDB Console User Group computed group 16
Change Pending status 60 CMDB Console User role 19
changing attribute permissions 26 CMDB Data Change All role 18
CI labels, defining for classes 63, 64 CMDB Data Change Group computed group 16
CI Relationship Viewer. See Atrium Explorer CMDB Data Change role 18
CIs. See configuration items CMDB Data View All role 18
class descriptions, setting 41 CMDB Data View Group computed group 16
class forms 184, 185 CMDB Data View role 17
Class Manager CMDB Data Viewer role 19
creating classes 38 CMDB Definitions Viewer Group computed
deleting classes 59 group 16
display pane 35 CMDB Definitions Viewer role 19
modifying classes 38 CMDB RE Definitions Admin role 20
navigation pane 36 CMDB RE Manual Identification role 20
Permissions tab 26 CMDB RE User Group computed group 16
viewing classes 36 CMDB RE User role 16, 20
class names, setting 41 CMDB Write Security dynamic group 16
Index 219
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 221
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
N permissions (continued)
instance 27
namespaces 41, 43 NE Administrator role 20
navigation pane 36 NE User role 20
NE Administrator role 20 roles 17
NE User role 20 row-level security 27
normalization, importing and exporting scenarios 31
configurations 153 setting 45
notifying users about events 180 Unrestricted Access role 21
view attribute 26
visible class 25
O write security 27
one-to-many form 132 Permissions tab 25, 26
one-to-one form 133 plugins
administering 75
AR 83
P CMDBf 81
JDBC 77
package files 130
polling event instances 183
package.xml file, creating 172
Product Catalog
permissions
creating data 144
AIE Definitions Admin role 20
exporting data 142
AIE User role 20
importing data 144
AR System field 26
validating data 151
AR System form 26
product support 3
assigning roles 22
properties, class 40
Atrium Foundation Admin role 21
provider organizations, creating 110
Atrium Foundation Viewer role 20
publishing events 180
Atrium Impact Simulator User role 19
attribute 25
change attribute 26
class 25
Q
classes, configuring default 30 Quick-Edit attributes, defining for classes 66
CMDB Console Admin 16, 19
CMDB Console Admin role 16, 19
CMDB Console User role 19
R
CMDB Data Change 18 RE Definition Author regular group 16
CMDB Data Change All 18 RE Manual Identification regular group 16
CMDB Data Change All role 18 RE Operator regular group 16
CMDB Data Change role 18 reconciliation and namespaces 43
CMDB Data View All 18 refresh interval, setting cache 191
CMDB Data View All role 18 regular classes 41
CMDB Data View role 17 relationships
CMDB Data Viewer role 19 deprecating 208
CMDB Definitions Viewer role 19 properties for 43
CMDB RE Definitions Admin role 20 retrieval method of federation
CMDB RE Manual Identification role 20 attributes 94
CMDB RE User 16, 20 defined 89
CMDB RE User role 16, 20 federated data classes 91, 94
default instance 29 federated relationship classes 96, 98
General Access role 21
groups 15
hidden class 25
roles status
AIE Definitions Admin 20 Active 60
AIE User 20 Change Pending 60
application 17 class 41
assigning 22 subclasses, form views 185
assigning permissions 22 superclasses, setting 41
Atrium Foundation Admin 21 support, customer 3
Atrium Foundation Viewer 20
Atrium Impact Simulator User 19
BMC Atrium CMDB permissions 17 T
CMDB Console Admin 16, 19 tabs
CMDB Console User 19 Indexes 55
CMDB Data Change 18 Permissions 25, 26
CMDB Data Change All 18 technical services
CMDB Data View 17 copying from production 114
CMDB Data View All 18 queries, editing 118
CMDB Data Viewer 19 technical support 3
CMDB Definitions Viewer 19 tooltips, defining for classes 65
CMDB RE Definitions Admin 20
CMDB RE Manual Identification 20
CMDB RE User 16, 20 U
General Access 21
Unrestricted Access role 21
in relationships 44
users
NE Administrator 20
access 14
NE User 20
creating 23
permissions 17
utilities
Unrestricted Access 21
cmdb2asset 184
row-level security 27
cmdbdriver 164
migratorcli 130
S
sandboxes V
copying services and organizations from
validating custom data 151
production 114
views 185, 186
self-join forms 188
visible class permissions 25
Service Catalog
copying services and organizations 114
creating services 113
described 112
W
dynamic service model 116 widgets. See BMC Atrium Core widgets
editing queries 116 write security 27
mapping services 115
provider organizations 110
service impact model, manually creating 119
service model
dynamic service modeling 116
service model, described 108
SHR:SchemaNames form 187
singleton classes 41
staging forms for importing data 145
Index 223
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