Quartis Optima Web

Description du fichier Formulaire.xml

12/10/2023

QUARTIS OPTIMA WEB :

Description du fichier Formulaire.xml

1 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

Sommaire
I. Présentation
II. Liste des balises
III. Balise <formulaire>
IV. Balise <table>
V. Balise <champ>
VI. Balise <affichage>
VI.1. Composant de type "texte"
VI.2. Composant de type "textarea"
VI.3. Composant de type "liste"
VI.4. Composant de type "listedynamique"
VI.5. Composant de type "password"
VI.6. Composant de type "radio"
VI.7. Composant de type "check"
VI.8. Composant de type "date"
VI.9. Composant de type "heure"
VI.10.Composant de type "date_heure"
VI.11.Composant de type "compteur"
VI.12.Composant de type "couleur"
VI.13. Composant de type "comboGrid"
VII. Balise <recherche>

2 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

I. Présentation

Le fichier formulaire.xml est un fichier de description d’un Formulaire de

l’application Quartis Optima Web. Il permet de définir la table ainsi que la liste des
champs sur lesquels porte le formulaire. Pour chaque champ, on définit son type de
données ainsi que ses règles d’affichage dans la liste de données, dans l’onglet de
recherche ainsi que dans le formulaire de saisie.
Ce fichier va permettre de générer la page Web correspondante :

Onglet Liste :

3 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

Onglet Recherche :

Onglet Formulaire :

4 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

II. Liste des balises

Ci-dessous, la liste de toutes les balises possibles, sans leurs éventuels attributs :

<formulaire>
<table>
<champ>
<affichage>
<item />
</items />
</affichage>
<recherche>
<item />
</items />
</recherche>
</champ>
</table>
</formulaire>

Dans la suite de ce document, la liste des attributs d’une balise sera décrite dans un
tableau de la forme suivante :

Attribut Description Langue

… … …

Attribut : le nom de l’attribut

Description : la description de l’attribut
5 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

Langue : Indique si la valeur de l’attribut peut être une clé associée à un fichier de
langue (#cle).

Les attributs indiqués en gras sont obligatoires.

III. Balise <formulaire>

La balise <formulaire> est la balise de plus haut niveau dans le fichier

formulaire.xml. C’est la balise racine. On ne peut la trouver qu’une seule fois dans le
fichier. Elle ne possède aucun attribut.

Note : Cette balise peut en fait porter n’importe quel nom. De manière conventionnelle,
on la nomme en fonction de sur quoi porte le formulaire : <personnel> pour le
formulaire du personnel, <machine> pour le formulaire des machines…

Exemple :

<personnel></personnel>

IV. Balise <table>

La balise <table> sert à indiquer le nom de la table sur laquelle porte le

formulaire. Elle est obligatoirement contenue à l’intérieur d’une balise <formulaire>. On
ne peut la trouver qu’une seule fois dans le fichier.

Attribut Description Langue

sql Nom SQL de la table Non
gestAdmin Nom du champ qui gère la suppression administrative Non

6 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

Note : l’attribut sql n’est obligatoire que dans le cas où il s’agit d’un formulaire et non
d’un formulaire dépendant.

Exemple :

<table sql="T_PERSONNEL" gestAdmin="FLAG_SUPP" />

V. Balise <champ>

La balise <champ> indique les différents paramètres liés à un champ de la table :

type de donnée, type d’affichage dans la liste de données, dans l’onglet Recherche ou
dans l’onglet Formulaire de saisie. Elle est obligatoirement contenue à l’intérieur d’une
balise <table>. On peut la trouver plusieurs fois (= il peut y avoir plusieurs champs dans
un formulaire).

Attribut Description Langue

sql Nom SQL du champ Non
clef Le champ est-il une clé primaire (true / false) Non
type Type de donnée du champ. (chaine / entier / decimal
/ date / heure / date_heure)
label Nom court du champ (affiché dans l’entête de la liste Oui
de données)
labelLong Nom long du champ (affiché dans les formulaires de Oui
saisie et de recherche)
largeur Largeur du champ dans le tableau Non
largLabelLong Largeur du nom long de saisie dans les formulaire de Non
saisie et de recherche
alignement Alignement dans la liste de données (left / center / Non
right) 7 / 14
tabVisible Champ visible dans la liste de données (true / false) Non
rechercheVisible Visible dans le formulaire de recherche (true / false) Non
formVisible Visible dans le formulaire de saisie (true / false) Non
redimensionnable Redimensionnable (true / false) Non
position Numéro de colonne dans la liste de données Non
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

Exemple :

<champ sql="MATR"
type="chaine"
label="#F_PERSONNEL_MATR_L"
labelLong="#F_PERSONNEL_MATR_LL"
largeur="60"
clef="true"
alignement="left"
largLabelLong="100"
tabVisible="true"
rechercheVisible="true" />

VI. Balise <affichage>

La balise <affichage> sert à renseigner les différents paramètres liés à l’affichage

du champ dans l’onglet formulaire de saisie : type de composant graphique (zone de
texte, liste déroulante), propriétés du composant, données externes liées au composant
(liste de données pour une liste déroulante par exemple).
La balise <affichage> peut posséder différents attributs, interprétés ou non selon le type
de composant à affiché (en fonction de l’attribut "type").
Elle est obligatoirement contenue à l’intérieur d’une balise <champ>. On ne peut la
trouver qu’une seule fois à l’intérieure d’une même balise <champ>.

Attribut Description Composants Langue

type Type de composant à afficher (texte / liste / Tous ( T, Non
radio / listedynamique / password / date / L, R, LD,
date_heure / heure / check / textarea / P, D, DH,
compteur / couleur / combogrid) H, CHK,
TA, CPT, C
C, CG)
x Position abscisse du composant Tous Non
y Position ordonnée du composant
largeur Largeur du composant T, TA, LD, Non
P, L, C, CG
longueurMax Nombre de caractères maxi T, LD, P, C Non
listeID ID de la liste de données L, LD, CG Non
colonnes Nb de colonnes d’un composant de type textarea TA Non
lignes Nb de lignes d’un composant de type textarea TA Non
min Valeur minimum d’un composant de type CPT Non
compteur
max Valeur maximum d’un composant de type CPT Non

8 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

compteur
pas Pas de variation d’un composant de type CPT Non
compteur
minChars Nb de caractères minimum à saisir pour activer la LD Non
liste dynamique
maxResult Nb de résultats maximum retournés par une liste LD Non
dynamique
nbMax Nb de résultats maximum retournés par un CG Non
comboGrid
rechCle Recherche par le nom de la clé (si =true) sinon CG Non
recherche par le label
nbCarMinRech Nombre de caractères minimum à mettre dans la CG Non
recherche avant d'afficher la liste
largeurTab Largeur du tableau CG Non
hauteurTab Hauteur du tableau CG Non
largeurCle Largeur de la colonne du tableau correspondant à la CG Non
"clé"
largeurLabel Largeur de la colonne du tableau correspondant au CG Non
"label"

Exemple :

<affichage type="liste"
x="350"
y="215"
largeur="180" />

Les points suivants indiquent la manière dont se présente la balise <affichage> en

fonction du type de composant choisi.

VI.1. Composant de type "texte"

<affichage type="texte" x="10" y="30" largeur="140" longueurMax="10"/>

VI.2. Composant de type "textarea"

<affichage type="textarea" colonnes="70" lignes="3" x="10" y="90"

longueurMax="200"/>

9 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

VI.3. Composant de type "liste"

Exemple 1 :

<affichage type="liste" x="340" y="330" listeID="OPTIMA_EQUIPE_LISTE">

<item value="-">#F_CHOIX_LISTE_NON_DEFINI</item>
</affichage>

Exemple 2 :

<affichage type="liste" x="340" y="330">

<item value="-">#F_CHOIX_LISTE_NON_DEFINI</item>
<items table="EQUIPE" champLien"CODE_EQUI" champAffichage="DESI" />
</affichage>

Il existe 3 méthodes pour indiquer la liste d’éléments à afficher dans un composant Liste.
 Indiquer l’attribut "listeID", qui fait référence à l’ID d’une liste de données définie
dans le fichier listes.xml
 Insérer une ou plusieurs balises <item> : définition des champs à insérer dans la
liste déroulante "en dur".
 Insérer une balise <items> : définition des champs à insérer dans la liste
déroulante en indiquant un lien vers une table SQL ainsi que le champ
représentant la valeur de l’élément et un champ pour l’affichage.

Balise <item> :

Attribut Description Langue

value Valeur de l’item de liste Non

Entre la balise de début et de fin, on indique le texte à afficher : cela peut-être une clé
de langage faisant référence à un fichier de langue (#cle)

<item value="-">#F_CHOIX_LISTE_NON_DEFINI</item>

Balise <items> :

Attribut Description Langue

table Table SQL Non
champLien Champ SQL correspondant à la valeur de l’item
10 / 14
champAffichage Champ SQL correspondant au texte de l’item
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

<items table="EQUIPE" champLien"CODE_EQUI" champAffichage="DESI" />

VI.4. Composant de type "listedynamique"

<affichage type="listedynamique"
x="10"
y="215"
largeur="180"
maxResult="50"
minChars="1">
<item value=""/>
<items table="SECTION_GEO"
champLien="CODE_SECT_GEOG"
champAffichage="DESI_SECT_GEOG" />
</affichage>

VI.5. Composant de type "password"

<affichage type="password" x="10" y="30" largeur="140" longueurMax="10"/>

VI.6. Composant de type "radio"

<affichage type="radio" x="400" y="110">

<item value="O">#F_CHOIX_MULTIPLE_OUI</item>
<item value="N">#F_CHOIX_MULTIPLE_NON</item>
</affichage>

VI.7. Composant de type "check"

11 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

<affichage type="check" x="400" y="110" valeurVrai="" valeurFaux="" />

VI.8. Composant de type "date"

<affichage type="date" x="10" y="90" />

VI.9. Composant de type "heure"

<affichage type="heure" x="10" y="90" longueurMax="8"/>

VI.10.Composant de type "date_heure"

<affichage type="date_heure" x="10" y="320" longueurMax="8" />

12 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

VI.11.Composant de type "compteur"

<affichage type="compteur" x="360" y="185" min="0" max="0" pas="1" />

VI.12.Composant de type "couleur"

<affichage type="couleur" x="10" y="490" longueurMax="8" largeur="150" />

VI.13. Composant de type "comboGrid"

13 / 14
 Quartis Optima Web
Description du fichier Formulaire.xml
12/10/2023

<affichage type="combogrid"
nbMax="10"
rechCle="true"
nbCarMaxRech="1"
largeur="300"
largeurTab="500"
hauteurTab="200"
largeurCle="100"
largeurLabel="300">
<item value="%">%</item>
<items table="ETAT_MACHINE"
champLien="CODE_ETAT_MACH"
champAffichage="DESI_ETAT_MACH" />
</affichage>

VII. Balise <recherche>

La balise <recherche> est proche de la balise <affichage>. Elle sert également à

définir le composant de saisie du champ mais dans l’onglet de recherche. La balise
<recherhe> possède les mêmes attributs et peut contenir les mêmes balises que la
balise <affichage> (balises <item>, <items). La balise <recherche> ne gère que les
composants de type "texte", "liste", "date", "heure", "date_heure" et "periode_date".
Seul le type "periode_date" n’a pas été défini dans la balise <affichage> :

<recherche type="periode_date" x="10" y="60" saisieObligatoire="true" />

Elle est obligatoirement contenue à l’intérieur d’une balise <champ>. On ne peut la

trouver qu’une seule fois à l’intérieure d’une même balise <champ>.

14 / 14