Healthcheck - Revision history

Nathan: /* Composed Block Instance Issues */

2026-02-25T15:15:15Z

Composed Block Instance Issues

← Older revision		Revision as of 11:15, 25 February 2026
Line 96:		Line 96:

	=== Entity Bounds Best Practices ===		=== Entity Bounds Best Practices ===
	This check reports when any bounds are not the same as the Skayl recommended bounds. For target bounds it's suggested to use 1..* and for source bounds it's suggested to use 0..*. If the current bounds are empty the check will show the FACE™ assumed bounds as ~~italisized~~.		This check reports when any bounds are not the same as the Skayl recommended bounds. For target bounds it's suggested to use 1..* and for source bounds it's suggested to use 0..*. If the current bounds are empty the check will show the FACE™ assumed bounds as italicized.

	=== Optional Characteristics ===		=== Optional Characteristics ===
Line 116:		Line 116:
	This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.		This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

	[[~~index~~.php?title=Category:UserGuide\|0021_Healthcheck]]		[[Index.php?title=Category:UserGuide\|0021_Healthcheck]]

Nathan: Enitty bounds best practices now included

2026-02-25T15:04:46Z

Enitty bounds best practices now included

← Older revision		Revision as of 11:04, 25 February 2026
Line 94:		Line 94:
	=== Platform Types with inappropriate type or Measurement ===		=== Platform Types with inappropriate type or Measurement ===
	This check finds any discrepancies in Measurement realization. Among the following Platform Types Phenom supports, ("Boolean", "BoundedString", "Char", "CharArray", "Double", "Fixed", "Float", "IDLArray", "IDLSequence", "Long", "LongDouble", "LongLong", "Octet", "Short", "String", "ULong", "ULongLong", "UShort"), there are two additional supported types that are mutually exclusive with the previous list, to the measurements they can respectively realize: "IDLStruct", and "Enumeration". IDLStructs can only realize Measurements with multiple axes, and Enumerations can only realize Enumeration Measurements. All other types above cannot realize multi-axis or Enumeration Measurements.		This check finds any discrepancies in Measurement realization. Among the following Platform Types Phenom supports, ("Boolean", "BoundedString", "Char", "CharArray", "Double", "Fixed", "Float", "IDLArray", "IDLSequence", "Long", "LongDouble", "LongLong", "Octet", "Short", "String", "ULong", "ULongLong", "UShort"), there are two additional supported types that are mutually exclusive with the previous list, to the measurements they can respectively realize: "IDLStruct", and "Enumeration". IDLStructs can only realize Measurements with multiple axes, and Enumerations can only realize Enumeration Measurements. All other types above cannot realize multi-axis or Enumeration Measurements.

			=== Entity Bounds Best Practices ===
			This check reports when any bounds are not the same as the Skayl recommended bounds. For target bounds it's suggested to use 1..* and for source bounds it's suggested to use 0..*. If the current bounds are empty the check will show the FACE™ assumed bounds as italisized.

	=== Optional Characteristics ===		=== Optional Characteristics ===
Line 113:		Line 116:
	This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.		This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

	[[Category:UserGuide\|0021_Healthcheck]]		[[index.php?title=Category:UserGuide\|0021_Healthcheck]]

Jen at 17:58, 22 October 2025

2025-10-22T17:58:15Z

← Older revision		Revision as of 13:58, 22 October 2025
Line 112:		Line 112:
	=== Composed Block Instance Issues ===		=== Composed Block Instance Issues ===
	This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.		This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

			[[Category:UserGuide\|0021_Healthcheck]]

Brian at 18:53, 9 April 2024

2024-04-09T18:53:25Z

← Older revision		Revision as of 14:53, 9 April 2024
Line 107:		Line 107:
	There are many elements Phenom supports that may have lower or upper bounds. Of these elements, if any have invalid bounds, (for example - lower bound is greater than upper bound), Phenom will report these elements here.		There are many elements Phenom supports that may have lower or upper bounds. Of these elements, if any have invalid bounds, (for example - lower bound is greater than upper bound), Phenom will report these elements here.

	=== ~~'''~~Nested View Issues~~'''~~ ===		=== Nested View Issues ===
	This health check finds all privately scoped nested views used in more than one perspective or used within more than one view family.		This health check finds all privately scoped nested views used in more than one perspective or used within more than one view family.

	=== Composed Block Instance Issues ===		=== Composed Block Instance Issues ===
	This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.		This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

Brian at 18:53, 9 April 2024

2024-04-09T18:53:05Z

