Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called before the business process flow status changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Use this to add a function as an event handler for the OnPreStageChange event so that it will be called before the business process flow stage changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called when the business process flow status changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Use this to add a function as an event handler for the OnStageChange event so that it will be called when the business process flow stage changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Use this to add a function as an event handler for the OnStageSelected event so that it will be called when a business process flow stage is selected.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Use this method to get a collection of stages currently in the active path with methods to interact with the stages displayed in the business process flow control. The active path represents stages currently rendered in the process control based on the branching rules and current data in the record.
A collection of all completed stages, the currently active stage, and the predicted set of future stages based on satisfied conditions in the branching rule. This may be a subset of the stages returned with formContext.data.process.getActiveProcess because it will only include those stages which represent a valid transition from the current stage based on branching that has occurred in the process.
Returns a Process object representing the active process.
current active process.
Returns a Stage object representing the active stage.
current active stage.
Use this method to asynchronously retrieve the enabled business process flows that the user can switch to for an entity.
The callback function must accept a parameter that contains an object with dictionary properties where the name of the property is the Id of the business process flow and the value of the property is the name of the business process flow. The enabled processes are filtered according to the user’s privileges. The list of enabled processes is the same ones a user can see in the UI if they want to change the process manually.
Returns all process instances for the entity record that the calling user has access to.
Optional callbackFunction: Xrm.ProcessFlow.GetProcessInstancesDelegate(Optional) a function to call when the operation is complete.
Use this method to get the currently selected stage.
The currently selected stage.
Use this method to get the current status of the process instance
The current status of the process
Progresses to the next stage.
Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate(Optional) A function to call when the operation is complete.
Moves to the previous stage.
Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate(Optional) A function to call when the operation is complete.
Use this to remove a function as an event handler for the OnPreProcessStatusChange event.
If an anonymous function is set using the addOnPreProcessStatusChange method it cannot be removed using this method.
Use this to remove a function as an event handler for the OnPreStageChange event.
If an anonymous function is set using the addOnPreStageChange method it cannot be removed using this method.
Use this to remove a function as an event handler for the OnProcessStatusChange event.
If an anonymous function is set using the addOnProcessStatusChange method it cannot be removed using this method.
Use this to remove a function as an event handler for the OnStageChange event.
If an anonymous function is set using the addOnStageChange method it cannot be removed using this method.
Use this to remove a function as an event handler for the OnStageChange event.
If an anonymous function is set using the addOnStageChange method it cannot be removed using this method.
Set a Process as the active process.
The Id of the process to make the active process.
Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate(Optional) a function to call when the operation is complete.
Sets a process instance as the active instance
The Id of the process instance to make the active instance.
Optional callbackFunction: Xrm.ProcessFlow.SetProcessInstanceDelegate(Optional) a function to call when the operation is complete.
Set a stage as the active stage.
the Id of the stage to make the active stage.
Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate(Optional) a function to call when the operation is complete.
Use this method to set the current status of the process instance
The new status for the process
Optional callbackFunction: Xrm.ProcessFlow.ProcessSetStatusDelegate(Optional) a function to call when the operation is complete.
Generated using TypeDoc
Interface for the Xrm.Page.data.process API.
Deprecated
Use ProcessManager instead.