パラメータ設定:BackgroundService.json
## 概要
バックグラウンドで実行される機能を設定します。
## 注意事項
- パラメータ変更時は[パラメータ変更時の確認事項](/ja/manual/parameter-edit)をご確認ください。
- [DeleteSysLogで指定したシステムログの削除が正しく行われない場合はこちらをご確認ください。](https://pleasanter.org/manual/parameter-name-change-deletesyslogs)
- パラメータDeleteTrashBoxを有効(true)にした場合、削除されたレコードの復元は行えません。誤って重要なデータを削除しないよう慎重に操作してください。
## 設定値
本パラメータファイルの設定値は下記の通りです。
| パラメータ名 | 設定例 | 説明 |
| :- | :- | :- |
| EnvironmentVariables | ["Production"] |バックグラウンドサービスを実行する環境を配列形式で設定します(複数設定可)。ここで指定した文字列が[Service.json](/ja/manual/service-json)の DeploymentEnvironment に設定されている環境でのみバックグラウンドサービスが実行されます。|
| Reminder | false | リマインダー機能の有効化/無効化をtrue/falseで指定。(リマインダー機能を有効化する際は[プリザンターのリマインダー機能を有効化する](/ja/manual/reminder)を参照のこと) |
| ~~ReminderIgnoreConsecutiveExceptionCount~~ | ~~30~~ | ~~リマインダー機能での連続した例外を無視する回数。~~ ※2|
| SyncByLdap | false | LDAP同期を自動実行する機能の有効化/無効化をtrue/falseで指定。有効化には事前に[Authentication.json](/ja/manual/authentication-json)内のLdapParameters配下のパラメータ設定が必要。 |
| SyncByLdapTime | ["02:00"] | LDAP同期を自動実行する時間。※1 |
| DeleteSysLogs | false | システムログを自動で削除する機能の有効化/無効化をtrue/falseで指定。有効化した場合は[SysLog.json](/ja/manual/sys-log-json)内のRetentionPeriodパラメータで指定された保存日数を過ぎたシステムログが削除される。 |
| DeleteSysLogsTime | ["02:00"] | システムログの削除を実行する時間。※1 |
| DeleteTemporaryFiles| false | テンポラリファイルを自動で削除する機能の有効化/無効化をtrue/falseで指定。有効化した場合はApp_Data\Temp配下およびApp_Data\Histories配下のファイルが[General.json](/ja/manual/general.json)内のDeleteTempOldThanとDeleteHistoriesOldThanそれぞれのパラメータで指定された期間を過ぎていた場合に削除される。 |
| DeleteTemporaryFilesTime| ["02:00"] | テンポラリファイルの削除を実行する時間。※1 |
| DeleteTrashBox| false | [ごみ箱](/ja/manual/table-record-restore)内のレコード、およびユーザ/グループ/組織を削除したあとデータベース内の削除済み領域に残るレコードを自動で削除する機能について、有効化/無効化をtrue/falseで指定。※)この機能を有効化した場合、削除されたレコードの復元は行えないため誤って重要なデータを削除しないよう慎重に操作すること。 |
| DeleteTrashBoxTime| ["02:00"] | [ごみ箱](/ja/manual/table-record-restore)内のレコード、および、削除済みユーザ/グループ/組織のレコードの削除を実行する時間。※1 |
| DeleteTrashBoxRetentionPeriod| 90 | [ごみ箱](/ja/manual/table-record-restore)内のレコード、および、削除済みユーザ/グループ/組織のレコードの保存期間を日数で指定する。処理開始時にレコードの更新日時が指定された保存期間より古い場合に削除される。 |
※1 処理開始時間を文字列配列で記述する。24時間表記(HH:mm)。指定した時間に毎日処理が実行される。時間を複数記述することで1日のうち複数回実行させることが可能。記述した時間は[Service.json](/ja/manual/service-json)のTimeZoneDefaultで指定したタイムゾーンとして扱われる。指定した時間に他の処理が実行中の場合はその処理終了後に実行される。同じ時分を指定した場合の処理開始順は不定。
※2 プリザンター 1.4.7.0以降のバージョンより廃止となりました。リマインダー機能で連続した例外が発生した場合でも処理を中断しなくなりました。
## 対応バージョン
|対応バージョン|内容|
|:--|:--|
|1.3.7.0 以降|ReminderIgnoreConsecutiveExceptionCountを追加<br>Reminderを追加|
|1.3.19.0 以降|SyncByLdapTimeを追加<br>SyncByLdapを追加|
|1.3.23.0 以降|DeleteSysLogsTimeを追加<br>DeleteSysLogsを追加|
|1.3.24.0 以降|DeleteTemporaryFilesTimeを追加<br>DeleteTemporaryFilesを追加|
|1.3.25.0 以降|DeleteTrashBoxRetentionPeriodを追加<br>DeleteTrashBoxを追加<br>DeleteTrashBoxTimeを追加|
|1.3.26.0 以降|EnvironmentVariablesを追加|
|1.4.7.0 以降|ReminderIgnoreConsecutiveExceptionCountを削除|