Skip to content

Background Tasks

Use Operations → Background Tasks in Host Administration to control recurring scheduling and maintenance for an application. You can enable or disable each task, adjust its run interval and timeout, and choose when repeated errors should temporarily pause it.

Host administrator access is required. Settings apply to the selected application and its domains across the agent farm. They are not personal preferences or settings for a single domain or node.

Choose the Right Control

What you need to change Where to change it
Whether recurring work is checked, how often it is checked, or when errors pause it Operations → Background Tasks
Priority, retries, timeout, or retention of an individual queued job type Workers
A particular queued job's state, log, or retry action Background Jobs Manager
A workflow's calendar, reminder, deadline, or scheduled start The corresponding process or case definition
How long business records or audit records are retained The corresponding retention settings

For example, increasing Run Interval for Create work item deadline jobs can delay the handling of due deadlines; it does not extend those deadlines. Changing a cleanup task's interval changes when cleanup is checked, not which records qualify for deletion.

Configure a Task

  1. Sign in to Host Administration and expand the application you want to manage.
  2. Open Operations → Background Tasks.
  3. Select Scheduled Tasks or Maintenance Tasks. Use the ? button beside a task for its description.
  4. Set Enabled, Run Interval, and Timeout Period as needed. Select Automatic Pause on Errors if repeated failures should pause future runs. Expand the row to edit the error threshold and pause settings.
  5. Select Save to apply the changes.
  6. Reopen the application settings to confirm the saved values. After the next eligible run, check the application logs and the relevant outcome, such as a due reminder, a newly searchable item, or queued replication work. Use Background Jobs for tasks that create queued jobs.

Empty numeric and duration fields use the defaults shown as placeholders. Clearing a value restores that field's default; it does not mean zero. Checkboxes explicitly enable or disable their respective options.

Changes apply to subsequent runs without restarting the agent. Saving does not force an immediate run. A task that is already running can finish. Disabling a task does not cancel jobs it has already queued; manage those jobs separately in the Background Jobs Manager if intervention is needed.

Application-wide impact

Disabling deadline, reminder, scheduling, synchronization, or replication tasks can delay the corresponding business operations for all domains in the application. Disabling cleanup allows eligible old data to accumulate. Before re-enabling a cleanup task, review its retention rules: eligible records may be deleted when cleanup resumes.

Restore Defaults

Select Restore Defaults on a task row, then Save. This resets the whole row, including Enabled and Automatic Pause on Errors, rather than only clearing the duration fields. Other task rows are unaffected.

To undo a tuning change while retaining other custom values, restore the previous value in the affected field and save. Do not use Restore Defaults when the row has other overrides you need to preserve.

Settings Reference

Setting Meaning and allowed values Default
Enabled Allows future runs of this task. Disabling it leaves already queued jobs in place. Enabled, except the three XML database tasks listed below
Run Interval Extra wait after pending work finishes, or after a failed run. Must be zero or positive. Zero adds no extra wait to the normal processing cycle. Varies by task
Timeout Period Time limit for one task run, including any automatic retry attempts within that run. Must be zero or positive; zero removes the time limit. This does not set the timeout of jobs the task queues. One hour
Automatic Pause on Errors Temporarily stops new runs when the failure threshold is reached. When cleared, the error-pause settings do not apply. Enabled
Failure Threshold (%) Percentage of failed runs within the tracking window required to pause the task. Enter 10 for 10%. Must be greater than 0 and at most 100. 50%
Minimum Runs Before Evaluation Minimum number of runs within the tracking window before the failure percentage is evaluated. Must be at least 2. 3
Error Tracking Window Period over which runs and failures are counted. Must be at least half a second. Varies by task
Pause After Errors Wait before allowing a trial run after an error pause. Must be at least half a second. Varies by task

Duration Format and Scheduling

Enter durations as hours:minutes:seconds, with an optional days. prefix:

Value Duration
00:00:00 Zero; no extra interval, or no timeout, depending on the field
00:15:00 15 minutes
03:00:00 Three hours
1.00:00:00 One day
3.00:00:00 Three days

