cancel(current)
This method allows cancelling all active contexts of the current record.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
current | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
Void | This 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:
Type | Description |
---|---|
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:
Type | Description |
---|---|
Boolean | This 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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
current | Simplerecord object | Y | N |
Return:
Type | Description |
---|---|
Boolean | This 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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
current | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
SimpleRecord object or NULL |
Example:
start
let context = simpleWorkflow.start(current); if (context.state === 'finished') { ss.info('Workflow finished!'); }
method()
Method description
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Return:
Type | Description |
---|---|
Example:
method()
Method description
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Return:
Type | Description |
---|---|
Example:
method()
Method description
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
Return:
Type | Description |
---|---|
Example: