Начало работы с Workflows: различия между версиями
Новая страница: « = Начало работы с Workflows = Давайте пройдём через пример «Hello World», добавим несколько задач и настроим автоматический триггер. == Hello World == В этой процедуре мы создаём workflow с одной задачей '''Запустить JavaScript''' и запускаем его. Вам не нужно писать JavaScript для этой...» |
Нет описания правки |
||
| Строка 4: | Строка 4: | ||
== Hello World == | == Hello World == | ||
В этой процедуре мы создаём | В этой процедуре мы создаём Workflow с одной задачей '''Запустить JavaScript''' и запускаем его. Вам не нужно писать JavaScript для этой процедуры; мы будем использовать стандартный пример JavaScript. | ||
=== Цели === | === Цели === | ||
* Ознакомиться с основными действиями '''Workflows'''. | * Ознакомиться с основными действиями '''Workflows'''. | ||
* Убедиться, что у вас есть все '''разрешения''', необходимые для запуска | * Убедиться, что у вас есть все '''разрешения''', необходимые для запуска Workflow и пользовательских скриптов. | ||
=== Шаги === | === Шаги === | ||
| Строка 16: | Строка 16: | ||
* Перейдите в '''Workflows'''. Убедитесь, что вы на вкладке '''Workflows''', а не на вкладке '''Выполнения'''. | * Перейдите в '''Workflows'''. Убедитесь, что вы на вкладке '''Workflows''', а не на вкладке '''Выполнения'''. | ||
* Выберите '''Workflow''' в правом верхнем углу страницы. | * Выберите '''Workflow''' в правом верхнем углу страницы. | ||
* Выберите '''Workflow''', чтобы создать новый | * Выберите '''Workflow''', чтобы создать новый Workflow. Откроется редактор Workflow. | ||
* Выберите заголовок | * Выберите заголовок Workflow. По умолчанию это <code>Untitled workflow</code>, и введите собственное имя, например <code>Quick Start</code>. | ||
* На панели '''Выбрать триггер''' справа прокрутите вниз и выберите триггер '''По требованию'''. Мы собираемся создать | * На панели '''Выбрать триггер''' справа прокрутите вниз и выберите триггер '''По требованию'''. Мы собираемся создать Workflow, который вы запускаете вручную через веб-интерфейс или '''REST API'''. | ||
* Чтобы добавить первую задачу в ваш | * Чтобы добавить первую задачу в ваш Workflow, наведите курсор на узел триггера графа Workflow и выберите '''Добавить'''. | ||
* На панели '''Выбрать действие''' справа выберите '''Запустить JavaScript'''. Теперь | * На панели '''Выбрать действие''' справа выберите '''Запустить JavaScript'''. Теперь Workflow имеет свою первую задачу и показывает конфигурацию ввода справа. Он поставляется с примером кода, который получает, кто запустил выполнение Workflow, и логирует это. | ||
* Выберите '''Запустить''', чтобы выполнить черновик | * Выберите '''Запустить''', чтобы выполнить черновик Workflow. Этот шаг также сохраняет ваш черновик. | ||
* При первом запуске | * При первом запуске Workflow вам будет предложено авторизовать службу автоматизации для запуска Workflow от имени вашего пользователя. Выберите '''Разрешить и запустить''', если вы согласны с этим. Вы всегда можете ограничить конфигурацию в '''настройках'''. | ||
'''Ошибка?''' Если вы получили ошибку «forbidden» при запуске | '''Ошибка?''' Если вы получили ошибку «forbidden» при запуске Workflow, проверьте настройки авторизации. | ||
* В правом верхнем углу выберите '''Настройки > Настройки авторизации'''. | * В правом верхнем углу выберите '''Настройки > Настройки авторизации'''. | ||
* Убедитесь, что у вас есть все '''необходимые разрешения'''. | * Убедитесь, что у вас есть все '''необходимые разрешения'''. | ||
* Запустите | * Запустите Workflow снова. | ||
Приложение переключается на '''монитор | Приложение переключается на '''монитор Workflow''', который представляет собой живое представление только что запущенного выполнения. Это представление автоматически обновляется, пока выполнение не достигнет конечного состояния. Правая панель показывает детали выполнения. | ||
* Пока | * Пока Workflow выполняется, вы должны видеть '''Состояние''' — '''Выполняется'''. | ||
* Когда выполнение завершено, вы должны видеть '''Состояние''' — '''Успех'''. | * Когда выполнение завершено, вы должны видеть '''Состояние''' — '''Успех'''. | ||
* Если вы не получили '''Успех''', информация о состоянии сообщит вам, почему. | * Если вы не получили '''Успех''', информация о состоянии сообщит вам, почему. | ||
* Вы можете изучить детали отдельных задач, выбрав их на графе, как показано ниже на скриншоте. | * Вы можете изучить детали отдельных задач, выбрав их на графе, как показано ниже на скриншоте. | ||
* Скриншот деталей задачи JavaScript из Quick Start | * Скриншот деталей задачи JavaScript из Quick Start Workflow. | ||
== Несколько задач == | == Несколько задач == | ||
Теперь, когда вы убедились, что можете запускать | Теперь, когда вы убедились, что можете запускать Workflow и пользовательские скрипты, давайте добавим ещё одну задачу и отправим пользовательское событие в хранилище данных. | ||
=== Цели === | === Цели === | ||
Теперь вы научитесь: | Теперь вы научитесь: | ||
* Редактировать | * Редактировать Workflow. | ||
* Добавлять больше задач в | * Добавлять больше задач в Workflow. | ||
* Переименовывать задачу. | * Переименовывать задачу. | ||
* Запускать JavaScript из задачи. | * Запускать JavaScript из задачи. | ||
=== Шаги === | === Шаги === | ||
* На мониторе | * На мониторе Workflow выберите '''Редактировать Workflow''', чтобы вернуться в редактор Workflow. | ||
* Чтобы добавить ещё одну задачу, наведите курсор на узел, к которому вы хотите её добавить, и выберите '''Добавить'''. Вы можете добавлять задачи в любой точке | * Чтобы добавить ещё одну задачу, наведите курсор на узел, к которому вы хотите её добавить, и выберите '''Добавить'''. Вы можете добавлять задачи в любой точке Workflow. У вас также могут быть несколько задач, выполняемых параллельно. Давайте добавим одну после нашей первой задачи <code>run_javascript_1</code>, так как мы планируем использовать некоторую информацию отсюда позже. | ||
* На панели '''Выбрать действие''' справа выберите '''Запустить JavaScript'''. | * На панели '''Выбрать действие''' справа выберите '''Запустить JavaScript'''. | ||
* Теперь хорошая возможность дать этой задаче лучшее имя, выбрав имя задачи в правом верхнем углу (аналогично тому, как мы меняли заголовок | * Теперь хорошая возможность дать этой задаче лучшее имя, выбрав имя задачи в правом верхнем углу (аналогично тому, как мы меняли заголовок Workflow) и изменив его на <code>ingest_custom_event</code>. | ||
* Как следует из названия, мы хотим, чтобы вторая задача загружала пользовательское событие в хранилище данных с помощью '''API''' Ключ-АСТРОМ, доступного для импорта в действии '''Запустить JavaScript'''. Для этого скопируйте следующий код JavaScript и вставьте его в поле '''Исходный код''', чтобы заменить стандартный пример. | * Как следует из названия, мы хотим, чтобы вторая задача загружала пользовательское событие в хранилище данных с помощью '''API''' Ключ-АСТРОМ, доступного для импорта в действии '''Запустить JavaScript'''. Для этого скопируйте следующий код JavaScript и вставьте его в поле '''Исходный код''', чтобы заменить стандартный пример. | ||
<pre>import { execution } from "@astromkey-sdk/automation-utils"; | <pre>import { execution } from "@astromkey-sdk/automation-utils"; | ||
| Строка 75: | Строка 74: | ||
}</pre>Это создаст событие <code>CustomInfo</code>, залогирует ответ '''API''' и вернёт его. Возвращая данные, они становятся доступными как результат задачи и могут использоваться последующими задачами. Дополнительную информацию о '''SDK''' см. в разделе '''Разработчик Ключ-АСТРОМ'''. | }</pre>Это создаст событие <code>CustomInfo</code>, залогирует ответ '''API''' и вернёт его. Возвращая данные, они становятся доступными как результат задачи и могут использоваться последующими задачами. Дополнительную информацию о '''SDK''' см. в разделе '''Разработчик Ключ-АСТРОМ'''. | ||
* Чтобы проверить изменения, сохраните и запустите | * Чтобы проверить изменения, сохраните и запустите Workflow, как раньше. Поскольку мы записываем новые события в '''API''' Ключ-АСТРОМ, вашему пользователю требуются необходимые разрешения (<code>storage:events:write</code>) для этого, а также необходимо разрешить '''AutomationEngine''' действовать с этим разрешением (мы разрешили '''AutomationEngine''' действовать от нашего имени в примере Hello World). Отсутствие разрешений будет отражено в статусе и логах задачи <code>ingest_custom_event</code>. | ||
* После успешного выполнения давайте вернёмся к редактированию | * После успешного выполнения давайте вернёмся к редактированию Workflow и используем результаты задачи. Наш пример <code>run_javascript_1</code> возвращает информацию <code>triggeredBy</code>, которую мы теперь будем использовать в качестве полезной нагрузки в нашем пользовательском событии. Выберите задачу <code>ingest_custom_event</code> (нашу вторую задачу), скопируйте следующий код JavaScript и вставьте его в '''Исходный код''', чтобы заменить текущее содержимое задачи <code>ingest_custom_event</code>. | ||
<pre>import { execution } from "@astromkey-sdk/automation-utils"; | <pre>import { execution } from "@astromkey-sdk/automation-utils"; | ||
import { eventsClient, EventIngestEventType } from '@astromkey-sdk/client-classic-environment-v2'; | import { eventsClient, EventIngestEventType } from '@astromkey-sdk/client-classic-environment-v2'; | ||
| Строка 97: | Строка 96: | ||
}</pre>На этот раз мы получаем детали выполнения, извлекаем результаты задачи <code>run_javascript_1</code> и используем информацию <code>triggeredBy</code> в качестве полезной нагрузки события. | }</pre>На этот раз мы получаем детали выполнения, извлекаем результаты задачи <code>run_javascript_1</code> и используем информацию <code>triggeredBy</code> в качестве полезной нагрузки события. | ||
* Запустите | * Запустите Workflow снова, чтобы убедиться, что событие успешно создаётся с новой полезной нагрузкой. | ||
== Автоматические триггеры == | == Автоматические триггеры == | ||
Осталось добавить автоматический триггер в наш | Осталось добавить автоматический триггер в наш Workflow. | ||
=== Цели === | === Цели === | ||
* Научиться автоматически запускать | * Научиться автоматически запускать Workflow вместо ручного запуска. | ||
=== Шаги === | |||
* На мониторе | * На мониторе Workflow выберите '''Редактировать Workflow''', чтобы вернуться в редактор Workflow. | ||
* Выберите узел триггера на графе (в нашем примере он должен говорить '''Триггер по требованию'''). На панели деталей триггера справа выберите '''Изменить триггер''' и подтвердите, что хотите изменить триггер. Это действие отменяет текущее определение триггера. | * Выберите узел триггера на графе (в нашем примере он должен говорить '''Триггер по требованию'''). На панели деталей триггера справа выберите '''Изменить триггер''' и подтвердите, что хотите изменить триггер. Это действие отменяет текущее определение триггера. | ||
* На панели '''Выбрать триггер''' выберите триггер '''Интервал времени'''. | * На панели '''Выбрать триггер''' выберите триггер '''Интервал времени'''. | ||
* Оставьте значение интервала ('''Запускать каждые (мин)''') по умолчанию (<code>30 минут</code>). | * Оставьте значение интервала ('''Запускать каждые (мин)''') по умолчанию (<code>30 минут</code>). | ||
* Выберите '''Сохранить'''. Выберите '''Развернуть''', чтобы сделать | * Выберите '''Сохранить'''. Выберите '''Развернуть''', чтобы сделать Workflow live и применить автоматический триггер. С этим изменением и развёртыванием черновика: | ||
** Была создана live-версия | ** Была создана live-версия Workflow. Live-Workflow будет автоматически запускаться каждые 30 минут. | ||
** Каждое выполнение, каждые 30 минут, перечисляется в таблице '''Выполнения'''. Выберите '''Выполнения''', чтобы увидеть список выполнений. Отфильтруйте ваш | ** Каждое выполнение, каждые 30 минут, перечисляется в таблице '''Выполнения'''. Выберите '''Выполнения''', чтобы увидеть список выполнений. Отфильтруйте ваш Workflow, если в среде уже есть другие выполняющиеся выполнения. | ||
== Quick Start workflow с использованием шаблона == | == Quick Start workflow с использованием шаблона == | ||
Вы можете использовать шаблон | Вы можете использовать шаблон Workflow для начала работы. Выберите приведённый ниже код Quick Start Workflow. Скопируйте выбранный код Workflow. Вставьте его в текстовый редактор. Сохраните шаблон как <code>quickstart.yaml</code>. В '''Workflows''' Ключ-АСТРОМ выберите '''Загрузить'''. Выберите <code>quickstart.yaml</code>. Выберите '''Импорт'''. Вы загрузили Quick Start Workflow в ваш тенант Ключ-АСТРОМ. Вы можете вносить правки, запускать его и развёртывать.<pre>{ | ||
"title": "Quick start", | "title": "Quick start", | ||
"taskDefaults": {}, | "taskDefaults": {}, | ||
| Строка 162: | Строка 150: | ||
"predecessors": [ | "predecessors": [ | ||
"run_javascript_1" | "run_javascript_1" | ||
] | ] | ||
} | } | ||
} | } | ||
}</pre> | }</pre> | ||
Текущая версия от 21:58, 16 ноября 2026
Начало работы с Workflows
Давайте пройдём через пример «Hello World», добавим несколько задач и настроим автоматический триггер.
Hello World
В этой процедуре мы создаём Workflow с одной задачей Запустить JavaScript и запускаем его. Вам не нужно писать JavaScript для этой процедуры; мы будем использовать стандартный пример JavaScript.
Цели
- Ознакомиться с основными действиями Workflows.
- Убедиться, что у вас есть все разрешения, необходимые для запуска Workflow и пользовательских скриптов.
Шаги
- Войдите в Ключ-АСТРОМ.
- Перейдите в Workflows. Убедитесь, что вы на вкладке Workflows, а не на вкладке Выполнения.
- Выберите Workflow в правом верхнем углу страницы.
- Выберите Workflow, чтобы создать новый Workflow. Откроется редактор Workflow.
- Выберите заголовок Workflow. По умолчанию это
Untitled workflow, и введите собственное имя, напримерQuick Start. - На панели Выбрать триггер справа прокрутите вниз и выберите триггер По требованию. Мы собираемся создать Workflow, который вы запускаете вручную через веб-интерфейс или REST API.
- Чтобы добавить первую задачу в ваш Workflow, наведите курсор на узел триггера графа Workflow и выберите Добавить.
- На панели Выбрать действие справа выберите Запустить JavaScript. Теперь Workflow имеет свою первую задачу и показывает конфигурацию ввода справа. Он поставляется с примером кода, который получает, кто запустил выполнение Workflow, и логирует это.
- Выберите Запустить, чтобы выполнить черновик Workflow. Этот шаг также сохраняет ваш черновик.
- При первом запуске Workflow вам будет предложено авторизовать службу автоматизации для запуска Workflow от имени вашего пользователя. Выберите Разрешить и запустить, если вы согласны с этим. Вы всегда можете ограничить конфигурацию в настройках.
Ошибка? Если вы получили ошибку «forbidden» при запуске Workflow, проверьте настройки авторизации.
- В правом верхнем углу выберите Настройки > Настройки авторизации.
- Убедитесь, что у вас есть все необходимые разрешения.
- Запустите Workflow снова.
Приложение переключается на монитор Workflow, который представляет собой живое представление только что запущенного выполнения. Это представление автоматически обновляется, пока выполнение не достигнет конечного состояния. Правая панель показывает детали выполнения.
- Пока Workflow выполняется, вы должны видеть Состояние — Выполняется.
- Когда выполнение завершено, вы должны видеть Состояние — Успех.
- Если вы не получили Успех, информация о состоянии сообщит вам, почему.
- Вы можете изучить детали отдельных задач, выбрав их на графе, как показано ниже на скриншоте.
- Скриншот деталей задачи JavaScript из Quick Start Workflow.
Несколько задач
Теперь, когда вы убедились, что можете запускать Workflow и пользовательские скрипты, давайте добавим ещё одну задачу и отправим пользовательское событие в хранилище данных.
Цели
Теперь вы научитесь:
- Редактировать Workflow.
- Добавлять больше задач в Workflow.
- Переименовывать задачу.
- Запускать JavaScript из задачи.
Шаги
- На мониторе Workflow выберите Редактировать Workflow, чтобы вернуться в редактор Workflow.
- Чтобы добавить ещё одну задачу, наведите курсор на узел, к которому вы хотите её добавить, и выберите Добавить. Вы можете добавлять задачи в любой точке Workflow. У вас также могут быть несколько задач, выполняемых параллельно. Давайте добавим одну после нашей первой задачи
run_javascript_1, так как мы планируем использовать некоторую информацию отсюда позже. - На панели Выбрать действие справа выберите Запустить JavaScript.
- Теперь хорошая возможность дать этой задаче лучшее имя, выбрав имя задачи в правом верхнем углу (аналогично тому, как мы меняли заголовок Workflow) и изменив его на
ingest_custom_event. - Как следует из названия, мы хотим, чтобы вторая задача загружала пользовательское событие в хранилище данных с помощью API Ключ-АСТРОМ, доступного для импорта в действии Запустить JavaScript. Для этого скопируйте следующий код JavaScript и вставьте его в поле Исходный код, чтобы заменить стандартный пример.
import { execution } from "@astromkey-sdk/automation-utils";
import { eventsClient, EventIngestEventType } from '@astromkey-sdk/client-classic-environment-v2';
export default async function () {
const my_event = {
"eventType": EventIngestEventType.CustomInfo,
"title": "Workflows quickstart sample event",
"properties": {
"triggeredBy": "tbd"
}
}
const event_result = await eventsClient.createEvent({body: my_event})
console.log(event_result)
return event_result
}Это создаст событие CustomInfo, залогирует ответ API и вернёт его. Возвращая данные, они становятся доступными как результат задачи и могут использоваться последующими задачами. Дополнительную информацию о SDK см. в разделе Разработчик Ключ-АСТРОМ.
- Чтобы проверить изменения, сохраните и запустите Workflow, как раньше. Поскольку мы записываем новые события в API Ключ-АСТРОМ, вашему пользователю требуются необходимые разрешения (
storage:events:write) для этого, а также необходимо разрешить AutomationEngine действовать с этим разрешением (мы разрешили AutomationEngine действовать от нашего имени в примере Hello World). Отсутствие разрешений будет отражено в статусе и логах задачиingest_custom_event. - После успешного выполнения давайте вернёмся к редактированию Workflow и используем результаты задачи. Наш пример
run_javascript_1возвращает информациюtriggeredBy, которую мы теперь будем использовать в качестве полезной нагрузки в нашем пользовательском событии. Выберите задачуingest_custom_event(нашу вторую задачу), скопируйте следующий код JavaScript и вставьте его в Исходный код, чтобы заменить текущее содержимое задачиingest_custom_event.
import { execution } from "@astromkey-sdk/automation-utils";
import { eventsClient, EventIngestEventType } from '@astromkey-sdk/client-classic-environment-v2';
export default async function () {
const exe = await execution();
const result = await exe.result("run_javascript_1");
const my_event = {
"eventType": EventIngestEventType.CustomInfo,
"title": "Workflows quickstart sample event",
"properties": {
"triggeredBy": result.triggeredBy
}
}
const event_result = await eventsClient.createEvent({body: my_event})
console.log(event_result)
return event_result
}На этот раз мы получаем детали выполнения, извлекаем результаты задачи run_javascript_1 и используем информацию triggeredBy в качестве полезной нагрузки события.
- Запустите Workflow снова, чтобы убедиться, что событие успешно создаётся с новой полезной нагрузкой.
Автоматические триггеры
Осталось добавить автоматический триггер в наш Workflow.
Цели
- Научиться автоматически запускать Workflow вместо ручного запуска.
Шаги
- На мониторе Workflow выберите Редактировать Workflow, чтобы вернуться в редактор Workflow.
- Выберите узел триггера на графе (в нашем примере он должен говорить Триггер по требованию). На панели деталей триггера справа выберите Изменить триггер и подтвердите, что хотите изменить триггер. Это действие отменяет текущее определение триггера.
- На панели Выбрать триггер выберите триггер Интервал времени.
- Оставьте значение интервала (Запускать каждые (мин)) по умолчанию (
30 минут). - Выберите Сохранить. Выберите Развернуть, чтобы сделать Workflow live и применить автоматический триггер. С этим изменением и развёртыванием черновика:
- Была создана live-версия Workflow. Live-Workflow будет автоматически запускаться каждые 30 минут.
- Каждое выполнение, каждые 30 минут, перечисляется в таблице Выполнения. Выберите Выполнения, чтобы увидеть список выполнений. Отфильтруйте ваш Workflow, если в среде уже есть другие выполняющиеся выполнения.
Quick Start workflow с использованием шаблона
Вы можете использовать шаблон Workflow для начала работы. Выберите приведённый ниже код Quick Start Workflow. Скопируйте выбранный код Workflow. Вставьте его в текстовый редактор. Сохраните шаблон как quickstart.yaml. В Workflows Ключ-АСТРОМ выберите Загрузить. Выберите quickstart.yaml. Выберите Импорт. Вы загрузили Quick Start Workflow в ваш тенант Ключ-АСТРОМ. Вы можете вносить правки, запускать его и развёртывать.
{
"title": "Quick start",
"taskDefaults": {},
"description": "",
"triggerType": "Manual",
"schemaVersion": 3,
"trigger": {},
"tasks": {
"run_javascript_1": {
"name": "run_javascript_1",
"input": {
"script": "// optional import of sdk modules\nimport { execution } from '@astromkey-sdk/automation-utils';\n\nexport default async function () {\n // your code goes here\n // e.g. get the current execution\n const ex = await execution();\n console.log('Automated script execution on behalf of', ex.trigger);\n \n return { triggeredBy: ex.trigger };\n}"
},
"action": "astromkey.automations:run-javascript",
"position": {
"x": 0,
"y": 1
},
"description": "Build a custom task running JavaScript code",
"predecessors": []
},
"ingest_custom_event": {
"name": "ingest_custom_event",
"input": {
"script": "import { execution } from \"@astromkey-sdk/automation-utils\";\nimport { eventsClient, EventIngestEventType } from '@astromkey-sdk/client-classic-environment-v2';\n\nexport default async function () {\n\n const exe = await execution();\n const result = await exe.result(\"run_javascript_1\");\n \n const my_event = {\n \"eventType\": EventIngestEventType.CustomInfo,\n \"title\": \"Workflows quickstart sample event\",\n \"properties\": {\n \"triggeredBy\": result.triggeredBy\n }\n }\n \n const event_result = await eventsClient.createEvent({body: my_event})\n console.log(event_result)\n\n return event_result\n}"
},
"action": "astromkey.automations:run-javascript",
"position": {
"x": 0,
"y": 2
},
"description": "Build a custom task running JavaScript code",
"predecessors": [
"run_javascript_1"
]
}
}
}