Versions Compared

Version Old Version 1 New Version Current
Changes made by

Kevin Scaggs

Kevin Scaggs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


This contribution provides:

  • A place to link Ves Events into the ONAP class hierarchy.
  • A place to link ServiceOrder and ServiceOrderItems into the overall ONAP class hierarchy.
  • A basis for agreements, which are used as part of Vnf licenses and entitlements.


This area will be further developed as needed.


Table of Contents

1         Business Interaction

1.1        Diagrams

1.1.1.1         Diagrams

...


                         Image Added


                        


Figure 1‑1: Diagram Business Interaction Types

   



Image RemovedImage Added





Figure 1‑2: Diagram Business Interaction



1.

...

1        ObjectClasses

1.

...

1.1        Overview

Qualified Name: Common::Business Interaction::ObjectClasses

1.

...

1.1.

...

1         Classes

1.

...

1.1.1.1       

...

BusinessInteractionItemRelationship class

Qualified Name: Common::Business Interaction::ObjectClasses:: BusinesInteractionRelationship

 

Description:

An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement.BusinessInteractionItemRelationship

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From TMF SID

...

 

                    

...

Table 1‑1

...

Attributes for Package ObjectClasses

 

Attribute Name

  		  

Aggreg.

  		  

Navig.

  		  

Type

Mult.

  		  

Type

  		  

Description

    

Stereotypes

  

type

businessinteractionString

none

Not navig.  

0..*

BusinessInteraction

 

 

 

 

 

OpenModelAttribute

  •   partOfObjectKey:  0
  •   uniqueSet:
  •   isInvariant:  false
  •   unsigned:  false
  •   counter: NA
  •   support: MANDATORY

 

 

businessinteraction

none

Not navig.  

0..*

BusinessInteraction

 

 

 

 

 

OpenModelAttribute

  •   partOfObjectKey:  0
  •   uniqueSet:
  •   isInvariant:  false
  •   unsigned:  false
  •   counter: NA
  •   support: MANDATORY

 

 

 

1.2.1.2         Classes

...

1

The type of relationship such as contains, relies on.



OpenModelAttribute

·         partOfObjectKey: 0

·         uniqueSet:

·         isInvariant: false

·         unsigned: false

·         counter: NA

·         support: MANDATORY


Preliminary



validFor

TimePeriod

1

Time period for which the relationship is valid



OpenModelAttribute

·         partOfObjectKey: 0

·         uniqueSet:

·         isInvariant: false

·         unsigned: false

·         counter: NA

·         support: MANDATORY


Preliminary





1.1.1.1.2        Agreement class

Qualified Name: Common::Business Interaction::ObjectClasses::Agreement

...

Parent class: BusinessInteraction

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From TMF SID

Table 1‑2 Attributes for Package ObjectClasses

 

...

              

...

Attribute Name

    

Type

    

Mult.

    

Description

    

Stereotypes

  

documentNumber

String

1

A reference number assigned to an Agreement that follows a

 

prescribed numbering system.

 

 

Experimental

 



OpenModelAttribute

 

·         partOfObjectKey:

 

0

 

·         uniqueSet:

 

·         isInvariant:

 

false

 

·         unsigned:

 

false

 

·         counter: NA

   

·         support: MANDATORY

 


Preliminary



statementOfIntent

String

1

An overview and goals of the Agreement.

 

 

Experimental

 



OpenModelAttribute

 

·         partOfObjectKey:

 

0

 

·         uniqueSet:

 

·         isInvariant:

 

false

 

·         unsigned:

 

false

 

·         counter: NA

   

·         support: MANDATORY

 


Preliminary



StartDate

DateTime

1

Date interaction initiated

 

 

Experimental

 



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.

 

 

Experimental

 



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

 

 

Experimental

 



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

Unambiguously distinguishes different object instances. It is

 

the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.

 

 



OpenModelAttribute

 

·         partOfObjectKey:

 

0

 

·         uniqueSet:

 

·         isInvariant:

 

false

 

·         unsigned:

 

false

 

·         counter: NA

 

·         support: MANDATORY

 


Preliminary

 

 

 

...





1

...

.1

...

Qualified Name: Common::Business Interaction::ObjectClasses::BusinesInteractionRelationship

Description:

...

.

...

Applied Stereotypes:

  • Experimental
  • OpenModelClass

-          support: MANDATORY

  • Reference

-          reference:  From TMF SID

...

1

...

 

              

...

Attribute Name

...

Type

...

.

...

Description

...

Stereotypes

...

type

...

String

1

...

.

...

 

 

...

Experimental

 

OpenModelAttribute

  •   partOfObjectKey:  0
  •   uniqueSet:
  •   isInvariant:  false
  •   unsigned:  false
  •   counter: NA
  •   support: MANDATORY

 

 

