Versions Compared

Key

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

...

    • This window display the Gerrit identifier (in this case 59893) associated to the change.
    • Next you will have to go to Gerrit at: gerrit.onap.org and login to Gerrit
    • You can then see the change you have made. Select that change. You will then need to "add" the name of the person to approve that change (i.e. DENG Hui)
    • Once the change has been committed, you will receive an email confirmation of the commit.
    • Note: If your commit and push fails for any reason, once you have fixed the problem, you can resend the request by selecting the "Amend (Edit previous commit)" icon in the Commit Message bar.


Output the ONAP Model

...

Word Document

GenDoc is a tool that enables you to output the model to a Word document. See installation instructions on how to install the GenDoc plug-in.

...

  • Once you have updated the GenDoc template, right click on the ONAP GenDoc Template file and select  the option "Generate documentation using Gendoc"
  • The GenDoc utility is invoked and the template is run. Once it has completed, you can find your output in the Output file you specified in the template.
  • Note: You do not want to "commit" to Gerrit the updated GenDoc template which contains your specific information.
  • As an alternative, you can create your own private folder for Gendoc template by selecting the option "File->New→Folder". Give the folder a name.
  • Then you can select "File->Import→ File System" and import the Gendoc template from your ONAP Information Model → Gendoc directory 
  • When you update this file you imported, it is now your own "private" copy. You can run the template using the same procedure described above.


Excel

Creating Tables

  • Papyrus provides the capability to export fragments of the model to tables.
  • Right-click on the folder containing the Uml artifacts you want to output, for example, Common → ObjectClasses and select the option New Table.
  • Papryus proposes different formats for you table: Class Tree Table, Generic Tree Table, or even a configuration utility to create your own table format.
  • For the purposes of this example, we are going to create a "Class Tree Table". The table artifact will be stored in your ObjectClasses folder.
  • The "Class Tree Table" will be automatically opened up when it is created and will look like this:
    Image Added
  • Now, in the model explorer, select all the classes you which to put in the table and "drag/drop" them into the table. 
  • Select the table contents and right-click and select  "Expand all for selection"
  • Now, for Common object classes, the table will look like this:

          Image Added

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