You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
This server-side class provides methods and public functions that allow operating with workflows and theirs components, such as activities, transitions, and other.
To create an instance of the SimpleWorkflow class, follow the example below:
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| workflowId | Integer | N | NULL |
cancel(current)
This method allows cancelling all active contexts of the current record.
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| current | SimpleRecord object | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
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 | This method returns NULL if the new SimpleWorkflow object has been created without specifying the workflowId parameter; otherwise, it returns an object of the Workflow (wf_workflow) table (of a SimpleRecord type). |
Example:
const workflow = new SimpleWorkflow('159491114038814558');
const copiedWorkflow = workflow.copy();
const simpleWorkflow = new SimpleWorkflow(copiedWorkflow.sys_id);
delete()
This method deletes the workflow and all its elements.
Return:
| Type | Description |
|---|---|
| Boolean | This method returns 'true' if the workflow has been successfully deleted; otherwise, it returns 'false'. |
Example:
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
const copiedWorkflow = simpleWorkflow.copy();
const 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 presented or not.
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| current | SimpleRecord object | Y | N |
Return:
| Type | Description |
|---|---|
| Boolean | This method returns 'true' if the active workflow context presents; otherwise, it returns 'false'. |
Example:
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
if (simpleWorkflow.hasActiveContexts(current)) {
simpleWorkflow.cancel(current);
}
revival(executingActivity, current)
This method restarts the workflow starting with the activity specified.
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| executingActivity | SimpleRecord object | Y | N |
| current | SimpleRecord object | Y | N |
Return:
| Type | Description |
|---|---|
| SimpleRecord object | This method returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type). |
Example:
const current = new SimpleRecord('task');
current.get('164579976616724057');
const approval = new SimpleRecord('sys_approval');
approval.get('164625329711023536');
const activity = approval.wf_executing_activity_id;
const workflow = new SimpleWorkflow();
workflow.revival(activity, current);
start(current)
Use this method to start the workflow. The method starts only the workflows where the Condition Type is set to Manual.
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| current | SimpleRecord object | Y | N |
Return:
| Type | Description |
|---|---|
| SimpleRecord object or NULL | This method returns NULL in the cases listed below:
Otherwise, it returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type). |
Example:
const simpleWorkflow = new SimpleWorkflow('159491114038814558');
const context = simpleWorkflow.start(current);
if (context.state === 'finished') {
ss.info('Workflow finished!');
}
startSubflow(executingActivity, current, workflowId)
This method allows starting a sub-workflow by executing activity.
Параметры:
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| executingActivity | SimpleRecord object | Y | N |
| current | SimpleRecord object | Y | N |
| workflowId | Integer | Y | N |
Return:
| Type | Description |
|---|---|
| SimpleRecord object or NULL | This method returns NULL if there are no workflow versions created by the current user; otherwise, it returns an object of the Workflow Context (wf_context) table (of a SimpleRecord type). |
Example:
- No labels
