Naming rules
A naming rule is a specification of how to name instances of a particular class, such as resources, people, and systems.
- Naming Context:
Sometimes in the naming of a resource instance, there is a minimal amount of information available to uniquely name the instance based on the attributes that are available on the class. In cases such as these, certain naming rules specify a relationship in addition to a set of attributes, as required for the naming rule. These relationships place what is known as a Naming Context on the resource instance, and require a second resource to be in use to contextually identify another resource instance.
For example:
- All that is known about a particular instance of an Operating System is the type of Operating System.
- The attribute representing the type of a Operating System is not unique enough to create a unique resource instance representing the Operating System.
- In order to use this attribute, the naming rule specifies a required installedOn relationship from the instance of the Operating System to a instance of a ComputerSystem (there is a implied requirement to also create a valid instance of a Computer System in order to create the relationship).
- NOT:
Certain naming rules are in place with a defined set of attributes that are acceptable to uniquely name a resource instance in a majority of circumstances. However, there are cases in the Common Data Model where another naming rule is needed to further refine the identity of a resource, using the same set of attributes in use by another naming rule while adding additional attributes.
Because the method to create a unique instance is based on satisfying naming rules, it is not desirable to have a naming rule with less specific requirements to generate a identity when more specific attributes are provided. In order to prevent the less specific naming rule from being used, certain naming rules use an OmittedIdentifier statement on a attribute. This is also referred to asNOT
in the Common Data Model Web site section on naming rules.Note: You can find the Common Data Model Web site in the $COLLATION_HOME/sdk/doc/model directory.When this NOT operation is mentioned, the operation shows that the attribute must be null. If any content exists in the attribute mentioned in the OmmittedIdentifier (NOT) operation, the naming rule is not used to uniquely identify a resource. For example:- A naming rule exists on the class Activity called
ActivityName. - This naming rule requires the attribute
ActivityNameto contain a value.- The assumption with this particular naming rule is the name of the activity is globally unique within the customer environment.
- In the circumstances where Activity names are not unique, there
is a second naming rule, called
QualifiedActivity.- This rule requires the attribute
ActivityNameand anownsrelationship from a instance of the classOrganizationalEntityto the instance of the classActivity
- This rule requires the attribute
- Because the naming rules use a common attribute,
ActivityName, and one naming rule is a further refinement of another naming rule, only one naming rule should be used to name the instance ofActivity. - Therefore, the naming rule
ActivityNamespecified theNOToperation on theownsrelationship. This means that theownsrelationship must not be populated in order to use theActivityNamenaming rule.
- A naming rule exists on the class Activity called
- The names are longer, mainly alphabetic strings that people use to refer to the entities.
- Identifiers are shorter, dense, mainly numeric values that the management system uses to uniquely identify the entities.