La fonction de script GET_VAR vous permet de renvoyer la valeur d'un objet Variable statique ou dynamique ou d'une variable d'agent. Lorsque vous utilisez cette fonction pour accéder à une variable dynamique, la valeur est résolue. La valeur est directement extraite de la source de données (une base de données, une variable ou un répertoire).
Pour plus d'informations :
Syntaxe
GET_VAR (Variable[, Key [, Column [,XPath|XQuery]]])
Paramètres
- GET_VAR
Extrait la valeur d'un objet Variable - Variable
Nom de l'objet Variable dont vous souhaitez extraire la valeur
Format: Nom AE, littéral de script ou variable de script - Key
Ligne de variable d'où extraire la valeur
Format: Nom AE, littéral de script ou variable de script - Column
Numéro de colonne d'où extraire la valeur
Format : littéral de script, variable de script ou nombre entre guillemets
Valeurs autorisées :- Objets Variable statiques : KEY (colonne Clé), 1 à 5 (colonne Valeur 1 à 5)
- Objets Variable dynamiques : RESULT (colonne de résultat, sauf pour les objets Variable FILELIST), 1 à n (colonne Valeur 1 à n)
- XPath|XQuery
Expression permettant d'accéder et lire les nœuds ou le contenu des données XML
Si vous ne saisissez pas d'expression, c'est l'intégralité du contenu de la colonne qui est renvoyé.
Important :- N'utilisez cette fonction qu'avec l'objet Variable XML.
- Vous pouvez utiliser des expressions Xpath avec l'objet Variable XML, mais les expressions Xpath peuvent fonctionner différemment selon le système de base de données. Voir la documentation fournie par l'éditeur de la base de données.
Codes retour
La fonction de script peut renvoyer les codes retour suivants :
- Valeur de la variable
- " " : L'entrée n'existe pas ou ne contient pas de valeur
Remarques :
- Si vous ne spécifiez pas de paramètre Key, c'est la première ligne qui est utilisée.
- Si vous ne spécifiez pas non plus de Column, le système utilise automatiquement une colonne selon le type de source :
- Objet Variable statique : Colonne de valeur 1
- Objet Variable SQL, SQLI, MULTI : colonne de résultat
- Objet Variable FILELIST : Colonne liste de fichiers
Vous pouvez soit ignorer la colonne, soit utiliser la valeur 1. La clé spécifiée correspond à la valeur renvoyée car il n'y a qu'une seule colonne.
- Le format de la valeur renvoyée correspond au format de sortie défini à la page Attributs de la définition d'objet. Pour plus d'informations, voir Page Attributs. Dans les variables dynamiques, spécifiez la valeur de la colonne de résultat (paramètre Ligne) au format qui s'affiche dans la source de données (SQL - base de données, MULTI - objet Variable). Le format de sortie de la variable n'a aucune importance dans ce cas.
- Si vous utilisez cette fonction de script avec un objet Variable XML statique, les valeurs des données de type XML sont automatiquement arrangées. Vous pouvez utiliser XML dans une seule ligne de script, mais le résultat sera réorganisé selon le standard XML.
Important !
- Une erreur se produisant pendant la résolution d'objets Variable dynamiques provoque une erreur d'exécution.
- Écrivez deux fois le & lorsque vous souhaitez accéder à une clé commençant par &. Sinon, le système interprète le terme comme une variable de script et ne tente pas de le résoudre.
Exemple : La ligne de script suivante accède à une clé appelée &key dans un objet Variable appelé VARA.TEST.
:SET &TEST# = GET_VAR(VARA.TEST,"&&key") - L'utilisation d'une fonction GET_VAR pour une clé inexistante renvoie un espace vide.
Conseils :
- Utilisez la fonction de script GET_VAR en combinaison avec l'instruction :FILL pour écrire toutes les valeurs d'une ligne dans un tableau de script. Pour plus d'informations, voir :FILL.
- Vous pouvez utiliser la fonction GET_VAR pour vérifier si une clé existe dans un objet Variable statique. Spécifiez la clé à vérifier en tant que colonne. Si la clé n'existe pas, la fonction de script renvoie une valeur vide. Si la clé existe, la fonction renvoie la clé.
Exemple : La ligne de script suivante renvoie la valeur "Test" lorsque la clé existe et " " en l'absence de clé.
:SET &KEY# = GET_VAR(VARA.TEST, "Test","KEY")
Exemples
Dans l'exemple suivant, la valeur d'une variable est extraite et le résultat est enregistré dans une variable de script :
:SET &TEST# = GET_VAR(MM.END.PROCESSING, "BookingDate")
Dans l'exemple suivant, des variables de script sont utilisées dans la fonction GET_VAR :
:SET &VAR# = "MM.END.PROCESSING"
:SET &VAL# = "BookingDate"
:SET &TEST# = GET_VAR(&VAR#, &VAL#)
Dans l'exemple suivant, la fonction de script GET_VAR est utilisée dans une condition :
:IF GET_VAR(MM.END.PROCESSING,
"BookingDate") = SYS_DATE("DDMMYY")
!...
:ENDIF
Voir aussi :