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

ACTIVATE_UC_OBJECT

Fonction script : Active un objet.

Syntaxe

ACTIVATE_UC_OBJECT( Nom d'objet [ , [WAIT] [ , [Date logique] [ , [Fuseau horaire] [ , , [ PASS_VALUES] [ , [Queue] [ , [Alias] [ , [ENABLE_PROMPTS] [, Limite de temps , [TERMINATE][, Exécuter]] ] ] ] ] ] ] ] )
ACTIVATE_UC_OBJECT( Nom d'objet [ , , [Date logique] [ , [Fuseau horaire] [ , [Heure de début] [ , [ PASS_VALUES] [ , [Queue] [ , [Alias] [ , [ENABLE_PROMPTS] ] ] ] ] ] ] ])

Elément de syntaxe	Description/format
Nom d'objet	Nom de l'objet Format : nom AE, littéral de script ou Variable de script
WAIT	Le mot clé WAIT a pour effet que la fonction de script attend la fermeture de l'objet.
Date logique	Date logique avec laquelle l'objet doit être activé au format "AAMMJJ" ou "AAAAMMJJ". Format : Littéral de script ou Variable de script Il est possible d'indiquer la date dans un autre Format de date. Saisissez ainsi en premier le format de date souhaité suivi d'un séparateur (: ou ;) puis la date. L'indication du format de date est facultative.
Fuseau horaire	Nom d'un objet Fuseau horaire. Fuseau horaire pour lequel la marque horaire doit être convertie. Format : Littéral de script ou Variable de script
Heure de Début	Marque horaire à partir de la date et de l'heure ("AAAA-MM-JJ HH:MM:SS"). Format : Littéral de script ou Variable de script
PASS_VALUES	Le mot clef PASS_VALUES permet de faire hériter les Variables d'objet et les Variables PromptSet des Tâches à démarrer.
Queue	Entrée d'une objet Queue spécifique qui doit être utilisé pour démarrer la Tâche. Format : nom AE, littéral de script ou Variable de script Si aucune Entrée de queue n'a lieu, l'objet est activé par défaut dans la Queue de Clients (CLIENT_QUEUE).
Alias	Alias pour l'objet activable. Celui-ci s'affiche dans la Fenêtre d'Activités et dans les statistiques du nom de l'objet. Format: nom AE, littéral de script ou Variable de script L'alias est soumis aux mêmes règles que les noms d'objet dans l'Automation Engine : Longueur maximale: 200 caractères Caractères autorisés: A-Z, 0-9, $, @, _, -, . et #
ENABLE_PROMPTS	Exécution des masques d'entrée du PromptSet des objets activés dans l'interface Utilisateur Conditions : 1) Un utilisateur est connecté à l'interface Utilisateur 2) Le script doit se trouver dans un objet démarré par cet Utilisateur 3) Lors de l'exécution d'un script, l'utilisateur doit encore être connecté à l'ID de session de l'interface Utilisateur. Si les conditions précédentes ne sont pas remplies ou si aucun objet PromptSet n'est attribué à l'objet activable, cela n'a donc aucun effet sur l'exécution suivante du script. Les dialogues d'exécution ne s'affichent pas.
Limite de temps	Durée d'exécution maximale de l'objet démarré Format : littéral de script ou Variable de script L'indication doit figurer au format heure HH:MM:SS. MM et SS doivent être saisies avec deux chiffres, HH peut être saisie avec un chiffre. Exemple : "1:05:07" Attention : ce paramètre doit uniquement être utilisé en rapport avec le mot-clé WAIT. Si la durée d'exécution maximale est définie, une action qui est exécutée en cas de dépassement doit au moins également être déterminée. Utilisez à cet effet les paramètres TERMINATE et Exécuter.
TERMINATE	Interrompre la tâche lorsque la durée d'exécution maximale (limite de temps) est dépassée
Exécuter	Objet devant être activé lorsque la durée d'exécution maximale est dépassée. Format : nom AE, littéral de script ou Variable de script

Codes retour
Numéro courant (RunID) de l'objet actif. "0" - L'activation a échoué. "20423" - Tentative d'auto-activation de la Tâche. Paramètre non autorisé, qui pourrait conduire à une boucle sans fin.

Remarques

La fonction de script ACTIVATE_UC_OBJECT vous permet d'activer un objet appartenant à la classe d'objet des objets activables.

Si vous n'indiquez aucune heure de début, l'activation de l'objet se produit immédiatement. Si vous définissez une heure de début spécifique, la Tâche est planifiée et reçoit le statut "Attente d'heure d'exécution".

Veillez à ne pas faire coïncider les heures d'activation et de démarrage !

L'objet peut, en outre, être activé avec une date logique. S'il n'y a pas de format de date, la date doit être indiquée au format "AAMMJJ" ou "AAAAMMJJ". Deux points ou un point-virgule sont autorisés comme séparateur entre le format de date et la date.

Si le mot-clé WAIT est utilisé, une durée d'exécution maximale peut en plus être définie pour l'objet démarré (limite de temps). Si cette dernière est dépassée, la tâche est interrompue et/ou un objet supplémentaire au choix est exécuté. Définir alors au moins l'une de ces deux actions via les paramètres TERMINATE et Exécuter.

La fonction de script renvoie le RunID de l'objet après une activation réussie. Le code retour en cas d'erreur est "0".

Interrogez toujours le code retour. L'instruction de script :ON_ERROR et les fonctions de script pour le traitement des erreurs permettent d'analyser la cause exacte de l'erreur.

Situation	Code retour	Description
Généralités
L'activation de l'objet a réussi.	RunID	Il s'agit du cas général.
L'objet n'existe pas	0	L'objet est introuvable et ne peut donc pas être activé.
Pas de droit d'exécution pour l'objet	0	Le système d'autorisation vérifie si l'Utilisateur responsable de l'activation possède aussi un droit d'exécution pour l'objet.
Interruption de l'activation de l'objet	0	L'interruption peut être effectuée manuellement ou par d'autres Tâches.
L'heure de début se trouve dans le passé	RunID
Génération de script à l'activation
Erreur de script dans l'objet	0	Les erreurs de script interrompent l'activation d'un objet.
:EXIT 0	RunID	Dans cette instruction, il s'agit d'une fin de traitement de script et non d'une interruption. Elle n'est donc pas considérée comme une erreur.
:EXIT <> 0	0	Cette instruction interrompt l'activation de l'objet.
:STOP NOMSG	RunID	Dans cette instruction, il s'agit d'une fin de traitement de script et non d'une interruption. Elle n'est donc pas considérée comme une erreur.
:STOP MSG	0	Cette instruction interrompt l'activation de l'objet.
Génération de script à l'exécution
Erreur de script dans l'objet :EXIT 0 :EXIT <> 0 :STOP MSG :STOP NOMSG	RunID	Si l'option "Générer à l'Exécution" de l'objet à activer est définie, l'exécution du script n'a pas lieu pendant l'activation et ACTIVATE_UC_OBJECT ne peut éventuellement pas reconnaître les erreurs éventuelles. Dans ce cas, le code retour renvoyé est toujours le RunID.
Post-Script
Erreur de script dans l'objet	RunID	Le post traitement est traité à la fin de l'exécution et ne se trouve donc pas dans la zone d'activation. Les erreurs ne sont donc pas reconnues.

Un objet ne peut pas s'auto-activer par la fonction de script. On évite ainsi les boucles infinies qui pourraient paralyser tout le système AE.

Attention : le paramètre WAIT ne peut pas être utilisé en même temps qu'une heure de début est indiquée.

Les paramètres de la fonction script doivent être organisés dans un certain ordre. Si vous omettez des paramètres, il faut quand même indiquer les virgules correspondantes (voir les exemples suivants).

L'élément de script permet d'écrire les Transactions ouvertes dans la base de données.

Exemples

Dans le premier exemple, un Job "Statut" est activé, ce qui provoque un contrôle du code retour.

:SET &ACTOBJ# = ACTIVATE_UC_OBJECT(STATUT)

:IF &ACTOBJ# = "0"
:   SET &NUMERR# = SYS_LAST_ERR_NR()
:   SET &ERRINS# =SYS_LAST_ERR_INS()
:   SET &MESSAGE# = GET_MSG_TXT(&NUMERR#,&ERRINS#)
:   SET &RET# = SEND_MAIL("jean.dupont@automic.com",,&MESSAGE#, "Veuillez vérifier. Merci !")
:ENDIF

Dans le deuxième exemple, l'objet est activé avec une date logique.

:SET &ACTOBJ# = ACTIVATE_UC_OBJECT(STATUT,,"JJ.MM.AA:01.12.00")

Le Workflow GS.SEMAINE doit être exécuté mi-juillet, le soir.

:SET &ACTOBJ# = ACTIVATE_UC_OBJECT(GS.SEMAINE,,, "MEZ", "2005-07-15 18:00:00")

Les variables du Job GS.FIN doivent également être héritées.

:SET &ACTOBJ# = ACTIVATE_UC_OBJECT("GS.FIN",,,,, PASS_VALUES)

Rubriques connexes :

Elément de script	Description
RESTART_UC_OBJECT	Répète l'exécution d'une tâche.
CANCEL_UC_OBJECT	Interrompt un objet activé.
GET_UC_OBJECT_NR	Indique le numéro courant (RunID) d'un objet activé.
CREATE_OBJECT	Crée un objet (uniquement Groupe Calendrier, Login et Variable).
:ON_ERROR	Détermine les réactions associées à certaines erreurs ou certains messages de script.

Elément de script - Activation d'objets

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

Généralités sur les scripts
Elément de script - Liste alphabétique
Elément de script - Division fonctionnelle