Pipeline Groovy Variables and Methods

ReleaseName

ID of the execution

Allows access to execution details for Gate, Step, Deploy or Utility workflows.

This variable was previously called FD_Release, which will continue to work but is deprecated now.

Allows access to details entered by user on Stage Execution Info.

It will not show any default values or FlexFields or WorkFlowInputs that are not set in the Stage Execution Info popup (The Paper Clip on the release dashboard screen)

added in 5.2.0.3

returns environment code

e.g. "DEV"

returns the name of the release

e.g "December Release"

returns the name of the snapshot

e.g. 12-04-2019 16:21:18

returns list of ReleaseProjectVersion objects in the snapshot.

returns list of ReleaseProjectVersion objects in the snapshot which were deployed successfully.

returns list of ReleaseProjectVersion objects in the snapshot which failed to deploy.

returns list of ReleaseProjectVersion objects in the snapshot which were skipped.

returns all skipped projects concatenated in the format "ProjectName,PartialProjectName (PackageName),..."

returns list of ReleaseProjectVersion objects in the snapshot which were not attempted.

returns true if any projects in a specific group of projects failed to deploy or submit.

returns false if the group doesn't exist or if the group doesn't have any failed project deployments.

returns true if any deploy or utility workflows in a specific group failed.

returns false if the group doesn't exist or if the group doesn't have any failed projects.

returns true if any utility workflows in a specific group failed.

returns false if the group doesn't exist or if the group doesn't have any failed utility projects.

returns true if a project is deployed, given the project name and package name. If package name is not supplied, this will behave same as stgexec.isProjectDeployed(projectName) method.

returns true if a project failed to deploy, given the project id and package name. If package name is not supplied, this will behave same as stgexec.isProjectFailed(projectId).

returns true if a project is skipped, given the project id and package name. If package name is not supplied then this method will behave same as stgexec.isProjectSkipped(projectId).

returns true if a project is skipped, given the project name and package name. If package name is not supplied then this method will behave same as stgexec.isProjectSkipped(projectName).

returns true if a project was not attempted, given the project id and package name. If package name is not supplied then this method will behave same as stgexec.isProjectNotAttempted(projectId).

returns gate status String, "SUCCESSFUL", "RUNNING", "FAILED" or null if the gate name doesn't match or doesn't yet have a status.

note that Skipped steps that were FAILED will still return FAILED.

If an invalid gate name is given or the gate hasn't run yet, the status will be null.

returns step status String, "SUCCESSFUL", "RUNNING", "FAILED" or null if the gate name doesn't match or doesn't yet have a status.

If an invalid step name is given or the step hasn't run yet, the status will be null.

returns an array of output values with the given output name irrespective of project.

e.g. [1234123]

Note that any encrypted workflow outputs will return as "******"

returns an array of output values with the given output name for the given project name.

e.g. [1234123]

Note that any encrypted workflow outputs will return as "******"

returns a map of output values for the given project id. Key of map is output name and value is list of output values.

e.g. [OP1:[1,3], ENCOP2:[******, ******], BOP3:[false], DBOP4:[123.456], INOP5:[1234,123]]

Note that any encrypted workflow outputs will return as "******"

returns a map of output values for the given project name. Key of map is output name and value is list of output values.

e.g. [OP1:[1,3], ENCOP2:[******, ******], BOP3:[false], DBOP4:[123.456], INOP5:[1234,123]]

Note that any encrypted workflow outputs will return as "******"

returns a map of output values for the given project id and instance code. Key of map is output name and value is list of output values.

e.g. [OP1:[1,3], ENCOP2:[******, ******], BOP3:[false], DBOP4:[123.456], INOP5:[1234,123]]

Note that any encrypted workflow outputs will return as "******"

returns a comma delimited String of the passed projects with their package name or all files for partial deploy projects.

e.g. TestProject, TestPartialDeploy (All Files)

returns a map of workflow input values for the given project name. Key of map is input name and value is list of input values.

returns a map of flex field values for the given project name and package name. Key of map is flex field code and value is list of flex field values.

returns a ProjectTypeEnum object for the current project.

Possible Values:  GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, UTILITY, MDS, SAP, and GENERIC

returns a RequestStatusEnum object for the current project.

Possible Values:  INITIATED("Initiated"), PENDING_APPROVAL("Pending Approval"), SCHEDULED("Scheduled"), REJECTED("Rejected"), READY("Ready"), SUBMITTED("Submitted"), COMPLETED("Completed"), ABORTED("Aborted"), and FAILED("Failed");

returns a WorkflowRequestSubmitStatus object for the current project.

Possible Values: SUBMITFAILED, SUBMITTED, SKIPPED, PENDING

returns a map of output values for the given workflow execution name. Key of map is workflow execution name and value is a ProjectWorkflowExecutionData object.

returns a map of output values. Key of map is output name and value is the description. 

returns a ProjectTypeEnum object for the current release project.

Possible Values: GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, UTILITY, MDS, SAP, and GENERIC