Data Model Generation - Revision history

Jen at 18:07, 22 October 2025

2025-10-22T18:07:52Z

← Older revision		Revision as of 14:07, 22 October 2025
Line 31:		Line 31:

	[[File:Phenom-generate-data model user template.png\|800px\|border]]		[[File:Phenom-generate-data model user template.png\|800px\|border]]

			[[Category:UserGuide\|0033_Data_Model_Generation]]

Derek: /* FACE (.face) */

2024-07-23T17:51:30Z

FACE (.face)

← Older revision		Revision as of 13:51, 23 July 2024
Line 12:		Line 12:

	=== FACE (.face) ===		=== 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 ~~3.1/3.2 or 3.0~~. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.		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]]		[[File:Datamodel - Face.png\|border\|800x800px]]

Derek: /* FACE (.face) */

2024-07-19T20:55:43Z

FACE (.face)

← Older revision		Revision as of 16:55, 19 July 2024
Line 12:		Line 12:

	=== FACE (.face) ===		=== 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: 3.1, 3.0, or 2.1. ~~"2.1 obfuscated" exports~~ the ~~model as a 2.1~~ FACE ~~files and obfuscate the node's names (mainly used for debug purposes)~~.		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 3.1/3.2 or 3.0. There is also the option of selecting additional export options via the checkboxes below export type and FACE version.

	[[File:~~Phenom~~-~~generate-data model face~~.png\|~~800px~~\|~~border~~]]		[[File:Datamodel - Face.png\|border\|800x800px]]

	=== Diagrams (.png / .zip) ===		=== Diagrams (.png / .zip) ===

Derek: /* Diagrams (.png / .zip) */

2024-07-19T18:10:29Z

Diagrams (.png / .zip)

← Older revision		Revision as of 14:10, 19 July 2024
Line 17:		Line 17:

	=== Diagrams (.png / .zip) ===		=== 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.		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.

	Allows for the preview of diagram images with the preview and regenerate buttons.

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

Derek: /* Diagrams (.zip) */

2024-07-19T18:09:59Z

Diagrams (.zip)

← Older revision		Revision as of 14:09, 19 July 2024
Line 16:		Line 16:
	[[File:Phenom-generate-data model face.png\|800px\|border]]		[[File:Phenom-generate-data model face.png\|800px\|border]]

	=== Diagrams (.zip) ===		=== Diagrams (.png / .zip) ===
	This option exports all the user-created diagrams and/or view traces as PGN files in a ZIP archive.		This option exports all the user-created diagrams and/or view traces as PGN files or in a ZIP archive if multiple are selected.

	[[File:~~Phenom-generate~~-~~data model diagrams~~.png\|~~800px~~\|~~border~~]]		Allows for the preview of diagram images with the preview and regenerate buttons.

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

	=== IDL (.idl) ===		=== IDL (.idl) ===

Derek: Derek moved page Data Model to Data Model Generation

2024-07-15T22:10:11Z

Derek moved page Data Model to Data Model Generation

← Older revision		Revision as of 18:10, 15 July 2024
(No difference)

Nathalie at 18:38, 15 September 2022

2022-09-15T18:38:42Z

← Older revision		Revision as of 14:38, 15 September 2022
Line 28:		Line 28:

	=== User Template ===		=== User Template ===
	This option exports the data model using user templates. These templates can be edited in the [[Templates]] ~~menu~~.		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]]		[[File:Phenom-generate-data model user template.png\|800px\|border]]

Nathalie: Nathalie moved page Data Model Generate to Data Model

2022-09-15T18:37:20Z

Nathalie moved page Data Model Generate to Data Model

← Older revision		Revision as of 14:37, 15 September 2022
(No difference)

Nathalie at 18:35, 15 September 2022

2022-09-15T18:35:41Z

@@ Line 2: / Line 2: @@
 == Filter ==
-The first drop down in the page allows the user to filter the model and the Nav Tree to only what is relevant for generation.
+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)
@@ Line 31: / Line 31: @@
 [[File:Phenom-generate-data model user template.png|800px|border]]

