Manuel des Scripts Automation Engine > Organisation fonctionnelle > Activation d'objets > DEACTIVATE_UC_OBJECT

DEACTIVATE_UC_OBJECT

Fonction de script : Désactive une tâche terminée.

Syntaxe

DEACTIVATE_UC_OBJECT(RunID [, FORCED])

Syntaxe	Description / format
RunID	RunID de la tâche devant être désactivée. Format : variable de script, littéral de script, nombre sans guillemets
FORCED	Effectue une désactivation, quel que soit le statut des tâches de haut niveau. Le système ne vérifie pas si la tâche est exécutée dans un workflow. De plus, les options de désactivation automatique des tâches subordonnées sont ignorées et désactivées dans tous les cas. Le paramètre FORCED peut uniquement être utilisé avec les workflows. Notez que FORCED ne vérifie pas si les tâches des sous-workflow sont actives. Format : Nom AE, littéral de script ou variable

Syntaxe

Description / format

RunID

RunID de la tâche devant être désactivée.
Format : variable de script, littéral de script, nombre sans guillemets

FORCED

Effectue une désactivation, quel que soit le statut des tâches de haut niveau.

Le système ne vérifie pas si la tâche est exécutée dans un workflow. De plus, les options de désactivation automatique des tâches subordonnées sont ignorées et désactivées dans tous les cas. Le paramètre FORCED peut uniquement être utilisé avec les workflows.

Notez que FORCED ne vérifie pas si les tâches des sous-workflow sont actives.

Format : Nom AE, littéral de script ou variable

Codes retour
12204 : la tâche (RunID) ne peut pas être désactivée. Les objets d'un workflow ne peuvent pas être désactivés. 12205 : la tâche (RunID) ne peut pas être désactivée car ses sous-tâches sont encore actives. 12206 - La définition du statut n'est pas numérique 12207 - Définition du statut non ascendante (de-à) 12208 - La définition du statut est incorrecte d'un point de vue syntaxique 12209 - Définition du statut introuvable : L'objet n'a pas été désactivé automatiquement 12210 - Définition du statut non numérique, l'objet n'a pas été désactivé automatiquement L'objet n'a pas été désactivé automatiquement

Codes retour

12204 : la tâche (RunID) ne peut pas être désactivée. Les objets d'un workflow ne peuvent pas être désactivés.
12205 : la tâche (RunID) ne peut pas être désactivée car ses sous-tâches sont encore actives.
12206 - La définition du statut n'est pas numérique
12207 - Définition du statut non ascendante (de-à)
12208 - La définition du statut est incorrecte d'un point de vue syntaxique
12209 - Définition du statut introuvable : L'objet n'a pas été désactivé automatiquement
12210 - Définition du statut non numérique, l'objet n'a pas été désactivé automatiquement L'objet n'a pas été désactivé automatiquement

Remarques

Vous ne pouvez désactiver que des tâches déjà terminées (réussies ou annulées). une tâche désactivée disparait des activités (fenêtre d'activités). Notez que vous devez indiquer le RunID de la tâche pour cela.

Pour la désactivation, les prérequis suivants sont applicables :

Un Workflow comportant des tâches actives ne peut pas être désactivé. Cela est également valable pour les tâches de tous les sous-workflows.
Les tâches qui ont été démarrées par un workflow ne peuvent être désactivées qu'en désactivant le workflow de plus haut niveau (pour lequel cett erègle s'applique également).

Dans les objets activables, vous pouvez également définir les paramètres destinés à leur désactivation automatique. Ces paramètres sont également vérifiés.

Exemples

Dans l'exemple suivant, un objet est activé et la fin de son exécution est attendue. En cas d'erreur, un message est envoyé ensuite à l'utilisateur concerné. Si l'objet se termine sans erreur, il est désactivé.

:SET &ACTOBJ# = ACTIVATE_UC_OBJECT(&OBJ#,WAIT)

:IF &ACTOBJ# = "0"
:   SET &ERRNR# = SYS_LAST_ERR_NR()
:   SET &ERRINS# = SYS_LAST_ERR_INS()
:   SET &MESSAGE# = GET_MSG_TXT(&ERRNR#,&ERRINS#)
:   SET &RET# = SEND_MAIL("John.Smith@automic.com",,&MESSAGE#, "Please check. Thanks!")
:ELSE
: SET &DEACTJOB# = DEACTIVATE_UC_OBJECT(&ACTJOB#)
:ENDIF

Rubriques connexes :

Eléments de script	Description
ACTIVATE_UC_OBJECT	Active un objet.
RESTART_UC_OBJECT	Répète l'exécution d'une tâche.

Eléments de script - Activation d'objets

Exemples :
Maintenance de la base de données avec options
Notification avec texte du message Variable
Détermination du message et du numéro de l'erreur
Réaction à des événements externes

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