1、 ETSI GR NFV-IFA 016 V3.1.1 (2018-08) Network Functions Virtualisation (NFV) Release 3; 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 V3.1.1 (2018-08) 2 Reference RGR/NFV-IFA016ed311 Keywords information model, model, NFV ETSI 650 Route des Lucioles F-06921 Sophia Antipo
3、lis 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 doc
4、ument 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
5、/or 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 s
6、tatus 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 ma
7、y 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
8、restriction extend to reproduction in all media. ETSI 2018. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTMand the ETSI logo are trademarks of ETSI registered for the benefit of its Members. 3GPPTM and LTETMare trademarks of ETSI registered for the benefit of its Members and of the 3GPP Organizatio
9、nal Partners. oneM2M logo is protected for the benefit of its Members. GSMand the GSM logo are trademarks registered and owned by the GSM Association. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 3 Contents Intellectual Property Rights 4g3Foreword . 4g3Modal verbs terminology 4g31 Scope 5g32 References
10、 5g32.1 Normative references . 5g32.2 Informative references 5g33 Abbreviations . 5g34 Overview 6g35 Getting Papyrus running . 6g35.1 Introduction 6g35.2 Downloading Papyrus 6g35.3 Papyrus overview . 14g35.4 Installing Gendoc plugin 15g35.5 Importing a model 16g35.6 Deleting a Project . 21g36 Using
11、Papyrus 21g36.1 Illustrative Profile and Model . 21g36.2 Papyrus file structure 23g36.3 Submitting a modified model . 23g36.4 Generating model documentation . 25g36.5 Using Class Diagrams 26g36.6 Applying a stereotype to an element 27g36.7 Changing the value of a stereotype attribute 29g3Annex A: Au
12、thors 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 bee
13、n 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 document. Trademarks The present document may include trademarks and/or tradename
14、s which are asserted and/or registered by their owners. ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does not constitute
15、 an endorsement by ETSI of products, services or organizations associated with those trademarks. 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“
16、, “may“, “need not“, “will“, “will not“, “can“ and “cannot“ are to be interpreted as described 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-IF
17、A 016 V3.1.1 (2018-08) 5 1 Scope The present document gives guidelines for the use of Papyrus i.1 when creating or maintaining NFV UMLi.2 information model. 2 References 2.1 Normative references Normative references are not applicable in the present document. 2.2 Informative references References ar
18、e 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 latest version of the referenced document (including any amendments) applies. NOTE: While any hyper
19、links 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 present document but they assist the user with regard to a particular subject area. i.1 Papyrus Eclipse
20、 UMLModeling Tool. NOTE: Available at https:/www.eclipse.org/papyrus/. i.2 Eclipse Modeling Tools. NOTE: Available at https:/www.eclipse.org/downloads/packages/. i.3 OMG Unified Modeling Language (UML) specifications 2.5.0. NOTE: Available at http:/www.omg.org/spec/UML/. i.4 ONF TR-515: “Open Networ
21、king Foundation Papyrus Guidelines 1.2“ September 2016. i.5 ETSI GR NFV-IFA 017: “Network Functions Virtualisation (NFV) Release 2; Information Modeling; UML Modeling Guidelines“. i.6 Eclipse Gendoc website. NOTE: Available at http:/www.eclipse.org/gendoc/. i.7 ETSI GR NFV-IFA 015: “Network Function
22、s Virtualisation (NFV) Release 2; Management and Orchestration; Report on NFV Information Model“. i.8 ETSI GR NFV-IFA 024: “Network Function Virtualisation (NFV) Release 2; Information Modeling; Report on External Touchpoints related to NFV Information Model“. 3 Abbreviations For the purposes of the
23、 present document, the following abbreviations apply: IDE Integrated Development Environment JVM Java Virtual Machine MS MicrosoftONF Open Networking Foundation ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 6 UMLUnified Model Language 4 Overview The present document provides information for putting in o
24、peration 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 Papyrus that allows generating MS Worddocumentation of a model from a template. The UMLModeling Guideline
25、s 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 UMLtool Papyrus (see i.1 is a plug-in for the Open Source integrated development environment (IDE) Ecli
26、pse. Current tool versions: Papyrus version 3.2.x or 3.3.x Gendoc version 0.6.x (V0.6.0) This clause explains how to get Papyrus running and how to create a model. 5.2 Downloading Papyrus The instructions to download Papyrus can be found in the Papyrus Download page: https:/www.eclipse.org/papyrus/d
27、ownload.html. The basic procedure is to setup Papyrus with update sites as summarized on the download page: The most basic procedure for installing Papyrus consists in installing the Eclipse Modeling Package for your own platform. Then, use the discovery interface (“Help“ “Install Modeling Component
28、“) and select Papyrus. Install the latest release from Papyrus. See instructions below “Papyrus Update sites“. These steps will be detailed in this clause. The Oxygen Eclipse Modeling Tools can be downloaded from the Oxygen download page: https:/www.eclipse.org/downloads/packages/release/Oxygen/3. N
29、OTE: The “Eclipse Modeling Tools“ package needs to be downloaded, not any other package. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 7 Figure 5.2-1: Eclipse Oxygen Modeling Tools Download Page Eclipse Oxygen Modeling Tools requires a 1.8 compatible JVM. Once downloaded, Eclipse cannot be “installed“ o
30、n the target 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. The initial Eclipse Welcome icon, shown in figure 5.2-3 appears. ETSI
31、ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 8 Figure 5.2-3: Initial Eclipse Welcome Icon After launching Papyrus, a default folder is created in the home directory (/users/). The workspace configuration information is contained in the folder (which is automatically created): Any empty (need not be empty bu
32、t is recommended) folder - anywhere - can be used as the workspace-folder. The workspace can be selected during the start of Papyrus. Figure 5.2-4: Initial Welcome page of Eclipse Figure 5.2-4 shows the initial welcome page of Eclipse. Close the tab at the upper left corner. Eclipse is now ready for
33、 initial installation of Papyrus. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 9 To add Papyrus, click menu and then as shown in figure 5.2-4a, figure 5.2-5, figure 5.2-7 and figure 5.2-8. Figure 5.2-4a: Installing Papyrus (1) Select Papyrus and click . ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 10 Figu
34、re 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. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 11 Figure 5.2-6: Proxy configuration Figure 5.2-7: Installing Papyrus (3) E
35、TSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 12 Figure 5.2.8: Installing Papyrus (4) When prompted, accept the terms of the license agreement as shown on figure 5.2-9. Figure 5.2-9: Installing Papyrus (5) After restarting Eclipse, switch to the Papyrus Perspective as shown on figure 5.2-10 or figure 5.2
36、-11 by: either going via menu Window Perspective Open Perspective Other: ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 13 Figure 5.2-10: Open Papyrus perspective (1) Figure 5.2-11: Open Papyrus perspective (2) or by clicking the Open Perspective-button ( ) at the top right side of the screen: and then s
37、electing as shown on figure 5.2-12. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 14 g198 Figure 5.2-12: Open Papyrus Perspective 5.3 Papyrus overview The outline of the Papyrus Perspective presents different windows and toolbars as shown in figure 5.3-1. Figure 5.3-1: Outline of Papyrus perspective ETS
38、I ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 15 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, it is always set to “Papyrus“. Project Explorer: it is used to manage Papyrus projects at system level. It pr
39、ovides 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 the whole model. If the Project Explorer contains several models, only one at a time can be selected to be edited
40、 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 allowing to view and edit the detailed property of a given element. Outline View: it provides a read-only view of
41、 the model presented in the Model Editor. 5.4 Installing Gendoc plugin The Gendoc plugin is used in conjunction with a document template. The template contains instructions that enable generation of a MicrosoftWorddocument. The document can include extracts from the model such as diagrams, class def
42、initions, 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 install Gendoc followed by guidance on construction of Gendoc templates along with example fragments of templates. Click menu
43、 and then as shown in figure 5.4-1. Figure 5.4-1: Installing Gendoc (1) Click and enter the Gendoc 0.6.0 update site as shown in figure 5.4-2: http:/download.eclipse.org/gendoc/updates/releases/0.6.0/ ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 16 Figure 5.4-2: Installing Gendoc (2) Select Gendoc as s
44、hown 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 Model Explorer as shown in figure 5.5-1. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 17 Figure 5.5-1: Papyrus Project Explorer
45、/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 a view on the model files in the workspace-folder. The window provides the internal view of the model selected in the . The
46、 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 defined 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 tw
47、o 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 Profile Model in separate projects. ETSI ETSI GR NFV-IFA 016 V3.1.1 (2018-08) 18 NOTE 4: ETSI NFV Information Model is using the
48、 OpenModel Profile and the ProfileLifecycle Profile. Those 2 profiles are provided as part of the model ZIP. The OpenInterfaceModel Profile is not used by the ETSI NFV Information Model. Download the latest model GR (e.g. ETSI GR NFV-IFA 015 i.7). The extracted ZIP contains a ZIP file of the current
49、 model. For the ETSI NFV Information Model, the format is NfvInformationModelv.zip. The next step is to import 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 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 Browse button to navigate to the folder containing the archive file to be importe
