Projects and Models Management - Revision history

Jen at 18:11, 22 October 2025

2025-10-22T18:11:34Z

← Older revision		Revision as of 14:11, 22 October 2025
Line 147:		Line 147:
	Dave and Riley will now be able to independently edit DSDM content and merge changes between their two models as they see appropriate.		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.		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]]

Chris: /* Copy Project */

2025-09-24T20:51:29Z

Copy Project

← Older revision		Revision as of 16:51, 24 September 2025
Line 64:		Line 64:
	[[File:Phenom-manage-model details2.png\|border\|800x800px]]		[[File:Phenom-manage-model details2.png\|border\|800x800px]]

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

Nathalie: /* SDM Import Automatic Detection */

2025-06-27T16:45:35Z

SDM Import Automatic Detection

← Older revision		Revision as of 12:45, 27 June 2025
Line 72:		Line 72:
	[[File:Manage - CopyCreate.png\|none\|800px]]		[[File:Manage - CopyCreate.png\|none\|800px]]

	== ~~SDM Import Automatic Detection~~ ==		== PHENOM-Managed SDMs ==
	~~When creating a project using file import~~, ~~the file will automatically be scanned for the presence of a recognized SDM~~. ~~If a SDM is found to match~~, ~~the project will automatically use one of the "official" Phenom-provided SDM models~~. ~~Some additional notes about this feature include:~~		PHENOM comes loaded with official FACE Shared Data Models (SDMs) for FACE Technical Standard Editions 2.1, 3.0, 3.1, and 3.2.

	# The ~~SDM detection is based on the name of the <dm/> node of the SDM~~ model~~. It should exactly match the name of the <dm~~/~~> in the official SDM.~~		=== Creating a Project with an SDM ===
	~~# If the SDM~~ model ~~contains more content than what is present in the "official" SDM, the swap will not occur (e~~.~~g. a user made a custom measurement and placed it in a package inside the SDM)~~		The user can create a project by importing a model file and/or selecting existing model.

	~~=== Extra Tips ===~~		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.
	If ~~for some reason~~ an ~~expected~~ SDM ~~doesn't swap~~ to a ~~Phenom-provided~~ SDM ~~follow these steps~~ to ~~manually do~~ it:		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).

	# ~~Import~~ the model file ~~as a model creation instead of a project creation~~; this ~~should cause~~ several ~~Phenom~~ models ~~to be generated~~ from the original file.		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:
	# Create ~~a new project~~, instead of uploading a file, select the models that were created in step 1. Instead of selecting ~~the~~ SDM model ~~that was created during import~~, select one of the ~~Phenom~~-~~provided~~ SDM models.		# Click on Create New Model and import the model file; this may lead to several models being created from the original file
	# (Optional) Delete the SDM model that was created in step 1.		# 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

	~~It is also possible~~ to ~~replace an SDM of an already created~~ project by ~~following these steps:~~		Alternatively, the user can chose to create the project by using one of the SDMs in the list of existing models.

	# Delete the project ~~that should have~~ the SDM ~~replaced~~. Do '''NOT''' select any constituent models for deletion.		=== Update a Project's SDM model ===
	# Create a new project, instead of uploading a file, select the models that were ~~from~~ the original deleted project~~. Instead of selecting~~ the SDM ~~model from the original project~~, ~~select one from~~ the ~~Phenom~~-~~provided~~ SDM models.
	# (Optional) Delete the SDM model ~~that was created in step 1.~~		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 ==		== Sample Workflow ==

Nathan: /* SDM Import Automatic Detection */

2025-06-27T15:58:39Z

SDM Import Automatic Detection

← Older revision		Revision as of 11:58, 27 June 2025
Line 76:		Line 76:

	# The SDM detection is based on the name of the <dm/> node of the SDM model. It should exactly match the name of the <dm/> in the official SDM.		# The SDM detection is based on the name of the <dm/> node of the SDM model. It should exactly match the name of the <dm/> in the official SDM.
	# If the SDM model contains more content than what present in the "official" SDM the swap will not occur (e.g. a user made a custom measurement and placed it in a package inside the SDM)		# If the SDM model contains more content than what is present in the "official" SDM, the swap will not occur (e.g. a user made a custom measurement and placed it in a package inside the SDM)

	=== Extra Tips ===		=== Extra Tips ===

Nathan: Added a section giving more information and guidance about SDM import automatic detection.

2025-05-29T18:10:35Z

Added a section giving more information and guidance about SDM import automatic detection.

@@ Line 71: / Line 71: @@
 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]]
 == Sample Workflow ==

Nathalie: /* Sample Workflow */

2024-07-23T18:39:09Z

