Dictionnaire des fonctions

• Code (champ CODINT)

Indiquez le code de la fonction.
Les codes commençant par "GES" sont générés automatiquement par le superviseur pour la gestion des OBJets.

• Intitulé (champ ZNOM)

Destiné notamment à figurer sur les états et les écrans dans lesquels le code de la fiche peut être saisi ou sélectionné. Ce texte permet de donner une description en clair de la fiche concernée.

• Menu ADMIN (champ MENU)

Lorsqu'on crée une fonction, il est indispensable de la référencer dans un menu, afin que cette fonction puisse être appelée. Les menus sont paramétrables par utilisateur, mais il existe un utilisateur de référence, appelé ici ADMIN, mais dont le nom est modifiable par le paramètre ADMUSR. Ses menus contiennent toutes les fonctions, et peuvent servir de modèle lors de la création des menus. On définit donc ici un menu de référence où va se retrouver la fonction.

Le menu de départ de l'arborescence standard s'appelle GENE ; toute fonction doit donc être référencée, soit dans ce menu GENE, soit dans un menu lui-même accessible à partir du menu GENE. Les contraintes sont les suivantes :

  il n'est pas possible d'avoir plus de 30 choix dans un menu.

  il n'est pas possible d'aller au-delà de 4 niveaux de sous-menus.

L'intitulé menu est le texte (traduisible) qui apparaîtra effectivement dans le menu de l'utilisateur pour désigner la fonction.

• Rang (champ RANG)

Indiquez le rang où apparaîtra la fonction dans le menu ci dessus.
Dans un menu les fonctions sont triées dans l'ordre croissant des rangs.

• Intitulé menu (champ ZLIBMENU)

Indiquez l'intitulé qui apparaîtra dans le menu de l'utilisateur ADMIN.

• Module (champ MODULE)

Indiquer le module par lequel est utilisée cette fonction. Si la fonction est utilisée par plusieurs modules, indiquer "superviseur".

• Code activité (champ CODACT)

Si cette zone n'est pas renseignée, la fonction sera toujours active et générera une ligne de menu pour l'utilisateur ADMIN.
Si cette zone correspond à un code activité inactif, la fonction ne sera pas active.
Si cette zone commence par X Y ou Z, la validation dossier ne mettra pas à jour la fonction.

• Type fonction (champ TYPTRAIT)

Indique le type de la fonction : traitement ou sous-menu.

• Menu/traitement (champ TRAIT)

Le traitement, s'il est renseigné, correspond :

• soit au nom du traitement à exécuter, à la condition que celui-ci n'ouvre pas de fenêtre
• soit au nom du menu.

Pour une fonction de type traitement, la méthode recommandée est de saisir l'action, si elle n'est pas de type "traitement divers", plutôt que de renseigner le traitement directement. 

• Type accès objet (champ TYP)

Lorsque la fonction est liée à un objet, le champ « type accès objet » est positionné automatiquement. Il permet de proposer en gestion des habilitations fonctionnelles les 3 codes suivants : C (Création), M (Modification), S (Suppression).
Pour tout objet, il sera possible de restreindre les droits des habilitations fonctionnelles, en n'autorisant pas la création et/ou la modification et/ou la suppression.

• Autorisation site (champ FCYAUZ)

Lorsque le champ « autorisation de site » est positionné, on permet de détailler les habilitations fonctionnelles par site ou par regroupement de sites.

• Exécution mono (champ MONO)

Cette case à cocher permet de rendre la fonction exécutable même si le dossier a été mis en mode « mono-module » ; c'est à dire s'il n'autorise aucune fonction pour le module. Un dossier est positionné en mono-module par une fonction exclusive.

• Aide de saisie (champ ZAIDE)

Intitulé du paramètre GFLAG=#; cet intitulé sera affiché, dans la fonction "profil menu",  pour la saisie de ce paramètre, pour cette fonction.

• Impression (champ RPT1)

Ces deux rubriques permettent de définir le nom de deux codes d'état appelables par les fonctions Fichier Impression et Fichier Liste. Ces codes état sont stockés dans les variables suivantes :GREPORT1 et GREPORT2. De façon normalisée, on suppose que la fonction Impression est relative à la fiche courante (la fonction n'est en principe pas disponible s'il n'y a pas de fiche courante), tandis que la fonction Liste est disponible dans tous les cas. Dans le cas d'une fonction liée à l'objet, le superviseur gère ces boutons ( (dés)activation, exécution du bouton ). Pour toutes les autres fonctions, le développeur de la fonction est supposée gérer l'appel de ces deux états, ainsi que l'activation.

• Liste (champ RPT2)

• Navigation (champ NAVIG)

Réglage des autorisations, autour de cette fonction, pour le menu "Navigation/Aller à la fonction" :

 Autorisée : cette fonction est accessible par la navigation.

 Interdite vers cette fonction : cette fonction ne peut être atteinte par la navigation, si par exemple, un contexte d'appel lui est nécessaire.

 Interdite depuis cette fonction : Depuis cette fonction, la navigation est interdite, lorsque par exemple il est nécessaire de protéger le contexte courant.

 Interdite dans tous les cas : On interdit d'accéder à cette fonction par la navigation, et d'accéder à la navigation de puis cette fonction.

