Creating a Project from an Existing Model

From PHENOM Portal Knowledgebase
Revision as of 11:28, 9 September 2026 by Chris (talk | contribs) (Documented import options)
Jump to navigation Jump to search

This page will explain how to create a new Project by uploading the file from your local system.

Switch to Manage Mode

All model management functions are performed in the Manage Models section of PHENOM. After logging in, please click on the Manage Models icon.

Create a New Project

It is possible to upload new content and create a new project all at once! To start, click on the Create New Project button.

Select Models

Once you click the button, the following screen should appear to the right of the Project listing.

For the Project Name, please use a valid identifier.

You may leave Description blank. This field is intended for you to capture notes about the project (or model) and how it will be used.

In the bottom-left of this display, there is a list of existing models. This is used to add existing models to the new project. Ignore this for now.

In the bottom-right, click on Import FACE model. This feature will allow you to upload .face and .skayl files alike. This button will add a model entry as follows:

For the Model Name (the first text field), please enter a valid identifier.

As before, Description can be left blank.

Click on Select files... and a file chooser will appear. Navigate to your local data model file and choose that file. PHENOM will immediately start uploading the file. While the file is uploading and being preprocessed, the following status will appear:

Once the file has successfully transferred, PHENOM will show the file uploaded successfully with a green indicator.

In the event of an error (e.g., invalid file type or invalid model), PHENOM will display an error as follows:

Once the file has been successfully uploaded, click on the SAVE button.

Import Options

There are two categories of import options for PHENOM: Import Checks/Fixes and Query Processing & Content Retention Options.

Import Checks/Fixes

  • Assert IDs (Default Checked). Ensures that each imported entity has an identifier.
  • Fix paths not ending in Observable (Default Checked). Although allowed by the FACE Technical Standard, this breaks model extensibility. When checked, this option will find and use an attribute with type identifier composed in the terminal entity.
  • Fix View Characteristics w/o name (Default Checked). When names are omitted from View characteristics, they are pulled from the corresponding entity model. This option makes the names explicit at the time of import.
  • Detect and reuse existing Shared Data Model (Default Checked). Detects the SDM used by the model and adds it as a separate model. This makes it easy to change the version of the SDM over time.
  • Unbounded CDM Mode (Default Checked). PHENOM best practices recommend bounds that differ from the standard-defined .face bounds. This option will apply the PHENOM-recommended bounds - (1..*) for all composed attributes/participants and (0..*) for all participant source roles.

Query Processing & Content Retention Options

  • Process CDM Queries (Default not Checked). Process the Conceptual Queries. This will used specified observables and create generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.
  • Process LDM Queries (Default not Checked). Process the Logical Queries. This will use the specified logical types and create generic platform elements in the model with "placeholders" where platform type would otherwise be specified.
  • Retain Queries (Default not Checked). This will retain all platform queries. Upon export, if these queries remains unchanged, they will be exported "as-is." When not enabled, exported queries may look slightly different (but will retain the same semantic).
  • Retain Entity Models (Default not Checked). This will retain all Logical and Platform Entities (and Associations). This is useful when strict tracking of these elements' GUID is desired.
  • Retain Auto Generated Content (Default not Checked). This feature preserves any automatically generated content PHENOM may have added during export. NOTE: PHENOM only does this to ensure model validity.
  • Apply Explicit Default Values (Default Checked). Ensures default values are made explicit in the model (instead of relying on implied default values).

Switch to New Model

After saving the model, it will appear in the project browser. Simply right-click on the new project and choose Switch. This will load the new project and you are able to start operating on this content.

You can verify that you have switched to the new project by looking at the top of your PHENOM display. The current project is displayed beside your username.