Run Interval is a minimum additional wait, not a fixed appointment or a guarantee of execution at that frequency. The normal processing cycle, workload, and service availability also affect when a task runs. If a task still has pending work, it can continue processing that work before the extra wait begins. Zero does not disable the task or make it run continuously without regard to the normal cycle.

Automatic Pause on Errors

The failure percentage is evaluated only after Minimum Runs Before Evaluation is reached within Error Tracking Window. For example, with a 50% threshold and a minimum of three runs, two failures among three runs in the window reach the threshold; one failure among three does not. Runs outside the window do not count.

After Pause After Errors, Emakin permits a trial run. A successful trial allows normal operation to resume; another failure causes another pause. Timeout failures can contribute to an error pause. Cancellation during agent shutdown does not count as a task failure.

Saving unrelated application settings does not clear an existing error pause when the task's settings are unchanged. Restore Defaults restores configuration values; it is not a command to run the task immediately.

Choose pause durations according to the cost of delay. Deadline and reminder tasks have shorter default pauses than routine cleanup. If maintenance scripts perform time-sensitive business operations, review the default one-day pause for Maintenance Script Queue before relying on it.

Task Catalog and Defaults

The names below match the English task labels in the panel. All tasks use a one-hour timeout, a 50% failure threshold, a minimum of three runs, and automatic pause on errors by default. The tables show the remaining timing defaults. Zero in the interval column means no extra wait. Check the panel's placeholders for the defaults in your installation.

Scheduled Tasks

These tasks check for due work or synchronize application data. Enabling them does not replace the schedules, calendars, or service configuration for the corresponding feature.

Task Purpose and effect of delay Run interval Error tracking window Pause after errors
Create case deadline jobs Handles due case deadline actions; pausing delays those actions. Zero 4 hours 15 minutes
Create case reminder jobs Handles due case reminders; pausing delays reminders. Zero 4 hours 30 minutes
Create case violation jobs Handles case service-level violations; pausing delays violation processing. Zero 4 hours 15 minutes
Create channel mail sync jobs Schedules checks of connected channel mailboxes; pausing delays incoming mail synchronization. Zero 4 hours One hour
Create obsoleted domain delete jobs Starts deletion for domains past their configured expiration period, including aborting their queued jobs. 6 hours One day One day
Create domain upgrade jobs Checks for Market subscription updates; pausing delays subscription updates. This does not deploy a new server version. 6 hours One day One day
Maintenance Script Queue Schedules maintenance scripts that are due; pausing delays their execution. Zero 4 hours One day
Replicate workflow data Updates relational data defined by replication mappings; pausing can leave reporting data behind workflow changes. Zero 4 hours 15 minutes
Create scheduled jobs Handles due workflow evaluator schedules; pausing can delay scheduled evaluations or workflow starts. Zero 4 hours 15 minutes
Create work item deadline jobs Handles due work-item deadline actions; pausing delays those actions. Zero 4 hours 15 minutes
Create work item reminder jobs Handles due work-item reminders; pausing delays reminders. Zero 4 hours 30 minutes

Maintenance Tasks

These tasks maintain search, replication, usage accounting, and stored records. A task appearing here does not mean its feature has been configured; for example, file replication still requires repository replication settings.

