#トリガータイプを拡張する

すべてのワークフローには、プロセスの実行を開始するためのエントリーポイントとして、特定のトリガーを設定する必要があります。

トリガータイプは通常、特定のシステム環境イベントを表します。アプリケーションの実行ライフサイクルにおいて、購読可能なイベントを提供するあらゆる部分をトリガータイプの定義に利用できます。例えば、リクエストの受信、コレクション操作、定期的なタスクなどが挙げられます。

トリガータイプは、文字列の識別子に基づいてプラグインのトリガーテーブルに登録されます。ワークフロー****プラグインには、いくつかの組み込みトリガーがあります。

• 'collection'：コレクション操作によってトリガーされます。
• 'schedule'：定期的なタスクによってトリガーされます。
• 'action'：アクション後のイベントによってトリガーされます。

拡張するトリガータイプは、識別子が一意であることを保証する必要があります。トリガーの購読/購読解除の実装はサーバーサイドで登録し、設定インターフェースの実装はクライアントサイドで登録します。

#サーバーサイド

任意のトリガーは Trigger 基底クラスを継承し、on メソッドと off メソッドを実装する必要があります。これらはそれぞれ、特定の環境イベントを購読するためと、購読を解除するために使用されます。on メソッドでは、最終的にイベントをトリガーするために、特定のイベントコールバック関数内で this.workflow.trigger() を呼び出す必要があります。また、off メソッドでは、購読解除に関連するクリーンアップ作業を行う必要があります。

this.workflow は、Trigger 基底クラスのコンストラクターに渡されるワークフロー****プラグインのインスタンスです。

import { Trigger } from '@nocobase/plugin-workflow';

class MyTrigger extends Trigger {
  timer: NodeJS.Timeout;

  on(workflow) {
    // register event
    this.timer = setInterval(() => {
      // trigger workflow
      this.workflow.trigger(workflow, { date: new Date() });
    }, workflow.config.interval ?? 60000);
  }

  off(workflow) {
    // unregister event
    clearInterval(this.timer);
  }
}

次に、ワークフローを拡張するプラグイン内で、トリガーインスタンスをワークフローエンジンに登録します。

import WorkflowPlugin from '@nocobase/plugin-workflow';

export default class MyPlugin extends Plugin {
  load() {
    // get workflow plugin instance
    const workflowPlugin = this.app.pm.get(WorkflowPlugin) as WorkflowPlugin;

    // register trigger
    workflowPlugin.registerTrigger('interval', MyTrigger);
  }
}

サーバーが起動してロードされた後、'interval' タイプのトリガーを追加して実行できるようになります。

#クライアントサイド

クライアントサイドでは、主にトリガータイプに必要な設定項目に基づいて設定インターフェースを提供します。各トリガータイプは、対応するタイプ設定をワークフロー****プラグインに登録する必要があります。

トリガーの設定インターフェースは、Loader（遅延読み込み関数）を通じて定義されます。Loaderは、antd の Form.Item を使用してフォームを構築するプレーンな React コンポーネントを指します。

#最もシンプルなトリガー

例えば、上記のインターバルタイマートリガーの場合、設定インターフェースのフォームで必要な間隔時間の設定項目（interval）を定義します。

import { Trigger } from '@nocobase/plugin-workflow/client-v2';

class MyTrigger extends Trigger {
  title = 'Interval timer trigger';

  // Trigger config form (lazy-loaded component)
  FieldsetLoader = () => import('./IntervalConfig');

  // Config validation
  validate(config) {
    return Boolean(config?.interval);
  }
}

ここで、FieldsetLoader は Promise<{ default: ComponentType }> を返す関数であり、動的 import() によって遅延読み込みを実現します。指し示すコンポーネントは、標準的な React 関数コンポーネントです。

// IntervalConfig.tsx
import { Form, InputNumber } from 'antd';

export default function IntervalConfig() {
  return (
    <Form.Item
      name={['config', 'interval']}
      label="Interval"
      initialValue={60000}
      rules={[{ required: true }]}
    >
      <InputNumber min={1000} />
    </Form.Item>
  );
}

フォームフィールドの name にはネストされた配列形式 ['config', 'fieldName'] を使用していることに注意してください。これは antd Form の標準的な規約です。

#複数の設定インターフェース

トリガーは、さまざまなシナリオに対応するために複数の設定インターフェースを提供できます。

• PresetFieldsetLoader — ワークフロー作成時のプリセットフォーム（通常は必須フィールドのみ含む）

• FieldsetLoader — 完全なトリガー設定フォーム（設定ドロワーに表示される）

• TriggerFieldsetLoader — 手動実行時の入力フォーム

Loader がファイルの名前付きエクスポート（デフォルトエクスポートではなく）を指す必要がある場合は、.then() を使用してリマップします。

class MyTrigger extends Trigger {
  title = 'My trigger';

  PresetFieldsetLoader = () =>
    import('./MyTriggerConfig').then((m) => ({ default: m.MyPresetConfig }));
  FieldsetLoader = () => import('./MyTriggerConfig');
  TriggerFieldsetLoader = () => import('./TriggerMyConfig');

  validate(config) {
    return Boolean(config?.collection && config?.mode);
  }

  createDefaultConfig() {
    return { mode: 1 };
  }
}

// MyTriggerConfig.tsx
import { Form, Select } from 'antd';
import { CollectionCascader } from '@nocobase/plugin-workflow/client-v2';

// Preset form for creation (named export)
export function MyPresetConfig() {
  return (
    <Form.Item name={['config', 'collection']} label="Collection" rules={[{ required: true }]}>
      <CollectionCascader />
    </Form.Item>
  );
}

// Full config form (default export)
export default function MyTriggerConfig() {
  return (
    <>
      <Form.Item name={['config', 'collection']} label="Collection">
        <CollectionCascader disabled />
      </Form.Item>
      <Form.Item name={['config', 'mode']} label="Mode">
        <Select
          options={[
            { label: 'Created', value: 1 },
            { label: 'Updated', value: 2 },
          ]}
        />
      </Form.Item>
    </>
  );
}

#トリガーの登録

拡張するプラグイン内で、トリガータイプをワークフロー****プラグインインスタンスに登録します。

import { Plugin } from '@nocobase/client-v2';
import MyTrigger from './MyTrigger';

export default class extends Plugin {
  async load() {
    const workflow = this.app.pm.get('workflow');
    workflow.registerTrigger('interval', MyTrigger);
  }
}

これにより、ワークフローの設定インターフェースで新しいトリガータイプが表示されるようになります。

完全な実例については、CollectionTrigger ソースコードを参照してください。

トリガータイプの定義に関するその他の詳細については、ワークフロー API リファレンスセクションを参照してください。