Fonctions
Cette fonction regroupe toutes les fonctions présentes dans la base de données du logiciel et appelées depuis un menu. Une fonction peut correspondre soit à un menu, soit à un traitement.
Prérequis
Reportez-vous à la documentation de Mise en œuvre
Gestion de l'écran
Une fonction est définie sur 2 onglets : un onglet contient les informations générales et l'autre, l'identification de l'action.
En-tête
L'en-tête permet de définir la fonction.
| Code (champ CODINT) |
|
Spécifie le code de la fonction. Les codes qui commencent par "GES" sont générées automatiquement par le superviseur de gestion d'objet. |
| Intitulé (champ ZNOM) |
Onglet Général
Cet onglet permet de définir les caractéristiques générales de la fonction.
Caractéristiques
| Menu ADMIN (champ MENU) |
|
Lorsqu'une fonction est créée, il est indispensable de la référencer dans un menu, afin que cette fonction puisse être appelée. Les menus sont paramétrés par utilisateur, mais un utilisateur de référence existe, appelé ADMIN, dont le nom est modifiable à l'aide du paramètre ADMUSR. Ces menus contiennent toutes les fonctions et peuvent servir de modèle pendant la création des menus. Par conséquent, un menu de référence indiquant où la fonction se trouve est défini à cet endroit. Le menu supérieur dans l'arborescence standard des menus est appelé GENE. Toutes les fonctions doivent être référencées, que ce soit dans ce menu GENE ou dans un autre menu accessible via le menu GENE. Les contraintes suivantes existent :
L’intitulé de menu est le texte traduisible qui apparaît dans le menu utilisateur pour nommer la fonction. |
| Rang (champ RANG) |
|
Indique le rang auquel la fonction apparaîtra dans le menu ci-dessus. Dans un menu, les fonctions sont triées par rang dans l'ordre ascendant. |
| Intitulé menu (champ ZLIBMENU) |
Bloc numéro 2
| Module (champ MODULE) |
|
Indique le module qui utilise cette fonction. Si la fonction est utilisée dans plusieurs modules, choisissez "Superviseur". |
| Code activité (champ CODACT) |
|
Si ce champ ne contient pas de valeur, la fonction sera toujours active et générera une ligne de menu pour l'utilisateur ADMIN. Si ce champ correspond à un code activité inactif, la fonction ne sera pas active. Si ce champ commence par X, Y ou Z, la validation de dossiers ne met pas à jour la fonction. |
| Type fonction (champ TYPTRAIT) |
|
Indique le type de fonction : traitement ou sous-menu. |
| Menu/traitement (champ TRAIT) |
|
S’il est renseigné, le traitement correspond :
Pour une fonction de type traitement, la méthode recommandée consiste à renseigner l'action, si elle n'est pas de type "traitement divers", plutôt que de renseigner directement le traitement. |
Autorisations
| Type accès objet (champ TYP) |
|
Lorsque la fonction est liée à un objet, le champ "Type accès objet" est automatiquement défini. Il est utilisé pour proposer les 3 codes suivants pour les autorisations fonctionnelles : C (Création), M (Modification), D (Suppression). |
| Autorisation site (champ FCYAUZ) |
|
Lorsque le champ "Autorisation site" est défini, il permet de définir dans le détail les autorisations fonctionnelles par site ou groupe de site. Remarque : ce paramétrage n'est pas disponible pour GESFCY. |
Divers
Tableau Options
| Numéro (champ NUMLIG1) |
| Code option (champ FLAG) |
|
Ce tableau est utilisé pour définir les codes option (maximum 20) sous la forme d'une lettre et d'un commentaire associé. Les lettres minuscules sont réservées pour les développements spécifiques/personnalisés. Pour chaque autorisation fonctionnelle, cette lettre peut être sélectionnée (ou non) afin d’ajouter les options à la fonction. Lors de l'exécution d'une fonction, le superviseur charge la variable globale GUSRAUZ(n) avec les codes option autorisés. n est l'index qui indique la décomposition des autorisations par site. Le développeur peut lier une partie de son traitement à la présence (ou non) d’un code option dans cette variable. |
| Intitulé option (champ ZOPTION) |
| Fonction (champ FNCOPT) |
|
Ce champ permet de définir la fonction qui régira l'accès à ce paramètre. Cela permet d'éviter les erreurs d'autorisations relatives aux accès. Voici un exemple. Le bouton Validation dans la fonction « Facture tiers client » (GESBIC) correspond à la fonction BPCVAL. Il est donc possible de contrôler l'accès au bouton selon les autorisations définies dans la fonction BPCVAL. |
| Activité (champ ACTOPT) |
|
Ce code activité régit la présence (ou non) de l'option dans la fonction. |
Tableau Variables
| Numéro (champ NUMLIG2) |
| Variable (champ VARIA) |
|
Ce tableau est utilisée pour définir une liste de variables globales qui doivent être affectées afin de donner au traitement d’appel un contexte plus spécifique. Ces variables sont initialisées par la fonction lorsque le traitement est appelé depuis le menu. |
| Valeur (champ VALEUR) |
|
Spécifie la valeur à affecter à la variable de la même ligne. Veillez à respecter son type (aucun contrôle n’est réalisé). |
| Activité (champ ACTVAR) |
|
Ce code activité permet de protéger la variable pendant une mise à jour de dossier. |
Onglet Action
Cet onglet permet de spécifier l’action à exécuter.
Bloc numéro 1
| Code action (champ ACTION) |
|
L'action qui sera exécutée au lancement de la fonction est définie ici. L'action doit exister dans le dictionnaire et ne doit pas être de type "Traitement divers". Si c'est le cas, l’action ne doit pas appeler la fonction mais doit appeler le traitement directement. Dans cet optique, renseignez le nom du traitement dans le premier onglet. |
| Paramètre (champ PARAM) |
| Valeur paramètre (champ VALPAR) |
|
Possibilité de renseigner les valeurs des paramètres de l'action. |
États
Par défaut, les états suivants sont associés à cette fonction :
AFONCTION : Fonctions
Un paramétrage différent permet des modifications.
Boutons spécifiques
|
Copie |
Utilisez cette action pour copier la définition de la fonction vers un autre dossier. |
Barre de menu
Documentation / ParagraphesCette entrée de menu vous permet d'accéder à la gestion de la documentation, au niveau du premier paragraphe de la documentation (si elle existe) associé à la fiche courante. Documentation / LiensCette entrée de menu vous permet d'accéder à la gestion des liens. Elle vous permet de définir des liens entre la fiche courante et d'autres fiches (par exemple des liens entre fonctions et paramètres). Ces liens sont spécifiques à la documentation et sont utilisés pour charger la génération des structures de documentations. Documentation / GénérationCette entrée de menu vous permet de lancer une génération de documentation. La génération peut se lancer également à partir du bouton Génération dans la partie basse de la fenêtre. Vous pouvez lancer 3 types de génération, séparément ou simultanément :
La borne proposée par défaut tient compte de la fiche en cours, mais elle peut être modifiée au lancement. |
Messages d’erreur
En plus des messages d'erreur génériques, les messages ci-dessous peuvent apparaître lors de la saisie.
Format du code fonction incorrect (5 caractères max)Pour une fonction de type menu, le code fonction ne doit pas dépasser 5 caractères.
Valeur incorrecteIl est interdit d'associer une fonction de type traitement à un menu général GENE.
Il est interdit d'associer une fonction de type menu à elle-même.
Champ obligatoireDans une fonction de type traitement, le code action (voir le nom du traitement) doit être renseigné.
Modification impossibleLorsqu’il existe un code activité standard, il n'est pas possible de le supprimer.
Option incorrecte/N° de ligne option incorrecte xxxDans une fonction liée à l'objet, les codes option C (Création), M (Modification) et D (Suppression) sont réservés au superviseur.
Fiche inexistanteDans la table des options, la fonction, lorsqu'elle est renseignée, doit exister dans le dictionnaire.
Autorisée : cette fonction est accessible depuis la navigation,