Développement >  Dictionnaire données >  Documentation >  Liens de documentation  

Afficher tout Masquer tout

Cette fonction permet de créer des liens documentaires utilisés dans le générateur de documentation. Ces liens complètent les informations du dictionnaire pour automatiser notamment des annexes et des pré-requis de la documentation. Une documentation annexe précise, pour chaque type de documentation, quels sont les liens possibles, et quels sont les paragraphes de documentation qu'ils alimentent.

Pré-requis

Codes activité

Les codes activités suivants (classés par type) peuvent avoir une influence sur le comportement de la fonction :

Codes activités dépendants

Ces codes ne sont jamais saisis en gestion de dossier, car leur valeur est calculée :

  AUDIT (Audit).

Fonctionnel

  ABI :  Business Intelligence

  ASD :  SData

  LEG :  Gestion multi-législations

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.

Autres pré-requis

Tables diverses

Les tables diverses suivantes sont utilisées par la fonction. Elles doivent donc être renseignées :

  Table diverse numéro 913 : Liens doc

  Table diverse numéro 910 : Type de doc

Gestion de l'écran

Le bloc d'en-tête contient un type de documentation et un code correspondant. On rattache à ce type un tableau de liens.

Ecran de saisie

Présentation

Chaque ligne du tableau représente un lien exploité dans la génération des documentations.

Fermer

 

Champs

Les champs suivants sont présents dans cet onglet :

Bloc numéro 1

Ce type, défini dans la table 910, définit le type de documentation pour lequel on définit les liens.

  • Module (champ MODULE)

Module d'appartenance du paramétrage.

  • Code (champ COD)

Ce code définit le code de documentation à laquelle sont rattachés les liens.

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.

Tableau Liens

  • Numéro de ligne (champ NUM)

 

Ce type de liens fait référence à la table diverse 913. Selon le type de documentation des liens différents sont autorisés.

  • Clé (champ CLELNK)

La clé de lien est liée au type précédemment saisi. Par exemple, lorsqu'on utilise le type ADP (paramètre), on saisit dans ce champ le code d'un paramètre, ou le nom d'une variable locale. Si on utilise le type ATB (table), on saisit dans ce champ le code d'une table de la base. Dans la plupart des cas, une fenêtre de sélection associée au contexte s'ouvre pour permettre de choisir parmi les codes possibles. On trouvera la liste des liens possibles dans l'annexe de la documentation.

  • Intitulé (champ INTLNK)

Intitulé associé au code précédent.

Fermer

 

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 / Vérification liens

L'option de vérification des liens parcourt les liens existants et avertit si :

  • l'objet est inexistant,
  • le module est différent de l'objet,
  • la documentation est inexistante,
  • le code activité est différent de l'objet.

Option / Epuration liens

L'option d'épuration des liens permet de supprimer les liens reliés à :

  • une documentation inexistante (code de la documentation d'en-tête n'existe pas),
  • un objet (liens appartenant au tableau des liens).

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

ADOCFNC [ADF]

Liens de documentation

ADOCUMENT [ADO]

Documentation

ADOPAR [ADP]

Paramètres

AMENLOC [AML]

Entête messages

APLSTD [AST]

Messages applicatif

ATABDIV [ADI]

Tables diverses

ATABLE [ATB]

Dictionnaire des tables

ATABTAB [ADV]

Paramètrage tables diverses

ATABZON [ATZ]

Dictionnaire des champs

ATEXTRA [AXX]

Textes à traduire