...

validFor

...

TimePeriod

...

1

...

Time period for which the business interaction is valid.

 

 

...

Experimental

 

OpenModelAttribute

  •   partOfObjectKey:  0
  •   uniqueSet:
  •   isInvariant:  false
  •   unsigned:  false
  •   counter: NA
  •   support: MANDATORY

 

 

 

 

...

3        BusinessInteraction class

Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteraction

...

A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. There are five types Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements, and Instructions.

This class is abstract.

Parent class: RootEntity

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From TMF SID

Table 1‑

...

3 Attributes for Package ObjectClasses

 

...

              

...

Attribute Name

    

Type

    

Mult.

    

Description

    

Stereotypes

  

StartDate

DateTime

1

Date interaction initiated

 

 

Experimental

 



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.

 

 

Experimental

 



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

 

 

Experimental

 



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

Unambiguously distinguishes different object instances. It is

 

the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.

 

 



OpenModelAttribute

 

·         partOfObjectKey:

 

0

 

·         uniqueSet:

 

·         isInvariant:

 

false

 

·         unsigned:

 

false

 

·         counter: NA

 

·         support: MANDATORY

 


Preliminary

 

 

 

...





1.

...

1.1.

...

1.4        BusinessInteractionItem class

Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionItem

...

This class is abstract.

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference
  • reference: From TMF SID

Table 1‑

...

4 Attributes for Package ObjectClasses

 

...

              

...

Attribute Name

    

Type

  		  

Mult.

    

Description

    

Stereotypes

  

quantity

Integer

1

Quantity of an interaction item involved in an interaction.

 

 



Experimental

 

OpenModelAttribute

 

·         partOfObjectKey:

 

0

 

·         uniqueSet:

 

·         isInvariant:

 

false

 

·         unsigned:

 

false

 

·         counter: NA

 

·         support: MANDATORY

 

 


Preliminary



action

String

1

The action to take for an InteractionItem, such as add, change,

  remove.

 

 

Experimental

 

OpenModelAttribute

  •   partOfObjectKey:  0
  •   uniqueSet:
  •   isInvariant:  false
  •   unsigned:  false
  •   counter: NA
  •   support: MANDATORY

 

 

 

 

...

remove.



OpenModelAttribute

·         partOfObjectKey: 0

·         uniqueSet:

·         isInvariant: false

·         unsigned: false

·         counter: NA

·         support: MANDATORY


Preliminary





1.1.1.1.5        BusinessInteractionRelationship class

Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship

Description:

An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement.

Applied Stereotypes:

  • OpenModelClass
  • support: MANDATORY
  • Preliminary
  • Reference
  • reference: From TMF SID

Table 1‑5 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

type

String

1

A categorization of the relationship, such as bulk, parent/child, and so forth.



OpenModelAttribute

·         partOfObjectKey: 0

·         uniqueSet:

·         isInvariant: false

·         unsigned: false

·         counter: NA

·         support: MANDATORY


Preliminary



validFor

TimePeriod

1

Time period for which the relationship is valid



OpenModelAttribute

·         partOfObjectKey: 0

·         uniqueSet:

·         isInvariant: false

·         unsigned: false

·         counter: NA

·         support: MANDATORY


Preliminary





1.1.1.1.6        BusinessInteractionSpec class

Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionSpec

...

The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec.

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY

...

  • Preliminary
  • Reference
  • reference: From TMF SID


1.

...

1.1.

...

1.

...

7        BusinessInteractionVersion class

Qualified Name: Common::Business Interaction::ObjectClasses::BusinessInteractionVersion

...

Version of the business interaction.

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY

...

  • Preliminary
  • Reference
  • reference: From TMF SID


1.

...

1.1.

...

1.

...

8        Notification class

Qualified Name: Common::Business Interaction::ObjectClasses::Notification

...

Parent class: BusinessInteraction

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From the TMF SID

...


1

...

.1

...

.

...

Qualified Name: Common::Business Interaction::ObjectClasses::PolicyEvent

Parent class: Notification

Applied Stereotypes:

  • Example
  • OpenModelClass

-          support: MANDATORY

 

1

...

.1

...

.9        Request class

Qualified Name: Common::Business Interaction::ObjectClasses::Request

...

Parent class: BusinessInteraction

Applied Stereotypes:

  • Experimental
  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From the TMF SID

...


1.

...

1.1.

...

1.10    Response class

Qualified Name: Common::Business Interaction::ObjectClasses::Response

...

Parent class: BusinessInteraction

Applied Stereotypes:

...

  • OpenModelClass

...

  • support: MANDATORY
  • Preliminary
  • Reference

...

  • reference:

...

  • From the TMF SID