BMC_BaseElement data class

The root class of component classes is MC_SM_Component. The root class of Atrium CMDB component classes is BMC_BaseElement which is a subclass of MC_SM_Component.

The classes that immediately extend from BMC_BaseElement areas follows:

  • BMC_Collection
  • BMC_LogicalEntity
  • BMC_System
  • BMC_SystemComponent
  • BMC_SystemService

This topic provides the following information about the BMC_BaseElement class:

BMC_BaseElement data class definition

The following figure shows the BAROC definition of the BMC_BaseElement class, which is located in the mc_sm_object.baroc file.

When integrated with BMC Atrium CMDB, the classes in mc_sm_object.baroc are exported component and impact relationship classes from the BMC Atrium CMDB.


BMC_BaseElement definitions

MC_PUBLISH_DATA_CLASS: BMC_BaseElement ISA MC_SM_COMPONENT
   DEFINES {
      AccountID : STRING;
      Category : STRING;
      Company : STRING;
      DatasetId : STRING;
      Department : STRING;
      Description : STRING;
      Floor : STRING;
      ImpactCostUnit : STRING;
      InstanceId : STRING;
      Item : STRING;
      ManufacturerName : STRING;
      Model : STRING;
      Name : STRING;
      Notes : LIST_OF STRING, representation = diary;
      OwnerContact : STRING;
      OwnerName : STRING;
      ReadSecurity : LIST_OF STRING;
      Region : STRING;
      Room : STRING;
      SerialNumber : STRING;
      ShortDescription : STRING, default = 'n/a';
      Site : STRING;
      SiteGroup : STRING;
      Type : STRING;
      UsersAffected : INTEGER;
      VersionNumber : STRING;
      WriteSecurity : LIST_OF STRING;
   };
END

BMC_BaseElement inherits slots from MC_SM_COMPONENT class, which is defined in the following figure. MC_SM_COMPONENT class is located in the mc_sm_root.baroc file. 

MC_SM_COMPONENT definition

