PHENOM Portal Knowledgebase - User contributions [en]

Data Model Generation

2026-09-10T15:56:42Z

Chris: /* Skayl (.skayl) */

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. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.

[[File:Datamodel - Face.png|border|800x800px]]

For more information on the export options, visit '''[[FACE Export Options]]'''.

Phenom's representation of data models is not a one-to-one match with the FACE format. Instead, upon the generation of a FACE file, the Phenom representation of the model is converted to FACE. The most prominent changes include the generation of LDM and PDM entity models and conversion of view nodes to queries and templates.

=== Generated Entity Model Content ===
Phenom does not handle LDM and PDM entity model content - only CDM entities and associations (elements) are represented. Upon conversion to a FACE model, logical and platform elements are generated if they are projected by view fields in the Phenom model. Compositions and participants (attributes) that have a type that references another element generate LDM and PDM attributes referencing corresponding LDM and PDM elements. Compositions that reference an observable as their type are generate logical and platform compositions referencing measurements and platform types used by the view fields projecting the conceptual composition. In cases where a single conceptual attribute is generated into several logical and/or platform attributes (because of the projection of that conceptual attributes by view fields using different measurements and/or platform types), in order to prevent name conflicts, the rolenames of the generated attributes are augmented with the names of the measurements and platform types to which they relate.

==== Generated Queries and Templates ====
Phenom represents interface documentation as views with fields that have projection paths through the conceptual entity model and reference a measurement and a platform type. Each view is converted to a template (platform template for FACE 3.0 and uop template for FACE 3.1/3.2) and a related platform query.

The specification of the generated query is written to capture the combination of projections through the entity model expressed in the projection paths documented on the fields of the converted view (and any views that are contained as the top-view's sub-structures). While the view field projection paths documented in Phenom traverse the conceptual entity model, the query is written traversing the platform entity model that was generated as part of the conversion to FACE.

The specification of the generated template is written to reference the related query and represent the structure of the Phenom view being converted. View fields that references other views as their type result in either the addition of a `using` statement to the template specification or the expression of a sub-structure within the template specification; which is used is based on the 'Private Nesting' setting on the view field in Phenom.

==== Retention Artifact Recovery ====
Normally, Phenom will generate content necessary for the FACE model format during FACE model generation as described above. However, it is also possible to use content from the original model by using import artifact recovery during generation.

During model file import, a user has the option to retain certain model elements (including LDM and PDM entity model content and query and template nodes) that are not handled by Phenom. If this is done, then during FACE model export the user can attempt to recover the retained content. Doing this will result in the addition of the content originally retained into the model and the favoring of re-use of re-introduced content over the generation of new content. For example, if logical and platform entities and compositions needed to project a given view field are recovered from the retention artifact, that recovered content will be traversed by the platform query and new LDM/PDM elements will not be generated. Similarly a retained query name and id can be re-used when a view is converted instead of a new query being generated; even the specification of the query will be re-used if it is detected that the view has not been changed since the original import.

==== Generated Node GUID Values ====
In order to achieve repeatable results, when new content is generated during FACE conversion, the xmi:id values of the generated content is derived based on related properties.
{| class="wikitable"
|+
!Generated Node
!Reason For Generation
!Derived GUID Determiners
|-
|Identifier Composition
|A conceptual level element missing a composition of type Identifier or a specializing element that lacks a novel attribute.
| - id value of the affected element
- name of the added composition.
|-
|Realizing Entity Model Node
|An entity model element or attribute being generated to the LDM or PDM level because it is projected by a view field and thus will be traversed by a logical or platform level query specification.
| - name/rolename
- bounds (for attributes)
- id of referenced type (for attributes)
- id of the realized node
- abstraction level
|-
|Empty Element Filler Composition
|A composition added to an empty platform level element to ensure that it has at least one attribute. (The presence of an empty element can be caused by certain types of projection traversals.)
| - id value of the filled element
- id of realized node
- id of type of created node
|-
|Composite Query
|A composite query is generated when the projection paths of the fields of a view cannot be expressed in a single query. Instead multiple queries are generated and combined in a composite query.
| - id of the view causing the generation
- the abstraction level of the generated composite query
|-
|Query Composition
|A composition of a generated composite query (above).
| - id of the view causing the generation
- the abstraction level of the generated composite query
- the index of the composition within the composite query
|-
|Query
|A query generated to represent the entity model traversals of a given view's fields' projection paths.
| - id of the view being represented
- the abstraction level of the generated query
- the index of the query (in cases when the view generates multiple queries to be combine in a composite)
|-
|Template
|Most templates get the xmi:id value of the view which generates them. However, when a view cannot be represented by a single query because of the heterogeneity of field projection paths, multiple templates are generated to related to each of the generated queries. The multiple templates will then be combined into a composite template. In this case, the composite template will receive the xmi:id value of the view and the templates it composes will get generated xmi:id values.
| - id of the view being represented
- the index of the template within the composite template
|-
|Template Composition
|The composition within a composite template pointing to the composed templates generated for reasons described above.
| - rolename of the composition element
- id of the template being composed
- id of the composite template
|-
|Participant Path Node
|Representation in the FACE format of participant path projections.
| - id of the participant node
- id of the attribute being traversed by the path node
- the index of the path node in the path
|-
|Duplicate Measurement System
|If measurement is found which has a different number of axes then the measurement system it references, a new measurement system will be created that is a copy of the original but with changes to which axes it combines.
| - id of original measurement system
|-
|Duplicate Reference Point
|A reference point element created to fill a duplicate measurement system.
| - id of original reference point
|-
|Duplicate Reference Point Part
|A reference point part created to fill a duplicate reference point.
| - id of original reference point part
|-
|Duplicate Coordinate System
|A coordinate system made to support a duplicate measurement system.
| - id of original coordinate system
|}

=== Diagrams (.png / .zip) ===
This option exports all the user-created diagrams and/or view traces as PGN files or in a ZIP archive if multiple are selected. Allows for the preview of diagram images with the preview and regenerate buttons.

[[File:Datamodel - Diagrams.png|border|800x800px]]

=== 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.

[[File:PHENOM Generate Datamodel - Skayl.png|border|.skayl / .xmi Model Export Options|800x800px]]

For more information on the export options, visit [[Skayl Export Options]].

=== 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]]

[[index.php?title=Category:UserGuide|0033_Data_Model_Generation]]

Data Model Generation

2026-09-10T15:55:28Z

Chris: /* Skayl (.skayl) */

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. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.

[[File:Datamodel - Face.png|border|800x800px]]

For more information on the export options, visit '''[[FACE Export Options]]'''.

Phenom's representation of data models is not a one-to-one match with the FACE format. Instead, upon the generation of a FACE file, the Phenom representation of the model is converted to FACE. The most prominent changes include the generation of LDM and PDM entity models and conversion of view nodes to queries and templates.

=== Generated Entity Model Content ===
Phenom does not handle LDM and PDM entity model content - only CDM entities and associations (elements) are represented. Upon conversion to a FACE model, logical and platform elements are generated if they are projected by view fields in the Phenom model. Compositions and participants (attributes) that have a type that references another element generate LDM and PDM attributes referencing corresponding LDM and PDM elements. Compositions that reference an observable as their type are generate logical and platform compositions referencing measurements and platform types used by the view fields projecting the conceptual composition. In cases where a single conceptual attribute is generated into several logical and/or platform attributes (because of the projection of that conceptual attributes by view fields using different measurements and/or platform types), in order to prevent name conflicts, the rolenames of the generated attributes are augmented with the names of the measurements and platform types to which they relate.

