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 Branch. |
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. |
FD_PROJECT_CLASSIFICATION | The project classification. Standard, PackageBased, Container, Utility |
Additional properties are available for projects based on which SCM is configured on them.
Any workflow outputs that were set in the Build will also be available as workflow variables in the Deploy workflow. The variables will not show up in the Workflow UI in the variables page, but will be in the project execution, variables screen and can be used like a variable or property in the deploy workflow.