メインコンテンツまでスキップ

起動ガイド

いつ、何をきっかけに動かし、どう止めるかを決めるための選択肢と基準を扱います。

起動のしかたは型で違います。 型そのものの選び方は設計ガイド、サイクルとワークフローの動きの違いはサイクルとワークフローにあります。

画面上の場所がある節では、そこで決めたことをどこで設定・確認するかを終わりに書いてあります。

型ごとに使えるもの​

ワークフローサイクル
手動で始めるできます（オーナーだけ）できません
決めた時刻に始める時間トリガーをプロジェクトに付けます。最初の有効な工程の時刻でも始まります巡回の周期を配置ごとに決めます
外部から始める外部 API で実行を始めます（登録は不要）外部 API で Webhook トリガーを呼びます（先に登録）
メールで始めるプロジェクトの宛先へのメールで実行を始めます（メールの機能が有効な環境）プロジェクトの宛先へのメールで、選んだ配置が動きます（メールの機能が有効な環境）
工程ごとの時刻使えます使えません（周期は配置ごと）

単位が違うことに注意してください。 ワークフローの時間トリガーはプロジェクトに付けますが、サイクルの周期は配置（Agent を工程に置いたもの）ごとです。ワークフローは時間トリガーが無くても構いません（オーナーが手動で始められます）。

ワークフローを始める​

ワークフローは手動が基本です。 決めた時刻に始めたいときだけ、時間トリガーを足してください。

手動で実行できるのはオーナーだけです。 メンバーは手動では実行できません（誰が何を決められるか）。メールで起動を使っていれば、メンバーもメールで始められます（メールで起動する）。

時間で始める方法は 2 つあります。 1 つは時間トリガーを追加すること、もう 1 つは最初の有効な工程に時刻を持たせることです（後の節）。有効な時間トリガーがあれば、そちらが開始を決めます。

時間トリガーを追加するときに決めるのは次の 2 つです。

  • いつ動かすか — 毎時・毎日・平日・毎週などから選べます（毎週は曜日を複数選べます）。細かく指定したいときは cron 式も使えます
  • 開始ステップ — どの工程から始めるかを選べます。指定しなければ最初の有効ステップから始まります。レーンがあるときは、分岐元より後ろの工程からは始められません

時間トリガーは複数付けられます。 平日の朝と週末の夜で別の工程から始める、といった使い方ができます。1 つずつ有効・無効にできるので、止めたいものだけ止められます。

時間トリガーを削除するときは確認が出ます。 削除すると、そのトリガーによる自動の開始は止まりますが、実行中の実行は止まりません。削除は元に戻せないので、止めるだけなら「有効」を切ります。

画面上の場所 設定 タブ ＞「トリガーと通知」＞「時間トリガーを追加」。「開始ステップ」も同じ場所で選びます

サイクルを回す​

サイクルは、配置ごとの周期で動きます。 プロジェクト全体の時間トリガーではありません。

同じ工程に置いた配置どうしでも、周期を別にできます。 「見つける」工程にメール担当とフォーム担当を置いて、片方だけ短い間隔で回すといった形が作れます。周期を変えたいから工程を分ける必要はありません。

1 つずつ止められます。 「巡回を有効にする」をオフにすれば、その配置は周期では動かなくなります（周期の設定は残ります）。ほかの配置は動き続けます。 ただし止まるのは周期による巡回だけで、同じ配置に有効な Webhook トリガーがあるか、メールで起動の配置に選んでいれば、そちらからは動きます。今後の新しい起動をすべて止めたいなら、Webhook トリガーとメールで起動も無効にしてください。すでに受け付けた分は取り消されません。

段階を分けたなら、起動時刻をずらしてください。 同じ時刻にすると、前の段階の結果がまだ無いうちに動いて空振りすることがあります。ただし時刻をずらしても、前の段階が終わっていることは保証されません（設計ガイド）。