==== Generated Queries and Templates ====
Phenom represents interface documentation as views with fields that have projection paths through the conceptual entity model and reference a measurement and a platform type. Each view is converted to a template (platform template for FACE 3.0 and uop template for FACE 3.1/3.2) and a related platform query.

The specification of the generated query is written to capture the combination of projections through the entity model expressed in the projection paths documented on the fields of the converted view (and any views that are contained as the top-view's sub-structures). While the view field projection paths documented in Phenom traverse the conceptual entity model, the query is written traversing the platform entity model that was generated as part of the conversion to FACE.

The specification of the generated template is written to reference the related query and represent the structure of the Phenom view being converted. View fields that references other views as their type result in either the addition of a `using` statement to the template specification or the expression of a sub-structure within the template specification; which is used is based on the 'Private Nesting' setting on the view field in Phenom.

==== Retention Artifact Recovery ====
Normally, Phenom will generate content necessary for the FACE model format during FACE model generation as described above. However, it is also possible to use content from the original model by using import artifact recovery during generation.

During model file import, a user has the option to retain certain model elements (including LDM and PDM entity model content and query and template nodes) that are not handled by Phenom. If this is done, then during FACE model export the user can attempt to recover the retained content. Doing this will result in the addition of the content originally retained into the model and the favoring of re-use of re-introduced content over the generation of new content. For example, if logical and platform entities and compositions needed to project a given view field are recovered from the retention artifact, that recovered content will be traversed by the platform query and new LDM/PDM elements will not be generated. Similarly a retained query name and id can be re-used when a view is converted instead of a new query being generated; even the specification of the query will be re-used if it is detected that the view has not been changed since the original import.

==== Generated Node GUID Values ====
In order to achieve repeatable results, when new content is generated during FACE conversion, the xmi:id values of the generated content is derived based on related properties.
{| class="wikitable"
|+
!Generated Node
!Reason For Generation
!Derived GUID Determiners
|-
|Identifier Composition
|A conceptual level element missing a composition of type Identifier or a specializing element that lacks a novel attribute.
| - id value of the affected element
- name of the added composition.
|-
|Realizing Entity Model Node
|An entity model element or attribute being generated to the LDM or PDM level because it is projected by a view field and thus will be traversed by a logical or platform level query specification.
| - name/rolename
- bounds (for attributes)
- id of referenced type (for attributes)
- id of the realized node
- abstraction level
|-
|Empty Element Filler Composition
|A composition added to an empty platform level element to ensure that it has at least one attribute. (The presence of an empty element can be caused by certain types of projection traversals.)
| - id value of the filled element
- id of realized node
- id of type of created node
|-
|Composite Query
|A composite query is generated when the projection paths of the fields of a view cannot be expressed in a single query. Instead multiple queries are generated and combined in a composite query.
| - id of the view causing the generation
- the abstraction level of the generated composite query
|-
|Query Composition
|A composition of a generated composite query (above).
| - id of the view causing the generation
- the abstraction level of the generated composite query
- the index of the composition within the composite query
|-
|Query
|A query generated to represent the entity model traversals of a given view's fields' projection paths.
| - id of the view being represented
- the abstraction level of the generated query
- the index of the query (in cases when the view generates multiple queries to be combine in a composite)
|-
|Template
|Most templates get the xmi:id value of the view which generates them. However, when a view cannot be represented by a single query because of the heterogeneity of field projection paths, multiple templates are generated to related to each of the generated queries. The multiple templates will then be combined into a composite template. In this case, the composite template will receive the xmi:id value of the view and the templates it composes will get generated xmi:id values.
| - id of the view being represented
- the index of the template within the composite template
|-
|Template Composition
|The composition within a composite template pointing to the composed templates generated for reasons described above.
| - rolename of the composition element
- id of the template being composed
- id of the composite template
|-
|Participant Path Node
|Representation in the FACE format of participant path projections.
| - id of the participant node
- id of the attribute being traversed by the path node
- the index of the path node in the path
|-
|Duplicate Measurement System
|If measurement is found which has a different number of axes then the measurement system it references, a new measurement system will be created that is a copy of the original but with changes to which axes it combines.
| - id of original measurement system
|-
|Duplicate Reference Point
|A reference point element created to fill a duplicate measurement system.
| - id of original reference point
|-
|Duplicate Reference Point Part
|A reference point part created to fill a duplicate reference point.
| - id of original reference point part
|-
|Duplicate Coordinate System
|A coordinate system made to support a duplicate measurement system.
| - id of original coordinate system
|}

=== Diagrams (.png / .zip) ===
This option exports all the user-created diagrams and/or view traces as PGN files or in a ZIP archive if multiple are selected. Allows for the preview of diagram images with the preview and regenerate buttons.

[[File:Datamodel - Diagrams.png|border|800x800px]]

=== 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.

[[File:PHENOM Generate Datamodel - Skayl.png|thumb|.skayl / .xmi Model Export Options]]

For more information on the export options, visit [[Skayl Export Options]].

=== 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]]

[[index.php?title=Category:UserGuide|0033_Data_Model_Generation]]

File:PHENOM Generate Datamodel - Skayl.png

2026-09-10T15:55:07Z

Chris:

.xmi / .skayl Model Export Options

Skayl Export Options

2026-09-10T15:54:00Z

Chris: Created page with "===Exclude Deprecated Content=== {{Checkbox Option |name=Exclude Deprecated Content |default=Unchecked |values=Checked / Unchecked |summary=Removes all elements marked as deprecated from the exported model. |details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information. |language=ini }} ====Exclude Deprecation Dependents==== {{Checkbox Option |name=Exclude..."

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

====Exclude Deprecation Dependents====
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate a new model rather than send a cached model (if available).

|details=PHENOM caches models upon export. If model content does not change and the export options remain the same, the cached model will be sent when the model is downloaded. If the ''project'' description or name changes, use this option to regenerate the model with the updated values. Alternatively, this option may be necessary if there have been updates to the FACE Export function.

|language=ini
}}

Data Model Generation

2026-09-10T15:53:05Z

Chris: /* Skayl (.skayl) */

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. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.

[[File:Datamodel - Face.png|border|800x800px]]

For more information on the export options, visit '''[[FACE Export Options]]'''.

Phenom's representation of data models is not a one-to-one match with the FACE format. Instead, upon the generation of a FACE file, the Phenom representation of the model is converted to FACE. The most prominent changes include the generation of LDM and PDM entity models and conversion of view nodes to queries and templates.

=== Generated Entity Model Content ===
Phenom does not handle LDM and PDM entity model content - only CDM entities and associations (elements) are represented. Upon conversion to a FACE model, logical and platform elements are generated if they are projected by view fields in the Phenom model. Compositions and participants (attributes) that have a type that references another element generate LDM and PDM attributes referencing corresponding LDM and PDM elements. Compositions that reference an observable as their type are generate logical and platform compositions referencing measurements and platform types used by the view fields projecting the conceptual composition. In cases where a single conceptual attribute is generated into several logical and/or platform attributes (because of the projection of that conceptual attributes by view fields using different measurements and/or platform types), in order to prevent name conflicts, the rolenames of the generated attributes are augmented with the names of the measurements and platform types to which they relate.

