public Background jobs queue

What is a background job?

In most cases many of the jobs in WordFrame Integra are executed on the background. Generally they are one of the following types:

• time and CPU consuming jobs
• jobs that need to be asynchronously executed from the user interface
• jobs that need a specific functional part of the system to be locked until they are executed.

All of these types of jobs are scheduled by the system to be executed as a background process. There is one other reason - if the system works with many front-end web servers in a cluster, these servers need to be utilized properly and the jobs need to be properly distributed among them for execution.

When a user is trying to access a screen that is locked until specific jobs are running, it will look like the one presented in the thumbnail:

How many jobs are in the queue

The count of all jobs that need to be finished for this functionality to be unlocked

Specific details of the next 5 jobs to be executed

Only 5 jobs are being presented as the screen could be locked by a very large number of jobs (ex. an import of 10.000 accounts)

Scheduled background jobs queue

To browse the currently scheduled background jobs for execution, you need to:

1. Log in to the WordFrame Integra Core Administration
2. Click on the "Architect" tab in the upper left corner
3. Click on the "Core monitoring" menu in the main navigation bar
4. Click on the "Jobs queue" link in the "Background jobs" section on the left of the screen

This screen is used by the administrators to review if they are stalled or aborted jobs in the system for some reason. Normally only newly scheduled jobs should be with "Pending" or "Running" status. If a job is in these statuses for too long, this indicates two possible errors:

• the functionality executed by the job has an error that prevents it from successfully finishing, in this case you need to try to abort the job and file an issue in the support system
• a front end server hasn't scheduled the job for execution or it scheduled itself, but its execution is taking too long - in this case you either need to check out whether this is a normal execution time for this job, or the restart the wordframe application pool on this server. This will automatically ABORT all scheduled jobs by this server.

Cancel or abort a background job

Using the corresponding "request abort" functionality you can cancel or abort a job. When the job is not yet started, clicking on this link, will cancel its execution. If the job is already running, it could be aborted only, if the abort event is supported by the job itself. For jobs that do not support that event, the only way to abort their execution is to kill the web server executing it. When this happens, the other servers or the server itself on restart, will delete this job from the queue and mark it as aborted. Whether the already performed changes of the database will be rolled back or not, depends entirely on the specifics of the job itself (if it is a transactional sql process or not).

View a background job details

By clicking on the "view link you will be redirected to the Builder's "Reports & Logs" section where all the details for each job is stored. To read more about this topic, please visit the View background job details tutorial page

View the complete background jobs log

A complete background jobs log is located in the "Reports & Logs" section of the Builder's shell. The duration of the log is according to the preset in the "Global settings" section. There is a dedicated shortcut to the log page in the upper right corner of the "Jobs queue" screen. You can read more about the topic in the Background jobs log tutorial page