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

:READ

Instruction de script : Lit les données entrées par l'utilisateur dans la boîte de dialogue.

Syntaxe

:REA[D] InVariable, [Input Check], [Message Text], [Default Value], [Input Handling]

Syntaxe

Description / format

InVariable

Stocke la valeur saisie par l'utilisateur.
Format : variable de script

Vérification de la saisie

Paramètre qui détermine comment les données saisies par l'utilisateur doivent être vérifiées.
Format : littéral de script ou variable de script

Les indicateurs suivants peuvent être définis :

  • "00"
    aucune vérification de saisie n'est effectuée (valeur par défaut).
  • "01" à "99"
    Le nombre maximal de caractères de la valeur saisie doit correspondre à cette valeur (par ex. "10").
  • "nombre min. - nombre max." :
    Le nombre saisi doit se situer dans cette plage (par ex."10-20").
  • Format de date
    Les données saisies par l'utilisateur doivent adopter le format de date prédéfini (par ex. AAAAMMJJ).
  • Valeur, Valeur1-Valeur2 :
    Les donnés saisies doivent être égales à une valeur spécifique ou être dans une plage de valeurs. Les valeurs et plages de valeurs peuvent être combinées librement, séparées par des virgules.

Texte du message

Texte qui est affiché et qui demande à l'utilisateur de saisir des données.
Format : littéral de script ou variable de script
Valeur par défaut : "Indiquez la valeur pour la variable Nom de variable"

Valeur par défaut

Valeur par défaut suggérée qui est affichée dans le champ de saisie.
Format : littéral de script ou variable de script
1024 caractères max.

Il est impossible de laisser une chaîne vide comme valeur par défaut. Un caractère espace doit être encadré de guillemets.

Format de saisie

Optioons de spécification du format de saisie. Plusieurs options peuvent être saisies dans n'importe quel ordre (par ex. "MN").
Format : littéral de script ou variable de script

Les options suivantes s'appliquent :

  • "C"
    Si l'instruction READ se trouve au sein d'un bloc :BEGINREAD... :ENDREAD, le curseur est placé dans ce champ de saisie.
  • "D"
    La saisie est sécurisée. Les caractères sont affichés sous la forme d'astérisques "*".
  • "I" (uniquement pour les jobs)
    Les instructions:READ et les données saisies par l'utilisateur sont généralement documentées dans l'objet job généré sous la forme de lignes REMARK. Spécifiez l'option "I" pour supprimer cette documentation.
  • "K"
    La saisie peut se faire en minuscules. Sans cet indicateur, les caractères sont automatiquement convertis en majuscules lors de la saisie.
  • L'option "K" n'est disponible que pour les entrées de l'interface utilisateur et n'affecte pas le tampon de lecture.

  • "M"
    Le champ ne doit pas rester vide.
  • "N"
    Seuls des chiffres peuvent être saisis.
  • "O"
    L'utilisateur peut sélectionner des données dans la liste ou saisir des données.

Les indicateurs "D" et "N" ne peuvent pas être utilisés simultanément. Utilisez le paramètre Vérification de la saisie pour des données protégées qui ne doivent recevoir que des chiffres.

Exemple :

:READ &PASS#,"1-99999999","Enter password (numerical)",,"DM"

Lorsque vous demandez une Vérification de saisie sans définir de valeur par défaut, il faut tout de même indiquer la virgule. Cette règle est illustrée dans l'exemple ci-dessus.

Remarques

L'instruction :READ affiche une boîte de dialogue dont l'apparence et la fonction dépendent des paramètres utilisés. Le nom de l'objet est indiqué dans la barre de titre. Les données saisies par l'utilisateur sont spécifiées dans un champ de saisie et enregistrées dans une variable de script.

Cette boîte de dialogue s'affiche seulement si le script est exécuté en mode dialogue. Dans un autre mode, les valeurs par défaut sont utilisées.

Lors de l'utilisation de cet élément de script, vérifiez que la valeur saisie soit compatible avec le type de données de "InVariable" (variable cible).

Les paramètres Vérification de la saisie, Texte du message, Valeur par défaut et Format de saisie sont facultatifs. S'il n'y a pas de contenu dans les paramètres Vérification de la saisie et Texte du message, il faut néanmoins indiquer les virgules dans l'instruction :READ.

Champ

Description

Champ numérique

Si vous indiquez une plage de valeurs numériques continues (par ex. "0-255") dans la Vérification de saisie utilisant le format de saisie "N", un champ numérique doté de flèches haut/bas s'affiche.

Zone de liste

Si le paramètre Vérification de la saisie contient une liste données de valeurs, par ex. "A,B,C", ces valeurs sont affichées dans une zone de liste.