画面上の場所 編集 ＞ 中央の図で対象の工程に置かれた Agent を選び、右の「工程のAgent」＞「起動条件」＞「巡回の周期」の「巡回を有効にする」。止めるときは同じ場所でオフにします

工程ごとの時刻（ワークフロー）​

ワークフローでは、Agent を置く工程に動く時刻を持たせられます。 確認工程は、前の工程が終わると始まります。選ぶのは 2 つです。

  • 前のステップの完了後すぐ — 既定です。前の工程が終わり次第動きます
  • 決まった時刻に — その時刻まで待ってから動きます

決めた時刻まで開始を待たせたいときに使います。 夜間にまとめて処理したい、といった場合です。動き始めたあとの時間は制限しません。

サイクルにはこの設定がありません。 サイクルで時刻を決めるのは、前の節の巡回の周期です。

最初の有効なステップの時刻は、実行の開始時刻になります（有効な時間トリガーが無いとき）。つまり、そこに時刻を置くだけでも、時間で始められます。 有効な時間トリガーがあれば、そちらが開始を決めます。

外部から動かす​

どちらの型も、外部 API から動かせます。 違うのは先に登録が要るかです。

ワークフローは、登録なしで実行を始められます。 外部 API のアクセストークンと Idempotency-Key ヘッダーを付けて実行開始を呼ぶと実行が始まり、記録には「外部API実行」として残ります。同じ Idempotency-Key で再送すると同じ実行が返り、二重に始まりません。 実行状況の取得では、実行の状態と始まり・終わりの時刻に加えて、工程ごとの状態と Agent の出力の要約も返ります（外部 API のドキュメント）。結果の届け先の決め方は設計ガイドにあります。

サイクルは、先に Webhook トリガーを登録します。 起動する配置（Agent と工程の組み合わせ）を対応付けて登録し、そのトリガーを外部 API から呼び出すと、その配置が動きます。登録するには、その Agent が先にその工程へ置かれている必要があります。

Webhook トリガーを削除するときは確認が出ます。 削除は元に戻せず、作り直すと呼び出し先が変わって、呼び出す側の設定も直すことになります。止めるだけなら「有効」を切ります。

外部 API の呼び出しそのものは、画面からはできません。 画面でできるのは、Webhook トリガーの登録・変更・削除と、呼び出し方（パス・ヘッダ・本文・例）を確かめてコピーすることまでです（ワークフローを画面から動かしたいときは、手動実行を使います）。

サイクルでは、呼び出しがまとまって 1 回の実行になることがあります。 まだ動き始めていない呼び出しがあると、あとから届いた分がそこに合わさることがあります。呼び出しの回数と実行の回数が同じとは考えないでください。 呼び出しで返る ID では、実行状況を取得できません。識別子と再送の扱いは外部 API のドキュメントにあります。

画面上の場所 サイクルは 設定 タブ ＞「トリガー」＞「Webhookトリガーを追加」＞「起動する配置」で Agent と工程を選びます。登録したトリガーの行に、呼び出し方（パス・ヘッダ・本文・例）が出ます。ワークフローは 設定 タブ ＞「トリガーと通知」の「外部APIから開始」に、呼び出し方が出ます

メールで起動する​

メールの機能が有効な環境で使えます。 プロジェクトに宛先を 1 つ用意し、そこへ届いたメールで動かします。

  • ワークフロー — メール 1 通で、最初の有効な工程から 1 回実行を始めます。件名・本文・添付ファイルがワークフローに渡ります
  • サイクル — 先に起動する配置（Agent と工程の組み合わせ）を 1 つ選びます。メール 1 通ごとに、その配置が 1 回動き、件名・本文・添付ファイルがその配置の Agent に渡ります。配置が動いている間に届いた分は、終わってから動きます。選んだ配置をあとで外すと、選び直すまでメールでは動きません

設定はオーナーだけです。 有効にすると宛先ができ、メンバーにも宛先が見えます。止めるときは無効にします（宛先は変わりません）。

