Slight updates include the following:
- Added Reference stereotype to all classes with the following note "As Built in ASDC; Not related to any release usecase."
- sight updates to a couple of definitions
- Rebuilt two diagrams - for some reason they were 'frozen", so deleted and reconstructed.
Table of Contents |
---|
1 Diagrams
...
Qualified Name: License::Diagrams
Description:
1.1.1 Diagrams
Figure
...
1: Diagram License
Figure
...
2: Diagram Rooting License
...
Figure
...
3: Diagram
...
Feature Groups
Figure
...
4: Diagram
...
License Datatypes
Figure
...
5: Diagram
...
License Keys
Figure
...
6: Diagram
...
Entitlements
2 ObjectClasses
2.1 Overview
...
Represents an instance of a EntitlementDesc.Entitlement
Specifies the use rights for the software as described by the license.
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑1 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
softwareAssetTag | String | 1 | A Service Provider internally generated asset tag (id). | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
ssmUserId | String | 1 | The requestor of the entitlement. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
assignmentStatus | String | 1 | The assignment status of the entitlement (assigned, available, ...). | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
assignmentDate | DateTime | 1 | The date the entitlement was assigned. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
name | String | 0..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 · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 0..1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
2.1.1.2 EntitlementPool class
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑2 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
_spPoolLimit | PoolLimit | 0..* | Pool limits applied by the service provider | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_vendorPoolLimit | PoolLimit | 0..* | Pool limits applied by the vendor. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
entitlementManufactureReferenceNumber | String | 0..1 | Identifier for the entitlement as described by the vendor in their price list / catalog /contract. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
entitlementPurchaseIncrements | Integer | 0..1 | This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
entitlementPoolThresholdValue | Integer | 0..1 | A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
entitlementPoolThresholdUnits | ThresholdUnitType | 0..1 | Specifies the Units for the ThresholdValue. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
invariantId | Identifier | 1 | Identifier that stays the same irrespective of version. Identifier that stays the same irrespective of version. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
Version | String | 1 | The version of this entity. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
poolType | LicenseGroupType | 1 | The license key may be 'universal' or 'unique' or 'one-time'. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
validFor | TimePeriod | 1 | The period during which the design entity is valid. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
status | String | 1 | The condition of the specification, such s active, inactive, or planned. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
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 · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
2.1.1.3 FeatureGroup class
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑3 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
featureGroupName | String | 1 | Name of the feature group | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
featureGroupDescription | String | 0..1 | Description of the feature group. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: |
false · counter: NA · support: MANDATORY | ||||
featureGroupPartNumber | String | 1 | The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
2.1.1.4 LicenceKeyPool class
...
The license key group model provides a description to systems like ALTS such as Asset Inventory for the license keys that are provided by a vendor. ALTS The Asset Inventory system will create a "group" and Purchasing systems (GPS and HP Asset Center) " and purchasing systems will send the inventory of license keys/files to be held by ALTS Asset Inventory in the appropriate group.
Controllers will request license keys from ALTS Asset Inventory using the UUID of the group, as directed by the ASDC models for the software (i.e. VFs).
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑4 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
_spPooLlimit | PoolLimit | 0..* | Pool limits applied by the service provider | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
_vendorPoollimit | PoolLimit | 0..* | Pool limits applied by the vendor. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
poolType | LicenseGroupType | 1 | The license key may be 'universal' or 'unique' or 'one-time'. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
thresholdUnits | ThresholdUnitType | 0..1 | Units can be either absolute or a percentage (%). | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
thresholdValue | Integer | 0..1 | Specified threshold value for the license key pool. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
keyPurchaseIncrements | String | 0..1 | Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
manufactureReferenceNumber | String | 0..1 | Identifier for the entitlement as described by the vendor in their price list / catalog /contract. Identifier for the entitlement as described by the vendor in their price list / catalog /contract. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
invariantId | Identifier | 1 | Identifier that stays the same irrespective of version. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
Version | String | 1 | The version of this entity. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
licenseManufactureReferenceNumber | String | 1 | Identifier for the entitlement as described by the vendor in their price list / catalog /contract. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
validFor | TimePeriod | 1 | The period during which the design entity is valid. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
status | String | 1 | The condition of the specification, such s active, inactive, or planned. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
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 · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
2.1.1.5 LicenseAgreement class
...
An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family.
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑5 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
requirementsAndConstraints | String | 1..* | Free form text. Includes information such as operating system or hypervisor required for the software. This may also contain factors to be considered in deployment/placement of the software instances. These requirements and constraints may need to be abstracted as policies or other business rules. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
licenseTerm | LicenseTerm | 1 | Term of the license: | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
documentNumber | String | 1 | A reference number assigned to an Agreement that follows a prescribed numbering system. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
statementOfIntent | String | 1 | An overview and goals of the Agreement. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
StartDate | DateTime | 1 | Date interaction initiated | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
endDate | DateTime | 1 | The date on which an interaction is closed or completed. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
Status | String | 0..1 | The current condition of an interaction, such as open, in research, closed, and so forth | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
name | String | 0..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 · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 0..1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
2.1.1.6 LicenseKeyInstance class
Qualified Name: License::ObjectClasses::LicenseKeyInstance
Description:
Represents an instance of a license key
Parent class: OperationalEntity
...
- Experimental
- OpenModelClasssupport: MANDATORY
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑6 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
softwareAssetTag | String | 1 | A Service Provider internally generated asset tag (id). | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
licenseKey | String | 1 | Vendor provided license key value that is entered into the vendor software to activiate / unlock it. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
smmUserId | String | 1 | The requestor of the license key. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
assignmentStatus | String | 1 | The assignment status of the license (assigned, available, ...). | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
assignmentDate | DateTime | 1 | The date the license key was assigned. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
licensekey | File | 0..1 | Vendor provided license key file that is entered into the vendor software to activiate / unlock it. | Future OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
name | String | 0..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 · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
description | String | 0..1 | Defines a textual free-form description of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object. | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY Preliminary |
2.1.1.7 PoolLimit class
...
- Experimental
- OpenModelClass
- support: MANDATORY
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Table 4‑7 Attributes for Package ObjectClasses
Attribute Name | Type | Mult. | Description | Stereotypes |
limitMetricType | EPMetricType | 1 | Specifies if this pool holds entitlements based on usage of the software (number of users), number of sessions, country, line of business, etc. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
limitMetricValue | Integer | 1 | The value of some limit being applied. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
aggregationFunction | AggregationTypes | 0..1 | Type of aggregation being performed (Peak or Average) | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
limitUnits | LimitUnits | 1 | The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...) | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
time | DateTime | 0..1 | Units time is specified in (day, month, hour, minute, second, millisecond. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
poolMetricTypeOther | String | 0..1 | LimitMetricType if Other enumeration is selected. | Experimental OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
3 SequenceFlows
3.1 Overview
Qualified Name: License::SequenceFlows
3.1.1 Classes
3.1.1
...
3.1.1.1 License Setup class
Qualified Name: License::SequenceFlows::License Setup
Description:
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
.1 License Setup class
Qualified Name: License::SequenceFlows::License Setup
Description:
Applied Stereotypes:
- OpenModelClass
- support: MANDATORY
Table 5‑1 Attributes for Package SequenceFlows
Attribute Name | Type | Mult. | Description | Stereotypes |
License Setup | 1 | OpenModelAttribute · partOfObjectKey: 0 · uniqueSet: · isInvariant: false · unsigned: false · counter: NA · support: MANDATORY |
3.1.1.2 SimpleOrderFlow class
...
- OpenModelClass
- support: MANDATORY
...
4 TypeDefinitions
...
4.1.2.1 AggregationTypes enumeration
Qualified Name: License::TypeDefinitions::AggregationTypes:TypeDefinitions::AggregationTypes
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
Qualified Name: License::TypeDefinitions::EPMetricType
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
Units of the entitlement/license term. Valid values: year, quarter, month, day.
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
4.1.2.4 LicenseGroupType enumeration
Qualified Name: License::TypeDefinitions::LicenseGroupTypeTypeDefinitions::LicenseGroupType
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
Not applicable when license type is Perpetual.
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
Qualified Name: License::TypeDefinitions::LimitUnits
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
...
Qualified Name: License::TypeDefinitions::ThresholdUnitType
Applied Stereotypes:
- Experimental
- Reference
- reference: As Built in ASDC; Not related to any release usecase.
Contains Enumeration Literals:
- ABSOLUTE
- %