Element Identity and Namespace Conventions

Applies To: System Center Service Manager 2010

This topic describes the recommended identification conventions to apply to elements and sub-elements of your management pack.

Element Identity and Namespaces

All ClassType elements defined in a management pack must define unique values for their ID attribute, not only in the management pack in which they are defined but within the scope of the entire management group. This means that unexpected conflicts can occur between imported management packs if care is not taken to make sure the elements in your management pack are uniquely identified.

Although class types are the only objects in a management pack that require uniqueness, it is recommended that all objects such as rules and images use the namespace prefix that you create for your management pack. This makes it easy for customers to locate similar objects in the database and when using the command shell. At a minimum, the namespace prefix should include the vendor name and the application, device, or service name

Namespace Prefix

The recommended syntax to use as your prefix is Vendor.ProductName.Version.

For example, Microsoft SQL Server uses the following namespace prefix in its version-independent management pack:

Microsoft.SQLServer

For example, the Microsoft SQL Server 2005 management pack uses the following namespace prefix for all elements:

Microsoft.SQLServer.2005

Identity

The identity of your element includes the namespace prefix and the unique identification of the element. The entire string should be assigned as the ID attribute of that element.

The following rules govern the structure of the value of an ID attribute.

• The length is less than or equal to 256 characters.

• The ID begins with a letter (a–z) or a number (0–9).

• The ID contains only letters, numbers, the period character (.), or the underscore (_) character.

• The ID is unique across all elements within the scope of the management pack.

• The ID is case sensitive.

For example, in the Microsoft SQL Server management pack, the following class type is defined:

Microsoft.SQLServer.DBEngine

Management Pack Elements

The following management pack elements possess an ID attribute and must be unique within all elements of the management pack.

• ClassType

• RelationshipType

• TypeProjection

• ClassType

• DataType

• SchemaType

• SecureReference

• DataSourceModuleType

• ConditionDetectionModuleType

• WriteActionModuleType

• Category

• Rule

• SecureReferenceOverride

• ObjectTemplate

• ConsoleTask

• View

• Folder

• StringResource

• Form

• Resource

• ReportResource

• Assembly (Resources)

• Image

• LanguagePack

Some elements in a management pack have child or sub-elements that can also possess an ID attribute.

The ID attribute of a sub-element follows the same naming guidelines as an element. However, this ID attribute is required to be unique only within the scope of the parent element. For example, two different classes, such as Microsoft.SQLServer.2005.DBEngine and Microsoft.SQLServer.2005.Agent, can both have a Property (ClassType) element whose ID attribute value is ServiceName.