Nathalie: /* Generate Models & Artifacts */

2022-09-15T18:34:05Z

Generate Models & Artifacts

← Older revision		Revision as of 14:34, 15 September 2022
Line 9:		Line 9:

	== Generate Models & Artifacts ==		== Generate Models & Artifacts ==
	The user can then choose the type of artifact to generate. Each type of artifacts has its own generation ~~options~~.		The user can then choose the type of artifact to generate. Each type of artifacts has its own generation parameters.

	=== FACE (.face) ===		=== FACE (.face) ===
	This ~~option~~ 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: 3.1, 3.0, or 2.1. "2.1 obfuscated" exports the model as a 2.1 FACE files and obfuscate the node's names (mainly used for debug purposes).		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: 3.1, 3.0, or 2.1. "2.1 obfuscated" exports the model as a 2.1 FACE files and obfuscate the node's names (mainly used for debug purposes).

	[[File:Phenom-~~manage~~-~~generate~~ face.png\|800px\|border]]		[[File:Phenom-generate-data model face.png\|800px\|border]]

	=== Diagrams (.zip) ===		=== Diagrams (.zip) ===
	This option exports all the user-created diagrams and/or view traces as PGN files in a ZIP archive.		This option exports all the user-created diagrams and/or view traces as PGN files in a ZIP archive.

	[[File:Phenom-generate-data model diagrams.png\|~~600px~~\|border]]		[[File:Phenom-generate-data model diagrams.png\|800px\|border]]

	=== IDL (.idl) ===		=== IDL (.idl) ===
	~~export~~ the data model in Interface Description Language (IDL) format		This option exports the data model in Interface Description Language (IDL) format.

	=== Skayl (.skayl) ===		=== Skayl (.skayl) ===
	~~export~~ the data model in Skayl's Proprietary Format (similar to FACE XMI, but ~~this~~ preserves ~~the~~ non-standardized integration model content)		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 ===		=== User Template ===
	~~export~~ the data model using user templates		This option exports the data model using user templates. These templates can be edited in the [[Templates]] menu.

			[[File:Phenom-generate-data model user template.png\|800px\|border]]

	~~Artifact Descriptions~~
	~~.face v2.1 XMI~~
	This is the canonical form for all Future Airborne Capability Environment (FACETM) version 2.1 data models. This style of model uses projection paths to capture data model semantics. It is a .face file in a customized version of the XMI file format.

	~~.face v3.0 XMI~~
	This is the canonical form for all Future Airborne Capability Environment (FACETM) version 3.0 data models. This style of model uses queries and templates to capture data model semantics. It is a .face file in a customized version of the XMI file format.

	~~.face v2.1 XMI obfuscated~~
	This is the canonical form for all Future Airborne Capability Environment (FACETM) version 2.1 data models. This style of model creates ambiguity with data model semantics. It is a .face file in a customized version of the XMI file format.

	~~.html~~
	~~This is a mini-website. Each element of the data model is provided as a simple HTML file that can be clicked around and navigated in a web browser.~~

	~~.docx~~
	~~This is a Word Document form of the data model. It captures all of the data model contents in a printable form.~~

	~~.xml UML XMI~~
	This is an XMI version 1.2 file as exported by Sparx Systems Enterprise Architect. While it is intended to be a portable, model interchange file, the portability is limited by the implementation of the XMI reader.

	~~.cpp TSS API View Classes~~
	~~This option will generate all of the classes needed to connect all defined interfaced to a FACE v2.1 Transport Service Segment (TSS). These classes conform to and can be used with the TSS API.~~

	~~.cpp User Template Generated~~
	~~Choose this option to select from the available user templates.~~

	~~Using Templates~~
	Project data can be used to fill a file with a custom format that fulfills a user's requirements. To do this, the user must select 'User Template' from the File Type menu and then choose a valid template for Phenom to use. Model generation via a user template can be combined with tag reporting to delineate which nodes in the project should be used for the code generation.



	~~Information about creating and editing templates can be found here.~~

	Enumeration behavior		Enumeration behavior