modifyProcessStep

Back to index

Summary

Modifies an existing process step.

projectName

Stringrequired

The name for the project that must be unique among all projects.

processName

Stringrequired

The name of the process.

processStepName

Stringrequired

The name of the process step.

actionLabelText

Stringoptional

The JSON derived action label text.

actualParameter

Arrayoptional

Actual parameters passed to an invoked subprocedure or process.

afterLastRetry

Stringoptional

Specifies error handling for the auto retry step.

Possible values: "continueOnError", "stopOnError"

afterProcessStep

Stringoptional

If specified, the process step will be placed after the named process step.

allowSkip

Booleanoptional

When enabled, manual process step can be skipped.

alwaysRun

Booleanoptional

True means this step will run even if preceding steps fail in a way that aborts the job.

applicationName

Stringoptional

The name of the application, if the process is owned by an application.

applicationTierName

Stringoptional

If references an application tier, the name of the application tier.

assignee

Arrayoptional

A list of assignees who receive the notification.

beforeProcessStep

Stringoptional

If specified, the process step will be placed before the named process step.

clearActualParameters

Booleanoptional

If true, the step should remove all actual parameters.

componentApplicationName

Stringoptional

If specified, the component is scoped to this application not the project.

componentName

Stringoptional

The name of the component, if the process is owned by a component.

componentRollback

Booleanoptional

When enabled, rollback will be performed only for the components that were not deployed successfully.

credentialName

Stringoptional

The name of the credential object.

dependencyJoinType

Stringoptional

Join type for incoming dependencies.

Possible values: "and", "or"

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

disableFailure

Booleanoptional

True means a manual process step cannot be failed.

emailConfigName

Stringoptional

The name of email configuration.

errorHandling

Stringoptional

Specifies error handling for this step.

Possible values: "abortJob", "abortJobNow", "abortProcedure", "abortProcedureNow", "failProcedure", "ignore", "retryOnError"

includeCompParameterRef

Booleanoptional

True if the actual parameters should be generated from component properties. Works for artifact components only.

instruction

Stringoptional

Instruction associated with the manual process step.

microserviceApplicationName

Stringoptional

If specified, the microservice is scoped to an application.

microserviceName

Stringoptional

The name of the microservice, if the process is owned by a microservice.

newName

Stringoptional

The new name for an existing object that is being renamed.

notificationEnabled

Booleanoptional

True means this email notification is enabled, false otherwise.

notificationTemplate

Stringoptional

Email notification template for process step.

processStepType

Stringoptional

Defines type of the process step.

Possible values: "command", "component", "manual", "none", "plugin", "procedure", "process", "rollback", "service", "utility"

retryCount

Integeroptional

If the retry is auto, specify the maximum number of times retry should occur.

retryInterval

Integeroptional

If the retry is auto, specify the interval in seconds after which retry should be attempted.

retryType

Stringoptional

Type of retry when process step fails. Is one of auto or manual.

Possible values: "auto", "manual"

rollbackSnapshot

Stringoptional

Name of Snapshot to be used for rollback.

rollbackType

Stringoptional

The type of the rollback.

Possible values: "environment", "snapshot"

rollbackUndeployProcess

Stringoptional

Name of the undeploy process to be used during rollback.

skipRollbackIfUndeployFails

Booleanoptional

When enabled, rollback will be performed only for the components that were successfully undeployed.

smartRollback

Booleanoptional

Smart deploy flag to be used during rollback is triggered.

subcomponent

Stringoptional

If referencing a component process, the name of the component.

subcomponentApplicationName

Stringoptional

If referencing a component process, the name of the component application (if not project scoped).

subcomponentProcess

Stringoptional

If referencing a component process, the name of the component process.

submicroservice

Stringoptional

If referencing a microservice, the name of the microservice.

submicroserviceProcess

Stringoptional

If referencing a microservice process, the name of the microservice process.

subprocedure

Stringoptional

If referencing a procedure, the name of the procedure.

subproject

Stringoptional

If referencing a procedure, the name of the procedure's project.

timeLimit

Stringoptional

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

Stringoptional

Units for step time limit: seconds, minutes, or hours.

Possible values: "hours", "minutes", "seconds"

useUtilityResource

Booleanoptional

True means that step will run on utility resource instead of a tier.

utilityResourceName

Stringoptional

Utility resource name.

workingDirectory

Stringoptional

Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job's workspace.

workspaceName

Stringoptional

The name of the workspace.

Usage

Perl

$cmdr->modifyProcessStep(
  "test-projectName", # projectName
  "test-processName", # processName
  "test-processStepName" # processStepName
  # optionals
);▼

ectool

ectool modifyProcessStep \
  "test-projectName" `# projectName` \
  "test-processName" `# processName` \
  "test-processStepName" `# processStepName` \
  # optionals▼

Examples

Perl

To modify a component process step in a master component:

$cmdr->modifyProcessStep('Default', 'Deploy', 'Check out', {componentName => 'WAR file', newName => 'Backup files'});▼

To modify a component process step in a specific application:

$cmdr->modifyProcessStep('Default', 'Deploy', 'Check out', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart', newName => 'Backup files'});▼

To modify an application process step:

$cmdr->modifyProcessStep('Default', 'Deploy', 'Check out', {applicationName => 'Shopping Cart', newName => 'Backup files'});▼

ectool

To modify a component process step in a master component:

ectool modifyProcessStep 'Default' 'Deploy' 'Check out' --componentName 'WAR file' --newName 'Backup files'▼

To modify a component process step in a specific application:

ectool modifyProcessStep 'Default' 'Deploy' 'Check out' --componentName 'WAR file' --componentApplicationName 'Shopping Cart' --newName 'Backup files'▼

To modify an application process step:

ectool modifyProcessStep  'Default' 'Deploy' 'Check out' --applicationName 'Shopping Cart' --newName 'Backup files'▼