Model Import Options: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
No edit summary
No edit summary
(5 intermediate revisions by the same user not shown)
Line 3: Line 3:
=Import Checks/Fixes=
=Import Checks/Fixes=
===Assert IDs===  
===Assert IDs===  
(Default Checked)
{{Checkbox Option
Ensures that each imported entity has an identifier.
|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 (Default Checked)===
===Fix paths not ending in Observable===
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.
{{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 (Default Checked)===
===Fix View Characteristics w/o name===
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.
{{Checkbox Option
|name=Fix paths not ending in Observable
  |default=Checked
|values=Checked / Unchecked


===Detect and reuse existing Shared Data Model (Default Checked)===
|summary=Ensures that each view characteristic has a name.  When a name is not specified, it is taken from the corresponding platform attribute.
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.
 
|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
}}


===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=
=Query Processing & Content Retention Options=


===Process CDM Queries (Default not Checked)===
===Process CDM Queries===
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.
{{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


===Process LDM Queries (Default not Checked)===
|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).
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)===
|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).
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)===
|language=ini
This will retain all Logical and Platform Entities (and Associations).  This is useful when strict tracking of these elements' GUID is desired.
}}
 
===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.


===Retain Auto Generated Content (Default not Checked)===
|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.
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)===
|language=ini
Ensures default values are made explicit in the model (instead of relying on implied default values).
}}

Revision as of 14:47, 9 September 2026

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

Import Checks/Fixes

Assert IDs

Property Value
Option Assert IDs
Default Checked
Allowed 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.


Fix paths not ending in Observable

Property Value
Option Fix paths not ending in Observable
Default Checked
Allowed 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.


Fix View Characteristics w/o name

Property Value
Option Fix paths not ending in Observable
Default Checked
Allowed 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.


Detect and reuse existing Shared Data Model

Property Value
Option Detect and reuse existing Shared Data Model
Default Checked
Allowed 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.


Unbounded CDM Mode

Property Value
Option Unbounded CDM Mode
Default Checked
Allowed 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.



Query Processing & Content Retention Options

Process CDM Queries

Property Value
Option Process CDM Queries
Default Unchecked
Allowed 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.


Process LDM Queries

Property Value
Option Process LDM Queries
Default Unchecked
Allowed 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.


Retain Queries

Property Value
Option Retain Queries
Default Unchecked
Allowed 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).


Retain Entity Models

Property Value
Option Retain Entity Models
Default Unchecked
Allowed 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.


Retain Auto Generated Content

Property Value
Option Retain Entity Models
Default Unchecked
Allowed 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.


Apply Explicit Default Values

Property Value
Option Retain Queries
Default Checked
Allowed 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.


Retrieved from "https://kb.phenomportal.com/index.php?title=Model_Import_Options&oldid=1623"