Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.75 KB

File metadata and controls

45 lines (32 loc) · 1.75 KB
title description author ms.author ms.date ms.reviewer ms.topic applies_to search.audienceType contributors
setProgress (Client API reference) in model-driven apps| MicrosoftDocs
Includes description and supported parameters for the setProgress method.
HemantGaur
hemantg
03/12/2022
jdaly
reference
Dynamics 365 (online)
developer
JimDaly

setProgress (Client API reference)

[!INCLUDE./includes/setProgress-description.md]

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).

Related articles

getProgress
formContext.data.process

[!INCLUDEfooter-include]