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.

CMDBSetClass function

The CMDBSetClass function sets the class properties in the OBJSTR:Class form. After you create a class, you cannot change the following properties: namespace, classId, classType (CI or relationship), and persistence provider.

Synopsis


#include "ar.h"
#include "arextern.h"
#include "cmdb.h"

int CMDBSetClass(
      ARControlStruct *control,
      CMDBClassNameId *classNameId,
      CMDBClassNameId *newclassNameId,
      CMDBClassTypeInfo *classTypeInfo,
      CMDBIndexList *indexList,
      CMDBAuditInfoStruct *auditInfo,
      ARPropList *characList,
      ARPropList *customCharacList,
      ARStatusList *status)

Input arguments

Input argument

Description

control

The control record for the operation, which contains information about the user requesting the operation and the server on which the operation is to be performed.

classNameId

The class to set. The classNameID argument contains the namespace name and the unique class name.

newclassNameId

The new name of the class. The newclassNameID argument contains the namespace name and the unique class name.

classTypeInfo

Information about the type of class.

indexList

The list of indexes defined for the class. When this parameter is specified, all previously existing indexes are replaced by its contents. To add indexes without losing existing indexes, include the existing indexes in this list.

auditInfo

The audit information for the class: audit type, qualification, and Audit Only Changed Fields (auditMask ). Use the following auditMask values:

  • CMDB_CLASS_AUDITCHANGE_DEFAULT = 0 --Use the value of the Disable Audit Only Change Fields system setting on the BMC Remedy AR System server. The system setting default is that only changing the attribute to a different value triggers auditing.
  • CMDB_CLASS_AUDITCHANGE_YES = 1 --Audit when an updated field value is different than the existing value.
  • CMDB_CLASS_AUDITCHANGE_NO = 2 --Audit when a field value is modified, even if the updated value is the same as the existing value.

characList

  • A list of characteristics for this class. Specify NULL for this parameter if you do not want to associate characteristics with this class. Characteristics not listed are for BMC Software internal use.
  • 1: Singleton--Used to specify if this is a singleton class. This characteristic is an integer value where type CMDB_CLASS_CHARAC_SINGLETON_FALSE indicates that this is not a singleton class. Type CMDB_CLASS_CHARAC_SINGLETON_TRUE indicates that this is a singleton class (CMDB_CLASS_CHARAC_SINGLETON ).
  • 2: Abstract--This property does not allow you to create instances for this abstract class (CMDB_CLASS_CHARAC_ABSTRACT ). After the property has been set for the attribute, you cannot create instances for it. All the attributes are propagated to the subclasses.
  • 3: Final--You cannot create subclasses from this class (CMDB_CLASS_CHARAC_FINAL ).
  • 4: Author--The author of the class (CMDB_CLASS_CHARAC_AUTHOR ).
  • 5: Description--The class description (CMDB_CLASS_CHARAC_DESCRIPTION ).
  • 6: Hidden permissions--Gives you the permissions to modify the class (CMDB_CLASS_CHARAC_CLASS_HIDDEN_PERMS ). Marks the class as hidden for the users in the group. When querying for classes, you can choose to retrieve hidden classes.
  • 7: Visible permissions--Gives you the permissions to modify the class (CMDB_CLASS_CHARAC_CLASS_VISIBLE_PERMS ). Marks the class as visible for the users in the group. When querying for classes, you will see all classes including the hidden classes.
  • 8: Categorizationq--(CMDB_CLASS_CHARAC_CATEGORIZATION_SUBCLASS ).
  • 9: Form name--(CMDB_CLASS_CHARAC_FORM_NAME ).
  • 10: Exposure--The visibility of the class, which can be CMDB_CLASS_EXPOSURE_NONE, CMDB_CLASS_EXPOSURE_USED_VISIBLE, or CMDB_CLASS_EXPOSURE_USED_HIDDEN.
  • 12: Federation schema type--Allows you to specify the schema type for federation (CMDB_CLASS_CHARAC_FEDERATION_SCHEMA_TYPE ). This characteristic is an integer data type, where:
    • 0 --CMDB_FEDERATION_SCHEMA_REGULAR --Indicates that the schema is not of type federation. 0 is the default value for this characteristic.
    • 1 --CMDB_FEDERATION_SCHEMA_VENDOR --Indicates that the schema type is an BMC Remedy AR System Vendor form.
  • 13: Federation vendor name--Allows you to specify the name of the vendor form or ARDBC plug-in name (CMDB_CLASS_CHARAC_FEDERATION_VENDOR_NAME ). Specify this characteristic only if you set the CHARAC_FEDERATION_SCHEMA_TYPE characteristic to 1.
  • 14: Federation vendor table name--Allows you to specify the name of the data store from which the federated data class will retrieve the data (CMDB_CLASS_CHARAC_FEDERATION_VENDOR_TABLE_NAME ). Specify this characteristic only if you set the CHARAC_FEDERATION_SCHEMA_TYPE characteristic to 1.
  • 15: Relation type--Allows you to specify the type of relationship for the federated class (CMDB_CLASS_CHARAC_RELATION_TYPE ). This characteristic, which only applies to relationship classes, is an integer data type, where:
    • 0 --CMDB_RELATION_REGULAR --Indicates a regular relationship that relates two CI endpoints.
    • 1 --CMDB_RELATION_QUERY --Indicates that the relation type is a query used for join conditions. 0 is the default value for this characteristic.
  • 16: BMC Remedy AR System qualification--Allows you to specify the BMC Remedy AR System qualification, which defines how the source class links to the destination class in federated relationship classes (CMDB_CLASS_CHARAC_RELATION_LINK_QUALIFIER ).
  • 17: Number of temp tables; allows you to define the maximum number of temporary tables to create for vendor forms (CMDB_CLASS_CHARAC_NUM_TEMP_TABLES ). Do not specify a value for the characteristic if you are working with regular (non-vendor) forms.
  • 18: Requires qualifier for the query--Allows you to specify whether a qualification is required for the federated class in the CMDBQueryByPath function (CMDB_CLASS_CHARAC_REQUIRES_QUALIFIER_FOR_QUERY ). This characteristic is an integer data type, where:
    • 0 --CMDB_QUAL_RESTRICITVE --Indicates that no qualification is required for the query.
    • 1 --CMDB_QUAL_NON_RESTRICITVE --Indicates that a qualification is required for the federated class. 1 is the default value for this characteristic. For performance reasons, BMC recommends that you do not set this value if you have a lot of data in the external data store and you have not specified any qualifications against the federated data class that maps to it.

customCharacList

A list of user-defined custom characteristics for the class. The value can be set to any user-defined characteristic but must be between 100000 (CMDB_CLASS_CUSTOM_CHARAC_MIN ) and 199999 (CMDB_CLASS_CUSTOM_CHARAC_MAX ). If you do not want to associate custom characteristics with this class, specify NULL for this parameter. To delete a custom characteristic, set its data type to NULL.

Return value

Return value

Description

status

A list of zero or more notes, warnings, or errors generated from a call of this function.

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

Comments