GB922-E Information Framework (SID) Model in Excel R14.0

Embed Size (px)

DESCRIPTION

Latest SID Map

Citation preview

Document TitleInformation Framework (SID)

GB922 Addendum E - Information Framework Model in Excel FileVersion 1.2

May, 2014

TM Forum 2014

Level 1 Confidential

Document NoticeNotice

Copyright TeleManagement Forum 2013. All Rights Reserved.This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to TM FORUM, except as needed for the purpose of developing any document or deliverable produced by a TM FORUM Collaboration Project Team (in which case the rules applicable to copyrights, as set forth in the TM FORUM IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by TM FORUM or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and TM FORUM DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Direct inquiries to the TM Forum office:

240 Headquarters Plaza,East Tower 10th Floor,Morristown, NJ 07960 USATel No. +1 973 944 5100Fax No. +1 973 944 5110TM Forum Web Page: www.tmforum.org

Level 1 Confidential

Document OverviewThis document stands as an Addendum to the Information Framework (SID), GB922 Release 14.0. Although not itself a core standard, it provides a report on model structure, entities and attributes (including derived attribute) and can be used as a reference to the model and as a check list for model conformance reports.

The model structure is provided in 2 forms:the SID14.0-Full includes the entire SID (excluding diagram packages and instances)The other tabs include the SID broken into domains

For the user convenience the model can be collapsed or expanded using the "+" signs on the left of the doc, by domain and L1 ABEs

The structure of the report is as follows:Column A - Domain name / ABE name - appears once per domain / ABE. All rows below this one with empty column A belong to the same ABE.Column B - Entity name - appears once per entity. All attributes with empty entity name below each entity belong to the entity above them.Column C - Attribute name, the names of the attributes per entityColumn D - Attribute origin - the entity which defines the attribute. If this field includes a different entity than current entity it means that this is a derived attribute and the entity which appears in column D is a base class of the current entity. Column E - The description of the Domain/ABE/Entity/Attribute as appears in the model

Level 1 Confidential

SID14.0-FullABE nameEntity nameAttribute nameAttribute originDocumentationSupplier_Partner DomainSupplierPartner ABEBuyerA PartyRole a Party plays, who imposed a Supplier to provide a deliverable by a formal Agreement (Commitment).partyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRolePartnerA PartyRole, played by a Party being an equitable partner in a business interaction with other parties, playing the Partner role. Usually all Partner have the same (or even compatible) business objectives.partyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRoleSupplierA PartyRole played by a Party, who commits to provide a deliverable to a Buyer by a formal Agreement (Commitment)partyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRoleSP Agreement ABESP Agreement ABE::SP Commitment ABECommitmentApproverRoleA role a party plays when approving a commitment i.e. Buyer, Supplier or PartnerinteractionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.CommitmentTermOrConditionA formal term or condition to govern a commitment.term/conditionNumberAgreementTermOrConditionUnique number assigned for reference.descriptionAgreementTermOrConditionText that explains the AgreementTermOrCondition.validForAgreementTermOrConditionThe period of time during which the AgreementTermOrCondition applies.CommitmentA detailed description of the mutual agreement between two parties, playing the role of equal Partners or one playing the role of a Supplier and the other playing the role of a Buyer. A Commitment may be associated to a KPI to govern the Commitment.agreementDocumentNumberAgreementA reference number assigned to an Agreement that follows a prescribed numbering system.agreementStatementOfIntentAgreementAn overview and goals of the Agreement.agreementPeriodAgreementThe time period during which the Agreement is in effect.IDBusinessInteractionUnique identifier for Interaction.interactionDateBusinessInteractionDate interaction initiated.descriptionBusinessInteractionNarrative that explains the interaction and details about the interaction, such as why the interaction is taking place.Narrative that explains the interaction and details about an interaction, such as why an interaction is taking place.interactionDateCompleteBusinessInteractionThe date on which an interaction is closed or completed.

interactionStatusBusinessInteractionThe current condition of an interaction, such as open, in research, closed, and so forth.CommitmentFulfilmentRoleA role a party plays in a relationship to a Commitment as a Partner or Supplier i.e. in that role the party has to fulfill the commitment.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.CommitmentProcurementRoleA role a party plays in a relationship to a Commitment as a Buyer or Supplier i.e. in that role the party has procured the commitment of another Partner or Supplier.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.SP Community ABECommunityA Community is a PartyRole, played by an Organization. CommunityMembers can commit to a Community, contribute Contributions to the Community and consume Assets from a Community.descriptionCommunityA short description of the purpose of the communitynbrOfMembersCommunityThe number of members committed to the communitytotalAssetsCommunityTotal number of assets provided to the Community.sourcedAssetsCommunityNumber of assets sourced from the CommunitypartyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRoleCommunityMemberA CommunityMember is a PartyRole, played by an Individual, who is committing to a Community, contributes to it and consumed Assets from the Community.dateJoinedCommunityMemberThe initial date of committing to the communitynbrRelatedMembersCommunityMemberNumber of associated CommunityMembersnbrContributionsCommunityMemberNumber of assets provided to the CommunitynbrConsumedAssetsCommunityMemberNumber of assets consumed from the CommunitypartyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRoleCommunityAdministratorA CommunityAdministrator is a PartyRole, played by a Party, who administers a Community.partyRoleIdPartyRoleUnique identifier for PartyRolesstatusPartyRoleUsed to track the lifecycle status, e.g. existing, prospective or former customers.validForPartyRoleThe time period that the PartyRole is valid fornamePartyRoleContributionA Contribution is a BusinessInteraction, containing items, associated to Resource, Service or Product that is contributed to a Community by a CommunityMember.IDBusinessInteractionUnique identifier for Interaction.interactionDateBusinessInteractionDate interaction initiated.descriptionBusinessInteractionNarrative that explains the interaction and details about the interaction, such as why the interaction is taking place.Narrative that explains the interaction and details about an interaction, such as why an interaction is taking place.interactionDateCompleteBusinessInteractionThe date on which an interaction is closed or completed.

interactionStatusBusinessInteractionThe current condition of an interaction, such as open, in research, closed, and so forth.ContributionProviderRoleA ContributionProviderRole is a BusinessInteractionRole a party (identified by a CommunityMember) plays when contributing to a Community.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.ContributionReceiverRoleA ContributioReceiverRole is a BusinessInteractionRole a party (identified by a Community) plays when receiving a contribution from a CommunityMember.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.AssetConsumptionAn AssetConsumption is a BusinessInteraction, containing items, associated to a Product, that is consumed from a Community as an Asset, by a CommunityMember.IDBusinessInteractionUnique identifier for Interaction.interactionDateBusinessInteractionDate interaction initiated.descriptionBusinessInteractionNarrative that explains the interaction and details about the interaction, such as why the interaction is taking place.Narrative that explains the interaction and details about an interaction, such as why an interaction is taking place.interactionDateCompleteBusinessInteractionThe date on which an interaction is closed or completed.

interactionStatusBusinessInteractionThe current condition of an interaction, such as open, in research, closed, and so forth.AssetConsumerRoleAn AssetConsumerRole is a BusinessInteractionRole a party (identified by a CommunityMember) plays when consuming assets from a Community.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.AssetProviderRoleAn AssetProviderRole is a BusinessInteractionRole a party (identified by a Community) plays when providing assets to a CommunityMember.interactionRoleBusinessInteractionRoleThe part a BusinessActor plays in an interaction, such as requester, responder, recipient, and so forth.Service DomainThe Service Domain consists of a set of layered ABEs that are used to manage the definition, development, and operational aspects of Services provided by an NGOSS system. Entities in this domain support various eTOM processes that deal with the definition, development and management of services offered by an enterprise. This includes Service Level Agreements, deployment and configuration of Services, management of problems in Service installation, deployment, usage, or performance, quality analysis, and rating. Finally, this domain also includes entities to perform planning for future offerings, service enhancement or retirement, and capacity .Service Problem ABEServiceProblemA Service Problem is an indication that a service is no longer functioning according to the agreement with its client(s).affectedServiceNumberServiceProblemNumber of affected services (mandatory, but value can be zero).problemIdProblemIdentifier of the problem. Note that this identifier is local to the server side of the interface. Only EntityIdentifier can be considered as global.originatingSytemProblemIndicates where the problem was generated.impactImportanceFactorProblemImpact Importance is characterized by an Impact Importance Factor: overall importance of the impact of all the affected services, e.g. 0 (zero impact) to 100 (worst impact). The Impact Importance is a calculated field which is set by the OSS determining the impact.priorityProblemAn indication varying from 1 to 10 of how important it is for the service provider to correct the Service Problem. The priority can be changed by the human operator while the impact importance can only be changed by the system which determines the impact.

descriptionProblemFree form text describing the Service Problem.firstAlertProblemText that indicates what first alerted the system to the problem. It is not the root cause of the Service Problem. Examples: Threshold crossing alert: Service component causing the problem Customer report: customer name (or TT id) reporting the problem

categoryProblemclassifier for the problem. Settable. Structured text/ enum.In the ATIS Service Outage document, the What Categorycorresponds to this attribute and the values can be used as possible values.responsiblePartyProblemperson or organization responsible for handling this problem. This is text or structured text and not an association to a party object. The Who category from the ATIS Service Outage document can be used for this attribute.problemEscalationProblemIndicates if this service problem has been escalated or not. Possible values are 0 to 10. A value of zero means no escalation. The meanings of values 1-10 are to be determined by the user of the interface, but they show increasing levels of escalation.

commentsProblemComments on problem, as a list of comments.timeRaisedProblemTime the problem was raisedtimeChangedProblemTime the problem was last changedreasonProblemFree text or optionally structured text. It can be Unknown. The Why category of the ATIS Service Outage document can be used to fill this value.ackStatusProblemAcknowledgement statusclearStatusProblemClear status of the problem. Clearance of the resource RC alarm or of the underlying alarms or problems does not imply clearance of the problem.

activityStatusProblemActivity status, indicates if the problem is historical or activeimpactPattternsProblemDefine the patterns of impact (optional) - e.g. other service characteristics - Used when defining impact through another pattern than the pre-defined attributes above This field is extendable.Service ABEOwnsServiceDetailsversionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceThis is an abstract base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.

Services are defined as being tightly bound to Products. A Product defines the context of the Service, Service and its related entities (e.g., ServiceSpecification, ServiceRole, and so forth) are related to entities in the Resource, Product, and other domains through a set of relationships.

A Service represents the object that will be instantiated. Each Service instance can be different; therefore, Service is limited to owning just the changeable attributes, methods, relationships, and constraints that can be instantiated. The invariant attributes, methods, relationships, and constraints that can be instantiated are defined by a ServiceSpecification.

The purpose of this entity is twofold. First, it is used to define attributes, methods, and relationships that are common to all Services. Second, it provides a convenient point to define how Services interact with other parts business entities.

Service is a first-class entity, inheriting directly from ManagedEntity. It is therefore a sibling with Resource, Product, and other first-class entities. Note that the CIM models Service as a subclass of LogicalElement, which is a subclass of ManagedSystemElement, which is a subclass of ManagedElement (which is equivalent to ManagedEntity)._partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServicePRDependencyThis is an associationClass defined in the DEN-ng Service model. It represents the semantics (e.g., exists, uses, and other relationships) that exist when a PhysicalResource is used to help supply or support a particular ResourceFacingService.

Please see the DEN-ng Service model for more details.This aggregation defines the set of PhysicalResources that are required for this particular ResourceFacingService to function correctly. This includes as a minimum the set of PhysicalResources that are required to host this particular ResourceFacingService.

The PhysicalResourcesHostRFS aggregation describes a hosting relationship, which is essentially passive in nature - the PhysicalResources exist so that the LogicalResources can be hosted on it.

The cardinality of the LogicalResourcesImplementRFS and PhysicalResourcesHostRFS aggregations are both 0..n on the aggregate side, because PhysicalResources can be installed which use LogicalResources before a ResourceFacingService is actually implemented. However, a ResourceFacingService can have one or more PhysicalResources for it to be instantiated. Hence, the aggregations has a 1..n cardinality on its component end.

versionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceLRDependencyThis is an associationClass defined in the DEN-ng Service model. It represents the semantics (e.g., exists, uses, and other relationships) that exist when a LogicalResource is used to help supply or support a particular ResourceFacingService.

Please see the DEN-ng Service model for more details.This aggregation defines the set of LogicalResources that are required for this particular ResourceFacingService to function correctly.

The LogicalResourcesImplementRFS aggregation is active in nature - it signifies an active whole-part relationship between a set of LogicalResources and a ResourceFacingService. Put another way, this latter aggregation is used to identify the LogicalResources that are used so that a ResourceFacingService can function.

The cardinality of the LogicalResourcesImplementRFS aggregation is 0..n on the aggregate side, because PhysicalResources can be installed which use LogicalResources before a ResourceFacingService is actually implemented. AResourceFacingService can have zero or more PhysicalResources and LogicalResources for it to be instantiated. Hence, the aggregations has a 1..n cardinality on its component end.

versionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceBusinessActorThis is an associationClass defined in the DEN-ng Service model. It represents the semantics (e.g., owns, uses, and other relationships) of a BusinessActor using a particular Service.

A Service is a realization of a Product in terms of operational capabilities.

Please see the DEN-ng Service model for more details.

versionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceUtilizationDetailsThis is an associationClass defined in the DEN-ng Service model. It represents the semantics (e.g., exists, uses, and other relationships) that exist when a PhysicalResource is used to help supply or support a particular Service.

versionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceRoleThis is an abstract base class that defines a Service in terms of a set of roles. The roles are then used to characterize the functionality of the Service, regardless of whether it is a resource- or a customer-facing service.

ServiceRoles represent the functionality of a Service, and as such are a mix of the invariant and changeable characteristics and behavior of a Service. Representing a Service in terms of ServiceRoles enables the functionality of the Service to be defined independently of BusinessActor, PhysicalResource, LogicalResource, or other Services.

Please see the DEN-ng Service model for more details.

roleCombinationRoleA roleCombination is an array of string attributes that are used to identify and potentially select one or more policies for a set of managed entities from among a much larger set of available policies. In contrast with the IETF definition, the DEN-ng definition of this attribute works with a second attribute, called roleSelectionMethod, that precisely defines how the selection process is determined.

Values of this attribute should be entered in comma separated value format; white space should be ignored.

roleSelectionMethodRoleThis is an enumerated integer that defines the precise means used to select one or more entities which map to one or more roles contained in the roleCombination attribute of this object. Values include:

0: retrieve all 1: retrieve intersection

For exampe, assume that there is an external query engine that is looking for the roles edge or ethernet. The result of this query will look at the roleCombination and roleSelectionMethod attributes of each managed object that it is querying.

If the value of this attribute is 0, then all managed objects that have their roleCombination set to either {edge}, {ethernet}, or {edge, ethernet} will be retrieved. In contrast, if the value of this attribute is 1, then only those managed objects whose roleCombination attribute is set to {edge, ethernet} will be retrieved.

commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServiceCharacteristicValueA ServiceCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceCharacteristic object. The values of the attributes in the ServiceCharacteristicValue object describe the values of the attributes that a corresponding ServiceCharacteristic object can take on.valueServiceCharacteristicValueA fact that describes an entity.validForServiceCharacteristicValueThe period for which the characteristic value is applicable.AdministerServiceDetailsversionEntityThis is a graphic string that identifies the version of the object. Notes: No analog in M.3100 or the CIM (version exists in some CIM subclasses, but these are relatively deep in the CIM hierarchy).commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServicePlaceDetailsinstalledTimeStampServicePlaceDetailsisLocatedAtServicePlaceDetailstoBeInstalledTimeStampServicePlaceDetailstoBeLocatedAtServicePlaceDetailsServiceInvolvementRoleA role a business entity (such as PartyRole, ResourceRole or CustomerAccount) plays in the relationship for a Resource. For example: user, owner, and so forth.involvementRoleInvolvementRoleA part a business entity plays in its involvement with a product, service or resourcevalidForInvolvementRoleThe period of time during with the business participant is involved with the product.Service ABE::CustomerFacing Service ABEThe Service ABE contains entities that are used to represent two fundamentally different types of Services, called CustomerFacingServices and ResourceFacingServices.

A CustomerFacingService defines the characteristics and behavior of a particular Service as seen by the Customer or other appropriate PartyRole. In contrast, a ResourceFacingService is an abstraction that defines the characteristics and behavior of a particular Service that is not directly seen or purchased by the PartyRole. ResourceFacingServices are #@#@internal#@#@ Services that are required to support a CustomerFacingService.

Entities in this ABE provide different views to examine, analyze, configure, monitor and repair Services of all types. Entities in this ABE are derived from Service Specification entities.

CustomerFacingServiceA CustomerFacingService defines the properties of a particular related Service that represents a realization of a Product within an organization's infrastructure; This is in direct contrast to ResourceFacingServices, which support the network/infrastructure facing part of the service. For example, a VPN is an example of a CustomerFacingService, while the sub-services that perform different types of routing between network devices making up the VPN are examples of ResourceFacingServices.

CustomerFacingServices are directly related to Products as well as to ResourceFacingServices. ResourceFacingServices are indirectly related to Products through the relationship between Product and CustomerFacingServices. This enforces the relationship to Products while keeping Services that are not directly realized by Products (i.e., ResourceFacingServices) separated from Products.cfsStatusCustomerFacingServiceThis is an enumerated integer that defines the status of this particular CustomerFacingService. Values include:

0: Operational and billable 1: Degraded but billable 2: In Violation and billable 3: Operational but not billable 4: In Test and not billable 5: Being Deployed and not billable 6: Failed

Value 0 means that this CustomerFacingService is acting per specification, and is fully billable.

Value 1 means that this CustomerFacingService is operational, but is currently in a degraded state. However, it has not violated any contractual specification and is fully billable.

Value 2 means that this CustomerFacingService is operational, but is currently in violation of its associated contractual specification(s). Whether it is billable or not is determined by its associated Policy for handling service violations.

Value 3 means that this CustomerFacingService is currently operational, but has not been enabled for this particular customer yet and is therefore not billable for this customer.

Value 4 means that this CustomerFacingService is currently being tested, and is not yet ready to be enabled for this particular customer. Consequently, it is therefore not billable for this customer.

Value 5 means that this CustomerFacingService is currently being deployed, and therefore has not been enabled for this particular customer yet. Consequently, it is therefore not billable for this customer.

Value 6 means that this CustomerFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ConnectivityThis is an abstract base class that is the parent for different types of traffic conditioning services defined in the DEN-ng Service model. TrafficConditioningServices are one example of a ResourceFacingService, in that the Customer is not able to control them. In fact, the Customer is not even aware that they are there. However, they must be implemented in order for different CoSs to be differentiated from each other, and hence for different Customers to receive different CoSs.

Please see the DEN-ng Service model for more details.

rfsStatusResourceFacingServiceThis is an enumerated integer that defines the status of this particular ResourceFacingService. Values include:

0: Operational and supporting CFS 1: Degraded but supporting CFS 2: In Violation and not supporting CFS 3: Operational but not yet supporting a CFS 4: Being Tested 5: Being Deployed 6: Failed

Value 0 means that this ResourceFacingService is acting per specification, and is also currently supporting one or more CustomerFacingServices.

Value 1 means that this ResourceFacingService is operational, but is currently in a degraded state. This degraded state indicates congestion or some other problem, but has not yet comprimised the operation of its associated CustomerFacingServices.

Value 2 means that this ResourceFacingService is operational, but is currently in violation of its associated specification(s). This in turn means that its associated CustomerFacingServices are violating their contractual specification(s) unless automatic fail-over has been enabled.

Value 3 means that this ResourceFacingService is acting per specification, but is not yet currently supporting one or more CustomerFacingServices.

Value 4 means that this ResourceFacingService is currently being tested, and is not yet ready to support a CustomerFacingService.

Value 5 means that this ResourceFacingService is currently being deployed, and is not yet ready to support a CustomerFacingService.

Value 6 means that this ResourceFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.IPsecVPNServicecfsStatusCustomerFacingServiceThis is an enumerated integer that defines the status of this particular CustomerFacingService. Values include:

0: Operational and billable 1: Degraded but billable 2: In Violation and billable 3: Operational but not billable 4: In Test and not billable 5: Being Deployed and not billable 6: Failed

Value 0 means that this CustomerFacingService is acting per specification, and is fully billable.

Value 1 means that this CustomerFacingService is operational, but is currently in a degraded state. However, it has not violated any contractual specification and is fully billable.

Value 2 means that this CustomerFacingService is operational, but is currently in violation of its associated contractual specification(s). Whether it is billable or not is determined by its associated Policy for handling service violations.

Value 3 means that this CustomerFacingService is currently operational, but has not been enabled for this particular customer yet and is therefore not billable for this customer.

Value 4 means that this CustomerFacingService is currently being tested, and is not yet ready to be enabled for this particular customer. Consequently, it is therefore not billable for this customer.

Value 5 means that this CustomerFacingService is currently being deployed, and therefore has not been enabled for this particular customer yet. Consequently, it is therefore not billable for this customer.

Value 6 means that this CustomerFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.CustomerFacingServiceCompositeThis is an abstract base class that defines an integrated set of CustomerFacingServices that collectively meets the needs of a Product. For example, the Customer may have requested #@#@GoldService#@#@, which is a ServicePackage that defines a set of ServiceBundles, each of which has its own QoS. This enables #@#@GoldService#@#@ to be abstracted and treated as a managed object that provides a CustomerFacingService.

cfsStatusCustomerFacingServiceThis is an enumerated integer that defines the status of this particular CustomerFacingService. Values include:

0: Operational and billable 1: Degraded but billable 2: In Violation and billable 3: Operational but not billable 4: In Test and not billable 5: Being Deployed and not billable 6: Failed

Value 0 means that this CustomerFacingService is acting per specification, and is fully billable.

Value 1 means that this CustomerFacingService is operational, but is currently in a degraded state. However, it has not violated any contractual specification and is fully billable.

Value 2 means that this CustomerFacingService is operational, but is currently in violation of its associated contractual specification(s). Whether it is billable or not is determined by its associated Policy for handling service violations.

Value 3 means that this CustomerFacingService is currently operational, but has not been enabled for this particular customer yet and is therefore not billable for this customer.

Value 4 means that this CustomerFacingService is currently being tested, and is not yet ready to be enabled for this particular customer. Consequently, it is therefore not billable for this customer.

Value 5 means that this CustomerFacingService is currently being deployed, and therefore has not been enabled for this particular customer yet. Consequently, it is therefore not billable for this customer.

Value 6 means that this CustomerFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.CustomerFacingServiceAtomicThis is an abstract base class that defines a stand-alone CustomerFacingService that meets the needs of a Product. Stand-alone CustomerFacingServices may be linked directly to a Product or aggregated by a CustomerFacingServiceProduct.cfsStatusCustomerFacingServiceThis is an enumerated integer that defines the status of this particular CustomerFacingService. Values include:

0: Operational and billable 1: Degraded but billable 2: In Violation and billable 3: Operational but not billable 4: In Test and not billable 5: Being Deployed and not billable 6: Failed

Value 0 means that this CustomerFacingService is acting per specification, and is fully billable.

Value 1 means that this CustomerFacingService is operational, but is currently in a degraded state. However, it has not violated any contractual specification and is fully billable.

Value 2 means that this CustomerFacingService is operational, but is currently in violation of its associated contractual specification(s). Whether it is billable or not is determined by its associated Policy for handling service violations.

Value 3 means that this CustomerFacingService is currently operational, but has not been enabled for this particular customer yet and is therefore not billable for this customer.

Value 4 means that this CustomerFacingService is currently being tested, and is not yet ready to be enabled for this particular customer. Consequently, it is therefore not billable for this customer.

Value 5 means that this CustomerFacingService is currently being deployed, and therefore has not been enabled for this particular customer yet. Consequently, it is therefore not billable for this customer.

Value 6 means that this CustomerFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ServicePackageA ServicePackage is derived from an associated ServicePackageSpec. The ServicePackageSpec defines the invariant attributes, methods, relationships, and constraints for all ServicePackage instances that are derived from it. This enables each individual ServicePackage to add its own application-specific changeable characteristics and behavior.

Note that there is no specific aggregation used to relate a particular ServicePackage to the ServicePackageSpec that it is derived from. This is because the ServicePackageSpec and ServicePackage both inherit the SpecifiesService aggregation, and at this (the business level) view, there are no new semantics that are required to represent this relationship.

Finally, while the composite pattern could be applied to ServicePackage, there is no perceived need to do so. Multiple ServicePackages will simply be aggregated by a ProductBundle, and appear as separate ProductComponents.

cfsStatusCustomerFacingServiceThis is an enumerated integer that defines the status of this particular CustomerFacingService. Values include:

0: Operational and billable 1: Degraded but billable 2: In Violation and billable 3: Operational but not billable 4: In Test and not billable 5: Being Deployed and not billable 6: Failed

Value 0 means that this CustomerFacingService is acting per specification, and is fully billable.

Value 1 means that this CustomerFacingService is operational, but is currently in a degraded state. However, it has not violated any contractual specification and is fully billable.

Value 2 means that this CustomerFacingService is operational, but is currently in violation of its associated contractual specification(s). Whether it is billable or not is determined by its associated Policy for handling service violations.

Value 3 means that this CustomerFacingService is currently operational, but has not been enabled for this particular customer yet and is therefore not billable for this customer.

Value 4 means that this CustomerFacingService is currently being tested, and is not yet ready to be enabled for this particular customer. Consequently, it is therefore not billable for this customer.

Value 5 means that this CustomerFacingService is currently being deployed, and therefore has not been enabled for this particular customer yet. Consequently, it is therefore not billable for this customer.

Value 6 means that this CustomerFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.Service ABE::CustomerFacing Service ABE::CustomerFacing Service Role ABECustomerFacingServiceRoleThis class defines a Service in terms of a set of ServiceRoles for a CustomerFacingService.

This is the base class for defining ServiceRoles that are used to represent the variable characteristics of a CustomerFacingService in terms of roles that this Service plays. This enables the CustomerFacingService to be managed abstractly using ServiceRoles. It also helps define the Service in terms of the functions that it has or provides.

Please see the DEN-ng Service model for more details.

roleCombinationRoleA roleCombination is an array of string attributes that are used to identify and potentially select one or more policies for a set of managed entities from among a much larger set of available policies. In contrast with the IETF definition, the DEN-ng definition of this attribute works with a second attribute, called roleSelectionMethod, that precisely defines how the selection process is determined.

Values of this attribute should be entered in comma separated value format; white space should be ignored.

roleSelectionMethodRoleThis is an enumerated integer that defines the precise means used to select one or more entities which map to one or more roles contained in the roleCombination attribute of this object. Values include:

0: retrieve all 1: retrieve intersection

For exampe, assume that there is an external query engine that is looking for the roles edge or ethernet. The result of this query will look at the roleCombination and roleSelectionMethod attributes of each managed object that it is querying.

If the value of this attribute is 0, then all managed objects that have their roleCombination set to either {edge}, {ethernet}, or {edge, ethernet} will be retrieved. In contrast, if the value of this attribute is 1, then only those managed objects whose roleCombination attribute is set to {edge, ethernet} will be retrieved.

commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.AccessServiceRoleThis class defines the variable characteristics of the different types of access services that will be provided for this CustomerFacingService as a set of ServiceRoles.

Please see the DEN-ng Service model for more details.

roleCombinationRoleA roleCombination is an array of string attributes that are used to identify and potentially select one or more policies for a set of managed entities from among a much larger set of available policies. In contrast with the IETF definition, the DEN-ng definition of this attribute works with a second attribute, called roleSelectionMethod, that precisely defines how the selection process is determined.

Values of this attribute should be entered in comma separated value format; white space should be ignored.

roleSelectionMethodRoleThis is an enumerated integer that defines the precise means used to select one or more entities which map to one or more roles contained in the roleCombination attribute of this object. Values include:

0: retrieve all 1: retrieve intersection

For exampe, assume that there is an external query engine that is looking for the roles edge or ethernet. The result of this query will look at the roleCombination and roleSelectionMethod attributes of each managed object that it is querying.

If the value of this attribute is 0, then all managed objects that have their roleCombination set to either {edge}, {ethernet}, or {edge, ethernet} will be retrieved. In contrast, if the value of this attribute is 1, then only those managed objects whose roleCombination attribute is set to {edge, ethernet} will be retrieved.

commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.FirewallServiceRoleThis class defines the variable characteristics of the different types of firewall services that will be provided for this CustomerFacingService as a set of ServiceRoles.

Please see the DEN-ng Service model for more details.

roleCombinationRoleA roleCombination is an array of string attributes that are used to identify and potentially select one or more policies for a set of managed entities from among a much larger set of available policies. In contrast with the IETF definition, the DEN-ng definition of this attribute works with a second attribute, called roleSelectionMethod, that precisely defines how the selection process is determined.

Values of this attribute should be entered in comma separated value format; white space should be ignored.

roleSelectionMethodRoleThis is an enumerated integer that defines the precise means used to select one or more entities which map to one or more roles contained in the roleCombination attribute of this object. Values include:

0: retrieve all 1: retrieve intersection

For exampe, assume that there is an external query engine that is looking for the roles edge or ethernet. The result of this query will look at the roleCombination and roleSelectionMethod attributes of each managed object that it is querying.

If the value of this attribute is 0, then all managed objects that have their roleCombination set to either {edge}, {ethernet}, or {edge, ethernet} will be retrieved. In contrast, if the value of this attribute is 1, then only those managed objects whose roleCombination attribute is set to {edge, ethernet} will be retrieved.

commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.Service ABE::ResourceFacing Service ABEThe Service ABE contains entities that are used to represent two fundamentally different types of Services, called CustomerFacingServices and ResourceFacingServices.

A CustomerFacingService defines the characteristics and behavior of a particular Service as seen by the Customer or other appropriate PartyRole. In contrast, a ResourceFacingService is an abstraction that defines the characteristics and behavior of a particular Service that is not directly seen or purchased by the PartyRole. ResourceFacingServices are #@#@internal#@#@ Services that are required to support a CustomerFacingService.

Entities in this ABE provide different views to examine, analyze, configure, monitor and repair Services of all types. Entities in this ABE are derived from Service Specification entities.

ResourceFacingServiceThis is an abstract base class for ResourceFacingServices. A ResourceFacingService is an abstraction that defines the characteristics and behavior of a particular Service that is not directly seen or purchased by the Customer. ResourceFacingServices are internal Services that are required to support a CustomerFacingService. The Customer obtains CustomerFacingServices via Products, and is not aware of the ResourceFacingServices which support the CustomerFacingService(s) that is being obtained directly by the Customer via a Product. For example, a VPN is an example of a CustomerFacingService. This particular type of VPN may require BGP to support it. Customers dont purchase BGP, and hopefully arent even aware that BGP is running. Therefore, BGP is an example of a ResourceFacingService.

CustomerFacingServices are directly related to Products as well as to ResourceFacingServices. ResourceFacingServices are indirectly related to Products through the relationship between Product and Resource. This enforces the relationship to Products while keeping Services that are not directly obtainable via Products (i.e., ResourceFacingServices) separated from Products.rfsStatusResourceFacingServiceThis is an enumerated integer that defines the status of this particular ResourceFacingService. Values include:

0: Operational and supporting CFS 1: Degraded but supporting CFS 2: In Violation and not supporting CFS 3: Operational but not yet supporting a CFS 4: Being Tested 5: Being Deployed 6: Failed

Value 0 means that this ResourceFacingService is acting per specification, and is also currently supporting one or more CustomerFacingServices.

Value 1 means that this ResourceFacingService is operational, but is currently in a degraded state. This degraded state indicates congestion or some other problem, but has not yet comprimised the operation of its associated CustomerFacingServices.

Value 2 means that this ResourceFacingService is operational, but is currently in violation of its associated specification(s). This in turn means that its associated CustomerFacingServices are violating their contractual specification(s) unless automatic fail-over has been enabled.

Value 3 means that this ResourceFacingService is acting per specification, but is not yet currently supporting one or more CustomerFacingServices.

Value 4 means that this ResourceFacingService is currently being tested, and is not yet ready to support a CustomerFacingService.

Value 5 means that this ResourceFacingService is currently being deployed, and is not yet ready to support a CustomerFacingService.

Value 6 means that this ResourceFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ResourceFacingServiceAtomicThis is an abstract base class that defines a stand-alone ResourceFacingService that meets the needs of a particular CustomerFacingService. Stand-alone ResourceFacingServices may be linked directly to a CustomerFacingService or aggregated by a ResourceFacingServiceComposite.rfsStatusResourceFacingServiceThis is an enumerated integer that defines the status of this particular ResourceFacingService. Values include:

0: Operational and supporting CFS 1: Degraded but supporting CFS 2: In Violation and not supporting CFS 3: Operational but not yet supporting a CFS 4: Being Tested 5: Being Deployed 6: Failed

Value 0 means that this ResourceFacingService is acting per specification, and is also currently supporting one or more CustomerFacingServices.

Value 1 means that this ResourceFacingService is operational, but is currently in a degraded state. This degraded state indicates congestion or some other problem, but has not yet comprimised the operation of its associated CustomerFacingServices.

Value 2 means that this ResourceFacingService is operational, but is currently in violation of its associated specification(s). This in turn means that its associated CustomerFacingServices are violating their contractual specification(s) unless automatic fail-over has been enabled.

Value 3 means that this ResourceFacingService is acting per specification, but is not yet currently supporting one or more CustomerFacingServices.

Value 4 means that this ResourceFacingService is currently being tested, and is not yet ready to support a CustomerFacingService.

Value 5 means that this ResourceFacingService is currently being deployed, and is not yet ready to support a CustomerFacingService.

Value 6 means that this ResourceFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.ResourceFacingServiceCompositeThis is an abstract base class that defines an integrated set of ResourceFacingServices that collectively meets the needs of a CustomerFacingService. For example, the Customer may have requested #@#@GoldService#@#@, which is a ServicePackage that defines a set of ServiceBundles, each of which has its own QoS. A set of ResourceFacingServiceProducts can then be defined, one for each different ServiceBundle instance, that provides the required QoS for each ServiceBundle instance.

Please see the DEN-ng Service Model whitepaper for more information and examples.

rfsStatusResourceFacingServiceThis is an enumerated integer that defines the status of this particular ResourceFacingService. Values include:

0: Operational and supporting CFS 1: Degraded but supporting CFS 2: In Violation and not supporting CFS 3: Operational but not yet supporting a CFS 4: Being Tested 5: Being Deployed 6: Failed

Value 0 means that this ResourceFacingService is acting per specification, and is also currently supporting one or more CustomerFacingServices.

Value 1 means that this ResourceFacingService is operational, but is currently in a degraded state. This degraded state indicates congestion or some other problem, but has not yet comprimised the operation of its associated CustomerFacingServices.

Value 2 means that this ResourceFacingService is operational, but is currently in violation of its associated specification(s). This in turn means that its associated CustomerFacingServices are violating their contractual specification(s) unless automatic fail-over has been enabled.

Value 3 means that this ResourceFacingService is acting per specification, but is not yet currently supporting one or more CustomerFacingServices.

Value 4 means that this ResourceFacingService is currently being tested, and is not yet ready to support a CustomerFacingService.

Value 5 means that this ResourceFacingService is currently being deployed, and is not yet ready to support a CustomerFacingService.

Value 6 means that this ResourceFacingService has currently failed. The set of actions that should be taken, as well as whether this service can still be billed or not, are determined by its associated Policy for handling service violations.

_partyRole2ServiceisServiceEnabledServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has been enabled for use. If the value of this attribute is FALSE, then this means that this particular Service has NOT been enabled for use.hasStartedServiceThis is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started.isMandatoryServiceThis is a Boolean attribute that, if TRUE, signifies that this Service is mandatory (i.e., this Service must be running when the managed environment is in a non-failed state). If the value of this attribute is FALSE, then this means that this Service is not required to run.startModeServiceThis attribute is an enumerated integer that indicates how the Service is started. Values include:

0: Unknown 1: Automatically by the managed environment 2: Automatically by the owning device 3: Manually by the Provider of the Service 4: Manually by a Customer of the Provider 5: Any of the above

isStatefulServiceThis is a Boolean attribute that, if TRUE, means that this Service can be changed without affecting any other services.commonNameRootEntityRepresents 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). Notes: The managedElementID attribute is defined in managedElement. This is similar to an objectID, which appears in the SID system view. It also embeds usageState, operationalState, and administrativeState in top (defined in X.721) which is inherited by managedElement. The SID and DEN-ng instead define rich state objects that are associated with a managed object. The CIM has in effect two attributes for this use: Name (but this is subclassed as a key) and ElementName.descriptionRootEntityThis is a string, and defines a textual free-form description of the object. Notes: This attribute doesnt exist in M.3100. The CIM has two attributes for this purpose, Caption (a short description) and Description.objectIDRootEntityUnambiguously distinguishes different object instances. It is the naming attribute of the object.BandwidthServiceThis class represents a generic specification for defining the characteristics of a Bandwidth Service. Such a Service could be part of a ResourceFacingService. For example, a Provider might have a 150M pipe that is being allocated to multiple customers, where each Customer gets a prescribed amount of bandwidth. This class is the base class for representing such features.

Please see the DEN-ng Service model for more details.

rfsStatusResourceFacingServiceThis is an enumerated integer that defines the status of this particular ResourceFacingService. Values include:

0: Operational and supporting CFS 1: Degraded but supporting CFS 2: In Violation and not supporting CFS 3: Operational but not yet supporting a CFS 4: Being Tested 5: Being Deployed 6: Failed

Value 0 means that this ResourceFacingService is acting per specification, and is also currently supporting one or more CustomerFacingServices.

Value 1 means that this ResourceFacingService is operational, but is currently in a degraded state. This degraded state indicates congestion or some other problem, but has not yet comprimised the operation of its associated CustomerFacingServices.

Value 2 means that this ResourceFacingService is operational, but is currently in violation of its associated specification(s). This in turn means that its associated CustomerFacingServices are violating their contractual specification(s) unless automatic fail-over has been enabled.

Value 3 means that this ResourceFacingService is acting per specification, but is not yet currently supporting one or more CustomerFacingServices.

Value 4 means that this ResourceFacingService is currently being tested, and is not yet ready to support a CustomerFacingServi