Edit

setProgress (Client API reference)

  • Article

Updates the progress of the action step.

Syntax

stepObj.setProgress(stepProgress,message);

Parameters

Name Type Required Description
stepProgress Number Yes Specify one of the following values to specify the step progress:
0: None
1: Processing
2: Completed
3: Failure
4: Invalid
message String No An optional message that is set as the Alt text on the icon for the step.

Return Value

Type: String.

Description: Returns invalid or success depending on whether the step progress was updated.

Remarks

This method is supported only for the action steps. Action steps are buttons on the business process stages that users can click to trigger an on-demand workflow or action. Action step is a preview feature introduced in the v9.0 release. More information: See the Business Process Flow automation with Action Steps section in Blog: New automation and visualization features for Business Process Flows (public preview).

getProgress
formContext.data.process