送れるのは、このプロジェクトのオーナーとメンバーが、登録メールアドレスから送ったメールです。 メンバーも、メールなら実行を始められます（手動の実行はオーナーだけです）。メンバーから外すと、そのアドレスはメンバーのものとしては使えなくなります。メールは送信元の認証（DMARC・DKIM・SPF のどれか）に合格している必要があります。

ほかの人からのメールで動かしたいときは、オーナーがそのアドレスを許可します（20 件まで）。アドレス全体を 1 件ずつ登録し、ドメインやワイルドカードでは許可できません。許可したアドレスからのメールは、DMARC に合格したときだけ外部の送信者として扱われます。

件名と本文は、送った人にかかわらず、Agent への指示ではなく外部からのデータとして渡ります。 人の確認は自動では足されないので、ワークフローで要るなら確認工程を置いてください（確認ガイド）。

本文は 20,000 文字まで、添付ファイルは 10 件まで（1 件 10 MiB まで）です。 受け付けた添付ファイルは、送った人ではなく、プロジェクトを作った人の「ライブラリ」に保存されて、実行に渡ります。件名は先頭の 998 文字までが渡ります。Message-ID の無いメールと、迷惑メールやウイルスと判定されたメールは受け付けません。同じメール（同じ Message-ID）が重ねて届いても、新しく始まりません。

受け付けると、送った人に受付の返信が届きます。 これは実行がうまくいったことを示すものではありません。オーナー・メンバーへの返信にはリンクが付きます（ワークフローはその実行記録、サイクルは選んだ配置の Agent で絞った実行履歴）。外部の送信者への返信には、リンクもプロジェクト名も付きません。

メールで起動を無効にしている間、プロジェクトを一時停止している間、サイクルで選んだ配置が外れている間に届いたメールは、断られます。 返信は届かず、あとから動くこともないので、設定を戻したあとで送り直してください（同時に進められる数に達していたときは、送り直されます＝同時に進められる数）。

ワークフローの記録では、起動の列に「メールで起動」と出ます。実行記録の依頼には「送った人：」と出て、外部の送信者には「外部（[EXT]）」が付きます。サイクルでメールで動いた巡回は、起動の列に「巡回」と出て、オーナー・メンバーが送ったときの依頼は「設定した人：」と出ます。

画面上の場所 ワークフローは 設定 タブ ＞「トリガーと通知」＞「メールで起動」、サイクルは 設定 タブ ＞「トリガー」＞「メールで起動」（起動する配置も同じ場所で選びます）。外部の送信元は同じ欄の「許可するメールアドレス」

同時に進められる数（ワークフロー）​

ワークフローには、同時に進められる実行の数に上限があります。 上限と、何を数えるかは設定値リファレンスにあります。

上限に達しているときに新しく始めようとすると、次のようになります。

  • 手動 — 断られます
  • 外部 API — 断られます（応答は外部 API のドキュメント）
  • メール — その場では始まりません。メールの受け付けが時間をおいて送り直すので、その間に空きができれば始まります
  • 決めた時刻（時間トリガーと、最初の有効な工程の時刻） — その回は見送られ、あとから取り戻されません。 実行履歴にも残りません

確認が滞ると、新しい依頼が始まらなくなります。 期限と担当者の決め方は確認ガイドにあります。外部 API から始めるなら、断られた依頼を呼び出す側で持っておき、あとで送り直す仕組みが要ります。

時刻の指定とタイムゾーン​

時刻の指定には、選ぶだけで済む形が用意されています。 毎時・毎日・平日・毎週・周期（○分ごと）から選べます。cron 式を書く必要はありません。

細かく指定したいときは、カスタム (cron) を選びます。 式の書き方と、指定できる刻みの制約は設定値リファレンスにあります。

