Job Management Screen

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

Overview¶

The "Job Management Screen" displays a list of the jobs registered in the queue and lets you perform various operations on them. Each job registered in the queue is given an ID, and jobs are run in order, starting with the job registered first.

Prerequisites¶

1. Set the BackgroundQueue parameter in BackgroundJobs.json to true to enable queuing.

Operation Procedure¶

Perform an operation that supports queuing, such as "Export" of records. The job is queued, and the message "Background Jobs has been registered. (ID:n)" (where n is the job ID) is displayed above the command button area.

1. Viewing¶

1. Select "Background Jobs" in the navigation menu, or click the job ID in the message.
2. The job management screen opens, and the jobs registered in the queue are displayed in ascending order of "Job Enqueued Time".
3. As on the record "Index" screen, you can narrow down the display with filters and sort it.

Result Messages¶

The following information is displayed in the result message.

1. "{Job type}" is replaced with the display name of the job type, such as "Export".

2. Downloading¶

When a background job "Completed", for job types such as export, the output file is saved in the specified folder. When saving is complete, a link to the output file is generated in the "File" column. Click the link to download the output file.

If no downloadable file can be found even though the "Status" is "Completed", "No downloadable file" is displayed.

The folder where output files are saved is specified with the OutputFilePath parameter in BackgroundJobs.json.

3. Cancelling¶

You can cancel background jobs whose "Status" is "Pending". "Running" background jobs cannot be cancelled.

1. Click the check box on the left of the screen to select the background jobs to cancel.
2. Click the "Cancel" button in the command button area.
3. The selected background jobs are cancelled.

4. Deleting¶

You can delete background jobs whose "Status" is anything other than "Running". For background jobs that generate an output file, such as "Export", the output file is deleted at the same time as the background job.

1. Click the check box on the left of the screen to select the background jobs to delete.
2. Click the "Bulk delete" button in the command button area.
3. The selected background jobs are deleted.

You can also delete old background jobs that have passed the retention period automatically by setting the following parameters in BackgroundService.json.

1. DeleteBackgroundJobs
2. DeleteBackgroundJobsTime
3. BackgroundJobsRetentionPeriod

5. Updating the Information¶

To update the display, reload the screen.

6. Details Screen¶

Click a record to open the details screen of the background job.

The following operations can be performed on the details screen.

Supported Versions¶

Related Information¶

• Queuing