You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

cancel(current)

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


Parameter(s):

NameTypeMandatoryDefault Value
currentSimpleRecord objectYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

cancel
    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:

TypeDescription
SimpleRecord object or NULL


Example:

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

delete()

This method deletes the workflow and all its elements.


Return:

TypeDescription
BooleanThis method returns the boolean result (TRUE if the workflow was successful deleted; otherwise, returns FALSE).


Example:

delete
   	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):

NameTypeMandatoryDefault Value
currentSimplerecord objectYN


Return:

TypeDescription
BooleanThis method returns the boolean result (TRUE if the active workflow context presents; otherwise, returns FALSE).


Example:

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

start(current)

This method is intended to start the workflow.


Parameter(s):

NameTypeMandatoryDefault Value
currentSimpleRecord objectYN


Return:

TypeDescription
SimpleRecord object or NULL


Example:

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

method()

Method description


Parameter(s):

NameTypeMandatoryDefault Value





Return:

TypeDescription



Example:


method()

Method description


Parameter(s):

NameTypeMandatoryDefault Value





Return:

TypeDescription



Example:


method()

Method description


Parameter(s):

NameTypeMandatoryDefault Value





Return:

TypeDescription



Example:


  • No labels