MC_PUBLISH_DATA_CLASS:
MC_SM_COMPONENT ISA MC_SM_DATA DEFINES
{
ComponentAliases: LIST_OF STRING;
HomeCell: STRING, read_only=yes;
Priority:MC_PRIORITY, default=PRIORITY_5;
StatusModel: STRING, default = 'STANDARD';
business_data:STRING;
change_number : INTEGER, parse=no, read_only=yes;
comment: STRING;
component_scope: MC_SM_COMPONENT_SCOPE, default = LOCAL, parse=NO, read_only = YES;
computed_status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = OK;
consolidate_function: MC_SM_CO_FUNCTION, parse =no, read_only=yes;
consumer_num: INTEGER, parse=NO, parse=no, read_only=yes;
direct_events_count: INTEGER, parse=no, read_only=yes;
impact_status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = NONE;
last_status_modification: INTEGER, parse=no, read_only=yes, representation = date;
maintenance_mode: MC_YESNO, parse = no, read_only=yes, default = NO;
manual_status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = NONE;
manual_status_comment: STRING, parse=no, read_only=yes;
manual_status_providers: LIST_OF STRING, parse=no, read_only=yes;
manual_status_providers_count: INTEGER, parse=no, read_only=yes;
manual_status_requestor: STRING, parse=no, read_only=yes;
self_status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = NONE;
shadow_cells: LIST_OF STRING, parse=NO, read_only=YES;
status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = OK;
sub_status: MC_SM_COMPONENT_STATUS, parse=no, read_only=yes, default = NONE;
# additional slot in 7.0
possible_causes: LIST_OF STRING, parse=no, read_only=yes;
root_causes: LIST_OF STRING, parse=no, read_only=yes;
sla_rollup_status: MC_SM_SLM_SLA_STATUS, parse=no, default=NO_SLAS;
impact_sla_rollup_status: MC_SM_SLM_SLA_STATUS, parse=no, default=NO_SLAS;
ScheduleId:STRING;
PriorityOut:MC_PRIORITY;
ImpactCostPerSec : REAL;
ImpactCostPerSecOut : REAL;
PriorityWatchdog:MC_YESNO, default=NO;
SelfPriorityFunction:MC_SM_PRIORITY_FUNCTION, default=BASE_PRIORITY;
SelfPriorityFunctionParam:STRING;
self_priority: MC_PRIORITY, parse=no, read_only=yes, default=PRIORITY_5;
raw_impact_priority: REAL, parse=no, read_only=yes;
impact_priority: MC_PRIORITY, parse=no, read_only=yes, default=PRIORITY_5;
computed_priority: MC_PRIORITY, parse=no, read_only=yes, default=PRIORITY_5;
cost:REAL, parse=no, read_only=yes;
impact_cost:REAL, parse=no, read_only=yes;
schedule_status:        MC_SM_SCHEDULE_STATUS, default=IN;
HomePageURI:STRING;
DeviceID:INTEGER;
any_event_max_sev:SEVERITY, default=OK, read_only=yes;
any_open_event_max_sev:SEVERITY, default=OK, read_only=yes;
impacting_open_event_max_sev:SEVERITY, default=OK, read_only=yes;
APPLICATION_event_max_sev:SEVERITY, default=OK, read_only=yes;
DATABASE_event_max_sev:SEVERITY, default=OK, read_only=yes;
NETWORK_event_max_sev:SEVERITY, default=OK, read_only=yes;
SYSTEM_event_max_sev:SEVERITY, default=OK, read_only=yes;
USER_TRANSACTIONS_event_max_sev:SEVERITY, default=OK, read_only=yes;
OTHER_event_max_sev:SEVERITY, default=OK, read_only=yes;
highest_pn_event_score:   REAL, read_only=yes;
highest_pn_predicted_severity : PREDICTED_SEVERITY, read_only=yes, default = '';
pn_predict_to_occur_time : INTEGER, representation=date, read_only=yes;

UsingOrganization:  STRING; 
UsingOrganizationId: STRING, default = '-1'; 
PNReadAcl: LIST_OF STRING, local=yes; 
PNWriteAcl: LIST_OF STRING, local=yes; 
AutoDeleteDelay: INTEGER; 
publish_providers_cis: LIST_OF STRING; 
source: STRING; 
Company: STRING; 
Site: STRING;
};
END

MC_SM_COMPONENT inherits slots from MC_SM_DATA (which contains no slot definitions, as shown in the following figure). MC_SM_DATA is located in the mc_sm_root.baroc file. 

MC_SM_DATA definition

MC_DATA_CLASS : MC_SM_DATA ISA CORE_DATA;
END

MC_SM_DATA inherits slots from CORE_DATA, which is shown in the following figure. CORE_DATA is located in the mc_root_internal.baroc file. 

CORE_DATA definition

MC_DATA_CLASS : 
   CORE_DATA
   DEFINES {
      data_handle : INTEGER, parse = no, read_only = yes;
      mc_udid : STRING, read_only = yes;
      mc_creation_time : INTEGER, parse = no, read_only = yes, representation = date;
      mc_modification_time : INTEGER, parse = no, read_only = yes, representation = date;
      mc_modification_requestor : STRING, parse = no, read_only = yes;
      publish_env_id : STRING, parse = no, read_only = yes;
   };
END

Configuration item instance slot descriptions in alphabetical order

The following table alphabetically lists the slots that define CIs with their descriptions and data type. The Source class column indicates the name of the class where the slot is defined.

Slots that define CIs

Slots

Description

Data type or enumeration

Source class

AccountId

Identification of the Account the object belongs to (Accounts are created in Infrastructure Management.)

STRING

BMC_BaseElement

any_event_max_sev

Maximum severity across all underlying events

SEVERITY

MC_SM_COMPONENT

any_open_event_max_sev

