MP Content

Class

Class naming

A class element can be created in either an application, service or extension management pack, based on the requirements for that management pack. The ID and name is not affected by the type of management pack.

Class ID

The ID of the class is made up of three different parts, described below.

Class ID

The different parts are separated with dots.

Part Description
MPID This is the management pack ID. This must be included to make the class ID unique in the management group. To learn more about MPID, see Management pack naming.
Description This is a description of the class. It's hard to give any definitive guidelines on how descriptive it should be but it should be easy to understand what the class is representing. If possible, it should contain the base class.
Since the class ID cant contain any spaces they must be removed.

The most common base classes are the following:
Base ClassAdd to desciption
Computer RoleComputerRole
Local ApplicationLocalApplication
Application ComponentApplicationComponent
Network NodeNetworkNode
Computer GrouoGroup
Instance GrouoGroup

This is used alot when auhtoring with the MP Authoring Snippets. When a reference is made to the description part of the class id this is what it means.

Type The type of element/workflow. This should be Class.



Below are some examples of class IDs.

Application info MPID
MPID: MyCompany.TestMP.3.0
Class description: Application Server
Base class: Computer Role
MyCompany.TestMP.3.0.ApplicationServerComputerRole.Class
MPID: MyCompany.TestMP.3.0
Class description: Integration Service
Base class: Local Application
MyCompany.TestMP.3.0.IntgrationServiceLocalApplication.Class
MPID: MyCompany.TestMP.3.0
Class description: Temperature Sensor
Base class: Network Node
MyCompany.TestMP.3.0.TemperatureSensorNetworkNode.Class
MPID: MyCompany.TestMP.3.0
Class description: Adonis Applicance
Base class: Network Node
MyCompany.TestMP.3.0.AdonisApplicanceNetworkNode.Class


Display name

The display name should be chosen to that it's easy to understand what class it is. It's not as tightly controlled as the Class ID but should still follow the same basic principal. It's important that you understand what the class is representing without making the name to complicated. Include the base class if it makes the name clearer, but it's not mandatory.

Based on the example above the display name could be:

TestMP Application Server Computer Role  
MyCompany TestMP Integration Service Local Application
Temperature Sensor Network Node
Adonis Applicance


Version: 1.0
Created: 2016-05-22, 18:00