Variables et objets VARA
Les variables et objets VARA vous permettent de définir des espaces réservés pour les valeurs à utiliser dans les objets exécutables. Cette rubrique différencie les différents types de variables et d'objets VARA proposés dans Automation Engine. Si vous êtes développeur et concepteur d'objets, vous pouvez créer des variables et des objets VARA pour les utiliser dans les objets exécutables. Si vous êtes administrateur système, vous devez gérer des variables client et système, ainsi que des objets VARA.
Cette rubrique contient les sujets suivants :
Présentation
Lorsqu'une tâche est générée, le système résout les variables et les référence à des objets VARA pour récupérer les valeurs de diverses sources. Les valeurs des variables et des objets VARA sont résolues au moment de l'activation ou de l'exécution, selon la définition de la page Attributs, dans la définition d'objet. Pour plus d'informations, voir Générer à l'activation ou à l’exécution.
Objets VARA
Les objets VARA sont des entités ayant leurs propres attributs, comme n'importe quel autre objet de Automation Engine. Les types d'objets VARA disponibles sont les suivants :
- Objets VARA prédéfinis pour les valeurs client et système
- Objets VARA définis par l'utilisateur
Si vous êtes administrateur, vous devez définir des paramètres système déterminant les actions à entreprendre lorsque les objets VARA ne peuvent pas être résolus. Pour plus d'informations, voir VARA_ERROR_ON_REPLACEMENT dans UC_CLIENT_SETTINGS.
Objets VARA prédéfinis pour les valeurs client et système
Automation Engine fournit des objets VARA, prédéfinis dans le client 0, qui stockent les valeurs client et système. Ces objets contrôlent le comportement du système et des clients. L'accès à ce type d'objet VARA est généralement limité aux administrateurs.
Les objets VARA contenant des paramètres système doivent rester dans le client 0.
Les objets VARA régissant le comportement des clients et de leurs processus peuvent être conservés dans leurs clients respectifs.
Pour plus d'informations, voir Liste des objets VARA pour les valeurs système et client.
Remarque : Vous ne pouvez pas utiliser des objets VARA prédéfinis dans les formulaires de jobs.
Objets VARA définis par l'utilisateur
Si vous êtes développeur et concepteur d'objets, vous pouvez créer des objets VARA pour conserver et utiliser des valeurs. Vos objets VARA peuvent récupérer les valeurs de diverses sources (bases de données, répertoires, etc.) de manière dynamique. Vous pouvez également leur affecter des valeurs statiques. Les objets VARA définis par l'utilisateur ne sont pas fournis avec l'installation. Cependant, Automation Engine fournit des modèles pour divers types d'objets VARA définis par l'utilisateur. Pour plus d'informations, voir Objets VARA.
Les variables d'agents conservent les paramètres et informations relatives aux agents. En tant qu'objets VARA virtuels, elles sont disponibles soit dans le client 0, soit dans la base de données. Pour obtenir une liste de toutes les variables d'agents disponibles, voir Liste des variables d'agents.
Remarque : Vous ne pouvez pas définir de valeurs dans les variables d'agents par un script.
Si vous êtes administrateur, vous devez spécifier toutes les variables d'agents dans la section [VARIABLES] du fichier INI de l'agent. Cela vous permet de vous assurer que les valeurs des variables sont définies conformément à votre environnement. Par exemple :
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=NSK
UC_EX_PATH_BIN=$data01.uc4
UC_EX_PATH_CACHE=c:\AE11\agents\windows\CACHE\0100\
UC_EX_PATH_JOBREPORT=$data01.
UC_EX_JOB_MD=$data01.uc4.ucxjns1r
Utilisez les éléments de script, tels que GET_VAR pour récupérer les valeurs de la variable d'agent.
Syntaxe
GET_VAR (Agent variable,Agent name)
Variables
Automation Engine utilise divers types de variables pour enregistrer et transmettre les valeurs. Certaines variables sont prédéfinies et ne peuvent être définies par les utilisateurs, tandis que d'autres peuvent être créées librement. Les variables sont résolues lorsque la tâche est générée. À la différence des objets VARA, les variables sont conservées dans les scripts et ne sont pas des objets en tant que tels.
Variables prédéfinies pour les valeurs système et objet
Automation Engine propose des variables prédéfinies pour récupérer les valeurs des propriétés système et objet. Vous pouvez utiliser ces variables prédéfinies dans les scripts et les définitions d'objets. Dans les scripts, les variables sont résolues et remplacées par des valeurs lors du traitement du script. Dans les définitions d'objets, les valeurs de ces variables sont remplacées après que le script ait été traité. Vous pouvez utiliser des variables prédéfinies pour modifier les attributs d'un objet.
Remarques :
- N'utilisez pas de variable système ou objet dans son propre attribut d'objet. Si des variables sont utilisées dans leur propre attribut, elles ne sont pas remplacées lors du traitement du script.
- Ne définissez pas d'attributs qui se référencent mutuellement via des variables. Les attributs qui se référencent mutuellement via des variables ne sont pas remplacés lors du traitement du script.
Pour plus d'informations, voir Liste des variables pour les valeurs système et objet.
Vous pouvez créer des variables de scripts pour conserver et transmettre des valeurs dans les scripts que vous définissez dans les pages Traitement des objets exécutables. Vous pouvez également définir certaines propriétés d'objets avec des variables de scripts. Utilisez des éléments de script pour définir et déclarer des variables de scripts, et affecter des valeurs à une variable de script. Les variables de scripts jouent un rôle fondamental lors de l'écriture des scripts.
Pour plus d'informations :
- Logique fonctionnelle avec les scripts
- Éléments de script et syntaxe
- Écrire des scripts
- Pages Traitement
- Référence du script Automation Engine
Vous pouvez définir des variables spécifiques aux objets pour récupérer les valeurs des propriétés de l'objet (valeurs des champs de saisie de l'objet) ou de son instance d'exécution (la tâche). Vous pouvez définir des variables de l'objet dans la page Variables d'un objet exécutable ou utiliser une instruction de script :PSET dans les pages Traitement. Ces variables d'objet sont enregistrées dans la définition de l'objet. Les tâches enfants héritent des variables d'objet de l'objet parent.
Pour plus d'informations :
Si vous avez défini des valeurs dans un PromptSet, ces valeurs sont enregistrées sous forme de variables PromptSet. Lorsque le PromptSet est affecté à un objet, ces valeurs sont utilisées pendant son exécution. Cependant, elles peuvent être remplacées de l'une des manières suivantes :
-
Manuellement à l'exécution de l'objet
Vous pouvez spécifier des valeurs différentes lors de l'appel du PromptSet.
En définissant différentes valeurs dans la page PromptSet
Lorsque l'objet est exécuté à partir d'un workflow ou d'un schedule
Pour plus d'informations :
- Objets PromptSet (PRPT)
- Hériter des variables d'objets et de PromptSet
- Exemples : Hériter des variables d'objet
Stocker des variables dans le tampon de lecture
Le tampon de lecture conserve les valeurs temporairement, de sorte que les autres tâches peuvent utiliser ces valeurs. Les valeurs enregistrées dans le tampon de lecture sont supprimées après avoir été utilisées. Si un processus contient plusieurs tâches, les variables du tampon de lecture enregistrent leurs valeurs par ordre chronologique. Ces valeurs sont également utilisées selon l'ordre chronologique. Ainsi, dans un processus de trois tâches, à la première utilisation de la fonction ACTIVATE_UC_OBJECT, ce sont les valeurs conservées par la première tâche qui sont utilisées.
Utilisez les instructions de script pour enregistrer les valeurs des variables de script ou des variables de PromptSet dans le tampon de lecture lorsque vous activez un objet via un script avec ACTIVATE_UC_OBJECT.
Automation Engine intègre des variables prédéfinies (variables UC_CAUSE* ) qui récupèrent les détails d'une tâche et conservent temporairement les valeurs dans le tampon de lecture. Les valeurs sont conservées dans le tampon de lecture lorsque vous spécifiez des actions alternatives ou de suivi (l'exécution d'un autre objet) si une condition ou un statut ne correspondent pas.
- Pour les objets exécutables :
- Si le statut d'une tâche n'est pas dans la plage spécifiée à la section Traitement du code retour de la Page Exécution de la définition d'objet
- Si le statut d'une tâche n'est pas celui qui a été spécifié à la section Évaluation du résultat de la tâche de la Page Attributs
- Workflows :
- Si une tâche ne peut pas être exécutée au moment spécifié par le point de contrôle, voir Heure & dépendances
- Si les conditions définies pour une tâche à la section Dépendances (onglet Heure & dépendances ) ne sont pas remplies
- Si la durée d'exécution d'une tâche diffère de la valeur attendue, telle que définie dans l'onglet Propriétés de la durée d'exécution
-
Pour les objets Schedule :
- Si la durée d'exécution d'une tâche diffère de la valeur attendue définie dans les propriétés de tâche Durée d'exécution
- Si le statut d'une tâche diffère de celui spécifié dans les paramètres Résultat, voir Définir les objets Schedule
-
Notifications STANDARD et ALARM :
- Si l'objet escalade en exécutant un autre objet CALL, voir Notification (CALL)
Pour plus d'informations :
La syntaxe des variables est la suivante :
- Les noms des variables commencent par une esperluette (&).
- Le deuxième caractère après l'esperluette de début ne peut être ni un nombre, ni le digne du dollar ($). Exception : Les variables des valeurs système et objets prédéfinies commencent par &$.
- Les noms des variables peuvent comporter jusqu'à 32 caractères. L'esperluette du début n'est pas comptée. La longueur de la valeur renvoyée n'est pas limitée.
- Les noms des variables peuvent contenir toutes les lettres de l'alphabet, les chiffres de 0 à 9 et les caractères spéciaux suivants : $, _, @, § et #.
- N'utilisez pas d'accents.
- Les noms des variables ne respectent pas la casse.
Exemples :
- Variables pour les valeurs système et objet : &$CLIENT#, &$DATE_format#, &$DATABASE_NAME#
- Variables : &HEADER#, &ROW#, &parentname#
Dans les objets exécutables, vous pouvez extraire les valeurs des variables et objets VARA de plusieurs manières.
- Sélectionnez l'option Variable dans la liste déroulante Source de la section Événement de base de données lors de la définition d'un Événements BDD.
- Saisissez le nom de la variable dans les champs de saisie et les listes déroulantes, selon ce qui est pris en charge.
-
Cliquez sur l'icône de la variable (le cas échéant) pour ouvrir la boîte de dialogue du sélecteur de variables contenant les variables regroupées comme suit :
-
Propriétés système
Variables système et client pour extraire les valeurs du système Automation Engine. Pour obtenir une liste complète, voir Propriétés système.
-
Propriétés objet
Variables d'objet, pour extraire les valeurs qui sont spécifiées dans les propriétés de l'objet ou dérivées de son instance d'exécution (tâche).
-
Variables Automation
Liste des objets VARA client et système.
-
Objets Variable
Liste des objets VARA définis par l'utilisateur et disponibles dans le client actuel.
-
Pour définir les attributs d'objet avec les valeurs des objets VARA, saisissez le nom de l'objet VARA entre accolades. Vous pouvez également spécifier les paramètres de clé et de colonne pour sélectionner une valeur spécifique dans l'objet VARA.
Syntaxe
{ Objet variable [, Clé [, Numéro de colonne ]] }.
Exemple
L'expression suivante est remplacée par la valeur d'un objet VARA lors de la génération de la tâche :
{MONITOR_SP1, 2, 3}
Où
- MONITOR_SP1 est le nom de l'objet VARA
- 2 est la clé
- 3 est la colonne
Les paramètres Clé et Colonne sont optionnels. Si vous ne spécifiez pas de paramètres, le système sélectionne la valeur comme suit, selon le type d'objet VARA.
- Objet VARA statique : l'expression est remplacée par la valeur définie dans la première colonne de l'objet VARA.
- Objet VARA dynamique : le numéro de colonne est remplacé par la valeur de la colonne Résultats.
Pour extraire les valeurs de variables et d'objet VARA dans les scripts, procédez comme suit :
-
Appelez les variables de scripts, de tampon de lecture, PromptSet, ainsi que les variables système et objet directement dans vos scripts. Pour plus d'informations, voir Éléments de script et syntaxe et Éléments de script pour variables et objets VARA.
-
Utilisez les fonctions de script, telles que GET_VAR pour extraire les valeurs enregistrées dans les objets VARA. À la différence des variables de script, vous ne pouvez pas appeler directement des objets VARA prédéfinis dans les scripts Automation Engine. Pour plus d'informations, voir Éléments de script pour variables et objets VARA.
Exemple :
Les scripts suivants extraient le chemin du répertoire dans lequel l'agent (WIN01) enregistre les rapports des jobs.
:SET &jobreport# = GET_VAR('UC_EX_PATH_JOBREPORT','WIN01') -
Utilisez la fonction de script GET_ATT pour extraire la valeur d'un attribut d'objet. Si l'attribut d'objet contient une variable, telle qu'une variable d'objet, le système résout la variable et extrait la valeur. Cette fonction ne modifie, ni ne remplace la variable elle-même.
Exemple :
Le script suivant extrait la valeur d'un attribut d'objet avec la fonction de script GET_ATT.
:SET&MYINTERNALACCT# = GET_ATT(&$INT_ACCOUNT#) -
Utilisez les instructions de script :READ pour extraire les valeurs enregistrées dans le tampon de lecture. Pour plus d'informations, voir :READ et :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.
Voir aussi :