ジョブの管理画面
(本機能はExtensionsトライアルで試用可能です)
概要¶
「ジョブの管理画面」は、キューへ登録されたジョブの一覧を表示し、ジョブに対して様々な操作を実行できます。キューへ登録された各ジョブにはIDが振られ、先に登録されたジョブから順に実行されます。
前提条件¶
- BackgroundJobs.jsonのパラメータBackgroundQueueをtrueに設定し、キューイングを有効化してください。
操作手順¶
レコードの「エクスポート」など、キューイングに対応した操作を実行します。ジョブがキューイングされ、コマンドボタンエリアの上に「バックグラウンドジョブに登録しました。(ID:n)」(nはジョブのID)というメッセージが表示されます。
1. 閲覧¶
- ナビゲーションメニューの「バックグラウンドジョブ」を選択するか、メッセージ中のジョブIDをクリックしてください。
- 「ジョブ管理画面」が開き、キューへ登録されたジョブが「ジョブ登録日時」の昇順に表示されます。
- レコードの「一覧画面」と同様に、フィルタで表示を絞り込んだり、並び替えたりできます。
| 列名 | 説明 |
|---|---|
| ID | ジョブ固有の番号を表示します。 |
| ジョブ種別 | 画面操作のうちキュー管理対象となる処理の種類を表示します。 (バージョン1.5.6.0リリース時点ではインポートのみ。今後、一括削除・一括更新・サマリ同期などを追加予定) |
| 状況 | ジョブの管理画面を開いた時点のジョブの状況を表示します。 |
| サイトID | キュー管理対象の操作を行ったサイト(テーブル)のIDを表示します。 |
| サイトタイトル | キュー管理対象の操作を行ったサイトのタイトルを表示します。 |
| 登録ユーザ | ジョブを登録したユーザのユーザ名を表示します。 |
| ジョブ登録日時 | キューに登録された日時を表示します。 |
| 結果メッセージ | ジョブの状況に応じて、下記「結果メッセージ」に記載の内容を表示します。 |
| ファイル | ジョブの完了時にファイルを出力するジョブの場合、出力ファイルのダウンロードリンクを表示します。ジョブのレコードを残したまま出力ファイルを削除した場合は「ダウンロード可能なファイルなし」と表示します。 |
結果メッセージ¶
結果メッセージには、以下の情報が表示されます。
- {ジョブ種別}の部分には、たとえば「 エクスポート 」のようなジョブ種別の表示名が入ります。適宜読み替えてください。
| 結果メッセージ | 表示内容 |
|---|---|
| {ジョブ種別}をキャンセルしました。 | ジョブのキャンセル時 |
| {ジョブ種別}が完了しました。 | ジョブの実行完了時 |
| ジョブの実行中にサービスが再起動されました。自動再実行を防ぐため、失敗として記録しました。 | ジョブの実行中にプリザンターが再起動し、エラーとした場合。 |
| 既定のジョブ実行時間を超過しています。必要に応じて「次のジョブを実行」をクリックしてください。 | ジョブの実行時間がパラメータで設定した閾値を超えた場合。キューイングの「実行時間が長いジョブへの対応」を参照。 |
| バックグラウンドでのエクスポートに失敗しました。 | エクスポートエラー時 |
2. ダウンロード¶
バックグラウンドジョブが「完了」すると、エクスポートのようなジョブ種別では、指定したフォルダに出力ファイルが保存されます。保存が完了すると、「ファイル」列に出力ファイルへのリンクが生成されます。リンクをクリックすると出力ファイルをダウンロードできます。
「 状況 」が「完了」にも関わらず、ダウンロード可能なファイルを確認できないときは「ダウンロード可能なファイルなし」と表示されます。
出力ファイルの保存先は、BackgroundJobs.jsonのパラメータOutputFilePathで指定します。
3. キャンセル¶
「 状況 」が「待機」のバックグラウンドジョブをキャンセルできます。「実行中」のバックグラウンドジョブはキャンセルできません。
- 画面左のチェックボックスをクリックし、キャンセルするバックグラウンドジョブを選択してください。
- コマンドボタンエリアの「キャンセル」ボタンをクリックしてください。
- 選択したバックグラウンドジョブがキャンセルされます。
4. 削除¶
「 状況 」が「実行中」以外のバックグラウンドジョブを削除できます。たとえば「 エクスポート 」のような出力ファイルを生成するバックグラウンドジョブでは、バックグラウンドジョブの削除と同時に、出力ファイルも削除されます。
- 画面左のチェックボックスをクリックし、削除するバックグラウンドジョブを選択してください。
- コマンドボタンエリアの「一括削除」ボタンをクリックしてください。
- 選択したバックグラウンドジョブが削除されます。
なお、BackgroundService.jsonの下記パラメータを設定することで、保存期間を過ぎた古いバックグラウンドジョブを自動削除することもできます。
- DeleteBackgroundJobs
- DeleteBackgroundJobsTime
- BackgroundJobsRetentionPeriod
5. 情報の更新¶
画面表示を更新したい場合は、再読み込みしてください。
6. 詳細画面¶
各レコードをクリックすると、バックグラウンドジョブの詳細画面が開きます。
詳細画面では、以下の操作を行えます。
| No | 操作 |
|---|---|
| 1 | 出力ファイルのダウンロード |
| 2 | 表示中のジョブの削除 |
| 3 | 表示中のジョブのキャンセル |
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.5.6.0 以降 | 機能追加 |
| 1.5.7.0 以降 | 対応するジョブ種別に「インポート」を追加 |




