Management

Overview

Once you’ve created background tasks, you need to manage them - trigger execution, monitor progress, view logs, and abort tasks when needed. System provides two ways to manage tasks:

1. GraphQL API - Use GraphQL queries and mutations to manage tasks from your frontend applications or external tools
2. Programmatic API - Trigger tasks directly from your backend code using the TaskService

What You Can Do

• List available task definitions - See all registered background tasks in your system
• Trigger task execution - Start a task with custom input parameters
• Monitor task runs - Check status, iterations, start/finish times, and results
• View task logs - Debug issues by reviewing detailed execution logs
• Abort running tasks - Stop tasks that are running too long or are no longer needed

Management of Tasks via GraphQL

List Available Task Definitions

Use this query to see all registered background tasks in your system. Each definition includes the task ID, title, and description you defined when creating the task.

List All Task Runs

Use this query to see all task executions. Each task run includes its status, timestamps, iterations, input/output data, and more. This helps you monitor task progress and troubleshoot issues.

List All Task Logs

Use this query to view detailed execution logs for debugging. You can filter logs by task ID to see what happened during a specific task execution. Logs include messages, timestamps, types, and error details.

Trigger a Task

Use this mutation to start a task execution with custom input parameters. The task will be queued and executed asynchronously. You can track its progress using the task ID returned in the response.

Abort a Task

Use this mutation to stop a running task. Provide the task ID and optionally a message explaining why the task is being aborted. The task will stop at the next safe checkpoint.

Managing via Code

Triggering a Task Programmatically

Use the TaskService to trigger tasks directly from your backend code. This is useful when you need to start background tasks as part of your application logic, such as after a user action or during a scheduled process. You can specify the task definition ID, custom input data, delay, parent task relationship, and a display name.

Aborting a Task Programmatically

Use the TaskService to abort a running task from your backend code. This is useful when you need to stop tasks programmatically based on application state or business logic. Provide the task ID and optionally a message explaining why the task is being aborted.