Zone de texte

Si le paramètre contient une plage de valeurs (telle que "A, 5-9") un champ de saisie est créé.

Spécifiez les virgules et les traits d'union entre quotes simples s'ils ne doivent pas être interprétés comme des séparateurs. Exemple : On peut choisir la valeur "1-5" ou la valeur "8,9".

:READ &OPTION#,"'1-5','8,9'",'Please select','1-5'

Dans la vérification de la saisie, vous pouvez utiliser des lettres ou des chiffres ou une combinaison des deux. Dans le dernier cas, le nombre de caractères est contrôlé. La saisie doit alors utiliser la formulation suivante. Dans l'exemple proposé, les caractères autorisés sont "A" à "F" et "1" à "999" :

:READ &INPUT#, "A-F,1-9,01-99,001-999","Please select"

Lorsque l'utilisateur n'indique ni ne sélectionne aucune valeur, un espace (" ") est enregistré dans la variable de script.

Le rapport trace automatiquement les valeurs qui ont été saisies dans les boîtes de dialogue. Cette fonction peut aussi être désactivée pour les rapports des jobs avec le paramètre "I". Notez que les données sécurisées (généralement les mots de passe) définies avec le paramètre "D" sont affichées cryptées dans le rapport.

Grâce à une instruction :READ, il est possible de lire les valeurs qui ont été placées dans la mémoire cache (voir :PUT_READ_BUFFER).

L'instruction de script écrit toutes les transactions ouvertes de ce script dans la base de données AE.

L'utilisation de l'instruction :PUT_VAR suivie de l'instruction :READ implique les particularités suivantes :
Si la génération du script de :READ est interrompue manuellement via le bouton "Interrompre" ou en raison de valeurs par défaut non valides (voir "Générer à l'exécution"), l'objet variable conserve les valeurs qui avaient été définies par l'instruction :PUT_VAR.

Exemples

En interrogeant l'utilisateur pour un titre, la saisie est pas vérifiée. Il est également possible de laisser le champ vide. Les caractères sont immédiatement convertis en majuscules.

:READ &HEADLINE#,"00","Please enter headline"

En interrogeant l'utilisateur pour un titre : une valeur par défaut n'est pas proposée, la valeur saisie n'est pas vérifiée. Cependant la saisie peut se faire en minuscules.

:READ &HEADLINE#,,,,"K"

Demande de chiffre : Dans ce cas, le paramètre "N" crée une zone nuémrique avec des flèches. Seuls les nombres entre 0 et 5 sont acceptés.

:READ &NUMBER#,"0-5","Please enter number",,"N"

Le système demande une date à l'utilisateur. La valeur lue doit être au format de date valide "AAMMJJ". La saisie est obligatoire.

:READ &DATE1#,"YYMMDD","Please specify a date (YYMMDD)",,"M"

Le système demande une signature à l'utilisateur. Le champ de saisie contient la valeur par défaut "A". La valeur saisie est vérifiée et peut être seulement "A", "X", "5", "6", "7", "8" ou "9".

:READ &LKZ#,"A,X,5-9","Please enter List Signature","A"

Le système demande à l'utilisateur d'indiquer un mot de passe de 8 caractères maximum. Le paramètre Format de saisie détermine que la saisie est sécurisée, donc les caractères ne sont pas convertis en majuscules et la saisie est obligatoire.

:READ &PASS#,"08","Please enter password (max. 8 characters)",,"DMK"

Dans l'exemple, le système demande l'adresse e-mail. L'utilisateur peut sélectionner trois adresses email. Pour que le trait d'union ne soit pas interprété en tant que plage de valeurs, une des adresses e-mail est spécifiée entre quotes simples.

:READ &USER#,"brown@automic.us,johnson@automic.us,'smith@late-night.com'", "Please select user"

Dans l'exemple suivant, l'utilisateur peut sélectionner une des trois adresses e-mail, ou bien en indiquer une autre.

:READ &USER#,"brown@automic.us,johnson@automic.us,'smith@late-night.com'", "Please select user",,"O"

Rubriques connexes :

Elément de script Description

:BEGINREAD... :ENDREAD

Début et fin d'une boîte de dialogue destinée aux questions posées à l'utilisateur.

:PRINT

Affiche le texte dans une boîte de dialogue destinée aux questions posées à l'utilisateur ou dans le protocole d'activation d'un objet.

:PUT_READ_BUFFER

Enregistre le nom et le contenu d'une variable de script dans le cache.

Eléments de script - Activation d'objets

Exemples :
Maintenance de la base de données avec options

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

Eléments de script - Répartition fonctionnelle