Maximum severity across all underlying events whose status = OPEN

SEVERITY

MC_SM_COMPONENT

APPLICATION_event_max_sev

Highest severity of all the attached events for which mc_event_subcategory = APPLICATION

SEVERITY

MC_SM_COMPONENT

Category

Provides a user-defined categorization of a CI

STRING

BMC_BaseElement

change_number

Increments every time an event is sent for the component. Used to determine the order of events for events which happen in the same second

INTEGER

MC_SM_COMPONENT

consumer_num

Number of CIs acting as consumers of the CI

INTEGER

MC_SM_COMPONENT

Comment

A comment that is set for the component via BMC Impact Manager

STRING

MC_SM_COMPONENT

component_scope

Scope of the component (local, shadow, and so on)

STRING

MC_SM_COMPONENT

computed_priority

The priority of a component that is the highest between self priority and impacts priority. Set in the computed_priority field.

Enumeration: MC_PRIORITY

MC_SM_COMPONENT

computed_status

Status of the CI computed from self and substatuses

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

consolidate_function

Function used to determine impact_status from the provider's propagated status

Enumeration: MC_SM_CO_FUNCTION

MC_SM_COMPONENT

Cost

The current cost for the component depending on the current value of the schedule (either During Schedule or Exceptions Within During Schedule)

REAL

MC_SM_COMPONENT

data_handle

Identifier in local cell

INTEGER

CORE_DATA

DATABASE_event_max_sev

Highest severity of any event of a particular subcategory that is attached to the CI or any other CI (inactive relationships are ignored)

SEVERITY

MC_SM_COMPONENT

DatasetId

Identification of the dataset within which the instance exists. This attribute relates to the CoreDatasetId attribute of a BMC_Dataset instance.

STRING

BMC_BaseElement

Description

A description of the CI that is meaningful to the enterprise

STRING

BMC_BaseElement

direct_events_count

Count of events coming from instrumentation

INTEGER

MC_SM_COMPONENT

HomeCell

Name of the parent cell for the CI

STRING

MC_SM_COMPONENT

highest_pn_predicted_severity

Highest value of all alarm events attached to the CI

REAL

MC_SM_COMPONENT

ImpactCostPerSec

Cost of one second of unavailability of the component

STRING

BMC_BaseElement

ImpactCostPerSec

Cost for a component when it is During Schedule

REAL

MC_SM_COMPONENT

ImpactCostPerSecOut

Cost for the component when it is in an Exceptions Within During Schedule period

REAL

MC_SM_COMPONENT

ImpactCostUnit

Unit of the cost expressed in ImpactCostPerSec

STRING

BMC_BaseElement

impact_priority

Priority determined from a component's impacts

Enumeration: MC_PRIORITY

MC_SM_COMPONENT

impact_status

Status computed by impact_function

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

impacting_open_event_max_sev

Maximum severity of impacting (causal) events whose status = OPEN

MC_SM_COMPONENT

InstanceId

Instance identification of a component within the BMC Atrium CMDB

STRING

BMC_BaseElement

Item

Provides a user-defined categorization of a CI

STRING

BMC_BaseElement

last_status_modification

Last time the status or sub_status was changed (used by GUI)

INTEGER

MC_SM_COMPONENT

maintenance_mode

Operational switch used to drop events when UM

Enumeration: MC_YESNO

MC_SM_COMPONENT

manual_status

Manual status flag of the component (NONE if not set)

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

manual_status_comment

Comment entered by user when CI is set to manual status

STRING

MC_SM_COMPONENT

manual_status_providers

List of direct and indirect providers; mc_udids of CIs with manual status set (might contain duplicate entries)

LIST_OF_STRING

MC_SM_COMPONENT

manual_status_providers_count

Number of direct and indirect providers with manual status set (might contain duplicate entries)

INTEGER

MC_SM_COMPONENT

manual_status_requestor

Login ID of user who sets the CI to manual status

STRING

