PHENOM Portal Knowledgebase - Recent changes [en]

Model Import Options

Chris — Thu, 10 Sep 2026 13:55:57 GMT

Retain Auto Generated Content

← Older revision		Revision as of 09:55, 10 September 2026
(9 intermediate revisions by the same user not shown)
Line 18:		Line 18:
	\|values=Checked / Unchecked		\|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.		\|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.		\|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		\|language=ini
	}}		}}
Line 24:		Line 24:
	===Fix View Characteristics w/o name===		===Fix View Characteristics w/o name===
	{{Checkbox Option		{{Checkbox Option
	\|name=Fix ~~paths not ending in Observable~~		\|name=Fix View Characteristics w/o name
	\|default=Checked		\|default=Checked
	\|values=Checked / Unchecked		\|values=Checked / Unchecked
Line 30:		Line 30:
	\|summary=Ensures that each view characteristic has a name. When a name is not specified, it is taken from the corresponding platform attribute.		\|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.		\|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		\|language=ini
Line 58:		Line 58:
	\|summary=Applies PHENOM's recommended bounds to imports element ''if not explicitly specified''.		\|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.		\|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		\|language=ini
	}}		}}


	=Query Processing & Content Retention Options=		=Query Processing & Content Retention Options=
Line 74:		Line 73:
	\|summary=Process Conceptual Queries so they are retained on import.		\|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~~.		\|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		\|language=ini
Line 87:		Line 86:
	\|summary=Process Logical Queries so they are retained on import.		\|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~~.		\|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		\|language=ini
Line 98:		Line 97:
	\|values=Checked / 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)~~.		\|summary=Preserves query nodes in their entirety for re-introduction into the model at time of export.

	\|details=On import, ~~PHENOM transforms platform~~ queries ~~into~~ a		\|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.
	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		\|language=ini
Line 114:		Line 112:
	\|summary=Retains all Logical and Platform Entities and Associations.		\|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.		\|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		\|language=ini
Line 127:		Line 125:
	\|summary=Preserves any automatically generated content PHENOM may have added during export.		\|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.		\|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		\|language=ini

Projects and Models Management

Chris — Wed, 09 Sep 2026 18:53:01 GMT

← Older revision		Revision as of 14:53, 9 September 2026
Line 63:		Line 63:

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

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

	== Copy Project (Create Branch) ==		== Copy Project (Create Branch) ==

Template:Checkbox Option

Chris — Wed, 09 Sep 2026 18:48:09 GMT

← Older revision		Revision as of 14:48, 9 September 2026
Line 16:		Line 16:

	'''Details:'''		'''Details:'''

	{{{details}}}		{{{details}}}
	</includeonly>		</includeonly>

	<noinclude>		<noinclude>
	== Usage ==		== Usage ==

Model Import Options

Chris — Wed, 09 Sep 2026 18:47:35 GMT

Show changes

Template:Checkbox Option

Chris — Wed, 09 Sep 2026 16:22:35 GMT

← Older revision		Revision as of 12:22, 9 September 2026
Line 6:		Line 6:
	\| '''Option'''		\| '''Option'''
	\| <code>{{{name}}}</code>		\| <code>{{{name}}}</code>
	\|-
	~~\| '''Type'''~~
	~~\| {{{type\|Not specified}}}~~
	\|-		\|-
	\| '''Default'''		\| '''Default'''

Model Import Options

Chris — Wed, 09 Sep 2026 16:20:27 GMT

Fix paths not ending in Observable (Default Checked)

← Older revision		Revision as of 12:20, 9 September 2026
Line 12:		Line 12:
	}}		}}

	===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 (Default Checked)===

Template:Checkbox Option

Chris — Wed, 09 Sep 2026 16:00:51 GMT

Usage

← Older revision		Revision as of 12:00, 9 September 2026
Line 25:		Line 25:
	<noinclude>		<noinclude>
	== Usage ==		== Usage ==

	<pre>		<pre>
	{{Checkbox Option		{{Checkbox Option

Model Import Options

Chris — Wed, 09 Sep 2026 16:00:23 GMT

Assert IDs

← Older revision		Revision as of 12:00, 9 September 2026
Line 3:		Line 3:
	=Import Checks/Fixes=		=Import Checks/Fixes=
	===Assert IDs===		===Assert IDs===
	~~(Default Checked)~~
	~~Ensures that each imported entity has an identifier.~~

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

Template:Checkbox Option

Chris — Wed, 09 Sep 2026 15:55:27 GMT

Usage

← Older revision		Revision as of 11:55, 9 September 2026
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
	~~abs~~		<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

Chris — Wed, 09 Sep 2026 15:53:34 GMT

Assert IDs

@@ Line 5: / Line 5: @@
 (Default Checked)
 Ensures that each imported entity has an identifier.
 ===Fix paths not ending in Observable (Default Checked)===

Template:Checkbox Option

Chris — Wed, 09 Sep 2026 15:49:12 GMT

Initial

New page

abs

Model Import Options

Chris — Wed, 09 Sep 2026 15:45:45 GMT

← Older revision		Revision as of 11:45, 9 September 2026
Line 1:		Line 1:
	There are two categories of import options for PHENOM: Import Checks/Fixes and Query Processing & Content Retention Options.		There are two categories of import options for PHENOM: Import Checks/Fixes and Query Processing & Content Retention Options.

	~~===~~=Import Checks/Fixes====		=Import Checks/Fixes=
	* '''Assert IDs (Default Checked)~~.'''~~ Ensures that each imported entity has an identifier.		===Assert IDs===
	* '''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.		(Default Checked)
	* '''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.		Ensures that each imported entity has an identifier.
	* '''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====		===Fix paths not ending in Observable (Default Checked)===
	* '''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.		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.
	* '''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).		===Fix View Characteristics w/o name (Default Checked)===
	* '''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.		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.
	* '''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).		===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

Chris — Wed, 09 Sep 2026 15:32:47 GMT

Import Options

@@ Line 47: / Line 47: @@
 ===Import Options===
-For a description of the model import options, pleas visit [[Model Import Options]].
+For a description of the model import options, please visit [[Model Import Options]].
 ===Switch to New Model===

Model Import Options

Chris — Wed, 09 Sep 2026 15:32:22 GMT

Initial Version

New page

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

Chris — Wed, 09 Sep 2026 15:32:00 GMT

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

← Older revision		Revision as of 11:32, 9 September 2026
(One intermediate revision by the same user not shown)
Line 45:		Line 45:

	[[File:Phenom-manage-create-new-project-save.png\|frame\|none]]		[[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===		===Switch to New Model===

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

Chris — Tue, 08 Sep 2026 18:57:58 GMT

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

New page

Load Model Screenshot