Dictionnaire des écrans

• Code écran (champ CODMSK)

Le code de l'écran peut contenirde 1 à 10 caractères alphanumériques. Le premier caractère estobligatoirement une lettre. Ce ne peut pas être un mot réservéd'Adonix.

• champ ABRMSK

L'abréviation de l'écran est formée de 1 à 4 caractères alphanumériques dont le premier est obligatoirement une lettre. Ce ne peut pas être un mot réservé d'Adonix.

Sauf, cas exceptionnel, la norme est d'avoir une abréviation distincte par écran. En effet, c'est l'identifiant sous lequel l'écran sera ouvert si l'abréviation n'est pas re-précisée dans le traitement. Cette abréviation donnera la classe des variables de cet écran.

• Intitulé (champ ZINTMSK)

Pas d'aide liée à ce champ.

• Ecran modèle (champ MDL)

Cette case à cocher permet d'identifier qu'un écran n'est jamais utilisable en tant que tel ( ni en interactif, ni en import ), mais ne sert que de modèle pour la création d'autres écrans. Cela peut également servir pour créer une classe de travail pour les traitements. Ces écrans ne seront jamais validés. Ils peuvent contenir 500 champs, alors qu'un écran validable ne peut contenir que 250 champs.

• Code activité (champ CODACT)

Ce champ permet de renseigner si l'écran doit être créé dans la base de données du dossier.
Si ce champ n'est pas renseigné, l'écran est toujours généré. Si ce champ correspond à un code activité inactif, l'écran n'est pas généré.

Un code activité débutant par X, Y, ou Z rend l'écran complet spécifique, c'est-à-dire qu'il n'est pas remis à jour en cas de revalidation de dossier.

• Module (champ MODULE)

[object Object]

• Taille (champ TYPMSK)

L'écran est tout d'abord défini par son type qui peut être :

• Entête et onglet sont particulièrement utilisés en gestion objet, consultation, sur un modèle "saisie fenêtre".
• Boite de dialogue est utilisée sur un modèle saisie fenêtre.
• Plein écran est utilisé sur un objet tableau et sur un modèle "saisie fenêtre".
• Plein écran avec liste gauche est utilisé sur un objet simple avec 1 seul écran et sur un modèle "saisie fenêtre".

Les 3 premiers types ( en-tête, onglet, boîte de dialogue ) nécessitent la saisie complémentaire du nombre de lignes et nombre de colonnes en sachant que le titre des onglets prend 1 ligne, le contour des blocs prend 1/2 ligne par trait et que le maximum est de 28 lignes, 112 colonnes (88 colonnes, s'il y a une liste de gauche).

Ces deux champs (lignes, colonnes) sont considérés comme du paramétrage. Les valeurs de ces champs ne sont pas diminuées par l'intégration d'un patch sauf pour le nombre de lignes si aucun code activité spécifique n'est trouvé (dans les blocs ou dans les champs).

• champ NBRLIG

• champ NBRCOL

• Empilement (champ STACKED)

• Script standard (champ TRTSTD)

Traitement dans lequel seront recherchées les actions " standard " (code STD) rattachées aux champ de l'écran. Pour un objet XXX, le nom du traitement standard est SUBXXX : cette norme est fortement conseillée mais cependant pas obligatoire. A la validation de l'écran, ce traitement est mis à jour (ou créé s'il n'existe pas déjà), lorsqu'une action " standard " est ajoutée sur un champ. En fait, l'étiquette du sous-programme est générée avec passage en paramètre de la valeur du champ; Il reste au développeur à écrire ce sous-programme.

• Script vertical (champ TRTSPV)

Traitement dans lequel seront recherchées les actions " verticales" (code SPV) rattachées aux champ de l'écran. Pour un objet XXX, le nom du traitement spécifique est SPVXXX : cette norme est fortement conseillée mais cependant pas obligatoire. A la validation de l'écran, ce traitement est mis à jour (ou créé s'il n'existe pas déjà), lorsqu'une action " verticale" est ajoutée sur un champ. En fait, l'étiquette du sous-programme est générée avec passage en paramètre de la valeur du champ; Il reste au développeur à écrire ce sous-programme. La mise à jour de ce champ ne nécessite pas de protection par un code activité.

• Script spécifique (champ TRTSPE)

Traitement dans lequel seront recherchées les actions " spécifiques " (code SPE) rattachées aux champ de l'écran. Pour un objet XXX, le nom du traitement spécifique est SPEXXX : cette norme est fortement conseillée mais cependant pas obligatoire. A la validation de l'écran, ce traitement est mis à jour (ou créé s'il n'existe pas déjà), lorsqu'une action " spécifique " est ajoutée sur un champ. En fait, l'étiquette du sous-programme est générée avec passage en paramètre de la valeur du champ; Il reste au développeur à écrire ce sous-programme. La mise à jour de ce champ ne nécessite pas de protection par un code activité.

• No (champ NOBLOC)

• Titre du bloc (champ ZTITBLOC)

Le titre d'un bloc est facultatif. Il apparaît sur la partie supérieure du cadre. Ce texte est traduisible. Il peut être évalué.

• Type bloc (champ TYPBLOC)

Le type de bloc définit la présentation des zones à l'intérieur d'un bloc.

• Tableau : les champs sont organisés dans un tableau de lignes déroulantes (horizontalement et verticalement si nécessaire).
• Liste : liste de champs indépendants les uns des autres.
• Texte : affichage de textes fixes background, sans qu'il puisse y avoir de saisie.
• Invisible : déclaration d'un bloc liste invisible. Permet d'inclure dans un écran des zones techniques non affichées utilisables par les traitements liés à l'écran.
• Flash : pour utiliser des vues portail (donnée externe à la fonction).
• Bureautique : pour document excel, word, powerpoint.
• Browser : pour page web.
• Editeur html : surtout réservé à la saisie de la documentation.
• Technique : pour composants XSL.
• Business Intelligence : pour l'exécution d'un état BO (surtout réservé au superviseur).

Une variable paramètre est nécessaire pour les blocs de type Flash, Bureautique, Browser, et Editeur html.

• Pos (champ POSBLOC)

Les "position", "ligne", "colonne" servent à placer les blocs les uns par rapport aux autres. Il faut simuler une grille sur le dessin des blocs, puis indiquer pour chacun, le positionnement par les coordonnées (ligne. colonne) de son angle supérieur gauche, l'occupation par le nombre de lignes et le nombre de colonnes dans cette grille fictive.

• Lig (champ LINBLOC)

• Col (champ COLBLOC)

• Haut (champ HTBLOC)

Si nécessaire, ces champs permettent d'indiquer un nombre de colonnes et de lignes minimum pour un bloc tableau.

• Larg (champ LGBLOC)

• Rang (champ RANG)

Indique le rang de saisie. Les blocs sont saisis dans l'ordre croissant des rangs lorsqu'on avance par tabulation d'un champ à l'autre. Il est utilisable en programmation pour identifier un bloc. Par exemple, afficher tous les champs du bloc 10, s'écrira : Affzo 10.       
Il est donc fortement conseillé de ne pas modifier le rang du bloc dans la définition de l'écran.

• Long (champ LNGLIB)

Pour un bloc de type liste, cette zone indique le nombre de caractères alloué à l'intitulé de chaque zone. En fonction de la place disponible, on prévoit 20, 15 ou 12 caractères.

• Act (champ ACTBLOC)

Ce champ permet de rendre optionnel un bloc de connées.

• Si le code activité n'est pas renseigné, le bloc est toujours généré.
• Si cette zone correspond à un code activité non actif, les zones de ce bloc ne sont pas générées.
  

• Ligne (champ NBLIGT)

Pour un bloc de type "Tableau", cette zone indique le nombre maximum de lignes dans le tableau.

• Options (champ OPTION)

Pour un bloc de type tableau, cette zone contient une liste de caractères, représentant chacun une fonction de base autorisée (si elle est présente) sur le tableau. Ces caractères peuvent être sélectionnés à l'aide d'une fenêtre de sélection. Les fonctions suivantes sont disponibles :

• K : Ligne précédente & suivante en mode saisie
• A : Annulation d'une ligne
• D : Annulation d'un intervalle de lignes
• R : Rajout de lignes en fin de tableau
• I : Insertion de lignes
• S : Couper
• B : Copier
• C : Coller
• T : Chargement de toutes les lignes du tableau
• ? : Recherche
• + : Justification de colonne
• = : Mode fiche automatique
• 1-9 : Nombre de colonnes fixes ( à partir de la 1^ère colonne )

• Empilement (champ BLOCSTACKE)

• Num colonne (champ BLOCCOLNUM)

• Paramètre (champ BASPAG)

Pour un bloc de type tableau, cette zone définit le nom de la variable de bas de tableau. C'est une variable technique stockant le nombre de lignes réellement saisies. Elle doit être définie comme saisissable, dans l'onglet des champs, avec le type de données ABS. Si l'on veut qu'un bloc tableau soit invisible, on définit cette variable en mode invisible.

• Pour un bloc de type Bureautique, le champ doit être de type Blob.
• Pour un bloc de type Flash, Browser ou Editeur html, le champ doit être de type Clob (AC0, AC1 ou ACB en standard).

• Représentation (champ BLOCTYPT)

Réprésentation du bloc "tableau" sur l'écran :

• Caractère : pas de graphe associé au tableau
• Car ou graph : graphe et tableau sont présent alternativement à la demande de l'utilisateur
• Car et graph : graphe et tableau sont présents sur l'écran
• Graphique: seul le graphe est présent à l'écran; le tableau n'est pas accessible

Pour les 3 dernières valeurs, un écran de "Paramètres graphiques" est accessible par le menu contextuel. 

• Bloc tableau (champ DETBLC)

Ce champ est désormais utilisé pour les "webs-services". Il est à renseigner pour les onglets contenant leur propre liste gauche. Exemple : écran BPABPR.

Sur le bloc liste, on indique le no de bloc tableau associé.

• Vue portail (champ BLOCVIEW)

Ce champ permet de sélectionner la vue portail, pour les blocs Flash

• No (champ NOFIC)

• Tables références (champ FICREF)

Ce tableau permet une aide à la saisie des champs dans l'onglet suivant. Le système rapatrie les caractéristiques des champs des tables listées. 

• No (champ NUMLIG)

• Champ (champ CODZON)

Ce champ indique le nom de champ de l'écran. Ce code peut être composé de 1 à 10 caractères alphanumériques dont le premier doit être une lettre. Les mots réservés Sage sont interdits. Pour bénéficier du trans-classe, il doit, si possible, avoir le même nom que le champ de la table auquel il fait référence. Un champ de nom NOMCHAMP défini dans un écran d'abréviation ABV1, peut être renseigné par la syntaxe [M:ABV1]NOMCHAMP.

Le nom de champ est généralement codifié par groupes de 3 caractères. Ces groupes sont capitalisés dans la fonction Codification rubriques. Il est recommandé de suivre cette norme.

Pour les champs créés en spécifique, le nom de champ doit commencer par X_, Y_ ou Z_.

• Bloc (champ NUMBLOC)

Ce champ indique le numéro du bloc où doit se positionner la zone.

• Pos (champ NOZONE)

Ce champ indique le numéro de la zone.

• Pour un bloc de type tableau, les zones sont placées de gauche à droite selon les numéros croissants.
• Pour un bloc de type liste, le numéro indique le nuùéro de ligne dans le bloc (1=ligne supérieure). Pour placer plusieurs zones sur la même ligne, il faut indiquer l'ordre en partie décimale.

Ex: 1,2 indique la deuxième position de la première ligne.

• Intitulé (champ ZINTIT)

Ce champ indique l'intitulé placé à gauche de la zone (ou au dessus en mode tableau). Possibilité de choisir l'un des trois intitulés du champ stockés dans la table ou un libellé évalué ou tout autre texte.

• Col (champ PDSZON)

Pas d'aide liée à ce champ.

• Num colonne (champ COLNUM)

• Type (champ CODTYP)

Indiquer le type de donnée de la zone. En fonction du type de donnée choisi des renseignements complémentaires peuvent être demandés.

• Menu (champ NOLIB)

Définit le numéro de menu local associée au champ défini sur la ligne.

Lorsqu'un champ est de type menu local, il est stocké sous la forme d'une valeur numérique (de 1 à 255) correspondant au rang d'un intitulé dans une table appelée menu local, stockée dans la table des messages APLSTD.

En saisie ou en affichage, on voit, selon les choix faits sur l'interface utilisateur :

• soit un intitulé pouvant être choisi dans une liste déroulante communément appelée combo box
• soit une liste de boutons de choix.

L'intérêt de ce type de saisie est que la liste des choix est présentée dans la langue de connexion de l'utilisateur.

Chaque numéro de menu local caractérise la liste des intitulés possibles. Par exemple, le menu local 1 correspond au choix Non / Oui dans cet ordre. Dans ce cas particulier, l'interface utilisateur peut aussi être la case à cocher.

• Long (champ LONG)

Permet de définir la longueur d'un champ lorsque ce champ utilise un type de données générique dont la longueur n'est pas fixée. C'est le cas notamment pour les types A et DCB.

Pour les blob, comme pour les clob, il faut saisir la longueur qui sera une longueur maximale de stockage. La codification est la suivante :

• Saisie (champ SAIAFF)

Cette information indique si la zone doit être saisie ou non. 3 Valeurs possibles:

• Saisie : Normal
• Affiché : La zone ne sera jamais saisie mais toujours visualisée.
• Invisible : La zone est présente en tant que variable de l'écran, mais ni saisie ni affichée.

• Transmission (champ TRANSM)

Indique pour un champ invisible, si sa description doit être prise en compte dans la description XML de la fenêtre. Les valeurs possibles sont :

• Non transmis : non pris en compte. (correspond au champ technique V140)
• Tout client : pris en compte par le client et les Web services
• Web services : pris en compte par les Web services uniquement. (correspond au champ invisible V140)

Pour les champs invisibles de bloc technique, ce champ est obligatoirement positionné à "tout client", cette technologie étant utilisée pour l'affichage des graphes XSL. Pour les autres cas de champ invisible, il est recommandé de mettre "non transmis" sauf besoin particulier à déterminer au cas par cas.

A noter, que pour les champs de bloc invisible, on a ces deux valeurs possibles : "non transmis", "Web services".

• Mode (champ MODE)

Ce champ permet de gérer la présence de la zone suivant le mode de saisie d'un tableau.

- Le mode fiche (accessible en clic droit dans la variable de bas de tableau) permet l'affichage/saisie d'une ligne d'un tableau dans une fenêtre. Tous les champs de la ligne qui sont marqués à 'Mode fiche' ou 'Mode fiche-tableau' sont accessibles dans une page ou plusieurs onglets suivant le nombre de champs.

- En mode Tableau, ne sont accessibles que les champs qui sont marqués 'Mode tableau' ou 'Mode fiche-tableau'.

Les actions définies sur les champs sont actives dans les deux modes.

• Act (champ CODACT)

Si cette zone n'est pas renseignée, la zone sera toujours présente. Si cette zone correspond à code activité non actif, la zone ne sera pas générée. Les codes activités commençant par X, Y, ou Z correspondent à des champs spécifiques qui ne sont pas touchés en mise à jour de dossier

• Dim (champ DIME)

Indiquer la dimension de lazone.
Cette dimension est affectée automatiquement dans le cas d'untableau déroulant.
Cette dimension peut être aussi affectée automatiquement dans lecas où le code activité de la zone comporte unedimension.

• Oblig (champ OBLIG)

Cette information indique si lazone est obligatoire ou non.
Pour un champ alphanumérique, obligatoire signifie que la zone nepeut être vide.
Pour un champ numérique ou de type date, obligatoire signifiequ'une valeur nulle ne peut être saisie.

• Retour ligne (champ BREAKAFTER)

• Masquable (champ ISMASKABLE)

• Tunnel (champ TUNNEL)

Lorsque le type de données est associé à un objet, cette information permet de créer automatiquement un tunnel disponible dans le menu contextuel du champ, permettant d'accéder directement à la gestion de cet objet. 
Une exception : le tunnel n'est pas proposé, lorsque la table gérée par l'objet de ce type de donnée est la table indiquée dans l'onglet général de l'écran, en première position.

• Lien (champ LIEN)

Si le champ a pour valeur 'Oui', une zone complémentaire est ajoutée à droite de la zone pour afficher l'intitulé du champ sélectionné. Cette zone doit être paramétrée dans le champ "intitulé" ou "intitulé court" sur l'onglet général de la table associée.

• Options (champ OPTSAI)

Les options dépendent du type de données (utiliser la fenêtre de recherche).
Cette colonne définit des options applicables à la saisie du champ. Ces options sont matérialisées par des caractères qui peuvent se concaténer lorsque plusieurs options sont nécessaires. Il est possible de choisir ces options grâce à une fenêtre de sélection. Les options disponibles dépendent du type de champ. Une description détaillée de toutes les options possibles est accessible. La combinaison de ces options permet au superviseur d'appliquer un format de saisi particulier pour le champ.
Avec le menu contextuel, vous pouvez également indiquer un format particulier pour la zone, en utilisant la syntaxe Sage X3. L'existence de ces informations est visualisée par un "$" dans cette zone. Ce champ permet donc de saisir des options OU un format de saisie.

• Tronc (champ OPTLNG)

Ce champ permet de préciser une longueur d'affichage, dans le cas où on la veut différente de la longueur de saisie.  La saisie sur ce champ sera alors "scrollante". Par défaut, sur les champs alphanumériques de longueur supérieure à 30, le superviseur prend une longueur d'affichage de 30 caractères. Ce format de saisie est pris en compte si aucun format est indiqué sur le type de donnée lié au champ, et sur le champ lui-même). 

• Valeur par défaut (champ VALDEF)

Ce champ indique une expression qui est proposée pour initialiser le champ. Si l'expression est précédée du caractère '*', la valeur par défaut est toujours affectée (même si le champ est déjà initialisé).

Pour un champ de type icône, la valeur saisie ici indique l'icône à afficher.
Exemple : 0 pour "nouveau", 1 "ouvrir", 2 "enregistrer, 3 "couper", 4 "copier", 5 "coller", ...
Pour ne pas afficher l'icône, le champ doit rester vide.

• Code accès (champ CODACC)

Si cette zone n'est pas renseignée, la zone sera toujours accessible à un utilisateur. Si cette zone est renseignée, un utilisateur ne pourra accéder à la zone que s'il est habilité pour le code d'accès correspondant. L'habilitation peut autoriser la consultation et/ou la modification de la zone.

Cette possibilité de restreindre l'accès à un champ est réservé au spécifique, et ne nécessite pas de protection par un code activité.

• Condition de saisie (champ CONSAI)

Le champ est défini comme étant saisissable, cependant dans certaines conditions, on désire qu'il ne le soit pas. La condition de saisie est une expression logique exprimée dans la syntaxe X3. Si l'expression est vraie lors de la saisie, la zone sera saisie, sinon elle sera affichée et sa valeur conservée. Exemple: Pour saisir une zone si la zone précédente est à oui : [M]ZONEPREC=2

• Objet graphique (champ TYPGRAPH)

Ce champ permet de préciser le type d'objet graphique qui sera utilisé :

• Case à cocher : sur champ de type Oui/Non (menu local 1).
• Radios boutons : sur champ de type menu local à nombre de choix restreint.
• Barre de progression : sur champ numérique.
• Icône : sur champ alphanumérique.
• Photo : sur champ de type blob.
• Texte multi-lignes : sur champ alphanumérique, clob ou blob.
• Rtf relatif (format KR) : sur champ alphanumérique. contient le nom d'un fichier sans extension.
• Rtf absolu(format KH) : sur champ alphanumérique. contient le répertoire, le nom d'un fichier et son extension. 

Sur un champ de bloc tableau, les objets autorisés sont : la case à cocher, et l'icône.

• Style (champ STYZON)

Possibilité d'ajout d'un style particulier sur le champ par paramétrage. Ceci est réservé au spécifique.  La mise à jour de ce champ ne nécessite pas de protection par un code activité.

• Table de contrôle (champ CODCTL)

Cette zone permet de définir une table de contrôle pour en vérifier la saisie et dans certains cas avoir une sélection des valeurs possibles. Ceci est réservé au spécifique.  La mise à jour de ce champ ne nécessite pas de protection par un code activité.

• Paramétrage (champ ACHPARG)

Ensemble de paramètres disponibles pour alimenter le graphe avec les champs du tableau. Ces paramètres sont décrits dans la table diverse 915.

• Représentation (champ CHREPR)

Permet de définir la représentation graphique de la colonne du tableau.

Cette information est nécessaire pour les graphes :

• Défaut : on prend la réprésentation définie pour l'ensemble du graphe
• Barre
• Ligne

• No (champ NOAC)

• Type (champ TYPACT)

Ce tableau permet de définir les actions particulières associées à la zone. Les types d'actions possibles sont:

• Avant-zone : Action avant toute saisie ou affichage de la zone. On peut l'utiliser par exemple pour définir le format de la zone.
• Init_bouton : Permet de définir les intitulés de bouton du menu contextuel.
• Init: Permet d'initialiser une zone.
• Avant_saisie : Action effectuée avant chaque saisie. on peut l'utiliser par exemple pour positionner mkstat et ne pas la saisir.
• Contrôle : Permet de tester la validité de la zone.
• Après-zone : Effectuée après le contrôle si celui-ci est valide. Permet par exemple d'affecter ou d'afficher d'autres zones.
• Après-modif : idem mais n'est déclenchée que si la zone a été modifiée.
• Sélection : Déclenchée par la touche F12.
• Bouton 1 : Déclenché par la touche F9 (réservée pour les tunnels)
• Bouton 2 à 20 : La touche F4 permet d'avoir la liste des menus contextuels.
• Avant_ligne : Uniquement pour les tableaux déroulants, permet de faire quelque chose à chaque fois qu'on entre en modification d'une ligne.
• Après_ligne : Uniquement pour les tableaux déroulants, permet de faire quelque chose après chaque saisie de ligne.
• Clic : Uniquement pour les champs icônes. Permet le déclenchement d'une action au clic sur l'icône.

