How to Manage Cron Jobs with TYPO3 Scheduler?

By default, the TYPO3 scheduler extension is available within your built-in TYPO3 core. Sometimes your administrator may not include the TYPO3 scheduler extension, then you can easily install and configure it below.

Composer TYPO3 Scheduler Installation

composer require typo3/cms-scheduler

Without-Composer TYPO3 Scheduler Installation

For your standard TYPO3 installation, you should have a built-in scheduler extension; just activate it ;)

Activate TYPO3 Scheduler Extension

Go to Admin Tools > Extensions > Activate “scheduler” extension.

Go to Admin Tools > Settings > Extensions Configuration > scheduler

Before we start working with the TYPO3 scheduler, let’s test-drive if everything works well with our TYPO3 scheduler service.

Go to System > Scheduler > Choose “Setup Check”. If you found anything wrong, then contact your system administrator to correct it.

As a TYPO3 administrator, you should know how-to manage TYPO3 schedulers, tasks, execution, TYPO3 cronjob, etc. Let’s have a quick look at the test-drive TYPO3 scheduler task.

Create a TYPO3 scheduler task

Step 1. Go to System > Scheduler > Choose “Information” from the dropdown.

Step 2. Click on the “+” button of the “Scheduler test task.”

Step 3. Fill-up all necessary fields like type, frequency, email, etc.

Step 4. Click on the “Save & Close” button.

Manually Execute/Run TYPO3 Scheduler Task

Step 1. Go to System > Scheduler > Scheduled Tasks

Step 2. Click on the “Run Task” play button.

Step 3. TYPO3 Scheduler should successfully run. Now let’s time check email ;)

Woohoo! We got our TYPO3 scheduler test task’s email, and It means our TYPO3 scheduler works well.

Manually Stop TYPO3 Scheduler Task

Step 1. Go to System > Scheduler > Scheduled Tasks
Step 2. Click on the “Stop Scheduler” button.

Organize TYPO3 Scheduler Tasks Group

Whenever you have many TYPO3 scheduler tasks, TYPO3 has an innovative feature to organize everything in various groups.

It’s effortless; You will just need to add and assign “Task Group” to each TYPO3 scheduler task.

Well, you got the backend management of the TYPO3 scheduler, but that does not end with the TYPO3 scheduler ;) Many people think TYPO3 will handle the recurring next cron, but that’s not true.

Basics TYPO3 Scheduler Command on CLI

You will need to configure TYPO3 Cronjob at your server to execute the recurring TYPO3 scheduler task. First of all, let’s learn the basics, how TYPO3 runs on CLI (command line interface).

// Composer based TYPO3 Setup
php vendor/bin/typo3 scheduler:run

// Without Composer Setup
php typo3/sysext/core/bin/typo3 scheduler:run

// Some server don’t directly run PHP, you should find out PHP CLI-path
which php
/usr/local/bin/php typo3/sysext/core/bin/typo3 scheduler:run

Get Help for TYPO3 Scheduler Command

// Run this command to Get help of TYPO3 scheduler
vendor/bin/typo3 scheduler:run --help

Run Single Task on TYPO3 Scheduler

// Run this command to run single task 
vendor/bin/typo3 scheduler:run --task=1

Run Multiple Task on TYPO3 Scheduler

// Run this command to run single task 
vendor/bin/typo3 scheduler:run --task=1 --task=2

Force Run Task on TYPO3 Scheduler

// Forcefully Run this command to run single task 
vendor/bin/typo3 scheduler:run --task=1 -f

Debug Task on TYPO3 Scheduler (Recommend)

// Forcefully Run this command to run single task 
vendor/bin/typo3 scheduler:run --task=1 -v

For your better optimized TYPO3 installation, I recommend configuring below the default TYPO3 scheduler, which will keep neat and clean your TYPO3 instance.

• Caching framework garbage collection (scheduler)
• Fileadmin garbage collection (scheduler)
• Table garbage collection (scheduler - sys_log)
• Table garbage collection (scheduler - sys_history)

TYPO3 uses Symfony commands API for writing CLI (command line interface) commands. These commands can also be run from the TYPO3 scheduler.

Are you looking for a step-by-step guide to create a custom TYPO3 scheduler task and command? Here we go?

Step 1. Register Symfony Console Commands

Create typo3conf/ext/yourextension/Configuration/Services.yaml

services:
 _defaults:
   autowire: true
   autoconfigure: true
   public: false


 NITSAN\NsBasetheme\:
   resource: "../Classes/*"

 Vendor\Extension\Command\TestScheduler:
   tags:
     - name: "console.command"
       command: "myext:test"
       description: "An example description for a command"
       # not required, defaults to false
       hidden: false

Step 2. Create Scheduler Command Controller Class

Create typo3conf/exte/yourextension/Classes/Command/TestScheduler.php

<?php
namespace Vendor\Extension\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
class TestScheduler extends Command
{
   /**
   * Configure the command by defining the name, options and arguments
   */
   protected function configure()
   {
       $this
           ->setDescription('Test Scheduler')
           ->setHelp('Description of the test scheduler')
           ->addArgument('id', InputArgument::OPTIONAL, 'id');
   }
   /**
    * Executes the command for showing sys_log entries
    *
    * @param InputInterface $input
    * @param OutputInterface $output
    * @return int error code
    */
   protected function execute(InputInterface $input, OutputInterface $output)
   {
       $io = new SymfonyStyle($input, $output);
       $io->writeln('Initiated and Processing...');
       $id = $input->getArgument('id');
       if(!$id) {
           $io->error('No id provided');
       }
       else {
           $io->success('Successfully run id='.$id);
       }
   }
}

Step 3. Create a TYPO3 Scheduler Task

Go to System > Scheduler > Add New Task > Choose Class = Execute console commands

Choose “myext:test TYPO3 Scheduler” at Scheduler Command.

Step 4. Let’s Have Test-Drive with CLI-Commands

// For composer-based TYPO3 instance, I suggest to dump-autoload
composer dump-autoload

// Syntax
vendor/bin/typo3 myext:test [id]

// Without passing argument
vendor/bin/typo3 myext:test

// Without passing argument
vendor/bin/typo3 myext:test id=1

User Help on our TYPO3 Scheduler Command

// Display help
vendor/bin/typo3 myext:test -h