Développement >  Dictionnaire données >  Documentation >  Documentation sur champs  

Afficher tout Masquer tout

Cette fonction permet de saisir l'aide associée à chaque champ du progiciel, stockée dans la base de données sous la forme de textes html. Cette aide est caractérisée par un mot-clé et un code langue. On rattache le mot-clé au champ des écrans via la rubrique correspondante dans le dictionnaire des écrans.

Cette aide est ensuite générée sur disque grâce à une fonction d'extraction dédiée. Elle est placée dans un sous-répertoire nommé FLD. Mais chaque aide sur champ est également intégrée dans l'aide fonctionnelle, si l'écran qui porte le champ documenté est associé à un paragraphe de cette aide.

Il est à noter qu'une fonction de mise à jour des mots-clés d'aide d'un écran est directement accessible par zoom depuis le code écran défini dans les paragraphes de l'aide fonctionnelle.

Pré-requis

Habilitations

Cette fonction est de type objet. Les opérations de création, modification, et suppression de fiche peuvent être activées ou désactivées pour un utilisateur donné. Des filtres par rôles peuvent également être mis en place sur cette fonction.

Gestion de l'écran

Ecran de saisie

Présentation

Outre le code langue et le code du document, on retrouve dans cet écran un bloc où l'on peut saisir le texte de l'aide, via un éditeur HTML, dont l'utilisation est détaillée dans une documentation annexe.

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Bloc numéro 1

Définit la langue dans laquelle un texte est exprimé.

Ce code identifie de façon unique la fiche en cours.
  • Module (champ MODULE)

Module d'appartenance du paragraphe de la documentation.
  • Aide générique (champ GEN)

Lorsque cette case est cochée, l'aide est considérée comme générique, c'est à dire réutilisable de façon très large dans des écrans autres que celui pour lequel elle a été faite au départ.

Une fonction dédiée de sélection permet de sélectionner les aides génériques.
  • Priorité traduction (champ PRIO)

 

Bloc numéro 2

  • champ LNKORD

Texte d'aide

  • champ TEXTE

Ce champ permet de saisir le texte de l'aide sur champ tel qu'il apparaîtra lors de l'appel de l'aide, et tel qu'il sera inséré dans la documentation fonctionnelle qui référence l'écran où cette aide est utilisée.

Fermer

 

Etats

Par défaut, les états suivants sont associés à la fonction :

  ADOCFLD : Aides sur champ

Mais ceci peut être modifié par paramétrage.

Boutons spécifiques

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

Ce bouton permet de recopier la définition de la fiche depuis ou vers un autre dossier.

Barre de menu

Option / Copie documentation

Présentation

Permet de copier l'aide vers un autre dossier, de façon plus globale que le bouton correspondant. On peut ici donner des bornes pour faire des copies en masse. Les syntaxes possibles pour définir un dossier sont définies dans une documentation annexe.

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Bloc numéro 1

  • Toutes langues (champ ALLLAN)

Si cette case est cochée, toutes les langues sont prises en compte pour l'opération.

Si la case n'est pas cochée, on prendra, selon les cas :

  • la langue par défaut de l'utilisateur, si aucun code langue n'est saisi.
  • la langue saisie par ailleurs sinon.

Définit la langue dans laquelle un texte est exprimé.
  • Tous codes (champ ALLCOD)

Si cette case est cochée, tous les codes sont pris en compte pour l'opération (sinon, on ne prendra en compte que les codes correspondant aux bornes saisies).
  • Code (champ COD)

 Code table sur 20 caractères, numériques ou alphanumériques selon le type de la table. Dans ce dernier cas, le format n'est pas contrôlé à la saisie. Aussi, tout caractère non numérique n'est pas pris en compte. De plus, seul le point (".") sert de séparateur : la virgule n'est pas prise en compte.

  • Mise à jour écrans (champ HLPZON)

Si cette case est cochée, la copie met à jour, dans le dictionnaire des données du dossier de destination, le mot-clé d'aide de tous les champs du dictionnaire qui le référencent.

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.
  • 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

 

Option / Cas d'emploi aide

Permet de visualiser, dans une fenêtre de sélection, les écrans où l'aide sur champ courante est utilisée.

Option / Aides non utilisées

Permet de lancer une recherche globale dans le dictionnaire des écrans, afin de retrouver les aides sur champ qui ne sont utilisées dans aucun écran. La liste apparaît sous forme de fichier trace.

Option / Aides manquantes

Permet de lancer une recherche globale dans le dictionnaire des écrans, afin de retrouver les champs sur lesquels il n'y a pas de mot-clé d'aide, ou sur lesquels le mot-clé référencé ne correspond pas à une aide sur champ existante. La liste apparaît sous forme de fichier trace.

Option / Epuration aides non utilisées

Option / Cas d'emploi

Messages d'erreur

Il n'y a pas de message d'erreur autre que les messages d'erreur génériques.

Tables mises en oeuvre

Les tables suivantes sont mises en oeuvre par la fonction :

Table

Intitulé Table

ADOCFLD [ADZ]

Documentation sur champs