Cette fonction permet de capitaliser les informations relatives aux sous-programmes et fonctions réutilisables.

Il s'agit surtout d'une base de connaissance. Cela permet également, de rendre accessible un sous-programme, lors de la génération des web services.

  

Pré-requis

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

Ecran de saisie

Bloc numéro 1

Fichier (champ PRG)

Code du traitement. Il doit être capitalisé dans le dictionnaire des traitements. 

Sous-programmes (champ SUBPRG)

sous_programme ou fonction considéré ré-utilisable et par conséquent, à capitaliser dans ce dictionnaire.

Intitulé (champ ZINTIT)

Caractéristiques

Code activité (champ CODACT)

Un code activité vous permet de :

  • rendre optionnel un élément du dictionnaire si la valeur associée au code activité est nulle,
  • signer les éléments spécifiques dès lors qu'ils sont marqués par un code commençant par X, Y ou Z,
  • dimensionner un nombre de lignes maximum lorsque le code activité marque des éléments d'un tableau,

Si le code activité est désactivé :

  • l'élément marqué n'est pas utilisable,
  • le code associé n'est pas généré ou activé.
Module (champ MODULE)

Que le module soit actif ou inactif, il n'y a aucune incidence sur l'exécution du sous-programme.

Type (champ TYPASU)

Permet de classer les sous-programmes et fonctions afin d'en faciliter la recherche, et ce, dans le but d' une meilleure ré-utilisabilité.

Les fonctions et sous-programmes sont à classer en fonction de leur objectif :

  • Contrôle
  • Saisie
  • Sélection
  • Mise à jour
  • Xsl (traitement lié au composant écran)
  • Retour d'un statut
  • Recherche d'information
  • Calcul
  • Divers
champ WA
Services web (champ WEBS)

Permet de préciser que ce sous-programme ou fonction est générable pour les web services. En fait, aucun traitement n'est livré directement exploitable pour les webs services. Par contre, une fonction de génération des web services est mise à disposition pour les objets et sous-programmes identifiés comme pouvant être générés.
champ PUBNAM

Bloc numéro 3

Fonction (champ FONCTION)

Case à cocher permettant de faire la distinction des fonctions (appelées par l'instruction Func ) des sous-programmes (appelés par l'instruction Call.)
Type argument (champ TYPFCT)

Ce champ est à renseigner pour les fonctions. Celles-ci sont à classer en fonction de la nature de leur argument de retour :

  • Char
  • Intéger
  • Decimal
  • Date
  • etc.

Descriptif

champ TEXTE

Texte alimentant le paragraphe PRE "présentation", de l'aide sur fiche. Dans la gestion de la documentation, on identifie la fiche aide par :

  • type documentation = ASU
  • code documentation = traitement_sous-programme

Tableau Paramètres

No (champ NUMLIG2)
Code (champ PARAM)

Chaque paramètre est identifié par un code de 10 caractères majuscules et chiffres. Il n'y a pas de dictionnaire pour ces paramètres. 

Intitulé (champ ZINTITPAR)
Type (champ TYPPAR)

Nature du paramètre :

  • Char : Chaîne de caractères
  • Integer : Nombre entier
  • Decimal : Nombre décimal
  • Date : date
  • Libellé : Menu local
  • Clob : texte
  • Blob : image
Code classe (champ CODCLA)
Dim (champ DIME)

Dimension du paramètre

Type d'argument (champ ADRVAL)

Il indique comment est passé le paramètre.

          par adresse ( une variable est nécessaire pour passer le paramètre. En sortie du sous-programme, la valeur du paramètre éventuellement modifiée est retournée au traitement appelant ).

          par valeur ( le paramètre est passé par une variable ou par constante. En sortie du sous-programme, la valeur du paramètre même si elle est modifiée n'est pas retournée au traitement appelant).
Paramètres

Bouton permettant la mise à jour du tableau des paramètres suite à l'analyse du sous-programme. Les champs chargés automatiquement sont : le code paramètre, le type et le type d'argument. Il restera ensuite à compléter ce tableau par l'intitulé et la dimension du paramètre.

Etats

Par défaut, les états suivants sont associés à la fonction :

  ASUBPROG : Liste des sous-programmes

Mais ceci peut être modifié par paramétrage.

Boutons spécifiques

Copie

Ce bouton permet de recopier la définition du sous-programme vers un autre dossier.

Publication

Ce bouton est actif sur les sous-programmes autorisés en Web services. Il permet justement de le sous-programme courant en web services.

Barre de menus

Traitement de vérification de la cohérence du tableau des paramètres avec le sous-programme. Le nombre de paramètres erronés, s'il y en a, est ainsi affiché.

Traitement de vérification de la cohérence du tableau des paramètres sur l'ensemble des sous-programmes. Une trace est générée, en fin de ce traitement de vérification.

Ce menu 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

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.

Messages d'erreur

Outre les messages génériques, les messages d'erreur suivants peuvent apparaître lors de la saisie :

Traitement inexistant

Traitement inexistant dans le dossier courant, ou l'un des dossiers mère.

Code réservé

Le code traitement renseigné est un code réservé pour Adonix, et ne peut donc pas être utilisé.

Tables mises en oeuvre

SEEREFERTTO Reportez-vous à la documentation de Mise en oeuvre