System Variables

System Variables work in the same way as DEFINES but are automatically generated by the scripting engine at the time of execution.

They can be used in scripts to access selected system settings relating to paths, files,  scripts and time-stamps.

System variables are replaced with their resolved values before a script executes.

System variables are READ-ONLY

%DSTAMP%

Date-time stamp of the format -YYYY-MM-DD-HH-MM-SS at the moment script execution begins.

%DATAPATH%

The root of the data source folder

The path of the DataJet datasources folder.    Dependant on where DataJet is installed.  Consistent across all projects.

Takes the form [installdirectory]/datasources/

e.g., F:/datajet/datasources/

%MYEXPORT%

This user's output folder

The path of DataJet active user’s output folder.  Dependant on where DataJet is installed.  Individual users use the same user output folder across all projects

Takes the form [installdirectory]/[realmdirectory]/output/username/

e.g., F:/datajet/dj-localhost/output/admin/

%OUTPUT%

The system output folder

The path of the default DataJet output folder.  Dependant on where DataJet is installed.  Consistent across all projects.

Takes the form [installdirectory]/[realmdirectory]/output/

e.g., F:/datajet/dj-localhost/output/

%LISTS%

The system lists folder.

The path of the default DataJet lists folder.  Dependant on where DataJet is installed.  Consistent across all projects.

Takes the form [installdirectory]/[realmdirectory]/Lists/

(NB: Lists are files containing lists of keys, and are used when importing files to create datasets).

e.g., F:/datajet/dj-localhost/Lists/

%MYLISTS%

This user's lists folder

The path of the default DataJet lists folder for this user.  Dependant on where DataJet is installed.  Consistent across all projects.

Takes the form [installdirectory]/[realmdirectory]/Lists/username

e.g., F:/datajet/dj-localhost/Lists/admin

%TEMPLATES%

The system templates folder

The path of the default DataJet Templates folder for this user.  Dependant on where DataJet is installed.  Consistent across all projects.

Takes the form [installdirectory]/[realmdirectory]/Templates/

(NB: Templates refer to the excel template files used when exporting Dashboards to Excel, and are not to be confused with viewing templates, as accessed from the Explorer Solution Viewer).

e.g., F:/datajet/dj-localhost/Templates/

%CONFIG%

This project’s config folder. 

The path of this project’s configuration folder.  Dependant on where DataJet is installed.  Each project has a config folder called config.   Any custom files needed by only one project can be stored in the project’s config folder.

Takes the form [installdirectory]/[realmdirectory]/[projectname]/config/

e.g., F:/datajet/dj-localhost/testproject/config/

Working with system variables

It is possible to use more than one System Variable in a single JSON key/value pairing.  It is also possible to use System Variables in combination with User Variables (DEFINES)

The following creates the user DEFINE %ROOT%, which contains the System Variable %DATAPATH%. This is then used with %DSTAMP% to generate a filename: 

{

  "METHOD": "DEFINES",

  "VARIABLES": [

    {

      "KEY": "%ROOT%",

      "VALUE": "%DATAPATH%TESTPROJECT/"

    }

  ],  

  "PROJECT": "TESTPROJECT"

}

{

  "METHOD": "EXPORTINTOWORKBOOK",

  "FILENAME": "%ROOT%OUTPUT%DSTAMP%.XLSX",

  "STARTROW": 1,

  "SHEET": "SUMMARY",

  "INCLUDEHEADERS": TRUE,

  "ALL": TRUE,

"DATASET": {

    "LOGIC": "OR",

    "NAME": "ETL_TABLE",

    "STRICT": TRUE,

    "SET": [

      {

        "LOGIC": "OR",

        "STYPE": "TABLE",

        "ENTITY": " ETL_TABLE "

      }

    ]

  },

  "PROJECT": "TESTPROJECT"

}

The resulting filename will resolve to f:/datajet/dj-localhost/output-2022-05-17-12-02-54.xslx

Viewing resolved values

It is not possible to view the resolved values of System Variables from within the Script Editor window.     If the script variable window is displayed (CTRL L), then system variables will be displayed in their unresolved form.  

This is by design.