GET_PARENT_TYPE

Aktivierungsdaten

GET_UC_OBJECT_NR

---

GET_UC_OBJECT_STATUS

Script-Funktion: Gibt den Status eines aktivierten Objektes zurück.

Syntax

GET_UC_OBJECT_STATUS([Object type ], [RunID], [ Request])

Anmerkungen

Mit der Script-Funktion stellen Sie den Status eines Objektes fest, das der Objektklasse der aktivierbaren Objekte angehört.

Die Script-Funktion gibt auch einen Wert zurück, wenn die Aufgabe nicht mehr aktiv ist. Er wird aus der Statistik entnommen. Falls keine Statistik gefunden wird, ist der Rückgabewert ein Leerstring.

Alle Parameter dieser Script-Funktion sind optional. Wenn Sie nur den Parameter Anforderung verwenden, sind trotzdem die beiden Kommata zu setzen.

Beispiel:

:SET  &STATUS# = GET_UC_OBJECT_STATUS( ,,"STATUS")

Wird Objekttyp und laufende Nummer (RunID) nicht angegeben, liefert die Script-Funktion den Status der eigenen Aufgabe. Es wird also der Status der Aufgabe, welche die Script-Funktion verwendet, zurückgegeben.

Wenn Objekttyp oder laufende Nummer (RunID) nicht angegeben werden, gelten die folgenden Besonderheiten:

• Wird nur Objekttyp als Parameter angegeben, ist der Rückgabewert der Status der eigenen Aufgabe. Dabei muss Objekttyp dem Objekttyp der eigenen Aufgabe entsprechen.
• Wird nur laufende Nummer (RunID) angegeben, kann damit entweder der Status der eigenen Aufgabe oder der Status einer anderen Aufgabe ermittelt werden.
• Wird die laufende Nummer einer anderen Aufgabe an die Script-Funktion übergeben, müssen beide Aufgaben vom gleichen Objekttyp sein. Ist das nicht der Fall, muss der Objekttyp der anderen Aufgabe explizit angegeben werden.

Es wird ein Leerstring zurückgegeben, wenn Objekttyp und laufende Nummer (RunID) nicht zusammenpassen. Es kommt auch ein Leerstring zurück, wenn keine Aufgabe zur angegebenen laufenden Nummer (RunID) gefunden wurde.

Wird Rückfrage nicht verwendet, gibt die Script-Funktion den Statuscode zurück. 

Für Jobs kann auch der Statustext ermittelt werden. Das ist der Text, den der Jobmelder im Trailer ausgegeben hat oder welcher mit :MODIFY_STATE geändert wurde. Bei den anderen Objekttypen wird ein Leerstring zurückgegeben.

Beispiele

Im ersten Beispiel wird der Job "DB.USE" aktiviert, um danach seinen Status zu ermitteln. Um die laufende Nummer des Jobs zu erhalten, wird eine weitere Script-Funktion eingesetzt.

:SET &JNR# = ACTIVATE_UC_OBJECT(JOBS,DB.USE)
:SET &STATUS# = GET_UC_OBJECT_STATUS(JOBS,&JNR#)

:PRINT "The status of the job(&JNR#) is &STATUS#".

Das zweite Beispiel ermittelt den eigenen Status einer Aufgabe. Der Status wird im Aktivierungsprotokoll ausgegeben.

:SET &RET# = GET_UC_OBJECT_STATUS()
:PRINT &RET#

Im dritten Beispiel soll im Script eines Jobs der Status des Workflows (Parent) ermittelt werden, in welchem dieser Job läuft. Da zwei unterschiedliche Objekttypen vorliegen, müssen der Script-Funktion Objekttyp und laufende Nummer (RunID) des Workflows übergeben werden.

:SET &RUNNR# = SYS_ACT_PARENT_NR()
:SET &STATUS# = GET_UC_OBJECT_STATUS (JOBP,&RUNNR#)
:SEND_MSG BU,BU,"The workflow's status is: &STATUS#."

Das vierte Beispiel gibt den Statustext eines Jobs zurück.

:SET &RET# = GET_UC_OBJECT_STATUS(,,"STATUS_TEXT")
:PRINT &RET#

Siehe auch:

Script-Sprachmittel - Aktivierungsdaten

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung
Script-Sprachmittel - Funktionelle Gliederung