Tag: Difference between revisions

From Tygron Preview Support Wiki
Jump to navigation Jump to search
m (Rudolf@tygron.nl moved page Tag (Panel) to Tag without leaving a redirect: Not just applicable for panels, but also for indicators.)
Line 10: Line 10:
|-
|-
| $TOKEN
| $TOKEN
| Inserts the [[API token]] of the Project's [[Session]]
| Inserts the [[web token]] of the Project's [[Session]]
|}
|}



Revision as of 06:50, 13 July 2020

Text in Panels can contain special tags that are replaced by the Tygron Platform based on the Project's data, the Session's data, and the context of the Panel, such as the owner or related Items of the Panel. A tag can be placed anywhere in the text of a Panel, and when the content of that Panel is rendered for display to the user, the tag is replaced by the appropriate data. In other words, the tag specifies a specific kind of data, and that data is inserted into the Panel's text in the location of the tag.

General tags

Tag Effect
$PROJECT_NAME Inserts the name of the Project.
$TOKEN Inserts the web token of the Project's Session

Web tags

Tag Effect
$LIB_CUSTOM Inserts the name of the custom javascript library, part of the web interface configuration.

Contextual tags

Tag Effect
$NAME Inserts the name of the Panel.
$ID Inserts the ID of the Panel.
$STAKEHOLDER_ID Inserts the ID of the stakeholder who owns the Panel, if it has one. -1 if it has none.
$STAKEHOLDER Inserts the name of the stakeholder who owns the Panel, if it has one. Empty text if it has none.

Attributes tags

Tag Effect
$ATTRIBUTE_ATTRIBUTENAME, where ATTRIBUTENAME is the name of the Attribute Inserts the values of Attributes stored in this Panel, which can change based on calculations of Indicators or other Panels.
$GLOBAL_GLOBALNAME, where GLOBALNAME is the name of the Global Inserts the values of Globals stored in the Project, which can change based on calculation of Indicators or other Panels.

Notes