案件ガイド
マーケットプレイス版では、登録 Agent を置いたワークフローの実行 1 件を案件と呼びます。案件ごとに設定と成果物をバージョンで持ち、確認工程ではそのバージョンを見て判断します。SaaS 版には無い仕組みです。
案件を始める
登録 Agent を置いたワークフローでは、プロジェクトの画面の上部のボタンが「今すぐ実行」ではなく「案件を開始」になります。押すと、案件を始めるための画面が開きます。
- 配置ごとに、設定値・連携先・指示ファイルを入れます。空欄の設定値は「標準のまま」と示された値で動きます。指示ファイルなどのファイルを入れられるのは、管理者が機能の許可で「ファイルの添付」を許している人だけです
- 必要なら「高度な設定」を開き、「Agent に渡る環境変数」と、設定値から作られる設定ファイルを確かめます。環境変数は設定値から決まり、Secret の値やコンテナの設定は含みません
- 「開始する」を押します。最初の工程の Agent が起動します
画面から入れられない必須入力が残っていると、始められません(「この画面から入力できない必須入力があります」)。必須の入力ファイルが、工程の設定の「入力ファイルの受け渡し」でつながっていないときに出ます。先行する工程の出力をつないでください。
管理者がプロジェクトを止めているときと、実行する利用者のアカウントが停止されているときも、始められません(起動ガイドの「止める・再開する」)。
案件を始められるのはプロジェクトの参加者(オーナー・運用担当・メンバー)と組織の運用の役割の人です(組織の運用の役割の人は、プロジェクトに参加していなくても案件を始められます)。同時に進められる案件は、実行中と確認待ちを合わせて 3 件までです。
外部 API と時間トリガーからも案件を始められます。外部 API の実行の開始では、「案件を開始」と同じ設定値・連携先・入力ファイルを開始のときに渡せます(config)。時間トリガーと Webhook トリガーの呼び出しでは設定値を渡せず、 契約の標準値と工程の設定だけで動きます(起動ガイド)。
案件の画面
案件の画面は、ワークフロー履歴の行の「案件の詳細」、実行記録の「案件の詳細」、確認依頼の「案件を開く」から開きます。タブは 3 つです。
| タブ | 見るもの |
|---|---|
| 進行 | 工程ごとの Agent・試行の回数・起動の状態。確認待ちのときは、その確認の状態 |
| 設定・ファイル | 案件の設定のバージョンと、成果物とファイル |
| 記録 | この案件の監査の記録。工程ごとの実行記録は、実行履歴から開きます |
起動の状態
| 表示 | 意味 |
|---|---|
| 起動待ち | 起動の順番を待っている |
| 起動中 | 実行基盤へ起動を依頼している |
| 起動済み | 実行基盤が起動を受け付けた(Agent が動き始めたとは限りません) |
| 起動失敗 | 起動できなかった。理由が添えられます。案件はそこで失敗として終わります |
| 取消済み | 案件の中断で、起動しなかった、または起動した工程に停止を伝えた |
設定のバージョン
案件の設定(配置ごとの設定値・連携先・指示ファイル)は、バージョンとして残ります。「設定のバージョン3」のように番号が付き、誰がいつ変えたかが出ます。
- 設定を変えられるのは確認待ちのときだけです。 実行中は「実行中は設定を変更できません。次の確認待ちで変更できます」と出ます。終わった案件の設定は変えられません
- 「設定を編集」で変え、「新しいバージョンとして保存」を押すと、新しいバージョンになります。保存すると、開いている確認の内容も新しいバージョンに置き換わります
- 「バージョンの履歴」で前のバージョンを見られます。編集できるのは最新のバージョンだけです。 過去のバージョンは読み取り専用で、そのときの確認は、そのバージョンに対して行われたものです
- 「Agent の標準との差分」で、契約の標準値から変えた項目だけを確かめられます
ほかの人が先に設定を保存していたときは、「他の人が設定を更新しました」と出て、最新の内容が読み込まれます。
成果物とファイル
「成果物とファイル」には、Agent の出力と、人が編集したバージョンが並びます。
- Agent の出力を開いて「編集して新しいバージョンにする」を押すと、内容を直して「バージョンを保存」できます。編集できるのは、テキストで 1 MiB までです。YAML と JSON は、保存するときに構文と、Agent の契約で決まった形に合うかを先に確かめ、合わないと保存されません。管理者が機能の許可で「ファイルの添付」を許していない人には、「編集して新しいバージョンにする」は出ません
- 保存したバージョンには「人の編集」と、編集元のバージョンが付きます
- 次の工程に渡すのは「次の工程に渡すバージョン」です。 編集元のバージョンを渡すことになっていたときは、保存した新しいバージョンに切り替わります。そうでないときは「次の工程に渡すバージョンは元のままです」と出るので、渡したいバージョンを案件の設定で選びます
- 成果物を編集できるのも、確認待ちのときだけです
成果物の大きさは、1 ファイル 20 MiB まで、1 回の実行で合計 100 MiB・100 ファイルまでです。
設定と成果物の編集はオーナーだけができます。確認担当者に指名されていても、オーナーでなければ編集できません。 メンバーは案件を見られます。
確認待ちで直してから進める
確認工程で止まった案件は、次のように直してから進められます。
- 確認依頼を開き、「確認内容のバージョン」と「次に実行する Agent」、成果物を確かめます
- 直したいところがあれば、オーナーが案件の画面で設定や成果物を新しいバージョンにします。設定は、確認の内容も新しいバージョンに置き換わります。成果物は、次の工程に渡すバージョンが編集元だったときに切り替わります
- 確認担当者が、次の工程へ進める・差し戻す・却下するを決めます
確認の決め方は確認ガイドにあります。
締め切りと確認の担当
案件の画面の見出しで、オーナー・運用担当と組織の運用の役割の人は、実行中の案件に次の操作ができます。
- 締め切り: 「締め切りを設定」で日時を決めます。締め切りは案件の画面に表示され、過ぎると「締め切り超過」と出ます。「締め切りを変更」「締め切りを解除する」で直せます
- 担当を付け替える: 確認待ちのときに、この案件の未決の確認依頼の担当を、選んだメンバーに置き換えます。新しく担当になった人へ通知します。メンバーでない人は担当にできません
案件を中断する
案件の画面の「案件を中断する」で止めます。オーナー・運用担当と組織の運用の役割の人と、その案件を始めた本人が使えます。
- まだ起動していない工程は起動されません
- 開いている確認依頼は取り消されます
- 実行中の Agent には停止を伝えます。実行中の工程の停止が記録されると「中断」になります。 それまでは「中断を要求済み」と出ます
取り違えやすいところ
- 実行中でも設定や成果物を直せると思う。 直せるのは確認待ちのときだけです。実行中は「実行中は設定を変更できません。次の確認待ちで変更できます」と出ます
- 確認担当者なら設定や成果物を直せると思う。 直せるのはオーナーだけです。確認担当者は、差し戻すか、オーナーに頼みます
- 前の工程の成果物が、自動で次の工程に渡ると思う。 渡るのは「次の工程に渡すバージョン」で、つないだファイルだけです(エージェントガイド)
- 「起動済み」なら Agent が動き始めていると思う。 実行基盤が起動を受け付けた状態で、動き始めたとは限りません
- 閉じた案件を再開できると思う。 やり直すときは、新しく案件を開始します(確認ガイド)