Template Project: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{being updated}} | {{being updated}} | ||
{{learned|what a template in the {{software}} is|which data | {{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}}== | ==What is a template in the {{software}}== | ||
A template | 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, | 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> | ||
=== | ===Elements that ''are transferred'' to a new project=== | ||
* [[Indicators]] | * [[Indicators]] | ||
* [[Stakeholders]] | * [[Stakeholders]] | ||
| Line 19: | Line 18: | ||
<br> | <br> | ||
=== | ===Elements that are ''not transferred'' to a new project=== | ||
* (Imported) [[Areas]] | * (Imported) [[Areas]] | ||
:The areas | :The areas are bound to a specific location in the template project and, therefore, not applicable to other locations/projects. | ||
* [[Measures]] | * [[Measures]] | ||
:Measures are drawn | :Measures are drawn at a certain location and, therefore, not applicable to other locations/projects. | ||
* [[Cinematics]] | * [[Cinematics]] | ||
:In a cinematic | :In a cinematic the camera has a specific location within the 3D world, which will not be applicable to other locations/projects. | ||
<br> | <br> | ||
| Line 31: | Line 30: | ||
===Special elements that need to be ''adjusted accordingly'' after creating a new project based on a template=== | ===Special elements that need to be ''adjusted accordingly'' after creating a new project based on a template=== | ||
* [[Overlays]] | * [[Overlays]] | ||
: Overlays are transferred to a new project (they will be recalculated for the new project) | : 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. | ||
* [[Panels]] | * [[Panels]] | ||
: The content of the panels is transferred to a new project, but | : The content of the panels is transferred to a new project, but their location must be reset. | ||
==How to create a template project== | ==How to create a template project== | ||
| Line 46: | Line 45: | ||
{{Editor ribbon|header=Tools|bar=Template}} | {{Editor ribbon|header=Tools|bar=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 | 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=== | ||
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 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 | 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 | ===Remove non-generic elements=== | ||
When the map is cleared, remove elements that are | 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=== | ===Domain admin rights=== | ||
[[File:Template_projects.JPG|right|500px]] | [[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. | 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 | 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 template project. | Below the list of steps for creating a new template project. | ||
<br> | <br> | ||
<br> | <br> | ||
{{Editor steps|title=create a template project|Start with a project you want to use as a template| | {{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 the project and then close it|Log in to the main menu (make sure you have domain admin rights)|Go to ''Options'' and then select ''Projects''| Click on the Check box named "Template" to mark the project as a template}} | ||
==Sharing your template with other users in your domain== | ==Sharing your template with other users in your domain== | ||
[[File:Q1-2016-TemplatePermissions2.jpg|right|500px]] | [[File:Q1-2016-TemplatePermissions2.jpg|right|500px]] | ||
When a project has been made a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project. No write permissions remain (project cannot be edited and | When a project has been made a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project. No write permissions remain (project cannot be edited and saved anymore, 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 can change the permissions of the original project in the Editor. | ||
<br> | <br> | ||
<br> | <br> | ||
{{Editor steps|title=share the template with other users in your domain|Load in the | {{Editor steps|title=share the template with other users in your 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 project on a new project== | ==Applying a template project on a new project== | ||
[[File:Choose_template.PNG|right|500px]] | [[File:Choose_template.PNG|right|500px]] | ||
For creating a new project based on a template project, follow the steps for creating a new project, but choose instead of Empty project the template project in the project wizard (see image on the right in where the user can select the Tygron Net template by clicking on the ''Use Tygron Net template button''). | For creating a new project based on a template project, follow the steps for creating a new project, but choose instead of Empty project the template project in the project wizard (see image on the right in where the user can select the Tygron Net template by clicking on the ''Use Tygron Net template button''). | ||
Revision as of 10:10, 10 April 2019
Please note: This page is currently being updated.
What is a template in the Tygron Platform
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
- Indicators
- Stakeholders
- Overlays settings, such as the grid size
- New functions/changes in function values
- Globals
- Action menus
- New/changed Upgrade types
- WFS connections in the Geo Data Wizard
Elements that are not transferred to a new project
- (Imported) Areas
- The areas are bound to a specific location in the template project and, therefore, not applicable to other locations/projects.
- Measures are drawn at a certain location and, therefore, not applicable to other locations/projects.
- In a cinematic the camera has a specific location within the 3D world, which will not be applicable to other locations/projects.
Special elements that need to be adjusted accordingly after creating a new project based on a 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 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.
- 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.
To create a template project, start with a project that you want to use as a template for other projects.
Template settings
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.
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
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.
Below the list of steps for creating a new template project.
How to 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 the project and then close it
- Log in to the main menu (make sure you have domain admin rights)
- Go to Options and then select Projects
- Click on the Check box named "Template" to mark the project as a template
Sharing your template with other users in your domain
When a project has been made a template project, the read and write permissions will change. This is to ensure that nobody accidentally edits the project. No write permissions remain (project cannot be edited and saved anymore, 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 can change the permissions of the original project in the Editor.
How to share the template with other users in your 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 project on a new project
For creating a new project based on a template project, follow the steps for creating a new project, but choose instead of Empty project the template project in the project wizard (see image on the right in where the user can select the Tygron Net template by clicking on the Use Tygron Net template button).