Introduction

The Open Source UML tool Papyrus is a plug-in for the Open Source integrated development environment (IDE) Eclipse.

GenDoc is the associated tool that allows you to output a model in Papyrus into a word document. The artifacts in the output (diagrams, classes, datatypes, etc.) can be copy/pasted directly into a model project's wiki page.

The Gendoc plugin is used in conjunction with a document template. The template contains instructions that enable generation of a Microsoft Word document. 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.

Current ONAP modelling tool versions

Installation

For current versions of Papyrus, both Eclipse and the Papyrus plugin are bundled together in a single installation package. Note that it's possible to install more than one version of Eclipse/Papyrus on the same machine.

Checking the status of the Eclipse Foundation servers

Before installing any Eclipse software, always check the status of the Eclipse Foundation servers! Installations can fail or act unpredictably if their servers are not fully operational.

The status is reported here: https://www.eclipsestatus.io/

Installing Papyrus

  • Papyrus installation packages can be downloaded from here: https://www.eclipse.org/papyrus/download.html
    • Select the download link that is appropriate for the machine on which you will be making the install, ex. "Windows 64-bit".
    • This results in the download of a zip file.
  • Extract the contents of the zip file to a directory from which you will start Papyrus. On a PC, "Program Files" is always a good option.
    • The content of the extracted files should look something like this:

  • To launch Papyrus, double-click on the "papyrus.exe" file.
    • For convenience, you may want to create a shortcut to papyrus.exe on your desktop or (for PC) pin it to your start menu
  • When Eclipse starts coming up, it will prompt you for a "Workspace", providing a default that you can override. The workspace is where your Eclipse projects will be stored. 
  • When Eclipse fully comes up, you can close the Welcome tab.

