Following is an update to the Policy Contribution.

1 Policy

1.1 Overview

Qualified Name: Common::Policy

Description:

Presently the scope of policy is imperitive (event, condition, action) only - not declaritive or intent.

Approach will be pragmatic in nature, establishing a model that meets the Policy team's near term needs, and then evolve from that base.

1.2 Diagrams

1.2.1 Overview

Qualified Name: Common::Policy::Diagrams

Description:

1.2.1.1 Diagrams

Figure 7‑1: Diagram Basic Policy

Figure 7‑2: Diagram Policy Event

Figure 7‑3: Diagram Policy Action

Figure 7‑4: Diagram Rooting Policy

Figure 7‑5: Diagram PolicyTypes

Figure 7‑6: Diagram Policy Datatypes & Enumerations

1.3 PolicyObjectClasses

1.3.1 Overview

Qualified Name: Common::Policy::PolicyObjectClasses

1.3.1.1 Classes

1.3.1.1.1 Policy class

Qualified Name: Common::Policy::PolicyObjectClasses::Policy

This class is abstract.

Parent class: RootEntity

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑1 Attributes for Class Policy

Attribute Name	Type	Mult.	Description	Stereotypes
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.2 PolicyAction class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyAction

Description:

This is an abstract base class that represents how to form the action clause of a PolicyRule.

Certain actions will take place if the condition clause is TRUE, others if the condition clause is FALSE.

This class is abstract.

Parent class: Policy

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑2 Attributes for Class PolicyAction

Attribute Name	Type	Mult.	Description	Stereotypes
keyValuePair	String	1	Additional metadata pertinant to the action.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
actionExecutionStrategy	PolicyExecutionStrategy	1	Defines the strategy to be used when executing the aggregated actions	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.3 PolicyActionAtomic class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionAtomic

Description:

This is the base class for all simple PolicyActions. A simple PolicyAction consists of a single Boolean clause, which is used to perform a single action. This consists of a single occurrence of a PolicyStatement, which is of the form:

{SET | CLEAR} PolicyVariable to PolicyValue

This is distinctly different from the PolicyActionVendor, which does not use a PolicyStatement.

PolicyActionAtomic objects can also be used to form more complex action structures. A PolicyActionComposite object can be used to contain a group of PolicyActionAtomic objects - this grouping enables multiple PolicyActionAtomic objects to be executed as a group. Alternatively, a PolicyActionAtomic object can contain one or more PolicyActionAtomic objects (and also PolicyActionComposite groups if desired) to provide the semantics of a compound PolicyAction. In either case, the aggregation is done using the containedPolicyActions aggregation.

Parent class: PolicyAction

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑3 Attributes for Class PolicyActionAtomic

Attribute Name	Type	Mult.	Description	Stereotypes
actionSequenceNumber	Integer	1	This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. This will allow a policy engine to reference externally supplied arguments to this object as it is executed. Notes: Not present in the ITU specs; CIM 2.7 has a subset of these values.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
subject	String	1	Tthe entity that is executing the policy.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
target	String	1	he set of entities that are affect-ed by the policy.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
hasExecutedd	HasExecuted	1	This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction. Permited Values: 0: not yet executed 1: executed with no errors 2: executed with errors but successfully rolled back 3: executed with errors and did not roll back 4: did not complete execution but successfully rolled back 5: did not complete execution and did not roll back Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
keyValuePair	String	1	Additional metadata pertinant to the action.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
actionExecutionStrategy	PolicyExecutionStrategy	1	Defines the strategy to be used when executing the aggregated actions	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.4 PolicyActionComposite class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyActionComposite

Description:

This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure.

For example if a composite is part of another composite policy structure.

Notes: default is "1"

Parent class: PolicyAction

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑4 Attributes for Class PolicyActionComposite

Attribute Name	Type	Mult.	Description	Stereotypes
actionSequence	Integer	1	This attribute is a non-negative integer and represents the particular sequence in which this element is executed as part of the overall policy structure. For example if a composite is part of another composite policy structure. Notes: default is "1"	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
hasSubPolicyActions	Boolean	1	This is a Boolean attribute that, if TRUE, signifies that this PolicyAction has one or more sub-actions. Sub-actions are used to enforce a hierarchical nesting of actions, so that parent actions may control the evaluation and other semantics of sub-actions that they contain. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
actionsCNF	Boolean	1	Specifies if the action is in confunctive normal form.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
workflowExecutionStrategy	PolicyExecutionStrategy	1	Execution Strategy that applies to the entire workflow.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
keyValuePair	String	1	Additional metadata pertinant to the action.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
actionExecutionStrategy	PolicyExecutionStrategy	1	Defines the strategy to be used when executing the aggregated actions	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.5 PolicyCondition class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyCondition

