1 Introduction

The intent  intent is to identify a set of rules and good practises about Information model definition in ONAP.

ONAP information model is documented in Papyrus (see Using Papyrus for Modeling . for  for more information).

IISOMI MOdeling Modeling Guidelines (IISOMI TR 514) is taken as reference and extended where needed.

...

An information model proposal can be posted in ONAP wiki.

A An IM model proposal shall provides:

• A class diagram showing the new classes and relations (including inheritance, aggregation and association) with any other class in ONAPIM ONAP IM and across any ONAP administrative domain (i.e. common, resource and service domains).
• A inheritance diagram for each new class
• A definition of each new IM entity by a dedicated descriptive table 

ONAP IM entities are: classes, association, data type , enumarationand enumeration

2.1 OpenModelAttributes Guidelines

...

• Documentation: in alignment with IISOMI TR 514, it contains a short definition. The documentation is carried in the “Applied comments” field in Papyrus; i.e., the “Owned comments” field shall not be used. The complete documentation should be written in a single comment; i.e., at most one “Applied comment”.
• Type: in alignment with IISOMI TR 514,The following types are used: simple association, composition association, aggregation, association, generalization, dependency, usage dependency, abstraction dependency, realization dependency.

...

3 Requirements of Using Gendoc

Besides the Papyrus diagrams, detailed defintions of the ONAP IM entities (i.e., class, association, data type and enumeration) are required on the model proposal wiki page.

They are usually copied from the word document generated using the Gendoc template.

The Gendoc template can be found at "GenDoc/ONAP GenDoc template.docx" in the source code, and can be used through Eclipse Gendoc plugin.

Requirements before generating a word document using the template:

1) open the template

2) edit the <param key='model_name' value='Pnf'/><drop/> line

    replacing 'Pnf' with the sub model name (e.g., 'Vnf') for which you want to generate the document

3) edit the <param key='user_path' value='D:\eclipse-workspace\ONAP_IM'/><drop/> line

    replacing 'D:\eclipse-workspace\ONAP_IM' with the actual directory path on your local disk, containing the papyrus models (i.e., the *.uml and *.notation files)

4) save the file, and use the template to generate word documents, the generated files can be found under "GenDoc_output" directory