==== Generated Queries and Templates ====
Phenom represents interface documentation as views with fields that have projection paths through the conceptual entity model and reference a measurement and a platform type. Each view is converted to a template (platform template for FACE 3.0 and uop template for FACE 3.1/3.2) and a related platform query.

The specification of the generated query is written to capture the combination of projections through the entity model expressed in the projection paths documented on the fields of the converted view (and any views that are contained as the top-view's sub-structures). While the view field projection paths documented in Phenom traverse the conceptual entity model, the query is written traversing the platform entity model that was generated as part of the conversion to FACE.

The specification of the generated template is written to reference the related query and represent the structure of the Phenom view being converted. View fields that references other views as their type result in either the addition of a `using` statement to the template specification or the expression of a sub-structure within the template specification; which is used is based on the 'Private Nesting' setting on the view field in Phenom.

==== Retention Artifact Recovery ====
Normally, Phenom will generate content necessary for the FACE model format during FACE model generation as described above. However, it is also possible to use content from the original model by using import artifact recovery during generation.

During model file import, a user has the option to retain certain model elements (including LDM and PDM entity model content and query and template nodes) that are not handled by Phenom. If this is done, then during FACE model export the user can attempt to recover the retained content. Doing this will result in the addition of the content originally retained into the model and the favoring of re-use of re-introduced content over the generation of new content. For example, if logical and platform entities and compositions needed to project a given view field are recovered from the retention artifact, that recovered content will be traversed by the platform query and new LDM/PDM elements will not be generated. Similarly a retained query name and id can be re-used when a view is converted instead of a new query being generated; even the specification of the query will be re-used if it is detected that the view has not been changed since the original import.

==== Generated Node GUID Values ====
In order to achieve repeatable results, when new content is generated during FACE conversion, the xmi:id values of the generated content is derived based on related properties.
{| class="wikitable"
|+
!Generated Node
!Reason For Generation
!Derived GUID Determiners
|-
|Identifier Composition
|A conceptual level element missing a composition of type Identifier or a specializing element that lacks a novel attribute.
| - id value of the affected element
- name of the added composition.
|-
|Realizing Entity Model Node
|An entity model element or attribute being generated to the LDM or PDM level because it is projected by a view field and thus will be traversed by a logical or platform level query specification.
| - name/rolename
- bounds (for attributes)
- id of referenced type (for attributes)
- id of the realized node
- abstraction level
|-
|Empty Element Filler Composition
|A composition added to an empty platform level element to ensure that it has at least one attribute. (The presence of an empty element can be caused by certain types of projection traversals.)
| - id value of the filled element
- id of realized node
- id of type of created node
|-
|Composite Query
|A composite query is generated when the projection paths of the fields of a view cannot be expressed in a single query. Instead multiple queries are generated and combined in a composite query.
| - id of the view causing the generation
- the abstraction level of the generated composite query
|-
|Query Composition
|A composition of a generated composite query (above).
| - id of the view causing the generation
- the abstraction level of the generated composite query
- the index of the composition within the composite query
|-
|Query
|A query generated to represent the entity model traversals of a given view's fields' projection paths.
| - id of the view being represented
- the abstraction level of the generated query
- the index of the query (in cases when the view generates multiple queries to be combine in a composite)
|-
|Template
|Most templates get the xmi:id value of the view which generates them. However, when a view cannot be represented by a single query because of the heterogeneity of field projection paths, multiple templates are generated to related to each of the generated queries. The multiple templates will then be combined into a composite template. In this case, the composite template will receive the xmi:id value of the view and the templates it composes will get generated xmi:id values.
| - id of the view being represented
- the index of the template within the composite template
|-
|Template Composition
|The composition within a composite template pointing to the composed templates generated for reasons described above.
| - rolename of the composition element
- id of the template being composed
- id of the composite template
|-
|Participant Path Node
|Representation in the FACE format of participant path projections.
| - id of the participant node
- id of the attribute being traversed by the path node
- the index of the path node in the path
|-
|Duplicate Measurement System
|If measurement is found which has a different number of axes then the measurement system it references, a new measurement system will be created that is a copy of the original but with changes to which axes it combines.
| - id of original measurement system
|-
|Duplicate Reference Point
|A reference point element created to fill a duplicate measurement system.
| - id of original reference point
|-
|Duplicate Reference Point Part
|A reference point part created to fill a duplicate reference point.
| - id of original reference point part
|-
|Duplicate Coordinate System
|A coordinate system made to support a duplicate measurement system.
| - id of original coordinate system
|}

=== Diagrams (.png / .zip) ===
This option exports all the user-created diagrams and/or view traces as PGN files or in a ZIP archive if multiple are selected. Allows for the preview of diagram images with the preview and regenerate buttons.

[[File:Datamodel - Diagrams.png|border|800x800px]]

=== 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.

For more information on the export options, visit [[Skayl Export Options]].

=== 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]]

[[index.php?title=Category:UserGuide|0033_Data_Model_Generation]]

FACE Export Options

2026-09-10T15:49:08Z

Chris: /* Export LDM Queries */

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate conceptual queries in the exported model.
|details=Conceptual queries are not natively handled by PHENOM. This option will ensure that conceptual queries are generated and added to the exported model.
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate logical queries in the exported model.

|details=Logical queries are not natively handled by PHENOM. This option will ensure that logical queries are generated and added to the exported model.

|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models|Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

====Re-save Retention Artifacts====
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

====Exclude Deprecation Dependents====
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate a new model rather than send a cached model (if available).

|details=PHENOM caches models upon export. If model content does not change and the export options remain the same, the cached model will be sent when the model is downloaded. If the ''project'' description or name changes, use this option to regenerate the model with the updated values. Alternatively, this option may be necessary if there have been updates to the FACE Export function.

|language=ini
}}

FACE Export Options

2026-09-10T15:48:39Z

Chris: /* Export CDM Queries */

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate conceptual queries in the exported model.
|details=Conceptual queries are not natively handled by PHENOM. This option will ensure that conceptual queries are generated and added to the exported model.
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models|Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

====Re-save Retention Artifacts====
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

====Exclude Deprecation Dependents====
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate a new model rather than send a cached model (if available).

|details=PHENOM caches models upon export. If model content does not change and the export options remain the same, the cached model will be sent when the model is downloaded. If the ''project'' description or name changes, use this option to regenerate the model with the updated values. Alternatively, this option may be necessary if there have been updates to the FACE Export function.

|language=ini
}}

FACE Export Options

2026-09-10T15:45:55Z

Chris: /* Force Regeneration */

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models|Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

====Re-save Retention Artifacts====
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

====Exclude Deprecation Dependents====
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=Generate a new model rather than send a cached model (if available).

|details=PHENOM caches models upon export. If model content does not change and the export options remain the same, the cached model will be sent when the model is downloaded. If the ''project'' description or name changes, use this option to regenerate the model with the updated values. Alternatively, this option may be necessary if there have been updates to the FACE Export function.

|language=ini
}}

Model Import Options

2026-09-10T15:40:15Z

Chris: /* Retain Entity Models */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

