Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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_NAME

Application name for Project being executed.

FD_PROJECT_NAME

Project being executed.

FD_PROJECT_VERSION

Project version being executed.

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.

FDBLD_SVN_

SOURCE1

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_

SOURCE1

SOURCE(n)_INSTANCE

Only available for SVN

-

based projects.

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

FDBLD_SVN_

SOURCE1

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_

SOURCE1

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_

SOURCE1

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_

SVN

GIT_SOURCE

(thumbs down)

(n)_REVISION

Only available for

SVN

GIT-based projects.

Represents

SVN revision number

GIT Repository Revision (SHA-1) corresponding to Project Version for Source

(thumbs down). Useful for projects with more than one source location

(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_

SVN

GIT_SOURCE

(thumbs down)

(n)_INSTANCE

Only available for

SVN

GIT-based projects.

Represents

SVN

GIT Instance Code for Source

(thumbs down). Useful for projects with more than one source location

(n), with n starting at 1.

FDBLD_

SVN

GIT_SOURCE

(thumbs down)

(n)_

PATH

BRANCH

Only available for

SVN

GIT-based projects.

Represents

SVN source path used

GIT branch for build for Source

(thumbs down). Useful for projects with more than one source location

(n), with n starting at 1.

FDBLD_

SVN

GIT_SOURCE

(thumbs down)

(n)_TAG

_PATH

Only available for

SVN

GIT-based projects.

Represents

SVN

GIT tag

path

for project version for Source

(thumbs down). Useful for projects with more than one source location

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

FDBLD_

SVN

GIT_SOURCE

(thumbs down)

(n)_SPARSE_CHECKOUT_

FOLDER

FOLDERS

Only available for

SVN

GIT-based projects.

Represents

sub-folder where Source (thumbs down) will be exported or checked out

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

FDBLD_GIT_

SOURCE1_REVISION

SOURCE(n)_CHECKOUT_FOLDER

Only available for GIT-based projects.

Represents

GIT Repository Revision (SHA-1) corresponding to Project Version for Source 1

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

FDBLD_
GIT_SOURCE1_SECONDARYREVISION
CVS_SOURCE(n)_REVISION

Only available for

GIT

CVS-based projects

with sparse checkout folders

.

Represents

comma separated revision (SHA-1) for sparse checkout folders for source

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

FDBLD_
GIT_SOURCE1
CVS_SOURCE(n)_INSTANCE

Only available for

GIT

CVS-based projects.

Represents

GIT

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

FDBLD_
GIT_SOURCE1
CVS_SOURCE(n)_BRANCH

Only available for

GIT

CVS-based projects.

Represents

GIT

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

FDBLD_
GIT_SOURCE1
CVS_SOURCE(n)_TAG

Only available for

GIT

CVS-based projects.

Represents

GIT

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_
GIT_SOURCE1_SPARSE_CHECKOUT_FOLDERS
CVS_SOURCE(n)_MODULES

Only available for

GIT

CVS-based projects.

Represents sparse checkout folders specified for Source 1

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

FDBLD_
GIT_SOURCE1
CVS_SOURCE(n)_CHECKOUT_FOLDER

Only available for

GIT

CVS-based projects.

Represents

sub-

checkout folder

where Source 1 will be cloned

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

FDBLD_
GIT
TFVC_SOURCE
(thumbs down)
(n)_REVISION

Only available for

GIT

TFVC-based projects.

Represents

GIT Repository Revision (SHA-1)

TFVC revision number corresponding to Project Version for Source

(thumbs down)

(n), with n starting at 1.

FDBLD_
GIT
TFVC_SOURCE
(thumbs down)_SECONDARYREVISIONOnly available for GIT-based projects with sparse checkout folders.
Represents comma separated revision (SHA-1) for sparse checkout folders for source (thumbs down).FDBLD_GIT_SOURCE(thumbs down)_
(n)_INSTANCE

Only available for

GIT

TFVC-based projects.

Represents

GIT

TFVC Instance Code for Source

(thumbs down)

(n), with n starting at 1.

FDBLD_
GIT
TFVC_SOURCE
(thumbs down)
(n)_BRANCH

Only available for

GIT

TFVC-based projects.

Represents

GIT

TFVC branch for build for Source

(thumbs down)

(n), with n starting at 1.

FDBLD_
GIT
TFVC_SOURCE
(thumbs down)
(n)_
TAG
LABEL

Only available for

GIT

TFVC-based projects.

Represents

GIT tag

TFVC label for project version for Source

(thumbs down). It may have been used for tagging source path, if workflow includes a step for tag

(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_
GIT
TFVC_SOURCE
(thumbs down)_SPARSE_CHECKOUT_FOLDERS
(n)_FOLDER

Only available for

GIT

TFVC-based projects.

Represents

sparse checkout folders specified for Source (thumbs down)

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

FDBLD_
GIT
TFVC_SOURCE
(thumbs down)
(n)_
CHECKOUT
GET_FOLDER

Only available for

GIT

TFVC-based projects.

Represents

sub-folder where Source (thumbs down) will be cloned

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