Conception des PromptSet

La page Conception des PromptSet dédiée aux objets PromptSet, vous permet de définir des formulaires de saisie interactifs. Vous pouvez configurer des jeux d'invites ("prompsets") avec diverses commandes utilisateur, afin que vos utilisateurs puissent sélectionner ou saisir des données. Les valeurs sélectionnées par l'utilisateur sont transmises aux objets exécutables. Chaque élément que vous intégrez au formulaire détermine également une variable que vous pouvez utiliser dans les scripts. Vous pouvez configurer des invites ("prompts") pour qu'elles soient saisies manuellement ou résolues automatiquement à partir des valeurs par défaut des variables dynamiques.

Créer et éditer des PromptSets

Pour créer un prompset

1. Ajoutez un objet PromptSet (PRPT)
2. Accédez à la page Conception des PromptSet de l'objet.
3. Déplacez les éléments de PromptSet souhaités, en les faisant glisser de la partie droite de l'écran vers le centre.
4. Sélectionnez un élément que vous avez déplacé dans le PromptSet pour configurer les paramètres de l'élément.
5. Vous pouvez faire glisser et déplacer les éléments dans le formulaire pour modifier leur ordre. Les prompts sont appelés dans l'ordre dans lequel ils apparaissent ici.
6. Pour supprimer un élément, sélectionnez-le, puis cliquez sur l'icône Supprimer ou le bouton Supprimer de la barre d'outils.
7. Enregistrez l'objet.

Vous pouvez désormais utiliser le prompset de la page Prompt, dans la page Variables & Prompts d'un objet exécutable.

Aperçu de prompset

1. Ajoutez et triez les éléments prompset souhaités.
2. Enregistrez le prompset.
3. Cliquez sur le bouton Aperçu de la barre d'outils.

Le formulaire s'affiche dans une boîte de dialogue contextuelle, avec les éléments que vous avez configurés.

Remarque : L'aperçu ne résout pas les variables utilisées pour définir les valeurs par défaut.

Prompts disponibles

Les éléments de prompt disponibles sont les suivants :

• En-tête / texte
  Affiche un texte dans le formulaire
  Vous pouvez utiliser cet élément pour les en-têtes, en guise de titre, pour regrouper d'autres éléments ou afficher un autre texte pour l'utilisateur. À la différence d'autres éléments, cet élément ne transmet pas de valeurs. Le texte ne peut pas être édité dans le formulaire.
• Nombre
  Permet à l'utilisateur de spécifier un nombre
• Champ texte
  Permet à l'utilisateur de saisir une chaîne de texte sur une ou plusieurs lignes
• Liste déroulante
  Permet à l'utilisateur de sélectionner une entrée dans une liste déroulante
• Case d'option
  Permet à l'utilisateur de sélectionner une seule option
• Case à cocher
  Permet à l'utilisateur de sélectionner une ou plusieurs options en cochant des cases
• Date / heure
  Permet à l'utilisateur de sélectionner une heure et une date

Paramètres prompt généraux

Les paramètres suivants sont disponibles pour tous les éléments de prompsets, à l'exception du prompt En-tête / texte qui dispose uniquement de Description, Nom de la variable, Information-bulle et Champ personnalisé :

• Description
  Texte descriptif qui est affiché dans le formulaire
  Le champ affiche une valeur par défaut lorsque vous ajoutez l'élément, que vous pouvez modifier.
• Nom de la variable
  Définit une variable PromptSet que vous pouvez utiliser dans les scripts
  La variable est créée à chaque exécution de l'objet exécutable.
  Le champ affiche un nom de variable par défaut lorsque vous ajoutez l'élément. Vous pouvez modifier ce nom en tenant compte des restrictions applicables au nom des variables. Pour plus d'informations, voir Variables de script.
  Remarque : Lorsque la référence de données est un objet Variable de type EXEC, le nom de la variable PromptSet doit correspondre à celui de la variable de script définie comme nom de paramètre dans l'objet de variable EXEC.
• Infobulle
  Texte qui s'affiche lorsque l'utilisateur passe le curseulr de la souris sur le champ
