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

起動ガイド

起動の考え方は SaaS 版と同じです（起動ガイド）。このページは、マーケットプレイス版で違う点をまとめます。

型ごとに使えるもの​

ワークフローサイクル
手動で始める「案件を開始」（オーナーだけ）できません
決めた時刻に始める時間トリガー。開始のときに設定値を渡せません巡回の周期を配置ごとに決めます
外部から始める外部 API（サービスアカウントのトークン）。開始のときに設定値を渡せません外部 API で Webhook トリガーを呼びます（先に登録）
メールで始めるできませんできません

ワークフローを始める​

画面から始めるときは「案件を開始」を使います。 配置ごとの設定値・接続先・指示ファイルを、その案件のために入れられます（案件ガイド）。

時間トリガーと外部 API から始めた案件には、開始のときに値を渡せません。 各 Agent の設定値は、契約の標準値に工程の設定を重ねたものになります。外部 API に本文を付けても無視されます。

必須の設定値・接続先・入力ファイルが工程の設定だけでそろっていないと、その案件は始まりません。

  • 時間トリガーでは、その回は始まらず、次の予定の時刻へ進みます
  • 外部 API では、エラーが返ります

時間トリガーや外部 API で動かすなら、必須の値はすべて工程の設定に入れておいてください（エージェントガイド）。

外部 API の呼び方はマーケットプレイス版の API リファレンスにあります。人のトークンでは呼べません。 管理画面で作ったサービスアカウントのトークンを使います。サービスアカウントは、この環境のすべてのプロジェクトを操作できます。

サイクルを回す​

巡回の周期の決め方は SaaS 版と同じです。マーケットプレイス版では、次の点が決まっています。

  • 同じ配置が実行中のあいだに来た回は見送ります。 積み上げて、あとからまとめて動かすことはしません
  • 予定から 5 分を過ぎた回は、見送りとして 1 件だけ残し、次の予定へ進みます。 環境が止まっていた間の回を、あとから全部動かすことはしません
  • 同じ配置の前の実行が終わってから 60 秒は、次の巡回を見送ります。 Webhook の呼び出しは、60 秒待ってから起動します
  • 同じ配置に起動を待っている Webhook の呼び出しがあるあいだも、巡回は見送ります

Agent が処理のあとに終了しないと、その配置の次の回がずっと見送られます。 見送りが続くときは、Agent の開発者に終了の作りを確かめてもらってください（はじめてのエージェント）。

Webhook で動かす（サイクル）​

Webhook トリガーの登録の仕方は SaaS 版と同じです。受けた呼び出しの扱いが違います。

  • 呼び出しをまとめません。 受けた呼び出しは、同じ配置に 1 件ずつ順に渡します。呼び出しの回数と実行の回数は同じです
  • 配置ごとの待ちは 20 件までです。超えると 429 queue_full が返ります
  • 受け付けてから 24 時間たっても起動できなかった呼び出しは、起動しません

Webhook トリガーを削除・無効化したり、起動する配置を付け替えたり、配置の環境変数を変えたり、プロジェクトを一時停止したりすると、まだ起動していない呼び出しも無効になります（削除の確認に「受付を待っている起動の要求も無効になります。」と出ます）。一時停止中に呼ぶと 409 で断られます。

うまくいかなかったとき​

SaaS 版の「結果の扱い」（ルールにより実行できない場合・Agent の報告による失敗のとき）はありません。 登録 Agent の工程は、終わり方ごとに次の決まった扱いで動きます（ワークフロー）。

終わり方扱い
完了・対象なしの省略次の工程へ進む
未完遂・停止自動ではやり直さず、確認依頼を作る（同じ工程への差し戻しを選べる）
ルールにより実行不可・そのほかの省略確認依頼を作る
失敗・時間切れ（何が起きたかが分かっていて、外部への効果が「読み取りのみ」か「書き込み (再送しても同じ結果)」）自動でやり直します。 やり直しの回数を使い切ると、案件は失敗で閉じます
失敗・時間切れ（外部への効果が「書き込み (再送で重複しうる)」）二重に書き込まないように、自動ではやり直さず、確認依頼を作る
何が起きたか分からない終わり方外部への効果の種類にかかわらず、自動ではやり直さず、確認依頼を作る

  • 自動でやり直すのは、プロジェクトの「工程ごとの再試行回数」と 2 回の、少ないほうの回数までです

  • 「何が起きたか分からない終わり方」には、Agent のプロセスが異常に終わった、Pod が消えた、結果を受け取りきれなかった、契約の実行上限で打ち切られた（既定 900 秒）ときが入ります。実行上限による時間切れは、自動ではやり直しません

  • 起動の前に実行ルールを読めなかったとき（存在しない連携先を指す禁止操作があるときなど）は、少しおいて照合し直し、回数を使い切ると確認依頼を作ります

止める・再開する​

SaaS 版と同じく、プロジェクトの一時停止で、新しく始まる実行をすべて止められます。マーケットプレイス版では、次の止め方が加わります。

止めたいもの止め方
動いている案件（ワークフロー）案件の画面の「案件を中断する」（オーナーだけ）。案件ガイド
動いているサイクルの 1 回の実行その実行の実行記録の「停止する」（オーナーだけ）

取り違えやすいところ​

  • 時間トリガーや外部 API でも、案件の設定を入れられると思う。 入れられるのは「案件を開始」からだけです。ほかの始め方では、工程の設定の値で動きます
  • 時間トリガーの時刻には必ず始まると思う。 必須の値が足りない、同時に進められる数（3 件）に達している、などのときは、その回は始まらず、取り戻されません
  • サイクルの Webhook はまとめて 1 回になると思う。 マーケットプレイス版では、1 件ずつ順に動きます
  • 期限で確認が進むと思う。 進みません（確認ガイド）
  • メールで起動できると思う。 マーケットプレイス版にはありません

次に読むもの​