PHENOM Portal Knowledgebase - User contributions [en]

Import

2024-04-09T17:57:42Z

Jacob: Replaced "nodes" with "model elements".

Within Data Model, the Import tab is where users can bulk import data into PHENOM. Model import using a .face file is available from the [[Projects and Models Management#Projects Management|Projects and Models Management]] page.

== [[CSV]] ==
Users can bulk import data into PHENOM using a properly formatted CSV file. The types of data the user can import are:
* View-Characteristic
* Enum-Literal
* Model-Content
* Constraints
* Message Data Model
* Platform Types

== [[Placeholders]] ==
Phenom can add a set of placeholder model elements to help you in your modeling efforts. These model elements will be most useful when you are not completely sure what observable or entity best represents the semantic you are trying to document or what measurement best represents the one used by a particular interface. In these instances, you will be able to use or project to a placeholder, coming back later to revise your project.

The placeholders will include an Observable, a Measurement System, commonly used Measurements, and a placeholder entity.

'''Example'''
[[File:Placeholder1.jpg|thumb|none]]

In this example we are using the AcccelerationPlaceholderMeasurement.

[[File:Placeholder2.jpg|none|thumb]]
When we're ready to revise the project, the placeholder usage will appear in the health check.

== [[Merge External Model]] ==
Merge external model will inject nodes from a provided model file into the current project. If Overwrite is enabled, nodes that are present in both the source and the destination project but are different in the destination project will be edited to resemble the ones in the source model.

Data Modeling

2024-04-09T17:53:59Z

Jacob: Removed irrelevant message model stuff

==[[Data Model Details]]==
The details tab is where most of the detailed model editing is done. Although selecting the [[details]] tab directly does very little, this is where the properties appear once an element has been selected from the [[NavTree]].

==[[Diagram]]==
Diagrams are a very easy way to visualize models and explore their connectivity. A modeling tool would not be complete without some means of building diagrams. While constructing PHENOM's diagramming engine, users expressed their desire for a "modeling scratchpad" capability. This concept allows users to build model content without immediately affecting the data model. This makes it possible to experiment with different modeling ideas without adding a bunch of intermediate content to the model. The new elements become official model content once they are "committed."

Beyond modeling new elements and patterns, the diagram tool can be used to build interface documentation. This functions oppositely from PHENOM's typical mode of documentation. Instead of start with the most specific details and then adding context, this view editing tool starts with the broadest context and narrows down to the most specific details. This approach is difficult to use unless you know the data model.

==[[Health Check|Healthcheck]]==
Rapidly check the overall health of your data model using PHENOM's Health Check. It runs 19 different tests against the model.

Some of the health checks provide tools to help users fix errors.

==[[Analytics]]==
These are tools that provide additional insight into the model. It can show the distribution of entities and attributes used in the documentation. This helps identify areas of the model where refactoring activities can provide the greatest benefit.

==[[Meridian Map]]==
The Meridian Map is a type of ribbon diagram that shows the semantic alignment of a collection of views. Drag up to 50 views into the Meridian Map, and it will quickly render the a graph showing all of the 100% semantic matches.

By default, this alignment works at the conceptual level. This means that a latitude position will map to a longitude position. In order to further filter using the measurement information, make sure that "Logical Matches Only" is selected.

==[[View Trace]]==
The View Trace tool allows users to map a set of views (one or more) to another set of views (one or more). Although the data model automates the View Trace process, there are times when it is necessary to map dissimilar semantics. View Trace is the primary mechanism for overriding semantic mappings.

==[[Import]]==
Although loading FACE XMI models (.face files) is the primary mechanism for importing bulk data into PHENOM, the import section has some helpful tools for importing data that may not conform to this default format.

PHENOM has the ability to import: [[Entity and Association| Entities]], [[Entity and Association| Associations]], [[View]]s, [[Platform Type and Enumeration|Enumerations]], [[Constraint]]s, and [[Platform Type and Enumeration|Platform Types]].

Permissions

2024-04-02T17:02:18Z

Jacob: rephrased to something more clear

== General ==
Permissions are a user's access level to either a project or a model. There are four different types of permissions, and a user can have any of the permissions types independent of one another. Users are able to assign permissions to their projects and models by using the Permissions Manager on the Project Detail and Model Detail pages. The table contains all users on the same account as the user.

[screenshot]

Another way to assign permissions to users that do not belong to the current user's account is by giving them a Permissions Token via the Project Sharing page. By inputting a username and the desired permissions level, then clicking the Share button, a unique Token will be generated for the specified user.

[screenshot]

The other user can then input the generated token to gain access to that project or model.

[screenshot]

This user, along with any other external users, will appear in the Permissions Manager under a separate External Users table.

[screenshot]

== Read permissions ==
'''If a user has Read permissions, they have the most basic access to a project or model.'''

The user is allowed to switch to a project to which they have Read permissions to all the contained models. The user is allowed to see all the content of their Read access projects and models. The user is also allowed to export their project for use elsewhere. In addition, if the model inherits from another model, a user with Read permissions is allowed to see the nodes that can be pulled from a parent model, but are prevented from actually pulling that content. Likewise, if a model has other models that inherit from it, a user with Read permissions to the model is allowed to see the push requests from the children models, but is not allowed to approve those changes.

Read permissions are also unique from the other permissions types because in order to have any other permissions, a user is required to also have Read access, to prevent scenarios where a user is allowed to edit model content that they are not even allowed to see. This is why a user wanting to assign Write or Admin permissions are not allowed to disable Read permissions, as seen below.

[screenshot]

== Write Permissions ==
'''If a user has Write permissions, they are allowed to edit project and model content.'''

The user is able to modify fields on the details pages of nodes in the model, as well as the majority of the actions related to inheriting models. If the model inherits from another model, the user with Write access is able to request to push content to the parent model. Assuming that the user also has Read permissions to the parent model, the user is also allowed to pull any new changes from the parent model. Likewise, if a model has other models that inherit from it, a user with Write permissions to the model is allowed to approve content changes and delete push requests.

== Admin Permissions ==
'''If a user has Admin permissions, they are allowed to make changes to projects and models themselves.'''

A user who has Admin access to projects or models is allowed to change the permissions of users who belong to the same account as them to the project or model. A user with Admin access to a model is also allowed to create inheriting models from it.

== Owner Permissions ==
'''If a user has Owner permissions (or "owns" a project or model), they were the creator of the project or model, and therefore have all of the above permissions types, as well as some more actions limited to just the owner of the project or model.'''

A user that owns a project or model is allowed to change permissions, both to users that belong to the same account as them, as well as external users, sharing permissions with them via Permissions Tokens. If a user owns a project and wishes to give other users permissions to it that are higher than those users currently have, the user must also have Admin permissions to all the contained models. In addition, the Owner of a project or model is the only user allowed to rename or delete the projects and models they own. If a user owns a project or model, no other user is allowed to revoke any of their permissions.

It should be noted that if a project or model was created before April 2nd, 2024, the project or model may have more than one Owner. When Owner permissions were added, the Owner of a given project or model was determined to be anyone who had Admin permissions to that project or model, excluding any user who recieved Admin access via a Permissions Token. All projects and models created after April 2nd, 2024, only have one Owner.

== Account Admins ==
Account admins are able to see all the projects and models that exist on their account, and are able to assign permissions to those projects and models to any user on the same account. In the case that a project or model was shared to someone on an account using a Permissions Token, that account's Admins are only allowed to assign permissions to the project or model that someone on the account holds.

Permissions

2024-04-02T16:58:56Z

Jacob: Made the names sound similar

== General ==
Permissions are a user's access level to either a project or a model. There are four different types of permissions, and a user can have any of the permissions types independent of one another. Users are able to assign permissions to their projects and models by using the Permissions Manager on the Project Detail and Model Detail pages. The table contains all users on the same account as the user.

[screenshot]

Another way to assign permissions to users that do not belong to the current user's account is by giving them a Permissions Token via the Project Sharing page. By inputting a username and the desired permissions level, then clicking the Share button, a unique Token will be generated for the specified user.

[screenshot]

The other user can then input the generated token to gain access to that project or model.

[screenshot]

This user, along with any other external users, will appear in the Permissions Manager under a separate External Users table.

[screenshot]

== Read permissions ==
'''If a user has Read permissions, they have the most basic access to a project or model.'''

The user is allowed to switch to a project to which they have Read permissions to all the contained models. The user is allowed to see all the content of their Read access projects and models. The user is also allowed to export their project for use elsewhere. In addition, if the model inherits from another model, a user with Read permissions is allowed to see the nodes that can be pulled from a parent model, but are prevented from actually pulling that content. Likewise, if a model has other models that inherit from it, a user with Read permissions to the model is allowed to see the push requests from the children models, but is not allowed to approve those changes.

Read permissions are also unique from the other permissions types because in order to have any other permissions, a user is required to also have Read access, to prevent scenarios where a user is allowed to edit model content that they are not even allowed to see. This is why a user wanting to assign Write or Admin permissions are not allowed to disable Read permissions, as seen below.

[screenshot]

== Write Permissions ==
'''If a user has Write permissions, they are allowed to edit project and model content.'''

The user is able to modify fields on the details pages of nodes in the model, as well as the majority of the actions related to inheriting models. If the model inherits from another model, the user with Write access is able to request to push content to the parent model. Assuming that the user also has Read permissions to the parent model, the user is also allowed to pull any new changes from the parent model. Likewise, if a model has other models that inherit from it, a user with Write permissions to the model is allowed to approve content changes and delete push requests.

== Admin Permissions ==
'''If a user has Admin permissions, they are allowed to make changes to projects and models themselves.'''

A user who has Admin access to projects or models is allowed to change the permissions of the projects or models to users who belong to the same account as them. A user with Admin access to a model is also allowed to create inheriting models from it.

== Owner Permissions ==
'''If a user has Owner permissions (or "owns" a project or model), they were the creator of the project or model, and therefore have all of the above permissions types, as well as some more actions limited to just the owner of the project or model.'''

A user that owns a project or model is allowed to change permissions, both to users that belong to the same account as them, as well as external users, sharing permissions with them via Permissions Tokens. If a user owns a project and wishes to give other users permissions to it that are higher than those users currently have, the user must also have Admin permissions to all the contained models. In addition, the Owner of a project or model is the only user allowed to rename or delete the projects and models they own. If a user owns a project or model, no other user is allowed to revoke any of their permissions.

It should be noted that if a project or model was created before April 2nd, 2024, the project or model may have more than one Owner. When Owner permissions were added, the Owner of a given project or model was determined to be anyone who had Admin permissions to that project or model, excluding any user who recieved Admin access via a Permissions Token. All projects and models created after April 2nd, 2024, only have one Owner.

== Account Admins ==
Account admins are able to see all the projects and models that exist on their account, and are able to assign permissions to those projects and models to any user on the same account. In the case that a project or model was shared to someone on an account using a Permissions Token, that account's Admins are only allowed to assign permissions to the project or model that someone on the account holds.