タイムゾーンは必ず選びます。 保存する前に、意図したタイムゾーンかを確かめてください。海外拠点の業務時間に合わせたいときは、ここで指定します。

ワークフローの時間トリガーには、次にいつ動くかが表示されます。 プロジェクトを止めているときと、その時間トリガーを無効にしているときは出ません。前回の時刻も出ます。これはその時間トリガーで実行を始められた時刻で、止めていたときや、同時に進められる数に達していて見送った回では進みません。

画面上の場所 時刻を決める画面はいずれも同じ形で、プリセットと「タイムゾーン」を選びます。時間トリガー＝設定 タブ ＞「トリガーと通知」／工程の時刻＝編集 ＞ 中央の図で工程を選び、右の「工程の設定」＞「起動条件」／巡回の周期＝編集 ＞ 中央の図で Agent を選び、右の「工程のAgent」＞「起動条件」＞「巡回の周期」

止める・再開する​

止め方は、何を止めたいかで違います。

  • 新しく始まる実行をすべて止める — プロジェクトを一時停止します。手動・決めた時刻・外部 API・巡回・Webhook・メールのどれでも、新しい実行は始まりません。進行中のワークフローの実行は、次の Agent を起動せずに待ちます（今動いている Agent は止まらず、確認待ちの確認依頼もそのまま残ります）。再開すれば、また始まり、待っていた実行は続きから進みます
  • 動いているワークフローの実行を止める — その実行を中断します。後の工程には進まず、確認待ちの確認依頼は取り消されます。すでに動いている Agent には停止が送られます（その結果は使われません）
  • サイクルの一部の配置だけ止める — サイクルを回す
  • 決めた時刻の開始だけ止める（ワークフロー） — 時間トリガーを無効にし、最初の有効な工程の時刻も外します（工程ごとの時刻）

画面上の場所 プロジェクトの画面の上部の「一時停止する」（再開は同じ場所の「再開する」。オーナーだけに出ます）。実行の中断は「ワークフロー履歴」タブ ＞ 動いている実行の「中断する」（オーナーだけに出ます）

取り違えやすいところ​

ここまでの節をまたいで、区別しておく点をまとめます。

  • 作れば動き始めると思う。 AI（α版）に作らせても、ほかのプロジェクトからコピーしても、時間トリガーは無効の状態で来ます。AI に作らせたサイクルで周期が提案されていれば、プロジェクトは一時停止の状態で来ます（再開すると巡回が始まります）。コピーでは開始ステップが未指定に戻り（＝最初の有効ステップから始まります）、ワークフローの工程ごとの時刻と、サイクルの巡回の周期・Webhook トリガー、メールで起動の設定は引き継がれません。有効にする前に、どこから始まるかを確かめてください
  • サイクルを手動で動かそうとする。 サイクルに手動実行はありません。配置ごとの周期、Webhook、またはメールで動きます。すぐ試したいなら、周期を短くして有効にしてください
  • プロジェクトの時間トリガーと、工程の時刻を混同する。 時間トリガーはいつ実行を始めるか、工程の時刻はその工程がいつ動くかです。サイクルには時間トリガーがありません（周期は配置ごと）
  • 外部から動かす方法が型で別物だと思う。 どちらも外部 API から動かします。 違うのは、ワークフローは登録なしで実行を始められるのに対し、サイクルは先に Webhook トリガーを登録することです。外部 API の呼び出しは画面からはできません
  • メンバーなら実行できると思う。 手動で実行できるのはオーナーだけです（メールで起動を使っていれば、メンバーもメールで始められます）
  • 決めた時刻には必ず始まると思う。 同時に進められる数に達していると、その回は見送られ、取り戻されません（ワークフロー）
  • 一時停止すれば、動いている実行も止まると思う。 止まるのは、新しく始まる実行と、進行中のワークフローの次の Agent の起動です。 今動いている Agent は止まりません。止めたいときは、その実行を中断します（動いている Agent に停止が送られます）

次に読むもの​