Перейти к основному содержанию

Определите рабочий процесс

Приложения могут включать рабочие процессы. Каждый вызов defineWorkflow() описывает один рабочий процесс: триггер и выполняемые им шаги. При установке Twenty создает его как активный рабочий процесс в рабочей области, готовый к запуску. Этот рабочий процесс запускается при создании компании. Она вызывает одну из логических функций приложения, затем записывает результат в компанию:
src/workflows/score-new-companies.ts
Основные моменты:
  • Рабочему процессу и каждому шагу нужен собственный universalIdentifier, а у триггера он может быть. Сохраняйте их неизменными между релизами: по ним Twenty сопоставляет установленный рабочий процесс при следующей установке.
  • nextStepIds связывает граф. Триггер указывает на первые шаги, а каждый шаг указывает на шаги, выполняемые после него.
  • Шаг считывает предыдущий вывод с помощью {{trigger.\<path>}} или {{\<step universalIdentifier>.\<path>}}.
  • Сборка проверяет всё определение: неподдерживаемые типы триггеров или шагов, повреждённые связи между шагами и ссылки на неизвестные шаги приводят к её сбою.
  • isSystem (необязательный, по умолчанию false) скрывает рабочий процесс из списков, в которых не отображаются системные рабочие процессы. Изменяется только отображаемое содержимое.

Ссылки на другие сущности

Шаги и триггеры ссылаются на метаданные по универсальному идентификатору, а не по имени или id:
  • Объекты и поля: собственные объекты и поля вашего приложения или стандартные через STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS. В приведённом выше примере предполагается, что приложение также определяет числовое поле leadScore в Company с помощью defineField(): шаг записи, который записывает поле, отсутствующее в рабочем пространстве, приводит к сбою установки.
  • Логические функции: собственные функции вашего приложения, доступные как действие рабочего процесса с workflowActionTriggerSettings. Пользовательское приложение рабочего пространства также может ссылаться на действия рабочих процессов других приложений, установленных в рабочем пространстве, как это могут рабочие процессы, созданные в приложении.
  • Агенты: собственные агенты вашего приложения из defineAgent().
Ссылка, которую Twenty не может разрешить, приводит к сбою установки.

Триггеры

Ручной рабочий процесс без availability не получает пункта меню команд. Каждый триггер также принимает необязательные name, position и outputSchema, которые влияют только на то, как рабочий процесс выглядит в конструкторе. Без них Twenty использует имя вроде Manual trigger, размещает триггер в верхней части холста и вычисляет выходную схему на основе настроек. Рабочий процесс webhook прослушивает https://\<your-twenty-domain>/webhooks/workflows/\<workspaceId>/\<workflowId>, где workflowId — это id установленного рабочего процесса. Тело запроса доступно как {{trigger.\<path>}}.

Шаги

