Manuel des Scripts Automation Engine > Organisation fonctionnelle > Traitement des erreurs et messages > :STOP

:STOP

Instruction de script : interrompt le traitement d'un script.

Syntaxe

:STOP [Mode arrêt]

Syntaxe

Description / format

Mode d'arrêt

Les paramètres suivants peuvent être passés à l'instruction :STOP en tant que mode d'arrêt :

Aucune indication
Interrompt le traitement d'un script et écrit le message U0010014 dans le protocole d'activation.

NOMSG, numéro du message[, texte du message]
Interrompt l'activation de l'objet sans erreur. Un message peut être créé à cette fin.

MSG, Numéro d'erreur, Texte d'erreur
Interrompt l'activation de l'objet avec un message d'erreur.

Remarques

:STOP interrompt l'activation d'un objet. C'est pourquoi l'instruction ne peut pas être utilisée dans les onglets Post-traitement. Automic recommande d'utiliser l'instruction :MODIFY_STATE à la place.

Mode d'arrêt NOMSG

On peut utiliser l'instruction :STOP avec le mode d'arrêt NOMSG dans des objets qui ne nécessitent pas d'agent pour l'exécution. Cela permet de travailler exclusivement avec des instructions de scripts (pour définir des variables par exemple).

Un message peut aussi être créé avec le mode d'arrêt NOMSG. Le numéro de message est nécessaire pour la syntaxe mais n'est pas évalué. Le texte du message est enregistré dans les statistiques et envoyé en tant qu'élément de confirmation lors de l'exécution via CallAPI. Ainsi par exemple, le numéro d'exécution (RunID) d'une tâche démarrée peut être retourné au CallAPI .

Comme le mode d'arrêt NOMSG termine l'activation d'une tâche sans erreur, cette dernière n'est pas affichée en tant que tâche interrompue dans les statistiques.

Mode d'arrêt MSG

Vous pouvez utiliser le mode d'arrêt MSG pour interrompre l'activation d'un objet avec un message d'erreur. Vous pouvez alors indiquer un numéro d'erreur et un texte d'erreur. Cela est particulièrement important pour les objets qui sont démarrés via le CallAPI de AE. Les informations retournées représentent la seule information sur l'exécution du script. Les numéros d'erreur 50 à 59 sont réservés aux utilisateurs.

Le code retour 4 est utilisé pour le numéro d'erreur 50 et le code retour 8 pour les numéros d'erreur de 51 à 59.

Notez que vous ne pouvez utiliser que les numéros d'erreur de 50 à 59. L'utilisation des autres numéros d'erreur entraîne l'interruption du script, avec un message d'erreur signalant que le numéro d'erreur indiqué n'est pas valide.

Comme le mode d'arrêt MSG termine l'activation d'une tâche avec erreur, ces tâches sont listées dans les statistiques des tâches interrompues.

Si l'instruction :STOP est utilisée sans paramètre ou avec le mode d'arrêt MSG, le traitement du script s'interrompt avec une erreur et un rollback de la base de données est effectué. Toutes les transactions non encore exécutées sont annulées. Si vous avez utilisé des objets variable de script, il est alors possible que les objets variables existants au début du script aient déjà sauvegardé leurs nouvelles valeurs, alors que les variables de la fin du script ne les aient pas sauvegardées.

Le système inscrit les transactions dans la base de données AE (commit) lorsque le traitement du script est interrompu. Ce moment survient

L'instruction :WAIT 0 permet de forcer une interruption du traitement du script et donc un commit de la base de données.

Exemple

L'exemple suivant renvoie un message d'erreur lié à l'activation correcte ou non d'un job.

:SET &ACTNR# = ACTIVATE_UC_OBJECT(JOBS, MM)
:
IF &ACTNR# = "0"
:
STOP MSG, 50, "Error in activating the job MM."
:
ELSE
:
PRINT "The job MM was activated with the activation number &ACTNR#."
:
ENDIF

 

Rubriques connexes :

Elément de script Description

:EXIT

Instruction permettant de terminer le traitement du script avec un code retour.

:WAIT

Interrompt le traitement du script pour une durée donnée. Entre temps, d'autres tâches sont terminées.

Eléments de script - Activer les objets
Eléments de script - Traitement des erreurs et messages

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

Eléments de script - Répartition fonctionnelle