Sous-programme

• 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)

Intitulé descriptif du sous-programme ou de la fonction.

Doit être le plus clair et précis pour faciliter ensuite, les recherches.

• Code activité (champ CODACT)

Un code activité permet :

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

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 (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

• Web services (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

• 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.

• 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

• 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)

Intitulé du paramètre du sous-programme ou de la fonction. Doit être le plus clair et précis pour faciliter la compréhension.

• 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).