Manuel Utilisateur > Objets > Liste alphabétique > Onglet Variable

 Onglet Variable

L'onglet Variable est spécifique à un type d'objet et on ne peut le trouver sous cet aspect que dans les objets variable. Selon la source de la variable, vous pouvez définir les valeurs manuellement (variables statiques) ou configurer les valeurs qui doivent être récupérées dynamiquement.

Objet : Variable
Classe d'objet :
Objet actif
Type d'objet (description courte) :
VARA

Informations générales

Le contenu de l'onglet Variable dépend de la source qui est définie lors de la création de l'objet variable. Cette source n'est pas modifiable. Les valeurs des variables peuvent être fournies dynamiquement par une base de données (SQL), par d'autres objets variable (multi) ou par un répertoire de la machine d'un agent (liste de fichiers) sous la forme d'une liste. Les paramètres correspondants se trouvent dans l'onglet Variable. Dans cet onglet vous pouvez aussi saisir des valeurs manuellement pour les variables statiques.

Les variables statiques se composent d'une clé et de cinq colonnes de valeurs. Le nombre de colonnes des variables dynamiques dépend de la source de données est n'est pas limité.

L'objet variable statique de type XML constitue une exception. Il ne contient qu'une seule colonne de valeurs, qui ne peut comporter que des structures XML valides.

Les éléments de script suivants peuvent être utilisés pour traiter le contenu :

Utilisez la fonction de script PREP_PROCESS_VAR pour accéder à une partie ou à toutes les entrées d'une variable. Ceci prépare le traitement d'une séquence de données.

Pour certaines variables dynamiques, vous pouvez utiliser des variables PromptSet dans certains champs de l'onglet Variable. La colonne des variables PromptSet liste ces champs (dans le tableau ci-dessous avec les descriptions des champs).
L'utilisation de ces champs est nécessaire pour la création de boîtes de dialogue PromptSet dynamiques

Seules les variables PromptSet sont prises en charge dans les champs de l'onglet Variable (les variables prédéfinies, d'objet et de script ne sont pas autorisées). Gardez le à l'esprit quand vous utilisez des objets modèles fournis par les variables backend, car leurs champs comportent par défaut les noms de variables PromptSet.

Notez que lorsque vous utilisez des variables de base de données (types SQL, SQL SECURE, SQLI, et SQLI SECURE), les champs binaires ne sont pas pris en charge. Les données binaires résultant d'une requête SQL provoqueront une erreur dans l'aperçu ou lorsque les valeurs sont récupérées lors de l'exécution.

Notez que dans les variables de base de données (SQL, SQLI, SQL SECURE, SQL SECURE types), pour des raisons techniques, le système ne vérifiera pas les instructions SQL traitées. Ceci signifie aussi que vous pouvez modifier ou supprimer des enregistrements de données à l'aide d'objets variable. Pour des raisons de sécurité, Automic recommande de limiter en conséquence l'accès utilisateur. Si possible, déployez un utilisateur de base de données ayant des droits en lecture seule pour les variables qui ont accès à une base de données externe (SQL, SQL SECURE). Pour les variables SQL internes (SQLI, SQLI SECURE), vous pouvez limiter l'accès aux objets au moyen d'un privilège (création et modification des variables SQL internes).