Task Purpose and effect of delay Run interval Error tracking window Pause after errors
Abort Timeouted Jobs Marks jobs past their completion deadline as aborted. Pausing delays this handling; it does not extend worker timeouts. 10 minutes 4 hours One hour
Delete Obsolete Jobs Removes job records eligible under job cleanup rules; pausing retains them longer. 3 hours 12 hours One day
Delete expired AI conversations Removes conversations whose expiration time has passed. 6 hours One day One day
Delete expired audit logs Removes audit records older than the configured audit-log retention period. 6 hours One day One day
Create case full text jobs Updates search indexing for pending case data; pausing delays search freshness. Zero 4 hours One day
Create document full text jobs Updates search indexing for pending document data; pausing delays search freshness. Zero 4 hours One day
Create instance full text jobs Updates search indexing for pending workflow-instance data; pausing delays search freshness. Zero 4 hours One day
Create file replication jobs Schedules pending file copies between configured repositories; pausing delays replication. 3 hours 12 hours One day
Delete temporary created files Removes temporary file records eligible for cleanup. 3 hours 12 hours One day
Create form data xml replication jobs Copies pending form data to the XML database. Disabled by default. 3 hours 12 hours One day
Create instance xml database jobs Copies workflow-instance data to the XML database. Disabled by default. 3 hours 12 hours One day
Create xml registry remover jobs Removes XML database documents whose source records were deleted. Disabled by default. 6 hours One day 3 days
Full text optimization Optimizes recently used search collections. It does not replace the indexing tasks above. 3 hours 12 hours 3 days
Delete obsolete instances Deletes workflow-instance records eligible under instance retention rules. 6 hours One day One day
Delete obsoleted work items Deletes work-item records eligible under work-item retention rules. 6 hours One day One day
Terminate error stale work items Schedules termination for work items that meet the stale-error rules. 6 hours One day One day
Delete obsoleted notifications Removes notification records eligible for cleanup; this is not notification delivery. 6 hours One day 3 days
MCP usage retention cleanup Removes detailed MCP usage events past their retention period. One hour 8 hours One day
MCP usage reconciliation Reconciles pending MCP usage accounting; pausing delays accounting updates. One hour 8 hours One day
Delete expired personal assistant child details Removes expired personal-assistant detail records. 30 minutes 4 hours 3 days
Recover personal assistant interactive results Retries delivery of pending interactive results to their destination conversation. 30 minutes 4 hours 30 minutes
Schedule personal assistant scan Schedules scans for users whose next personal-assistant scan is due. 30 minutes 4 hours One day

Enable the three XML database tasks explicitly only when your installation uses XML database replication. Review both the data-copy tasks and the XML cleanup task so that copied data can be maintained when source records are deleted. Restoring defaults disables these three tasks again.

Replicate workflow data is separate: it maintains relational data through replication mappings and is enabled by default. It does not enable XML database replication.

Full-text indexing and Full text optimization are also separate. If new or updated items are missing from search, check the appropriate case, document, or instance indexing task and its queued jobs. Enabling optimization alone does not schedule missing indexing work.

Upgrade Checklist

For installations upgrading from configuration that used the following controls:

Previous control Action in Host Administration
AK_FULLTEXTMAINTENANCE Review Full text optimization under Maintenance Tasks. The environment variable no longer controls it; the task is enabled by default.
AK_DISABLE_WORKFLOW_REPLICATION Review Replicate workflow data under Scheduled Tasks. The environment variable no longer controls it; the task is enabled by default.
Agent:Workers:DrainingWorkers in node configuration Remove this obsolete setting from custom configuration. Review the three XML database task switches under Maintenance Tasks; they are disabled by default.

Record any intentional exclusions from the previous deployment and reproduce the required enabled/disabled choices in Host Administration. Review the one-hour task timeout and automatic error-pause defaults, particularly for long-running maintenance and time-sensitive scripts. Save the selected application's settings and verify the affected operations after upgrading. Do not rely on the removed controls to preserve a previous exclusion.

Troubleshooting

Symptom Checks and recovery
A task does not run after saving Confirm the application, task group, and Enabled setting. Check the interval, error pause, agent availability, and application logs. Saving is not an immediate-run command.
Reminders, deadlines, or scheduled starts are late Check the corresponding scheduled task, then inspect its queued jobs. Review the underlying schedule or calendar separately. Reducing the interval cannot repair a failing job.
Work remains in the queue after disabling a task Previously queued jobs are retained and can still run. Inspect them in Background Jobs Manager before deciding whether to abort them.
A task repeatedly pauses Find and correct the underlying error in application logs or queued-job logs. Allow the pause to expire and verify recovery. Review the threshold and window together before changing them.
A task is skipped because of invalid settings Check application logs for a configuration warning. Correct invalid durations or error-pause values, then save. Other tasks can continue while this task is skipped.
Old records remain longer than expected Check the cleanup task's enabled state, interval, pause, and logs, then verify that the records meet the relevant retention rules.
XML database data is no longer updated Check whether XML replication is required and explicitly enable the relevant XML database tasks. Relational replication and full-text indexing switches do not enable XML replication.