ジョブ
フォームが開始したジョブの追跡、中止、再起動、承認、削除
フォームを起動するすべてのユーザー向け: ジョブとは何か、どこで見つけられるか、誰が見られるかを説明します。
ジョブとは
ジョブとは、フォームの 1 回の実行のことです。フォームが送信されるとすぐに、AnsibleForms はそのステータス、extravars、出力とともにジョブを記録します。
各ジョブには次の情報が保存されます。
- 実行した フォーム と、起動した ユーザー (
localやldapなどのユーザーの種類を含む) - ジョブの種類 と ステータス、 開始時刻 と 終了時刻
- 出力、実行に使われた extravars と認証情報、フォームに入力されたフィールドの値
マルチステップフォームでは、フォームに対して 1 つのジョブと、ステップごとに 1 つのジョブが作成されます。ステップはメインジョブに関連付けられ、その下に一覧表示されます。
同じジョブは REST API からも起動、追跡、管理できます。
ジョブページ
ヘッダーの ジョブ リンクをクリックすると、すべてのジョブの一覧が新しい順に開きます ( /jobs/all )。このページとリンクは、ロールで showJobs ロールオプション が設定されているユーザーに表示されます。
左側のメニューはジョブを時間で分類し、各項目にジョブの数を表示します。ステータスの項目を選ぶと、一覧がそのステータスで絞り込まれます。
| セクション | メニュー項目 | 表示内容 |
|---|---|---|
| 過去 | 成功 | ステータスが success のジョブ |
| 失敗 | ステータスが failed のジョブ | |
| 中止 | ステータスが aborted のジョブ | |
| 却下 | ステータスが rejected のジョブ | |
| 放棄 | ステータスが abandoned のジョブ | |
| 現在 | 実行中 | ステータスが running のジョブ |
| 承認待ち | ステータスが approve のジョブ。待機中のジョブがあると件数がオレンジ色になります | |
| 未来 | スケジュール済み | スケジュール ページ (ロールオプション allowScheduledJobs ) |
| 保存済み | 保存済みジョブ ページ (ロールオプション allowStoredJobs ) |
メニューにはすべてのジョブを表示する項目はありません。ヘッダーの ジョブ リンクで、 warning のジョブも含めてすべてが表示されます。
表の上のタイトル行には次のものがあります。
- 検索ボックス: 表示されている列にそのテキストを含むジョブ (大文字と小文字を区別しない)、またはステップのいずれかの ID またはターゲットがそのテキストであるジョブを残します。
- 削除 (チェックしたジョブの数付き): 最初の列でチェックしたジョブをまとめて削除します。
- 列:
id、form、job type、status、start time、end time、duration、userの列を表示または非表示にします。 実行中のジョブの所要時間はカウントアップします。 - 更新: 一覧を再読み込みします。
一覧には、 JOBS_LIST_SIZE の設定 ( 設定 > システム > 全般 の ジョブ タブ、既定は 1000 ) で指定した数だけ、新しいジョブが読み込まれます。ページ、検索、フィルターはこれらのジョブが対象です。
各列は並べ替えが可能で、それぞれにフィルター欄があります。マルチステップのジョブには form の直前に矢印があり、クリックすると ステップが展開されます。行のそれ以外の部分をクリックするとジョブが開きます。
ヘッダーのベルは、自分の承認を待っているジョブの数を示し、クリックすると 承認待ち で一覧が開きます。ランナーを表示できる ユーザーには、 承認待ちのランナー (参加を要求した RTE) の数も含まれ、 待機しているのがランナーだけの場合は 接続 > ランナー が開きます。両方が待機している場合は、 承認待ちのジョブ と 承認待ちのランナー のメニューが件数付きで開きます。
誰がどのジョブを見られるか
ユーザーが見られるジョブは、そのユーザーのロールによって決まります。
| ユーザー | 表示されるジョブ |
|---|---|
管理者 ( admin ロール) | すべてのジョブ |
ロールオプション showAllJobLogs | すべてのジョブ |
ロールオプション manageAllJobs (7.3.0 以降) | すべてのジョブ。中止、削除、再起動もできます |
| その他のユーザー | 自分のジョブと、自分のロールのいずれかを指定した承認を待っているジョブ |
7.2 までは、どのユーザーも承認待ちのジョブを extravars や出力も含めて開くことができました。7.3.0 以降は、ジョブの所有者と承認者だけが開けます。 ジョブが見えても、そのジョブに対するすべての操作が許可されるわけではありません。ほかのユーザーのジョブを中止、削除、再起動するには管理者または manageAllJobs が必要で、 showAllJobLogs はジョブを表示するだけです。削除にはさらに allowJobDeletion が、再起動には allowJobRelaunch が必要です。
このセクションの内容
各トピックはそれぞれのページで説明しています。