Setup Section Variables

Variable Name

Functionality

Value

FailureAction

Determines what happens when an operation fails

A string that indicates the way an operation failure is handled. Permissible values are: Abort or Continue. The default is Abort.

IMPORTANT: As a general rule you should not modify this value without a very good reason. It is provided so that users have a way to ignore failures in non-essential command operations, for example if a failure occurs when sending an email message after completion of the entire script. In this case reporting the failure might well be preferable to aborting the entire process. If you decide to use this feature, you should do so in matched pairs i.e. assign FailureAction.Continue, then process the operation, then assign FailureAction.Abort immediately after to avoid the potential for unintended behaviour.

GenerateReport

Determines whether an automatically generated report is created

A string that can be converted to a boolean value e.g. True or False, 1 or 0, T or F, etc. True or False is recommended for clarity.

RuntimePassword

Defines a password that must be provided before a Project can be run.

A string that represents the password the user needs to provide to run the Project.

NOTE: When using Pipeline Runner Studio the entire project is encrypted and passwords included within the Script section are therefore protected. If you use passwords using the text Script via Notepad, Notepad++, Visual Studio or any other text editor the script and any passwords in it will not be protected by encryption.

ReportFileName

Defines the path and file name to be used for the report.

A string representing the fully qualified path and file name to be used for the report. Any existing report of the same name will be automatically overwritten without warning.

IMPORTANT: Do not use a variable as part of the file name. Doing so will mean that if there is a validation error then the variable will not have been processed and the file location will not exist. To ensure that a report is always created, ensure that the fully qualified path and file name is specified verbatim.