CA Technologies Prerelease Documentation. Authorized Use Only.

PDM Macro Definitions › cmdbMetadata

cmdbMetadata

The cmdbMetadata macro provides attribute-level metadata for the versioning, TWA viewer, and CMDBf viewers for use when displaying CI and transaction information. This metadata is used for the following purposes:

• To categorize and provide help information about each attribute.
• To map each MDR provider attribute name with its corresponding CA CMDB attribute name so they are displayed together. This macro does not create a UI control and typically, use it in an HTMPL file. The HTMPL file is then included in a display form, which the versioning, TWA viewer, and CMDBf viewers use.

Note: For more information about how to use this macro, see the Administration Guide.

This macro has the following properties:

attr=attributeName

Specifies a CA CMDB attribute name. This property is required in all cases except hiding a provider attribute from the CI displays. All subsequent properties refer to the handling of this attribute. The attribute name specified must be a valid, case sensitive, CI attribute name.

category=attributeCategoryName

Specifies the category of this attribute to group-related attributes on the versioning and CMDBf viewer attribute displays. The category is typically the tab that contains the attribute on the CI detail display. Attributes are sorted by category on those forms.

common=yes|no

(Deprecated) Specifies whether this attribute is a common attribute (in the nr object). Do not use this property. Do not specify an extension for the metadata for common attributes.

currentcivalue=dottedNotation

Explicitly specifies special dotted notation for the current value of the attribute. This property is required when the default dotted notation to access the current CI value is incorrect. For example, this property is required when defining common attributes, and those attributes are not in the extension table.

Note: For dotted notation examples, see the cmdb_metadata_common.htmpl form.

dbcolumn=UAPMcolumnName

Specifies a UAPM database column name so that it can be associated with the specified CA CMDB attribute name.

extension=objectName

Specifies the extension object name that contains the attribute name. This property is required when defining attributes that are in an extension table.

heading=string

Specifies a short label that describes this attribute. Typically, you set this property the default label that the CI detail form displays.

help=string

Specifies a brief description of the attribute.

hide_provider_attr=yes|no

(For use with the CMDBf viewer only) Hides the provider attribute from the CMDBf viewer display when you specify YES. Requires the specification of provider_attr and either provider_name or provider_name_regexp.

provider_attr=MDRattributeName

(For use with the CMDBf viewer only) Specifies the MDR provider attribute name that maps to the current attribute (attr). Requires the specification of attr, and either provider_name or provider_name_regexp.

provider_name=MDRname

(For use with the CMDBf viewer only.) Specifies the MDR provider name that is associated with the MDR attribute name (provider_attr). This property specifies an exact match with a particular MDR provider name. Requires the specification of provider_attr. This property is mutually exclusive with provider_name_regexp.

provider_name_regexp=regularExpression

(For use with the CMDBf viewer only.) Specifies the MDR provider name regular expression that is associated with the MDR attribute name (provider_attr). This property specifies a regular expression pattern to match with the MDR provider names. Regular expressions use a valid JavaScript RegExp() pattern. Requires the specification of provider_attr. For example, \"MyMdr.*\" matches all provider names starting with \"MyMdr\" such as \"MyMdr1\", \"MyMdrAbcd\", and so on. The characters \".*\" indicate to match all provider names. This property is mutually exclusive with provider_name.

standardcivalue=dottedNotation

Explicitly specifies special dotted notation for the corresponding value of the attribute for the standard CI. This property is required when the default dotted notation to access the standard CI value is incorrect. For example, this property is required when defining common attributes, and those attributes are not in the extension table.