Background tasks

How to use background tasks in fylr

Enables users to configure and schedule server-side jobs.

Overview

Open the Background Tasks section in the header bar of your fylr instance.

background tasks manager located in the header bar of fylr
background tasks manager located in the header bar of fylr

Tasks Table

The Tasks Table lists all existing background tasks.

For each task, users can:

  • View Task Log: Inspect execution details and results

  • Edit Task: Modify configuration, schedule, or parameters


Creating a New Task

Create a new task by using the -Icon and selecting the module

Select a Module

Each module executes a type of background job. The selected module determines which parameters will be available during configuration.

Available modules:

  • delete_objects : Delete objects

  • metadata: Apply metadata mappings on search results

  • search : Execute an advanced search (send summaries via email)

  • set_unset_tags — Set or unset tags

Task Configuration

Description: A brief description of the tasks purpose (can be edited later)

Define the schedule:

  • Manual time (default: now)

  • Scheduled time (future execution, repeated schedules possible)

Email Notifications: Send an email notification when the task completes

Task Parameters

Common Parameters

  • Search Configuration: Define the target records for the task using a commong Search

  • Overwrite Values: If a record has values in fields, the task is allowed to overwrite those with the results of the module

Depending on the module used different parameters will be available.

System right "Administration > Access Task Manager" is required to use access background tasks.

The user needs appropriate permissions to the datamodel to successfully apply modules.


Monitoring and Logs

Once a task is created and executed, its progress and results can be monitored through the Task Log.

Task Log may be accessed from the tasks table or from the task editor.

The log includes:

  • information (start, finish)

  • Status (success, failed, in progress)

  • Output messages or error details

Last updated