Indicator: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
Joris (talk | contribs)
Tygron, Administrators
628 edits
Maxim@tygron.com (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Administrators
5,955 edits
No edit summary
 
(417 intermediate revisions by 18 users not shown)
Line 1: Line 1:
After reading this page[[File:Ui_-_topbar.jpg|framed|right|The top bar of the interface. The indicators are Budget, Building and Progress.]]
[[File:Api_current_situation_calculation.png|thumb|right|400px|[[Overlay]] in comparison to [[Measurement]]s, [[Indicator]]s and [[Global]]s]]
Indicators are named after Key Performance Indicators (KPI), which serve as a means to identify potential improvements and as a metric for the degree to which those improvements have been successful.


* You've learned what indicators are
Indicators are visible at the top of the [[interface]]. Each indicator has a short name and, except for the budget, a progress bar showing current performance. Indicators can also be inspected by clicking on its element in the top bar, which opens the [[indicator panel]].
* You've learned what predefined indicators exist in the Tygron Engine
* You've learned what other parts of a game can influence indicators
* You've learned how to alter existing indicators in your game
* You've learned how to add and remove complete indicators


==Indicators==
==Score==
The progress made on an indicator depends on the ''absolute score'' setting of the indicator:
* When selected, the progress is based on the absolute score.
* When not selected, the progress is relative to the calculate score in the current situation. Such an indicator will measure the relative improvements.


Indicators are the themes for which targets exist in a game. They are named after Key Performance Indicators, a measure by which organizations evaluate their success. Indicators are a primary part of your game, and serve as the guiding element by which players can determine whether they are making progress.
In the indicator panel, the indicator's full name is shown in the title, along with a description and indicator progress on the left. On the right part of this panel a calculated <code>SCORE</code> and an <code>EXPLANATION</code> are shown. The <code>SCORE</code> and <code>EXPLANATION</code> are produced by the indicator's [[Excel Sheet]]. This Excel sheet calculates a score and explanation, placing them in designated cells. The excel sheet is also able to obtain information from a project using [[TQL|Tygron Query Language (TQL)]] statements. A change in the project state provides input to the indicator, the indicator spreadsheet performs calculations based on this input and displays the result as output in the indicator and progress panel on the top bar.<br/>


Indicators are visible in-game at the top of the interface. Each indicator is represented by a short name, and (with exception of the budget) is accompanied by a small progress bar to indicate how well you are performing on that indicator.
To better understand the implementation of the Excel Indicator, please follow the [[Indicators Tutorial]].


Each indicator has a name, a description, a color and a goal. The goal is the most important part of the indicator, because that is what drives a stakeholder to perform (or abstain from) an action. Each action a stakeholder takes is meant to advance their indicators.
[[File:ExcelFlow2-Q3-2015.jpg|300px|left]]
[[File:exce10a-Q3-2015.jpg|right|thumb|Detail from sample Indicator Excel File]]


===Types of indicator===
<br clear=all>


A number of indicator types already exist in the Tygron Engine. The available indicator types are dividable into 2 groups, namely indicators that are stakeholder-specific, and indicators that apply globally. The following predefined indicator types exist:
The following output labels can be used to show text or numbers in the indicator panel at the top bar.


'''Stakeholder-specific indicators'''
: <code>EXACT_NUMBER_VALUE</code>: A numerical value that is formatted using the unit system selected for your project. Replaces the indicator's progress bar.
*Budget
: <code>EXACT_TEXT_VALUE</code>: A text value that will be used instead of the progress bar.
*Building
'''Global indicators'''
*Green
*Parking
*Livability
*Water Storage
*Qualitative


Lastly, each player also has a progress indicator. This indicator cannot be altered directly. It sums up the scores achieved on the other indicators, based on their [[importance]].
==Explanation==
This is the text shown in the lower left corner of the Indicator panel during a session. The explanation text can be written in HTML format. The cell should be named <code>EXPLANATION</code>. When using explanation texts, you may also want to include numbers and/ or text output from your excel. For this you can include <code>%s</code> values, which will be replaced by <code>VAR_#</code> cells, starting from <code>VAR_0</code>.


Please read more about the various [[Indicator types|Indicator types]].
[[File:ExcelIndicatorPanelExplanation2-Q3-2015.jpg|thumb|left|Explanation field on Indicator Panel]]
{{clear}}
====Simple text string as EXPLANATION output====
A simple HTML text string as <code>EXPLANATION</code> output can be written as follows:


===Influencing Indicators===
<code><nowiki><p>SOCIAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p></nowiki></code>


During the game, players are able to influence indicators by taking [[actions]]. Almost every action has an effect on at least one indicator. It is up to the players to apply their actions appropriately to increase the score on their indicators. It is possible to adjust the effects actions have on indicators. For more information on this, please read about [[Function values|changing function values]].
In this string, values from cells named <code>VAR_0</code> to <code>VAR_4</code> are being used to output values in the explanation text.  


==Editing Indicators==
Combining three strings with only a change in category names will cover <code>VAR_0</code> to <code>VAR_18</code> and results in the following:


There are two ways to change the indicators in your game. You can either edit existing indicators, or you can add or remove complete indicators from your game as required. To perform either task, you can open the "Indicators" panel from the "Indicators" menu in the editor.
<code><nowiki><p>SOCIAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p></nowiki></code><br/>
<code><nowiki><p>NORMAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p></nowiki></code><br/>
<code><nowiki><p>LUXE:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p></nowiki></code><br/>


&rarr; Menu
Which looks on the Excel Indicator panel in the project main view like this:
&rarr; Indicators
&rarr; Indicators


[[File:Editor - indicators.jpg|framed|none|The indicator screen of the editor.]]
[[File:ExcelIndicatorTextlExplanation-Q3-2015.jpg|thumb|left|Text string as <code>EXPLANATION</code>]]
<br clear=all>


===Changing indicators===
====HTML table as EXPLANATION output====


In the indicators panel in the editor, you can select an existing indicator from the list on the left. The rest of the panel will automatically be filled with the information pertaining to that indicator. A number of properties pertaining to an indicator can be edited.
As the above shows, with many <code>VAR_#</code> variables and categories present, the <code>EXPLANATION</code> field tends to lack clarity. To improve readability of the <code>EXPLANATION</code> output, it is recommended to implement a table format. To simplify the process, we recommend using an HTML table generator, such as: http://www.tablesgenerator.com/html_tables#.


;Name
This will result in the following table:
: The full name for indicator. This is the name that will appear as the title of the indicator in game.
;Short name
: The short name for indicator. This will appear in areas where multiple indicators are summed up.
;Color
: The color for the indicator. The color will be used to display the indicator in graphs and charts.
;Description
: The description for the indicator. Most indicator have a fitting default description, but by customizing this text it is possible to guide the players towards specific actions, provide hints or refer to other sources of information.
;Target
: The goal to reach for this indicator. This is the most important property, because by setting the target, you are directly instructing the stakeholder what they should strive for in the game. Depending on the selected indicator type, one or more values can be entered for targets. For example: for a budget indicator, you only need to set the amount of money the stakeholder should have remaining. For the building indicator, you can enter a separate goal for each type of building.


===Adding/removing indicators===
{| class="wikitable"
|-
! scope="col"| Housing Units
! scope="col"| Affordable Housing
! scope="col"| Market Housing
! scope="col"| Top Market Housing
! scope="col"| Totals
|-
! scope="row"| Total present
| %s units
| %s units
| %s units
| %s units
|-
! scope="row"| Already protected
| %s units
| %s units
| %s units
| %s units
|-
! scope="row"| To be added to protected area
| %s units
| %s units
| %s units
| %s units
|-
! scope="row"| Total Protected
| %s units
| %s units
| %s units
| %s units
|-
! scope="row"| Remaining unprotected
| %s units
| %s units
| %s units
| %s units
|}
[[File:ExcelTableExplanation-Q3-2015.jpg|thumb|left|HTML table as <code>EXPLANATION</code>]]


By right-clicking in the list of indicators on the left side of the panel, you can open a menu where you can add and remove indicators. Hover over "Add indicator" to make a second menu appear. Here you can select an indicator to add to the game. If you select "Budget" or "Building", you will also have to select a stakeholder for which to add the indicator. With the exception of the qualitative indicator, you can add 1 indicator of each type (the stakeholder-specific indicators, of which you can add 1 per stakeholder).


By right-clicking on an indicator in the list on the left side of the panel, you can also choose to delete the indicator you have clicked on. This removes the indicator from the game, so that the players will no longer need to score on it.
{{clear}}
 
==Influencing Indicators==
During a session, users' actions can influence Indicators, directly by spatial adjustments and [[TQL|spatial TQL statements]] and indirectly through [[Grid Overlay]] results and subsequent [[TQL|Grid TQL statements]]. It is up to the users to adjust their actions to improve the score on their Indicators. Also note that an action can also have effects on personal indicators of other stakeholders. For example, if a project developer creates a large office park where there previously was a forest, the amount of green will go down, which will negatively affect the goals of a municipality.
 
[[File:Improving_green_indicator.jpg|thumb|left|250px|Improving the green indicator by planning a forest of deciduous trees. The improvement is shown in green in the [[Action log panel]].]]
{{clear}}
The current situation (original) and maquette (planned) situation can be compared by switching between these situations using the buttons in the [[top bar]].
[[File:Current_situation_green_indicator.jpg|thumb|left|250px|Current situation of the green indicator when planning a forest of deciduous trees. Notice the selected ''original'' button in the [[top bar]].]]
[[File:Maquette_situation_green_indicator.jpg|thumb|center|250px|Maquette situation of the green indicator when planning a forest of deciduous trees. Notice the selected ''planned'' button in the [[top bar]].]]
{{clear}}
 
==Indicators on the GeoShare==
You can also import indicators from the {{geoshare}}. There is a set of indicators made available in the {{Public Share}}. It is also possible to import indicators from {{geoshare}} of your [[domain]]. Default public share indicators have wiki pages explaining any required project adjustments upon import. For example, some indicators require specific [[Indicator]] attributes, an [[Overlay]], or [[Area]]s to function.
<gallery heights=300px widths=300px>
File:Share_public_indicators_editor.png|The default indicators shown in the indicators tab in the editor.
File:Share_public_indicators.png|The indicators shown in the public {{geoshare}}.
</gallery>
 
The available default indicators are listed below.
Some of these indicators already perform specific calculations and can be directly used in the project. They can also be [[Indicators Tutorial|modified and extended with adjusted calculation]]s.
 
It is also possible to implement your own indicator, using an [[Excel|Excel file]]. This Excel file should be imported into your project and assigned to an indicator. Each added indicator is initially empty, and will require some work to set up, but it is highly customizable.
 
==Relation to stakeholders==
By default, when adding an indicator, it is visible to and accessible by all stakeholders, through an icon in the [[top bar]]. Access to an indicator can be restricted when it is made personal; a link to a stakeholder can be configured for an indicator. This stakeholder is then considered the owner of the indicator.
 
For more information on adding and removing indicators to stakeholders, see [[stakeholders]].
 
This relationship between an indicator and its personal stakeholder can be queried using TQL with the [[Relation (TQL Param)|Relation parameter]]:
* Stakeholder name: <code>SELECT_NAME_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER</code>
* Stakeholder id: <code>SELECT_ID_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER</code>
 
When using an excel for an Excel Indicator, you can also access the stakeholder directly using:
* Stakeholder name: <code>SELECT_NAME_WHERE_STAKEHOLDER_IS_ID</code>
* Stakeholder id: <code>SELECT_ID_WHERE_STAKEHOLDER_IS_ID</code>
 
[[File:Personal_heat_indicator.png|thumb|right| A personal heat indicator for the municipality. It is only visible in the top bar for this specific stakeholder.]]
 
<br clear=all>
 
==Excel Summary==
: Below is a small summary describing a suggested workflow from a bird's eye perspective, without going deeper into details:
<br>
{{Editor steps|title=create an Excel Indicator|Load a sample project in the editor.|Create an empty xlsx workbook.|Name one cell <code>EXPLANATION</code>.|Create the <code>EXPLANATION</code> output format (HTML text string, HTML table) with <code>%s</code> variables.|Decide, based on the <code>EXPLANATION</code>, which function categories are needed, and place them in one column.|Add consecutive columns that match the <code>EXPLANATION</code>.|Create the <code>VAR</code> columns with <code>ROUND(UP)</code> formulas and <code>VAR_n</code> name labels.|Create the <code>SCORE</code> field(s) as required by the type of project (Timeline/ Planning).|Optionally, test the spreadsheet by entering round values in query fields.|Create a new Excel Indicator in the project and upload the Excel file to the project.|Recalculate the indicators and verify if no errors are present.}}
 
===Tips===
*Divisions by zero can be solved as follows: <code>=C2/IF(D2,D2,1)</code>. In this example cells C2 and D2 contain number values. 
*Instead of using the VAR_# method for the explanation text, you can also use the concatenate function of excel:
<code>
CONCATENATE(<nowiki>"<p>",A2, ": ", E2, " m2 and in Safe Zone: ", F2, " m2</p>"</nowiki>)
</code>
*Starting with creating a table aids in setting up the Excel spreadsheet, by already thinking in advance about the lay out and formatting of the <code>EXPLANATION</code>.
*To quickly test the spreadsheet, without uploading it to the project, it is possible to enter some values in all the cells that contain queries as name. Other cells with formulas will change their content accordingly. By entering round values, for example 100, 1000, etc,  calculations can easily be verified. Don't forget to save first and to revert back to the last saved version when done verifying!
*To display an actual percentage sign in the explanation, you need to place two percentage signs. I.e. : "50% of houses" should be written as "50%% of houses".
 
{{article end
|seealso=
* [[Indicators Tutorial]]
* [[TQL]]
* [[Plotly]]
|howtos=
* [[How to upload an Indicator Excel]]
* [[How to edit Excel named Cells]]
* [[How to add or remove or duplicate an Indicator]]
* [[How to edit Indicator properties]]
* [[How to edit Indicator targets]]
* [[How to configure a Query for an Excel Indicator]]
* [[How to make the Green Garden Indicator]]
* [[How to manually adjust Indicators in Excel]]
* [[How to use the Query Tool to test queries from an Excel Indicator spreadsheet]]
* [[How to change Function Values for a Function]], to adjust the effects actions have on Indicators.
* [[How to make an Indicator visible to only one stakeholder]]
|videos=
{{video|youtube=Vv1XA3HCOyQ&t=734s}}
|external=
* [https://www.youtube.com/watch?v=Vv1XA3HCOyQ&t=734s TQL and Indicators Webinar]
 
|api=*[[Api session items indicators]]
*[[Api session event editor indicator]]
}}
 
{{Editor current situation nav}}
{{Indicator nav}}
[[Category:Items]][[Category:Indicator]]

Latest revision as of 11:42, 13 July 2026

Overlay in comparison to Measurements, Indicators and Globals

Indicators are named after Key Performance Indicators (KPI), which serve as a means to identify potential improvements and as a metric for the degree to which those improvements have been successful.

Indicators are visible at the top of the interface. Each indicator has a short name and, except for the budget, a progress bar showing current performance. Indicators can also be inspected by clicking on its element in the top bar, which opens the indicator panel.

Score

The progress made on an indicator depends on the absolute score setting of the indicator:

  • When selected, the progress is based on the absolute score.
  • When not selected, the progress is relative to the calculate score in the current situation. Such an indicator will measure the relative improvements.

In the indicator panel, the indicator's full name is shown in the title, along with a description and indicator progress on the left. On the right part of this panel a calculated SCORE and an EXPLANATION are shown. The SCORE and EXPLANATION are produced by the indicator's Excel Sheet. This Excel sheet calculates a score and explanation, placing them in designated cells. The excel sheet is also able to obtain information from a project using Tygron Query Language (TQL) statements. A change in the project state provides input to the indicator, the indicator spreadsheet performs calculations based on this input and displays the result as output in the indicator and progress panel on the top bar.

To better understand the implementation of the Excel Indicator, please follow the Indicators Tutorial.

Detail from sample Indicator Excel File


The following output labels can be used to show text or numbers in the indicator panel at the top bar.

EXACT_NUMBER_VALUE: A numerical value that is formatted using the unit system selected for your project. Replaces the indicator's progress bar.
EXACT_TEXT_VALUE: A text value that will be used instead of the progress bar.

Explanation

This is the text shown in the lower left corner of the Indicator panel during a session. The explanation text can be written in HTML format. The cell should be named EXPLANATION. When using explanation texts, you may also want to include numbers and/ or text output from your excel. For this you can include %s values, which will be replaced by VAR_# cells, starting from VAR_0.

Explanation field on Indicator Panel

Simple text string as EXPLANATION output

A simple HTML text string as EXPLANATION output can be written as follows:

<p>SOCIAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p>

In this string, values from cells named VAR_0 to VAR_4 are being used to output values in the explanation text.

Combining three strings with only a change in category names will cover VAR_0 to VAR_18 and results in the following:

<p>SOCIAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p>
<p>NORMAL:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p>
<p>LUXE:%s units total, of which %s are currently protected, %s are planned to be protected, protecting a total of %s units, leaving %s units unprotected</p>

Which looks on the Excel Indicator panel in the project main view like this:

Text string as EXPLANATION


HTML table as EXPLANATION output

As the above shows, with many VAR_# variables and categories present, the EXPLANATION field tends to lack clarity. To improve readability of the EXPLANATION output, it is recommended to implement a table format. To simplify the process, we recommend using an HTML table generator, such as: http://www.tablesgenerator.com/html_tables#.

This will result in the following table:

Housing Units Affordable Housing Market Housing Top Market Housing Totals
Total present %s units %s units %s units %s units
Already protected %s units %s units %s units %s units
To be added to protected area %s units %s units %s units %s units
Total Protected %s units %s units %s units %s units
Remaining unprotected %s units %s units %s units %s units
HTML table as EXPLANATION


Influencing Indicators

During a session, users' actions can influence Indicators, directly by spatial adjustments and spatial TQL statements and indirectly through Grid Overlay results and subsequent Grid TQL statements. It is up to the users to adjust their actions to improve the score on their Indicators. Also note that an action can also have effects on personal indicators of other stakeholders. For example, if a project developer creates a large office park where there previously was a forest, the amount of green will go down, which will negatively affect the goals of a municipality.

Improving the green indicator by planning a forest of deciduous trees. The improvement is shown in green in the Action log panel.

The current situation (original) and maquette (planned) situation can be compared by switching between these situations using the buttons in the top bar.

Current situation of the green indicator when planning a forest of deciduous trees. Notice the selected original button in the top bar.
Maquette situation of the green indicator when planning a forest of deciduous trees. Notice the selected planned button in the top bar.

Indicators on the GeoShare

You can also import indicators from the GeoShare. There is a set of indicators made available in the Public Share. It is also possible to import indicators from GeoShare of your domain. Default public share indicators have wiki pages explaining any required project adjustments upon import. For example, some indicators require specific Indicator attributes, an Overlay, or Areas to function.

  • The default indicators shown in the indicators tab in the editor.
    The default indicators shown in the indicators tab in the editor.
  • The indicators shown in the public GeoShare.
    The indicators shown in the public GeoShare.

The available default indicators are listed below. Some of these indicators already perform specific calculations and can be directly used in the project. They can also be modified and extended with adjusted calculations.

It is also possible to implement your own indicator, using an Excel file. This Excel file should be imported into your project and assigned to an indicator. Each added indicator is initially empty, and will require some work to set up, but it is highly customizable.

Relation to stakeholders

By default, when adding an indicator, it is visible to and accessible by all stakeholders, through an icon in the top bar. Access to an indicator can be restricted when it is made personal; a link to a stakeholder can be configured for an indicator. This stakeholder is then considered the owner of the indicator.

For more information on adding and removing indicators to stakeholders, see stakeholders.

This relationship between an indicator and its personal stakeholder can be queried using TQL with the Relation parameter:

  • Stakeholder name: SELECT_NAME_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER
  • Stakeholder id: SELECT_ID_WHERE_INDICATOR_IS_17_AND_RELATION_IS_OWNER

When using an excel for an Excel Indicator, you can also access the stakeholder directly using:

  • Stakeholder name: SELECT_NAME_WHERE_STAKEHOLDER_IS_ID
  • Stakeholder id: SELECT_ID_WHERE_STAKEHOLDER_IS_ID
A personal heat indicator for the municipality. It is only visible in the top bar for this specific stakeholder.


Excel Summary

Below is a small summary describing a suggested workflow from a bird's eye perspective, without going deeper into details:


How to create an Excel Indicator:
  1. Load a sample project in the editor.
  2. Create an empty xlsx workbook.
  3. Name one cell EXPLANATION.
  4. Create the EXPLANATION output format (HTML text string, HTML table) with %s variables.
  5. Decide, based on the EXPLANATION, which function categories are needed, and place them in one column.
  6. Add consecutive columns that match the EXPLANATION.
  7. Create the VAR columns with ROUND(UP) formulas and VAR_n name labels.
  8. Create the SCORE field(s) as required by the type of project (Timeline/ Planning).
  9. Optionally, test the spreadsheet by entering round values in query fields.
  10. Create a new Excel Indicator in the project and upload the Excel file to the project.
  11. Recalculate the indicators and verify if no errors are present.

Tips

  • Divisions by zero can be solved as follows: =C2/IF(D2,D2,1). In this example cells C2 and D2 contain number values.
  • Instead of using the VAR_# method for the explanation text, you can also use the concatenate function of excel:

CONCATENATE("<p>",A2, ": ", E2, " m2 and in Safe Zone: ", F2, " m2</p>")

  • Starting with creating a table aids in setting up the Excel spreadsheet, by already thinking in advance about the lay out and formatting of the EXPLANATION.
  • To quickly test the spreadsheet, without uploading it to the project, it is possible to enter some values in all the cells that contain queries as name. Other cells with formulas will change their content accordingly. By entering round values, for example 100, 1000, etc, calculations can easily be verified. Don't forget to save first and to revert back to the last saved version when done verifying!
  • To display an actual percentage sign in the explanation, you need to place two percentage signs. I.e. : "50% of houses" should be written as "50%% of houses".

How-to's

Videos


See also

API Endpoints

Current Situation
Current Situation
Buildings • Terrains • Administrative • Areas • Networks • Overlays • Indicators • Panels • Globals •  Queries • Geo Import
Buildings
Function • Function Override • Section • Category • Custom Geometry • Category Value • Function Value • Function Values Table • List of Functions
Traffic
Unit Type • Unit Data • Unit Data Override
Terrain
Height sector • Elevation model • Elevation GeoTIFF • Elevation Grid Overlay • Ground Price • Terrain Type • Terrain Type Override • List of Terrain Types
Administrative
Neighborhood • Zone • Permission Popup • Plot • Zip Code
Queries
Query Tool • Measurement
Geo Import
Source • GeoShare
Network
Net Cluster • Net Function • Net Line • Net Load • Net Node • Net Setting
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community


Indicators
Basics
Excel • Indicators Tutorial • TQL • TQL Tutorial
Public Share
Climate adaptation • Green • Green MKP • Health • Heat Reduction • Heat risk • Housing target • Industrial runoff • Livability Housing • Parking • Risk contour • Solar panels • Student housing target • Traffic health impact • Traffic Noise • Water stress • Wind turbine
Tools
Plotly
Retrieved from "https://support.tygron.com/w/index.php?title=Indicator&oldid=91062"