How to create a Template Project: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
Created page with "After creating a Project, it may be desirable to apply the implemented calculation models and tools to other Projects and locations as well. For these situations, it's..."
 
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
No edit summary
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
After creating a [[Project]], it may be desirable to apply the implemented calculation models and tools to other [[Project]]s and locations as well. For these situations, it's possible to turn a [[Project]] into a [[Project Template]], so that when a new [[Project]] is created, the previously created models and tools are immediately added to the new [[Project]].
After creating a [[Project]], it may be desirable to apply the implemented calculation models and tools to other [[Project]]s and locations as well. For these situations, it's possible to turn a [[Project]] into a [[Template Project]], so that when a new [[Project]] is created, the previously created models and tools are immediately added to the new [[Project]].


Creating a [[Project Template]] consists of 2 steps: tweaking the content of the existing [[Project]] to be free of location- and use-case specific information, and flagging the [[Project]] to be usable as a [[Project Template]].
Creating a [[Template Project]] consists of 2 steps: tweaking the content of the existing [[Project]] to be free of location- and use-case specific information, and flagging the [[Project]] to be usable as a [[Template Project]].
 
<youtube>KXO_sJKoU1E</youtube>


==Cleaning the existing Project==
==Cleaning the existing Project==
[[File:Template_settings_panel.png|right|500px]]
[[File:Template_settings_panel.png|right|500px|Template projects in the New Project Wizard]]
{{Editor location|Template}}
{{Editor location|Template}}


Line 10: Line 12:
|Create a copy by saving the project under a different name
|Create a copy by saving the project under a different name
|Go in the Editor menu to ''Tools'' > ''Template'' > ''Template settings''|Set the desired data sources for new projects based on this template
|Go in the Editor menu to ''Tools'' > ''Template'' > ''Template settings''|Set the desired data sources for new projects based on this template
| Clear map. '''Warning''': this will remove the 3D world from your project, which cannot be undone (the reason for step 2).
| Clear map. '''Warning''': this will remove all [[item]]s with a geometry from your project, which cannot be undone (the reason for step 2).
|When the map is cleared, remove any elements that are non-generic
|When the map is cleared, remove any elements that are non-generic
|Save and close the project
|Save and close the project
}}
}}


In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template.
In the template settings screen, the data sources that should be used by default when using this template can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template.


===Clear map===
===Clear map===
Line 21: Line 23:
The clear map option is a permanent setting and cannot be undone. Therefore, it is recommended to make a copy of your project by saving it under a different name.
The clear map option is a permanent setting and cannot be undone. Therefore, it is recommended to make a copy of your project by saving it under a different name.


===Remove non-generic elements===
==Setting the Project as a Template==
When the map is cleared, remove elements that are non-generic, for example, stakeholder names. The stakeholder Municipality is named after the municipality belonging to the project area. If the template project is created for The Hague, the stakeholder is called ''Municipality The Hague''. If you apply the template on a project in Amsterdam, the stakeholder will use the previous name combined with the new name, which will result in ''Municipality The Hague Amsterdam.'' Therefore, in the template project, remove the part where it says ''The Hague'', so the stakeholder in the template project will be named just ''Municipality''. This way the new name in the Amsterdam project will become ''Municipality Amsterdam''.
{{clear}}
 
==Flagging the Project as a Template==
[[File:Template_projects.JPG|right|500px]]
[[File:Template_projects.JPG|right|500px]]


{{Editor steps|title=flag the Project to be usable as a template
{{Editor steps|title=flag the Project to be usable as a template
|Log in to the main menu (make sure you have domain-admin rights)
|Log in with an account that has domain-admin rights
|Go to ''Options'' and select ''Projects''
|In the [[Main Menu]], go to ''Options'' and select ''Projects''
|Click on the check box named "Template" to mark the project as a template
|Click on the check box named "Template" to mark the project as a template
}}
}}


Setting a project as a template can only be done by users with [[Account_management#Domain_Admin|Domain Administrator]] rights.
Setting a project as a template can only be done by users with [[Domain Admin (User Account Type)|Domain Administrator]] rights.
When a project has been turned into a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. The permissions will be set to either ''none'' or ''read'', so the project cannot be edited anymore. By default only the creator can read the template and the template is not shared with other users within your domain. Please refer to the next paragraph on how to make templates available for a domain.
When a project has been turned into a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. The permissions will be set to either ''none'' or ''read'', so the project cannot be edited anymore. By default only the creator can read the template and the template is not shared with other users within your domain. Please refer to the next paragraph on how to make templates available for a domain.
{{article end
|notes=
* If the [[Project]] which is to be turned into a [[Template Project]] is large, it is advised to apply ''Clear Map'' to remove all spatial information in the project. Always add a [[Project Version]] first or apply ''Save As'' before applying Clear Map.
|howtos=
* [[How to share a Template Project with other users in your domain]]
* [[How to base a new Project on a Template Project]]
|seealso=
* [[Template Project]]
|api=
*[[Api session event editor clear map]]
}}
[[Category:How-to's]]

Latest revision as of 11:30, 7 July 2026

After creating a Project, it may be desirable to apply the implemented calculation models and tools to other Projects and locations as well. For these situations, it's possible to turn a Project into a Template Project, so that when a new Project is created, the previously created models and tools are immediately added to the new Project.

Creating a Template Project consists of 2 steps: tweaking the content of the existing Project to be free of location- and use-case specific information, and flagging the Project to be usable as a Template Project.

Cleaning the existing Project

Template projects in the New Project Wizard
Template projects in the New Project Wizard
Editor → Tools (Ribbon tab) → Template (Ribbon bar)
How to clean a Project:
  1. Start with a project you want to use as a template
  2. Create a copy by saving the project under a different name
  3. Go in the Editor menu to Tools > Template > Template settings
  4. Set the desired data sources for new projects based on this template
  5. Clear map. Warning: this will remove all items with a geometry from your project, which cannot be undone (the reason for step 2).
  6. When the map is cleared, remove any elements that are non-generic
  7. Save and close the project

In the template settings screen, the data sources that should be used by default when using this template can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template.

Clear map

The map needs to be cleared, so the project size will be small. This will ensure that the creation of a new project based on the template will be as fast as possible. The clear map option is a permanent setting and cannot be undone. Therefore, it is recommended to make a copy of your project by saving it under a different name.

Setting the Project as a Template

How to flag the Project to be usable as a template:
  1. Log in with an account that has domain-admin rights
  2. In the Main Menu, go to Options and select Projects
  3. Click on the check box named "Template" to mark the project as a template

Setting a project as a template can only be done by users with Domain Administrator rights. When a project has been turned into a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. The permissions will be set to either none or read, so the project cannot be edited anymore. By default only the creator can read the template and the template is not shared with other users within your domain. Please refer to the next paragraph on how to make templates available for a domain.


Notes

  • If the Project which is to be turned into a Template Project is large, it is advised to apply Clear Map to remove all spatial information in the project. Always add a Project Version first or apply Save As before applying Clear Map.

How-to's

See also

API Endpoints

Retrieved from "https://support.tygron.com/w/index.php?title=How_to_create_a_Template_Project&oldid=89559"