BackgroundService.json
概要¶
バックグラウンドで実行される機能を設定します。
注意事項¶
- パラメータ変更時はパラメータ変更時の確認事項を確認してください。
DeleteSysLogで指定したシステムログの削除が正しく行われない場合は、こちらを確認してください。DeleteTrashBoxを有効化（trueに設定）した場合、削除されたレコードの復元は行えません。誤って重要なデータを削除しないよう、慎重に操作してください。- 💎が添えられたパラメータは、年間サポートサービスの特定プラン契約者のみ利用可能です。詳細はこちらを参照してください。
設定値¶
本パラメータファイルの設定値は下記の通りです。
| パラメータ名 | 設定例 | 説明 |
|---|---|---|
| EnvironmentVariables | ["Production"] | バックグラウンドサービスを実行する環境を配列形式で設定（複数設定可）。ここで指定した文字列がService.jsonの DeploymentEnvironment に設定されている環境でのみバックグラウンドサービスが実行される。 |
| Reminder | false | リマインダー機能の有効化/無効化をtrue/falseで指定。（リマインダー機能を有効化する際は「プリザンターのリマインダー機能を有効化する」を参照のこと） |
| ReminderCheckIntervalSeconds | 60 | リマインダーの起動間隔（単位：秒）を30〜3600の数値で設定。 既定値：60 ※3 |
| SyncByLdap | false | LDAP同期を自動実行する機能の有効化/無効化をtrue/falseで指定。有効化には事前にAuthentication.json内のLdapParameters配下のパラメータ設定が必要。 |
| SyncByLdapTime | ["01:00"] | LDAP同期を自動実行する時間。※1 |
| DeleteSysLogs | false | システムログを自動で削除する機能の有効化/無効化をtrue/falseで指定。有効化した場合はSysLog.json内のRetentionPeriodパラメータで指定された保存日数を過ぎたシステムログが削除される。 |
| DeleteSysLogsChunkSize | 5000 | 分割削除する場合に一回で削除されるレコード数を指定。分割せずに削除する場合は0を設定。 |
| DeleteSysLogsTime | ["02:00"] | システムログの削除を実行する時間。※1 |
| DeleteTemporaryFiles | false | テンポラリファイルを自動で削除する機能の有効化/無効化をtrue/falseで指定。有効化した場合はApp_Data\Temp配下およびApp_Data\Histories配下のファイルがGeneral.json内のDeleteTempOldThanとDeleteHistoriesOldThanそれぞれのパラメータで指定された期間を過ぎていた場合に削除される。 |
| DeleteTemporaryFilesTime | ["02:30"] | テンポラリファイルの削除を実行する時間。※1 |
| DeleteTrashBox | false | ごみ箱内のレコード、およびユーザ/グループ/組織を削除したあとデータベース内の削除済み領域に残るレコードを自動で削除する機能について、有効化/無効化をtrue/falseで指定。※)この機能を有効化した場合、削除されたレコードの復元は行えないため誤って重要なデータを削除しないよう慎重に操作すること。 |
| DeleteTrashBoxTime | ["03:00"] | ごみ箱内のレコード、および、削除済みユーザ/グループ/組織のレコードの削除を実行する時間。※1 |
| DeleteTrashBoxRetentionPeriod | 90 | ごみ箱内のレコード、および、削除済みユーザ/グループ/組織のレコードの保存期間を日数で指定する。処理開始時にレコードの更新日時が指定された保存期間より古い場合に削除される。 |
| DeleteUnusedRecord | false | ごみ箱内の削除されたレコードに関連する「未使用の権限」や「リンク情報」を自動的に削除する機能の有効化/無効化をtrue/falseで指定。 パラメータDeleteTrashBoxがfalseの場合は、何も削除されないことがある。本機能による削除は復元を行えない。慎重に設定すること。 |
| DeleteUnusedRecordTime | ["03:00"] | 未使用の権限やリンク情報の削除を実行する時間。 |
| DeleteUnusedRecordChunkSize | 1000 | 未使用の権限やリンク情報を一度に削除する件数。大きな数値を設定すると処理は早く終わるが、サーバに負荷がかかる可能性がある。 未設定時または0を設定した場合は、既定値1000が使用される。 |
| DeleteMcpLogs | false | MCPログを自動で削除する機能の有効化/無効化をtrue/falseで指定。 |
| DeleteMcpLogsTime | ["02:00"] | MCPログの削除を実行する時間。※1 |
| McpLogsRetentionPeriod | 90 | MCPログの保存期間を日数で指定する。処理開始時に指定された保存期間より更新日時が古い場合に削除される。 |
| DeleteMcpLogsChunkSize | 5000 | MCPログを分割削除する場合に一回で削除されるレコード数を指定。分割せずに削除する場合は0を設定。 |
| DeleteBackgroundJobs💎 | true | 「 状況 」が「完了」「エラー」「キャンセル」となったバックグラウンドジョブを、一定期間後に自動削除する機能を有効にするか否かをtrue/falseで指定。既定値はfalse。 |
| DeleteBackgroundJobsTime💎 | ["04:00"] | 自動削除の実行時刻リスト。既存のDeleteSysLogsTimeなどと同じ時刻リスト形式（※1）。既定値は ["04:00"]。 |
| BackgroundJobsRetentionPeriod💎 | 7 | ジョブの保持期間（日数）。「実行中」から「完了」「エラー」「キャンセル」への遷移日時からこの日数経過したジョブを削除する。負の数値を設定した場合は削除を無効化する。既定値は7。 |
| WarmupTimeoutSeconds | 180 | ウォームアップ処理全体の完了を待つ待機時間の上限値を秒単位で指定する。複数インスタンス起動時は、他のサーバの起動処理完了を待つ待機時間の上限値としても使用される。この時間はウォームアップ処理全体の完了を待つ待機時間には算入されない。待機時間を超えた場合、ウォームアップは失敗として扱われアプリケーションは終了する（再起動の要否は実行環境の設定に従う）。0以下を設定した場合は無制限に待つ。0を設定する場合は、ウォームアップ処理が停止した際に検知できなくなる可能性があるため、注意すること。 |
| WarmupFailureShutdownDelaySeconds | 60 | ウォームアップ処理が失敗またはタイムアウトした場合に、アプリケーションを終了する前に待機する時間を秒単位で指定する。短い間隔での再起動が繰り返されることを緩和する目的で使用する。本パラメータに0以下の値を設定しないこと。0以下の値を設定した場合、ウォームアップ処理が停止した際に検知できなくなるおそれがある。 |
| DeleteTenant💎 | false | 削除申請されたテナントのレコードを自動で削除する機能の有効化/無効化をtrue/falseで指定。 |
| DeleteTenantTime💎 | ["04:00"] | 自動削除の実行時刻リスト。既存のDeleteSysLogsTimeなどと同じ時刻リスト形式（※1）。既定値は ["04:00"]。 |
| DeleteTenantRetentionPeriod💎 | 30 | テナントの保存期間を日数で指定する。指定された保存期間よりAPIによる削除申請日時が古い場合に削除される。 |
| DeleteTenantChunkSize💎 | 1000 | テナントに含まれるレコードを分割削除する場合に一回で削除されるレコード数を指定。 |
| DeleteTenantBinariesChunkSize💎 | 10 | Binariesテーブルの分割削除時に、一回で削除されるレコード数を指定。分割せずに削除する場合は0を設定。 |
※1 処理開始時間を文字列配列で記述する。24時間表記(HH:mm)。指定した時間に毎日処理が実行される。時間を複数記述することで１日のうち複数回実行させることが可能。記述した時間はService.jsonのTimeZoneDefaultで指定したタイムゾーンとして扱われる。指定した時間に他の処理が実行中の場合はその処理終了後に実行される。同じ時分を指定した場合の処理開始順は不定。
※2 プリザンター 1.4.7.0以降のバージョンより廃止。リマインダー機能で連続した例外が発生した場合でも処理を中断しない。
※3 リマインダーの設定件数やユーザ数、組織・グループ数が多く、DB負荷が定常的に高い場合は、既定値よりも大きな値を設定すること。範囲外の値を指定した場合は、自動的に最も近い有効値に変更して動作します。
| 指定値 | 実際の動作 |
|---|---|
| 10 (下限未満) | 30として動作 |
| 7200 (上限超過) | 3600として動作 |
このとき、システムログに警告メッセージが記録されます。
"ReminderCheckIntervalSeconds is out of range. Configured: 7200, Used: 3600 (valid range: 30-3600)."
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.3.7.0 以降 | ReminderIgnoreConsecutiveExceptionCountを追加 Reminderを追加 |
| 1.3.19.0 以降 | SyncByLdapTimeを追加 SyncByLdapを追加 |
| 1.3.23.0 以降 | DeleteSysLogsTimeを追加 DeleteSysLogsを追加 |
| 1.3.24.0 以降 | DeleteTemporaryFilesTimeを追加 DeleteTemporaryFilesを追加 |
| 1.3.25.0 以降 | DeleteTrashBoxRetentionPeriodを追加 DeleteTrashBoxを追加 DeleteTrashBoxTimeを追加 |
| 1.3.26.0 以降 | EnvironmentVariablesを追加 |
| 1.4.7.0 以降 | ReminderIgnoreConsecutiveExceptionCountを削除 |
| 1.4.16.0 以降 | DeleteSysLogsChunkSizeを追加 |
| 1.5.0.0以降 | DeleteUnusedRecordを追加 DeleteUnusedRecordTimeを追加 DeleteUnusedRecordChunkSizeを追加 |
| 1.5.2.0以降 | DeleteMcpLogs を追加 DeleteMcpLogsTime を追加 McpLogsRetentionPeriodを追加 DeleteMcpLogsChunkSize を追加 |
| 1.5.5.0 以降 | ReminderCheckIntervalSecondsを追加 |
| 1.5.6.0 以降 | DeleteBackgroundJobsを追加 DeleteBackgroundJobsTimeを追加 BackgroundJobsRetentionPeriodを追加 |
| 1.5.7.0 以降 | WarmupTimeoutSecondsを追加 WarmupFailureShutdownDelaySecondsを追加 DeleteTenantを追加 DeleteTenantTimeを追加 DeleteTenantRetentionPeriodを追加 DeleteTenantChunkSizeを追加 DeleteTenantBinariesChunkSizeを追加 |
| 1.5.8.0 以降 | DeleteTenantの既定値を変更 |