Développement > Dictionnaire données > Ouverture au paramétrage > Variables globales
 |
 |
Variables globales
Cette fonction permet de capitaliser un ensemble de variables globales définies dans l'applicatif, et de généré automatiquement la déclaration (voire initialisée si cela est prévu dans la fiche), dans le sous-programme DEFVAR du traitement précisé sur la fiche. En aucun cas, il n'est possible d'ajouter des lignes de traitement, dans les traitements générés.
Cette fonction est délicate puisqu'elle intervient sur la déclaration de variable dans les traitements. Elle doit être destinée essentiellement aux développeurs et ne doit, en aucun cas, être laissée entre les mains d'utilisateurs non avertis. Il est surtout recommander de ne pas modifier le standard ou de le faire en connaissance de cause.
La case à cocher "public", si elle est positionnée, indique que la variable globale est ré-utilisable, notamment par le spécifique ; La documentation liée à cette variable est disponible.
Toutes les variables globales utilisées dans le produit ne sont toutes déclarées dans ce dictionnaire. On identifie :
- celles affectées à un paramètre
- celles devant exister au-delà d'un traitement.
Pour les variables absentes du dictionnaire, leur déclaration est à faire directement dans le traitement fonctionnel.
Pré-requis
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 à renseigner
Les tables suivantes sont utilisées par la fonction. Leur contenu doit donc être éventuellement mis à jour :
| Table |
Intitulé Table |
|---|---|
|
ATYPE [ATY] |
|
|
ACTIV [ACV] |
|
|
ADOPAR [ADP] |
Gestion de l'écran
Ecran de saisie
Présentation
Un seul écran permet d'écrire la variable, d'indiquer son format, son dimensionnement et éventuellement de paramétrer son initialisation.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Bloc numéro 1
|
On adopte la norme suivante, pour le nom de la variable globale :
Cette variable appartient à la classe [V]. |
|
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. |
Bloc numéro 2
|
Un code activité permet :
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. |
|
Module d'appartenance du paramétrage. |
|
Ce flag indique que cet élément est publié. Il est donc ré-utilisable par le spécifique. Une documentation associée est livrée. |
Descriptif
|
Cette zone texte permet d'afficher des commentaires relatifs à la fiche courante. |
Format
|
On définit ici le type de données de la variable global. Si le type de données est de type alphanumérique et défini avec une longueur, la variable globale est alors générée avec une longueur définie par GLONxxx (xxx=type de donnée). La longueur est obligatoire si le type de données indiqué sur la fiche est de type interne alphanumérique, clob ou blob et n'ayant pas de longueur renseignée. A l'inverse, la longueur n'est pas saisissable pour tout type de données ayant un type interne autre que alphanumérique, clob et blob. |
|
Champ affiché avec la valeur issue du type de donnée. |
|
La longueur est obligatoire si le type de données indiqué sur la fiche est de type interne alphanumérique, clob ou blob et n'ayant pas de longueur renseignée. A l'inverse, la longueur n'est pas saisissable pour tout type de données ayant un type interne autre que alphanumérique, clob et blob. |
Formules de dimensionnement
|
Possibilité de définir des variables à une ou deux dimensions, le premier poste commencçant à 0 par défaut, mais selon le paramétrage pouvant commencer à 1. Permet de définir une valeur par le biais d'une expression calculée pouvant contenir des constantes et des variables. |
|
|
|
|
|
|
Initialisation
|
Permet de lier une variable à un paramètre, pour ainsi, récupérer automatiquement la valeur du paramètre dans cette variable globale lors de la connexion au dossier.
|
|
|
|
Champ permettant l'initialisation du champ. Génération de l'alimentation de la variable globale dans le Subprog DEFVAR du traitement nommé sur la fiche. Pour le standard, afin de conserver une homogénéïté, il recommandé de ne pas initialiser la variable dans le dictionnaire sauf pour les variables servant à la déclaration d'une autre variable. L'initialisation sera faite dans l'un des traitements GLOBxxx (xxx=module). Permet de définir une valeur par le biais d'une expression calculée pouvant contenir des constantes et des variables. |
|
|
Traitement généré
|
Traitement dans lequel va être déclarée la variable. Doit avoir été créé dans le dictionnaire des traitements. Doit se nommer WWAGLOBxxx. Pour le standard, on se limite à la liste disponible, bien que l'on puisse affecter de nouveaux traitements. Dans le produit X3, le traitement est à appeler depuis le traitement GLOBX3. Pour le spécifique, il est conseillé, d'avoir ces propres traitements générés, qui adopteront la norme de nommage WWAGLOBxxx, ou xxx commencera par X, Y ou Z. Ce traitement devra être appelé par le point d'entrée OUVRE du traitement superviseur GLOBSUP. Il existe deux traitements réservés aux variables globales associées à un paramètre :
|
|
|
|
Rang de déclaration et d'initialisation de la variable dans le traitement nommé sur cette fiche. Cette information à surtout de l'importance, lorsqu'une variable sert au dimensionnement ou à l'initialisation d'une seconde variable. |
Fermer
Boutons spécifiques
|
|
Les champs suivants sont présents dans la fenêtre ouverte par ce bouton : Bloc numéro 1
Bloc numéro 2
Fermer Les variables globales déclarées par le standard sont protégées. Seuls certains champs sont modifiables. |
|
|
Les champs suivants sont présents dans la fenêtre ouverte par ce bouton : Bloc numéro 1
Bloc numéro 2
Fermer Permet non seulement de créer l'enregistrement dans la table des variables globales, mais aussi de générer la documentation ( paragraphe PRE), si du texte est saisi. Permet de créer les lignes de déclaration de la variable dans le traitement lié. |
|
|
Les champs suivants sont présents dans la fenêtre ouverte par ce bouton : Bloc numéro 1
Bloc numéro 2
Fermer Permet non seulement de supprimer l'enregistrement dans la table des variables globales, mais aussi
Attention, il n'y a aucun cuntrole du superviseur, quant à l'utilisation de cette variable que ce soit dans le traitement courant ou tout autre traitement. |
|
|
Les champs suivants sont présents dans la fenêtre ouverte par ce bouton : Bloc numéro 1
Bloc numéro 2
Fermer Permet de recopier la définition d'une variable globale vers un autre dossier. une validation est ensuite nécessaire pour générer le traitement associé. |
|
Permet la re-génération de tous les traitements connus de ce dictionnaire des variables globales. |
Barre de menu
Option / Contexte assistant de formules
Permet d'aller en tunnel sur la fonction "contexte assistant de formule".
Documentation / Paragraphes
Cette fonction permet d'accéder à la gestion de la documentation, sur le premier paragraphe de la documentation (si elle existe) associé à la fiche courante.
Documentation / Liens
Cette fonction permet d'accéder à la gestion des liens. Elle 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, purement documentaires, permettent d'alimenter la mécanique de génération des squelettes de documentation.
Documentation / Génération
Présentation
Ce menu permet de lancer une génération de documentation. La génération peut se lancer également à partir du bouton [Génération] dans le bas de la fenêtre.
Trois types de génération peuvent être lancées, séparément ou simultanément :
- la génération du squelette de documentation à partir du dictionnaire (tables ADOCUMENT, ADOCBLB, ADOCCLB).
- la génération de la documentation à partir des tables précédentes.
- la génération de la documentation sur champ.
Les bornes proposées par défaut tiennent compte de la fiche en cours, mais elles peuvent être modifiées au lancement.
Fermer
Champs
Les champs suivants sont présents dans cet onglet :
Sélections
|
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 :
|
|
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). |
|
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). |
|
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). |
|
Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation. |
|
|
Génération ADOCUMENT
|
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. |
Génération document final
|
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" |
|
Permet de générer le document final uniquement pour les documentations validées. |
|
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. |
|
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. |
|
Permet de donner une borne sur les codes à prendre en compte pour la génération de documentation. |
|
|
|
|
Fermer
Messages d'erreur
Outre les messages génériques, les messages d'erreur suivants peuvent apparaître lors de la saisie :
Paramètre inexistant
Si un paramètre est saisi, il doit existé dans la table de définition des paramètres ADOPAR.
Ce paramètre est utilisé par la variable globale xxxxxxxxx
Ce paramètre est déjà associé à une variable globale. Il ne peut en alimenter qu'une seule.
Type de données incorrect
Il faut une entière compatibilité entre le type de donnée de la variable et le type du paramètre.
Valeur incorrecte
Le code variable doit commencer par G, X, Y, ou Z
Le nom d'une variable globale doit commencer par G pour le standard et X, Y ou Z pour le spécifique.