Reference and Cheat Sheets > PackBench Variables

This chapter contains a reference of variables that can be used in various configuration places. Bear in mind that certain variables are available only in specific contexts. The use of the Variables Editor is recommended, as it can recognize the context and suggest the right set of variables available for processing.

Run Variables

The following variables are available in the run-context. Some of them can be accessed only from a task.

Variable name	Description	Notes
PkgAppName	Represents the application name of the run package.
PkgLanguage	Represents the language of the run package.
PkgVersion	Represents the version of the package run.
PkgVendor	Represents the name of the vendor of the package run.
PkgFileName	Represents the full path to the entry file name of the run package.
PkgName	Represents the name of the run package.
PkgCreated	Represents the date of creation of the run.
PkgDir	Represents the full path to the package directory.	This value does not have a trailing backslash.
PkgPlatform	Represents the human-readable platform of the run package.
RunStatus	Represents a human-readable status of the run package.
ToolPath	Represents a full path to the tool assigned to a task.	Available only in task-context.
ToolStatus	Represents a human readable status of a tool's visibility.	Available only in task-context.
WorkflowName	Represents the name of the workflow.
WorkflowId	Represents the numeric identifier of a workflow.
WorkflowStatus	Represents a human-readable status of the workflow.
ProjectId	Represents the numeric identifier of a project.
ProjectStatus	Represents a human-readable status of the project.
ProjectPath	Represents the default path where projects are saved.	This value is already resolved.
ProjectName	Represents the name of the project.

General Variables

The following variables are available in all contexts:

Variable name	Description	Notes
DateTime	Inserts the current date and time.	This value may be not safe to use as file or directory name. In order to make it safe, use Safe modifier, for example ($DateTime->Safe).

PackBench and RaySuite Products

The following variables which represent installation paths of selected RaySuite products are available in all contexts:

Variable name	Description	Notes
BenchDirectory	Represents a full path to the root PackBench directory, as defined during the installation process.	This value ends with a trailing backslash.
RayPackDirectory	Represents the full path to RayPack directory.	This value ends with a trailing backslash. The value is not resolved if RayPack is not installed on the current machine.
RayQCDirectory	Represents the full path to RayQC directory.	This value ends with a trailing backslash. The value is not resolved if RayQC is not installed on the current machine.
RayQCAdDirectory	Represents the full path to RayQC Advanced directory.	This value ends with a trailing backslash. The value is not resolved if RayQC Advanced is not installed on the current machine.
RayEvalDirectory	Represents the full path to RayEval directory.	This value ends with a trailing backslash. The value is not resolved if RayEval is not installed on the current machine.
PackPointDirectory	Represents the full path to PackPoint directory.	This value ends with a trailing backslash. The value is not resolved if RayPack is not installed on the current machine.
RayBIStudioDirectory	Represents the full path to RayBIStudio directory.	This value ends with a trailing backslash. The value is not resolved if RayBIStudio is not installed on the current machine.
RayBIPublisherDirectory	Represents the full path to the RayBIPublisher directory.	This value ends with a trailing backslash. The value is not resolved if RayBIPublisherDirectory is not installed on the current machine.

RayFlow Products

The following variables which are present for RayFlow:

Variable name	Description	Notes
RayFlowServerURL	Represents the URL to the RayFlow Server.
RayFlowServiceUser	Represents the name of the RayFlow Server User.
RayFlowUser	Represents the name of the RayFlow User
RayFlowPassword	Represents the password for RayFlow.
RayFlowProjectId	Represents the ID of the RayFlow Project.
RayFlowTaskId	Represents the ID of the RayFlow Task.

Folder Naming Conventions

The following variables which represent names for predefined folders are available in all contexts:

Variable name	Description	Notes
ProjectSourcesFolder	The name of folder for original sources.	This is a relative path.
ProjectDocsFolder	The name of folder for documentation.	This is a relative path.
ProjectRepackagedFolder	The name of folder for repackaged files.	This is a relative path.
ProjectOutputFolder	The name of folder for output files.	This is a relative path.
ProjectWorkingFolder	The name of folder for working files.	This is a relative path.

Value Modifiers

In order to modify the value (for example make it UPPERCASED or safe for a file name) use variable modifiers, described in chapter Variable modifiers.