Automation Engine Script-Leitfaden > Funktionelle Gliederung > Objekte lesen oder verändern > :MODIFY_STATE

:MODIFY_STATE

Script-Anweisung: Ändert den Rückgabewert oder Statustext eines Jobs nach dessen Ende.

Syntax

:MODIFY_STATE Property=Value

Syntax

Beschreibung/Format

Eigenschaft

Eigenschaft für das Jobende.
Format: Script-Variable oder AE-Name

Erlaubte Werte: "RETCODE", "STATUS_TEXT"
"RETCODE" = Rückgabewert des Jobs.
"STATUS_TEXT" = Statustext des Jobs. 

Wert 

Neue Zuweisung für die Eigenschaft des Jobs.
Format: Script-Literal, Script-Variable, AE-Name, Zahl ohne Hochkommata oder Script-Funktion

Für "RETCODE": Numerischer Wert.
Für "STATUS_TEXT": Alphanumerische Zeichenfolge, maximal 32 Zeichen. 

Beschreibung

Mit :MODIFY_STATE kann der Rückgabewert oder der Statustext eines Jobs nachträglich geändert werden. Die Script-Anweisung ist daher nur in der Registerkarte Post-Script erlaubt.

Die Script-Anweisung kann beispielsweise dazu verwendet werden, um einem Job, der "technisch" zwar normal endete, nachträglich den Status ENDED_NOT_OK zuzuweisen. Das könnte bei einem Job notwendig werden, bei dem ein Fehler erst durch die Analyse des eigenen Reports erkannt werden kann.
Siehe: PREP_PROCESS_REPORT.

Die Änderung des Rückgabewertes beeinflusst den Status des Jobs. Der Status resultiert daraus, welcher maximale Rückgabewert für ein normales Ende des Jobs definiert wurde (Registerkarte Laufzeit). Ist der gesetzte Rückgabewert größer als dieser maximale Rückgabewert, wird der Status auf ENDED_NOT_OK gesetzt. Ist der gesetzte Rückgabewert kleiner als der festgelegte maximale Rückgabewert oder gleich, erhält der Job den Status ENDED_OK.

Für das Jobende kann auch ein eigener Statustext gesetzt werden. Er ersetzt den Text, den der Jobmelder im Trailer ausgegeben hat.

Die Änderungen werden im Report des Jobs, Registerkarte Post-Prozessierung, protokolliert. Die geänderten Werte sind auch im Detailfenster des Jobs sichtbar.

Beispiel

Im Beispiel geht es um einen Job, der unter Windows eine Datei kopieren soll, die nicht vorhanden ist. Der Job würde normal mit Rückgabewert "0" enden. Nur aus dem Job-Report wäre ersichtlich, dass die zu kopierende Datei nicht gefunden wurde.

Im Post-Script des Jobs wird nun der Job-Report analysiert. Das Fehlen der zu kopierenden Datei wird erkannt und der Rückgabewert geändert. Dadurch wird der Job abgebrochen.

:SET &HND# = PREP_PROCESS_REPORT(,,,"*cannot find the file*")
:
PROCESS &HND#
:  
MODIFY_STATE STATUS_TEXT="Files not found"
:  
MODIFY_STATE RETCODE=50
:
ENDPROCESS

 

Siehe auch:

Script-Sprachmittel Beschreibung

:EXIT

Beendet die Prozessierung des Scripts mit Rückgabewert.

GET_UC_OBJECT_STATUS

Gibt den Status eines aktivierten Objektes zurück.

Script-Sprachmittel - Objekte lesen oder verändern

Beispielsammlung
Endestatus aufgrund des Reportinhaltes setzen

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung

Script-Sprachmittel - Funktionelle Gliederung

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH