setActiveProcess (Client API reference)
Sets a Process as the active process.
If there is an active instance of the process, the table record is loaded with the process instance ID. If there is no active instance of the process, a new process instance is created and the table record is loaded with the process instance ID. If there are multiple instances of the current process, the record is loaded with the first instance of the active process as per the defaulting logic, that is the most recently used process instance per user.
setActiveProcess method should be used while creating or editing a record. Use the
setActiveProcess method to set the active process for a business process flow instead of
Xrm.Navigation.openForm method .
Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.
|processId||String||Yes||The Id of the process to set as the active process.|
|callbackFunction||Function||No||A function to call when the operation is complete. This callback function is passed one of the following string values to indicate whether the operation succeeded:
- success: The operation succeeded.
- invalid: The processId isn’t valid or the process isn’t enabled.