Liens de documentation
La fonction de gestion des liens de documentation permet d'associer, à une documentation donnée, des liens vers des éléments du dictionnaire. Ces éléments sont utilisés, en complément des informations trouvées dans le dictionnaire, pour générer automatiquement des paragraphes et leur contenu, notamment dans les sections pré-requis et les sections annexes finales.
Liens selon les types de documentation
La liste des liens existants et la façon dont ils sont utilisés selon le type de documentation d'origine, est donné dans la suite. On trouve dans ces tableaux une colonne Compl.
Cette colonne définit, lorsqu'elle est à Oui, que les liens décrits par ce code viennent en complément des liens trouvés dans le dictionnaire. Ainsi, lorsqu'on génère une documentation fonctionnelle, les fenêtres, tables, objets qui lui sont associés sont analysés pour retrouver les codes activités associés, mais il est possible qu'un code activité non directement relié à la fonction influe sur son fonctionnement. On ajoutera alors ce code activité via un lien.
Lorsque la colonne Compl est à Non, aucune autre informatation du dictionnaire ne permet de définir le lien en question. Il est donc obligatoire de renseigner ce type de lien si on veut que cette information figure dans la documentation générée. Il faut noter que dans certains cas (tables diverses, menus locaux), on pourrait retrouver des liens de ce type, mais de façon peu fiable (ne nous intéressent dans ce cas que les tables diverses et les menus locaux dont le paramétrage est un pré-requis de la fonction).
Fonctions
Les documentations des fonctions (codes AFC) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ACV | Code activité | Liste des codes activités concernés dans les pré-requis. | Oui |
ADP | Paramètre | Paramètres concernés dans les pré-requis. | Non |
ANM | Compteurs | Liste des compteurs associés à la fonction dans les pré-requis. | Non |
GAU | Pièces automatiques | Liste des pièces automatiques associées à la fonction dans les pré-requis. | Non |
CDE | Codes section | Liste des codes section associés à la fonction dans les pré-requis. | Non |
TRS | Transactions | Liste des fonctions permettant de définir des transactions pour la fonction documentée. | Non |
ADI | Tables diverses | Liste des tables diverses dans les pré-requis fonction. | Non |
AML | Menus locaux | Liste des menus locaux à paramétrer dans les pré-requis. | Non |
ARP | Etats | Etats lancés depuis la fonction. | Oui |
ABT | Tâches batch | Annexe des tâches batch permettant de lancer la fonction. | Oui |
ATB | Tables | Tables mises en oeuvre dans la fonction. | Oui |
Remarque : la recherche des codes activités à partir des fonctions dans le dictionnaire est très exhaustive, et est susceptible de renvoyer certains codes activités dont la présence n'est pas forcément souhaitée. Pour pallier de comportement, il suffit de créer un lien vers le code activité FAL (toujours faux). Dès lors qu'un lien de ce type est inséré, seuls les autres codes activités présents dans la liste des liens sont renvoyés.
Paramètres
Les documentations des fonctions (codes ADP) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
AFC | Fonction | Liste des fonctions concernées dans l'aide décrivant le paramètre. | Non |
ACV | Code activité | Liste des codes activités associés. | Oui |
AOE | Modèles d'import/export | Liste des modèles d'import export utilisant ce paramètre. Ce lien n'est utilisé que de façon réciproque (pour obtenir les paramètres associés aux modèles dans les documentations en question). | Non |
AT2 | Tables pré-requis | Liste des tables à renseigner dans les pré-requis. | Non |
Variables de dimensionnement
Les documentations des fonctions (codes ADM) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ATB | Tables dimensionnées | Liste des tables dimensionnées par la variable. | Oui |
Modèles d'import/export
Les documentations des modèles d'import/export (codes AOE) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ADP | Paramètres concernés | Liste des paramètres influant le fonctionnement du modèle. A noter que les liens réciproques sont aussi parcourus. | Non |
AT2 | Tables pré-requis | Liste des tables mentionnées dans les pré-requis d'utilisation | Non |
ATB | Tables mises à jour | Liste des tables mises à jour | Oui |
Etats
Les documentations des modèles d'états (codes ARP) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ATB | Tables éditées | Liste des tables dont le contenu alimente l'état | Oui |
Evénements de Workflow
Les documentations des événements de Workflow (codes AWA) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ATB | Tables du contexte | Liste des tables dont le contenu fait partie du contexte de déclenchement | Oui |
Actions
Les documentations des actions (codes ACT) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ACT | Actions liées | Actions liées à la précédente | Oui |
Déclencheurs statistiques
Les documentations des déclencheurs statistiques (codes PS1) peuvent être enrichis par les liens du tableau suivant.
Lien | Signification | Utilisation lors de la génération de documentation | Compl |
ATB | Tables | Tables mises en oeuvre dans le contexte de déclenchement | Oui |
Cas particulier des points d'entrée
Les points d'entrée s'appuient de façon un peu particulière sur les liens. En effet :
- l'élément du dictionnaire qui est documenté est le traitement dans le dictionnaire des traitements
- chaque point d'entrée est défini par un lien vers le type APE, et le code associé est le nom du point d'entrée. Les liens qui suivent (jusqu'au prochain lien APE) caractérisent ce point d'entrée. Si des caractéristiques communes existent avant le premier lien APE, il sont supposés être valables par défaut pour tous les poits d'entrée.
- les liens ATB et AT2 sont utilisés pour définir les tables ouvertes (respectivement avec un contenu significatif ou non significatif)
- le lien TRS permet de définir s'il y a une transaction en cours (valeur 2) ou non (valeur 1)
- le lien TRA permet de définir s'il y a un fichier trace ouvert (valeur 2) ou pas (valeur 1)
Ainsi, si on a le tableau de liens suivant :
| TRS | 1 |
| TRA | 2 |
| ATB | TABLE1 |
| AT2 | TABLE2 |
| APE | POINT1 |
| ATB | TABLE3 |
| APE | POINT2 |
| TRA | 1 |
| APE | POINT3 |
| AT2 | TABLE4 |
Le traitement dispose de 3 points d'entrée POINT1, POINT2, POINT3 :
- Le POINT1 n'a pas de transaction ouverte, gère une trace, la table TABLE1 est en ligne et significative, la table TABLE2 est en ligne sans être significative (valeurs par défaut), la table TABLE3 est en ligne et significative.
- Le point POINT2 a les mêmes valeurs par défaut, sauf qu'il n'y a pas trace (la table TABLE3 n'est pas en ligne).
- Le point POINT3 a les mêmes valeurs par défaut (une trace est ouverte). La table TABLE4 est ouverte sans être significative.