SimpleWorkflow

This server-side class provide methods and public functions that allow operating with workflows and theirs components, such as activities, transitions, and so on.

You can create an instance of the SimpleWorkflow class in the way described below:

    const workflow = new SimpleWorkflow('workflowId');

Parameter(s):

cancel(current)

This method allows cancelling all active contexts of the current record.

Parameter(s):

Return:

Example:

    if (simpleWorkflow.hasActiveContexts(current)) {
    	simpleWorkflow.cancel(current);
    }

copy()

This method copies the workflow with creating a version in the Checked Out state and after that returns a copied workflow.

Return:

Example:

   	const copiedWorkflow = SimpleWorkflow.copy();
   	const simpleWorkflow = new SimpleWorkflow(copiedWorkflow.sys_id);

delete()

This method deletes the workflow and all its elements.

Return:

Example:

   	let copiedWorkflow = simpleWorkflow.copy();
   	let simpleWorkflow = new SimpleWorkflow(copiedWorkflow.sys_id);
   	if (simpleWorkflow.delete()) {
   		ss.info('Workflow deleted!');
   	}

hasActiveContexts(current)

This method checks the current record if there are any active workflow contexts present or not.

Parameter(s):

Return:

Example:

    if (simpleWorkflow.hasActiveContexts(current)) {
    	simpleWorkflow.cancel(current);
    }

revival(executingActivity, current)

This method restarts the workflow starting with the activity specified.

Parameter(s):

Return:

Example:

let current = new SimpleRecord('task');
current.query();
current.next();
let activity = new SimpleRecord('wf_executing_activity');
activity.query();
activity.next();
let context = (new SimpleWorkflow())->revival(activity, current);

start(current)

This method is intended to start the workflow.

Parameter(s):

Return:

Example:

    let context = simpleWorkflow.start(current);
    if (context.state === 'finished') {
    	ss.info('Workflow finished!');
    }

startSubflow(executingActivity, current, workflowId)

This method allows starting sub-workflow by executing activity.

Parameter(s):

Return:

Example: