Développement > Dictionnaire scripts > Consultations 

Une consultation permet d'extraire des informations d'une ou plusieurs tables, présentées sous la forme d'un tableau. La sélection se fait en fonction de critères saisissables au lancement de la recherche.

La gestion des consultations donne la possibilité :

 de paramétrer l'écran de consultation,

 de présenter les résultats de la consultation sous forme de graphe,

 d'avoir une gestion des mémos, pour enregistrer les critères de sélections. Le code extension mémo est à renseigner dans la table de codification des mémos. 

Une consultation se présente sous la forme :

 d'une fenêtre composée d'un en-tête comprenant les critères principaux pour la sélection et d'un onglet affichant le résultat de la sélection sous forme d'un tableau. Nous ne sommes cependant pas limités à un onglet.

 d'une fenêtre constituée d'un seul écran. C'est une fenêtre appelable depuis le bouton « Critère ». Elle permet, comme son nom l'indique, la saisie complète des critères de sélection,  des critères de tri des enregistrements, des mémos, d'un écran paramétrable pour l'affichage du résultat de la consultation.

 Il n'y a pas de liste de gauche.

Le graphe est personnalisable et est considéré comme du paramétrage. Il est à renseigner dans les écrans de paramètrage des consultations.

Pré-requis

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

En-tête

Champs

Les champs suivants sont présents dans cet onglet :

Ce code identifie la consultation.

  • Intitulé (champ DES)

Ce texte est repris en titre de l'onglet de lafenêtre principale de consultation.

Fermer

 

Onglet Ecrans

Présentation

Le premier onglet permet d'identifier les fenêtres utilisées par la consultation ainsi que de définir des caractéristiques générales.

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Caractéristiques

  • Module (champ MODULE)

Module d'appartenance du paramétrage. Ce champ permet de renseigner si l'écran doit être créé dans la base de données du dossier. Il l'est si le module auquel l'écran est rattaché est actif pour le dossier.

Un code activité permet :

  • de rendre optionnel un élément du dictionnaire si la valeur associée au code activité est nulle.
  • de signer les éléments spécifiques dès lors qu'ils sont marqués par un code commençant par X, Y ou Z.
  • de dimensionner un nombre de lignes maximum lorsque le code activité marque des éléments d'un tableau.

Ainsi, si le code activité est non actif, l'élément marqué ne sera pas utilisable, et le code associé (s'il y en a) ne sera pas généré ni activable.

Scripts

  • Script standard (champ PRGSTD)

Dans ce traitement, doivent être développés :

  • le chargement du tableau de consultation
  • les tunnels et dépliages pour bouton droit
  • l'analyse des paramètres d'entrée dans la consultation
  • le changement de code écran selon la clé principale de recherche.

Ce traitement doit contenir une étiquette $ACTION.
Pour de plus amples renseignements, consulterl' Aide au développement.

  • Script spécifique (champ PRGSPE)

Réservé au distributeur. Comportement identique au traitement standard.

Données

Fenêtre de base de la consultation constituée d'un écran d'entête et d'un onglet avec un tableau ayant pour zone de bas de page NBLIG. Il n'est cependant pas interdit d'y ajouter des onglets supplémentaires à la condition de les alimenter par traitement. Règles de construction.

L'écran tableau est aussi utilisé comme écran de référence en gestion des écrans de consultation.

Cette fenêtre est facultative. Elle regroupe les critères de sélections, les critères de tri, le code mémo, le code d'un écran paramétrable. Elle doit être sans entête et avec un onglet unique. Règles de construction.

 

  • champ SCRABB1

 

 

  • champ SCRABB2

 

 

  • champ SCRABB0

 

Bloc numéro 4

Cette zone est facultative.

  • Si la fenêtre de critères est définie avec une zone ECRAN renseignée, le tableau affiché correspond à l'écran associé au code écran de la fenêtre de critères (écran WM+Code consultation+Code écran).
  • Si la fenêtre de critères est définie avec une zone ECRAN vide et que le code écran par défaut est paramétré, le tableau affiché correspond à l'écran associé au code écran par défaut (écran WM+Code consultation+Code écran par défaut).
  • Sinon, le tableau affiché correspond à l'écran tableau de la fenêtre principale.

