Geo Plugins tutorial: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 2: Line 2:


{{tutorial prerequisites
{{tutorial prerequisites
|tutorial=This tutorial is a continuation of the [[Template Project Tutorial]]. If you have not already done so, please complete that tutorial first.
|tutorial=Parts of this tutorial are a continuation of the [[Template Project Tutorial]]. If possible, and if you have not already done so, please complete that tutorial first.
|project=This tutorial can be started based on any arbitrary Project in the Netherlands, however it is assumed that a new Project is created to start off with. Note that multiple new Projects will be created during this tutorial.
|project=This tutorial can best be started with a Project in the city of The Hague in the Netherlands, due to one of the used data sources being specific to that city. Note that multiple new Projects will be created during this tutorial.
|additional=To work with Project templating functionality fully (specifically, to assign Template status to a Project), either Domain Admin access rights are required, or the assistance of a Domain Admin for your organisation is required.
|additional=To work with Project templating functionality fully (specifically, to assign Template status to a Project), either Domain Admin access rights are required, or the assistance of a Domain Admin for your organisation is required.
|Start the {{software}} application, and if necessary log in so you are in the main menu.
|Start the {{software}} application, and if necessary log in so you are in the main menu.
}}
}}
==Introduction to Geo Plugins==
The {{software}} allows for the importing of geo data to enrich a [[Project]]. This can serve to both amend data which the {{software}} already supplies, but also to add types of data which are unique to the use-case at hand. When importing data, almost all of the related operations are to determine precisely how the imported data relates to the potential data types and subtypes available in a {{software}} [[Project]].
[[Geo Plugin]]s offer a way to store such a mapping, so that import operations can be easily repeated. In them, information is stored about which data can be found in the relevant data source, and how that data should be interpreted or modified when it is imported. They can then be used when manually importing data, but can also be called upon when a new Project is created to automatically obtain data relevant for the use-case and models the [[Template Project]] entails.
==Creating a Project to create Geo Plugins in==
Any [[Project]] may contain any number of [[Geo Plugin]]s. However, for the purpose of this tutorial a [[Project]] in a specific location is required, due to some of the steps relying on a datasource which has data only in a specific region.
{{page break}}


{{Tutorial completed
{{Tutorial completed
| learned=how to create [[Geo Plugin]]s and use them to automatically map geo data, and use them to automatically retrieve data when using your [[Project]] as a [[Template]] to create a new Project
| learned=how to create [[Geo Plugin]]s and use them to automatically map geo data, and use them to automatically retrieve data when using your [[Project]] as a [[Template]] to create a new Project
}}
}}

Revision as of 13:08, 2 November 2022

This tutorial is a stub.

Prerequisites

The following prerequisites should be met before starting this tutorial:

  • Parts of this tutorial are a continuation of the Template Project Tutorial. If possible, and if you have not already done so, please complete that tutorial first. If you have not yet followed the tutorials related to those subjects please do so first.
  • This tutorial can best be started with a Project in the city of The Hague in the Netherlands, due to one of the used data sources being specific to that city. Note that multiple new Projects will be created during this tutorial.
  • To work with Project templating functionality fully (specifically, to assign Template status to a Project), either Domain Admin access rights are required, or the assistance of a Domain Admin for your organisation is required. 

Preparations

Take the following steps as preparation for following this tutorial:

  • Start the Tygron Platform application, and if necessary log in so you are in the main menu.

Introduction to Geo Plugins

The Tygron Platform allows for the importing of geo data to enrich a Project. This can serve to both amend data which the Tygron Platform already supplies, but also to add types of data which are unique to the use-case at hand. When importing data, almost all of the related operations are to determine precisely how the imported data relates to the potential data types and subtypes available in a Tygron Platform Project.

Geo Plugins offer a way to store such a mapping, so that import operations can be easily repeated. In them, information is stored about which data can be found in the relevant data source, and how that data should be interpreted or modified when it is imported. They can then be used when manually importing data, but can also be called upon when a new Project is created to automatically obtain data relevant for the use-case and models the Template Project entails.

Creating a Project to create Geo Plugins in

Any Project may contain any number of Geo Plugins. However, for the purpose of this tutorial a Project in a specific location is required, due to some of the steps relying on a datasource which has data only in a specific region.

Tutorial completed

Congratulations. You have now completed this tutorial. In it, you have learned how to create Geo Plugins and use them to automatically map geo data, and use them to automatically retrieve data when using your Project as a Template to create a new Project.