Parameterelemente für Jobs

Mit Hilfe von Funktionselementen kann man auf Jobs zugreifen. So können beispielsweise mit dem job-get-Element die Werte sämtlicher Job-Parameter ermittelt werden. Welche Jobeigenschaften ausgelesen oder gesetzt werden sollen, wird durch Parameterelemente spezifiziert. Im Folgenden werden die Job-Parameter und die zugehörigen Parameterelemente aufgeführt.

category
Bedeutung: Die Job-Kategorie (user oder system).

Definition:

<!ELEMENT category (%cm.atom;)>
comment
Bedeutung: Die Beschreibung des Jobs.

Definition:

<!ELEMENT comment (%cm.atom;)>
displayTitle
Bedeutung: Der in der HTML-Benutzerschnittstelle angezeigte Titel des Jobs (eine Kombination aus Titel und Namen).

Definition:

<!ELEMENT displayTitle (%cm.atom;)>
execLogin
Bedeutung: Das Login, unter dem das Skript ausgeführt werden kann.

Definition:

<!ELEMENT execLogin (%cm.atom;)>
execPerm
Bedeutung: 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.

Definition:

<!ELEMENT execPerm (%cm.atom;)>
getKeys
Bedeutung: Die Liste der mit job-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
id
Bedeutung: Die ID des Jobs.

Definition:

<!ELEMENT id (%cm.atom;)>
isActive
Bedeutung: Gibt an, ob ein Job aktiv (1) oder nicht aktiv (0) ist. Nur aktive Jobs können ausgeführt werden.

Definition:

<!ELEMENT isActive (%cm.atom;)>
lastExecEnd
Bedeutung: Der Zeitpunkt, an dem die letzte Ausführung des Jobs beendet wurde.

Definition:

<!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime |
  userConfigFormattedTime)*">
<!ELEMENT lastExecEnd (%cm.date;)>
<!ATTLIST lastExecEnd  type CDATA #IMPLIED>

Bedeutung der Attribute:

  • type: Der Typ des Feldes lastExecEnd.

Beispiel:

<cm-request...>
  <job-where>
    <execLogin>stan</execLogin>
  </job-where>
  <job-get>
    <lastExecEnd type="date"/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <lastExecStart type="date">
        <isoDateTime>20010401164700</isoDateTime>
        <systemConfigFormattedTime>01.04.2001 08:47 MET</systemConfigFormattedTime>
        <userConfigFormattedTime>01.04.2001 16:47 EST</userConfigFormattedTime>
      </lastExecStart>
    </job>
  </cm-code>
</cm-response>
lastExecResult
Bedeutung: Das Ergebnis der letzten Ausführung des Skripts.

Definition:

<!ELEMENT lastExecResult (%cm.atom;)>
lastExecStart
Bedeutung: Der Zeitpunkt, an dem die letzte Ausführung des Jobs begonnen wurde.

Definition:

<!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime |
  userConfigFormattedTime)*">
<!ELEMENT lastExecStart (%cm.date;)>
<!ATTLIST lastExecStart type CDATA #IMPLIED>

Bedeutung der Attribute:

  • type: Der Typ des Feldes lastExecStart.

Beispiel:

<cm-request...>
  <job-where>
    <id>5423</id>
  </job-where>
  <job-get>
    <lastExecStart type="date"/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <lastExecStart type="date">
        <isoDateTime>20010613153502</isoDateTime>
        <systemConfigFormattedTime>13.06.2001 15:35 MET</systemConfigFormattedTime>
        <userConfigFormattedTime>13.06.2001 07:35 EST</userConfigFormattedTime>
      </lastExecStart>
    </job>
  </cm-code>
</cm-response>
lastLogEntry
Bedeutung: Der letzte (aktuelle) Protokolleintrag des Jobs.

Definition:

<!ENTITY % cm.logEntry "  (logEntryId,  execResult,  execStart,  execEnd)">
<!ELEMENT lastLogEntry %cm.logEntry;>

Beispiel:

<cm-request...>
  <job-where>
    <id>5423</id>
  </job-where>
  <job-get>
    <lastLogEntry/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <lastLogEntry>
        <logEntryId>69811.61</logEntryId>
        <execResult />
        <execStart type="date">
          <isoDateTime>20020716130256</isoDateTime>
          <systemConfigFormattedTime>16.07.2002 15:02</systemConfigFormattedTime>
          <userConfigFormattedTime>16.07.2002 15:02</userConfigFormattedTime>
        </execStart>
        <execEnd type="date">
          <isoDateTime>20020716130256</isoDateTime>
          <systemConfigFormattedTime>16.07.2002 15:02</systemConfigFormattedTime>
          <userConfigFormattedTime>16.07.2002 15:02</userConfigFormattedTime>
        </execEnd>
      </lastLogEntry>
    </job>
  </cm-code>
</cm-response>
lastOutput
Bedeutung: Die letzte vom Job produzierte Ausgabe.

Definition:

<!ELEMENT lastOutput (%cm.atom;)>

Beispiel:

<cm-request...>
  <job-where>
    <name>myJob</name>
  </job-where>
  <job-get>
    <lastOutput/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <lastOutput><![CDATA[Die Job-Ausgabe.]]></lastOutput>
    </job>
  </cm-code>
</cm-response>
log
Bedeutung: Die Liste der IDs der letzten Protokolleinträge des Jobs. Die maximale Anzahl der Einträge ist im Systemkonfigurationseintrag tuning.jobMaxLogLength definiert.

Definition:

<!ELEMENT log (%cm.atom;)>
logEntries
Bedeutung: Die letzten Protokolleinträge des Jobs, von denen jeder wiederum eine Liste ist.

Definition:

<!ELEMENT logEntries (%cm.listitem;)>

Beispiel:

<cm-request...>
  <job-where>
    <id>5423</id>
  </job-where>
  <job-get>
    <logEntries/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <logEntries>
        <listitem>
          <logEntryId>67921.31</logEntryId>
          <execResult />
          <execStart type="date">
            <isoDateTime>20020716130256</isoDateTime>
            <systemConfigFormattedTime>16.07.2002 15:02</systemConfigFormattedTime>
            <userConfigFormattedTime>16.07.2002 15:02</userConfigFormattedTime>
          </execStart>
          <execEnd type="date">
            <isoDateTime>20020716130256</isoDateTime>
            <systemConfigFormattedTime>16.07.2002 15:02</systemConfigFormattedTime>
            <userConfigFormattedTime>16.07.2002 15:02</userConfigFormattedTime>
          </execEnd>
        </listitem>
      </logEntries>
    </job>
  </cm-code>
</cm-response>
name
Bedeutung: Der Name des Jobs. Namen von Jobs der Kategorie user dürfen nicht mit system oder einem Unterstrich beginnen.

Definition:

<!ELEMENT script (%cm.atom;)>
nextExecStart
Bedeutung: 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).

Definition:

<!ENTITY % cm.date " (%cm.atom; | isoDateTime | systemConfigFormattedTime |
  userConfigFormattedTime)*">
<!ELEMENT nextExecStart (%cm.date;)>
<!ATTLIST nextExecStart type CDATA #IMPLIED>

Bedeutung der Attribute:

  • type: Der Typ des Feldes nextExecStart.

Beispiel: siehe lastExecStart.
queuePos
Bedeutung: 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.

Definition:

<!ELEMENT queuePos (%cm.atom;)>
schedule
Bedeutung: Der Ausführungsplan.

Definition:

<!ELEMENT schedule (%cm.atom;)>

Beispiel:

<cm-request...>
  <job-where>
    <id>5423</id>
  </job-where>
  <job-get>
    <schedule/>
  </job-get></cm-request> <cm-response...>
  <cm-code numeric="0" phrase="ok">
    <job>
      <schedule>
        <listitem>
          <dictitem>
            <key>years</key>
            <value>
              <listitem>2007</listitem>
              <listitem>2008</listitem>
            </value>
          </dictitem>
          <dictitem>
            <key>minutes</key>
            <value>
              <listitem>3</listitem>
              <listitem>5</listitem>
              <listitem>6</listitem>
              <listitem>7</listitem>
            </value>
          </dictitem>
          ...
        </listitem>
      </schedule>
    </job>
  </cm-code>
</cm-response>
script
Bedeutung: Das Tcl-Skript, das abgearbeitet werden soll, wenn der Job ausgeführt wird.

Definition:

<!ELEMENT script (%cm.atom;)>
setKeys
Bedeutung: Die Liste der mit job-set setzbaren Parameter.

Definition:

<!ELEMENT setKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
title
Bedeutung: Der Titel des Jobs.

Definition:

<!ELEMENT title (%cm.atom;)>