• Action (champ ACTION)

Le code de l'action, renvoie à la table des actions qui précise le sous-programme qui va être appelé. Cependant 3 codes particuliers existent: "STD" , "SPE" et "SPV", qui indiquent que l'action n'est pas cataloguée mais fait appel à une étiquette qui est définie respectivement dans les traitements "standard" pour STD, "spécifique" pour SPE et "vertical" pour SPV. 

• Intitulé (champ ZINTITACT)

Le code de l'action, renvoie à la table des actions qui précise le sous-programme qui va être appelé. Cependant 3 codes particuliers existent: "STD" , "SPE" et "SPV", qui indiquent que l'action n'est pas cataloguée mais fait appel à une étiquette qui est définie respectivement dans les traitements "standard" pour STD, "spécifique" pour SPE et "vertical" pour SPV. 

• Exécution (champ EXEACT)

Ce champ permet de définir le contexte d'exécution de l'action:

• Interactive : cas de la saisie en ligne.
• Import / Web service : cas d'alimentation de la fiche en mode web service ou import. L'exécution des actions sur les champs est réalisée lorsque tous les champs sont renseignés.
• Toujours : dans tous les cas.

• Désactivation (champ DISACT)

Ce champ est disponible pour le spécifique et la verticalisation. On pourra préciser :

• Sur une action SPV : la désactivation ou non de l'action STD de même type
• Sur une action SPE: la désactivation ou non de l'action SPV et/ou de l'action STD de même type

• No (champ NOPA)

Cette partie de l'écran permet dedéfinir la valeur de certains paramètres.
Ces paramètres correspondent aux actions qui sont indiquées pourune zone (par exemple pour l'action de contrôle du code postal, ilfaut définir le champ code pays et le champ ville). Attention àrespecter le type de paramètre indiqué dans l'aide.

• Descriptif (champ CODPAR)

• Valeur (champ VALPAR)