JustRelate

Job-Parameter

Parameter
 Typ
 Erklärung
 get
 set
create		 descr
category string Die Job-Kategorie (user oder system ) • •
comment string Beschreibung des Jobs • •
displayTitle string Der in der HTML-Benutzerschnittstelle angezeigte Titel des Jobs •
execLogin string Login, unter dem das Skript ausgeführt wird • • •
execPerm string Das globale Recht, das ein Benutzer benötigt, um den Job auszuführen, d. h. in die Warteschlange zu stellen. Ist kein Recht angegeben, so dürfen alle Benutzer den Job ausführen. • •
getKeys stringlist Liste der mit get abfragbaren Job-Parameter •
id number Die ID des Jobs • •
isActive bool Gibt an, ob ein Job aktiv (1) oder nicht aktiv (0) ist. Nur aktive Jobs können ausgeführt werden • • •
lastExecEnd datetime Zeitpunkt, an dem die letzte Ausführung des Jobs beendet wurde. •
lastExecResult string Ergebnis der letzten Ausführung des Skripts •
lastExecStart datetime Zeitpunkt, an dem die letzte Ausführung des Jobs begonnen wurde. •
lastLogEntry stringlist Der letzte (aktuelle) Protokolleintrag des Jobs. Das Format ist beim Subbefehl getLogEntry beschrieben. •
lastOutput string Die letzte vom Job produzierte Ausgabe. •
log stringlist Die Liste der IDs der letzten Protokolleinträge des Jobs. Die maximale Anzahl der Einträge ist im Systemkonfigurationseintrag jobMaxLogLength definiert. •
logEntries stringlist Die letzten Protokolleinträge des Jobs, von denen jeder wiederum eine Liste ist. Das Format ist beim Subbefehl getLogEntry beschrieben. •
name string Der Name des Jobs. Namen von Jobs der Kategorie user dürfen nicht mit system oder einem Unterstrich beginnen. • • •
nextExecStart datetime Zeitpunkt, an dem der Job das nächste Mal ausgeführt wird (leer, wenn er gerade läuft oder es keinen nächsten Termin gibt). • •
queuePos number Wenn der Wert größer 0 ist, gibt er die Position des Jobs in der Warteschlange an, ist er 0, so wird der Job gerade ausgeführt, andernfalls ist der Job nicht in der Warteschlange • •
schedule stringlist Der Ausführungsplan (Beschreibung siehe unten). • •
script string Das Tcl-Skript, das abgearbeitet werden soll, wenn der Job ausgeführt wird (nicht bei Jobs der Kategorie system ). • •
setKeys stringlist Liste der mit set setzbaren Job-Parameter •
title string Der Titel des Jobs • • •
Der Ausführungsplan

Jedem Job ist ein Ausführungsplan (engl. schedule = Terminplan) zugeordnet. In diesem Plan sind die (gegebenenfalls wiederkehrenden) Ausführungszeitpunkte des Jobs festgelegt. Jeder Ausführungszeitpunkt besteht aus Angaben über die Jahre (years), Monate (months), Tage (days) oder Wochentage (weekdays), die Stunden (hours) und die Minuten (minutes). Die Angaben müssen nicht vollständig sein, d. h. Bestandteile können weggelassen werden. Der folgende Job wird im Juli 2010 täglich um 6.30 und um 22.30 Uhr ausgeführt:

job withName twiceADayInJuly2010 set schedule {
  {minutes 30 hours {6 22} months 7 years 2010}
}

Der Ausführungsplan ist eine Liste von Einträgen, von denen jeder wiederum eine Liste ist. Schließlich werden innerhalb eines Eintrags dessen Bestandteile mit den oben aufgeführten Bezeichnern und den dazu gehörenden Werten spezifiziert.

Für die Logik der Wiederholung ist es entscheidend, dass ein fehlender Bestandteil eines Eintrags so interpretiert wird, als wären alle möglichen Werte für diesen Bestandteil angegeben. Führt man beispielsweise nicht die Tage oder Wochentage auf, in denen der Job ausgeführt werden soll, so wird er täglich ausgeführt. Ein leerer Eintrag für einen Ausführungszeitpunkt bewirkt also, dass der Job jede Minute ausgeführt wird, und zwar so lange, bis der Eintrag gelöscht oder geändert wird. Ein einmaliger Ausführungszeitpunkt (ohne Wiederholung) lässt sich definieren, indem für jeden Bestandteil außer weekdays genau ein Wert angegeben wird. days und weekdays werden mit oder verknüpft, und das Ergebnis wird mit allen anderen Kategorien mit und verknüpft.

Die Stunden werden als Zahlen von 0 bis 23, die Wochentage mit den Zahlen 1 bis 7 angegeben, wobei 1 für Montag, 2 für Dienstag usw. steht.

Alle Einträge in Ausführungsplänen beziehen sich auf die Server-Zeit mit ihrer spezifischen Zeitzone. Überschneiden sich die Ausführungszeiten in Einträgen, so hat der in der Liste weiter vorn stehende Eintrag Vorrang.

© JustRelate Group GmbH · 2024