Allgemeines
Ein Job der Klasse SchedulerRegisterService wird periodisch ausgeführt. Es kann als CRON-Job oder als DELAY-Job angelegt werden. Beispiele sind die DeleteJobs.
Einrichtung
Konfiguration Service
Einrichten eines SCHEDULER-Service mit ID und Name je nach Job, der eingerichtet werden soll:
Als Service-Klasse muss org.b2bbp.service.inbound.scheduled.SchedulerRegisterService
angegeben werden.
Konfiguration Service-Properties
Die folgenden Service-Properties müssen für jeden SchedulerRegisterService eingerichtet werden. Bei keiner dieser Properties wird der Nachrichtenkontext überschrieben!
Die folgenden B3P_CRON_<Wert>-Angaben haben einen Default-Wert von -1. Das heißt, dass der Job jede Minute/Stunde/Tag/… ausgeführt wird!
Sollte also keine dieser Properties gesetzt werden, wird der CRON-Job jede Minute ausgeführt! In allen CRON-Properties (außer für das Jahr) können kommasepariert mehrere Werte angegeben werden.
Allgemeine Konfiguration
Mit den folgenden Eigenschaften wird die generelle Konfiguration des Service vorgenommen.
Name der Eigenschaft | erlaubte Werte | Beschreibung |
B3P_SCHEDULER_REGISTER_CLASSNAME | Java-Klassenbezeichnung | Name der Java-Klasse, die den Service implementiert |
B3P_SCHEDULER_NAME | Beliebiger Text | Name der im Monitor angezeigt wird nachdem der Job ausgeführt wurde. (optional) |
B3P_SCHEDULER_TYPE | CRON oder DELAY | Art der wiederholten Ausführung. Je nach Wahl müssen die Properties B3P_CRON_<Wert> oder B3P_DELAY_<Wert> gesetzt werden. (1) (Pflichtfeld) |
B3P_DELAY_MINUTES | Ganze positive Zahl | Anzahl der Minuten, die bis zum Ausführen gewartet wird und nach denen der Job erneut ausgeführt wird. (Pflichtfeld) |
B3P_DELAY_REPEAT | Boolean Wert (true oder false) | Angabe, ob der Job nach einmaligem Lauf wiederholt werden soll oder nicht. Default: false |
(1) Falls die Property B3P_SCHEDULER_TYPE
nicht gesetzt ist, wird automatisch ein Default gewählt: falls die Property B3P_DELAY_MINUTES
gesetzt ist, wird als Scheduler Type DELAY
gesetzt. Sonst wird CRON
gesetzt.
Konfiguration der Laufzeit
Mit den folgenden Eigenschaften werden die Zeitpunkte konfiguriert, zu welchen der Job laufen soll.
Name der Eigenschaft | erlaubte Werte | Beschreibung |
B3P_CRON_HOURS_MINUTES | hh:mm | Uhrzeit, zu der der Job ausgeführt wird. Kann alternativ zu B3P_CRON_HOURS & B3P_CRON_MINUTES genutzt werden. |
B3P_CRON_MINUTES | Ganze Zahl von 0-59 | Minute, in der der Job ausgeführt wird. Die Eingabe mehrerer Werte ist kommasepariert anzugeben |
B3P_CRON_HOURS | Ganze Zahl von 0-23 | Stunde, in der der Job ausgeführt wird. Die Eingabe mehrerer Werte ist kommasepariert anzugeben |
B3P_CRON_DAYS_OF_MONTH | Ganze Zahl von 1-31 | Tag im Monat, an dem der Job ausgeführt wird. Die Eingabe mehrerer Werte ist kommasepariert anzugeben |
B3P_CRON_MONTH | Ganze Zahl von 0-11 | Monat, in dem der Job ausgeführt wird (0=Jan, 1=Feb, …). Die Eingabe mehrerer Werte ist kommasepariert anzugeben |
B3P_CRON_DAYS_OF_WEEK | Ganze Zahl von 1-7 | Wochentag, an dem Job ausgeführt wird (1=Sonntag, 2=Montag, …). Die Eingabe mehrerer Werte ist kommasepariert anzugeben |
B3P_CRON_YEAR | Ganze Zahl | Jahr der Ausführung (Default -1 führt zur Ausführung in jedem Jahr) |
B3P_FACTORY_CALENDAR_EXTNAME | Name der Extension des Werkskalenders | Verweis auf eine Extension, welche Wochentage und spezielle Daten von der Ausführung des Jobs ausschließt. Kann nur mit CRON-Jobs genutzt werden. |
Der Scheduler-Service läuft also zum Beispiel einmal täglich, wenn nur die beiden Properties B3P_CRON_HOURS und B3P_CRON_MINUTES gesetzt werden (24-Stunden-Angaben verwenden).
Ausführung
Alle Details zu weiteren nötigen Service Properties sind in den Dokumentationen zu den einzelnen Jobs zu finden.
Abschließend muss der Service einem Knoten zugeordnet werden (der Global Property NODE_<x> hinzufügen) und die Services oder der entsprechende Application Server neugestartet werden.
Damit ist der Job aktiv. Der CRON-Job wird zum gewünschten Zeitpunkt ausgeführt, der DELAY-Job wartet die in B3P_DELAY_MINUTES konfigurierte Zeit, bevor er zum ersten Mal ausgeführt wird.
View Me Edit Me