Description:

This is an abstract base class that represents how to form the condition clause of a PolicyRule. This class can be used to represent rule-specific or reusable policy conditions.

Policy conditions are of the form:

{variable, operator, value}

where the operator is usually the MATCH operator, but could be another type (e.g., compare) of operator. This gives the semantics of "IF the condition is TRUE (or FALSE)".

The subclasses of PolicyCondition, along with its recursive aggregation, enable simple and compound (e.g., nested) PolicyConditions to be supported by the same structure.

Parent class: Policy

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑5 Attributes for Class PolicyCondition

Attribute Name	Type	Mult.	Description	Stereotypes
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.6 PolicyEvent class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEvent

Description:

A PolicyEvent is an occurrence of an important event, and can be used to trigger the evaluation of a PolicyCondition or PolicyCondition clause in a PolicyRule.

Parent class: Policy

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑6 Attributes for Class PolicyEvent

Attribute Name	Type	Mult.	Description	Stereotypes
eventOrigin	String	1	eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventDomain	String	1	The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
Payload	String	1	The payload for the event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventType	String	1	Classification that captures the symantics of that particular event categorization (enodeb, vnf)	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.7 PolicyEventAtomic class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventAtomic

Parent class: PolicyEvent

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑7 Attributes for Class PolicyEventAtomic

Attribute Name	Type	Mult.	Description	Stereotypes
eventOrigin	String	1	eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventDomain	String	1	The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
Payload	String	1	The payload for the event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventType	String	1	Classification that captures the symantics of that particular event categorization (enodeb, vnf)	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future

1.3.1.1.8 PolicyEventComposite class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyEventComposite

Parent class: PolicyEvent

Applied Stereotypes:

Experimental
Future
OpenModelClass

- support: MANDATORY

Table 7‑8 Attributes for Class PolicyEventComposite

Attribute Name	Type	Mult.	Description	Stereotypes
_policyevent	PolicyEvent	0..*	Composite event has events	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventOrigin	String	1	eventOrigin provides information on the entity that generates the event (DCAE, Vnf, monitors).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventDomain	String	1	The environment or entity in which the event occurred (Eg - Vnf, switch, eNodeB, or data center).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
Payload	String	1	The payload for the event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
eventType	String	1	Classification that captures the symantics of that particular event categorization (enodeb, vnf)	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future

1.3.1.1.9 PolicyGroup class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyGroup

Description:

This class is a generalized aggregation container. It enables PolicyRules and/or PolicyGroups to be aggregated in a single container. Note that loops, including the degenerate case of a PolicyGroup that contains itself, are not allowed when PolicyGroups contain other PolicyGroups.

Parent class: Policy

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑9 Attributes for Class PolicyGroup

Attribute Name	Type	Mult.	Description	Stereotypes
isMandatoryEvaluation	Boolean	1	This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
usage	String	1	This is a free-form string attribute that recommends how this policy object should be used. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
keywords	String	1	This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: Permitted Values: Unknown InstallPermissions ConfigChange InstallMethod Default Error Usage InternalError Security ExternalError Authentication Notification Authorization Publish Accounting Subscribe Auditing Publish-Subscribe Service Exception CustomerFacingService ResourceFacingService Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
policyName	String	1	This is a generic naming attribute that can be used to identify different policy entities. This enables commonName to be used to enforce enterprise or service provider generic naming and this attribute to be used to fine tune the naming of policy entities. Thus, commonName is public in scope and policyName is private to policy. Notes: Not present in the ITU specs or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	1	This is a string, and defines a textual free-form description of the object. Notes: This attribute doesn't exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.10 PolicyRule class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRule

Description:

This is a concrete base class for realizing the "event-condition-passaction-failaction" semantics that form a policy rule. The semantics of this rule are that the rule is evaluated when an event occurs. If the condition clause is satisfied, then the pass-action clause will be executed (otherwise, the fail-action clause will be executed).

PolicyRules may be nested within PolicyRules. This is often needed in networking (e.g., bandwidth allocation).

Parent class: Policy

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑10 Attributes for Class PolicyRule

Attribute Name	Type	Mult.	Description	Stereotypes
isCNF	Boolean	1	This is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
isMandatoryEvaluation	Boolean	1	This is a Boolean attribute that, if TRUE, signifies that evaluation (and possibly action execution) of this entity is mandatory and must be attempted. If the Mandatory property value of this entity is FALSE, then the evaluation of this entity is considered to be "best effort" and may be ignored. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
usage	String	1	This is a free-form string attribute that recommends how this policy object should be used. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
keywords	String	1	This is a string attribute that defines a set of one or more keywords that a policy administrator may use to assist in characterizing or categorizing a policy object to facilitate search operations. The following keywords are pre-defined: Permitted Values: Unknown InstallPermissions ConfigChange InstallMethod Default Error Usage InternalError Security ExternalError Authentication Notification Authorization Publish Accounting Subscribe Auditing Publish-Subscribe Service Exception CustomerFacingService ResourceFacingService Notes: Not present in the ITU specs; the CIM defines a PolicyKeyword attribute, but its semantics are very different.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
Version	String	1	Version of the policy as defined by the developer.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
hasSubRuless	Boolean	1	his is a Boolean attribute that, if TRUE, defines the condition clause of this rule to be represented in Conjunctive Normal Form (e.g., an AND of ORs). If the value of this attribute is FALSE, then the condition clause will be represented in Disjunctive Normal Form (e.g., an OR of ANDs). This attribute controls the setting of how multiple condition clauses (as represented by multiple PolicyConditionComposite objects) are treated in the PolicyRule. As such, it is different from the attribute PolicyConditionComposite.IsCNF, which controls how multiple PolicyConditionAtomic objects are treated in a (single) PolicyConditionComposite object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.11 PolicyRuleTemplate (PolicyRuleSpec) class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplate (PolicyRuleSpec)

Description:

This is a concrete base class that is used to define the invariant characteristics (attributes, methods, constraints and relationships) of a PolicyRule entity.

Parent class: Descriptor (EntitySpecification)

Applied Stereotypes:

Experimental
OpenModelClass

- support: MANDATORY

Table 7‑11 Attributes for Class PolicyRuleTemplate (PolicyRuleSpec)

Attribute Name	Type	Mult.	Description	Stereotypes
executionStrategy	PolicyExecutionStrategy	1	This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: 0: Unknown 1: Do Until Success 2: Do All 3: Do Until Failure 4: Do All Without Failure or Do Nothing "Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). "Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. "Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
sequencedActions	Integer	1	This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
policyActionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyConditionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyEventSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
decisionStrategy	DecisionStrategy	1	This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. Permitted Values: 0: Unknown 1: MatchFirst 2: MatchAll MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
EventTypes	String	1..*	List of Event Types to be considered by this event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
validFor	TimePeriod	1	The period during which the descriptor is valid.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
status	String	1	The condition of the specification, such s active, inactive, or planned.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
descriptorVersion	String	1	Identifies the version of the descriptor.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.12 PolicyRuleTemplateA (Drools) class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplateA (Drools)

Parent class: PolicyRuleTemplate (PolicyRuleSpec)

Applied Stereotypes:

OpenModelClass

- support: MANDATORY

Table 7‑12 Attributes for Class PolicyRuleTemplateA (Drools)

Attribute Name	Type	Mult.	Description	Stereotypes
executionStrategy	PolicyExecutionStrategy	1	This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: 0: Unknown 1: Do Until Success 2: Do All 3: Do Until Failure 4: Do All Without Failure or Do Nothing "Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). "Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. "Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
sequencedActions	Integer	1	This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
policyActionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyConditionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyEventSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
decisionStrategy	DecisionStrategy	1	This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. Permitted Values: 0: Unknown 1: MatchFirst 2: MatchAll MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
EventTypes	String	1..*	List of Event Types to be considered by this event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
validFor	TimePeriod	1	The period during which the descriptor is valid.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
status	String	1	The condition of the specification, such s active, inactive, or planned.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
descriptorVersion	String	1	Identifies the version of the descriptor.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.13 PolicyRuleTemplateB (XACML) class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyRuleTemplateB (XACML)

Parent class: PolicyRuleTemplate (PolicyRuleSpec)

Applied Stereotypes:

OpenModelClass

- support: MANDATORY

Table 7‑13 Attributes for Class PolicyRuleTemplateB (XACML)

