zum Inhalt springen

Automation mit dem Scheduler

TYPO3 bietet Ihnen mit dem Scheduler (in der deutschen Übersetzung “Planer”) eine System-Extension an, die bestimmte Aufgaben automatisch und regelmäßig durchführen kann (so genannte Cronjobs).

Aktivierung

In allen TYPO3 Installationen finden Sie den Scheduler bereits als System-Extension vor. Jedoch müssen Sie ihn unter Umständen noch aktivieren um ihn nutzen zu können. Loggen Sie sich im Backend mit Ihrer Administrationskennung ein und prüfen Sie im Extension Manager, ob der Scheduler (Extension Key: "scheduler") bereits aktiviert wurde.

vergrößern:
Die scheduler-Extension ist bereits installiert. Wenn Sie nicht ausgegraut ist, ist sie wie auf diesem Screenshot bereits aktiviert.

Den Scheduler-User anlegen

Damit der Scheduler ausgeführt werden kann, braucht er einen eigenen User-Account.

Rufen Sie unter System den Scheduler auf. Wählen Sie im Dropdown-Menü den Punkt “Setup check”. TYPO3 prüft nun, ob der nötige User _cli_scheduler bereits existiert. (Die Unterstriche sind Bestandteil des Namens.) Sofern dieser User noch nicht existiert, können Sie ihn durch Klick auf “Create the user now” (siehe Screenshot) einfach von TYPO3 mit den korrekten Parametern anlegen lassen.

vergrößern:
Wenn Sie diese Meldung sehen, klicken Sie auf "Create the user now" um den TYPO3 Backend User _cli_scheduler anzulegen.

Tasks anlegen

"Tasks" sind die Aufgaben, welche Sie dem System geben. Eine Übersicht der verfügbaren Tasks erhalten Sie, indem Sie im Scheduler Modul im oberen DropDown-Menü "Information" wählen. Es kann auch vorkommen, dass eine Extension solch einen Task anbietet und somit die Liste erweitert.

 

Hinweis: Sollten Sie spezielle Tasks haben, die z.B. durch (selbst-programmierte) Extensions hinzugefügt wurden, dann achten Sie bitte darauf, dass die Tasks ressourcenschonend sind. Bitte legen Sie keine Tasks an, die extremen Rechen- und/oder Speicheraufwand verursachen.

Wenn Sie sich unsicher sind, ob Sie einen Task problemlos ausführen können, dann kontaktieren Sie uns einfach (typo3master(at)uni-koeln.de).

 

Um nun einen Task anzulegen, wählen Sie im DropDown-Menü "Scheduled Tasks" und klicken Sie dort auf das Hinzufügen-Icon.

vergrößern:
Mit Klick auf den Button mit dem Tooltip "Add Task" können Sie im Scheduler eine weitere Aufgabe anlegen.

Informationen zu den auszufüllenden Feldern:

  • Class: ein Drop-Down Menü aus dem Sie die Aufgabe auswählen
  • Type: Für einen regelmäßigen Task wählen Sie "Recurring". Falls der Task nur ein einziges Mal ausgeführt werden soll, wählen Sie “Single”.
  • Task group: Dieses Feld können Sie leer lassen.
  • Start: Wann soll der Task (erstmalig) ausgeführt werden?
  • End: (optional). Setzt einen End-Zeitpunkt für regelmäßige Tasks.
  • Frequency: In welchem Rhythmus soll ein regelmäßiger Task ausgeführt werden? Dies muss entweder in Sekunden (!) oder mit Hilfe von Cron Commands angegeben werden. Zum Beispiel.: "3600", "@hourly" oder "0 * * * *" für eine stündliche Ausführung. “@daily” für eine Ausführung einmal am Tag.
  • Allow Parallel Execution: Aktivieren Sie dies um zu erlauben, dass Tasks gleichzeitig ausgeführt werden dürfen.
  • Description: Hier besteht die Möglichkeit eine kurze Beschreibung anzulegen, die angezeigt wird, wenn in der Liste “Scheduled tasks” der Mauszeiger über den Namen des Task geführt wird.

Zum Abspeichern klicken Sie bitte auf das Diskettensymbol oberhalb des Formulars:

Wichtiger eingebauter Task: “Update Extension List”

Dieser Task aktualisiert die interne Liste der verfügbaren Extensions und Updates. Verwechseln Sie das nicht mit einem Update der Extensions, welches weiterhin manuell ausgeführt werden muss. Dies kann und sollte auch nicht automatisiert werden, weil es in einigen wenigen Fällen nötig ist einzugreifen.

 

Wählen Sie folgende Einstellungen:

  • Class: “Update extension list” aus der Gruppe “extensionmanger”
  • Typ: “Recurring”
  • Start: setzen Sie ein Startdatum
  • Frequency: sinnvoll ist “@daily”.

Mit Klick auf das Diskettensymbol speichern Sie den Task ab.

Wichtiger eingebauter Task: System Status Update

Dieser Task prüft Ihre TYPO3 Installation und sendet eine E-Mail Benachrichtigung falls Fehler gefunden wurden.

Achtung: Dieser Task ist nur dann sinnvoll, wenn auch das Extension-Repository automatisch aktualisiert wird!

Wählen Sie folgende Einstellungen:

  • Class: "System Status Update" aus der Gruppe reports
  • Type: Reccuring
  • Start: Setzen Sie ein Startdatum
  • Frequency: @weekly ist sinnvoll. Generell sollten Sie diesen Task nicht öfter als 1x täglich ("@daily") ausführen.
  • Notification Email Addresses: Geben Sie hier (jeweils eine pro Zeile) die E-Mail-Adresse der Personen ein, die informiert werden sollen.

Speichern Sie den Task mit Klick auf das Diskettensymbol.

Tasks ausführen

Alle angelegten Tasks werden unter "Scheduled Tasks" angezeigt.

Wenn Sie zum ersten Mal einen Task angelegt haben, dann wird er erst in der darauffolgenden Nacht zum ersten Mal ausgeführt.

Danach läuft das Skript, das die zu erledigenden Aufgaben abfragt, jedoch regelmäßig durch.

Beachten Sie: Der Server hat seinen eigenen Rhythmus wie oft er prüft, ob eine Aufgabe zu erledigen ist. Dies geschieht alle 15 Minuten (mit individueller Taktung, also nicht unbedingt immer zur vollen Stunde). Es ist somit durchaus möglich, dass ein Task nicht genau zur definierten Zeit anfängt, sondern erst dann, wenn der Server das nächste Mal abfragt, ob etwas durchzuführen ist. Diese Tasks werden dann als "late" markiert (siehe auch Statuslegende unterhalb der Tasks).

Sie können Tasks auch manuell ausführen, indem Sie den gewünschten Task markieren und auf "Execute selected tasks" klicken.

Kontakt
Bei Fragen und für eine individuelle Beratung wenden Sie sich bitte an:
RRZK-Helpdesk
Telefon: (0221) 470-89555