1、 ETSI GR NFV-IFA 016 V2.1.1 (2017-03) Network Functions Virtualisation (NFV) Release 2; Information Modeling; Papyrus Guidelines Disclaimer The present document has been produced and approved by the Network Functions Virtualisation (NFV) ETSI Industry Specification Group (ISG) and represents the vie
2、ws 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 016 V2.1.1 (2017-03) 2 Reference DGR/NFV-IFA016 Keywords information model, model, NFV ETSI 650 Route des Lucioles F-06921 Sophia Antipolis C
3、edex - 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 document
4、 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/or i
5、n 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 status
6、 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 be
7、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 restr
8、iction 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 of
9、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 016 V2.1.1 (2017-03) 3 Contents Intellectual Property Rights 4g3Foreword . 4g3Modal verbs terminology 4g31 Scope 5g32 References 5g32.1 Normativ
10、e references . 5g32.2 Informative references 5g33 Abbreviations . 6g34 Overview 6g35 Getting Papyrus running . 6g35.1 Introduction 6g35.2 Downloading Eclipse 6g35.3 Papyrus overview . 13g35.4 Installing Gendoc plugin installation 14g35.5 Importing a model 15g35.6 Deleting a Project . 19g36 Using Pap
11、yrus 20g36.1 Illustrative Profile and Model . 20g36.2 Papyrus file structure 22g36.3 Submitting a modified model . 22g36.4 Generating model documentation . 24g36.5 Using Class Diagrams 25g36.6 Applying a stereotype to an element 26g36.7 Changing the value of a stereotype attribute 27g3Annex A: Autho
12、rs 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/). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been c
13、arried 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 document. Trademarks When trademarks are mentioned in the present document, please n
14、ote that these trademarks are owned by their respective owners and that they are only mentioned on a citation way, without claiming any right on them. The present document does not give any right to use or reproduce these trademarks which remain the property of their respective owners. Foreword This
15、 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 described in clause 3.2 o
16、f 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 016 V2.1.1 (2017-03) 5 1 Scope The present document defines the guidelines that are recommended to be taken
17、into account during the creation of a protocol-neutral UMLi.2 information model using the Open Source tool Papyrus i.1. 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 Nor
18、mative 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, t
19、he latest 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 p
20、resent document but they assist the user with regard to a particular subject area. i.1 Papyrus Eclipse UMLModeling Tool. NOTE: Available at https:/www.eclipse.org/papyrus/. i.2 Eclipse Modeling Tools. NOTE: Available at https:/www.eclipse.org/downloads/packages/eclipse-modeling-tools/marsr. i.3 OMG
21、Unified Modeling Language (UML) specifications 2.5.0. NOTE: Available at http:/www.omg.org/spec/UML/. i.4 ONF TR-515: “Open Networking Foundation Papyrus Guidelines 1.2“ September 2016. i.5 ETSI GR NFV-IFA 017: “Network Functions Virtualisation (NFV); Information Modeling; UML Modeling Guidelines“.
22、i.6 Eclipse Gendoc website. NOTE: Available at http:/www.eclipse.org/gendoc/. i.7 ETSI GR NFV-IFA 015: “Network Function Virtualization (NFV); Management and Orchestration; Report on NFV Information Model“. i.8 ETSI GR NFV-IFA 024: “Network Function Virtualisation (NFV); Information Modeling; Report
23、 on External Touchpoints related to NFV Information Model“. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 6 3 Abbreviations For the purposes of the present document, the following abbreviations apply: IDE Integrated development environment JVM Java Virtual Machine MS MicrosoftONF Open Networking Foundat
24、ion UMLUnified Model Language 4 Overview The present document provides information for putting in operation and for using the Open Source tool Papyrus i.1 and the Gendoc plugin i.6. The Papyrus tool is used to edit the NFV Information Model and Gendoc i.6 is an Eclipse plug-in integrated with Papyru
25、s that allows generating MS Word documentation of a model from a template. The UML Modeling Guidelines are defined in ETSI GR NFV-IFA 017 i.5. The ONF Papyrus Guidelines (see ONF TR-515 i.4) have been used as a basis for these guidelines. 5 Getting Papyrus running 5.1 Introduction The Open Source UM
26、Ltool Papyrus (see i.1 is a plug-in for the Open Source integrated development environment (IDE) Eclipse. Current tool versions: Eclipse version 4.5.x “Mars“ (V4.5.1) Papyrus version 1.1.x (V1.1.3) Gendoc version 0.5.x (V0.5.1) NOTE 1: Eclipse Neon is not supported yet. NOTE 2: Papyrus Mars release
27、(V1.1.3) requires a 1.7 compatible JVM. This clause explains how to get Papyrus running and how to create a model. 5.2 Downloading Eclipse Eclipse Mars Modeling Tools (see i.2) can be downloaded from here: http:/www.eclipse.org/downloads/packages/eclipse-modeling-tools/mars2 NOTE: The “Eclipse Model
28、ing Tools“ package needs to be downloaded, not any other package. Select the package needed for the operating system as shown on figure 5.2-1. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 7 Figure 5.2-1: Eclipse Mars Modeling Tools Download Page Once downloaded, Eclipse cannot be “installed“ on the tar
29、get machine. The zip-file needs to be extracted in a new folder as shown on figure 5.2-2. Figure 5.2-2: Content of the Eclipse folder after extracting the zip-file To launch Eclipse, double-click on the Eclipse.exe file. After launching Eclipse, a default folder is created in the home directory (/us
30、ers/). The workspace configuration information is contained in the folder: . Any empty (need not be empty but is recommended) folder - anywhere - can be used as the workspace-folder. The workspace can be selected during the start of Eclipse. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 8 Figure 5.2-3:
31、Initial Welcome page of Eclipse Figure 5.2-3 shows the initial welcome page of Eclipse. Close the tab at the upper left corner. Eclipse is now ready for initial installation of Papyrus. To add Papyrus, click menu and then as shown in figure 5.2-4, figure 5.2-5, figure 5.2-7 and figure 5.2-8. Figure
32、5.2-4: Installing Papyrus (1) Select Papyrus and click . ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 9 Figure 5.2-5: Installing Papyrus (2) If a proxy to access internet is needed, it can be configured under Windows, Preferences, then General, Network Connections as shown on figure 5.2-6. Figure 5.2-6
33、: Proxy configuration ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 10 Figure 5.2-7: Installing Papyrus (3) Figure 5.2.8: Installing Papyrus (4) When prompted, accept the terms of the license agreement as shown on figure 5.2-9. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 11 Figure 5.2-9: Installing Papyru
34、s (5) After restarting Eclipse, switch to the Papyrus Perspective as shown on figure 5.2-10 or figure 5.2-11 by: either going via menu Window Perspective Open Perspective Other: Figure 5.2-10: Open Papyrus perspective (1) ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 12 Figure 5.2-11: Open Papyrus persp
35、ective (2) or by clicking the Open Perspective-button ( ) at the top right side of the screen: and then selecting as shown on figure 5.2-12. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 13 barb2right Figure 5.2-12: Open Papyrus Perspective 5.3 Papyrus overview The outline of the Papyrus Perspective pre
36、sents different windows and toolbars as shown in figure 5.3-1. Figure 5.3-1: Outline of Papyrus perspective ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 14 Perspective: it provides the modeling context and the layout of the windows, as well as the definition of the menus and toolbars. For using Papyrus
37、, it is always set to “Papyrus“. Project Explorer: it is used to manage Papyrus projects at system level. It provides a view on the model files in the workspace folder. Model Explorer: it provides the internal view of the model selected in the Project Explorer. It is a tree-based model editor for th
38、e whole model. If the Project Explorer contains several models, only one at a time can be selected to be edited in the Model Explorer. Model Editors: it allows graphic edition of the model via diagrams. Class diagrams are the only type of diagram mandated. Property View: it is a form-based editor al
39、lowing to view and edit the detailed property of a given element. Outline View: it provides a read-only view of the model presented in the Model Editor. 5.4 Installing Gendoc plugin installation The Gendoc plugin is used in conjunction with a document template. The template contains instructions tha
40、t enable generation of a MicrosoftWorddocument. The document can include extracts from the model such as diagrams, class definitions, attribute definitions along with their stereotypes, etc. as well as figures and text directly entered into the template. This clause provides instructions on how to i
41、nstall Gendoc followed by guidance on construction of Gendoc templates along with example fragments of templates. Click menu and then as shown in figure 5.4-1. Figure 5.4-1: Installing Gendoc (1) Click and enter the Gendoc 0.5.0 update site as shown in figure 5.4-2: http:/download.eclipse.org/gendoc
42、/updates/releases/0.5.0/ ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 15 Figure 5.4-2: Installing Gendoc (2) Select Gendoc as shown in figure 5.4-3. Figure 5.4-3: Installing Gendoc (3) Then click and follow the instructions. 5.5 Importing a model The Papyrus Perspective offers a Project Explorer and a
43、Model Explorer as shown in figure 5.5-1. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 16 Figure 5.5-1: Papyrus Project Explorer/Model Explorer NOTE 1: Models cannot exist on their own. Every model needs to be contained in a project. NOTE 2: A project can contain zero or more models. The window provides
44、 a view on the model files in the workspace-folder. The window provides the internal view of the model selected in the . The can only show (edit) one model at a time. The actual interface specification is contained in the Information Model and the additional properties of the UMLartefacts are define
45、d in a Profile Model. It is possible to organize the two models in a single project (Alternative 1 in figure 5.5.2) or in two separate projects (Alternative 2 in figure 5.5-2). Figure 5.5-2: Papyrus Model Structure NOTE 3: ETSI NFV Information Model is using Alternative 2: Information Model and Prof
46、ile Model in separate projects. Download the latest model GR (e.g. ETSI GR NFV-IFA 015 i.7). The extracted ZIP contains a ZIP file of the current model. For the ETSI NFV Information Model, the format is NfvInformationModelv.zip. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 17 The next step is to import
47、 the OpenModelProfile files and XxxModel files into Papyrus. Right-click in the Project Explorer area to open the menu containing the Import button as shown in the figure 5.5-3. Figure 5.5-3: Importing a model (1) Select General Existing Projects into Workspace. Click Next and then point via the Bro
48、wse button to navigate to the folder containing the archive file to be imported as shown in figure 5.5-4. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 18 Figure 5.5-4: Importing a model (2) Always import both the Information Model and the Profile. A double click on in the Project Explorer opens the mod
49、el in the Model Explorer as show in figure 5.5-5. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 19 Figure 5.5-5: Open a Model Now the model import is completed. 5.6 Deleting a Project Projects can be deleted from the by a right click on the project (e.g. ) and selecting as shown in figure 5.6-1. ETSI ETSI GR NFV-IFA 016 V2.1.1 (2017-03) 20 Figure 5.6-1: Delete a Project 6 Using Papyrus 6.1 Illustrative Profile and Model This guideline document uses an illustrative UMLprofile, a
