This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

CMDBUIComponentInfo structure

The CMDBUIComponentInfo data structure holds the UI components to retrieve.


typedef struct CMDBUIComponentInfo
   {
   ARNameType classId;
   ARLocaleType locale;
   unsigned int componentType;
   ARNameType componentId;
   char *tag1;
   char *tag2;
   char *tag3;
   char *tag4;
   char *tag5;
   char *tag6;
   char *tag7;
   char *encodedQual;
} CMDBUIComponentInfo;



The CMDBUIComponentInfo structure consists of the following elements:

classId

An integer value indicating the class ID for the UI component.

locale

The name of the locale specific to the component. If no locale is specified in this subclasses, the default locale is used.

componentType

The integer value indicating the component type.

  • 0 --The information to retrieve is a component type of None. (CMDB_COMPONENT_TYPE_NONE ).
  • 1 --The icon type component to retrieve (CMDB_COMPONENT_TYPE_ICON ).
  • 2 --The localized label type component to retrieve (CMDB_COMPONENT_TYPE_LOCALIZEDSTRING ).
  • 3 --The tooltip type component to retrieve (CMDB_COMPONENT_TYPE_TOOLTIP ).
  • 4 --The user interface graphical line information to retrieve (CMDB_COMPONENT_TYPE_LINE ).
  • 100 --The server configuration information to retrieve (CMDB_COMPONENT_TYPE_CMDB_SERVER_CONFIGURATION ).
  • 101-- The saved query information to retrieve for the APIs (CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY ). This option is for BMC use only.
  • 102 --The CI scope saved query information to retrieve for the APIs (CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_SAVED_QUERY ). This option is for internal use only. A CI scope refers to the specific attributes that are displayed when you query and drill down on a CI in the BMC Atrium Explorer.
  • 900 --The BMC Atrium Explorer view to retrieve (CMDB_COMPONENT_TYPE_EXPLORER_VIEW ). This option is for internal use only.
  • 901 --The saved query to retrieve for BMC Atrium Explorer (CMDB_COMPONENT_TYPE_SAVED_QUERY ). This option is for internal use only.
  • 902 --The BMC Atrium Explorer filter to retrieve (CMDB_COMPONENT_TYPE_EXPLORER_FILTER ). This option is for internal use only.
  • 903 --The user preference to retrieve for the BMC Atrium Explorer (CMDB_COMPONENT_TYPE_ATRIUM_USER_PREF ). This option is for internal use only.
  • 904 --The adapter used for configuring federated data to retrieve (CMDB_COMPONENT_TYPE_FEDERATION_ADAPTER ). This option is for internal use only.
  • 905 --The plug-in configuration used for federated data to retrieve (CMDB_COMPONENT_TYPE_FEDERATION_PLUGIN_CONFIG ). This option is for internal use only.
  • 906 --The quick edit attribute to retrieve (CMDB_COMPONENT_TYPE_QUICK_EDIT_ATTRIBUTES ). This attribute is displayed when you right-click an instance and select Quick Edit in the Display pane.
  • 907 --The BMC Atrium Explorer group threshold value to retrieve (CMDB_COMPONENT_TYPE_EXPLORER_GROUP_THRESHOLD ). The group threshold value controls the total number of like CIs displayed in the BMC Atrium Explorer at a given time (for example, disk drives or computer systems).
  • 908 --The class label to retrieve (CMDB_COMPONENT_TYPE_CLASS_LABEL_ATTRIBUTE ). This attribute is displayed in the BMC Atrium Explorer as the label for the class icon.
  • 909 --The class display name to retrieve (CMDB_COMPONENT_TYPE_CLASS_DISPLAY_NAME ). This is the display name for the class that is used in the BMC Atrium Explorer.

componentID

An integer value indicating the ID of the component. The composite values of componentType and componentId for a component form a unique value, based on which a unique index is created. The CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY and CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE component types use this tag to stores the name of the saved query.

For all other component types, the CMDB engine auto-populates the instance ID by default.

tag1

An information tag allows you to provide descriptions for the components. You might use more than one tag at a time to provide descriptions for a specific component type. These tags are used to filter a specific component type. Each of the component types use this tag in the following ways:

  • CMDB_COMPONENT_TYPE_ICON --Used to specify the owner of the icon.
  • CMDB_COMPONENT_TYPE_LOCALIZED_LABEL --Used to specify the owner of the localized label.
  • CMDB_COMPONENT_TYPE_TOOLTIP --Used to specify the owner of the tool tip.
  • CMDB_COMPONENT_TYPE_LINE --Used to specify the owner of the UI line.
  • CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the category name for the saved query.
  • CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the category name of the CI scope for the saved query.

tag2

Each of the component types use this tag in the following ways:

  • CMDB_COMPONENT_TYPE_ICON --Used to specify the size of the icon.
  • CMDB_COMPONENT_TYPE_LOCALIZED_LABEL --Used to specify the attribute name of the localized string. This tag is left blank if it is a label for a class.
  • CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the description for the saved query.
  • CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the description of the CI scope for the saved query.

tag3

Each of the component types use this tag in the following ways:

  • CMDB_COMPONENT_TYPE_ICON --Used to specify the image type of the icon for the component type (for example, JPG, BMP, or GIF).
  • CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the characteristics for the saved query.
  • CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_ SAVED_QUERY --Used to specify the characteristics of the CI scope for the saved query.
  • CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY --Used to specify the version number of the saved query XML file.

tag4

Used to specify the weight of the icon for the CMDB_COMPONENT_TYPE_ICON component type.

tag5

Used to describe a specific component type.

tag6

Used to store the version number of the saved query XML file for the CMDB_COMPONENT_TYPE_CMDB_SAVED_QUERY and CMDB_COMPONENT_TYPE_CMDB_CI_SCOPE_SAVED_QUERY component types. The query definitions for the saved query and CI scope saved query components are stored in an XML file for data manipulation.

tag7

Reserved for future use.

encodedQual

The encoded qualifier for the UI component query.

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

Comments