Рабочие процессы приложения поддерживают следующие типы шагов: LOGIC_FUNCTION, AI_AGENT, HTTP_REQUEST, CLASSIFY, CREATE_RECORD, UPDATE_RECORD, UPSERT_RECORD, DELETE_RECORD, FIND_RECORDS, PICK_RECORD, FILTER, IF_ELSE, ITERATOR, FORM, DELAY, WAIT_FOR_EVENT, SEND_EMAIL, DRAFT_EMAIL, CREATE_CALENDAR_EVENT, SEND_CHAT_MESSAGE и EMPTY. Их входные данные соответствуют шагам конструктора рабочих процессов, но вместо имён используются универсальные идентификаторы:
  • Шаги записи используют objectUniversalIdentifier вместо имени объекта.
  • Фильтры и сортировки ссылаются на поля с помощью fieldMetadataUniversalIdentifier.
  • Операнды фильтра принимают значения ViewFilterOperand, экспортируемые из twenty-sdk/define. Операторы группы фильтров принимают строковые значения, такие как 'AND' или 'OR'.
  • Поля формы типа RECORD именуют свой объект с помощью settings.objectUniversalIdentifier. Поля типа SELECT и MULTI_SELECT предлагают варианты существующего поля того же типа, именуемого с помощью settings.selectedFieldUniversalIdentifier.
  • Чтобы выполнить собственный код, используйте шаг LOGIC_FUNCTION. Шаг Code в конструкторе недоступен.
  • Шаги AI_AGENT запускают одного из агентов вашего приложения, указанного с помощью agentUniversalIdentifier, и используют настройки шага конструктора: prompt, responseFormat, humanInputInstructions, conversation и workspaceMemberId для участника, с которым ведется разговор агента.
  • Шаги электронной почты и календаря выполняются, только если роль вашего приложения имеет соответствующий флаг разрешения: SystemPermissionFlag.SEND_EMAIL_TOOL для SEND_EMAIL и DRAFT_EMAIL, SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL для CREATE_CALENDAR_EVENT. Рабочая область предоставляет его при установке приложения, после чего шаг может использовать любую подключенную учетную запись в рабочей области, как рабочий процесс, созданный в приложении.
  • Идентификаторы подключенных учетных записей локальны для каждой рабочей области, поэтому не задавайте такой идентификатор жестко в коде. Укажите учетную запись одним из двух способов:
    • connectedAccountHandle: адрес электронной почты учетной записи, например 'sales@example.com'. Когда приложение синхронизируется, идентификатор сопоставляется с учетной записью с этим адресом, которая предоставлена рабочей области (область действия WORKSPACE) и может выполнять этот шаг. Личную учетную запись участника нельзя указать по идентификатору: при извлечении она сохраняется как ее connectedAccountId. Если несколько учетных записей используют один адрес, например один почтовый ящик подключен двумя участниками или через двух провайдеров, используется самая старая. Если совпадений нет, синхронизация завершается сбоем и указывает handle. Это не fromHandle, который выбирает псевдоним для отправки.
    • connectedAccountId: переменная, например {{trigger.properties.after.connectedAccountId}}. Шаги электронной почты также принимают идентификатор участника рабочего пространства, например {{trigger.properties.after.assigneeId}}, который разрешается в первую учетную запись этого участника, способную отправлять сообщения.
    Задайте ровно один из двух.
  • SEND_CHAT_MESSAGE отправляет сообщение во входящие участника рабочего пространства, заданного с помощью workspaceMemberId. Идентификаторы участников также локальны для каждого рабочего пространства, поэтому приложение передаёт переменную, например {{trigger.properties.after.assigneeId}}.

После установки

  • Рабочий процесс становится активным сразу после установки приложения, а его запуски отображаются вместе с другими запусками рабочих процессов рабочего пространства.
  • Установка новой версии приложения обновляет рабочий процесс на месте.
  • Пользователи не могут редактировать установленный рабочий процесс. Чтобы настроить такой рабочий процесс, они создают его дубликат: копию можно редактировать.

Рабочие процессы пользовательского приложения рабочего пространства

Пользовательское приложение рабочего пространства является владельцем рабочих процессов, созданных в конструкторе рабочих процессов, и код имеет для них такой же авторитет, как и конструктор:
  • twenty app pull записывает каждый из них из его активной версии, последней опубликованной конструктором. Рабочий процесс, активная версия которого использует настройки, невыразимые в файле defineWorkflow(), например шаг кода, отмечается в отчёте и остаётся на месте.
  • Загруженный рабочий процесс сохраняет то, что сохранил конструктор: триггер без universalIdentifier, имя триггера из конструктора, position со значением null для узла, который конструктор никогда не размещал, и outputSchema, отличающуюся от вычисленной. Для этих полей требуются twenty-sdk 2.53.0 или новее, применённые к серверу версии 2.53.0 или новее: более старые версии отклоняют их как неизвестные ключи.
  • twenty app apply публикует так же, как конструктор. Рабочий процесс, определение которого совпадает с его активной версией, остаётся без изменений. В противном случае активная версия архивируется, а определение становится новой активной версией, поэтому прошлые запуски сохраняют версию, с которой они выполнялись.
  • Пользователи продолжают редактировать эти рабочие процессы в конструкторе, и следующая выгрузка возвращает их изменения.