public Background jobs log

Contents [-]

1 What is a background job?
2 Navigate to background jobs log page
3 Background jobs log filter settings

What is a background job?

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 more 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 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)

Navigate to background jobs log page

To review the details of a background job you need to:

Log in to the WordFrame Integra Core Administration
Click on the "Builder" tab in the upper left corner
Click on the "Reports & Logs" menu in the main navigation bar
Click on the "Background jobs" link in the "Operational logs" section on the left of the screen

This list represents only background jobs withing the preset archive period for this log, managed by the System logs period page from the Architect's "Global settings" section.

Background jobs log filter settings

The background jobs could be filtered by:

Job name

User friendly identifier set by the job creator.

Job ID

Unique identifier of the job within the system. It is a GUID generated by the system.

Job type

Represents the job purpose, creator or result. Is is set by the platform developers. Click on it to filter all logged jobs with this job type.

Application name

Which application requested the job execution. It is set by the administrator that created the application. Click on it to filter all logged jobs scheduled from this application.

Application pack name

From which wordframe software pack the application that requested the job was created. It is set by the pack developers. Click on it to filter all logged jobs scheduled from applications from this pack.

Job priority

The execution priority of the job. Jobs with higher priority are executed sooner by the web servers. It is set by the platform developers. Possible priorities are:

highest
higher
high
normal
low

Click on it to filter all logged jobs scheduled with this execution priority.

Server IP

The IP of the server that executed the background job. If there are more than one running applications on the same IP, a server GUID will be presented also.

Parent job ID

Sometimes (ex. account imports) the application or the user schedules a job, which sole purpose is to create a number of child jobs that actually execute specific functionality. This field presents the ID of such jobs. It is a GUID generated by the system.

Created on period

Represents the exact moment of the job's creation. Set by the system.

Created by

Represents the account that triggered the application functionality that scheduled the job. Not available, if the functionality was triggered by not authenticated user or the system itself. Click on it to filter all logged jobs scheduled by this account.

Job status

Represents the current status of the job. Possible priorities are:

pending - jobs that are still not scheduled by a webserver for execution.
running - jobs that are marked by a web server that they are been executed.
canceled - jobs that have been canceled by the user while they were "pending"
aborted - jobs that have been aborted during its execution
finished - jobs that finished their execution. The result could be a success or an error.
error or finished with error - job that have been executed but with errors. The error will be logged into the job details and could be reviewed.

Click on it to filter all logged jobs scheduled with this current status.

Execution time above

If the job is finished this represents the actual time that took for its execution. The execution time is measured as the period in which the job was running on a web server. (not as the period from its creation to its finishing moment).