|details=Normally, PHENOM’s import discards queries and re-generates them upon export. This approach, however, fails to preserve the exact values stored in query element attributes, including the GUID, name, description, and specification. By choosing to retain queries, a user is able to re-introduce them upon export. This preserves the GUID, name, and description of the queries. Additionally, if the semantics of the related view were not changed by the user, the specification will also be preserved.

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected. This should be used in conjunction with the corresponding [[FACE Export Options#Recover Retention Artifacts|Recover Retention Artifacts]].

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. By default, this content is removed upon import. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

FACE Export Options

2026-09-10T15:39:57Z

Chris: /* Recover Retention Artifacts */

FACE Export Options

2026-09-10T15:37:36Z

Chris: /* Exclude Deprecation Dependents */

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

====Re-save Retention Artifacts====
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

====Exclude Deprecation Dependents====
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

FACE Export Options

2026-09-10T15:37:22Z

Chris: /* Re-save Retention Artifacts */

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

====Re-save Retention Artifacts====
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

===Exclude Deprecation Dependents===
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

FACE Export Options

2026-09-10T15:36:06Z

Chris: Created page with "===Export CDM Queries=== {{Checkbox Option |name=Export CDM Queries |default=Unchecked |values=Checked / Unchecked |summary=ABC |details=ABC |language=ini }} ===Export LDM Queries=== {{Checkbox Option |name=Export LDM Queries |default=Unchecked |values=Checked / Unchecked |summary=ABC |details=ABC |language=ini }} ===Recover Retention Artifacts=== {{Checkbox Option |name=Recover Retention Artifacts |default=Unchecked |values=Checked / Unchecked |summ..."

===Export CDM Queries===
{{Checkbox Option
|name=Export CDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Export LDM Queries===
{{Checkbox Option
|name=Export LDM Queries
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

===Recover Retention Artifacts===
{{Checkbox Option
|name=Recover Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Used in conjunction with [[Model Import Options#Retain Entity Models]].
|details=When a FACE model is imported into Phenom, some nodes may be removed. However, these nodes can be recovered if the Retain options were selected during import. 
The reintroduced nodes will preserve their FACE UUIDs and namespaces. The types of nodes that can be reintroduced include:
<ul>
<li>CDM Queries</li>
<li>LDM Queries</li>
<li>LDM Entity Model - logical entity, association, composition, and participants </li>
<li>PDM Entity Model - platform entity, association, composition, and participants </li>
</ul>

|language=ini
}}

===Re-save Retention Artifacts===
{{Checkbox Option
|name=Re-save Retention Artifacts
|default=Unchecked
|values=Checked / Unchecked
|summary=Save updated to retained content so it may be recovered again in future exports.

|details=When retained nodes are reintroduced, their attributes are preserved. However, the model structure may have changed over time and the reintroduced nodes may be updated to meet FACE-conformant standards. By re-saving the Retention Artifacts, the new updates will be stored and can be recovered again on subsequent FACE exports.

|language=ini
}}

===Exclude Deprecated Content===
{{Checkbox Option
|name=Exclude Deprecated Content
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements marked as deprecated from the exported model.

|details=Excluding deprecated content removes all elements marked as deprecated during model generation. This ensures your results contain only up-to-date information.

|language=ini
}}

===Exclude Deprecation Dependents===
{{Checkbox Option
|name=Exclude Deprecation Dependents
|default=Unchecked
|values=Checked / Unchecked
|summary=Removes all elements that depend on deprecated content.
|details=Excluding dependents of deprecated content adds further deletions by removing elements that depend on deprecated content. If not selected, deprecated content with dependents will not be deleted.

|language=ini
}}

===Force Regeneration===
{{Checkbox Option
|name=Force Regeneration
|default=Unchecked
|values=Checked / Unchecked
|summary=ABC
|details=ABC
|language=ini
}}

Model Import Options

2026-09-10T15:35:50Z

Chris: /* Retain Entity Models */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

|details=Normally, PHENOM’s import discards queries and re-generates them upon export. This approach, however, fails to preserve the exact values stored in query element attributes, including the GUID, name, description, and specification. By choosing to retain queries, a user is able to re-introduce them upon export. This preserves the GUID, name, and description of the queries. Additionally, if the semantics of the related view were not changed by the user, the specification will also be preserved.

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected. This should be used in conjunction with the corresponding [[FACE Export Options#Recover Retention Artifacts]].

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. By default, this content is removed upon import. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

File:Datamodel - Face.png

2026-09-10T14:27:43Z

Chris: Chris uploaded a new version of File:Datamodel - Face.png

Face

Data Model Generation

2026-09-10T14:08:08Z

Chris: /* Generate Models & Artifacts */

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. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.

[[File:Datamodel - Face.png|border|800x800px]]

For more information on the export options, visit '''[[FACE Export Options]]'''.

Phenom's representation of data models is not a one-to-one match with the FACE format. Instead, upon the generation of a FACE file, the Phenom representation of the model is converted to FACE. The most prominent changes include the generation of LDM and PDM entity models and conversion of view nodes to queries and templates.

=== Generated Entity Model Content ===
Phenom does not handle LDM and PDM entity model content - only CDM entities and associations (elements) are represented. Upon conversion to a FACE model, logical and platform elements are generated if they are projected by view fields in the Phenom model. Compositions and participants (attributes) that have a type that references another element generate LDM and PDM attributes referencing corresponding LDM and PDM elements. Compositions that reference an observable as their type are generate logical and platform compositions referencing measurements and platform types used by the view fields projecting the conceptual composition. In cases where a single conceptual attribute is generated into several logical and/or platform attributes (because of the projection of that conceptual attributes by view fields using different measurements and/or platform types), in order to prevent name conflicts, the rolenames of the generated attributes are augmented with the names of the measurements and platform types to which they relate.

==== Generated Queries and Templates ====
Phenom represents interface documentation as views with fields that have projection paths through the conceptual entity model and reference a measurement and a platform type. Each view is converted to a template (platform template for FACE 3.0 and uop template for FACE 3.1/3.2) and a related platform query.

The specification of the generated query is written to capture the combination of projections through the entity model expressed in the projection paths documented on the fields of the converted view (and any views that are contained as the top-view's sub-structures). While the view field projection paths documented in Phenom traverse the conceptual entity model, the query is written traversing the platform entity model that was generated as part of the conversion to FACE.

The specification of the generated template is written to reference the related query and represent the structure of the Phenom view being converted. View fields that references other views as their type result in either the addition of a `using` statement to the template specification or the expression of a sub-structure within the template specification; which is used is based on the 'Private Nesting' setting on the view field in Phenom.

==== Retention Artifact Recovery ====
Normally, Phenom will generate content necessary for the FACE model format during FACE model generation as described above. However, it is also possible to use content from the original model by using import artifact recovery during generation.

During model file import, a user has the option to retain certain model elements (including LDM and PDM entity model content and query and template nodes) that are not handled by Phenom. If this is done, then during FACE model export the user can attempt to recover the retained content. Doing this will result in the addition of the content originally retained into the model and the favoring of re-use of re-introduced content over the generation of new content. For example, if logical and platform entities and compositions needed to project a given view field are recovered from the retention artifact, that recovered content will be traversed by the platform query and new LDM/PDM elements will not be generated. Similarly a retained query name and id can be re-used when a view is converted instead of a new query being generated; even the specification of the query will be re-used if it is detected that the view has not been changed since the original import.

==== Generated Node GUID Values ====
In order to achieve repeatable results, when new content is generated during FACE conversion, the xmi:id values of the generated content is derived based on related properties.
{| class="wikitable"
|+
!Generated Node
!Reason For Generation
!Derived GUID Determiners
|-
|Identifier Composition
|A conceptual level element missing a composition of type Identifier or a specializing element that lacks a novel attribute.
| - id value of the affected element
- name of the added composition.
|-
|Realizing Entity Model Node
|An entity model element or attribute being generated to the LDM or PDM level because it is projected by a view field and thus will be traversed by a logical or platform level query specification.
| - name/rolename
- bounds (for attributes)
- id of referenced type (for attributes)
- id of the realized node
- abstraction level
|-
|Empty Element Filler Composition
|A composition added to an empty platform level element to ensure that it has at least one attribute. (The presence of an empty element can be caused by certain types of projection traversals.)
| - id value of the filled element
- id of realized node
- id of type of created node
|-
|Composite Query
|A composite query is generated when the projection paths of the fields of a view cannot be expressed in a single query. Instead multiple queries are generated and combined in a composite query.
| - id of the view causing the generation
- the abstraction level of the generated composite query
|-
|Query Composition
|A composition of a generated composite query (above).
| - id of the view causing the generation
- the abstraction level of the generated composite query
- the index of the composition within the composite query
|-
|Query
|A query generated to represent the entity model traversals of a given view's fields' projection paths.
| - id of the view being represented
- the abstraction level of the generated query
- the index of the query (in cases when the view generates multiple queries to be combine in a composite)
|-
|Template
|Most templates get the xmi:id value of the view which generates them. However, when a view cannot be represented by a single query because of the heterogeneity of field projection paths, multiple templates are generated to related to each of the generated queries. The multiple templates will then be combined into a composite template. In this case, the composite template will receive the xmi:id value of the view and the templates it composes will get generated xmi:id values.
| - id of the view being represented
- the index of the template within the composite template
|-
|Template Composition
|The composition within a composite template pointing to the composed templates generated for reasons described above.
| - rolename of the composition element
- id of the template being composed
- id of the composite template
|-
|Participant Path Node
|Representation in the FACE format of participant path projections.
| - id of the participant node
- id of the attribute being traversed by the path node
- the index of the path node in the path
|-
|Duplicate Measurement System
|If measurement is found which has a different number of axes then the measurement system it references, a new measurement system will be created that is a copy of the original but with changes to which axes it combines.
| - id of original measurement system
|-
|Duplicate Reference Point
|A reference point element created to fill a duplicate measurement system.
| - id of original reference point
|-
|Duplicate Reference Point Part
|A reference point part created to fill a duplicate reference point.
| - id of original reference point part
|-
|Duplicate Coordinate System
|A coordinate system made to support a duplicate measurement system.
| - id of original coordinate system
|}

=== Diagrams (.png / .zip) ===
This option exports all the user-created diagrams and/or view traces as PGN files or in a ZIP archive if multiple are selected. Allows for the preview of diagram images with the preview and regenerate buttons.

[[File:Datamodel - Diagrams.png|border|800x800px]]

=== 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]]

[[index.php?title=Category:UserGuide|0033_Data_Model_Generation]]

File:Datamodel - Face.png

2026-09-10T14:06:31Z

Chris: Chris uploaded a new version of File:Datamodel - Face.png

Face

Model Import Options

2026-09-10T13:55:57Z

Chris: /* Retain Auto Generated Content */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

|details=Normally, PHENOM’s import discards queries and re-generates them upon export. This approach, however, fails to preserve the exact values stored in query element attributes, including the GUID, name, description, and specification. By choosing to retain queries, a user is able to re-introduce them upon export. This preserves the GUID, name, and description of the queries. Additionally, if the semantics of the related view were not changed by the user, the specification will also be preserved.

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected. This should be used in conjunction with the corresponding Model Export Option.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. By default, this content is removed upon import. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:54:50Z

Chris: /* Retain Entity Models */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

|details=Normally, PHENOM’s import discards queries and re-generates them upon export. This approach, however, fails to preserve the exact values stored in query element attributes, including the GUID, name, description, and specification. By choosing to retain queries, a user is able to re-introduce them upon export. This preserves the GUID, name, and description of the queries. Additionally, if the semantics of the related view were not changed by the user, the specification will also be preserved.

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected. This should be used in conjunction with the corresponding Model Export Option.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:50:29Z

Chris: /* Retain Queries */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

|details=Normally, PHENOM’s import discards queries and re-generates them upon export. This approach, however, fails to preserve the exact values stored in query element attributes, including the GUID, name, description, and specification. By choosing to retain queries, a user is able to re-introduce them upon export. This preserves the GUID, name, and description of the queries. Additionally, if the semantics of the related view were not changed by the user, the specification will also be preserved.

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:48:40Z

Chris: /* Process CDM Queries */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:48:24Z

Chris: /* Process LDM Queries */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled in with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=Phenom does not natively maintain logical queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The platform attributes will be filled with placeholder values; updating these provides an easy way to realize the imported logical queries into exported platform queries and templates.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:47:38Z

Chris: /* Process CDM Queries */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=Phenom does not natively maintain conceptual queries. However, it can capture the projections encoded in those queries by turning them into views in which each of the query’s select clauses is turned into a field. The logical and platform attributes will be filled in with placeholder values; updating these provides an easy way to realize the imported conceptual queries into exported logical and platform queries and templates.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:44:13Z

Chris: /* Unbounded CDM Mode */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (0..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=PHENOM does not store or process Conceptual Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Conceptual Queries are retained when imported. This uses the query-specified observables and creates generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:43:08Z

Chris: /* Fix View Characteristics w/o name */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this only applies to FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (1..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=PHENOM does not store or process Conceptual Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Conceptual Queries are retained when imported. This uses the query-specified observables and creates generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:42:50Z

Chris: /* Fix View Characteristics w/o name */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix View Characteristics w/o name
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import. Note: this option only affects FACE v2.1 models.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (1..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=PHENOM does not store or process Conceptual Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Conceptual Queries are retained when imported. This uses the query-specified observables and creates generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-10T13:41:59Z

Chris: /* Fix paths not ending in Observable */

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute. Note: this only applies to FACE v2.1 models.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (1..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=PHENOM does not store or process Conceptual Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Conceptual Queries are retained when imported. This uses the query-specified observables and creates generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Projects and Models Management

2026-09-09T18:53:01Z

Chris:

== Projects & Models 101 ==
A '''project''' in PHENOM is composed of one or more models which are loaded together into a workspace.
A '''model''' is a collection of nodes. A node can be an entity, an association, an observable, a view…
One objective of a project is to be:
* Independent
* Complete: reflect the reality to the best of its ability
* Compliant
* Valid (or at least "validatable ")
A model in and of itself might not constitute a complete, compliant, or even valid project as it might depend on entities inside other models, making it impossible to load independently. However, by combining several models in a project, they can form a complete, compliant, and valid model.

[[File:Phenom-manage-project model structure1.png|600px|border]]

The following diagram depicts how a model can be part of multiple projects.

[[File:Phenom-manage-project model structure2.png|600px|border]]

Once a project is loaded into PHENOM, the node contents of its constituent models can be added to as well as edited.

== Projects Management ==
When in PHENOM > Manage Models > Projects, the user can see the projects and models they have access to.

[[File:Phenom-manage-projects models list.png|500px|border]]

The project you are currently working on is displayed at the top of all the pages. Additionally, in the Manage Projects page, the active project is the expanded by default and has a different icon.

[[File:Phenom-manage-active project.png|600px|border]]

To create a project, the user can click on the + button in the Projects list and then select existing models, import new FACE models, or add new blank models.

[[File:Phenom-manage-new project.png|600px|border]]

There are three ways a user can have access to a project or a model:
* The user creates it
* The user uploads it
* The user is assigned permissions from an external user
The user will see, for each model, its inheritors and versions.

The user can easily switch between projects in the Projects Management page.

[[File:Phenom-manage-switch-project-2.png|border|800x800px]]

== Model Versions ==
In PHENOM, models maintain the content as well as the record of changes made to that content.

By default, each model has a "live" version. This is the version of the model which, when loaded in a project can be edited and amended.

When the user is satisfied with the current state of a model, they can publish it, thus creating a “static” version of that model. A published version of a model is a snapshot of its content at one point in time. It cannot be added to or edited but can still be included in a project, referenced by and depended upon by the contents of a different model.

In the example below, the model version FACE_SDM_306 and FACE_SDM_316 are a "published" version of the FACE_SDM model. While it can be shared with other users, included in a project, and referred to and depended upon by other models, it can never be edited. In the Model tree, all published models have their publication dates displayed for ease of use.

[[File:Phenom-manage-published model.png|600px|border]]

== Model Inheritance & Content Merging ==
The same model can be loaded as a part of several different projects. However, the users of those projects will not be able to edit the content of the model simultaneously.
When a user chooses to include in a project a model which is already a part of a different project, a "child" model will be created. This inheriting or "child" model is not a different version of a model, but rather its own model which inherits some portion of its content.
At first, the inheriting and the parent models are identical but as their respective user make changes, they grow apart. Therefore, it’s possible for this "child" model to merge its changes to and from the parent model.
A user can see the relationships between models in Manage Models > Projects > Model.
In this example, the model Coffee is the parent of the model Coffee_in_Coffee_2. This results from the Coffee_live version of the Coffee model being loaded into a new project. When edits are made in either the parent or child model, the changes can be merged between them.

[[File:Phenom-manage-model branching.png|600px|border]]

Clicking on a live or published model will display its characteristics on the right panel. The user will be able to edit some of the model's characteristics and the permissions of the model, provided the user has Admin or Owner privileges for that model.

[[File:Phenom-manage-model details2.png|border|800x800px]]

== New Project (Load Model) ==
[[Creating a Project from an Existing Model]]

== Copy Project (Create Branch) ==
Copying a project allows for easy cloning of project content with just a click of a button. The resulting project will contain a child of all the live models of the source project and the same published models.

To copy a project, the user just needs to select a project from their project tree and click the copy project icon on the top-right.
[[File:Manage - Copybtn.png|none|800px]]
The copy project screen closely resembles the project creation screen, requiring the user to input a new name and description for the new project. Additionally, the user must choose whether to copy the existing permissions from the source project to the copied project before saving.
[[File:Manage - CopyCreate.png|none|800px]]

== PHENOM-Managed SDMs ==
PHENOM comes loaded with official FACE Shared Data Models (SDMs) for FACE Technical Standard Editions 2.1, 3.0, 3.1, and 3.2.

=== Creating a Project with an SDM ===
The user can create a project by importing a model file and/or selecting existing model.

If the user choses to import a model file containing an SDM, PHENOM will try to replace it with its managed version. This will allow the user to benefit from the ability to update SDM version in the future.
During import, PHENOM will scan the model and if it detects a <dm/> node with the exact same name as one of the managed SDM model, it will try to replace it. However, if the imported SDM model contains more content than what is present in the "official" SDM, the swap will not occur (e.g. a custom measurement was added to package inside the SDM).

If for some reason, an expected SDM doesn't swap to a PHENOM-managed SDM, the user can proceed as follows to manually do it:
# Click on Create New Model and import the model file; this may lead to several models being created from the original file
# Click on Create New Project, and instead of uploading a file, select all the models that were created in step 1 except for the SDM one. Instead of selecting that SDM model, select one of the PHENOM-managed SDM models
# (Optional) Delete the SDM model that was created in step 1

Alternatively, the user can chose to create the project by using one of the SDMs in the list of existing models.

=== Update a Project's SDM model ===

If the project contains a PHENOM-managed SDM, the user has the ability to switch between versions of the SDM on the Project details page.

If the project contains a custom version of an SDM, it is possible to replace it with a PHENOM-managed. To do so, the user needs to follow these steps:
# Delete the original project containing the custom SDM. In the confirmation window, DO '''NOT''' select any constituent models for deletion
# Create a new project, and instead of uploading a file, select all the models that were included in the original deleted project except for the SDM one, and of the PHENOM-managed SDM models
# (Optional) Delete the custom SDM model

== Sample Workflow ==
This section goes over a sample workflow which employs the PHENOM project and model structure concepts described in the sections above.
In the scenario laid out below, a group of users, Chris, Dave, Nick, and Riley are working on different parts of completing a data model and documenting a set of interfaces against it. Each of them plays a slightly different role in the process, and they will use some of PHENOM's Model management features to keep their work organized.

=== Part 1 – Chris ===
Chris is working on updating the Shared Data Model (SDM) the group is using to conform to the latest changes released in an accepted standard. The user loads an SDM content file to create a model.
[[File:Workflow-newModel.png|border|800px]]

[[File:Worlflow - CreatedSubmodel.png|border|300px]]

The user loads the model into an SDM_Editor project and begins to make the changes.

[[File:Worlflow - CreatingProject.png|border|800px]]

[[File:Workflow - SwitchProject.png|border|300px]]

Once the user has made the changes necessary to match a decided-upon standard, the user publishes a version v1 of his SDM model.

[[File:Workflow - PublishProject.png|border|300px]] [[File:Worklow - PublishedModel.png|border|300px]]

Chris is going to make further changes in the SDM_Editor project, but that will be for the next standard update. In the meantime, the user wants to make the static version of the SDM they just published available to the rest of his team, so the user gives them Read permissions to it. However, making further changes to the SDM is his job and the user wants to stay in control of the process, so the user does not give any of his colleagues permissions to either the live version of the SDM model or the SDM_Editor project.

[[File:Phenom-manage-example-chris-7.png|border|800px]]

=== Part 2 – Dave ===
Dave is working on creating a Domain Specific Data Model (DSDM) for the team to use - he will be referencing the SDM Chris released in his efforts. He creates a new project into which he adds the SDM version he has access to and a blank model which will contain the DSDM content he creates.

[[File:Workflow - Davecreate project.png|border|800px]]

After Dave has added some content to his DSDM model which references nodes in the SDM, he will see that his DSDM model is now listed as dependent on the SDM model he has been using – which means, it can no longer be loaded without it.

[[File:Workflow - Dependencies.png|border|800px]]

Nick and Riley will be documenting some interfaces against the domain model that Dave is working on. However, Dave does not want them to have to wait for him to have finished with all of his work before they can start. Also, as they work on their interface documentation, they may come up with good changes to the DSDM and suggest that they be included in Dave's work. So, Dave decided to share his project with Nick and Riley, giving them Read/Write permissions, which automatically gives them permissions to the active DSDM model version he's working on.

[[File:Phenom-manage-example-dave-4.png|border|800px]]

=== Part 3 – Nick & Riley ===
Nick and Riley will be documenting interfaces using the DSDM that was shared with them, but they will be working with different sets of interfaces, each in his own project.
If they try to create a new project with just the DSDM, they will be rejected because they must also load in the SDM that was used to create it and on which it depends.

[[File:Workflow - DepFailure.png|border|800px]]

Once they have the appropriate permissions to all of the content, they can create their individual project with the models to house their documentation work separate from the contents of both the SDM and the DSDM.
In the example below, Riley creates a RILEY_s_INTFC_DOC project including the DSDM_live model and a new blank model for his changes. By doing so, a new model, DSDM_IN_RILEY_S_INTFC_DOC, was created, inheriting from Dave’s DSDM_live.

[[File:Manage workflow - Final2.png|border|800px]]

Dave and Riley will now be able to independently edit DSDM content and merge changes between their two models as they see appropriate.
Whenever Dave makes new updates to the DSDM, Nick and Riley have the opportunity to pull in those changes into their copies of the model. When either one of them makes a change to the DSDM portion of his project that he thinks should be included in the official version, they can make a push request to Dave's project that he can then either approve or ignore.

[[Category:UserGuide|0037_Projects_and_Models_Management]]

Template:Checkbox Option

2026-09-09T18:48:09Z

Chris:

<includeonly>
{| class="wikitable"
! Property
! Value
|-
| '''Option'''
| <code>{{{name}}}</code>
|-
| '''Default'''
| <code>{{{default}}}</code>
|-
| '''Allowed values'''
| {{{values|Not specified}}}
|}
'''Summary:''' {{{summary}}}

'''Details:'''
{{{details}}}
</includeonly>
<noinclude>
== Usage ==
<pre>
{{Checkbox Option
|name=enableLogging
|default=true
|values=true or false
|summary=Enables application logging.
|details=When selected, the application writes operational messages to the configured log.
}}
</pre>
</noinclude>

Model Import Options

2026-09-09T18:47:35Z

Chris:

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

=Import Checks/Fixes=
===Assert IDs===
{{Checkbox Option
|name=Assert IDs
|default=Checked
|values=Checked / Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The FACE Technical Standard requires every entity & association to have an identifier attribute to be a "valid" model. When enabled, this option ensures the identifier is added to the model as needed to satisfy the identifier requirement. NOTE: If an entity/association is a specialization, the identifier may not exist in the entity itself, but it must exist somewhere in the inheritance chain.
|language=ini
}}

===Fix paths not ending in Observable===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked
|summary=If a path ends in an entity or association, this will find an attribute in the entity and terminate on that instead.
|details=Although allowed by the FACE Technical Standard, pointing to an entire entity (or association) limits model extensibility. This import option fixes your model by moving that endpoint from the entity to an attribute.
|language=ini
}}

===Fix View Characteristics w/o name===
{{Checkbox Option
|name=Fix paths not ending in Observable
|default=Checked
|values=Checked / Unchecked

|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.

|details=The FACE Technical Standard allows the name to be omitted from a view attribute. When this is done and a name is needed (e.g., during data type generation), the names are used from the corresponding attribute in the entity model. This option makes the names explicit at the time of import.

|language=ini
}}

===Detect and reuse existing Shared Data Model===

{{Checkbox Option
|name=Detect and reuse existing Shared Data Model
|default=Checked
|values=Checked / Unchecked

|summary=Detects the SDM used by the model and adds it as a separate model.

|details=PHENOM manages a complete library of FACE Shared Data Models and is able to detect when a model uses of these SDMs. This option makes the SDM a separate model within the project so it can be updated and changed over time.

|language=ini
}}

===Unbounded CDM Mode===

{{Checkbox Option
|name=Unbounded CDM Mode
|default=Checked
|values=Checked / Unchecked

|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.

|details=PHENOM best practices recommend bounds that differ from the defaults defined by the FACE Technical Standard. This will apply the PHENOM-recommended bounds - (1..*) for all composed attributes/participants and (0..*) for all participant source roles. NOTE: this will not overwrite existing bounds - this only applies the PHENOM-recommended values when no explicit bounds are set.

|language=ini
}}

=Query Processing & Content Retention Options=

===Process CDM Queries===
{{Checkbox Option
|name=Process CDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Conceptual Queries so they are retained on import.

|details=PHENOM does not store or process Conceptual Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Conceptual Queries are retained when imported. This uses the query-specified observables and creates generic logical and platform elements in the model with "placeholders" where logical and platform type would otherwise be specified.

|language=ini
}}

===Process LDM Queries===
{{Checkbox Option
|name=Process LDM Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=Process Logical Queries so they are retained on import.

|details=PHENOM does not store or process Logical Queries, however, it is possible to import the data in such a way that this data is retains. This ensures Logical Queries are retained when imported. This uses the query-specified measurements and creates generic platform elements in the model with "placeholders" where platform type would otherwise be specified.

|language=ini
}}

===Retain Queries===
{{Checkbox Option
|name=Retain Queries
|default=Unchecked
|values=Checked / Unchecked

|summary=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).

|details=On import, PHENOM transforms platform queries into a
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).

|language=ini
}}

===Retain Entity Models===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Retains all Logical and Platform Entities and Associations.

|details=Except in some special cases, the Logical and Platform entity models can be fully derived. The only downside is that this can change the values of the element's GUIDs. Typically, this only happens once when a model is imported into PHENOM. However, if it is necessary to retain the original entity model, this option should be selected.

|language=ini
}}

===Retain Auto Generated Content===
{{Checkbox Option
|name=Retain Entity Models
|default=Unchecked
|values=Checked / Unchecked

|summary=Preserves any automatically generated content PHENOM may have added during export.

|details=In some cases during model export, PHENOM may add some innocuous content to ensure the validity of the exported model. Such content is labeled as being auto-generated by PHENOM. When this option is selected, PHENOM will keep this content when importing the model. As an example of when this occurs, consider the case when a query joins ''though'' an entity but does not reference any of its attributes (this is a valid possibility). When this occurs, a corresponding platform entity is created, but it does not have any attributes and fails validity checks. In this case, PHENOM would add an attribute (typically an identifier) to ensure validity.

|language=ini
}}

===Apply Explicit Default Values===
{{Checkbox Option
|name=Retain Queries
|default=Checked
|values=Checked / Unchecked

|summary=Ensures default values are made explicit in the model.

|details=In a valid XML file, attributes values may not be serialized if they match the default value specified in its schema definition. This option ensures that all values (even those matching the default value) are explicit in the model.

|language=ini
}}

Model Import Options

2026-09-09T16:38:54Z

Chris: /* Detect and reuse existing Shared Data Model (Default Checked) */

Model Import Options

2026-09-09T16:35:58Z

Chris: /* Fix View Characteristics w/o name (Default Checked) */

Template:Checkbox Option

2026-09-09T16:22:35Z

Chris:

<includeonly>
{| class="wikitable"
! Property
! Value
|-
| '''Option'''
| <code>{{{name}}}</code>
|-
| '''Default'''
| <code>{{{default}}}</code>
|-
| '''Allowed values'''
| {{{values|Not specified}}}
|}
'''Summary:''' {{{summary}}}

'''Details:'''

{{{details}}}
</includeonly>

<noinclude>
== Usage ==
<pre>
{{Checkbox Option
|name=enableLogging
|default=true
|values=true or false
|summary=Enables application logging.
|details=When selected, the application writes operational messages to the configured log.
}}
</pre>
</noinclude>

Model Import Options

2026-09-09T16:20:27Z

Chris: /* Fix paths not ending in Observable (Default Checked) */

Template:Checkbox Option

2026-09-09T16:00:51Z

Chris: /* Usage */

<includeonly>
{| class="wikitable"
! Property
! Value
|-
| '''Option'''
| <code>{{{name}}}</code>
|-
| '''Type'''
| {{{type|Not specified}}}
|-
| '''Default'''
| <code>{{{default}}}</code>
|-
| '''Allowed values'''
| {{{values|Not specified}}}
|}
'''Summary:''' {{{summary}}}

'''Details:'''

{{{details}}}
</includeonly>

<noinclude>
== Usage ==
<pre>
{{Checkbox Option
|name=enableLogging
|default=true
|values=true or false
|summary=Enables application logging.
|details=When selected, the application writes operational messages to the configured log.
}}
</pre>
</noinclude>

Model Import Options

2026-09-09T16:00:23Z

Chris: /* Assert IDs */

Template:Checkbox Option

2026-09-09T15:55:27Z

Chris: /* Usage */

<includeonly>
{| class="wikitable"
! Property
! Value
|-
| '''Option'''
| <code>{{{name}}}</code>
|-
| '''Type'''
| {{{type|Not specified}}}
|-
| '''Default'''
| <code>{{{default}}}</code>
|-
| '''Allowed values'''
| {{{values|Not specified}}}
|}
'''Summary:''' {{{summary}}}

'''Details:'''

{{{details}}}
</includeonly>

<noinclude>
== Usage ==

<pre>
{{Checkbox Option
|name=enableLogging
|default=true
|values=true or false
|summary=Enables application logging.
|details=When selected, the application writes operational messages to the configured log.
}}
</pre>
</noinclude>

Template:Checkbox Option

2026-09-09T15:54:11Z

Chris:

<includeonly>
{| class="wikitable"
! Property
! Value
|-
| '''Option'''
| <code>{{{name}}}</code>
|-
| '''Type'''
| {{{type|Not specified}}}
|-
| '''Default'''
| <code>{{{default}}}</code>
|-
| '''Allowed values'''
| {{{values|Not specified}}}
|}
'''Summary:''' {{{summary}}}

'''Details:'''

{{{details}}}
</includeonly>

<noinclude>
== Usage ==

<pre>
{{Checkbox Option
|name=enableLogging
|type=Checkbox
|default=true
|values=true or false
|summary=Enables application logging.
|details=When selected, the application writes operational messages to the configured log.
}}
</pre>
</noinclude>

Model Import Options

2026-09-09T15:53:34Z

Chris: /* Assert IDs */

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.

{{Checkbox Option
|name=Import.Assert IDs
|type=Import
|default=Checked
|values=Checked-Unchecked
|summary=Ensures that each imported entity has an identifier.
|details=The timer begins when the application initiates a connection.
|language=ini
}}

===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).

Template:Checkbox Option

2026-09-09T15:49:12Z

Chris: Initial

abs

Model Import Options

2026-09-09T15:45:45Z

Chris:

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).

Creating a Project from an Existing Model

2026-09-09T15:32:47Z

Chris: /* Import Options */

Creating a Project from an Existing Model

2026-09-09T15:32:38Z

Chris: /* Import Options */

Model Import Options

2026-09-09T15:32:22Z

Chris: Initial Version

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).

Creating a Project from an Existing Model

2026-09-09T15:32:00Z

Chris: Added new page for import options. Will move out the details in a minute.

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|Manage Models]] section of PHENOM. After logging in, please click on the [[Manage|Manage Models]] icon.

[[File:Phenom navigation bar 5.png|thumb|none]]

===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.

[[File:Phenom-manage-create-new-project.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-select-models.png|frame|none]]

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:

[[File:Phenom-manage-create-new-project-load-model.png|frame|none]]

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:

[[File:Phenom-manage-create-new-project-model-loading.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-model-loaded-successfully.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-model-load-error.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-save.png|frame|none]]

===Import Options===
For a description of the model import options, pleas visit [[Model 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.

[[File:Phenom-manage-switch-project.png|frame|none]]

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.

[[File:Phenom-header-current-model-and-user.png|frame|none]]

Creating a Project from an Existing Model

2026-09-09T15:28:48Z

Chris: Documented import options

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|Manage Models]] section of PHENOM. After logging in, please click on the [[Manage|Manage Models]] icon.

[[File:Phenom navigation bar 5.png|thumb|none]]

===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.

[[File:Phenom-manage-create-new-project.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-select-models.png|frame|none]]

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:

[[File:Phenom-manage-create-new-project-load-model.png|frame|none]]

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:

[[File:Phenom-manage-create-new-project-model-loading.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-model-loaded-successfully.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-model-load-error.png|frame|none]]

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

[[File:Phenom-manage-create-new-project-save.png|frame|none]]

===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.

[[File:Phenom-manage-switch-project.png|frame|none]]

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.

[[File:Phenom-header-current-model-and-user.png|frame|none]]

File:Phenom-manage-create-new-project-load-model.png

2026-09-08T18:57:58Z

Chris: Chris uploaded a new version of File:Phenom-manage-create-new-project-load-model.png

Load Model Screenshot

Setup Two-Factor Authentication (2FA)

2026-05-11T14:07:28Z

Chris:

Go to the Account Page. You can access it in the top right corner.
 
[[File:Account page.png|border|frameless|230x165px|alt=account page menu|Where to access the account page]]

Click “Set Up Two-Factor Authentication.” You’ll be asked to enter your password.
 
[[File:Account general info 2.png|border|frameless|395x395px]]

Scan the QR code with an Authenticator App (Google, Microsoft, etc.). The app will generate a code - enter it into the input field to complete 2FA activation. The next time you log in, you’ll be asked for the 2FA verification code.
 
[[File:QR Code.png|border|frameless|538x581px|alt=Scan the QR Code to get your initial code for 2FA|qr code for 2fa]]

File:QR Code.png

2026-05-11T13:45:13Z

Chris:

QR Code for 2FA setup.

Setup Two-Factor Authentication (2FA)

2026-05-08T22:11:49Z

Chris: Created page with "Go to the Account Page. You can access it in the top right corner. Where to access the account page Click “Set Up Two-Factor Authentication.” You’ll be asked to enter your password. 395x395px Scan the QR code with the Google Authenticator App. The app will generate a code—enter it into the input field. The next time you l..."

Go to the Account Page. You can access it in the top right corner. 
[[File:Account page.png|border|frameless|230x165px|alt=account page menu|Where to access the account page]]

Click “Set Up Two-Factor Authentication.”
You’ll be asked to enter your password.
 
[[File:Account general info 2.png|border|frameless|395x395px]]

Scan the QR code with the Google Authenticator App. The app will generate a code—enter it into the input field. The next time you log in, you’ll be asked for the 2FA verification code.
 
[[File:Account general info 2.png|border|frameless|395x395px]]