PublicAPI.Processes.WorkflowInstance.TerminateProcess

ELMA API Documentation

Terminate process instance

Access path: PublicAPI.Processes.WorkflowInstance.TerminateProcess

Syntax

public void TerminateProcess(
	WorkflowInstance instance,
	string reason,
	User user
)

Parameters

instance: Type: WorkflowInstance
Process instance, which needs to be terminated. Object. Access path: PublicAPI.Processes.WorkflowInstance

reason: Type: System String
Process termination reason

user: Type: User
User, who terminated the process. Object. Access path: PublicAPI.Portal.Security.User

Examples

Copy to Clipboard Print

//load the process instance by ID 
var instance = PublicAPI.Processes.WorkflowInstance.Load(3);
//load the user by ID 
var user = PublicAPI.Portal.Security.User.Load(3);
//process termination reason 
var reason = "Process termination reason";

//terminate the process
PublicAPI.Processes.WorkflowInstance.TerminateProcess(instance, reason, user);