Installing GenDoc within Papyrus

  • GenDoc releases are available here: https://www.eclipse.org/gendoc/downloads/download.php
  • The easiest way to install GenDoc is to copy the URL to the update site from that page and use it directly in Papyrus.
    • In Papyrus, go to the menu item "Help"→"Install new software...". An "Available Software" popup window should appear.
    • In the "Work with:" section, paste in the GenDoc update site for the appropriate release (for example http://download.eclipse.org/gendoc/updates/releases/0.7.2/2019-09) and hit enter.
    • Select the Gendoc package. You should see something like this:
    • Click the "Next >" button and follow the instructions to complete the installation.
      • Note: You may get a warning message about installing software that contains unsigned content - select "Install anyway".
    • When the installation is finished, Eclipse will prompt for a restart. Accept the restart to begin to use GenDoc.

Checking the versions of the tools

Checking the version of Papyrus

  • To verify you have the correct version of Papyrus, go to the menu item "Help"→"About Papyrus".
  • A popup window should appear that shows the Eclipse version (NOTE: not the Papyrus version) and looks something like this: 
  • Click on "Installation Details" to show the Eclipse and Papyrus versions. You should see something like these:

Checking the version of GenDoc

  • To verify you have the correct version of GenDoc, first follow the instructions above for checking the version information for Eclipse.
  • In the "Papyrus Installation Details" popup, when GenDoc is properly installed, you should see something like these:

Tips and Tricks in Eclipse/Papyrus

EGit (Eclipse/Git)

If you encounter unanticipated problems when following the procedures on this page for working with Eclipse/Git, check the user guide for possible solutions: http://wiki.eclipse.org/EGit/User_Guide

Workspaces

A workspace is a directory where Eclipse projects, with associated models and files, are stored. It's possible to have several workspaces, but only one is active at a time. Preferences for Eclipse and its plugins are also local to a workspace.

Note that local GIT repositories are not stored in the workspace itself, but there is a link from the workspace to the GIT repository being used in that workspace.

Important: if you open a workspace in a different version of Eclipse than previously used, Eclipse will update the workspace to match that version.

Important: It's possible to delete a workspace by simply deleting its directory when it is not active in Eclipse. This will delete all content that is stored locally there, so be sure before deleting!!!

Choosing workspace at startup

  • When Papyrus starts, a popup window normally asks you to select a Workspace, with many different options for selection. You can also create a new workspace by writing in a new directory name in the Workspace field.

Switching workspaces

  • Within Papyrus, you can switch between workspaces by going to the menu item "File"→"Switch Workspace". 
  • Clicking "Other..." brings up a popup window similar to the one shown on startup, but that also allows you to copy workspace settings from the current workspace to a new one.

Perspectives

A perspective is a view in Eclipse that contains a series of selection and content editor areas. The perspective has an initial layout that you can change by collapsing, expanding or moving around the different areas.

Papyrus has a number of pre-defined perspectives associated with different tasks and plugins. In ONAP we mainly use the perspectives for Papyrus and Git.

Resetting a perspective to default layout

If you have moved around or minimized some of the view areas and can't find something you're looking for, you can reset the current perspective to its default layout.

  • Select the menu item "Window"→"Perspective"→"Reset Perspective..." and then click "Reset Perspective" in the popup window.

Switching perspective

There are several ways to switch perspectives:

  • To change perspective, go to the menu item "Window"→"Perspective"→"Open Perspective" and then select the perspective that you want to use.
  • If you don't see the perspective you want, continue to menu item "Other" to open a popup with further options that looks like this:
  • To switch back and forth in the list of currently active perspectives, select the menu item "Window"→"Navigation"→"Next Perspective"/"Previous Perspective" or use the corresponding hotkeys:
  • There is also a toolbar for changing perspectives, normally on the top right side of your screen. You will see a number of small icons that represent perspectives:

    • The storage/cylinder icon marked "GIT" is for Git, and the bird icon is for Papyrus.
    • If you don't see the icon for the perspective that you want to use, clicking the icon with the "+" to the left of the predefined perspectives brings you to the same popup window as going to the menu item "Window"→"Perspective"→"Open Perspective"→Other".

Using the ONAP Model from Gerrit in Papyrus

First-time Setup of Papyrus for ONAP Gerrit

This process must be followed if you have never used the Eclipse/Git function with Gerrit.

Setup of RSA Keys in Papyrus and ONAP Gerrit

You must first generate an SSH key within Papyrus:

  • Go to the menu item "Window"→"Preferences", then "General"→"Network Connections"→"SSH2".
  • Select the "Key Management" tab and click "Generate RSA Key...".

         

  • The system will generate a key for you and place the key in the same window, in the box labelled "You can paste this public key into the remote authorized_keys file:".
  • Copy the public key. You will need to paste this into ONAP Gerrit.
  • Select "Save private key", which will save your key as an id_rsa file.
    • Note: You may be asked if you want to save this private key without passphrase protection - select OK.



  • A window will pop up with a location and a name for the key file - just click Save.


  • Don't click "Apply and Close" yet.

Add the key from Papyrus into ONAP Gerrit:

  • Login to ONAP Gerrit (https://gerrit.onap.org/).
  • Click your name at the top right and click "Settings".
  • Click or scroll to "SSH Keys":

  • If you didn't copy the text of your public key before, you now need to switch to the open "SSH2" window in Eclipse and copy it.
  • In Gerrit, paste the text of your public key into the "New SSH key" text box and click "Add New SSH Key".
  • Now you can go back to Eclipse and click "Apply and Close".

ONAP Gerrit user contributor agreement

To be able to push model changes to Gerrit, you need to have a CCLA (Corporate Contributor License Agreement) associated with your account in Gerrit.

  • Login to ONAP Gerrit (https://gerrit.onap.org/).
  • Click your name at the top right and click "Settings".
  • Click or scroll to "Agreements".
  • If you do not see a CCLA clickable link, click on "New Contributor Agreement" and follow the instructions:

ONAP Gerrit user setup in Eclipse

To be able to push model changes to Gerrit, your "committer" user information in EGit (a.k.a. Eclipse/Git) must correspond to the user name and email you have associated with your ONAP Gerrit account. 

  • Login to ONAP Gerrit (https://gerrit.onap.org/).
  • Click your name at the top right and click "Settings".
  • Click or scroll to "Profile". You will see your user name and email. These should be the same as for logging in to Linux Foundation.
  • In Papyrus go to: "Window"→"Preferences", then "Team"→"Git"→"Configuration", and select the "User Settings" tab:


  • The table should contain a "user" category with an "email" and a "name" entry.
    • The value for the "email" key should be your email from Gerrit.
    • The value for the "name" key should be your user name from Gerrit.
  • If "User Settings" is empty or the information doesn't match your settings in Gerrit, you need to add or update entries in the key-value table.
    • Sometimes on an initial setup, your settings may not be writable.
      • First check that the Location field points at a valid Git config file. If you're unsure, click on "Open". This should open the .gitconfig file in the background in Eclipse.
        • Note: if you want to switch to the opened file and see its contents, you'll need to close the settings window and reopen it.
      • If the specified .gitconfig file isn't valid and writable, you may be able to fix this by exiting Eclipse, specifying your home directory in Windows, and reopening Eclipse. Follow the instructions here: http://wiki.eclipse.org/EGit/User_Guide#Setting_up_the_Home_Directory_on_Windows
    • Once your User Settings are editable:
      • If the "email" key exists but has the wrong value, select the value field in the table and provide your email from Gerrit.
      • If the table is empty or missing the "email" key, select "Add Entry...", type in the key "user.email", and provide your email from Gerrit as the value.
      • If the "name" key exists but has the wrong value, select the value field in the table and provide your user name from Gerrit.
      • If the table is empty or missing the "name" key, select "Add Entry...", type in the key "user.name", and provide your user name from Gerrit as the value.

Cloning the Information Model from Gerrit into Papyrus

The ONAP Information Model currently resides in Gerrit in the modeling/modelspec repository. In order to visualize it or make updates, you need to download the model to your local machine by cloning it into a local Git repository and adding it to your Papyrus workspace.

  • In Papyrus, go to the Git perspective, for example by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then selecting "Git".
  • Once in the Git perspective, your screen should have the following on top:

           

  • Select the "cloud" icon with a repository and a green arrow. This is your "clone repository" function in Git:
  • In the popup window, you need to supply the URI for the Source Git Repository. The format of that URI is ssh://{Gerrit_UserId}@gerrit.onap.org:29418/modeling/modelspec
  • Based upon what you have just entered, the rest of the screen gets populated with the correct info. It should look something like this:
  • Make sure to fill in your ONAP Gerrit password. This should be the same as for logging in to Linux Foundation. Once the screen is filled in, select "Next".
  • It will then prompt you for the branches to select. Click "Deselect All", then choose just "master" and click "Next". The popup should looks like this:
  • You will then be prompted to create a local directory on your machine into which the model should be loaded by Git.
    • It can be any location you want, and not necessarily the workspace you are using for Eclipse/Papyrus projects.
    • Check the box "Import all existing Eclipse projects after clone finishes".  Your screen at this point should look something like this:
  • Select "Finish".
    • For a first-time setup, you may get the following message. Select "Yes".
  • The cloning process should complete, and the repository should be created on your local machine.
  • The view below shows an example of the newly created repository which has been opened up down to the level of the "Local" folder. Only the "master" branch should show up as your "Local".

          

What if Eclipse/Git won't connect to ONAP Gerrit?

  • If it looks like Eclipse is not able to connect to Gerrit, you can try working with the model outside your corporate VPN.
  • However, the preferred way to solve this problem is to set up a proxy access to Gerrit:
    • Go to "Window"→"Preferences"→"General"→"Network Connections"
    • Edit the entries for HTTP and HTTPS that have "Provider" preset to Manual. For both, set the URL for your proxy under "Host" and its port under "Port".
    • For "Active Provider" at the top of the window, select "Manual".
    • The resulting configuration should look something like this:

Viewing the Model in Papyrus

Once you have successfully cloned the ONAP model, you can now view it in Papyrus.

  • Go to the Papyrus perspective, for example by selecting the menu item "Window"→"Perspective"→"Open Perspective"→"Other..." and then selecting "Papyrus".
  • This perspective should show a "Project Explorer" on the left side of the screen that looks something like this:


  • You should see your newly created Eclipse/Papyrus project in the "Project Explorer".


  • The text in light brown is telling you that your project is in the modelspec repository you just created, in the branch "master". Note that all model work is being performed in the "master" branch.
    • If you do not see the project in the "Project Explorer", probably you forget to check the box to import all existing Eclipse projects when cloning the model. To fix this, switch to the Git perspective, select the repository name or the Working Tree, then right-click and select "Import projects...".
  • If you click on the ">" to open/explore the ONAP Information Model folder, you will see something like:
  • Each of the "green birds" represent a Papyrus model. Double-clicking on any of these models will open it in a new Model Explorer panel, which is usually on the left side of the screen in the center.
    • The icon with the triangle saying "model" represents the top-level of the ONAP model. Double-click on "model" like you would a folder, and you should see something like this: 
    •  The icons with a little arrow coming out of a circle represent the sub-models. Open up any sub-model like you would a folder, and you should see something like this (in this example it is the Vnf sub-model):
  • Start viewing the model by selecting any diagram, i.e. in the Vnf → Diagrams package.
    • Here's a little trick for seeing the associated artifacts in the diagram. In the model explorer bar you will see two arrows opposing each other. Select that double-arrow option:
    • What this means, is when you select any artifact on a diagram, i.e. a "Class", the model explorer takes you directly to that artifact in the model explorer tree.
  • Now, explore the model yourself by taking a look at all the class diagrams in the sub-models! Note, some of the sub-models are currently empty.

Contents of the ONAP Information Model

Here is a description of what you have in the ONAP Information Model.

  • The overall ONAP "model" is composed of "sub-models".
  • Each of the "sub-models" has a model editor that is responsible for editing the model and uploading the changes into Gerrit/Git.
    • Note: two people should never edit a "sub-model" at the same time without clearly communicated coordination, otherwise "model conflicts" may arise.
  • You should see the following in the ONAP Information Model folder:
    • GenDoc  - This is where the GenDoc templates reside for creating an output of the model in Word
    • StyleSheets - These are CSS stylesheets to use when formatting the model                                                              
    • Common - The common submodel of the model (where artifacts used by multiple sub-models are stored)           
    • Infrastructure -  The infrastructure submodel where the multi-cloud artifacts are stored                                          
    • model - This is the "umbrella" ONAP model that contains all the submodels                                                            
    • Nf - Network Function submodel                                                                                                                                
    • Ns - Network Service submodel                                                                                                                                  
    • OpenModel_Profile.profile - Contains IISOMI stereotypes                                                                                                                                     
    • Party - The party submodel for party related artifacts                                                                                                 
    • Pnf - The Pnf submodel where PNFD resides                                                                                                               
    • Resource - The resource submodel for resource related artifacts                                                                                
    • Service - The service submodel for service related artifacts                                                                                         
    • Vnf - The Vnf submodel for Vnf specific artifacts
  • Each sub-model has the following types of packages
    • Associations - Contains all associations used in diagrams.
    • Diagrams - Contains UML diagrams
    • Interfaces - Contains Component, Interface, and Operation artifacts (usually empty for now)
    • ObjectClasses - Contains all class definitions
    • TypeDefinitions - Contains all DataTypes and Enumerations.

Updating the Model in Gerrit

Only approved model editors can update the working branch in Gerrit. To be a model editor you must undergo Papyrus training.

  • Current model editors for each submodel are specified here.

Before making changes, always ensure that you have the latest version of the model from the ONAP Gerrit repository.

  • If you have not yet cloned the model, the clone process will provide you with the latest version.
  • If you have already cloned the model into your workspace, make sure to "Fetch" the latest updates from Gerrit before making any changes.

Once you have finished making your model changes, select "File"→"Save" or click the Save icon.

Staging changes

Only changes that have been staged will be included in the Push to Gerrit.

  • If this is a first-time that you're updating the model, make sure that you first have set up the user information for Gerrit properly.
  • Next, go to the Git perspective, for example by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then selecting "Git".
  • Once in the Git Perspective, select the repository where you have changed the files:
  • Select the "Git Staging" tab in the lower right hand portion of your screen (It might also be on the right-hand side of your screen depending on your layout.)
    • It looks like this, with a little green down-arrow:
  • The Git Staging window looks like this:
  • You will see all of the files that you have changed in the "Unstaged changes".
    • Note: If there is a file in the list that you did not intend to change, you can revert the unwanted changes by right-clicking on that file and selecting "Replace with HEAD revision".
  • For each changed file that you want to stage, right-click and select "Add to index". Once they have been added, the files will move to "Staged Changes".
    • As a shortcut, you can select the little green "++" sign that will add all the files for you:
    • After you hit the green "++" it should look something like this:

Writing the commit message

Next you will need to prepare to "Commit and Push" your changes.

  • Position your cursor in the "Commit Message" window.
  • Add a commit message indicating the change you have done, i.e. "Added new diagram to service model".
  • Then press carriage return twice so that you have a blank line after your message.
    • You can then optionally add a more detailed message about the change.
  • Next, you will have to associate the change to a JIRA ticket. Add on the line after the blank line:  Issue-ID: MODELING-xxx
  • Git should generate a "Change-Id" for you, so you don't need to manually add one.
    • If there is no "Change-Id" line in the "Commit Message" window, click the "Add Change-ID" icon to the right on the same line as the "Commit Message" title.
  • Then "Sign-off" on the change by clicking the "Add Signed-off-by" icon that looks like a pen and is on the same line as the "Commit Message" title:

                   

Commiting to your local repository and pushing to remote Gerrit

  • Now you are ready to select "Commit and Push". This commits your local changes and pushes them to the remote Gerrit repository (which should be the working branch).


    • Note that the "Committer" must correspond to the user name and email you have associated to your Gerrit account. If they don't, follow the instructions here: ONAP Gerrit user setup in Eclipse
  • After you press "Commit and Push...", you will see this popup:
  • Click "Finish".

Asking for approval in Gerrit

  • Once your changes have been successfully pushed to Gerrit, you should see push result messages from Gerrit in a new window in Eclipse:

                

  • This window display the Gerrit identifier (in this case 59893) associated with the change. Make a note of the identifier.
  • Now open a browser and login to Gerrit (https://gerrit.onap.org/).
  • You should then see the change you have just made. Select that change.
  • Click "Add..." and specify the name of the person to approve that change. Approvers are Deng Hui as well as the model owner, if you are updating a model for which you are not the owner.
  • Once the change has been committed, you will receive an email confirmation of the commit.

Recovering from a failed push to Gerrit

  • If your commit and push fails for any reason, once you have fixed the problem, you can try to resend the request by selecting the "Amend (Edit previous commit)" icon in the Commit Message bar:
  • If you want to roll back your failed commits:
    • Go to the Git Perspective by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then select "Git".
    • Right-click on the "modelspec" repository and select "Reset...":
    • Select "Remote Tracking"→"origin"→"master", then "Mixed", and then click "Reset".
    • This operation will let your local back to keep aligned with the remote merged changes, then you can do a new commit.

Exporting the ONAP Model

Exporting to a Word Document

GenDoc is a plugin to Eclipse/Papyrus that enables you to output the model to a Word document. (See installation instructions for the GenDoc plug-in above.)

Updating the GenDoc Template

  • Generic GenDoc templates are provided in the GenDoc folder of the ONAP model. Each template is a Word document itself that contains GenDoc instructions.
    • The template commonly used for model output is called "ONAP GenDoc Template.docx". 
  • You can open the template directly in Eclipse by right-clicking the template and choosing "Open With", and then the editor you want to use.
    • To open the template in Word outside of the Eclipse environment, select "System Editor".
  • There are two things in this template that you need to update before exporting the model:
    • Find the key "model_name" and fill in the name of the model that you want to export. This needs to be changed whenever you export a different sub-model.
      • Ex.<param key='model_name' value='Pnf'/><drop/>
    • Find the key "user_path" and fill in the name of the directory of your workspace. This only needs to be changed when opening the model in a new workspace.
      • Ex. <param key='user_path' value='D:\eclipse-workspace\ONAP_IM'/><drop/>
    • Note: Don't "push" the updated GenDoc template which contains your specific information, unless you are also changing something in the body of the template itself

Running the GenDoc template

  • Once you have updated the GenDoc template, right-click on the template file and select "Generate documentation using Gendoc"
  • The GenDoc utility is invoked and the template is run.
  • By default, the template creates a directory "GenDoc_output" in your workspace, if it doesn't already exist.
  • It then creates a Word doc that contains the model name and the current date-time in its name.

  • To see the newly directory and file, select "File"→"Refresh".

  • As an alternative:
    • Create your own private folder for the Gendoc template by selecting  "File"→"New"→"Folder". Give the folder a name.
    • Then select "File"→"Import"→"File System" and import the Gendoc template from your "ONAP Information Model"/Gendoc directory .
    • This imported file is now your own private copy. You can run the template using the same procedure described above.

Exporting to an Excel File

Papyrus provides the capability to export fragments of the model to tables.

Creating a table

  • In the Model Explorer, right-click on the folder containing the UML artifacts you want to output (for example "Common"→"Root"→"RootObjectClasses") and select an option under "New Table".
    • Papyrus proposes different formats for your table, such as Class Tree Table, Generic Tree Table, as well as a configuration utility to create your own table format.
    • For the purposes of this example, select "Class Tree Table". 
  • The table artifact will be stored in the folder you selected above, using the name you provided when you created the table.
  • The "Class Tree Table" will be automatically opened up when it is created and will look like this:
  • Now, in the Model Explorer, select all the classes you which to put in the table and "drag/drop" them into the table. 
    • Note: Another option to create a table is to first select the UML artifacts you wish to output, then right-click and select New Table.
  • Select the table contents and right-click and select  "Expand all for selection". The table will look something like this:

          

Putting a table into Excel

  • You can then "copy/paste" your table to an Excel spreadsheet, or just keep the table in Papyrus for future reference.

      


  • No labels