Background Jobs

  • Updated on Mar 18, 2025
  • Published on Mar 3, 2025
  • 3 minute(s) read
  • DL
  • Migration Team
 Prev Next

Overview

Every Encodify configuration has crucial tasks that need to run in the background to ensure any number of jobs gets done to keep the application running smoothly and to allow users to continue to enjoy an engaging experience, without it grinding to a halt every time it needs to do something extra. Background jobs queue provides greater visibility over the progress and completion of these processes with possibility to navigate to the result of the job execution.

Access to Background Jobs Panel

Background Jobs Panel can be accessed from Dashboard by clicking the icon in the top right corner located next to Notifications.

Background Jobs Panel has 2 tabs: User Generated and System Generated.

User Generated panel is user-specific and will display the list of background jobs and their status started by the current user.

System Generated tab displays the list of import jobs triggered by the system.

For example:

  • Import of inputs in Creative Automation Print Studio will be displayed on the User Genered tab of the Background Jobs page.

  • Scheduled csv/xml import will be displayed on the System Generated tab of the Background Jobs page.

Note!

System Generated jobs will only be displayed to a user if he is selected in the "Users to Notify" in import settings.

Currently supported background jobs:

  • Item import

  • Bulk item change (bulk create, bulk edit, bulk workflow status change)

  • Creative Automation Print Output generation (CA Print Studio import only)

  • Creative Automation Output generation (CA Studio Storyteq only)

  • Merge PDF (CA Print Studio import only)

  • Bulk download

  • Manual PDF merge

  • Video Edit

  • Module export

  • Report export

  • Run Converters

  • Generate Missing Previews

  • Clean Media Holders

Clicking Open Module for the Items Import and Bulk Item Change background job entries will redirect to the module search result filtered by the corrresponding batchID.

It is is also possible to navigate directly to the item that has been created as a result of the Merge PDF action by clicking Open Item.

Clicking Open Creative Automation Print Studio, Open Creative Automation Studio will redirect to the corresponding wizard step. Clicking Open Item will open the request item.

For the background jobs currently in progress, progress indicator will be displayed.

Timestamp for each background job entry will indicate job start time.

Download from the Background Jobs panel

Download link will be present in the Background jobs panel for the following background job types:

  • Bulk download

  • Manual PDF merge

  • Video Edit (download of trimmed video file)

  • Module export

  • Report export

Download link has expiration time of 24 hours. After this period download link will not be available and entry in background jobs will be marked as expired.

Stopping of Background Jobs

Background Jobs in progress can be stopped. "Stop process" button will be present in Background Job Queue for next types of jobs:

  • Module export

  • Report export

  • Run Converters

  • Generate Missing Previews

  • Clean Media Holders

Clicking on "Stop process" button opens corresponding modal with confirmation message.

After confirming background job stopping - status of background job is changed to "Stopped" in Background Job Queue and progress bar is hidden.Download link is not available for background jobs with status "Stopped".

Note: background jobs with status "Stopped" are not able to be restarted.

"Stop process" button

Confirmation message for processing Background Job

Filtering and deleting of Background Jobs

Jobs in Background Job Queue can be filtered by the following status’s

  • All (default)

  • Created

  • In Progress

  • Failed

  • Completed

  • Expired

  • Stopped

List of filter parameters in dropdown respectively depends on available background jobs with corresponding statuses.

Filtered list of jobs updates on the fly if job transfers from one state to another during viewing the list

List of available filter parameters

Each Background Job entry with status: "Completed", "Failed", "Expired", "Stopped" can be manually deleted.

Clicking on "Delete Job" icon opens corresponding modal with confirmation message.

After confirming background job deleting - deleted job is no more visible in Background Job Queue.

Note:

  • Background job entry is not deleted completely, but instead disassociated with the assigned user.

  • System Generated background jobs can only be deleted by System / Site Administrator users.

"Delete Job" icon

Confirmation message for Background Job entry with status "Completed"

Confirmation message for Background Job entry with status "Failed"/"Expired"

Import Background Job

The following import jobs are currently supported by the background jobs:

  • Import of inputs in Creative Automation Print Studio (User Generated)

  • XML / CSV import from Site Configuration > Module > Import (System Generated)

  • XML / CSV import by scheduler job (System Generated)

  • XML / CSV import from File System by scheduled action (System Generated)

  • XML / CSV import from FTP server by scheduled action (System Generated)

  • XML / CSV import from HTTP server by scheduled action (System Generated)

It is possible to filter the list of import jobs by the status:

Progress bar with the number of processed items will be displayed for the import jobs in progress.

It is possible to navigate to the module search result filtered by the BatchID corresponding to the imported items by clicking Open Module.

Note!

Timestamp for the import background job dispays time of the background job creation, which may differ from the actual import start.

Related articles