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. |
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. |
FD_REPORTS_DIR | Folder for generated reports. Files saved here can be downloaded from Project Workflow Execution reports tab. |
FD_ENVIRONMENT_CODE | Environment code |
FD_ |
TARGET_GROUP_CODE | Instance code |
FD_ |
FOLDER_NAME |
The folder name of the folder closest to the Project being executed. | |
FD_PROJECT_ID | Id of the Project being executed. |
FD_PROJECT_NAME | Name of the Project being executed. |
FD_PROJECT_FULL_PATH | Full path of project |
FD_PROJECT_VERSION | Project version being executed. |
FD_RELEASE_NAME | Release Name if the project is in a release. |
FD_RELEASE_SNAPSHOT_NAME | Release Snapshot Name if the project is in a release. |
FDBLD_ |
BRANCH_NAME | Name of the |
branch used to build project version. For example, trunk. |
FDBLD_ |
BRANCH_ATTRIBUTE1 | Attribute1 value of |
the branch used to build project version. |
FDBLD_ |
BRANCH_ATTRIBUTE2 | Attribute2 value of |
the branch used to build project version. |
FDBLD_ |
BRANCH_ATTRIBUTE3 | Attribute3 value of |
the branch used to build project version. | |
FD_WF_USER | Username for workflow submitter, if workflow was submitted manually, otherwise value could be cipoller or some other internal user. |
FD_WF_USER_EMAIL | User's email if Workflow was submitted manually. |
FD_PLUGIN_LOG_LEVEL | Log Level for Plugins |
FD_ALL_FILES_REQUESTED | If All files were requested as part of build workflow for Partial Deployment projects. |
FD_PACKAGE_NAME | Package Name for Partial Deployment projects. |
FD_SERVER_BASE_URL | FlexDeploy server base URL configured on system settings. |
FD_IS_FORCE_DEPLOY | true or false to indicate if Force Deploy was checked or not. |
FD_WORKFLOW_REQUEST_ID | Workflow request id |
FD_WORKFLOW_EXECUTION_ID | Workflow execution id |
FD_SMTP_HOST_NAME | Mail configuration - host name |
FD_SMTP_HOST_PORT | Mail configuration - port |
FD_SMTP_USER | Mail configuration - user |
FD_SMTP_PASSWORD | Mail configuration - password |
FD_SMTP_FROM_ADDRESS | Mail configuration - from address |
FD_SMTP_ENABLE_TLS | Mail configuration - enable tls |
FDBLD_VERSION_SEQUENCE | Build sequence number. This sequence is unique for each project stream. |
FDBLD_PROJECT_VERSION_SEQUENCE | Project build sequence number. This sequence is unique for each project. |
FDBLD_PACKAGE_VERSION_SEQUENCE | Package build sequence number. This sequence is unique for each project package. |
FDBLD_SVN_SOURCE(n)_REVISION
Additional properties are available for
...
projects
...
FDBLD_SVN_SOURCE(n)_INSTANCE
...
FDBLD_SVN_SOURCE(n)_PATH
...
FDBLD_SVN_SOURCE(n)_TAG_PATH
...
FDBLD_SVN_SOURCE(n)_CHECKOUT_FOLDER
...
FDBLD_GIT_SOURCE(n)_REVISION
...
FDBLD_GIT_SOURCE(n)_SECONDARYREVISION
...
FDBLD_GIT_SOURCE(n)_INSTANCE
...
FDBLD_GIT_SOURCE(n)_BRANCH
...
FDBLD_GIT_SOURCE(n)_TAG
...
FDBLD_GIT_SOURCE(n)_SPARSE_CHECKOUT_FOLDERS
...
FDBLD_GIT_SOURCE(n)_CHECKOUT_FOLDER
...
Only available for CVS-based projects.
Represents CVS revision number corresponding to Project Version for Source (n), with n starting at 1.
...
Only available for CVS-based projects.
Represents CVS Instance Code for Source (n), with n starting at 1.
...
Only available for CVS-based projects.
Represents CVS branch for build for Source (n), with n starting at 1.
...
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.
...
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.
...
Only available for CVS-based projects.
Represents checkout folder specified for Source (n), with n starting at 1.
...
Only available for TFVC-based projects.
Represents TFVC revision number corresponding to Project Version for Source (n), with n starting at 1.
...
Only available for TFVC-based projects.
Represents TFVC Instance Code for Source (n), with n starting at 1.
...
Only available for TFVC-based projects.
Represents TFVC branch for build for Source (n), with n starting at 1.
...
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.
...
Only available for TFVC-based projects.
Represents TFVC source folder path for building a project for Source(n), with n starting at 1.
...
Only available for TFVC-based projects.
Represents checkout folder(get) for TFVC for Source(n), with n starting at 1.
...
Only available for Perforce based projects.
Represents ChangeSet Id captured at build time for specific Project Source definition.
...
Only available for Perforce based projects.
Represents Perforce Instance Code for specific Project Source.
...
Only available for Perforce based projects.
Represent Perforce Label for specific Project Source.
...
Only available for Perforce based projects.
Represent Perforce Depot path for specific Project Source, could be main path or branch path.
...
Only available for Perforce based projects.
...
based on which SCM is configured on them.