1、 ETSI GR NFV-IFA 017 V2.1.1 (2017-02) Network Functions Virtualisation (NFV) Release 2; Information Modeling; UML Modeling Guidelines Disclaimer The present document has been produced and approved by the Network Functions Virtualisation (NFV) ETSI Industry Specification Group (ISG) and represents th
2、e views of those members who participated in this ISG. It does not necessarily represent the views of the entire ETSI membership. GROUP REPORT ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 2 Reference DGR/NFV-IFA017 Keywords information model, NFV, UML ETSI 650 Route des Lucioles F-06921 Sophia Antipoli
3、s Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret N 348 623 562 00017 - NAF 742 C Association but non lucratif enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice The present document can be downloaded from: http:/www.etsi.org/standards-search The present docum
4、ent may be made available in electronic versions and/or in print. The content of any electronic and/or print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any existing or perceived difference in contents between such versions and/o
5、r in print, the only prevailing document is the print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat. Users of the present document should be aware that the document may be subject to revision or change of status. Information on the current sta
6、tus of this and other ETSI documents is available at https:/portal.etsi.org/TB/ETSIDeliverableStatus.aspx If you find errors in the present document, please send your comment to one of the following services: https:/portal.etsi.org/People/CommiteeSupportStaff.aspx Copyright Notification No part may
7、be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm except as authorized by written permission of ETSI. The content of the PDF version shall not be modified without the written authorization of ETSI. The copyright and the foregoing re
8、striction extend to reproduction in all media. European Telecommunications Standards Institute 2017. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTMand the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM and LTE are Trade Marks of ETSI registered for the benefit
9、of its Members and of the 3GPP Organizational Partners. GSM and the GSM logo are Trade Marks registered and owned by the GSM Association. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 3 Contents Intellectual Property Rights 5g3Foreword . 5g3Modal verbs terminology 5g31 Scope 6g32 References 6g32.1 Norma
10、tive references . 6g32.2 Informative references 6g33 Definitions and abbreviations . 6g33.1 Definitions 6g33.2 Abbreviations . 7g34 Overview 7g35 UML artefact descriptions 7g35.1 Classes 7g35.1.1 Description 7g35.1.2 Class notation 7g35.1.3 Class properties . 8g35.2 Attributes in classes 9g35.2.1 De
11、scription 9g35.2.2 Attribute notation 10g35.2.3 Attribute properties . 10g35.3 Associations . 12g35.3.1 Description 12g35.3.2 Association notation . 12g35.3.3 Association properties. 14g35.4 Interfaces 16g35.5 Interface operations 16g35.6 Operation parameters . 17g35.7 Notifications . 17g35.7.1 Desc
12、ription 17g35.7.2 Notification notation . 17g35.7.3 Notification properties 17g35.8 Data Types 19g35.8.1 Description 19g35.8.2 Type notation 19g35.8.3 Type properties . 19g35.8.4 UML Primitive Types . 20g35.8.5 Pre-defined Data Types 21g35.9 Qualifiers and conditions 21g35.10 Use cases 21g35.11 Acti
13、vities 21g35.12 State machines 21g36 UML profile definitions . 22g36.1 Additional Properties for individual UML artefacts . 22g36.2 Additional Properties for all UML artefacts . 25g36.2.1 LifecycleState Property . 25g36.2.2 Reference property 27g36.2.3 Example property 28g37 Recommended Modeling Pat
14、terns 28g37.1 Model Structure 28g37.2 Use of XOR/Choice/Proxy class 29g37.2.1 Xor constraint . 29g37.2.1.1 Description 29g3ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 4 7.2.1.2 Example 29g37.2.1.3 Name style. 29g37.2.2 “Choice“ 30g37.2.3 Proxy class Modeling 30g37.3 UML diagram guidelines 30g37.3.1 Re
15、commendations . 30g37.3.2 Using colors 30g37.3.3 Style sheets . 30g3Annex A: Authors Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards“, which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server (https:/ipr.etsi.org/). Pur
16、suant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present do
17、cument. Foreword This Group Report (GR) has been produced by ETSI Industry Specification Group (ISG) Network Functions Virtualisation (NFV). Modal verbs terminology In the present document “should“, “should not“, “may“, “need not“, “will“, “will not“, “can“ and “cannot“ are to be interpreted as desc
18、ribed in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of provisions). “must“ and “must not“ are NOT allowed in ETSI deliverables except when used in direct citation. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 6 1 Scope The present document defines the guidelines that have to
19、 be taken into account during the creation of a protocol-neutral UML (Unified Modeling Language) information model. These guidelines are informative for the general reader, but need to be followed when designing models for the ETSI NFV Information Model. 2 References 2.1 Normative references Normati
20、ve references are not applicable in the present document. 2.2 Informative references References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the l
21、atest version of the referenced document (including any amendments) applies. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long term validity. The following referenced documents are not necessary for the application of the prese
22、nt document but they assist the user with regard to a particular subject area. i.1 Papyrus Eclipse UML Modeling Tool. NOTE: Available at https:/www.eclipse.org/papyrus/. i.2 Unified Modeling Language (UML). NOTE: Available at http:/www.uml.org/. i.3 OMG Unified Modeling Language (OMG UML), Version 2
23、.5. NOTE: Available at http:/www.omg.org/spec/UML/2.5/. i.4 Open Networking Foundation UML Modeling Guidelines V1.2, September 2016 (ONF TR-514). i.5 ETSI GR NFV-IFA 015: “Network Functions Virtualisation (NFV) Release 2; Management and Orchestration; Report on NFV Information Model“. i.6 ETSI GS NF
24、V 003: “Network Functions Virtualisation (NFV); Terminology for Main Concepts in NFV“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ETSI GS NFV 003 i.6 apply. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 7 3.2 Abbreviations
25、 For the purposes of the present document, the abbreviations given in ETSI GS NFV 003 i.6 and the following apply: MAC Media Access Control UCC Upper Camel Case UML Unified Modeling Language 4 Overview UML defines a large number of basic model elements (UML artefacts). In order to assure consistent
26、and harmonious information models, only a selected subset of these artefacts are used in the UML model guidelines in the present document. The semantic of the selected artefacts is defined in i.2. The guidelines of each basic model artefact is divided into three parts: 1) Short description. 2) Graph
27、ical notation examples. 3) Properties. The guidelines have been developed using the Papyrus open source UML tool i.1. The ONF UML Modeling Guidelines i.4 have been used as a basis for these guidelines. The present document only uses a subset of the guidelines defined in the ONF UML Modeling Guidelin
28、es i.4. The parts not used are indicated clearly in each clause. 5 UML artefact descriptions 5.1 Classes 5.1.1 Description Classes are used to convey a structural (often called static) representation of an entity, including properties and attributes. 5.1.2 Class notation Figure 5.1.2-1: Graphical No
29、tation for classes As highlighted in figure 5.1.2-1, a class is represented with a name compartment and an attributes compartment. It is recommended that the name compartment contains also the assigned lifecycle stereotypes. The attributes compartment can be set in a diagram to not expose the attrib
30、utes or to expose some or all of the attributes. In some diagrams the attributes are hidden to reduce clutter, in others only a subset of the attributes is exposed to focus attention on those attributes. It is also possible to hide the attribute compartment of a class in the class diagrams where a l
31、arge number of classes need to be shown, as depicted in figure 5.1.2-2. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 8 Figure 5.1.2-2: Graphical Notation for Classes without Attributes Compartment It is recommended that the name compartment also show stereotypes for the class where relevant. When showi
32、ng stereotypes, the compartment may include the stereotype “OpenModelClass“ (as all classes in the model have this stereotype by default) and may also include other stereotypes. In the general UML definition a class may have name, attribute and operation compartments, as shown in figure 5.1.2-3, but
33、 since the structural part and the behavioural part of the model are decoupled, the operation compartment, is not used and always hidden. Figure 5.1.2-3: Graphical Notation for Classes with Attributes and Deprecated Operations Compartment 5.1.3 Class properties A class has the following properties:
34、Name: - Follows Upper Camel Case (UCC) convention. Each class in the model has a unique name. An example of Upper Camel Case: NetworkService. Documentation: - Contains a short definition. The documentation is carried in the “Applied comments“ field in Papyrus as shown on figure 5.1.3-1; i.e. the “Ow
35、ned comments“ field is not used. The complete documentation should be written in a single comment; i.e. at most one “Applied comment“. Figure 5.1.3-1: Entering documentation ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 9 Superclass: - Inheritance may be used to deal with shared properties. Multiple inh
36、eritance is not supported in ETSI NFV Information Model. Abstract: - Indicates if the object class can be instantiated or is just used for inheritance; i.e. abstract classes will not be instantiated. Additional properties are defined in the “OpenModelClass“ stereotype which extents by default (requi
37、red) the “metaclass“ Class as shown on figure 5.1.3-2. Figure 5.1.3-2: “OpenModelClass“ Stereotype - support: square4 This property qualifies the support of the object class at the management interface. See definition in clause 5.9. - condition: square4 This property contains the condition for the c
38、ondition-related support qualifiers. The following properties of the OpenModelClass stereotype are not used for ETSI NFV Information Model: objectCreationNotification. objectDeletionNotification. The following class stereotype is not used for ETSI NFV Information Model: Choice. The following UML def
39、ined class properties are not used: Is leaf (default = false). Is active (default = false). Visibility (default = public). 5.2 Attributes in classes 5.2.1 Description Attributes contain the properties of an object class. Note that the roles of navigable association ends become an attribute at the ot
40、her associated end when this association end is owned by the classifier; see also “Role Type“ property in clause 5.3.3. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 10 NOTE: The association end can also be owned by the association itself in which case it does not become an attribute. 5.2.2 Attribute no
41、tation The notation, shown in figure 5.2.2-1, is: |“| : = . NOTE: When no default is relevant or no default is defined, the “=“ is not shown. Figure 5.2.2-1: Graphical Notation for object class with attributes 5.2.3 Attribute properties An attribute has the following properties: Name: - Follows Lowe
42、r Camel Case (LCC) and is unique across all attribute names in the inheritance tree. An example of Lower Camel Case: virtualMemSize. - It is recommended that all Boolean typed attribute names start with is (e.g. isAbstract), or a verb such as has and the whole attribute name should be composed in a
43、way that it is possible to answer it by true or false. Documentation: - Contains a short definition. The documentation is carried in the “Applied comments“ field in Papyrus; i.e. the “Owned comments“ field is not used. The complete documentation. Type: - Refers to a datatype or a basic UML type. See
44、 clause 5.5. - If it is needed to reference another information model element (i.e. class), then an association is used (see clause 5.3). Default Value: - Provides the value that the attribute has to start with in case the value is not provided during creation, or already defined because of a system
45、 state. Multiplicity (*, 1, 1*, 01, ): - Defines the number of values the attribute can simultaneously have: square4 * is a list attribute with 0, one or multiple values; square4 1 attribute has always one value; square4 1* is a list attribute with at least one value; square4 01 attribute may have n
46、o or at most one value; square4 Default value is 1; square4 Other values are possible; e.g. “217“. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 11 Additional properties are defined in the “OpenModelAttribute“ stereotype which extents by default (required) the “metaclass“ Property, as shown on figure 5.
47、2.3-1. Figure 5.2.3-1: “OpenModelAttribute“ Stereotype - isInvariant: square4 This property identifies if the value of the attribute can be changed after it has been created. - support: square4 This property qualifies the support of the object class at the management interface. See definition in cla
48、use 5.9. - condition: square4 This property contains the condition for the condition-related support qualifiers. Other properties: - PassedByReference: square4 This property is only applied to attributes that have an object class defined as their type; i.e. association member ends owned by the class
49、 which became attributes. The stereotype is applied on a case by case basis. Figure 5.2.3-2 is showing this stereotype. square4 The property defines that the attribute contains only the reference (e.g. name, identifier, address) of the referred object instance(s) when being transferred across the interface. Otherwise the attribute contains the complete information of the object instance(s) when being transferred across the interface. ETSI ETSI GR NFV-IFA 017 V2.1.1 (2017-02) 12 Figure 5.2.3-2: “P
