Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Этот серверный класс предоставляет собой методы и общедоступные функции, которые позволяют управлять рабочими процессами и их компонентами, такими как действия, переходы и другие.
Чтобы создать экземпляр класса SimpleWorkflow, следуйте приведенному ниже примеру
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:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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Описание |
---|---|
VoidThis | method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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). | Метод возвращает "null", если объект SimpleWorkflow был создан без указания параметра workflowId. Метод возвращает объект (SimpleRecord type) таблицы Рабочий процесс (wf_workflow). |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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'. | При успешном удалении процесса метод возвращает "true". В случае неудачи метод возвращает "false". |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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'. | Если контекст активного рабочего процесса найден, метод возвращает значение "true". Если такой контекст отсутствует, метод возвращает "false". |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 Метод возвращает объект (SimpleRecord type) таблицы Контекста рабочего процесса (wf_context) table (of a SimpleRecord type). |
ExampleПример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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Данный метод предназначен для запуска рабочего процесса. При помощи метода start(current) можно запустить только рабочие процессы, в которых Тип условия указан как Ручной.
Параметры:
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). | или NULL | В случае успеха метод возвращает объект (SimpleRecord type) таблицы Контекст рабочего процесса (wf_context).
|
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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). | или NULL | Метод возвращает объект (SimpleRecord type) таблицы Контекст рабочего процесса (wf_context). Метод возвращает значение "null", если нет версий рабочего процесса, созданных текущим пользователем. |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Table of Contents | ||||
---|---|---|---|---|
|