← Older revision		Revision as of 14:53, 9 April 2024
Line 110:		Line 110:
	This health check finds all privately scoped nested views used in more than one perspective or used within more than one view family.		This health check finds all privately scoped nested views used in more than one perspective or used within more than one view family.

	=== ~~'''~~Composed Block Instance Issues~~'''~~ ===		=== Composed Block Instance Issues ===
	This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.		This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

Brian: added two health checks

2024-04-01T23:16:19Z

added two health checks

← Older revision		Revision as of 19:16, 1 April 2024
Line 106:		Line 106:
	=== Bounds Issues ===		=== Bounds Issues ===
	There are many elements Phenom supports that may have lower or upper bounds. Of these elements, if any have invalid bounds, (for example - lower bound is greater than upper bound), Phenom will report these elements here.		There are many elements Phenom supports that may have lower or upper bounds. Of these elements, if any have invalid bounds, (for example - lower bound is greater than upper bound), Phenom will report these elements here.

			=== '''Nested View Issues''' ===
			This health check finds all privately scoped nested views used in more than one perspective or used within more than one view family.

			=== '''Composed Block Instance Issues''' ===
			This health check traces through the node connection and compares the Composed Block Instance with the connected block node, and searches for mismatched data types or inconsistent template types.

Nathalie: /* Running a Project Health Check */

2024-02-06T19:11:58Z

Running a Project Health Check

Nathalie: Nathalie moved page Health Check to Healthcheck

2024-02-06T19:10:42Z

Nathalie moved page Health Check to Healthcheck

← Older revision	Revision as of 15:10, 6 February 2024
(No difference)

Nick at 22:08, 15 October 2023

2023-10-15T22:08:46Z

← Older revision		Revision as of 18:08, 15 October 2023
Line 52:		Line 52:

	==== Compositions Referencing Errors ====		==== Compositions Referencing Errors ====
	~~''''' No wrench icon available'''''~~

	'''''Compositions that realize a deprecated observable will appear in this section.'''''		'''''Compositions that realize a deprecated observable will appear in this section.'''''

Nick: /* Integration Context */

2023-10-02T14:37:03Z

Integration Context

← Older revision		Revision as of 10:37, 2 October 2023
Line 101:		Line 101:

	=== Integration Context ===		=== Integration Context ===
	If there are any issues with Integration Model content, those issues will be reported here. This includes checks for issues such as inconsistent data types, ~~connection validity~~, ~~reference checking, etc~~.		If there are any issues with Integration Model content, those issues will be reported here. This includes checks for issues such as inconsistent data types, missing message ports, and endpoints with multiple connections.

	=== Conversion Errors ===		=== Conversion Errors ===

← Older revision		Revision as of 15:11, 6 February 2024
Line 1:		Line 1:
	== Running a Project ~~Health Check~~ ==		== Running a Project Healthcheck ==
	There are certain characteristics that make some projects more useful than others. Projects defined using a clear, unambiguous structure are very well suited for automating integration. Their structure aligns them well for determining semantic equivalence with other systems. Some of these project qualities can be checked running relatively simple algorithms while others are far more complex. As additional project ~~health checks~~ are added to PHENOM, they can be run from this control panel.		There are certain characteristics that make some projects more useful than others. Projects defined using a clear, unambiguous structure are very well suited for automating integration. Their structure aligns them well for determining semantic equivalence with other systems. Some of these project qualities can be checked running relatively simple algorithms while others are far more complex. As additional project healthchecks are added to PHENOM, they can be run from this control panel.

	To get to the ~~health checks~~, navigate to the Data Model mode and select the ~~Health Check~~ tab. This will present you with a blank ~~health check~~ page. Click on the "Run ~~Health Check~~" button to initiate the tests. Please note, the tests may take a few minutes - a spinner icon indicates that PHENOM is working.		To get to the healthchecks, navigate to the Data Model mode and select the Healthcheck tab. This will present you with a blank healthcheck page. Click on the "Run Healthcheck" button to initiate the tests. Please note, the tests may take a few minutes - a spinner icon indicates that PHENOM is working.

	[[File:Phenom-data model-health check blank.png\|1000px\|border]]		[[File:Phenom-data model-health check blank.png\|1000px\|border]]
