The "Background Jobs" screen shows the status of background processes.
A background job is a program that runs centrally, without a logged-on user. Background jobs serve repetitive or time-consuming processes. A background job automatically gets lower priority when several users are active at the same time. The turnaround time can therefore change.
See also [[Invantive Estate/Subjects/Advanced/Submit Background Job|Submit Background Job]], [[Invantive Estate/Subjects/Advanced/Background Scripts|Background Scripts]] and [[Invantive Estate/Subjects/Advanced/Background Schedulers|Background Schedulers]].
The fields are:
- "Number": The unique number of the background job.
- "Script": The background script that the job executes.
- "Requested Start Time": The earliest point in time at which the user wants the background job to run.
- "Requester": The name of the user who requested the job.
- "Start": The actual start time of the job. This time is never earlier than the requested start time. It can be much later, depending on the number of requested background jobs.
- "End": The time at which the background job ended.
- "Status": The current status of the job. The possible statuses follow after this list.
- "End Status": The result of the job. The possible end statuses follow after this list. The log file contains the errors.
- "Exit Code": The final numerical value of the job.
- "Parent Job": The number of the job that requested this job, if any.
- "Scheduler": The background scheduler that will execute, has executed or is executing the job.
- "Last Error Message": The last error message, if the process ended with one or more errors.
- "Database Session": The unique database session number of the background job.
- "# Days to Keep": The number of days that the output file and the log file are kept.
- "# Versions to Keep": The number of versions that are kept.
- "Rerun on Error": When checked, the process runs again if it ended with one or more errors.
- "Rerun on Success": When checked, the process runs again if it ended successfully.
- "Rerun on Warning": When checked, the process runs again if it ended with a warning.
- "Rerun Every (sec)": The number of seconds before the process restarts after a restart event.
- "Documents": The documents linked to the background process.
- "#Documents": The number of documents linked to the background process.
- "Size": The size of the documents linked to the background process.
- "Output File": The name of the output file.
- "Log File": The name of the log file.
The following statuses can occur in the field "Status":
- Planned: the job is registered and will start as soon as possible after the requested start time.
- Locked: the job is locked and can in this way be assigned to a scheduler.
- Active: the job is currently being executed. The time at which the job started is shown in the field "Start".
- Wait: the job has started another job and waits until that job is completed.
- Completed: the job is completed. The time at which the job completed is recorded in the field "End".
- Canceled: the job was requested, but the request was cancelled before the job started.
- Terminated: the job was terminated by a sudden stop of the system, for instance because the server was rebooted while the job was still being executed.
The following end statuses can occur in the field "End Status":
- Unfinished: the job is not completed yet and thus has no end status.
- Successful: the job has been completed.
- Error: the job is terminated with one or more errors.
- Warning: the job has completed, but one or more warnings have been generated.