Line-by-line Execution.


To alleviate the burden of argument passing, exception handling and logging, the execution engine has been provided. The execution engine will essentially execute the native interpretive language (PowerShell or bash), line by line, but each execution will be tested for exceptions (trivial in bash, significantly more complex in PowerShell).

Where is it used

In all places using .tsk files, i.e. build, package, wrap and deploy. The following operations are available to all tasks, however, some are more applicable to specific processes, see Build, Local and Remote task execution for more details of how these can be used.


The following operations are provided to simplify common tasks.

Keyword Description Example
ASSIGN Display, and expand as necessary, variable assignment ASSIGN $test=”$varcontainingvar”
CMPRSS Compress directory to file CMPRSS packageName dirName
DCMPRS Decompress package file DCMPRS packageName
DECRYP decrypt using private key (PKI) DECRYP crypt/encrypt.dat
     decrypt using AES/GPG key DECRYP crypt/encrypt.dat $key
DETOKN Detokenise file with target prop DETOKN token.yml
     Detokenise with specific file DETOKN token.yml PROP_FILE
     Detokenise with encrypted file DETOKN token.yml crypt/FIL $key
     Expand and reveal embedded variables and detokenise DETOKN token.yml $TARGET reveal
     Expand but do not reveal embedded variables and detokenise DETOKN token.yml manifest.txt resolve
EXCREM Execute command EXCREM hostname
     Execute script EXCREM ./
EXERTY Execute Retry, wait 10 seconds and retry twice EXERTY “temperamentalcommand”
     Optional, wait and retry override EXERTY “verytemperamentalcommand” 20 5
EXITIF Exit normally if argument set EXITIF $ACTION
     Exit normally if set to value EXITIF $ACTION clean
IMGTXT Display image file as text (wrapper for jp2a in Linux) IMGTXT sample.jpg
INVOKE call a custom script INVOKE ./script “Hello”
MAKDIR Create a directory and path (opt) MAKDIR directory/and/path
MASKED Return an uppercase hexadecimal checksum using SHA256 MASKED $password
MD5MSK Deprecated. Return an uppercase hexadecimal checksum MD5MSK $password
PROPLD Load properties as variables PROPLD PROP_FILE
     Expand and reveal embedded variables PROPLD $TARGET reveal
     Expand but do not reveal embedded variables PROPLD manifest.txt resolve
REFRSH Refresh directory contents REFRSH manifest.txt ~/temp_dir
     clear directory contents (create if not existing) REFRSH ~/temp_dir
REMOVE Delete files, including wildcard REMOVE *.war
REPLAC Replace token in file REPLAC fileName %token% $value
VARCHK Variable validation using default file properties.varchk VARCHK
     Variable validation using names file VARCHK
VECOPY Verbose copy VECOPY *.war

Notes on EXCREM use, the properties are similar to those used for remote tasks, where the minimum required is the host, if other properties are not used, must be set to NOT_SUPPLIED, i.e.


Windows only

The following operations are only available in PowerShell version

Keyword Description Example
CMDTST Returns true if command exists CMDTST vagrant
ELEVAT Execute as elevated NT SYSTEM ELEVAT “$(pwd)/custom.ps1”
EXECMD Execute in Command (CMD) shell ELEVAT “terraform $OPT_ARG”
MSTOOL Microsoft Build Tools, set environment variables

Common Variables

These are automatically set at both build and deploy time.

Variable Description
$SOLUTIONROOT The solution directory identified by localtion of CDAF.solution file
$SOLUTION The solution name identified by property in CDAF.solution file
$BUILDNUMBER The first argument passed for CI, and propagated to CD
$CDAF_CORE Core CDAF runtime location
$TASK_NAME The name of the task file currently executing
$TARGET Available in both build and deploy, but derived differently, see below for details

Build-time Variables

These are automatically set at execution start-up

Variable Description
$AUTOMATIONROOT The installation directory of the Continuous Delivery Automation Framework
$ACTION The second argument passed, has some hardcoded functions
• clean: only remove temp files
• packageonly: skip any build tasks
$TARGET At build time, this is derived (Can be overridden, see CDAF_BUILD_ENV environment variable)
• Linux: Set to WSL for Windows Subsystem, otherwise LINUX
• Windows: Set to WINDOWS is on-domain, otherwise WORKGROUP
$TMPDIR Automatically set to the temp dir
$WORKSPACE The working directory at execution start-up

See also Environment and Global Variables.

Deploy-time Variables

Variable Description
$ENVIRONMENT This is the first argument passed to the release, the targets are derived from this
$TARGET All targets are processed based on pattern match $ENVIRONMENT*, the TARGET being currently executed is set in this variable
$RELEASE Second argument passed to release
$OPT_ARG Third argument passed to release

Next: Solution Properties

This e-mail, including attachments, may contain information which is confidential and subject to copyright. If you are not the intended recipient, please notify the sender by return e-mail or telephone (0800 800 181) and delete this e-mail and any attachments from your system. E-mail communications are not secure and are not guaranteed by Southern Cross Medical Care Society (Southern Cross) to be free of unauthorised interference, error or virus. Anyone who communicates with us by e-mail is taken to accept this risk. Anything in this email which does not relate to the official business of Southern Cross is neither given nor endorsed by Southern Cross. Information Classification: General/Internal