Managing System Tasks

To manage System Tasks, navigate to the System menu in the left navigation panel and select Tasks. This action will direct you to the Manage Tasks administrative screen, where you can view, add, edit, or delete various system-level tasks.

Understanding the Task Management Interface 💡

The Manage Tasks page presents a comprehensive data table that lists all configured system tasks. An Administrator will utilize this interface to ensure efficient background operations and scheduled processes within GimCore.

Page Header Actions:

  • Add New button: Initiates the creation of a new system task by opening a modal dialog.

Data Table Columns:

The main data table displays the following columns for each task:

  • Name: The unique identifier and descriptive name of the task.
  • Class: Specifies the underlying code class responsible for executing the task's logic.
  • Active: A boolean indicator (Yes/No) showing whether the task is currently enabled and running.
  • Last Run: The timestamp of when the task was last executed successfully.
  • Actions: Contains inline controls for managing individual tasks.

Inline Actions:

  • Edit (Pencil icon ✏️): Clicking this icon opens the Edit Task modal, allowing modification of an existing task's properties.
  • Delete (Trash icon 🗑️): Clicking this icon prompts a confirmation dialog to permanently remove the task from the system.

Adding a New Task ➕

To add a new system task:

  1. Click the Add New button located in the page header. This will open the Add Task modal dialog.
  2. In the Add Task modal, configure the following properties:
    • Name: Enter a unique and descriptive name for the new task.
    • Class: Select the appropriate system class that defines the functionality of this task. This field typically utilizes a dropdown or search selector to choose from available task classes.
    • Active: Toggle this option to Yes to enable the task immediately upon creation, or No to keep it inactive.
    • Expression: Define the scheduling frequency of the task using a Cron expression. This determines when and how often the task will run (e.g., * * * * * for every minute, 0 0 * * * for daily at midnight).
    • Description: Provide a brief explanation of the task's purpose and functionality.
  3. Click the Create button within the modal to save and activate the new task.

Editing an Existing Task 📝

To modify the properties of an existing system task:

  1. Locate the desired task in the data table.
  2. Click the Edit (Pencil icon ✏️) in the Actions column corresponding to that task. This will open the Edit Task modal dialog, pre-populated with the task's current settings.
  3. Adjust any of the following configurable fields:
    • Name: Update the task's name.
    • Class: Modify the task's class if necessary.
    • Active: Change the active status of the task.
    • Expression: Update the Cron expression to modify the task's scheduling.
    • Description: Revise the task's description.
  4. Click the Update button within the modal to apply your changes.

Deleting a Task 🗑️

To remove a system task from GimCore:

  1. Locate the task you wish to delete in the data table.
  2. Click the Delete (Trash icon 🗑️) in the Actions column corresponding to that task.
  3. A confirmation dialog will appear, asking you to confirm the deletion. Confirming this action will permanently remove the task and its configurations from the system.