• No (champ NUMLIG1)

• Code option (champ FLAG)

Ce tableau permet de définir des codes options (jusqu'à 19 maximum) sous la forme d'une lettre et d'un commentaire associé. Les lettres minuscules sont réservées aux développement spécifiques. A chaque habilitation fonctionnelle, cette lettre pourra être ou non sélectionnée afin d'ajouter des options à la fonction. A l'exécution d'une fonction, le superviseur alimente la variable globale GUSRAUZ(n)par les codes option autorisés. n est l'indice indiquant l'éclatement des habilitations par site. Le développeur pourra faire dépendre une partie de son traitement par la présence ou pas d'un code option dans cette variable.  

• Intitulé option (champ ZOPTION)

Indiquez l'intitulé de l'option correspondant au code de la même ligne. Cet intitulé sera visualisé dans le profil utilisateur lors de la saisie des droits d'accès.

• Fonction (champ FNCOPT)

Ce champ permet de définir une fonction qui conditionnera l'accès à ce paramètre.

Ceci permet d'éviter des erreurs d'autorisation d'accès.

Par exemple : Le bouton 'Validation' de la fonction GESBIC 'Factures Tiers client' correspond à la fonction BPCVAL. On va donc contrôler l'accès au bouton d'après les autorisations définies sur la fonction BPCVAL.

• Activité (champ ACTOPT)

Ce code activité conditionne la présence ou non de l'option dans la fonction.

• No (champ NUMLIG2)

• Variable (champ VARIA)

Ce tableau permet de définir une liste de variables globales qui doivent être affectées afin de donner au traitement appelant un contexte plus précis. Ces variables sont initialisées par la fonction, lorsque le traitement est appelé depuis le menu.  

• Valeur (champ VALEUR)

Indiquer la valeur à affecter à la variable de la même ligne. Attention à respecter le type de celle-ci (aucun contrôle n'est effectué).

• Activité (champ ACTVAR)

Ce code activité permet essentiellement de protéger la variable d'une mise à jour dossier.

• Code action (champ ACTION)

On définit l'action qui sera exécutée au lancement de la fonction. L'action doit exister dans le dictionnaire et ne doit pas être de type "traitement divers". Si tel était le cas, la fonction ne doit pas faire appel à la fonction mais doit appeler le traitement directement ; pour ce faire, on saisit le nom du traitement, dans le premier onglet.

• Paramètre (champ PARAM)

• Valeur paramètre (champ VALPAR)

possibilité de saisir des valeurs aux paramètres de l'action.

• Toutes langues existantes (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.

• Langue (champ LAN)

Permet de définir la langue de génération (quand la case permettant de générer dans toutes les langues n'est pas cochée).

• Tous types (champ ALLTYP)

Si cette case est cochée, tous les types de documentation sont pris en compte pour la génération. Il est à noter que, dans ce cas, on limite la génération aux documentations standard (seules les documentations de code inférieur à X sont prises en compte).

• Type (champ TYPEDOC)

Permet de définir le type de documentation à prendre en compte dans le traitement (quand on n'a pas coché la case pour les prendre tous en compte).

• Codes documentations (champ FUNDEB)

Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation.

• champ FUNFIN

• Génération ADOCUMENT (champ GENDOC)

Ce radio-bouton permet créer/mettre à jour le squelette de la documentation (hiérarchie des paragraphes) à partir des éléments techniques trouvés dans le dictionnaire des données. On peut choisir de reprendre uniquement les documentations existantes ou créer de nouvelles documentations si besoin.

Les liens de documentation sont également pris en compte. Les paragraphes susceptibles d'être créés sont définis dans l'annexe technique correspondante.

• champ GENFIN

Ce radio-bouton permet de générer la documentation finale à partir du contenu des paragraphes de documentation. Cette documentation est créée dans différents sous-répertoires du répertoire défini par le paramètre utilisateur DIRDOC.

Il faut utiliser la génération "Selon code activité" pour obtenir la génération des documentations des fonctions ayant des codes activités >= "X"
La génération "Complète" ne traite que les codes activités standards.

• Uniquement les documentations validées (champ HLPVLD)

Permet de générer le document final uniquement pour les documentations validées.

• Aides sur champs liées aux documentations (champ HLPLNKFLD)

Si cette case est cochée, on traite spécifiquement les aides sur champs relatives aux documentations sur fonction ou objet traitées par ailleurs. Pour savoir quelles sont les aides sur champ à traiter, on explore les écrans associés aux paragraphes de documentation correspondants.

• Autres aides sur champs (champ HLPFLD)

Si cette case est cochée, on crée la documentation finale à partir du contenu des paragraphes de documentation. Cette documentation est créée dans le sous-répertoire FLD du répertoire défini par le paramètre utilisateur DIRDOC.

• Codes aides sur champs (champ HLPDEB)

Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation.

• champ HLPFIN

• Répertoire de génération (champ REPERT)