Dictionnaire des fonctions

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.

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.

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.

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

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.

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

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. 

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.

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

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.

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.

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.

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.  

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.

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

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.  

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

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

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.

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