MC_SM_COMPONENT

ManufacturerName

Name of the company that manufactured the CI

STRING

BMC_BaseElement

mc_creation_time

Date and time when the object was created

INTEGER

CORE_DATA

mc_modification_time

Date and time when the object was last changed

INTEGER

CORE_DATA

mc_modification_requestor

Modification requestor

STRING

CORE_DATA

mc_udid

Universal data identifier

STRING

CORE_DATA

Model

Model assigned to the CI by the manufacturing company

STRING

BMC_BaseElement

Name

User-defined name that is meaningful to the enterprise

STRING

BMC_BaseElement

NETWORK_event_max_sev

Highest severity of any event of a particular subcategory that is attached to the CI or any other CI (inactive relationships are ignored)

SEVERITY

MC_SM_COMPONENT

Notes

General notes on the object

INTEGER

BMC_BaseElement

OTHER_event_max_sev

Highest severity of all the attached events for which mc_event_subcategory = OTHER

SEVERITY

MC_SM_COMPONENT

OwnerContact

A string that provides information about how the primary system owner can be reached (for example: phone number, email address)

STRING

BMC_BaseElement

OwnerName

Name of the person in the enterprise who is responsible for the CI

STRING

BMC_BaseElement

pn_predict_to_occur_time

Lowest value among all the alarms sharing the highest pn_predicted_severity slot

INTEGER

MC_SM_COMPONENT

possible_causes

List of possible causes for the component's current status (different from root causes)

LIST_OF_STRING

MC_SM_COMPONENT

Priority

Priority

Enumeration: MC_PRIORITY

MC_SM_COMPONENT

PriorityWatchdog

Indicates whether the component is a priority propagator

Enumeration: MC_YESNO

MC_SM_COMPONENT

raw_impact_priority

The computed priority for an object (value between 0 and 1)

REAL

MC_SM_COMPONENT

ReadSecurity

List of permission groups that defines who has read access to a CI

LIST_OF_STRING

BMC_BaseElement

root_causes

List of root causes for the component's current status

LIST_OF_STRING

MC_SM_COMPONENT

ShortDescription

Short textual description (one-line string) of the object

STRING

BMC_BaseElement

schedule_status

Indicates whether the component is currently During Schedule or Exception Within During Schedule

Enumeration_ MC_SM_SCHEDULE_STATUS

MC_SM_COMPONENT

self_priority

The priority of the component based on the base priority and the component's current status

Enumeration: MC_PRIORITY

MC_SM_COMPONENT

self_status

The status of the object based on events directly attached to it (This does not take into account status from providers.)

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

sla_roleup_status

The aggregation of the compliance status of the associated SLAs, if any

Enumeration: MC_SM_SLM_SLA_STATUS

MC_SM_COMPONENT

shadow_cells

List of cells that contain the shadow of the CI

LIST_OF_STRING

MC_SM_COMPONENT

Status

Main status of the component (equals computed_status unless manual status is set)

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

StatusModel

Name of the status computation model

STRING

MC_SM_COMPONENT

sub_status

Derived status of the CI

Enumeration: MC_SM_COMPONENT_STATUS

MC_SM_COMPONENT

SYSTEM_event_max_sev

Highest severity of any event of a particular subcategory that is attached to the CI or any other CI (inactive relationships are ignored)

SEVERITY

MC_SM_COMPONENT

Type

User-defined categorization of a CI

STRING

BMC_BaseElement

USER_TRANSACTIONS_event_max_sev

Highest severity of any event of a particular subcategory that is attached to the CI or any other CI (inactive relationships are ignored)

SEVERITY

MC_SM_COMPONENT

VersionNumber

Version number of the CI, assigned by the manufacturer

LIST_OF_STRING

BMC_BaseElement

WriteSecurity

List of permission groups that defines who has write access to a CI

LIST_OF_STRING

BMC_BaseElement

Was this page helpful? Yes No Submitting... Thank you

Comments