Selon le type de données, les variables SQL et SQLI renvoient la valeur '''' (chaîne de caractères, date, heure, horodatage) ou 0 (nombre) pour les valeurs NULL.


Statique

Pour les variables statiques (paramètre source : statique), vous pouvez saisir les valeurs de l'onglet Variable manuellement ou à l'aide des éléments de script :PUT_VAR ou :PUT_VAR_COL. Chaque saisie d'une ligne du tableau est composée d'une clé et de 5 valeurs et dépend des paramètres spécifiés dans l'onglet Attributs.

Notez que la clé ne doit pas commencer par le caractère &. Sinon l'objet variable pourra être enregistré, mais une erreur surviendra lors de l'accès à ces lignes par un script.

Une clé peut contenir au maximum 200 caractères.

Les paramètres "Type de données" et "Format de sortie" (onglet Attributs) ne se réfèrent qu'à la première colonne de valeurs. Les autres colonnes possèdent toujours le type de données "Texte".

Selon le type de données, les plages de valeurs suivantes sont autorisées :

Type de données

Longueur du contenu

Chaîne

Illimité

Si le paramètre ''Limitation de texte'' est sélectionné (onglet "Attributs"), cette restriction ne concerne que la première colonne de valeurs. 

Nombre

Entre 0 et 2147483647

Horodatage

Valeur de la date et de l'heure en fonction du format de sortie.

Heure Valeur de l'heure en fonction du format de sortie.
Date Valeur de la date en fonction du format de sortie.

Utilisez la fonction recherche pour trouver des objets variable, des clés ou des valeurs.

Le tri des valeurs dépend des paramètres de l'onglet Attributs. Par défaut, la colonne Clé est triée par ordre croissant.

Editeur de cellules

Un éditeur est disponible pour les colonnes de valeurs des objets VARA statiques. Il permet une édition de contenu simple et conviviale. Cet éditeur est utile particulièrement pour la modification de valeurs longues.

Pour ouvrir l'éditeur, cliquez sur une cellule de la colonne de valeurs. Une icône crayon apparaît dans le coin droit de la cellule; cliquez sur cette icône pour ouvrir l'éditeur.
Vous pouvez également appuyer sur les touches du clavier ''MAJ+F2'' pour ouvrir la fenêtre de l'éditeur de cellules.

 

L'éditeur contient les fonctions suivantes, qui sont disponibles par le biais de la barre d'outils de l'éditeur ou du menu contextuel :


XML

L'objet variable XML est un type spécial d'objet variable statique. Bien qu'il soit par définition un objet statique, il contient une colonne de valeurs au lieu de cinq. En plus, seules les structures XML valides sont le type de données qui peut être utilisé. Il peut être utilisé pour enregistrer provisoirement des données complexes comme la structure XML du système Automation Engine. Ces données peuvent ensuite être référencées et utilisées dans les objets PromptSet, dans les objets script et dans d'autres contextes de script du système.

Si vous essayez d'utiliser des types de données autres que XML ou des structures XML incomplètes avec cet objet, un message d'erreur s'affiche.

Il est possible d'utiliser des expressions XPath avec l'objet variable XML, tel que décrit également dans les sections spécifiques des fonctions de script correspondantes. En fonction de la base de données avec laquelle le système Automation Engine est utilisé, des expressions XPath individuelles peuvent fonctionner différemment. Dans ce cas, veuillez consulter le fournisseur de la base de données.

Si vous utilisez l'Automation Engine avec une base de données Oracle, les valeurs des attributs des données XML utilisées dans cet objet variable ne doivent pas contenir plus de 4 000 caractères.

Champ/élément

Description

Variables PromptSet
Paramètres    
Clé Clé de la structure des données XML saisies dans le champ Valeur. Vous pouvez définir une clé individuelle.
Valeur Données à enregistrer et à utiliser au format XML.

Pour éditer des données XML, vous pouvez utiliser l'éditeur de cellules que l'on appelle en cliquant sur l'icône crayon, lorsque la cellule Valeur est activée à l'aide d'un clic, tel qu'indiqué ci-dessous. Consultez la catégorie Statique ci-dessus pour obtenir des détails sur l'éditeur de cellules et son utilisation.

 


EXEC

La variable dynamique EXEC peut être utilisée comme intermédiaire, exécutant la lecture des valeurs renvoyées des objets exécutés, ce qui peut affecter l'exécution ultérieure d'objets ou déclencher l'exécution d'objets. En tant qu'utilisateur, vous pouvez enregistrer ces lectures dans des variables de script définies dans EXEC. La variable EXEC n'a pas de paramètres de saisie.

Vous pouvez utiliser l'objet variable dynamique EXEC afin de lire et de transférer les valeurs d'un autre objet activable. Dans ce cas, les paramètres de l'objet variable dynamique EXEC doivent utiliser les mêmes noms que ceux utilisés dans la variable PromptSet de l'objet activable qui fournit les codes retour.

Champ/élément

Description

Variables PromptSet

Objet activable

Nom de l'objet Automation Engine.

Il est recommandé d'utiliser les types d'objet suivants avec la variable VARA.EXEC :

  • Job, script, job de transfert de fichier, événement, gestionnaire de tâches distantes, Workflow, groupe, notification

Les types d'objets activables suivants ne doivent pas être utilisés avec la variable VARA.EXEC : Schedule et Cockpit.

Notez qu'à ce stade, aucune vérification de l'objet activable n'est réalisée, si le bon type d'objet a été sélectionné. Un message d'erreur sera affiché dès que l'objet est exécuté.

 
Variable de résultat

Nom de la variable de script utilisée pour la valeur renvoyée par l'objet activable.

 
Paramètres

Liste des variables disponibles dans l'objet activable. Leurs valeurs peuvent être :

  • des valeurs directes, par exemple 5342 ou
  • des variables référencées, par exemple &reftext#.
Aperçu Cliquez sur ce bouton pour afficher un aperçu des valeurs résultat enregistrées ou transférées.  

SQL

Les valeurs des variables qui utilisent la source SQL sont chargées à partir d'une base de données externe à l'aide des instructions SQL. Dans ce cas, la base de données du système AE ne peut pas être utilisée.
La source de variable ''SQL - interne'' peut être spécifiée pour utiliser la base de données AE.

Notez que les variables SQL requièrent que l'agent de base de données soit configuré et démarré de manière individuelle. Par conséquent, il n'est pas utilisable pour exécuter des jobs de base de données et des événements. Vous trouverez des informations à ce sujet dans le manuel d'installation de l'agent de base de données.

Pour modifier le temps maximal accordé pour résoudre les variables SQL, utilisez le paramètre VAR_TIMEOUT (UC_HOSTCHAR*).

Les longueurs des valeurs sont toujours illimitées. Si une limite de texte maximale a été choisie dans l'onglet Attributs, celle-ci ne s'applique qu'à la première colonne de valeurs. Les éléments dépassant cette limite seront exclus.

Les caractères non imprimables sont automatiquement supprimés (caractères ASCII 0x00 à 0x20 et 0x7F).

Le nombre maximal de lignes retournées est déterminé par le paramètre SQLVAR_MAX_ROWS dans la variable UC_SYSTEM_SETTINGS. 

L'Automation Engine ne supprime pas les caractères espace à la fin des valeurs des variables SQL.

Champ/élément

Description

Variables PromptSet

Connexion à la base de donées

 

 

Connexion

Objet connexion de type base de données qui contient les paramètres de connexion pour la base de données.

Login

Objet Login qui enregistre le nom de l'utilisateur de la base de données et le mot de passe associé.

Si aucun objet Login n'est indiqué et si l'option Appliquer le Login utilisateur par défaut n'est pas cochée, les données de connexion sont fournies par l'objet connexion pour l'accès à la base de données. Si aucune information de connexion ne s'y trouve non plus, une erreur survient à la résolution de la variable.

Appliquer le Login utilisateur par défaut

La sélection d'un objet Login pour les variables SQL est aussi possible dans les objets utilisateur. Si le paramètre Appliquer le Login utilisateur par défaut est activé, l'objet Login qui a été attribué à l'utilisateur connecté est utilisé. L'objet Login configuré dans la variable est alors ignoré. Si aucun Login n'est défini ou si un Login non valide est défini dans l'objet utilisateur, l'accès à la variable génère une erreur.

 
SQL    
Instruction SQL

Champ texte pour spécifier des instructions SQL. Ces instructions SQL sont utilisées pour sélectionner des enregistrements de données de la base de données et les attribuer aux valeurs de variable.

Exemple : select * from col

Notez que toutes les instructions SQL sont autorisées dans ce champ texte. Vous pouvez même modifier ou supprimer des entrées de la base de données.

AE ne vérifie pas si les instructions SQL contiennent des erreurs ou sont dangereuses. Elles sont passées à la base de données sans vérification. Une erreur d'exécution ne peut donc survenir que lors de l'accès à la base de données, qui a lieu au moment de la résolution des variables.

Notez que vous devez utiliser le paramètre VAR_SECURITY_LEVEL(UC_SYSTEM_SETTINGS) dans les instructions SQL si vous utilisez des variables prédéfinies ou d'autres objets variable. Sinon, aucun remplacement n'est effectué (par défaut) et une erreur de base de données se produit.

Taille maximale : 4096 caractères

Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne résultat. Les autres colonnes contiennent les valeurs des colonnes de la base de données qui ont été retournées par la requête SQL. La colonne de résultat peut se composer d'une combinaison des colonnes de valeurs et d'autres caractères au choix. Ceci est défini par le format du résultat.

Les numéros de colonne qui ont été indiqués entre accolades { } dans le champ Format du résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du retour : {1}_{2}
Colonne de résultat : JOB01_WIN01

La colonne de résultat correspond à la première colonne de valeur si aucun format du résultat n'est indiqué.

Les limitations des variables (valeur min., valeur max. et limiter le texte) n'influencent pas la colonne de résultat, mais uniquement la première colonne renvoyée. Si la valeur de cette colonne dépasse la plage autorisée, la ligne en question est ignorée et n'est pas disponible via l'objet variable.


 
Aperçu

Exécute les instructions SQL et affiche le résultat dans une nouvelle fenêtre. Ainsi, les instructions SQL sont vérifiées et d'autres erreurs peuvent être identifiées (par exemple, le type de données de l'objet variable ne correspond pas à celui de la base de données) .

L'agent de base de données envoie les données pour l'aperçu dans un message à l'Automation Engine. Si ce message dépasse la longueur de message maximale acceptée par un processus serveur (paramètre MaxMsgSize= dans le fichier INI de l'Automation Engine, valeur par défaut : 3145 728 octets). Dans ce cas, limitez le résultat à l'aide d'un nombre de lignes maximal ou à l'aide d'instructions SQL.

 

SQL Secure

SQL SECURE ressemble au type SQL et exécute également les instructions SQL sur une base de données externe. Contrairement au type SQL, vous pouvez utiliser toutes les variables prises en charge à l'intérieur des instructions SQL, sans risque d'une injection SQL dans la base de données. Les variables sont remplacées, indépendamment du paramètre VAR_SECURITY_LEVEL (UC_SYSTEM_SETTINGS).

Vous ne pouvez pas spécifier de variables directement dans le champ Requête SQL, mais vous pouvez les inclure dans des paramètres de liaison. Ces paramètres de liaison sont gérés dans les tables correspondantes et peuvent contenir des variables prédéfinies, des caractères de remplacement pour les objets VARA et des variables PromptSet. Dans le script SQL, utilisez le caractère ? à l'emplacement où les paramètres de liaison doivent être insérés.

Pour des raisons techniques, le système ne peut pas vérifier si seules des commandes SELECT sont utilisées dans le SQL de la variable. Pour empêcher l'exécution d'instructions SQL autre que SELECT, Automic recommande de déployer un utilisateur de la base de données qui n'a que des droits de lecture.

Ce comportement particulier de remplacement des variables ne s'applique qu'aux commandes SQL. Pour utiliser les variables PromptSet dans les champs connexion et Login, le paramètre VAR_SECURITY_LEVEL = 3 est encore requis.

Ce type de variable requiert également un agent de base de données démarré en mode de service BD et qui est en version v9 SP3 ou supérieure. Les anciens agents ne prennent pas en charge le type de variable SQL SECURE. Le nombre maximal de lignes retournées est défini par la variable UC_SYSTEM_SETTINGS, paramètre SQLVAR_MAX_ROWS.

Champ / Elément

Description

Variables PromptSet

Connexion à la base de données

 

 

Connexion

Objet connexion de type base de données qui contient les paramètres de connexion pour la base de données sélectionnée.

Login

Objet Login qui enregistre le nom de l'utilisateur de la base de données et le mot de passe associé.

Les données de connexion pour l'accès à la base de données sont fournies par l'objet connexion si aucun objet Login n'est indiqué et si l'option Appliquer le Login utilisateur par défaut n'est pas cochée. Une erreur survient à la résolution de la variable et cet objet ne contient aucune information de connexion.

Appliquer le Login utilisateur par défaut

Vous pouvez aussi sélectionner un objet Login pour les variables SQL dans les objets utilisateur. Si le paramètre Appliquer le Login utilisateur par défaut est activé, l'objet Login qui a été attribué à l'utilisateur connecté est utilisé. L'objet Login configuré dans la variable est alors ignoré. Si aucun Login n'est défini ou si un Login non valide est défini dans l'objet utilisateur, l'accès à la variable génère une erreur.

 
Requête SQL    
Instruction SQL

Instructions SQL utilisées pour sélectionner certains éléments de la base de données qui servent de valeurs de variables.

Les variables qui sont indiquées directement dans SQL ne sont pas remplacées. Pour inclure des variables, utilisez les paramètres de liaison.

Taille maximale : 4096 caractères

Paramètres de liaison

Tableau contenant les paramètres de liaison.

Utilisez les paramètres de liaison pour ajouter des valeurs de variables aux instructions SQL. Vous pouvez utiliser des variables prédéfinies, des variables PromptSet et des caractères de remplacement pour les objets VARA comme éléments de ce tableau. Chaque ligne représente un paramètre de liaison.

Les paramètres de liaison permettent d'ajouter des valeurs de variables dans les commandes SQL. Vous pouvez utiliser des variables de script, des variables d'objet, des variables prédéfinies et des caractères de remplacement pour les objets VARA que vous saisissez dans cette table. Chaque ligne représente un paramètre de liaison.

La variable VAR_SECURITY_LEVEL (UC_SYSTEM_SETTINGS) n'impose aucune limitation.

Dans les instructions SQL, vous devez utiliser le caractère ? à chaque emplacement où la valeur remplacée d'un paramètre de liaison doit être insérée. Un paramètre de liaison doit exister pour chaque ?. Assurez-vous de maintenir l'ordre correct du tableau. Notez que vous ne pouvez pas utiliser des paramètres de liaison plusieurs fois.

Si une variable indiquée n'existe pas, aucune valeur ne pourra être remplacée. Dans ce cas, le nom de la variable est utilisé, ce qui peut provoquer une erreur lors de la résolution de la variable.

Les paramètres sont numérotés automatiquement et ne peuvent pas être modifiés. Pour supprimer des paramètres de liaison spécifiques, sélectionnez-les et tapez sur la touche SUPPR.

Vous pouvez utiliser des noms de variables comme paramètres de liaison, avec la valeur de votre choix.

Les types de données et les formats de saisie suivants sont pris en charge pour les paramètres de liaison :

  • Date : aaaa-mm-jj
  • Heure : hh:mm:ss
  • Horodatage : aaaa-mm-jj hh:mm:ss
  • String : chaîne de caractères au choix
  • Booléen : valeurs possibles: 0 / 1 ou vrai / faux
  • Nombre : pas de séparateur des milliers, un point en tant que séparateur de décimale

Les autres types de champ de la base de données et les autres formats ne sont pas pris en charge. Les types de données ne sont pas convertis (pas de conversion d'horodatage à date). Si une valeur non valide est insérée, une erreur survient lors de l'exécution de la commande SQL.

 
Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne résultat. Les autres colonnes contiennent les valeurs des colonnes de la base de données qui ont été retournées par la requête SQL. La colonne de résultat peut se composer d'une combinaison des colonnes de valeurs et d'autres caractères au choix. Ceci est défini par le format du résultat.

Les numéros de colonne qui ont été indiqués entre accolades { } dans le champ Format du résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du retour : {1}_{2}
Colonne de résultat : JOB01_WIN01

La colonne de résultat correspond à la première colonne de valeur si aucun format du résultat n'est indiqué.

Les limitations des variables (valeur min., valeur max. et limiter le texte) n'influencent pas la colonne de résultat, mais uniquement la première colonne renvoyée. Si la valeur de cette colonne dépasse la plage autorisée, la ligne en question est ignorée et n'est pas disponible via l'objet variable.

 
Aperçu

Exécute les instructions SQL et affiche le résultat dans une nouvelle fenêtre. Ainsi, les instructions SQL sont vérifiées et d'autres erreurs peuvent être identifiées (par exemple, le type de données de l'objet variable ne correspond pas à celui de la base de données) .

L'agent de base de données envoie les données pour l'aperçu dans un message à l'Automation Engine. Une erreur survient si ce message dépasse la longueur de message maximale acceptée par un processus serveur (paramètre MaxMsgSize= dans le fichier INI de l'Automation Engine, valeur par défaut : 3145 728 octets). Dans ce cas, limitez le résultat à l'aide d'un nombre de lignes maximal ou à l'aide d'instructions SQL.

 

SQL - interne

Si une variable a une source SQL - interne, les valeurs sont récupérées à partir de la base de données AE au moyen d'instructions SQL. Il n'est pas nécessaire d'indiquer de connexion ni de Login car l'accès à la base de données reste interne.

Cette fonctionnalité doit être activée par l'administrateur au moyen du paramètre SQLVAR_INTERNAL dans la variable UC_SYSTEM_SETTINGS. Le privilège utilisateur "Créer et modifier les variables SQL-interne" est requis.

La longueur des valeurs n'est jamais limitée. Si une limite de texte maximale a été choisie dans l'onglet Attributs, celle-ci ne s'applique qu'à la première colonne de valeurs. Les éléments dépassant cette limite seront exclus.

Le nombre maximal de lignes retournées est déterminé par le paramètre SQLVAR_MAX_ROWS de la variable UC_SYSTEM_SETTINGS. 

Une erreur de conversion qui se produit pendant l'exécution des instructions SQL sur des bases de données MS SQL Serveur peut provoquer un blocage ou une transaction incohérente (avec un résultat imprévu). Automic recommande de vérifier très attentivement les commandes dans les variables SQLI des utilisateurs car, pour des raisons techniques, l'Automation Engine ne peut pas détecter de telles erreurs.

Champ/élément

Description

Variables PromptSet
SQL    
Instruction SQL

Champ texte pour spécifier des instructions SQL. Ces instructions SQL permettent de déterminer les enregistrements de données de la base de données AE qui servent de valeurs de variables.

Exemple : select * from OH

Pour exécuter des instructions SQL, le type de base de données AE utilisé doit être sélectionné : SQL Serveur, Oracle ou DB2. Les instructions SQL restent enregistrées pour chaque type de base de données.

Notez que les instructions SQL ne sont pas vérifiées. Vous pouvez même modifier ou supprimer des entrées de la base de données.

AE ne vérifie pas si ces commandes SQL contiennent des erreurs ou sont dangereuses. Elles sont passées à la base de données sans vérification. Une erreur d'exécution ne survient donc que lors de l'accès à la base de données, c'est à dire lors de la résolution des variables.

Notez que pour utiliser des variables prédéfinies ou d'autres objets variable dans les instructions SQL, le paramètre VAR_SECURITY_LEVEL (UC_SYSTEM_SETTINGS) doit être défini en conséquence. Sinon, les variables ne sont pas remplacées (par défaut) et une erreur de base de données se produit.

Taille maximale : 4096 caractères

Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne de résultat. Les autres colonnes contiennent les valeurs des colonnes de la base de données qui sont retournées par la requête SQL. La colonne de résultat peut se composer d'une combinaison des colonnes de valeurs et d'autres caractères au choix. Ceci est défini par le format du résultat.

Les numéros de colonne qui ont été indiqués entre accolades { } dans le champ Format du résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du résultat : {1}_{2}
Colonne de résultat : JOB01_WIN01

La colonne de résultat correspond à la première colonne de valeur si aucun format du résultat n'est indiqué.

Les limitations des variables (valeur min., valeur max. et limiter le texte) n'influencent pas la colonne de résultat, mais uniquement la première colonne renvoyée. Si des valeurs de cette colonne dépassent la plage autorisée, les lignes en question sont exclues et ne sont pas disponibles via l'objet variable.


 
Aperçu

Exécute les instructions SQL et affiche le résultat dans une nouvelle fenêtre. Ainsi, les instructions SQL peut être vérifiées et d'autres erreurs peuvent être identifiées (par exemple, le type de données de l'objet variable ne correspond pas à celui de la base de données).

 

SQL interne Secure

Ce type de variable possède la même fonction que "SQL - interne", avec la seule différence que les variables peuvent toujours être insérées dans les commandes SQL (indépendamment du paramètre VAR_SECURITY_LEVEL - UC_SYSTEM_SETTINGS). Pour inclure des variables dans SQL, vous devez utiliser les paramètres de liaison. Ainsi vous ne pouvez pas rédiger d'instructions SQL, ce qui protège la base de données du risque d'une injection SQL.

Comme pour "SQLI interne", les valeurs des variables sont récupérées directement de la base de données AE. Un agent de base de données n'est donc pas requis.

Les variables SQLI SECURE sont liées au paramètre SQLVAR_INTERNAL (variable UC_SYSTEM_SETTINGS) et au privilège "Créer et modifier les variables de SQL-interne".

Pour des raisons techniques, le système ne peut pas vérifier si seules des commandes SELECT sont utilisées dans le SQL de la variable.

Pour déterminer le nombre maximal de lignes retournées, utilisez le paramètre SQLVAR_MAX_ROWS de la variable UC_SYSTEM_SETTINGS.

Champ / Elément

Description

Variables PromptSet
SQL    
Requête SQL

Instructions SQL utilisées pour sélectionner certains éléments de la base de données qui servent de valeurs de variables.

Les variables qui sont indiquées directement dans SQL ne sont pas remplacées. Pour inclure des variables, utilisez les paramètres de liaison.

Taille maximale : 4096 caractères

 
Paramètres de liaison

Tableau contenant les paramètres de liaison.

Les paramètres de liaison permettent d'ajouter des valeurs de variables dans les commandes SQL. Vous pouvez utiliser des variables de script, des variables d'objet, des variables prédéfinies et des caractères de remplacement pour les objets VARA que vous saisissez dans cette table. Chaque ligne représente un paramètre de liaison.

La variable VAR_SECURITY_LEVEL (UC_SYSTEM_SETTINGS) n'impose aucune limitation.

Dans les instructions SQL, vous devez utiliser le caractère ? à chaque emplacement où la valeur remplacée d'un paramètre de liaison doit être insérée. Un paramètre de liaison doit exister pour chaque ?. Assurez-vous de maintenir l'ordre correct du tableau. Notez que vous ne pouvez pas utiliser des paramètres de liaison plusieurs fois.

Si une variable indiquée n'existe pas, aucune valeur ne pourra être remplacée. Dans ce cas, le nom de la variable est utilisé, ce qui peut provoquer une erreur lors de la résolution de la variable.

Les paramètres sont numérotés automatiquement et ne peuvent pas être modifiés . Pour supprimer des paramètres de liaison spécifiques, sélectionnez-les et tapez sur la touche SUPPR.

Vous pouvez utiliser des noms de variables comme paramètres de liaison, avec la valeur de votre choix.

Les types de données et les formats de saisie suivants sont pris en charge pour les paramètres de liaison :

  • Date : aaaa-mm-jj
  • Heure : hh:mm:ss
  • Horodatage : aaaa-mm-jj hh:mm:ss
  • String : chaîne de caractères au choix
  • Booléen : valeurs possibles: 0 / 1 ou vrai / faux
  • Nombre : pas de séparateur des milliers, un point en tant que séparateur de décimale

Les autres types de champ de la base de données et les autres formats ne sont pas pris en charge. Les types de données ne sont pas convertis (pas de conversion d'horodatage à date). Si une valeur non valide est insérée, une erreur survient lors de l'exécution de la commande SQL.

Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne de résultat. Les autres colonnes contiennent les valeurs des colonnes de la base de données qui sont retournées par la requête SQL. La colonne de résultat peut se composer d'une combinaison des colonnes de valeurs et d'autres caractères au choix. Ceci est défini par le format du résultat.

Les numéros de colonne qui ont été indiqués entre accolades { } dans le champ Format du résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du résultat : {1}_{2}
Colonne de résultat : JOB01_WIN01

La colonne de résultat correspond à la première colonne de valeur si aucun format du résultat n'est indiqué.

Les limitations des variables (valeur min., valeur max. et limiter le texte) n'influencent pas la colonne de résultat, mais uniquement la première colonne renvoyée. Si des valeurs de cette colonne dépassent la plage autorisée, les lignes en question sont exclues et ne sont pas disponibles via l'objet variable.

 
Aperçu

Exécute les instructions SQL et affiche le résultat dans une nouvelle fenêtre. Ainsi, les instructions SQL sont vérifiées et d'autres erreurs peuvent être identifiées (par exemple, le type de données de l'objet variable ne correspond pas à celui de la base de données) .

 

Multi

Les variables qui possèdent le paramètre source Multi reçoivent une combinaison des valeurs des deux autres objets variables. Utilisez l'onglet Variable pour définir la variable source et le type de calcul de valeurs.

Champ/élément

Description

Variable 1
Variable 2

Définition des deux objets variable qui servent de sources de valeurs.

La variable 1 détermine le nombre de colonnes. Les valeurs des colonnes de référence des deux variables sont combinées en fonction de l'opération définie. La colonne de référence dépend de la source de la variable : colonne clé (dans les variables statiques), première colonne de valeurs (source de variables : SQL, SQL interne, Multi) ou bien la colonne Liste de fichiers (source de variables : Liste de fichiers). Les colonnes qui ne sont pas contenues dans la variable 2 ne possèdent aucune valeur pour les entrées correspondantes.

Si les deux objets variable contiennent des entrées du même nom, les valeurs de la variable 1 sont utilisées.

Notez que le type de données de la colonne de référence des variables source doit correspondre au type de données de la variable Multi. Sinon, une erreur survient ou les valeurs ne sont pas disponibles.

Aperçu Récupère les valeurs de la variable, exécute l'opération indiquée et affiche le résultat dans une nouvelle fenêtre.
Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne de résultat. La colonne de résultat affiche une combinaison des colonnes de valeurs et de tout autre caractère. Ceci est défini par le format du résultat.

Les numéros de colonne qui ont été indiqués entre accolades { } dans le champ Format du résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du résultat : {1}_{2}
Colonne de résultat : JOB01_WIN01

Sans indication d'un format de résultat, la valeur des colonnes Résultat ou Clé est une présomption.

Les valeurs de la colonne de résultat doivent respecter les limitations de la variable (valeur min., valeur max.et limiter le texte à) ou correspondre au format de sortie ou au type de données. Sinon, la colonne de résultat ne contient aucune valeur.

Opération  
Union Récupère les valeurs des variables 1 et 2. Lorsque les entrées des variables sont identiques, les valeurs de la variable 1 sont utilisées.
Intersection Récupère les valeurs qui se trouvent à la fois dans la variable 1 et dans la variable 2. Si les valeurs sont identiques, les entrées de la colonne résultat / clé de la variable 1 sont utilisées.
Différence Récupère toutes les valeurs de la variable 1 qui ne sont pas contenues dans la variable 2. Les entrées de la colonne résultat / clé sont comparées les unes aux autres.

Liste de fichiers

Si la source Liste de fichiers est sélectionnée, l'objet variable reçoit comme valeurs les noms de fichiers d'un répertoire spécifié. La saisie d'un agent de système d'exploitation est alors requise. Sur les agents Windows, les noms de fichiers sont classés par ordre croissant. Sur les agents UNIX, les noms de fichiers ne sont pas classés.

Les variables dont la source est "Liste de fichiers" possèdent toujours une seule colonne, contrairement à "SQL", "SQL - interne" et "Multi". Prenez en compte ces informations lors de l'utilisation du script GET_PROCESS_LINE. Il n'y a pas de colonne de résultat.

Champ/élément

Description

Variables PromptSet
Répertoire

Répertoire dont les noms de fichiers doivent être retournés comme liste de valeurs lors de l'accès à l'objet variable. Le répertoire être accessible sur l'hôte indiqué.

Par exemple pour une machine Windows :


C:\temp

Vous pouvez également limiter la liste aux fichiers ayant un nom ou suffixe donné. Pour configurer ces filtres, utilisez les caractères génériques : * représente plusieurs caractères, ? un seul caractère.

Par exemple :
C:\AUTOMIC\utility\temp\*.txt

Aperçu L'aperçu peut être utilisé pour vérifier les paramètres des champs (le répertoire n'existe pas, l'hôte n'est pas disponible, pas de droit de lecture sur le chemin). En l'absence de problème, la liste des fichiers est affichée dans une nouvelle fenêtre.  
Hôte    
Hôte

Agent de système d'exploitation permettant l'accès au répertoire indiqué. La sélection d'un groupe d'agents n'est pas possible.
Le système utilise automatiquement l'agent de la tâche qui a déclenché l'accès à la variable (pour les transferts de fichiers : l'hôte source) si aucun hôte n'est sélectionné.

Une erreur d'exécution se produit si la variable est utilisée dans un objet auquel aucun agent ni Login n'a été attribué.

Si l'objet transfert de fichier est utilisé comme source : si vous n'attribuez pas d'hôte à la variable, l'hôte du système cible de l'objet transfert de fichier sera utilisé.

Appliquer l'hôte de la tâche

Si cette option est activée, l’agent de la tâche qui accède à la variable est utilisé.


 
Login Objet Login pour la connexion à l'hôte. En l'absence de cette indication, le système utilise automatiquement l'objet Login de la tâche qui accède aux variables.
Appliquer le Login de la tâche Ce paramètre indique que le système utilise l'objet Login de la tâche dans laquelle la variable est utilisée.  

Backend

Les variables de type "Backend" exécutent une commande sur un système d'exploitation et renvoient le résultat sous forme de valeurs affichées en colonnes. L'objet variable définit la répartition des colonnes. Il est possible de saisir plusieurs commandes pour différents systèmes d'exploitation, noms de systèmes et versions dans une variable. Lors de la résolution de la variable, la commande adaptée à l'agent concerné est automatiquement sélectionnée et exécutée.

Pour accéder à la machine source, un agent et un objet Login doivent être sélectionnés comme pour le type de variable "Liste de fichiers".

Les systèmes d'exploitation UNIX et Windows sont pris en charge. Le système d'exploitation doit être sélectionné via les onglets en dessous du tableau des commandes.

Le privilège "Créer et modifier les variables Backend" est nécessaire pour configurer et modifier les objets VARA de type BACKEND.

Le code retour est automatiquement défini à 1 si une commande Windows aboutit à une erreur. Cela veut dire que lorsque vous utilisez l'objet VARA à l'intérieur d'un script, ce dernier s'interrompra. Afin d'éviter cette situation, vous pouvez ajouter ''& set ERRORLEVEL=0'' à la fin de la commande Windows.
Par exemple : cmd /c dir /b /o:d C:\temp\*.xml & set ERRORLEVEL=0
Cette commande liste les fichiers d'un répertoire. Le code retour est toujours 0 peu importe que les fichiers soient trouvés ou pas. Ainsi vous pouvez être sûr que les tâches utilisant cette variable ne seront pas interrompues.

Notez que les paramètres BACKENDVAR_TIMEOUT (UC_HOSTCHAR_DEFAULT) et BACKENDVAR_MAX_ROWS (UC_SYSTEM_SETTINGS) sont également disponibles pour les variables de type Backend.

Champ / Elément

Description

Variables PromptSet
Hôte    
Hôte

Agent sur la machine où la commande doit être exécutée.

Appliquer l'hôte de la tâche

Ce paramètre déploie l'agent de la tâche qui accède à l'objet variable.

Si cette option est définie, l'agent de la tâche est utilisé. Si la tâche ne possède pas d'agent (par ex. pour les objets script), l'agent de la variable est utilisé (voir "Agent"). Si aucun agent n'est défini sur ces deux emplacements, une erreur survient lors de l'exécution de la variable.

 
Login Objet Login pour la connexion à l'ordinateur de l'agent.
Appliquer le Login de la tâche

Ce paramètre déploie le Login de la tâche utilisant la variable.

Si cette option est définie, l'objet Login de la tâche est utilisé. Si la tâche ne possède pas de Login (par ex. pour les objets script), celui de la variable est utilisé (voir "Login"). Si aucun objet Login n'est défini sur ces deux emplacements, une erreur survient lors de l'exécution de la variable.

 
Commande

Tableau pour la définition des commandes par système d'exploitation

Sous Windows, il ne s'agit pas de lignes batch. Ceci signifie que le programme spécifique à exécuter doit être défini. 

Exemples :
Lister les répertoires : cmd /c dir C:\temp
Exécuter un ping : ping localhost -n 10

Il est possible d'enregistrer des commandes pour plusieurs systèmes d'exploitation dans la même variable. Le système utilise automatiquement les commandes du système d'exploitation de l'agent approprié lors de la résolution des variables.

Dans les colonnes Nom d'OS et Version, il est possible de filtrer les noms (par ex. un UNIX déterminé) et la version du système d'exploitation. Ici aussi, les lignes adaptées à l'agent spécifié sont utilisées automatiquement lors de l'exécution de la variable.

La première ligne qui correspond au système d'exploitation, nom d'OS et version de l'agent est utilisée.

Notez qu'une variable de type Backend ne peut exécuter qu'une seule commande.

Sous UNIX, l'utilisateur spécifié dans l'objet Login doit avoir les droits pour exécuter la commande correspondante. Sous Linux, les droits root sont par exemple requis pour les commandes "chkconfig" et "runlevel".

 
Nom d'OS

Filtre sur le nom du système d'exploitation

Il est possible d'utiliser le caractère générique *. Il s'agit d'un caractère de remplacement pour un nombre de caractères au choix.

Le nom d'OS fait référence au nom du système d'exploitation de l'agent qui est affiché dans la colonne de la Supervision système > Agent > SW.

 
Version

Filtre sur la version du système d'exploitation

La version fait référence à la version du système d'exploitation de l'agent qui est affiché dans la colonne de la Supervision système > Agent > SW.

 
Commande

Commande du système d'exploitation

Sous Windows, seules les commandes Powershell sont prises en charge.

 
Colonnes

Définition de la répartition du résultat dans les colonnes.

Syntaxe :
Nom de colonne :position de début(longueur) [ ;nom de colonne :position de début(longueur)  . . .] 

Nom de la colonne : nom de la colonne défini par l'utilisateur
Position de début : position du caractère à partir duquel la colonne commence.
Longueur : nombre de caractères qui définit la taille de la colonne.

Le point-virgule (;) ne doit être utilisé qu'entre des colonnes. Un point-virgule n'est pas nécessaire à la fin de la définition.

Vous devez définir au moins une valeur de colonne (minimum requis).

Par exemple :
process:1(20);pid:25(10)

l'exemple ci-dessus divise la sortie de la commande en deux colonnes :
La colonne process commence au premier caractère et contient 20 caractères, "pid" commence par au 25ème caractère et a une longueur de 10 caractères.

 
     
Format du résultat

Définition du contenu de la colonne résultat.

La première colonne affichée dans l'aperçu est la colonne de résultat. La colonne de résultat peut se composer d'une combinaison de colonnes de valeurs et de tout caractère, ceci est déterminé par le format du résultat.

Les numéros de colonne qui sont indiqués entre accolades { } dans le champ Format de résultat sont remplacés par la valeur de la colonne concernée.

Par exemple :
Colonne de valeurs 1 : JOB1
Colonne de valeurs 2 : WIN01
Format du résultat : {1}_{2}
Colonne de résultat : JOB01_WIN01

Si aucun format du résultat n'est indiqué, la colonne de résultat correspond à la première colonne de valeurs.

Les valeurs de la colonne de résultat doivent respecter les limitations de la variable (valeur min., valeur max.et limiter le texte à) ou correspondre au format de sortie ou au type de données. Sinon, la colonne de résultat ne contient aucune valeur.

 
Aperçu Exécute la commande correspondante sur la machine définie et affiche le résultat dans une fenêtre séparée.  

Des objets variables prédéfinies de type BACKEND sont fournis dans le client 0 (dossier UC _RB_VARIABLES) :

Nom d'objet Système d'exploitation Fonction Colonnes
UC_RB_VARA_PROCESSLIST Windows, Linux, AIX, SunOS, HP-UX

Liste les processus actifs.

La longueur maximale du nom de processus peut différer en fonction du système UNIX correspondant. Ajustez la longueur de la colonne de l'objet variable, si nécessaire.

ProcessID
Nom de processus
UC_RB_VARA_SERVICES_PAUSED Windows, Linux, AIX, SunOS, HP-UX Liste tous les services suspendus. Nom du service
UC_RB_VARA_SERVICES_RUNNING Windows, Linux, AIX, SunOS, HP-UX Liste tous les services en cours. Nom du service
UC_RB_VARA_SERVICES_STOPPED Windows, Linux, AIX, SunOS, HP-UX Liste tous les services arrêtés. Nom du service
UC_RB_VARA_USERLIST Windows, Linux, AIX, SunOS, HP-UX

Liste tous les utilisateurs du système d'exploitation

Windows : Active Directory pour Powershell doit être installé sur l'ordinateur approprié

Nom du compte utilisateur

Ces objets variable peuvent être utilisés pour des éléments PromptSet dynamiques. Leur agent spécifié est le nom de la variable &AGENT# et leur login est &LOGIN#. Utilisez ces noms pour les variables PromptSet des éléments requis.

Dans les objets PromptSet, vous pouvez sélectionner directement les objets variables prédéfinis comme variables de référence. Il n'est pas nécessaire de les créer auparavant dans leur client.

Les objets variable comportent les options Appliquer l'hôte de la tâche / Appliquer le Login de la tâche et utilisent l'agent / le Login de la tâche (si disponible) à laquelle l'objet PromptSet est attribué.

Le tableau ci-dessus présente également les systèmes d'exploitation pour lesquels les commandes sont spécifiées dans la variable. Selon l'agent et son système d'exploitation, la commande adaptée est exécutée.

 

 

Voir également :