Queuing

(This feature can be tried with the Pleasanter Extensions Trial.)

Overview¶

This feature registers high-load processing as background jobs in a queue and runs them in order, instead of running them immediately during the request. Users can view a list of the jobs they ran themselves on the screen, but they cannot view the jobs run by other users.

Benefits of This Feature¶

Enabling this feature provides the following benefits.

1. Prevents request timeouts of high-load processing
2. Prevents user operations from being blocked while a large amount of data is processed
3. Makes the progress of high-load processing visible

Basic Behavior of Queuing¶

1. When a user performs an operation that supports queuing, it is not run immediately but registered in the queue as a job. Registration in the queue completes immediately, and the user can perform other operations.
2. Jobs registered in the queue can be checked on the job management screen.
3. A job is first registered in the queue with the "Status" of "Pending", which means it is waiting to be run. Users can cancel a "Pending" job at any time.
4. Jobs registered in the queue are taken out one at a time, starting with the job registered first, and run.
5. When a job starts running, its "Status" changes from "Pending" to "Running". A "Running" job can be neither cancelled nor deleted.
6. If Pleasanter restarts unexpectedly while a job is running, the "Running" job changes to "Failed" with the default settings. This behavior can be changed in the parameter settings.
7. Pleasanter monitors how long each job runs. When a job runs longer than the threshold (time) set in the parameters, its "Status" changes from "Running" to "Running (Overdue)". A job whose "Status" is "Running (Overdue)" can be run in parallel with the next job by clicking a button.
8. When a running job ends normally, its "Status" changes from "Running" to "Completed".
9. When a running job ends abnormally, its "Status" changes from "Running" to "Failed".
10. Jobs whose "Status" is "Cancelled", "Failed", or "Completed" can be deleted on the screen, and can also be set to be deleted automatically after a certain period.

Supported Job Types¶

Cautions¶

1. When enabling this feature, set appropriate values for the OutputFilePath and InputFilePath parameters in BackgroundJobs.json. If they are not set, processing fails and the queue feature cannot be used.

Limitations¶

1. The queue runs one job at a time (a single serial line).

Enabling Queuing¶

To enable queuing, set BackgroundQueue in BackgroundJobs.json to true.

Job Management Screen¶

When you run a job that supports queuing, the job is registered in the queue, and you can check and operate it on the job management screen. For details, see Job Management Screen.

Job Status¶

1. When you perform an operation that supports queuing, it is registered in the queue as a job, and its "Status" becomes "Pending".
2. When a job whose "Status" is "Pending" is cancelled, it changes to "Cancelled".
3. Jobs registered in the queue are run in the order in which they were registered, and their "Status" changes from "Pending" to "Running".
4. A job whose "Status" is "Running" changes to "Completed" if it ends normally, and to "Failed" if it ends abnormally.
5. If a job whose "Status" is "Running" becomes neither "Completed" nor "Failed" even after exceeding the threshold (time) set in the parameters, it changes to "Running (Overdue)".
6. "Preparing" is a "Status" used only for processing that requires a file upload, such as import. Export does not change to this "Status". If a job remains "Preparing" beyond the time set in BackgroundJobTimeout of BackgroundJobs.json (time out), it changes to "Failed". Unlike export, it does not change to an overdue status. If the application recovers from a failure while there is a "Preparing" job, the job changes to "Failed" regardless of the RecoverAction setting in BackgroundJobs.json.

Deleting Jobs¶

Completed jobs, failed jobs, and cancelled jobs remain in the queue until a user deletes them. Unnecessary jobs can be deleted with the following features.

1. On the job management screen, you can delete unnecessary jobs in bulk.
2. On the "details screen", you can delete unnecessary jobs one at a time.
3. By setting the "DeleteBackgroundJobs" parameter in BackgroundService.json to true, you can enable automatic deletion of jobs whose "Status" is "Completed", "Failed", or "Cancelled" after a certain period.
4. When a job is deleted, the "output file" saved when the job completed is also deleted.

Handling Long-Running Jobs¶

This section uses an example in which three jobs, Job A, Job B, and Job C, are registered in the queue in this order.

When Job A changes to "Running", the next job, Job B, must wait for Job A to complete. If Job A takes a long time, the subsequent Job B and Job C must wait for the preceding job to complete, even if they would finish quickly.

To address this, a threshold is set for the run time of jobs, and a job whose "Status" does not change to "Completed" or "Failed" even after exceeding the threshold can be run in parallel with the next job. The "Status" of a job that exceeds the threshold changes to "Running (Overdue)". While Job A is running, open the job management screen, select Job A, and click the "Run Next Job" button. The next pending job, Job B, runs in parallel with Job A. If Job B "Completed" before Job A, select Job A again and click the "Run Next Job" button. The next pending job, Job C, runs in parallel with Job A.

The threshold for the run time of jobs can be set with the BackgroundJobTimeout parameter in BackgroundJobs.json.

Scope of Viewing and Operating Jobs¶

The range of jobs that a user can view and operate is controlled according to the user's permissions.

Display When Jobs Are Reserved¶

1.5.9.0

With queuing, a job is run when its turn comes, not when it is registered. Therefore, if you bulk delete, bulk update, or import records in the same table while a job is waiting to be run, the operation may overlap with the processing of the reserved job. When you open a table that has jobs registered in the queue, a message notifying you that jobs are reserved is displayed at the top of the index screen and in some operation dialogs. You can check before an operation whether the table has unfinished processing.

"{Job type}" is replaced with the display name of the job type, such as "Export". When jobs of more than one job type are reserved, they are separated by commas, such as "Export, Import".

Message at the Top of the Screen¶

The message at the top of the screen is displayed in the Index, Calendar, Crosstab, Gantt chart, Burndown chart, Time series chart, Analysis chart, Kanban, and Image library of issue tables and result tables.

The message shows the job types of the reserved jobs. Clicking "Background Jobs" in the message displays the job management screen.

Dialogs¶

In the "Export", "Import", and "Bulk update" dialogs, a message is displayed at the top. Bulk update does not support queuing, but when jobs are reserved for the table, the message is also displayed in the bulk update dialog.

Confirmation Message of Bulk Delete¶

When you click "Bulk delete" on the index screen, a sentence notifying you that jobs are reserved is added to the confirmation message.

Display Conditions¶

1. The message is displayed when, at the time the screen is opened, the table being displayed has jobs whose "Status" is "Preparing", "Pending", "Running", or "Running (Overdue)". It is no longer displayed once the jobs become "Completed", "Failed", or "Cancelled".
2. Jobs run by other users are also included. However, general users cannot view other users' jobs on the job management screen (see "Scope of Viewing and Operating Jobs").
3. The target job types are "Export", "Import", and "Bulk delete". "AI Connect" jobs are not included.
4. It is not displayed on pages published with the Information Disclosure Function.

Supported Versions¶

Related Information¶

• Job Management Screen