Sample Workflow

Derek: /* Copy Project */

2024-07-23T17:26:47Z

Copy Project

← Older revision		Revision as of 13:26, 23 July 2024
Line 65:		Line 65:

	== Copy Project ==		== Copy Project ==
	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 ~~original~~ project and the same published models.		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.		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]]		[[File:Manage - Copybtn.png\|none\|800px]]
	The ~~create~~ copy project screen ~~is very similar to~~ the project creation screen ~~where~~ the user ~~needs~~ to input a new name and description for the ~~copied~~ project. Additionally, the user ~~needs to decide~~ whether ~~or not they want~~ to copy ~~all of~~ the permissions ~~that are currently selected~~ from the source project to the copied project before saving.		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]]		[[File:Manage - CopyCreate.png\|none\|800px]]

Nathalie: /* Copy Project */

2024-07-23T17:21:53Z

Copy Project

← Older revision		Revision as of 13:21, 23 July 2024
Line 65:		Line 65:

	== Copy Project ==		== Copy Project ==
	Copying a project allows for easy cloning of project content with just a click of a button. ~~Copied projects immediately inherits the selected project which means the~~ resulting ~~copied~~ project ~~becomes~~ a child project.		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 original 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.		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\|~~thumb\|800x800px~~]]		[[File:Manage - Copybtn.png\|none\|800px]]
	The create copy project screen is very similar to the project creation screen where the user needs to input a new name and description for the copied project. Additionally, the user needs to decide whether or not they want to copy all of the permissions that are currently selected from the source project to the copied project before saving.		The create copy project screen is very similar to the project creation screen where the user needs to input a new name and description for the copied project. Additionally, the user needs to decide whether or not they want to copy all of the permissions that are currently selected from the source project to the copied project before saving.
	[[File:Manage - CopyCreate.png\|none\|~~thumb\|800x800px~~]]		[[File:Manage - CopyCreate.png\|none\|800px]]

	== Sample Workflow ==		== Sample Workflow ==

Derek: /* Copying a Project */

2024-07-23T17:16:56Z

Copying a Project

← Older revision		Revision as of 13:16, 23 July 2024
Line 64:		Line 64:
	[[File:Phenom-manage-model details2.png\|border\|800x800px]]		[[File:Phenom-manage-model details2.png\|border\|800x800px]]

	== ~~Copying a~~ Project ==		== Copy Project ==
	Copying a project allows for easy cloning of project content with just a click of a button. Copied projects immediately inherits the selected project which means the resulting copied project becomes a child project.		Copying a project allows for easy cloning of project content with just a click of a button. Copied projects immediately inherits the selected project which means the resulting copied project becomes a child project.

Derek at 19:03, 22 July 2024

2024-07-22T19:03:44Z

← Older revision		Revision as of 15:03, 22 July 2024
Line 121:		Line 121:
	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.		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:~~Workflow~~ - ~~Final~~.png\|border\|600x600px]]		[[File:Manage workflow - Final2.png\|border\|600x600px]]

	Dave and Riley will now be able to independently edit DSDM content and merge changes between their two models as they see appropriate.		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.		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.

← Older revision		Revision as of 14:39, 23 July 2024
Line 78:		Line 78:
	=== Part 1 – Chris ===		=== 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.		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:Workflow-newModel.png\|border\|600x600px]]~~		[[File:Worlflow - CreatedSubmodel.png\|border\|300px]]

	[[File:Worlflow - CreatedSubmodel.png\|border\|~~300x300px~~]]

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

	[[File:Worlflow - CreatingProject.png\|border\|~~600x600px~~]]		[[File:Worlflow - CreatingProject.png\|border\|800px]]

	[[File:Workflow - SwitchProject.png\|border\|~~300x300px~~]]		[[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.		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\|~~300x300px~~]]		[[File:Workflow - PublishProject.png\|border\|300px]] [[File:Worklow - PublishedModel.png\|border\|300px]]

	[[File:Worklow - PublishedModel.png\|border\|~~300x300px~~]]

	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.		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\|~~829x829px~~]]		[[File:Phenom-manage-example-chris-7.png\|border\|800px]]

	=== Part 2 – Dave ===		=== 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.		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\|~~600x600px~~]]		[[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.		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\|~~600x600px~~]]		[[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.		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\|~~812x812px~~]]		[[File:Phenom-manage-example-dave-4.png\|border\|800px]]

	=== Part 3 – Nick & Riley ===		=== Part 3 – Nick & Riley ===
Line 116:		Line 113:
	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.		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\|~~600x600px~~]]		[[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.		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.		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\|~~600x600px~~]]		[[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.		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.		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.