Template Project: Difference between revisions
No edit summary |
|||
Line 1: | Line 1: | ||
{{learned|what a template in the Tygron Engine is|which data is transferred to a new project|how to create a template project|how to | {{learned|what a template in the Tygron Engine is|which data is 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 Tygron Engine== | ==What is a template in the Tygron Engine== | ||
Line 25: | Line 25: | ||
:Measures are drawn on a certain location, this location is also not present in the new project anymore | :Measures are drawn on a certain location, this location is also not present in the new project anymore | ||
* [[Cinematics]] | * [[Cinematics]] | ||
:In a cinematic, the camera has a certain location in the 3D world, since the location is different in the new project, the cinematic will not be | :In a cinematic, the camera has a certain location in the 3D world, since the location is different in the new project, the cinematic will not be transferred. | ||
==How to create a template project== | ==How to create a template project== | ||
To create a template project, start with a project that you want to use as a template for other projects. | 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 the 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 the template. | ||
===Clear map=== | |||
The map needs to be cleared, so the project size will be small This will ensure 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 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 can't be undone. Even if the project is not saved after the map is cleared, when opening the project again the map will be empty. Therefore it is recommended to create a new version first, or to make a copy of your project by saving the project under a different name. | The clear map option is a permanent setting and can't be undone. Even if the project is not saved after the map is cleared, when opening the project again the map will be empty. Therefore it is recommended to create a new version first, or to make a copy of your project by saving the project under a different name. | ||
When the map is cleared, remove elements that are not generic for other projects. For example, stakeholder names | ===Remove not generic elements=== | ||
When the map is cleared, remove elements that are not generic for other projects. For example, stakeholder names. The stakeholder municipality is named after the municipality in where the project area lies. 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 ''The Hague'' part, so the stakeholder in the template project will be named only Municipality and in the new project in Amsterdam ''Municipality Amsterdam''. | |||
===Domain admin rights=== | |||
Setting a project as a template can only be done by users with [[Account_management#Domain_Admin|Domain Administrator]] rights. By default the template is not shared with other users within your domain. Please refer to the next paragraph about making templates available for the domain. | Setting a project as a template can only be done by users with [[Account_management#Domain_Admin|Domain Administrator]] rights. By default the template is not shared with other users within your domain. Please refer to the next paragraph about making templates available for the domain. | ||
Revision as of 12:04, 7 May 2018
What is a template in the Tygron Engine
A template is a project that can be used to create a new project with. This new project can have a different location as the original template project, but has the same Indicators, Actions, Overlays settings etc. as the template project. This is very convenient in case a similar spatial issue is at hand on different locations and you want to create different projects for these locations. Also, this functionality enables the user to make elaborate predefined actions or custom indicators, which can then be easily applied with a template to another area. This functionality saves a lot of time and makes preparing projects faster.
Which elements are transferred to a new project
In a template project, elements that are not spatial, thus the elements that are not linked to a location will be transferred to a new project.
Examples of elements that are transferred to a new project are:
- Indicators
- Overlays
- Stakeholders
- New functions/changes in function values
- Globals
- Actions
- New/changed Upgrade types
- WFS connections in the Geo Data Wizard
- Panels (the content of the panels is transferred to a new project, but the locations of these panels must be set)
Examples of elements that are not transferred to a new project are:
- (Imported) Areas
- The areas have a certain location in the template project. The new project is very likely on a new location and therefore the areas are not in that location and in the new project
- Measures are drawn on a certain location, this location is also not present in the new project anymore
- In a cinematic, the camera has a certain location in the 3D world, since the location is different in the new project, the cinematic will not be transferred.
How to create a template project
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 the template.
Clear map
The map needs to be cleared, so the project size will be small This will ensure 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 can't be undone. Even if the project is not saved after the map is cleared, when opening the project again the map will be empty. Therefore it is recommended to create a new version first, or to make a copy of your project by saving the project under a different name.
Remove not generic elements
When the map is cleared, remove elements that are not generic for other projects. For example, stakeholder names. The stakeholder municipality is named after the municipality in where the project area lies. 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 The Hague part, so the stakeholder in the template project will be named only Municipality and in the new project in Amsterdam Municipality Amsterdam.
Domain admin rights
Setting a project as a template can only be done by users with Domain Administrator rights. By default the template is not shared with other users within your domain. Please refer to the next paragraph about making templates available for the domain.
See below for the list of steps for creating a template project.
- Start with a project you want to use as a template
- Create a new version of your project
- Go in the Editor Ribbon 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 and can't be undone. Therefore you have created a new version first in step 2.
- When the map is cleared, remove elements that are not generic
- Save the project under a new name so as to create a new project or create a new version and close the project
- 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 project template, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. No write permissions remain (project cannot be edited anymore) 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 use the template, the creator can change the permissions of the original project in the editor.
- 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
Using the template project
The template project can be applied on a new project by clicking on the new Project button in the menu. In the screen where also the name for the new project can be selected, the template project button should be used. The rest of the steps is the same as for creating a new project