• Focus
  Met le focus sur le prompt lorsque l'utilisateur affiche le formulaire
  Si cette option a été définie pour plusieurs prompts, c'est le dernier prompt ayant cette option sélectionnée qui aura le focus.
• Lecture seule
  La valeur par défaut est affichée et ne peut pas être modifiée par l'utilisateur
• Guillemets
  Caractère ajouté au début et à la fin de la valeur
• Champ personnalisé
  Texte n'impactant pas la fonction de l'élément prompset et ne s'affichant pas dans le formulaire
  Utilisez ce champ pour les remarques ou pour conserver des informations sur le prompt, qui seront accessibles dans la base de données.

Référence de données

Le champ Référence de données vous permet de sélectionner un objet Variable jouant le rôle d'une variable de référence pour le prompt. À l'exception du prompt En-tête / texte, tous les prompts vous permettent de spécifier une référence de données. L'objet Variable de référence de données détermine les valeurs et types de données autorisés et fournis dans l'invite.

La colonne dans laquelle les valeurs sont extraites change en fonction du type d'objet VARA de référence de données spécifié : 

• Variables statiques : première colonne de valeurs
• Variables dynamiques : Colonne RESULTAT

Remarques : 

• Si vous utilisez un objet VARA dynamique (à l'exception de FILELIST VARA) en tant que référence de données, le nombre d'entrées renvoyées est limité par la valeur de SQLVAR_MAX_ROWS dans UC_SYSTEM_SETTINGS - Paramètres système. La valeur par défaut est 200 lignes.
• Lorsque la référence de données est un objet EXEC VARA, le nom de la variable PromptSet (Nom de variable) doit correspondre à celui de la variable de script définie comme nom de paramètre dans l'objet Variable EXEC. Pour plus d'informations, voir Objets VARA EXEC.

Important !

• Ne modifiez pas les objets VARA de référence de données lors de l'exécution d'objets avec des prompsets ou lorsque ces objets démarrent. À ce moment-là, l'interface du prompt a déjà été générée et l'édition d'objets Variable causerait des problèmes.
• Si les valeurs spécifiées pour un élément prompset ne correspondent pas aux valeurs de référence, le prompt ne peut pas être envoyé après l'activation de l'objet. Vous trouverez plus d'informations à ce sujet dans la rubrique Activer des PromptSets.

Types de données requis

Le menu déroulant Référence de données n'inclut que les objets VARA dont le type de données correpsond à l'élément prompset. Utilisez l'élément prompset approprié pour le type de données de référence concerné. Vous pouvez, par exemple, utiliser l'élément prompset Heure / Date pour les données de type date. Parmi les types de données de prompts, on trouve :

• Nombre : nombre
  
• Champ texte : texte
• Liste déroulante :
  • Texte
  • Nombre
  • Heure
  • Date
  • Horodatage
• Case d'option :
  • Texte
  • Nombre
• Case à cocher :
  • Texte
  • Nombre
• Date / heure :
  Le type de données requis dépend du paramètre Type du prompt.
  • Date
  • Date et heure (horodatage)
  • Heure

Variables de référence de données par défaut

Le client système (0) fournit les références de données par défaut pour les prompts suivants :

• Nombre : UC_DATATYPE_NUMERIC
• Champ texte : UC_DATATYPE_STRING
• Date / heure :
  • Date : UC_DATATYPE_DATE
  • Date et heure : UC_DATATYPE_TIMESTAMP
  • Heure : UC_DATATYPE_TIME

Paramètres Clé et XPath/XQuery

(Champ texte, Liste déroulante, Case d'option et Case à cocher uniquement). Si vous sélectionnez une variable XML dans le champ Référence des données, les paramètres supplémentaires suivants sont proposés :

• Clé
  Clé de la liste Clé de la variable XML sélectionnée dans le champ Référence de données
  
• XPath/XQuery
  Expression XPath ou XQuery de la variable XML sélectionnée dans la clé.

Remarque : Les deux champs autorisent des variables.

Exemple

Supposons que vous ayez la variable XML suivante dans la clé :

<server>

    <name>MyUNIXServer</name>

    <ip>19.16.8.1.200</ip>

</server>

Pour spécifier l'adresse IP, procédez comme suit :

1. Sélectionnez la variable XML dans le champ Référence de données.
2. Sélectionnez la clé appropriée pour la variable XML dans le champ Clé.
3. Saisissez server/ip.

Valeur / sélection par défaut

La valeur par défaut s'affiche à l'appel du prompset. Si l'utilisateur ne sélectionne pas une autre valeur ou si le champ est en lecture seule, cette valeur est transmise. À l'exception du prompt En-tête / texte, tous les prompts vous permettent de spécifier une valeur par défaut.

Certains types de prompts sont soumis aux restrictions suivantes :

• La longueur du texte par défaut des éléments prompset n'est pas limitée, sauf si une longueur maximale est spécifiée dans la définition de la variable définie comme référence de données du prompt.
• Les espaces restants sont tronqués.
• Les éléments PromptSet Heure / Date ne peuvent pas être enregistrés sans valeurs par défaut. Pour que la date et heure actuelles s'affichent en tant que valeurs par défaut à l'ouverture d'un prompt, utilisez les variables prédéfinies &$PHYS_DATE_format# ou &$PHYS_TIME_format#.

Définir une valeur par défaut

Sélectionnez une option pour définir la valeur par défaut :

• Définir manuellement
  Selon le type de prompt, saisissez la valeur par défaut, soit en sélectionnant la valeur dans la commande, soit en la saisissant dans la barre de titre de l'élément prompt. Utilisez cette option si vous souhaitez une valeur par défaut statique pour le prompt.
  
• Définir par variable
  Saisissez le nom de la variable dans le champ de la barre de titre de l'élément prompt ou cliquez sur le bouton $x pour ouvrir la boîte de dialogue Insérer variable, vous permettant de sélectionner une variable prédéfinie. Pour plus d'informations, voir Insérer des variables dans des objets et des scripts. Utilisez cette option pour récupérer la valeur actuelle de la variable à l'appel du PromptSet. La variable renvoie les valeurs en fonction de l'objet auquel le PromptSet est affecté, et non en fonction de l'objet PromptSet lui-même.

Remarques :

• Les options « manuellement » et « variable » autorisent toutes deux le texte et les variables, sauf pour les prompts Nombre, n'autorisant que des nombres.
• Le système ne vérifie pas si le type de données de la valeur par défaut spécifiée correspond à la variable de référence de données. La seule exception est le prompt Champ texte soumis à un contrôle de référence par le système si l'objet Variable de référence contient du texte dans son type de données.

Important ! Vous pouvez enregistrer un PromptSet, même s'il contient des prompts dont les valeurs par défaut utilisent un type de données incorrect ou ne respectent pas les restrictions spécifiées dans les paramètres du prompt. L'erreur résultante se produit lors de la tentative d'enregistrement de l'objet auquel le PromptSet a été attribué.

Remplacer des valeurs de prompt

La valeur du prompt peut être remplacée à de nombreux endroits. L'ordre de priorité de la valeur de prompt utilisée pour l'activation est :

1. La valeur par défaut (si elle a été définie ici).
2. Le prompt de la page Prompt Sets, dans Variables & Prompts de la définition d'un objet exécutable remplace la valeur par défaut. Pour plus d'informations, voir la Page Prompt Sets.
3. Remplacement de l'activation de l'instance d'un objet Workflow ou d'un autre objet exécutable au moment de l'exécution :
   • Manuellement via une commande Exécuter.
   • Via un objet Schedule.
   • Via une fonction de script ACTIVATE_UC_OBJECT avec le paramètre PASS_VALUES utilisant :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.

   Remarque : La variable de tampon de lecture doit avoir le même nom que la variable PromptSet (Nom de la variable). Aucune boîte de dialogue Requête ne s'affiche pour les tâches activées via des objets Workflow, Schedule ou Script.

Remarque : Vous pouvez également définir des valeurs de prompt spécifiques aux workflows. Pour plus d'informations, voir l'Onglet PromptSets.

Autres paramètres spécifiques aux prompts

Certains paramètres ne sont disponibles que pour certains types de prompts.

Rechargement dynamique (prompts Liste déroulante)

Selon la variable de référence de données, ce paramètre génère l'une des actions suivantes :

• Si la valeur de référence de données est une variable dynamique, la liste des valeurs de la liste déroulante sera toujours résolue à l'appel du prompt. Le contenu de la liste est directement récupéré de la source de données. Ce comportement concerne l'aperçu de l'objet PromptSet, la page Variable & Prompts > Variables pour les objets exécutables et la boîte de dialogue Requête à l'exécution.
• Si une variable définie dans le PromptSet actuel est également spécifiée dans la définition d'objet de la variable de référence de données du prompt liste déroulante, vous pouvez utiliser la valeur du prompt précédente dans les champs autorisés de la variable de référence de données. Vous devez saisir le nom de variable du prompt précédent de l'un des champs de définition d'objet suivants dans la définition d'objet Variable de référence de données du prompt actuel. Pour plus d'informations, voir les paramètres de variables dans les rubriques suivantes :
  • Objets VARA BACKEND: Colonnes Agent, Login et Commande
  • Objets VARA EXEC : Section Paramètres
  • Objets VARA FILELIST: Agent, Login et Fichiers
  • Objets VARA SEC_SQLI : voir Paramètres des variables
  • Objets VARA SEC_SQL : Connexion, Login et Instruction SQL (Section Paramètres des variables)
  • Objets VARA SQLI : voir Section Paramètres des variables
  • Objets VARA SQL : Connexion, Login et Instruction SQL (Section Paramètres des variables)

Remarque : Si vous voulez utiliser des variables PromptSet dans les objets Variable, assurez-vous que la valeur de VAR_SECURITY_LEVEL dans UC_SYSTEM_SETTINGS - Paramètres système est 3. Cette restriction ne s'applique pas aux instructions SQL d'objets VARA utilisant les sources SQL SECURE et SQLI SECURE.

Obligatoire (prompts Case à cocher et Champ texte)

Requiert la saisie de l'utilisateur ou la sélection de données dans le prompt

Minimum et maximum (prompts Nombre et Heure / Date)

Détermine les valeurs minimales et maximales autorisées.

Remarque : Ces limitations sont déjà vérifiées quand vous enregistrez l'objet auquel l'objet PromptSet a été attribué. Vous ne pouvez pas enregistrer d'objets dont les valeurs PromptSet définies à la page Variables & Prompts ne sont pas valides en raison des propriétés du PromptSet.

Sélection multiple et séparateur (prompts Case à cocher et Champ texte)

Utilisez les paramètres suivants pour permettre aux utilisateurs de sélectionner plusieurs valeurs :

• Sélection multiple
  Permet à l'utilisateur de sélectionner plusieurs valeurs
• Séparateur
  (Uniquement disponible si l'option Sélection multiple est active) Caractère séparant les valeurs individuelles dans les sélections multiples
  (Prompts Case à cocher uniquement) Aucun séparateur n'est requis si vous sélectionnez l'option Tableau.

Conseil : (Prompts Champ texte uniquement) Activez l'option Assistant de saisie pour faciliter la sélection de plusieurs valeurs par l'utilisateur.

Réinitialiser sur modification (prompts Champ texte, Liste déroulante et Case à cocher)

Annule automatiquement la valeur d'autres prompts Champ texte, Liste déroulante et / ou Case à cocher, y compris les valeurs par défaut, lorsqu'un utilisateur sélectionne une valeur pour ce prompt.

Les cases à cocher s'affichent pour chaque prompt Champ texte, Liste déroulante et Case à cocher dans le PromptSet actuel. Cochez les cases des champs à réinitialiser si l'utilisateur saisit une valeur dans ce prompt.

Paramètres Champ texte

Les paramètres suivants ne sont disponibles que pour les prompts Champ texte :

• Multi-lignes
  Permet au champ de texte d'afficher plusieurs lignes
  Par défaut, le champ de texte ne propose qu'une seule ligne.
  
• Longueur maximum
  Nombre de caractères autorisé pour la valeur du prompt
  Cette vérification est effectuée lorsque vous enregistrez l'objet PromptSet ou un objet exécutable auquel vous l'affectez.
• Assistant de saisie
  Est doté d'un bouton "..." en regard du champ de texte, qui ouvre une fenêtre de dialogue permettant à l'utilisateur de sélectionner des valeurs
  Cette option peut être utilisée dans les cas suivants :
  • Pour sélectionner des valeurs à partir de la variable de référence des données.
  • La référence de données est un objet VARA FILELIST
  • La sélection multiple est activée
  Remarque : Lorsque votre référence de données est un objet VARA STATIC et que vous sélectionnez une ligne dans la fenêtre de dialogue, la valeur de la colonne Valeur 1 est sélectionnée.
  
• Majuscule
  Convertit automatiquement en majuscules les minuscules saisies dans le champ de texte
• Afficher comme un mot de passe
  Chiffre la valeur du champ de texte et masque les caractères saisis dans le champ de texte, en les transformant en astérisques (*)
  Remarques :
  • Le texte n'apparaît plus sous forme de texte plein dans les rapports.
  • Utilisez le paramètre CMD du messager de job pour exécuter les commandes de jobs Windows ou UNIX contenant des mots de passe chiffrés.
    
• Expression régulière
  Crée des règles pour le contenu autorisé d'un champ texte à l'aide d'une expression régulière.
  Vous ne pourrez ni enregistrer le PromptSet, ni spécifier de valeur pour ce dernier dans un objet exécutable si la valeur ne satisfait pas aux règles d'expression régulière.
  Exemples :
  N'autoriser que les nombres à deux chiffres : [0-9]{2}
  Autoriser tous les caractères à l'exception de "x" : [^x]
  Un des caractères "a", "b" ou "c" : [abc]
  Toutes les lettres en minuscules et majuscules, les chiffres et la virgule sont autorisés aussi souvent que souhaité : [A-Za-z0-9,]*
  Caractères autorisés #, , ,$, @, A-Z, 0-9 et longueur max. 10 :  [A-Z0-9_#@$,]{0,10}
  Remarques :
  • Les espaces en début et en fin dans les expressions régulières ne sont pas autorisés et ne seront pas ignorés.
  • Vous pouvez exécuter un objet exécutable avec un prompt soumis à des règles d'expression régulière si le prompt a une valeur nulle. Pour vous assurer que le prompt a une valeur, cochez la case Obligatoire.
    
  Conseil : Intégrez les règles à l'info-bulle du prompt pour aider les utilisateurs.

Paramètres Heure et Date

Outre les paramètres courants, les paramètres suivants sont disponibles pour les prompts Heure / Date :

• Type
  Sélectionnez l'un des types suivants :
  • Date
  • Date et heure
  • Heure
  Remarques :
  • Les références de données par défaut de ces options sont différentes. Pour plus d'informations, voir Référence de données ci-dessus.
  • Les paramètres Calendrier, Événement de calendrier et Format de sortie du prompt déterminent les spécifications de date et d'heure.
• Calendrier
  Sélectionnez un objet Calendrier pour choisir une date
• Événement de calendrier
  Choisissez un événement de calendrier dans le calendrier sélectionné
• Format de sortie
  Sélectionnez un format de données

Formats disponibles pour les types Date :

• JJ-MOI-AAAA
• JJ-MOI-RR
• MM-JJ-AAAA
• AAAAMMJJ
• MMJJRR
• JJMMRR
• MM-JJ-RR
• MM/JJ/RR
• AAMMJJ
• AA.MM.JJ
• AA-MM-JJ
• AAAAMMJJ
• AAAA.MM.JJ
• AAAA-MM-JJ
• JJMMAA
• JJ.MM.AA
• JJ-MM-AA
• JJMMAAAA
• JJ.MM.AAAA
• JJ-MM-AAAA
• MMJJAA
• MMJJAAAA
• MM/JJ/AA
• MM/JJ/AAAA

Formats disponibles pour les types Date et heure : 

• AAAAMMJJHH24MISS
• AAAA-MM-JJ HH:MM:SS

Voir aussi :

• Objets PromptSet (PRPT)
• Activer des PromptSets
• Page Prompt Sets