Versions Compared

Key

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

...

Method

Description

getRelatedTicket()returns related ticket associated to the stage.
getRelatedTicket(projectId)returns related ticket associated to snapshot project or the stage.  If not found, related ticket is returned from the stage.
getRelatedTicket(projectId, packageName)returns related ticket associated to the snapshot project and package.  If not found, related ticket is returned from the stage.
setRelatedTicket(ticketNumber)sets the related ticket field on stage.
setRelatedTicket(projectId, ticketNumber)sets the related ticket field for the snapshot project on the stage.
setRelatedTicket(projectId, packageName, ticketNumber)sets the related ticket field for the snapshot project and package on the stage.
getWorkflowInputs(inputName)returns list of workflow inputs for input name irrespective of project.
getWorkflowInputMap(projectName)

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.

getWorkflowInputMap(projectId)returns a map of workflow input values for the given project id. Key of map is input name and value is list of input values.
getWorkflowInputMap(projectId, packageName)returns a map of workflow input values for the given project id and package name. Key of map is input name and value is list of input values.
getWorkflowInputMap(projectName, packageName)returns a map of workflow input values for the given project name and package name. Key of map is input name and value is list of input values.
getFlexFields(flexfieldCode)returns list of flex field values for code irrespective of project.
getFlexFieldMap(projectId)returns a map of flex field values for the given project id. Key of map is flex field code and value is list of flex field values.
getFlexFieldMap(projectName)returns a map of flex field values for the given project name. Key of map is flex field code and value is list of flex field values.
getFlexFieldMap(projectId, packageName)returns a map of flex field values for the given project id and package name. Key of map is flex field code and value is list of flex field values.
getFlexFieldMap(projectName, packageName)

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.

isUserNoOverride(projectId)returns true if the deploy override option is No Override for the snapshot project on the stage.
isUserNoOverride(projectId, packageName)returns true if the deploy override option is No Override for the snapshot project and package on the stage.
isUserForceDeploy(projectI)returns true if the deploy override option is Force for the snapshot project on the stage.
isUserForceDeploy(projectId, packageName)returns true if the deploy override option is Force for the snapshot project and package on the stage.
isUserSkipDeploy(projectId)returns true if the deploy override option is Skip for the snapshot project on the stage.
isUserSkipDeploy(projectId, packageName)returns true if the deploy override option is Skip for the snapshot project and package on the stage.
setUserNoOverride(projectId)removes any previously set deploy option override for the snapshot project on the stage.
setUserNoOverride(projectId, packageName)removes any previously set deploy option override for the snapshot project and package on the stage.
setUserForceDeploy(projectId)force deploy the snapshot project on the stage.
setUserForceDeploy(projectId, packageName)force deploy the snapshot project and package on the stage.
setUserSkipDeploy(projectId)skip the deployment for the snapshot project on the stage.
setUserSkipDeploy(projectId, packageName)skip the deployment for the snapshot project and package on the stage.
setInstanceOverride(projectId, instanceCode)

Set instance override (deploy or utility) for specified project id. @Since 5.5.0.1

If specified instance is not mapped to current environment then execution will be skipped.

This method is to be used for Full Deployment project of All Files Partial Deployment project. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

setInstanceOverride(projectId, instanceCodeList)

Set instance overrides (deploy or utility) for specified project id. Execution will only happen against specified instances (supply java.util.List of String instance codes) if it is mapped to current environment. @Since 5.5.0.1

Instance codes that are not mapped to current environment will be skipped.

This method is to be used for Full Deployment project of All Files Partial Deployment project. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

setInstanceOverride(projectId, packageName, instanceCode)

Set instance overrides (deploy or utility) for specified project id and package name. @Since 5.5.0.1

If specified instance is not mapped to current environment then execution will be skipped.

This method is to be used for Partial Deployment project where Package is used in release. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

setInstanceOverride(projectId, packageName, instanceCodeList)

Set instance overrides (deploy or utility) for specified project id and package name. Execution will only happen against specified instances (supply java.util.List of String instance codes), if it is mapped to current environment. @Since 5.5.0.1

Instance codes that are not mapped to current environment will be skipped.

This method is to be used for Partial Deployment project where Package is used in release. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

getInstanceOverride(projectId)Returns List of instance codes configured as overrides. @Since 5.5.0.1
getInstanceOverride(projectId, packageName)Returns List of instance codes configured as overrides. @Since 5.5.0.1
setFlexField(projectId, code, value)Set the value of the flex field for the snapshot project on the stage.
setFlexField(projectId, packageName, code, value)Set the value of the flex field for the snapshot project and package on the stage. If package name is null, all the release projects with the matching projectid will be updated with the same value.
setWorkflowInput(projectId, code, value)Set the value of the workflow inputs for the snapshot project on the stage.
setWorkflowInput(projectId, packageName, code, value)Set the value of the workflow inputs for the snapshot project and package on the stage. If package name is null, all the release projects with the matching projectid will be updated with the same value.

...