Workflow Execution Variables

Following variables are available in Workflow Editor (UI), Shell Plugins and script-based plugins.

Variable Name

Description

FD_WORKING_DIR

Working directory for Plugin execution on the Endpoint. This folder contains sub-folders like temp, internal, artifacts etc.

FlexDeploy will use a different Working directory for each workflow execution. Syntax - <Endpoint directory>/<Project Id>/<Workflow Execution Id>

This folder structure is kept for 3 days. Older folders are automatically purged.

FD_ARTIFACTS_DIR

Folder for build artifacts. Build workflow will generate artifacts in this folder. And Deploy workflow will automatically have access to the same artifacts. Artifacts are associated with specific Project Version.

FD_TEMP_DIR

Folder for temporary files. FlexDeploy will generate temporary files in this folder.

Custom shell / script (Groovy, WLST) plugins can also generate temporary files here.

FD_ENVIRONMENT_CODE

Environment code

FD_INSTANCE_CODE

Instance code

FD_APPLICATION_IDApplication id for the Project being executed.

FD_APPLICATION_NAME

Application name for Project being executed.

FD_PROJECT_IDId of Project being executed.

FD_PROJECT_NAME

Project being executed.

FD_PROJECT_FULL_PATHFull path of project -

FD_PROJECT_VERSION

Project version being executed.

FD_RELEASE_NAMERelease Name if the project is in a release.
FD_RELEASE_SNAPSHOT_NAMERelease Snapshot Name if the project is in a release.

FDBLD_STREAM_NAME

Name of the stream used to build project version. For example, trunk.

FDBLD_STREAM_ATTRIBUTE1

Attribute1 value of stream used to build project version.

FDBLD_STREAM_ATTRIBUTE2

Attribute2 value of stream used to build project version.

FDBLD_STREAM_ATTRIBUTE3

Attribute3 value of stream used to build project version.

FD_WF_USERUsername for workflow submitter, if workflow was submitted manually, otherwise value could be cipoller or some other internal user.
FD_WF_USER_EMAILUser's email if Workflow was submitted manually.
FD_PLUGIN_LOG_LEVELLog Level for Plugins
FD_ALL_FILES_REQUESTEDIf All files were requested as part of build workflow for Partial Deployment projects.
FD_PACKAGE_NAMEPackage Name for Partial Deployment projects.
FD_SERVER_BASE_URLFlexDeploy server base URL configured on system settings.
FD_IS_FORCE_DEPLOYtrue or false to indicate if Force Deploy was checked or not.
FD_WORKFLOW_REQUEST_IDWorkflow request id
FD_WORKFLOW_EXECUTION_IDWorkflow execution id
FD_SMTP_HOST_NAMEMail configuration - host name
FD_SMTP_HOST_PORTMail configuration - port
FD_SMTP_USER

Mail configuration - user

FD_SMTP_PASSWORDMail configuration - password
FD_SMTP_FROM_ADDRESSMail configuration - from address
FD_SMTP_ENABLE_TLSMail configuration - enable tls

FDBLD_SVN_SOURCE(n)_REVISION

Only available for SVN based projects.

Represents SVN revision number corresponding to Project Version for Source (n), with n starting at 1.

FDBLD_SVN_SOURCE(n)_INSTANCE

Only available for SVN based projects.

Represents SVN Instance Code for Source (n), with n starting at 1.

FDBLD_SVN_SOURCE(n)_PATH

Only available for SVN-based projects.

Represents SVN source path used for build for Source (n), with n starting at 1.

FDBLD_SVN_SOURCE(n)_TAG_PATH

Only available for SVN-based projects.

Represents SVN tag path for project version for Source (n), with n starting at 1. It may have been used for tagging source path, if workflow includes a step for tag.

FDBLD_SVN_SOURCE(n)_CHECKOUT_FOLDER

Only available for SVN-based projects.

Represents sub-folder where Source (n), with n starting at 1, will be exported or checked out.

FDBLD_GIT_SOURCE(n)_REVISION

Only available for GIT-based projects.

Represents GIT Repository Revision (SHA-1) corresponding to Project Version for Source (n), with n starting at 1.

