BackgroundJobs.json
(This function can be tried with the "Pleasanter Extensions Trial".)
Cautions¶
- When changing parameters, please refer to "Confirmation When Changing Parameters".
- When editing this file, refer to "Queuing" as well.
- To use WorkerCount, you need a contract for the Multi-Tenant option in addition to a contract for the Unlimited plan of the Annual Support Service.
Setting Values¶
The setting values of this parameter file are as follows.
| Parameter name | e.g. | Description |
|---|---|---|
| BackgroundQueue | true | Specify with true/false whether to enable the queue method. The default value is false. |
| BackgroundJobDispatcherInterval | 60 | The time interval (in seconds) for checking the queue to retrieve a job. The default value is 60. |
| BackgroundJobTimeout | 3600 | The threshold for displaying a warning message on the "Queue Management" screen that a job has been running for a long time. The default value is 3600. Specifying 0 disables it. |
| BulkQueueThreshold | 300 | The threshold for the number of records at which a bulk delete is registered in the queue. In an environment where the queue feature is enabled, when a bulk delete is run from the index screen of a time-limited table or record table, it is registered in the queue as a background job if the number of target records is BulkQueueThreshold or more. If the number of target records is less than BulkQueueThreshold, the processing is run immediately. The default value is 0 (registered in the queue regardless of the number of records). |
| FallbackLanguage | "ja" | The language for displaying result messages. If it is not set, the value of DefaultLanguage in "Service.json" is used. |
| RecoverAction | "Failed" | Defines how jobs that were "Running" are handled when recovering from a failure. "Failed" (default) Sets jobs that were "Running" to "Error". "Pending" Returns jobs that were "Running" to "Waiting" and re-registers them at the end of the queue. |
| OutputFilePath | ・For Windows C:\\Output ・For Linux /var/opt/pleasanter/output | Sets the destination for files related to jobs, such as export output files. The path must be set appropriately for the environment. Escape the path separator \ of a Windows environment as \\. In addition, access permission for the target folder must be granted to IIS_IUSRS. |
| InputFilePath | ・For Windows C:\Input ・For Linux /var/opt/pleasanter/input | Sets the destination for files related to jobs, such as import input files. The target file is deleted when the import is complete. The path must be set appropriately for the environment. Escape the path separator \ of a Windows environment as \\. In addition, access permission for the target folder must be granted to IIS_IUSRS. Do not set a directory where static file delivery is enabled, such as under wwwroot. |
| WorkerCount | 3 | To use this parameter, you need a contract for the Unlimited plan of the Annual Support Service. Specify the number of workers when multi-tenant is enabled as a natural number. The default value is null. For details of this parameter, see "Multi-Tenant Management Function: Queuing". |
| DisabledJobTypes | [ "Export" ] | Specify, as an array, the job types that do not use the queue method. The default value is null (the queue method is used for all job types). The specified job types are not registered in the queue even if BackgroundQueue is true, and are run synchronously as before. [Values that can be specified] "Export": Export "Import": Import "BulkDelete": Bulk delete "AiConnect": AI Connect Values are case-sensitive. If a value other than the above is specified, no error occurs and no job type is disabled. It is not applied to jobs already registered in the queue. |
Supported Versions¶
| Supported versions | Body |
|---|---|
| 1.5.6.0 and later | Added BackgroundJobs.json |
| 1.5.7.0 and later | Added InputFilePath |
| 1.5.8.0 and later | Added WorkerCount |
| 1.5.9.0 and later | Added BulkQueueThreshold and DisabledJobTypes |