System Variables

These variables can be used throughout the system via the [[variable]] notation. Some of them (those in "Variables used by the system") are used to inform the dashboard of locations or other settings.

Variables used by the system

These are variables that the dashboard uses as configuration.

Images

Variable	Description

Variable	Description
`IMAGE_RESOURCE_DIRECTORY`	Image resource path used for e.g. image category object type
`IMAGE_RESOURCE_EXTENSION`	Image file extension used for e.g. image category object type. Defaults to png if not provided

Themes

Variable	Description

Variable	Description
`PI_STYLES`	System theme, used before user login, or if user doesn't have a theme (A user specific theme is not defined as a variable, so PI_STYLES as a user variable is not used)
`PI_STYLES_EXTERNAL_THEME_PATH`	Web url directory to access theme files. Using this would make themes read only, so supplying this path also disables the editing themes feature

Maps

Variable	Description

Variable	Description
`MAP_TILE_URL`	The URL for tiles from the map provider including {x} {y} and {z} for the tile selection and potentially {s} when multiple subdomains are used
`MAP_TILE_URL_SUBDOMAINS`	A comma separated list to be rotated in the {s} in MAP_TILE_URL

CSV

Variable	Description

Variable	Description
`CSV_DELIMITER`	Delimiter used for data in a CSV file, default value is `,`
`QUOTE_CSV_VALUES`	Setting to `true` will quote CSV values with double quotes

Modules

Variable	Description

Variable	Description
`PAN_RENDERER_URL`	URL for the Renderer. Usually `http://localhost:9915`
`PAN_EXCEL_READER_URL`	URL for the Excel Reader. Usually `http://localhost:9916`
`PAN_SCHEDULER_URL`	URL for the Scheduler. Usually `http://localhost:9917`
`ANALYTICS_SERVER_URL`	URL for Pirana. Usually `http://localhost:9918`
`SCHEDULE_BASE_DIRECTORY`	The root folder used by the Scheduler when using the schedule to directory feature

OAuth

Variable	Description

Variable	Description
`OAUTH_ENABLED`	Boolean, true to enable OIDC/OAUTH
`OAUTH_PROVIDER`	Provider: auth0, microsoft, keycloak or generic
`OAUTH_BASE_URL`	Base OAuth URL e.g. https://login.microsoftonline.com/TENANT
`OAUTH_AUTH_URL`	Auth URL (when generic provider)
`OAUTH_TOKEN_ENDPOINT`	Token endpoint (when generic provider)
`OAUTH_API_KEY`	API Key
`OAUTH_API_SECRET`	API Secret
`OAUTH_LOGIN_SCREEN_BYPASS`	Boolean, true to bypass the login screen and attempt auto login

Userflow

Variable	Description

Variable	Description
`USERFLOW_ENABLED`	Userflow enabled checkbox
`USERFLOW_TOKEN`	Userflow Token
`USERFLOW_USER_ID`	Userflow User ID

General

Variable	Description

Variable	Description
`PDF_DATE_FORMAT`	Date format used when downloading a chart as a PDF file. Defaults to yyyy-MM-dd if not provided
`ONLINE_HELP_URL`	If provided, there is a link available to access online help
`ACTIVE_DIRECTORY_SERVER`	For Window Single-Sign-On (via Waffle)
`ENABLE_OPENING_DASHBOARD_AS_TAB`	Used to enable opening the dashboard in new browser tabs. We do not recommend using this setting when embedding dashboards.

If a variable is added to the ‘User Variable’ section that matches a System or Environment Variable a warning message like the one shown below will be displayed. In the following example, a System Variable already exists, which has been made secure, when the same variable is added to the User Variable screen it will be automatically set to the same security level as the System Variable and this cannot be modified

In addition to this, if the same variable is added twice the following message will be displayed.