GET_PARENT_TYPE

Données d'activation

GET_UC_OBJECT_NR

---

GET_UC_OBJECT_STATUS

Fonction de script : Retourne le statut d'un objet activé

Syntaxe

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

Remarques

Cette fonction de script permet de récupérer des informations sur le statut d'un objet activable.

Cette fonction de script renvoie une valeur même si la tâche n'est plus active car cette information est extraite des statistiques. Une chaîne vide est retournée si aucune statistique n'est trouvée.

Tous les paramètres de cette fonction de script sont facultatifs. Si vous utilisez uniquement le paramètre Requête, il faut quand même indiquer les deux virgules des paramètres inutilisés.

Exemple :

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

Si le type d'objet et le RunID ne sont pas indiqués, le statut de la tâche qui utilise cette fonction de script est retourné.

Si le type d'objet ou le RunID ne sont pas indiqués, les particularités suivantes s'appliquent :

• Si le type d'objet est le seul paramètre indiqué, le statut de sa propre tâche est retourné. Le type d'objet doit correspondre au type d'objet de sa propre tâche.
• Si le RunID est le seul paramètre indiqué, le statut de sa propre tâche ou le statut d'une autre tâche peut être renvoyé.
• Si le RunID d'une autre tâche est assigné à cette fonction de script, les deux tâches doivent être du même type d'objet. Sinon le type d'objet de l'autre tâche doit être indiqué clairement.

Une chaîne vide est renvoyée si le type d'objet et le RunID ne correspondent pas. Une chaîne vide est également renvoyée si aucune tâche n'est trouvée pour le RunID indiqué.

Si aucune requête n'est utilisée, la fonction de script renvoie le code du statut. 

Le texte du statut peut également être récupéré pour les jobs. Il s'agit du texte que le messager de job a affiché dans la queue ou qui a été modifié par :MODIFY_STATE. Pour les autres types d'objet, une chaîne vide est renvoyée.

Exemples

Le premier exemple active le job "DB.USE" pour ensuite récupérer son statut. Une autre fonction de script est utilisée pour récupérer le numéro d'exécution du job.

: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#".

Le deuxième exemple récupère le statut d'une tâche. Le statut est écrit dans le protocole d'activation.

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

Dans le troisième exemple, le script d'un job doit récupérer le statut du Workflow (parent). Comme il existe deux types d'objets différents, le type d'objet et le RunID du Workflow doivent être passés à la fonction de script.

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

Le quatrième exemple renvoie le texte du statut d'un job.

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

Rubriques connexes :

Eléments de script - Données d'activation

Généralités sur les scripts
Eléments de script - Liste alphabétique
Eléments de script - Répartition fonctionnelle