Data Model: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
(Created page with "==Analytics== The Analytics tab provides tools to summarize different aspects of your model and review and compare large sets of model nodes. Entity Usage — The Entity Usage tool provides an at-a-glance overview of entities most commonly used in project paths as well as an overview of how many entities remain unused. Hover over the graph to see the name of the entity presented and the exact number of times it is used. Semantic Equivalencies — The Semant...")
 
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
==[[Analytics]]==
PHENOM can generate a number of different data model formats and documentation artifacts from the current project.


The Analytics tab provides tools to summarize different aspects of your model and review and compare large sets of model nodes.
== Filter ==
The first drop down in the page allows the user to filter the nodes in the model and the Nav Tree to only that will be used for generation.
* None: no filter is applied
* Services: only display the services in the Nav Tree and only services will be exported (along with any elements necessary to export a valid model)
* Views: only display the views in the Nav Tree and only views will be exported (along with any elements necessary to export a valid model)
* Tags: the tag filter currently applied in the Nav Tree will be applied to the model upon export (necessary elements to make the model valid will be exported as well)


    Entity Usage — The Entity Usage tool provides an at-a-glance overview of entities most commonly used in project paths as well as an overview of how many entities remain unused. Hover over the graph to see the name of the entity presented and the exact number of times it is used.
== Generate Models & Artifacts ==
    Semantic Equivalencies — The Semantic Equivalencies tool allows you to determine the percentage of characteristics in a group of views that have semantically equivalent paths within another group of views.
The user can then choose the type of artifact to generate. Each type of artifacts has its own generation parameters.


==[[Health Check]]==
=== FACE (.face) ===
This type exports a data model in FACE XMI format aligned with the FACE Technical Standard. The user has to choose which version of FACE to export the data model as: 3.1, 3.0, or 2.1. "2.1 obfuscated" exports the model as a 2.1 FACE files and obfuscate the node's names (mainly used for debug purposes).


The PHENOM Health Check provides a validation of "project quality" through a series of tests, including Entity and Attribute uniqueness.
[[File:Phenom-generate-data model face.png|800px|border]]
 
=== Diagrams (.zip) ===
This option exports all the user-created diagrams and/or view traces as PGN files in a ZIP archive.
 
[[File:Phenom-generate-data model diagrams.png|800px|border]]
 
=== IDL (.idl) ===
This option exports the data model in Interface Description Language (IDL) format.
 
=== Skayl (.skayl) ===
This option exports the data model in Skayl's Proprietary Format. This format is similar to FACE XMI, but it preserves all non-standardized content, including integration model content.
 
=== User Template ===
This option exports the data model using user templates. These templates can be edited in the [[Templates]] tab.
 
[[File:Phenom-generate-data model user template.png|800px|border]]

Latest revision as of 14:38, 15 September 2022

PHENOM can generate a number of different data model formats and documentation artifacts from the current project.

Filter

The first drop down in the page allows the user to filter the nodes in the model and the Nav Tree to only that will be used for generation.

  • None: no filter is applied
  • Services: only display the services in the Nav Tree and only services will be exported (along with any elements necessary to export a valid model)
  • Views: only display the views in the Nav Tree and only views will be exported (along with any elements necessary to export a valid model)
  • Tags: the tag filter currently applied in the Nav Tree will be applied to the model upon export (necessary elements to make the model valid will be exported as well)

Generate Models & Artifacts

The user can then choose the type of artifact to generate. Each type of artifacts has its own generation parameters.

FACE (.face)

This type exports a data model in FACE XMI format aligned with the FACE Technical Standard. The user has to choose which version of FACE to export the data model as: 3.1, 3.0, or 2.1. "2.1 obfuscated" exports the model as a 2.1 FACE files and obfuscate the node's names (mainly used for debug purposes).

Diagrams (.zip)

This option exports all the user-created diagrams and/or view traces as PGN files in a ZIP archive.

IDL (.idl)

This option exports the data model in Interface Description Language (IDL) format.

Skayl (.skayl)

This option exports the data model in Skayl's Proprietary Format. This format is similar to FACE XMI, but it preserves all non-standardized content, including integration model content.

User Template

This option exports the data model using user templates. These templates can be edited in the Templates tab.