Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

processStep

On this page
Back to index

Summary

A step in an application or component process.
processName
Stringrequired
The name of the process.
processStepName
Stringrequired
The name of the process step.
projectName
Stringrequired
The name for the project that must be unique among all projects.
actionLabelText
Stringoptional
The JSON derived action label text.
actualParameters
Stringoptional
Actual parameters passed to an invoked subprocedure or process. (Alternate argument name actualParameter.)
afterLastRetry
Stringoptional
Specifies error handling for the auto retry step.
afterProcessStep
Stringoptional
If specified, the process step will be placed after the named process step.
allowSkip
Stringoptional
When enabled, manual process step can be skipped.
alwaysRun
Stringoptional
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.
assignees
Stringoptional
A list of assignees who receive the notification. (Alternate argument name assignee.)
beforeProcessStep
Stringoptional
If specified, the process step will be placed before the named process step.
clearActualParameters
Stringoptional
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
Stringoptional
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.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
disableFailure
Stringoptional
True means a manual process step cannot be failed.
emailConfigName
Stringoptional
The name of email configuration.
errorHandling
Stringoptional
Specifies error handling for this step.
includeCompParameterRef
Stringoptional
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
Stringoptional
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.
retryCount
Stringoptional
If the retry is auto, specify the maximum number of times retry should occur.
retryInterval
Stringoptional
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.
rollbackSnapshot
Stringoptional
Name of Snapshot to be used for rollback.
rollbackType
Stringoptional
The type of the rollback.
rollbackUndeployProcess
Stringoptional
Name of the undeploy process to be used during rollback.
skipRollbackIfUndeployFails
Stringoptional
When enabled, rollback will be performed only for the components that were successfully undeployed.
smartRollback
Stringoptional
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.
useUtilityResource
Stringoptional
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

There are no usage examples available for processStep.