Tableau

  • Champs entête (champ FLD1)

Ce tableau permet de faire correspondre les zones critères de l'écran entête avec celles de l'écran de critères et d'identifier les critères d'affichage qu'ils soient dans l'écran d'entête ou la fenêtre de critères. En cours de consultation, la modification des critères d'affichage entrainera le réaffichage de la page courante de consultation, alors que la modification des autres critères entrainera une nouvelle recherche depuis la première page.

  • Champs critères (champ FLD0)

 

  • Critère d'affichage (champ DSYCRI)

 

Fermer

 

Onglet Tables

Présentation

Dans cet onglet, on peut donner la liste des tables de la base à ouvrir au début de la consultation. Ces tables seront ouvertes avec l'abréviation du dictionnaire et accessibles dans la consultation.

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Tableau

Indiquer les tables à ouvrir en début de consultation. Elles seront ouvertes avec l'abréviation définie dans le dictionnaire des tables.

Fermer

 

Onglet Divers

Présentation

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Clé de recherche

On indique l'objet associé, lorsque l'on désire exploiter et mette à jour les derniers lus par la consultation.

permet la gestion des boutons magnétos, s'ils sont paramétrés pour cette consultation. Si un objet a été précisé, la table gérée par cet objet sera chargée ici. On indique aussi sous quelle abréviation utiliser cette table en gestion des consultations. Par défaut, l'abréviation du dictionnaire des tables est proposée. Ce champ n'est pas utilisé pour filter les enregistrements à consulter. 

  • champ FILABB

 

  • Clé (champ FILKEY)

Indiquer la clé de parcours de la table, pourles boutons "magnétos" et la gestion des derniers lus.

  • Zone site (champ ZSITE)

 

On peut définir ici le champ de la table principale où se trouvele site auquel est rattaché l'enregistrement.

Le fait de définir ce champ permet de gérer automatiquement lesrestrictions d'accès aux données d'un site.

  • Zone code d'accès (champ ZACC)

 

On peut définir ici le champ de la table principale où se trouvele code d'accès auquel est rattaché l'enregistrement.

Le fait de définir ce champ permet de gérer automatiquement lesrestrictions d'accès liées au codes d'accès.

  • Conditions (champ FILCND)

Cette zone est facultative. Elle permet d'indiquer un critère de sélection sur la table de façon à sauter certains enregistrements inappropriés en utilisation des boutons magnétos ou en gestion des derniers lus.

  • Magnétos (champ MAGNETO)

Permet d'activer les boutons magnéto : Premier, Précédent, Suivant et Dernier en haut de la fenêtre principale de consultation.

Tableau

  • Composante de clé (champ CPNKEY)

 

  • Champs entête (champ CPNSCR)

Indiquer la correspondance entre les composantesde la clé et les champs de l'écran d'entête deconsultation.

Bloc numéro 3

Fermer

 

Boutons spécifiques

permet de générer le traitement automatique lié à la consultation ( WWCNSxxx, ou xxx est le code consultation )

Les champs suivants sont présents dans la fenêtre ouverte par ce bouton :

Bloc numéro 1

  • champ OBJET

 

  • champ CLES

 

Bloc numéro 2

  • Depuis le dossier (champ DOSORG)

Ce champ permet de définir le dossier à partir duquel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.

  • Tous dossiers (champ TOUDOS)

Cette option permet de copier la fiche vers tous les dossiers définis dans le dictionnaire (table ADOSSIER de la solution courante).

  • Vers le dossier (champ DOSDES)

Ce champ permet de définir le dossier dans lequel la fiche va être copiée. Les syntaxes possibles sont décrites dans l'annexe dédiée.

Fermer

permet de recopier la définition de la consultation vers un autre dossier. Attention, il faudra valider la consultation dans le dossier de destination.