FDBLD_GIT_SOURCE(n)_SECONDARYREVISION

Only available for GIT-based projects with sparse checkout folders.

Represents comma separated revision (SHA-1) for sparse checkout folders for source (n), with n starting at 1.

FDBLD_GIT_SOURCE(n)_INSTANCE

Only available for GIT-based projects.

Represents GIT Instance Code for Source (n), with n starting at 1.

FDBLD_GIT_SOURCE(n)_BRANCH

Only available for GIT-based projects.

Represents GIT branch for build for Source (n), with n starting at 1.

FDBLD_GIT_SOURCE(n)_TAG

Only available for GIT-based projects.

Represents GIT tag for project version for Source (n), with n starting at 1. It may have been used for tagging source path, if workflow includes a step for tag.

FDBLD_GIT_SOURCE(n)_SPARSE_CHECKOUT_FOLDERS

Only available for GIT-based projects.

Represents sparse checkout folders specified for Source (n), with n starting at 1.

FDBLD_GIT_SOURCE(n)_CHECKOUT_FOLDER

Only available for GIT-based projects.

Represents sub-folder where Source (n), with n starting at 1, will be cloned.

FDBLD_CVS_SOURCE(n)_REVISION

Only available for CVS-based projects.

Represents CVS revision number corresponding to Project Version for Source (n), with n starting at 1.

FDBLD_CVS_SOURCE(n)_INSTANCE

Only available for CVS-based projects.

Represents CVS Instance Code for Source (n), with n starting at 1.

FDBLD_CVS_SOURCE(n)_BRANCH

Only available for CVS-based projects.

Represents CVS branch for build for Source (n), with n starting at 1.

FDBLD_CVS_SOURCE(n)_TAG

Only available for CVS-based projects.

Represents CVS tag for project version for Source (n), with n starting at 1. It may have been used for tagging source path, if workflow includes a step for tag.

FDBLD_CVS_SOURCE(n)_MODULES

Only available for CVS-based projects.

Comma separated list of CVS modules to be checked out from the CVS Repository. Root modules or subdirectories(module/subdir) can be specified.

FDBLD_CVS_SOURCE(n)_CHECKOUT_FOLDER

Only available for CVS-based projects.

Represents checkout folder specified for Source (n), with n starting at 1.

FDBLD_TFVC_SOURCE(n)_REVISION

Only available for TFVC-based projects.

Represents TFVC revision number corresponding to Project Version for Source (n), with n starting at 1.

FDBLD_TFVC_SOURCE(n)_INSTANCE

Only available for TFVC-based projects.

Represents TFVC Instance Code for Source (n), with n starting at 1.

FDBLD_TFVC_SOURCE(n)_BRANCH

Only available for TFVC-based projects.

Represents TFVC branch for build for Source (n), with n starting at 1.

FDBLD_TFVC_SOURCE(n)_LABEL

Only available for TFVC-based projects.

Represents TFVC label for project version for Source(n), with n starting at 1. A TFVC label is the equivalent of a tag in similar SCM tools such as SVN and GIT.

FDBLD_TFVC_SOURCE(n)_FOLDER

Only available for TFVC-based projects.

Represents TFVC source folder path for building a project for Source(n), with n starting at 1.

FDBLD_TFVC_SOURCE(n)_GET_FOLDER

Only available for TFVC-based projects.

Represents checkout folder(get) for TFVC for Source(n), with n starting at 1.

FDBLD_PERF_SOURCE(n)_REVISION

Only available for Perforce based projects.

Represents ChangeSet Id captured at build time for specific Project Source definition.

FDBLD_PERF_SOURCE(n)_INSTANCE

Only available for Perforce based projects.

Represents Perforce Instance Code for specific Project Source.

FDBLD_PERF_SOURCE(n)_LABEL

Only available for Perforce based projects.

Represent Perforce Label for specific Project Source.

FDBLD_PERF_SOURCE(n)_DEPOT

Only available for Perforce based projects.

Represent Perforce Depot path for specific Project Source, could be main path or branch path.

FDBLD_PERF_SOURCE(n)_CHECKOUT_FOLDER

Only available for Perforce based projects.

Checkout folder specified for specific Project Source.