Рабочие процессы

​

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

import {
  defineWorkflow,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';

const COMPANY = STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier;
const SCORE_COMPANY_FUNCTION = '0f6c0b3e-8a4f-4f0e-9d0a-3c1e5b7a2d41';

const SCORE_NEW_COMPANIES = {
  workflow: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e81',
  trigger: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e82',
  score: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e83',
  save: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e84',
};

export default defineWorkflow({
  universalIdentifier: SCORE_NEW_COMPANIES.workflow,
  name: 'Score new companies',
  version: {
    trigger: {
      universalIdentifier: SCORE_NEW_COMPANIES.trigger,
      type: 'DATABASE_EVENT',
      settings: {
        objectUniversalIdentifier: COMPANY,
        action: 'created',
      },
      nextStepIds: [SCORE_NEW_COMPANIES.score],
    },
    steps: [
      {
        universalIdentifier: SCORE_NEW_COMPANIES.score,
        name: 'Score the company',
        type: 'LOGIC_FUNCTION',
        logicFunctionUniversalIdentifier: SCORE_COMPANY_FUNCTION,
        input: { companyName: '{{trigger.properties.after.name}}' },
        nextStepIds: [SCORE_NEW_COMPANIES.save],
      },
      {
        universalIdentifier: SCORE_NEW_COMPANIES.save,
        name: 'Save the score',
        type: 'UPDATE_RECORD',
        input: {
          objectUniversalIdentifier: COMPANY,
          objectRecordId: '{{trigger.recordId}}',
          objectRecord: { leadScore: `{{${SCORE_NEW_COMPANIES.score}.score}}` },
          fieldsToUpdate: ['leadScore'],
        },
        nextStepIds: [],
      },
    ],
  },
});

• Рабочий процесс, его триггер и каждый шаг должны иметь собственный universalIdentifier. Сохраняйте их неизменными между релизами: по ним Twenty сопоставляет установленный рабочий процесс при следующей установке.
• nextStepIds связывает граф. Триггер указывает на первые шаги, а каждый шаг указывает на шаги, выполняемые после него.
• Шаг считывает предыдущий вывод с помощью {{trigger.\<path>}} или {{\<step universalIdentifier>.\<path>}}.
• Сборка проверяет всё определение: неподдерживаемые типы триггеров или шагов, повреждённые связи между шагами и ссылки на неизвестные шаги приводят к её сбою.

​

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

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

​

Триггеры

​

Шаги

• Шаги записи используют objectUniversalIdentifier вместо имени объекта.
• Фильтры и сортировки ссылаются на поля с помощью fieldMetadataUniversalIdentifier.
• Поля формы типа RECORD именуют свой объект с помощью settings.objectUniversalIdentifier. Поля типа SELECT и MULTI_SELECT предлагают варианты существующего поля того же типа, именуемого с помощью settings.selectedFieldUniversalIdentifier.
• Чтобы выполнить собственный код, используйте шаг LOGIC_FUNCTION. Шаг Code в конструкторе недоступен.
• Шаги электронной почты и календаря выполняются, только если роль вашего приложения имеет соответствующий флаг разрешения: SystemPermissionFlag.SEND_EMAIL_TOOL для SEND_EMAIL и DRAFT_EMAIL, SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL для CREATE_CALENDAR_EVENT. Рабочая область предоставляет его при установке приложения, после чего шаг может использовать любую подключенную учетную запись в рабочей области, как рабочий процесс, созданный в приложении.
• Идентификаторы подключенных учетных записей локальны для каждой рабочей области, поэтому не задавайте такой идентификатор жестко в коде. Передайте учетную запись в качестве переменной. Шаги электронной почты также принимают идентификатор участника рабочего пространства, например {{trigger.properties.after.assigneeId}}, который разрешается в первую учетную запись этого участника, способную отправлять сообщения.

​

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

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