Root variables

These are the top level variables that can be accessed by templates.

Default root variables

The data model for all templates contains the following variables under the root:

Name Type Description
project Project hash Contains all information related to the current project
f Formatter hash Formatting object
GUIComponentStatics GUIComponentStatics hash Contains constants related to GUI components

Additional application root variables

The data model for application templates contain the following additional variables under the root:

Name Type Description
entities Entity sequence All of the entities for the project, ordered alphabetical by name.
guiComponents GUIComponent sequence All of the GUI components for the project, ordered alphabetical by name.

Additional entity root variables

The data model for entity templates contain the following additional variables under the root:

Name Type Description
entity Entity hash The entity that the template is being processed for

Additional GUI component root variables

The data model for GUI component templates contain the following additional variables under the root:

Name Type Description
guiComponent GUIComponent hash The GUI components that the template is being processed for

Additional database root variables

The data model for database templates contain the following additional variables under the root:

Name Type Description
entities Entity sequence The list of entities for the project, ordered such that identifying entities come before identified entities.
constraintsFlag Boolean scalar Whether to produce table constraint sql statements.
createTablesFlag Boolean scalar Whether to produce create table sql statements.
testRecordsFlag Boolean scalar Whether to produce sql statements that create test records.
supportTablesFlag Boolean scalar Whether to produce sql statements that create support tables.
dropDeleteFlag Boolean scalar Whether to generate drop and/or delete sql statements for the above options.

Related concepts

Template data model
Project variables
GUIComponentStatics variables
Entity variables
GUI component variables

Related tasks

Customising a template