Line 12:		Line 12:
	All test results can be downloaded as a CSV file by clicking on the "Download Report" button.		All test results can be downloaded as a CSV file by clicking on the "Download Report" button.

	'''''The project can be filtered by tags and be used in ~~Health Check~~ but please be aware that the ~~health check~~ will ensure the project is a valid project. So if a set of nodes are excluded but they have dependencies, then the ~~Health Check~~ will add the nodes back in and they will appear in the health report.'''''		'''''The project can be filtered by tags and be used in Healthcheck but please be aware that the healthcheck will ensure the project is a valid project. So if a set of nodes are excluded but they have dependencies, then the Healthcheck will add the nodes back in and they will appear in the health report.'''''

	== ~~Health Checks~~ ==		== Healthchecks ==
	=== Entity Uniqueness ===		=== Entity Uniqueness ===
	The Entity Uniqueness check determines if all of the entities in the project have a unique set of attributes and associations. Theoretically, if two things have the exact same set of attributes, then they are the same thing. While it may not seem to have any short-term consequences, entity uniqueness will be much more important when projects are analyzed for similarity and merge.		The Entity Uniqueness check determines if all of the entities in the project have a unique set of attributes and associations. Theoretically, if two things have the exact same set of attributes, then they are the same thing. While it may not seem to have any short-term consequences, entity uniqueness will be much more important when projects are analyzed for similarity and merge.
Line 71:		Line 71:

	=== Platform Enumerations with improperly matched Literals ===		=== Platform Enumerations with improperly matched Literals ===
	This ~~health check~~ captures issues with Platform Enumerations that don't match their realized Measurements, when comparing their Platform Enumeration Literals to the Measurement's Labels.		This healthcheck captures issues with Platform Enumerations that don't match their realized Measurements, when comparing their Platform Enumeration Literals to the Measurement's Labels.

	There are two categories that can currently show up on this report:		There are two categories that can currently show up on this report:
Line 79:		Line 79:
	These issues may not always indicate a problem with the Enumeration; there will be scenarios where a modeler may want to have specialized names in the Platform-level Enumeration that differ from the LDM Measurement Labels. Setting the realize relationship on LDM Literals indicates which Label a Literal represents.		These issues may not always indicate a problem with the Enumeration; there will be scenarios where a modeler may want to have specialized names in the Platform-level Enumeration that differ from the LDM Measurement Labels. Setting the realize relationship on LDM Literals indicates which Label a Literal represents.

	Clicking on the links of each Enumeration found in this ~~health check~~ will bring up the Platform Type editor, which you can use to manage them. For more details, go to [[Platform Type and Enumeration]].		Clicking on the links of each Enumeration found in this healthcheck will bring up the Platform Type editor, which you can use to manage them. For more details, go to [[Platform Type and Enumeration]].

	'''''To see the Project Generation behavior PHENOM follows when generating Enumeration content, please see: Model & Artifact Generation'''''		'''''To see the Project Generation behavior PHENOM follows when generating Enumeration content, please see: Model & Artifact Generation'''''

	=== Views without Characteristics ===		=== Views without Characteristics ===
	This ~~health check~~ captures Views without any child Characteristics. Platform Views are exported from Phenom as Views in FACE 2.1 and Templates/Queries in FACE 3.0. In both standards, the resultant element must not be empty.		This healthcheck captures Views without any child Characteristics. Platform Views are exported from Phenom as Views in FACE 2.1 and Templates/Queries in FACE 3.0. In both standards, the resultant element must not be empty.

	=== Specialization Inconsistencies ===		=== Specialization Inconsistencies ===
	Specialization Inconsistencies checks for inconsistencies in specializing Entities. Phenom's representation of specialization requires consistency in the attributes between the Entity specializing, and the Entity being specialized. If any of the attributes being specialized in Entity A are not present in Entity B, they will be present in this ~~health check~~.		Specialization Inconsistencies checks for inconsistencies in specializing Entities. Phenom's representation of specialization requires consistency in the attributes between the Entity specializing, and the Entity being specialized. If any of the attributes being specialized in Entity A are not present in Entity B, they will be present in this healthcheck.

	=== FACE™ SDM Conformance ===		=== FACE™ SDM Conformance ===
	Use this ~~health check~~ to monitor model conformance. As new versions of the FACE SDM are released, they will be enumerated in this ~~health check~~. Green check marks indicate matching conformance, yellow warning signs indicate disparities in expected SDM node content, and red X's indicate that content referenced by an SDM node could not be found in your model.		Use this healthcheck to monitor model conformance. As new versions of the FACE SDM are released, they will be enumerated in this healthcheck. Green check marks indicate matching conformance, yellow warning signs indicate disparities in expected SDM node content, and red X's indicate that content referenced by an SDM node could not be found in your model.

	=== Platform Types with inappropriate type or Measurement ===		=== Platform Types with inappropriate type or Measurement ===