Attribute Name	Type	Mult.	Description	Stereotypes
executionStrategy	PolicyExecutionStrategy	1	This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include: 0: Unknown 1: Do Until Success 2: Do All 3: Do Until Failure 4: Do All Without Failure or Do Nothing "Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed). "Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails. "Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped. Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
sequencedActions	Integer	1	This is an enumerated integer defines how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. Notes: Not present in the ITU or CIM specs (the CIM defined a subset of these values as an attribute in the PolicyRule).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
policyActionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyConditions that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyConditions can be used to build PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyConditionSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
policyEventSelectCriteria	String	1	This is an attribute that contains an OCL expression to prescribe any limitations on the types of PolicyEvents that can be used with any PolicyRules that are derived from this particular PolicyRuleSpec. This enables a PolicyRuleSpec to be built that defines what types of PolicyEvents can be used to trigger the evaluation of PolicyRules. This in turn ensures that a given set of PolicyRules carry standard functionality. Notes: Not present in the ITU or CIM specs.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
decisionStrategy	DecisionStrategy	1	This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet. Permitted Values: 0: Unknown 1: MatchFirst 2: MatchAll MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated. MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
EventTypes	String	1..*	List of Event Types to be considered by this event.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY Future
validFor	TimePeriod	1	The period during which the descriptor is valid.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
status	String	1	The condition of the specification, such s active, inactive, or planned.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
descriptorVersion	String	1	Identifies the version of the descriptor.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.3.1.1.14 PolicyStatement class

Qualified Name: Common::Policy::PolicyObjectClasses::PolicyStatement

Parent class: Policy

Applied Stereotypes:

OpenModelClass

- support: MANDATORY

Table 7‑14 Attributes for Class PolicyStatement

Attribute Name	Type	Mult.	Description	Stereotypes
name	String	1	Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
description	String	0..1	Defines a textual free-form description of the object.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
id	Identifier	1	Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY
invarientId	Identifier	1	An ID for the entity that does not change regardless of version.	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY

1.4 PolicyTypeDefinitions

1.4.1 Overview

Qualified Name: Common::Policy::PolicyTypeDefinitions

1.4.1.1 Datatypes

1.4.1.2 Enumerations

1.4.1.2.1 DecisionStrategy enumeration

Qualified Name: Common::Policy::PolicyTypeDefinitions::DecisionStrategy

Description:

This is an enumerated integer that specifies the particular decision strategy to be used in this PolicySet.

Permitted Values:

0: Unknown

1: MatchFirst

2: MatchAll

MatchFirst enforces the actions of the first rule that evaluates to TRUE; policy evaluation then STOPS, meaning that all subsequent rules are no longer evaluated.

MatchAll enforces the actions of all rules that evaluate to TRUE. This is equivalent to performing two passes through the rule set. The first pass gathers all PolicyRules that evaluate to true and places them in a group. The second pass then executes only those rules that evaluated to true. Execution of these rules is controlled through the Priority property (on the aggregation PolicySetComponent), which defines the order in which the PolicyRules execute.

Contains Enumeration Literals:

0
1
2

1.4.1.2.2 HasExecuted enumeration

Qualified Name: Common::Policy::PolicyTypeDefinitions::HasExecuted

Description:

This is an enumerated integer that is set by a policy application to define the state of execution of this policyAction.

Permited Values:

0: not yet executed

1: executed with no errors

2: executed with errors but successfully rolled back

3: executed with errors and did not roll back

4: did not complete execution but successfully rolled back

5: did not complete execution and did not roll back

Notes:

Not present in the ITU or CIM specs.

Contains Enumeration Literals:

0
1
2
3

1.4.1.2.3 PolicyExecutionStrategy enumeration

Qualified Name: Common::Policy::PolicyTypeDefinitions::PolicyExecutionStrategy

Description:

This is an enumerated integer that defines the strategy to be used when executing the sequenced actions aggregated by this PolicyRule. Defined execution strategies include:

0: Unknown

1: Do Until Success

2: Do All

3: Do Until Failure

4: Do All Without Failure or Do Nothing

"Do Until Success" means that actions should be executed according to their predefined order, until successful execution of a single action. At that point, the process should stop (even if there are additional actions that could be executed).

"Do All" means that all actions should be executed that are part of the set, according to their predefined order. This should continue, even if one or more of the actions fails.

"Do Until Failure" means that all actions should be executed according to their predefined order until an action fails to execute. At that point, the entire sequence should be stopped.

Finally, "Do All Without Failure or Do Nothing" means that all actions specified should be performed. However, if a failure occurs, then NONE of the actions should be performed. This implies EITHER the ability to look-ahead and ensure that the actions will be able to be performed successfully, or the ability to perform a rollback of that action and all previous actions when an error is encountered.

Contains Enumeration Literals:

0
1
2
3
4