Ce bouton permet de visualiser le dessin de la fenêtre principale. La consultation doit avoir été validée.

Ce bouton permet de visualiser le dessin de la fenêtre principale en mode web. La consultation doit avoir été validée.

Barre de menu

Documentation / Paragraphes

Cette fonction permet d'accéder à la gestion de la documentation, sur le premier paragraphe de la documentation (si elle existe) associé à la fiche courante.

Documentation / Liens

Cette fonction permet d'accéder à la gestion des liens. Elle permet de définir des liens entre la fiche courante et d'autres fiches (par exemple des liens entre fonctions et paramètres). Ces liens, purement documentaires, permettent d'alimenter la mécanique de génération des squelettes de documentation.

Documentation / Génération

Ce menu permet de lancer une génération de documentation. La génération peut se lancer également à partir du bouton [Génération] dans le bas de la fenêtre.

Trois types de génération peuvent être lancées, séparément ou simultanément :

  • la génération du squelette de documentation à partir du dictionnaire (tables ADOCUMENT, ADOCBLB, ADOCCLB).
  • la génération de la documentation à partir des tables précédentes.
  • la génération de la documentation sur champ.

Les bornes proposées par défaut tiennent compte de la fiche en cours, mais elles peuvent être modifiées au lancement.

Messages d'erreur

Outre les messages génériques, les messages d'erreur suivants peuvent apparaître lors de la saisie :

Fenêtre … enregistrement verrouillé

Il y a un lock logique sur cette fenêtre.

Fenêtre inexistante

La fenêtre renseignée dans la consultation n'est pas déclarée dans le dictionnaire des fenêtres.

Fenêtre sans écran d'entête

La fenêtre principale doit obligatoirement être composée d'un entête et d'au moins un onglet.

Fenêtre sans onglet

La fenêtre principale doit obligatoirement être composée d'un entête et d'au moins un onglet. La fenêtre de critère doit obligatoirement être composée d'un onglet.

Fenêtre avec plusieurs onglets

La fenêtre de critère ne peut contenir qu'un seul onglet.

Fenêtre avec écran d'entête

La fenêtre de critère ne peut pas contenir d'entête.

Ecran inexistant

L'écran associé à la fenêtre n'est pas déclaré dans le dictionnaire des écrans.

Ecrans de même abréviation

L'écran d'entête et l'onglet associés à la fenêtre principale ainsi que l'onglet de la fenêtre de critères doivent avoir une abréviation différente. Vérifier le dictionnaire de ces écrans.

Ecran sans tableau de bas de page NBLIG

Pour les besoins du modèle de consultation, l'onglet de la fenêtre principale doit contenir un tableau dont la variable de bas de tableau doit se nommer NBLIG.

Zone obligatoire

Dans le tableau qui associe champs d'entête et champs de la fenêtre de critères, lorsqu'on crée une ligne, un champ doit être précisé au minimum.

Le tableau de correspondance des éléments de la clé et les champs d'entête doit être renseigné.

Champ inexistant

Les champs définis dans le tableau qui associe champs d'entête et champs de la fenêtre de critères doivent être déclarés dans les écrans entête ou onglet « critères ».

Les champs définis dans le tableau qui associe champs de clé et champs d'entête doivent être déclarés dans les écrans entête.

Ce champ doit être de type

Dans le tableau qui associe champs d'entête et champs de la fenêtre de critères, le champ de critère doit être du même type de donnée que celui de l'entête.

Dans le tableau qui associe champs de clé et champs d'entête, les champs doivent être du même type deux à deux.

Clé inexistante

La clé déclarée doit existée dans le dictionnaire de la table renseignée dans le champ précédent.

Zone inexistante

Le champ pour le site déclaré doit existé dans le dictionnaire de la table renseignée sur cet onglet.

Fichier inexistant

Le type de graphe doit être un fichier d'extension vtc, et doit être présent dans le sous-répertoire  GRAPH du dossier courant.

Tables mises en oeuvre

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre