Template Project: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
No edit summary
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{being updated}}
[[File:Api_tools_geo.png|thumb|right|400px|[[Template]] in relation to [[Source]]s and [[Geo Plugin]]s]]
{{learned|what a template in the {{software}} is|which data are transferred to a new project|how to create a template project|how to share your project template within your domain|how to use a template project}}
 
==What is a template in the {{software}}==
A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same [[Indicators]] and [[Actions]]. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.
A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same [[Indicators]] and [[Actions]]. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.


==Which elements are transferred to a new project==
==Which elements are transferred to a new project==
In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.<br>
In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.
 
===Elements that ''are transferred'' to a new project===
===Elements that ''are transferred'' to a new project===
* [[Indicators]]
* [[Indicator]]s
* [[Stakeholders]]
* [[Stakeholder]]s
* [[Overlay]]s and their settings, such as the grid size
* [[Overlay]]s and their settings, such as the grid size
* New [[functions]]/changes in [[function values]]
* New [[Functions]]/changes in [[function values]]
* New [[terrain types]]/changes in terrain types
* New [[Terrain Type]]s/changes in terrain types
* [[Globals]]
* [[Global]]s
* [[Actions|Action menus]]
* [[Action Menu]]s
* New/changed [[Upgrade types]]
* New/changed [[Upgrade Type]]s
* [[WFS]] connections in the [[Geo Data Wizard]]
* [[WFS]] connections in the [[Geo Data Wizard]]
<br>
* [[Geo Plugin]]s


===Elements that are ''not transferred'' to a new project===
===Elements that are ''not transferred'' to a new project===
* [[Areas]], [[Buildings]], [[Neighborhoods]], [[Networks]],[[Plots]], [[Terrains]], [[Zip codes]], [[Zones]]
* [[Area]]s, [[Building]]s, [[Neighborhood]]s, [[Network]]s,[[Plot]]s, [[Terrain]]s, [[Zone]]s
:These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
:These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
* [[Measures]]
* [[Measure]]s
:Measures are drawn at a certain location and, therefore, not applicable to other locations/projects.
:Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
* [[Cinematics]]
* [[Cinematics]]
:In a cinematic the camera has a specific location within the 3D world, which will not be applicable to other locations/projects.
:A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
* [[Panels]]
* [[Panel]]s
: Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.  
: Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.  
<br>


===Special elements that need to be ''adjusted accordingly'' after creating a new project based on a template===
===Transferred elements that rely on spatial data===
* [[Overlay]]s
* [[Overlay]]s
: Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the [[Rainfall_(Overlay)|rainfall overlay]], such as water level areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, ''are'' transferred from the template.
: Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the [[Rainfall Overlay]], such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, ''are'' transferred from the template.
* [[Panels]]
: The content of the panels is transferred to a new project, but their location must be reset.
 
==How to create a template project==
See below for the full list of steps for creating a template project. The steps are in short explained in this section.
<br>
<br>
To create a template project, start with a project that you want to use as a template for other projects.


===Template settings===
===Template settings===
Line 47: Line 36:
{{Editor location|Template}}
{{Editor location|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.
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. Changes made are stored in [[Geo Option]] items.
 
===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.
 
===Remove non-generic elements===
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''.
 
===Domain admin rights===
[[File:Template_projects.JPG|right|500px]]
Setting a project as a template can only be done by users with [[Account_management#Domain_Admin|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.


Below the list of steps for creating a new template project.
<br>
<br>
{{Editor steps|title=create a template project|Start with a project you want to use as a template|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| Clear map. '''Warning''': this will remove the 3D world from your project, which cannot be undone (the reason for step 2).|When the map is cleared, remove any elements that are non-generic|Save and close the project|Log in to the main menu (make sure you have domain-admin rights)|Go to ''Options'' and select ''Projects''| Click on the check box named "Template" to mark the project as a template}}
==Sharing your template with other users in a domain==
[[File:Q1-2016-TemplatePermissions2.jpg|right|500px]]
When a project has been made a template project, the read and write permissions have been changed. This is to ensure that nobody accidentally edits the project. No write permissions remain (the project can no longer be edited and saved, unless the creator changes this) and only the creator can read the template by default. In order to change the read permissions, so that other users within the same domain can also make use of the template, the creator has to change the permissions of the original project in the Editor.
<br>
<br>
{{Editor steps|title=share the template with other users in the domain|Load in the Editor the template project to be shared with the domain|Select "File" when in main view|Select "Permissions"| Change the entry for "Other users in domain" to "Read"|Save project}}
==Applying a template to a new project==
[[File:Choose_template.PNG|right|500px]]
When creating a new project based on a template project, follow the same steps as for creating a new project, but instead of selecting ''Empty project'', select the template project in the project wizard. The image on the right shows an example where the user can select the Tygron Net template by clicking on the ''Use Tygron Net Template'' button).


{{article end
{{article end
|howtos=* [[How to create a Template Project]]
|howtos=
* [[How to create a Template Project]]
* [[How to share a Template Project with other users in your domain]]
* [[How to base a new Project on a Template Project]]
|videos={{video|gallery=
{{video|link=https://youtu.be/VZrazrmgYZM|description=Video tutorial on using Template Projects.}}
}}
}}
}}
==See Also==
* [[File:Templates.jpg| link=https://youtu.be/VZrazrmgYZM|left|thumb|Templates]]


{{editor tools nav}}
{{editor tools nav}}
[[Category:Project Metadata]]

Latest revision as of 14:45, 28 September 2023

Template in relation to Sources and Geo Plugins

A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same Indicators and Actions. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.

Which elements are transferred to a new project

In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.

Elements that are transferred to a new project

Elements that are not transferred to a new project

These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.

Transferred elements that rely on spatial data

Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the Rainfall Overlay, such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, are transferred from the template.

Template settings

Template settings panel.png
Editor → Tools (Ribbon tab) → Template (Ribbon bar)

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. Changes made are stored in Geo Option items.


How-to's

Videos

Video tutorial on using Template Projects.
Editor ribbon icon tools.pngTools
Tools
Building style • Environment • Cinematics • Screenshot • Free Cam • Web Interface • API Overview • Triggers • Template • Geo Plugins • Debug Info
Environment
Sun angle • Solar Panels • Lighting • Weather
Cinematics
Special Effects • Particle Emitters
Screenshot
GIF animation • Video recording
Geo Plugins
Error Logs • Geo Links • Geo Options • Sources
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://previewsupport.tygron.com/w/index.php?title=Template_Project&oldid=55578"