...

Version Anglaise / English version

Une version anglaise de cette FAQ existe à l'adresse suivante : https://portal.hardis-group.com/x/-wkbIQ

An english version of this FAQ exists à the following address : https://portal.hardis-group.com/x/-wkbIQ

...

Aide

pour accéder à l'aide en ligne adelia, on peu accéder à l'aide d'un navigateur à l'adresse suivante : 

...

Plus précisément on pourra accéder directement aux :

• Ordres L4G (or by topic ou par thème )
• Objets graphiques
• Fonctions prédéfinies  (ou par thème)
• Mots réservés  
• Fonctions de la VaToolBx (ou par thème)

...

/* ___ Déclarations des variables _______________________________________________________ 
REF(A5_COD_ARTICLE) 			  w_COD_ARTICLE_1 										/* définir la variable w_COD_ARTICLE_1 de la même façon que la propriété A5_COD_ARTICLE
REF(A5_COD_ARTICLE HL_ART_ALCOOL) w_COD_ARTICLE_2 										/* définir la variable w_COD_ARTICLE_2 de la même façon que la propriété A5_COD_ARTICLE de l'entité HL_ART_ALCOOL
REF(w_COD_ARTICLE_2)			  w_COD_ARTICLE_3 										/* définir la variable w_COD_ARTICLE_3 de la même façon que la variable variable w_COD_ARTICLE_2 

/* ___ Déclarations des listes __________________________________________________________
LISTE LST_ART_ALC_1  *REF_MLD(HL_ART_ALCOOL)											/* définir une liste avec toutes les propriétés de l'entité HL_ART_ALCOOL
LISTE LST_ART_ALC_2  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) 					/* définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et HL_ART_LANGUE
LISTE LST_ART_ALC_3  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) w_COD_ARTICLE_1	/* définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et HL_ART_LANGUE et également la variable w_COD_ARTICLE_1

...

La taille de la variable peut auss aussi indiquée en :

• kilobytes (* 1024) en ajoutant le suffixe "K" à la valeur (jusqu'à 8189K), ou bien
• megabytes (* 1048576) en ajoutant le suffixe "M" à la valeur (jusqu'à 7M)

...

La taille totale de la variable numérique doit être comprise entre 1 et 63 .
La taille correspond au nombre total de chiffres (décimales comprises).
La valeur décimale est inclue incluse dans le nombre total de chiffres.
Comme le nombre de décimales est inclue inclus dans le nombre total de chiffre, le nombre de décimales sera inférieur ou égal au nombre total de chiffres.

...

1 - Définition

Pour définir a new une nouvelle constante, il suffiit d'aller dans menu Référentiel de l'éditeur L4G, séléctionner la ligne de menu Dictionnaire des constantes (ou bien d'appuyer sur F9).

...

• DECL PGM. Dans ce paragraphe, on déclare les variables globales (ou paramètres, listes, curseurs etc) du programme,
• INIT PGM. C'est le point d'entrée du programme,
• FENETRE - DECLARATION. Dans ce paragraphe, on déclare les variables (listes, curseurs etc) accessibles seulement depuis les différents paragraphes de la fenêtre (Initialisation, Vérification, Validation, Evénements),
• FENETRE - EVENEMENTS. Dans ce paragraphe on écrira le code correspondant à chaque événement qui pourra être déclenché sur un objet,
• INITIALISATION. Dans ce paragraphe on écrira le code qui lchargera charge les données avant d'afficher la fenêtre,
• VERIFICATION. Dans ce paragraphe on écrira le code qui vérifie les données saisies dans la fenêtre par un utilisateur,
• VALIDATION . Dans ce paragraphe on écrira le code qui écrira écrit les données dans la base après vérification.
• PROCEDURES . Des procedures peuvent être créées pour effectuer des actions répétivies ou bien pour rendre le code plus modulaire et lisible.

...

/* ___ Déclarations _____________________________________________________________________
DECL_PGM
   /* variables globales, DS, listes, curseurs, déclarations de paramètres du programme

INIT_PGM
   INITIALIER WIN_2205			/* appeler le paragraphe de chargement des données
   EXECUTER   WIN_2205          /* showafficher thela windowfenêtre to the userà l'utilisateur

WIN_2205
   DECLARATION
      /* variables locales, DS, listes, curseurs
   INITIALISATION
      /* code à exécuter avant d'afficher la fenêtre
   OBJETS
     EVENEMENTS_OBJETS...
     BTN_VALIDATE
        BoutonGaucheClic
           VERIFIER              /* appeler le paragraphe de vérification
           VALIDER               /* appeler le paragraphe de validation
           TERMINER              /* fermer la fenêtre en cours (aller à l'odre suivant l'ordre INITIALISER)
   VERIFICATION
      /* code qui vérifie les données saisies par l'utilisateur
      ENVOYER_MSG *EFFACER_TOUT  /* effacer les messages d'erreur
      si [conditionErreur pour l'objet ZZ_JLP]
         preparer_msg hl21734 ZZ_JLP
         init_msg ZZ_JLP
         anomalie      
      fin
      ...
   VALIDATION
      /* code pour mettre à jour la base de données après la vérification des données saisies par l'utilisateur
      MAJ_SQL ou CREER_SQL ou ...

...

Pour concatener deux variables alphanumériques (ou plus) on utilisera les opérateurs // ou /// .

• // est un opérateur qui va concaténer le contenu exact des deux variables (la taille exacte de l'opérande de gauche sera concaténée à la taille exacte de l'opérande de droite)
• /// est un opérateur qui va éliminer les blancs qui sont en partie droite de l'opérande de gauche.

...

/* ___ Déclarations _____________________________________________________________________
ALPHA( 10) wLeft 
ALPHA( 10) wRight
ALPHA( 20) wText1 
ALPHA( 20) wText2 
ALPHA( 20) wText3 

/* ___ Code _____________________________________________________________________________
wLeft  = 'Hello'
wRight = 'World' 
wText1 = wLeft //  wRight						/* wText1 = 'Hello     World     '
wText2 = wLeft /// wRight						/* wText2 = 'HelloWorld          '
wText3 = wLeft /// ' ' // wRight				/* wText3 = 'Hello World         '

2 -

...

Connaître la taille d'une chaîne de caractères

...

Pour connaître la taille d'une chaîne de caractères, il suffit d'utiliser la fonction prédéfinie &LONGUEUR_CHAINE Afin de découper une chaine de caractères en différentes chaînes (en une liste de chaines en réalité) par rapport à un séparateur, il suffit d'utiliser l'instruction SCINDER_CHAINE :

/* ___ Déclarations _____________________________________________________________________
alpha(num_bin_2  50) elementDay
liste       lst_days elementDay stringLength
alpha(1000100) myDays myString

/* ___ Code _____________________________________________________________________________
myDaysmyString  = 'Sunday;Monday;Tuesday;Wednesday;Thursday;Friday;Saturday' 
scinder_chaine  myDays= ';alpha beta' lst_days  	
stringLength    /* la liste "lst_days" contiendra 7 éléments : 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

3 - Remplacer une partie de chaine de caractères

= &longueur_chaine(myString)
    /* stringLength a pour valeur 10

3 - Découper une chaine de caractères par rapport à un séparateur

Afin de découper une chaine de caractères en différentes chaînes (en une liste de chaines en réalité) par rapport à un séparateurAfin de remplacer une partie de chaine de caractères, il suffit d'utiliser l'instruction RECHSCINDER_REMPLACERCHAINE :

/* ___ Déclarations _____________________________________________________________________
alpha(1000  50) myDays
alpha(1000) myDaysModified
alpha(  56) mySearchString
alpha(  78) myReplacementStringelementDay
liste       lst_days elementDay
alpha(1000) myDays

/* ___ Code _____________________________________________________________________________
myDays              = 'Sunday;Monday;Tuesday;Wednesday;Thursday;Friday;Saturday' 
mySearchStringscinder_chaine      =myDays ';'
myReplacementString =lst_days ' , '	
myDaysModified    /* la = *blank
rech_replacer myDays mySearchString myReplacementString myDaysModified
	/* la chaine myDaysModified contiendra 'Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday'

4 - Ajouter un "retour chariot" dans une chaine de manière à avoir un retour à la ligne dans un champs d'un écran.

liste "lst_days" contiendra 7 éléments : 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

4 - Remplacer une partie de chaine de caractères

Afin de remplacer une partie de chaine de caractères, il suffit d'utiliser l'instruction RECH_REMPLACER :Afin d'ajouter un "retour" à une variable alphanumerique, il faudra créer une chaine alpha contenant le caractère "CR" (carriage return) et le caractère "LF" (line feed).

/* ___ Déclarations _____________________________________________________________________
ALPHAalpha(  11000) myDays
alpha(1000) wCR myDaysModified
ALPHAalpha(  156) wLF mySearchString
ALPHAalpha(  278) wCRLF 
ALPHA(100) wText 

myReplacementString

/* ___ Code _____________________________________________________________________________
wCR = &CONVERSION_CAR('0D') 
wLF = &CONVERSION_CAR('0A') 
wCRLF = wCR // wLF 
wText = 'Hello' /// wCRLF /// 'world'

z_display = wText 

La propriété Multiligne de l'objet texte devra être cochée si vous voulez pouvoir voir le retour à l'écran).

Image Removed

Date, Time et Timestamp

1 - Effectuer des calculs sur des type date, time et timestamp

Afin d'effectuer des calculs sur des types Date, Time ou Timestamps, on utilisera les fonctions prédéfinies suivantes :

• &Calcul_Date
• &Calcul_Heure
• &Calcul_Timestp

myDays              = 'Sunday;Monday;Tuesday;Wednesday;Thursday;Friday;Saturday'
mySearchString      = ';'
myReplacementString = ' , '
myDaysModified      = *blank
rech_replacer myDays mySearchString myReplacementString myDaysModified
	/* la chaine myDaysModified contiendra 'Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday'

5 - Ajouter un "retour chariot" dans une chaine de manière à avoir un retour à la ligne dans un champs d'un écran.

Afin d'ajouter un "retour" à une variable alphanumerique, il faudra créer une chaine alpha contenant le caractère "CR" (carriage return) et le caractère "LF" (line feed).

/* ___ Déclarations _____________________________________________________________________
dateALPHA(  1) wCR     myDate
date
ALPHA(  1) wLF     myNewDate
time
ALPHA(  2) wCRLF     MyTime
time        MyNewTime
timestamp   MyTimestamp
timestamp   MyNewTimestamp

ALPHA(100) wText 

/* ___ Code _____________________________________________________________________________
myNewDatewCR = &calculCONVERSION_dateCAR(myDate;1;'Y0D')                      /* ajouter 1 année à myDate
myNewDate
wLF = &calculCONVERSION_dateCAR(myDate;-6;'M0A') 
wCRLF = wCR // wLF 
wText = 'Hello' /// wCRLF /// 'world'

z_display = wText 

La propriété Multiligne de l'objet texte devra être cochée si vous voulez pouvoir voir le retour à l'écran.

Image Added

...

Date, Time et Timestamp

1 - Effectuer des calculs sur des type date, time et timestamp

Afin d'effectuer des calculs sur des types Date, Time ou Timestamps, on utilisera les fonctions prédéfinies suivantes :

• &Calcul_Date
• &Calcul_Heure
• &Calcul_Timestp

/* ___ Déclarations _____________________________________________________________________
date       /* soustraire 6 mois à myDate
myNewDate = &calcul_date(myDate;40;'D')              myDate
date       /* ajouter 40 jours à myDate

myNewTime = &calcul_heure(myTime;1;'H') myNewDate
time        MyTime
time        MyNewTime
timestamp   MyTimestamp
timestamp    MyNewTimestamp

/* ajouter___ 1 heure à myTime
myNewTime = &calcul_heure(myTime;-6;'M'Code _____________________________________________________________________________
myNewDate = &calcul_date(myDate;1;'Y')                      /* soustraireajouter 61 minutesannée à myTimemyDate
myNewTimemyNewDate = &calcul_heuredate(myTimemyDate;40-6;'SM')                     /* ajoutersoustraire 406 secondesmois à myTimemyDate

myNewTimestampmyNewDate = &calcul_timestpdate(myTimestampmyDate;140;'Y D')        /*    ajouter 1 année à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp    /* ajouter 40 jours à myDate

myNewTime = &calcul_heure(myTime;1;'H')                     /* ajouter 1 heure à myTime
myNewTime = &calcul_heure(myTime;-6;'M ')                    /* soustraire 6 moisminutes à myTimestampmyTime
myNewTimestampmyNewTime = &calcul_timestpheure(myTimestampmyTime;40;'D S')                    /* ajouter 40 jourssecondes à myTimestampmyTime

myNewTimestamp = &calcul_timestp(myTimestamp;1;'HY ')        /* ajouter 1 heureannée à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;-6;'MIM ')       /* soustraire 6 minutesmois à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;40;'SD ')       /* ajouter 40 secondesjours à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;-30;'1;'H ')        /* ajouter 1 heure à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;-6;'MI')       /* soustraire 6 minutes à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;40;'S ')       /* ajouter 40 secondes à myTimestamp
myNewTimestamp = &calcul_timestp(myTimestamp;-30;'MS')      /* substraire 30 secondes à myTimestamp

...

/* ___ Déclarations _____________________________________________________________________
date        myDate1
date        myDate2
time        myTime1
time        myTime2
timestamp   myTimestamp1
timestamp   myTimestamp2
num_e(9,0)  myInterval1
num_e(9,0)  myInterval2
num_e(15,0) myInterval3

/* ___ Code _____________________________________________________________________________
myInterval1 = &ecart_dates(myDate1;myDate2)                   /* nombre de jours entre myDate1 et myDate2 (la valeur peut être négative si myDate1 est plus grand que myDate2)
myInterval2 = &ecart_heures(myTime1;myTime2)                  /* nombre de secondes entre myTime1 et myTime2 (la valeur peut être négative si myTime1 est plus grand que myTime2)

myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'Y ')   /* numbrenombre d'années entre myTimestamp1 et myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'M ')   /* numbernombre ofde months betweenentre myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'D ')   /* numbernombre ofde daysjours betweenentre myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'H ')   /* numbernombre ofd'heures hoursentre between myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'MI')   /* numbernombre ofde minutes betweenentre myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'S ')   /* numbernombre ofde secondssecondes betweenentre myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)
myInterval3 = &tms_interval(myTimestamp1;myTimestamp2;'MS')   /* numbernombre ofde microsecondsmicrosecondes betweenentre myTimestamp1 andet myTimestamp2 (la valeur peut être négative si myTimestamp1 est plus grand que myTimestamp2)

Image

1 - Transformer une variable alpha en variable image

3 - Extraire des informations d'une variable de type Date

Afin d'extraire des informations Si une variable de type image contient du texte, il est possible de transformer le contenu d'une variable de type alphanumérique en type image de la façon suivante : Date, on utilisera les fonctions prédéfinies suivantes :

• &Date_Annee
• &Date_Mois
• &Date_Jour
• &Date_Num

/* ___ Déclarations _____________________________________________________________________
alpha(date 100) fileAlias
alpha(  10) fileMode
alpha(5000) myAlpha
image       myImagemyDate
num_bin_4   nb4ReturnCodee(4,0)  myYear
num_e(2,0)  myMonth
num_e(2,0)  myDay
num_e(8,0)  myDateNum

/* ___ Code _____________________________________________________________________________
myAlphamyYear   = 'my text to be transformed to an image variable (2205)
fileAlias = 'myTransformation'
fileMode  = 'w'

charger_dll   'VATOOLBX.DLL'
appeler_dll   'VATOOLBX.DLL' 'VaToolBxOpenFile' fileAlias myImage fileMode nb4ReturnCode
appeler_dll   'VATOOLBX.DLL' 'VaToolBxWriteString' fileAlias myAlpha nb4ReturnCode
appeler_dll   'VATOOLBX.DLL' 'VaToolBxCloseFile' fileAlias nb4ReturnCode
decharger_dll 'VATOOLBX.DLL'

/* la variable myImage contient le texte initialement contenu dans la variable myAlpha.

2 - Transformer une variable image en variable alpha

Si une variable de type Image contient seulement du texte, il est possible de transformer la variable de type Image en type alpha de la façon suivante :

= &date_annee(myDate)                             /* extrait l'année de la date myDate (l'année sera au format SSAA)  
myMonth     = &date_mois(myDate)                              /* extrait le mois de la date myDate
myDay       = &date_jour(myDate)                              /* extrait le jour de la date myDate 
myDateNum   = &date_to_num(myDate)                            /* convertit la date myDate au format numérique (format SSAAMMJJ) 

...

Image

1 - Transformer une variable alpha en variable image

Il est possible de transformer le contenu d'une variable de type alphanumérique en type image de la façon suivante : 

/* ___ Déclarations 

/* ___ Déclarations _____________________________________________________________________
alpha( 100) fileAlias
alpha(  10) fileMode
num_bin_4   fileSize
alpha(5000) myAlpha
image       myImage

num_bin_4   nb4ReturnCode

/* ___ Code _____________________________________________________________________________
fileAliasalpha( = 'myTransformation'
fileMode  = 't'
fileSize  = 5000  

charger_dll   'VATOOLBX.DLL' 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxOpenFile' fileAlias myImage fileMode nb4ReturnCode 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxWriteString' fileAlias myAlpha nb4ReturnCode 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxReadFile' fileAlias myAlpha fileSize nb4ReturnCode 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxCloseFile' fileAlias nb4ReturnCode
decharger_dll 'VATOOLBX.DLL'

/* la variable myAlpha contient le texte alpha initialement contenu dans la variable myImage.
/* la variable fileSize contient le nombre de caractères lu de la variable myImage.

Listes

1 - Déclarations

Une liste peut être declarée avec des variables , ou en référence à une entité logique , ou en reference to à une autre liste , ou encore une combination de ces éléments .

/* ___ Déclarations de li _100) fileAlias
alpha(  10) fileMode
alpha(5000) myAlpha
image       myImage
num_bin_4   nb4ReturnCode

/* ___ Code _____________________________________________________________________________ 
LISTEmyAlpha LST_EXAMPLE  = 'my ELT_ONE ELT_TWO ELT_2205											/* définir une liste avec des éléments simples définis auparavant, ici les variables ELT_ONE, ELT_TWO et ELT_2205
LISTE LST_ART_ALC_2  *REF_MLD(HL_ART_ALCOOL)											/* définir une liste avec toutes les propriétés de l'entité HL_ART_ALCOOL
LISTE LST_ART_ALC_3  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) 					/* définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et HL_ART_LANGUE
LISTE LST_ART_ALC_4  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) w_COD_ARTICLE_1	/* définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et the HL_ART_LANGUE, plus la variable w_COD_ARTICLE_1
LISTE LST_ART_ALC_5  *REF_L(LST_ART_ALC_4) ELT_2205		                           		/* définir une liste avec toutes les propiétés de la liste LST_ART_ALC_4, plus la variable ELT_2205

2 - Utilisation des listes

1 - Ajouter des éléments

Une liste est un objet mémoire structuré composé de colonnes, c'est similaire à une table, mais en mémoire.

Pour insérer des données dans une liste, il suffit de frenseigner la valeur des variables colonnes de la liste, puis d'ajouter un élément à la list avec l'ordre L4G INSERER_ELT

Les éléments sont par défaut ajoutés à la fin de la liste (*FIN), mais on peut aussi les ajouter ...

• au début de la liste (INSERER_ELT *DEBUT)
• à la fin de la liste (INSERER_ELT *FIN)
• avant l'élément courant (INSERER_ELT *AVANT)
• après l'élément courant (INSERER_ELT *APRES)
• trié suivant une (ou plusieurs) colonne(s) (INSERER_ELT *TRI(...) )

text to be transformed to an image variable (2205)
fileAlias = 'myTransformation'
fileMode  = 'w'

charger_dll   'VATOOLBX.DLL'
appeler_dll   'VATOOLBX.DLL' 'VaToolBxOpenFile' fileAlias myImage fileMode nb4ReturnCode
appeler_dll   'VATOOLBX.DLL' 'VaToolBxWriteString' fileAlias myAlpha nb4ReturnCode
appeler_dll   'VATOOLBX.DLL' 'VaToolBxCloseFile' fileAlias nb4ReturnCode
decharger_dll 'VATOOLBX.DLL'

/* la variable myImage contient le texte initialement contenu dans la variable myAlpha.

2 - Transformer une variable image en variable alpha

Si une variable de type Image contient seulement du texte, il est possible de transformer la variable de type Image en type alpha de la façon suivante :

/* ___ Déclarations _____________________________________________________________________
alpha( 100) fileAlias
alpha(  10) fileMode
num_bin_4   fileSize
alpha(5000) myAlpha
image       myImage

num_bin_4   nb4ReturnCode

/* ___ Code _____________________________________________________________________________
fileAlias = 'myTransformation'
fileMode  = 't'
fileSize  = 5000  

charger_dll   'VATOOLBX.DLL' 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxOpenFile'    fileAlias myImage fileMode nb4ReturnCode 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxReadFile'    fileAlias myAlpha fileSize nb4ReturnCode 
appeler_dll   'VATOOLBX.DLL' 'VaToolBxCloseFile'   fileAlias                  nb4ReturnCode
decharger_dll 'VATOOLBX.DLL'

/* la variable myAlpha contient le texte alpha initialement contenu dans la variable myImage.
/* la variable fileSize contient le nombre de caractères lu de la variable myImage.

...

Listes

1 - Déclarations

Une liste peut être declarée avec des variables , en référence à une entité logique , en reference à une autre liste , ou encore une combination de ces éléments .Par default, les lignes insérées dans la liste ne sont pas considérées comme modifiées, mais on peut les indiquer comme modifées au momenet de l'insertion si on veut retrouver plus tard ces éléments modifiés. Pour ce faire, il suffit d'ajouter *MODIF à l'ordre INSERER_ELT.

/* ___ ListesDéclarations -de exemples d'utilisation listes ____________________________________________
ELT_ONE  = 1
ELT_TWO  = 2
ELT_2205 = 2205
INSERER_ELT LST_EXAMPLE 

INSERER_ELT LST_EXAMPLE *DEBUT_______________ 
LISTE LST_EXAMPLE    ELT_ONE ELT_TWO ELT_2205											/* pour insérer un élément au début de la liste
INSERER_ELT LST_EXAMPLE *FINdéfinir une liste avec des éléments simples définis auparavant, ici les variables ELT_ONE, ELT_TWO et ELT_2205
LISTE LST_ART_ALC_2  *REF_MLD(HL_ART_ALCOOL)											/* pourdéfinir insérerune unliste élémentavec àtoutes lales finpropriétés de la liste (comme c'est la valeur par défaut *FIN peut être omis)
INSERER_ELT LST_EXAMPLE *AVANT l'entité HL_ART_ALCOOL
LISTE LST_ART_ALC_3  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) 									/* pour insérer un élément dans la liste avant l'élément courant
INSERER_ELT LST_EXAMPLE *APRES  									/* pour insérer un élément dans la liste après l'élément courant
INSERER_ELT LST_EXAMPLE *TRI(ELT_2205 *DESC, ELT_TWO *ASC)			/* pour insérer un élément dans la liste trié par ELT_2205 descendant, puis ELT_TWO ascendand (*ASC est la valeur défaut, peut être omis)

INSERER_ELT LST_EXAMPLE *MODIF										/*  pour insérer un élément dans la liste ET en faire initialement un élément modifié (qui pourra être relu par LECTURE_LST LST_EXAMPLE *MODIF ...)

2 - Parcourir une liste

Afin de parcourir une liste, on pourra utiliser la boucle LECTURE_LST ... FIN_LECTURE_LST. 

Dans la boucle de parcours d'une liste on est positionné sur un élément et on peut modifier (avec MODIFIER_ELT) ou supprimer (avec SUPPRIMER_ELT) l'élément courant.

définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et HL_ART_LANGUE
LISTE LST_ART_ALC_4  *REF_MLD(HL_ART_ALCOOL) *REF_MLD(HL_ART_LANGUE) w_COD_ARTICLE_1	/* définir une liste avec toutes les propriétés des entités HL_ART_ALCOOL et HL_ART_LANGUE, plus la variable w_COD_ARTICLE_1
LISTE LST_ART_ALC_5  *REF_L(LST_ART_ALC_4) ELT_2205		                           		/* définir une liste avec toutes les propiétés de la liste LST_ART_ALC_4, plus la variable ELT_2205

2 - Utilisation des listes

1 - Ajouter des éléments

Une liste est un objet mémoire structuré composé de colonnes, c'est similaire à une table, mais en mémoire.

Pour insérer des données dans une liste, il suffit de renseigner la valeur des variables colonnes de la liste, puis d'ajouter un élément à la list avec l'ordre L4G INSERER_ELT

Les éléments sont par défaut ajoutés à la fin de la liste (*FIN), mais on peut aussi les ajouter ...

• au début de la liste (INSERER_ELT *DEBUT)
• à la fin de la liste (INSERER_ELT *FIN)
• avant l'élément courant (INSERER_ELT *AVANT)
• après l'élément courant (INSERER_ELT *APRES)
• trié suivant une (ou plusieurs) colonne(s) (INSERER_ELT *TRI(...) )

Par default, les lignes insérées dans la liste ne sont pas considérées comme modifiées, mais on peut les indiquer comme modifées au moment de l'insertion si on veut retrouver plus tard ces éléments modifiés. Pour ce faire, il suffit d'ajouter *MODIF à l'ordre INSERER_ELT.

/* ___ Listes - exemples d'utilisation __

/* ___ Liste - utilisations ___________________________________________________
ELT_ONE  = 1
ELT_TWO  = 2
ELT_2205 = 2205
LECTUREINSERER_LSTELT LST_EXAMPLE 

INSERER_ELT LST_EXAMPLE *DEBUT										/* ELT_ONEpour contientinsérer laun valeurélément deau ladébut première ligne de la liste (pour la colonne ELT_ONE), de même pour ELT_TWO et ELT_2205
  ...
  SI ...
    SUPPRIMER
INSERER_ELT LST_EXAMPLE *FIN										/* pour insérer un élément à la fin de la liste (comme c'est la valeur par défaut *FIN peut être omis)
INSERER_ELT LST_EXAMPLE *AVANT  									/* onpour peutinsérer supprimerun l'élément courant
dans la FIB
liste avant SI ...
    ELT_ONE = ELT_ONE + 1
    MODIFIER_ELT LST_EXAMPLEl'élément courant
INSERER_ELT LST_EXAMPLE *APRES  									/* on peut modifier les valeurs depour insérer un élément dans la liste après l'élément courant en modifiant une (ou plusieurs) des colonnes qui le composent     
	MODIFIER
INSERER_ELT LST_EXAMPLE *TRI(ELT_2205 *DESC, ELT_TWO *ASC)			/* pour insérer un élément dans la liste trié par ELT_2205 descendant, puis ELT_TWO ascendant (*ASC est la valeur défaut, peut être omis)

INSERER_ELT LST_EXAMPLE	*SELECT *MODIF										/* enpour modifiantinsérer un élément ondans peutla ajouterliste l'attributET SELECTen oufaire DESELECTinitialement 
un élément FIN 
FIN_modifié (qui pourra être relu par LECTURE_LST

/* LST___EXAMPLE Pour une liste graphique, on peut parcourir les éléments sélectionnés par l'utilisateur ___
LECTURE_LST LST_GRAPHICAL *SELECT
	... 
*MODIF ...)

2 - Parcourir une liste

Afin de parcourir une liste, on pourra utiliser la boucle LECTURE_LST ... FIN_LECTURE_LST. 

Dans la boucle de parcours d'une liste on est positionné sur un élément et on peut modifier (avec MODIFIER_ELT) ou supprimer (avec SUPPRIMER_ELT) l'élément courant.

  

/* ___ PourListe une- liste graphique, on peut parcourir les éléments modifiés par l'utilisateur ou par programme si l'attribut *MODIF a été spécifié au moment de l'insertion ___
LECTURE_LST LST_GRAPHICAL *MODIF
	...
FIN_LECTURE_LST

On peut aussi utiliser une boucle manuelle avec LIRE_P_ELT (lire le premier élément) et LIRE_AV_ELT (lire l'élément suivant).

On peut également utililser LIRE_D_ELT (lire le denier élément) and LIRE_AR_ELT (lire l'élément précédent).

/* ___ Lists usage utilisations ______________________________________________________ 
LECTURE________________________________
READ_F_ELT LST_EXAMPLE 							/* we try to read the first element of the list (if it exists)
DO_WHILE &CODE_LST(LST_EXAMPLE) = *NORMAL		/* did the last operation on the list end successfully ?
  LST LST_EXAMPLE 

  /* ELT_ONE contient la valeur de la première ligne de la liste (pour la colonne ELT_ONE), de même pour ELT_TWO et ELT_2205
  ...
  SI ...
  READ  SUPPRIMER_NX_ELT LST_EXAMPLE						/* tryon to read the next element of the list
REDO

READ_Lpeut supprimer l'élément courant
  FIB
  SI ...
    ELT_ONE = ELT_ONE + 1
    MODIFIER_ELT LST_EXAMPLE 							/* weon peut trymodifier toles readvaleurs thede lastl'élément elementcourant ofen themodifiant listune (if it exists)
DO_WHILE &CODE_LST(LST_EXAMPLE) = *NORMALou plusieurs) des colonnes qui le composent     
	MODIFIER_ELT LST_EXAMPLE	*SELECT			/* diden themodifiant lastun operationélément on thepeut listajouter endl'attribut successfullySELECT ?
ou DESELECT ...
  FIN READ
FIN_PRLECTURE_ELT LST_EXAMPLE						LST

/* try to read the next element of the list
REDO

3 - Parse a list using indexes

...

___ Pour une liste graphique, on peut parcourir les éléments sélectionnés par l'utilisateur ___
LECTURE_LST LST_GRAPHICAL *SELECT
	... 
FIN_LECTURE_LST  

/* ___ Pour une liste graphique, on peut parcourir les éléments modifiés par l'utilisateur ou par programme si l'attribut *MODIF a été spécifié au moment de l'insertion ___
LECTURE_LST LST_GRAPHICAL *MODIF
	...
FIN_LECTURE_LST

On peut aussi utiliser une boucle manuelle avec LIRE_P_ELT (lire le premier élément) et LIRE_AV_ELT (lire l'élément suivant).

On peut également utililser LIRE_D_ELT (lire le denier élément) and LIRE_AR_ELT (lire l'élément précédent).

/* ___ Liste - utilisations

...

/* ___ Lists declarations _______________________________________________________________
LIST       LST_EXAMPLE    ELT_ONE ELT_TWO ELT_2205		/* defining a list with single elements defined previously, here ELT_ONE, ELT_TWO and ELT_2205 variables
LIST_INDEX MY_INDEX LST_EXAMPLE ELT_2205			    /* we define the MY_INDEX index that will index the LST_EXAMPLE list on the ELT_2205 column

/* ___ Lists usage _______________________________________________________________
ELT_2205 = 67											/* we set the value we want to reach in the list
READ_ELT MY_INDEX 			 
LIRE_P_ELT LST_EXAMPLE 							/* welecture trydu topremier readélément thede firstla element of the list with the value 67 in the column ELT_2205
IFliste (s'il existe)
TANT_QUE &CODE_LST(MYLST_INDEXEXAMPLE) = *NORMAL						/* didest-ce theque findl'opération thea elementréussi with?
 the searched...
 value ?
  ... LIRE_AV_ELT LST_EXAMPLE													/* iflecture yes, then we are on the element, we can use it, modify it or delete it.
END

ELT_2205 = 67
READ_F_ELT MY_INDEXde l'élément suivant (s'il existe)
REFAIRE

LIRE_D_ELT LST_EXAMPLE 									/* readslecture thedu firstdernier elementélément thatde isla greater or equal to the column value of the index
DO_WHILEliste (s'il existe) 
TANT_QUE &CODE_LST(MYLST_INDEXEXAMPLE) = *NORMAL
  		/* est-ce que l'opération a réussi ?
  ...
  READLIRE_NXAR_ELT MY_INDEX
REDO

DELETE_INDEX MY_INDEXLST_EXAMPLE									/* deletelecture thede indexl'élément ifprécédent it(s's not needed anymore, to free the memory used by the index

An index is first created when the first read is done on on it (with READ_ELT or READ_F_ELT).

When an index is not needed more, we can destroy it (to release memory) with the  DELETE_INDEX instruction

4 - Operations on lists

...

il existe)
REDO

3 - Parcourir une liste en utilisant des indexs

Afin de parcourir une liste pour chercher un élément (ou à partir d'un élément), on peut crééer et ustiliser des listes indexées (avec l'instruction INDEX_LIST).

On pourra alors utiliser les instructions LIRE_ELT (pour lire un élément) ou LIRE_P_ELT (pour accéder au premier élément supérieur ou égal à la valeur de l'index).

...

/* ___ ListsDéclarations de usagelistes _______________________________________________________________
CLEAR_LST LST_EXAMPLE							/* clear the list specified
COPY_LST  LST_ONE LST_TWO   					/* copy the content of the list LST_ONE in the list LST_TWO, 
												/* the two lists are identical at the end of the instruction, 

LISTE       LST_EXAMPLE    ELT_ONE ELT_TWO ELT_2205		/* définit une liste avec 3 "colonnes" précédemment déclarés, ici les variables ELT_ONE, ELT_TWO et ELT_2205
INDEX_LISTE MY_INDEX       LST_EXAMPLE ELT_2205		    /* définit l'index MY_INDEX qui va indexer la liste LST_EXAMPLE sur la colonne ELT_2205

/* ___ Liste - utilisations ______________________________________________________ 
ELT_2205 = 67												/* thevaleur twoqu'on listsveut mustatteindre havedans thela same structureliste
INSERTLIRE_LSTELT LSTMY_ONE LST_TWOINDEX 										/* addon theessaie contentde oflire thele firstpremier listélément to the second list
de la list qui contiendrait la valeur 67 dans la colonne ELT_2205
SI &CODE_LST(MY_INDEX) = *NORMAL						/* a-t-on trouvé ?
  ...													/* bysi defaultoui, thealors elementson areest addedpositionné at the endsur l'élément, buton we can specify *BEGIN, *END, *BEFORE, *AFTER
INSERT_LST LST_ONE LST_TWO *BEGIN				/* add the content of the first list at the start of the second list 
INSERT_LST LST_ONE LST_TWO *END					/* add the content of the first list at the end of the second list 
INSERT_LST LST_ONE LST_TWO *BEFORE				/* add the content of the first list just before the current element of the second list 
INSERT_LST LST_ONE LST_TWO *AFTER				/* add the content of the first list just before the current element of the second list 

SORT_LST LST_EXAMPLE ELT_2205 *DESC, ELT_ONE	/* sort the list on the ELT_2205 colum in descending order and then on ELT_ONE column ascending

SQL

1 - Null values

When reading information from the database, we sometimes have to deal with NULL values.

For example if you want to search for the AVERAGE (or MIN, MAX etc) value of a column, sometimes your *COND(condition) will return no line or you have null values for the specified columns.

And sometime you have to know that there is no value.

To do this we have to use indicators.

peut l'utiliser, le modifier ou le supprimer.
FIN

ELT_2205 = 67
LIRE_P_ELT MY_INDEX 									/* lire le premier élément dont la valeur de colonne LT_2205 est supérieure ou égale à la valeur positionnée pour l'index (67)
TANT_QUE &CODE_LST(MY_INDEX) = *NORMAL                  /* est-ce que la dernière opération sur l'index a réussi ?
  ...
  LIRE_AV_ELT MY_INDEX
REFAIRE

DETRUIRE_INDEX MY_INDEX									/* supprimer l'index si on ne l'utilise plus, pour libérer la mémoire qu'il utilise

Un index est créé au moment où on l'utilise pour la première fois en lecture.

Quand un index n'a plus d'utiliité dans le programme, on peut le détruire (pour libérer de la mémoire) avec l'instruction DETRUIRE_INDEX.

4 - Operations sur les listes

Pour vider une liste , on utilisera l'instruction L4G VIDER_LST,

Pour copier une liste dans une autre liste, on utilisera l'instruction L4G COPIER_LST,

Pour inserer une liste dans une autre liste, on utilisera l'instruction L4G INSERER_LST, 

Pour trier une liste , on utilisera l'instruction L4G TRIER_LST.

/* ___ Utlisation de listes 

/* ___ Declarations _____________________________________________________________________
num_bin_2
VIDER_LST   wIndAverage
num_e( 8,2) wAverageValue
num_bin_2   wIndMax
num_e( 8,2) wMaxValue

/* ___ Code _____________________________________________________________________________
chain_sql employee *col(	average(age) 	:wAverageValue 	:wIndAverage, 	-LST_EXAMPLE								/* efface la liste,
COPIER_LST  LST_ONE LST_TWO   						/* copier le contenu de la liste LST_ONE dans la liste LST_TWO, 
							max(age) 		:wMaxValue 		:wIndMax 		- 
				   *cond( name='milkwater')/* les deux listes sont identiquesà la fin de l'opération, 
													/* les deux searchlistes fordoivent theavoir averagela and max age of employees with name equals to "milkwater" 
if wIndAverage = -1 
	/* no value for the average
else
	/* ...
end
if wIndMax = -1 
	/* no value for the maximum
else
	/* ...
end

2 - Locked records

One or several lines in a table can be locked. This is caused by a process which modified records in a table without committing the changes. The consequence is that no other process can modify the lines before the first commit or rollback was executed. Even a locked record can not be modified, it can be read by another database user.

With the reserved world *LOCKED, it is possible in Adelia to check if a record is locked. It needs to be used after a database modification statement (UPD_SQL or DELETE).

• *LOCKED = '1' : record is locked 
• *LOCKED = '0' : record is not locked (we can use the constant _RECORD_LOCKED instead of the value '1')

même structure,
INSERER_LST LST_ONE LST_TWO							/* ajoute le contenu de la première liste à la seconde liste,
													/* par défaut les éléments sont ajoutés à la fin de la liste de destination, mais on peut spécifier *DEBUUT, *FIN, *AVANT, *APRES
INSERER_LST LST_ONE LST_TWO *DEBUT					/* ajoute le contenu de la première liste au début de la seconde liste
INSERER_LST LST_ONE LST_TWO *FIN		      		/* ajoute le contenu de la première liste à la fin de la seconde liste
INSERER_LST LST_ONE LST_TWO *AVANT					/* ajoute le contenu de la première liste avant l'élément courant de la seconde liste 
INSERER_LST LST_ONE LST_TWO *APRES					/* ajoute le contenu de la première liste après l'élément courant de la seconde liste 

TRIER_LST   LST_EXAMPLE ELT_2205 *DESC, ELT_ONE		/* trier la liste sur la colonne ELT_2205 en ordre décroissant et sur la colonne ELT_ONE par ordre croissant

...

SQL

1 - Valeurs nulles

Quand on lit des informations en provenance de la base de données, on doit parfois gérer des valeurs NULLES.

Par exemple si on veut gérer les valeurs MOYENNE (ou MIN, MAX etc) des colonnes, parfois le *COND(condition) ne retourne aucune ligne ou bien on peut avoir des valeurs nulles dans les colonnes spécifiées.

Et parfois il est important de savoir qu'il n'y a pas de valeur.

Pour faire celà, on utilisera des indicateurs.

/* ___ Declarations ____

/* ___ Code _____________________________________________________________________________

/* ___ Force Oracle to answer after a certain amount of time, even if the record is locked ______________________________
/* ___ Here we will have an answer after 5 seconds maximum. _____________________________________________________________
/* ___ The 'P' parameter means all the queries submitted during the session will have this timeout delay ________________
/* ___ A 'T' parameter would mean that only the next query submitted during the session would have this timeout delay ___

call_dll 'VATOOLBX.DLL' 'VaToolBxSetTimeOut' 5 'P' returnCodeBool_________________________________________________
num_bin_2   wIndAverage
num_e( 8,2) wAverageValue
num_bin_2   wIndMax
num_e( 8,2) wMaxValue

/* ___ Try to do an update to a database record ___

updCode _____________________________________________________________________________
lire_sql employee *col(	moyenne(age = age + 1 ) 	:wAverageValue 	:wIndAverage, 	-
							max(age) 		:wMaxValue 		:wIndMax 	- 
				   *cond( name='milkwater')										 
if *locked = _RECORD_LOCKED/* recherche de la moyenne et du max des ages des employés dont le nom est égal à "milkwater" 
si wIndAverage = -1 
	/* the record(s) is(are) locked 
elsepas de valeur pour la moyenne
sinon
	/* the record(s) is(are) not locked and has been updated
end

Random values

In order to generate random values, we can use 2 functions of the VaToolBx package in Adelia.

• VaToolBxSeedRand
• VaToolBxRandom

1 - VaToolBxSeedRand

The VaToolBxSeedRand function is used to reset the pseudo-random number generator, which is used by the VaToolBxRandom function. 

2 - VaToolBxRandom

The VaToolBxRandom function is used to generate random values.
The result is a NUM_BIN_4 number between -2147483648 and 2147483647.
To have a value between 0 and X you can use  &ABSOLUTE_VALUE and &MODULO functions (see the example above)

3 - Example

...

 ...
fin
si wIndMax = -1 
	/* pas de valeur pour le maximum
sinon
	/* ...
fin

2 - Enregistrements verrouillés

Une ou plusieurs lignes d'une table peuvent être verrouillées. Ceci peut être dû à un processus qui a modifié des éléments sans pour autant avoir validé (commit) les modifications. En conséquence, aucun autre processus ne pourra modifier les lignes avant qu'une instruction VALIDER_MAJ (ou ANNULER_MAJ) n'ait été exécutée.
Si un enregistrement verrouillé, alors il ne pourra pas être modifié. Par contre il pourra être lu par un autre utilisateur.

Le mot reservé *BLOQUE permet de vérifier si un enregistrement est verrouillé. On le consulte après un accès modifiant la base de données (MAJ_SQL ou SUPPRIMER_SQL etc..).

• *BLOQUE = '1' : l'enregistrement est verrouillé 
• *BLOQUE = '0' : l'enregistrement n'est pas verrouillé (on peut également utiliser la constante _RECORD_LOCKED à la place de la valeur '1')

/* ___ Code _____________________________________________________________________________

/* ___ Forcer Oracle à répondre après un certain délai, même si l'enregistrment est verrouillé __________________________
/* ___ Dans l'exemple qui suit, une réponse sera fournie après 5 secondes au maximum. ___________________________________
/* ___ Le paramètre 'P' indique que toutes les requêtes soumises durant la session utiliseront ce délai _________________
/* ___ Le paramètre 'T' indiquerait que seule la requête suivante aurait ce délai _______________________________________

appeler_dll 'VATOOLBX.DLL' 'VaToolBxSetTimeOut' 5 'P' returnCodeBool

/* ___ Tentative de mise à jour d'un enregistrement ___

maj_sql employee age = age + 1 - 
				   *cond( name = 'milkwater')										 
if *bloque = '1'
	/* l'enregistrement est verrouillé 
else
	/* l'(les) enregistement(s) ne sont pas bloqués et ont été mis à jour
end

...

Valeurs aléatoires

Pour générer des valeurs aléatoires, on peut utliiser les deux fonctions suivantes de la VaToolBx.

• VaToolBxSeedRand
• VaToolBxRandom

1 - VaToolBxSeedRand

La fonction VaToolBxSeedRand est utilisée pour réinitialiser le générateur de nombre pseudo-aléatoire, lequel est utilisé par la fonction VaToolBxRandom. 

2 - VaToolBxRandom

La fonction VaToolBxRandom est utilisée pour generater une valeur aléatoire.
Le resultat est un nombre de type NUM_BIN_4 compris entre -2147483648 et 2147483647.
Pour avoir une valeur comprise entre 0 et X on peut utiliser les fonctions &VALEUR_ABSOLUE et &MODULO (voir l'example ci-dessous)

3 - Example

Example to retrieve a value between 1 and 10 :

/* ___ Declarations _____________________________________________________________________
num_e(6,0) wTime
num_bin_4  wSeedValue
num_bin_4  wRandomValue

/* ___ Code _____________________________________________________________________________

/* ___ Generate a seed value ____________________________________________________________
time 		 wTime
wSeedValue = wTime
call_dll 'vatoolbx.dll' 'VaToolBxSeedRand' wSeedValue 

/* ___ Generate a random value 

...

Example to retrieve a value between 1 and 10 :

/* ___ Declarations _____________________________________________________________________
num_e(6,0) wTime
num_bin_4  wSeedValue
num_bin_4call_dll 'vatoolbx.dll' 'VaToolBxRandom'   wRandomValue

/* ___ Code Calculate a value between 1 and 10 _____________________________________________________________________
wRandomValue = &absolute_value(wRandomValue)
wRandomValue = &modulo(wRandomValue;10)
wRandomValue = wRandomValue + 1

...

Dynamic program call

We can use the CALL instruction to call a dynamic program, with static or even dynamic parameters

1 - Dynamic call examples

/* ___ Declarations ________

/* ___ Generate a seed value ____________________________________________________________
time 		 wTime
wSeedValue = wTime
call_dll 'vatoolbx.dll' 'VaToolBxSeedRand' wSeedValue 
alpha(  10)  wProgramObjectFileName
alpha( 128)  wProgramPublicProcedureName
alpha(1000)  wParameters
num_e( 2,0)  myParameterNum01
num_e( 2,0)  myParameterNum02

/* ___ Generate a random value Code ___________________________________________________________________________________
call_dll 'vatoolbx.dll' 'VaToolBxRandom'   wRandomValue
call myProgram
call myProgram.myProcedure
myParameterNum01= 22
call myProgram.myProcedure2 myParameterNum01
myParameterNum01= 22
myParameterNum02= 05
call myProgram.myProcedure2 myParameterNum01 myParameterNum02

/* ___ CalculateDynamic aprogram value between 1 and 10 name _____________________________________________________________
wRandomValuewProgramObjectFileName = &absolute_value(wRandomValue)
wRandomValue = &modulo(wRandomValue;10)
wRandomValue = wRandomValue + 1

Dynamic program call

We can use the CALL instruction to call a dynamic program, with static or even dynamic parameters

1 - Dynamic call examples

/* ___ Declarations'mypgm'
call &wProgramObjectFileName 

wProgramObjectFileName      = 'mypgm'
call &wProgramObjectFileName.myProcedure

/* ___ Dynamic program name and public procedure name ___________________________________
wProgramObjectFileName      = 'mypgm'
wProgramPublicProcedureName = 'myProcedure'
call &wProgramObjectFileName.&wProgramPublicProcedureName

wProgramObjectFileName      = 'mypgm'
wProgramPublicProcedureName = 'myProcedure2'
myParameterNum01            = 22
call &wProgramObjectFileName.&wProgramPublicProcedureName myParameterNum

/* ___ Dynamic program name, procedure name and parameters _______________________________
alpha(  10)  wProgramObjectFileName
alpha( 128)  wProgramPublicProcedureName
alpha(
wProgramObjectFileName      = 'mypgm'
wProgramPublicProcedureName = 'myProcedure2'
wParameters                 = '22 05'
call &wProgramObjectFileName.&wProgramPublicProcedureName &wParameters

...

Users's attribute

User session can be used to store and retrieve values.

1 - Set an attribute value

To set a session private attribute value, we simply have to use the  VaToolBxCloudSetUserAttribute fonction of the vaToolBx library :

1000)  wParameters
num_e( 2,0)  myParameterNum01
num_e( 2,0)  myParameterNum02

/* ___ Code ________Declarations _____________________________________________________________________
call myProgram
call myProgram.myProcedure
myParameterNum01= 22
call myProgram.myProcedure2 myParameterNum01
myParameterNum01= 22
myParameterNum02= 05
call myProgram.myProcedure2 myParameterNum01 myParameterNum02

alpha( 50) wAttributeName
alpha(256) wAttributeValue

/* ___ Dynamic program name ________________Code _____________________________________________
wProgramObjectFileName = 'mypgm'
call &wProgramObjectFileName 

wProgramObjectFileName      = 'mypgm'
call &wProgramObjectFileName.myProcedure

/* ___ Dynamic program name and public procedure name ___________________________________
wProgramObjectFileNamewAttributeName      = 'mypgm'
wProgramPublicProcedureName = 'myProcedure'
call &wProgramObjectFileName.&wProgramPublicProcedureName

wProgramObjectFileName      = 'mypgm'
wProgramPublicProcedureName = 'myProcedure2'
myParameterNum01            = 22
call &wProgramObjectFileName.&wProgramPublicProcedureName myParameterNum

/* ___ Dynamic program name, procedure name and parameters ______________________________
wProgramObjectFileNamemyLabel'							/* Label 
wAttributeValue = 'xxxyyyzzz'						/* Value to be stored under the user session (must be alpha value)
call_dll 'VaToolBx' 'VaToolBxCloudSetUserAttribute' wAttributeName  -
                            = 'mypgm'
wProgramPublicProcedureName = 'myProcedure2'
wParameters                 = '22 05'
call &wProgramObjectFileName.&wProgramPublicProcedureName &wParameters

Users's attribute

User session can be used to store and retrieve values.

...

 wAttributeValue

The scope of this setting is limited to the current session (logout / logon will destroy all values).

2 - Retrieve an attribute value

To set retrieve a session private attribute value, we simply have to use the  VaToolBxCloudSetUserAttribute VaToolBxCloudGetUserAttribute fonction of the vaToolBx library :

/* ___ Declarations _____________________________________________________________________
alpha( 50) wAttributeName
alpha(256) wAttributeValue
num_bin_4  wAttributeLength

/* ___ Code _____________________________________________________________________________
wAttributeName   = 'myLabel'							/* Label 
wAttributeValue  = *blank
wAttributeLength = 'xxxyyyzzz'256								/* ValueSize to be stored under of the user session (must be alpha value)wAttributeValue variable
call_dll 'VaToolBx' 'VaToolBxCloudSetUserAttributeVaToolBxCloudGetUserAttribute' wAttributeName   -
                                                    wAttributeValue  -
                                                    wAttributeLength
if *return_code = *normal
   /* wAttributeValue

The scope of this setting is limited to the current session (logout / logon will destroy all values).

...

 contains the value previously saved
end

3 - Delete an attribute value

To retrieve delete a session private attribute value, we simply have to use the  VaToolBxCloudGetUserAttribute VaToolBxCloudSetUserAttribute fonction of the vaToolBx library with a blank value :

/* ___ Declarations _____________________________________________________________________
alpha( 50) wAttributeName
alpha(256) wAttributeValue
num_bin_4  wAttributeLength

/* ___ Code _____________________________________________________________________________
wAttributeName   = 'myLabel'							/* Label 
wAttributeValue  = *blank
wAttributeLength = 256								/* * Size ofblank to delete the label from the wAttributeValueuser's variablesession
call_dll 'VaToolBx' 'VaToolBxCloudGetUserAttributeVaToolBxCloudSetUserAttribute' wAttributeName   -
                                                    wAttributeValue  -
                                                    wAttributeLength
if *return_code = *normal
      /* wAttributeValue contains the value previously saved
end

3 - Delete an attribute value

To delete a session private attribute value, we simply have to use the  VaToolBxCloudSetUserAttribute fonction of the vaToolBx library with a blank value :

 wAttributeValue

...

Management Rules

Management rules (MR) can be used if we don't want to repeat the same code on different parts of the code.
The management rule can have parameters and must be seen as a text that will be parsed inside the code.

1 - Parameters

The parameter 1 of the MR will be placed in place of the :01 value etc.
The :01 (:xx) value can be present multiple times inside the MR.
The :01 (:xx) value can be placed anywhere in the code, even to replace an Adelia order or part of it.

/* ___ DeclarationsManagement Rule "My___________Beautiful_MR" __________________________________________________________
alpha( 50) wAttributeName
alpha(256) wAttributeValue

/* ___ Code ________Declarations _____________________________________________________________________
wAttributeName  = 'myLabel'							/* Label 
wAttributeValue = *blank							/* *blank to delete the label from the user's session
call_dll 'VaToolBx' 'VaToolBxCloudSetUserAttribute' wAttributeName  -
                   _____
decl alpha( 50)                                 wAttributeValue

Management Rules

Management rules (MR) can be used if we don't want to repeat the same code on different parts of the code.
The management rule can have parameters and must be seen as a text that will be parsed inside the code.

1 - Parameters

The parameter 1 of the MR will be placed in place of the :01 value etc.
The :01 (:xx) value can be present multiple times inside the MR.
The :01 (:xx) value can be placed anywhere in the code, even to replace an Adelia order or part of it.

/* ___ Management Rule "My_Beautiful_MR" w:01_val
decl ref(cli_usr_:02 client) wCli_usr_:02
decl num_e(9,0)              sqlcode_mr

/* ___ Code _____________________________________________________________________________
wcli_usr_:02  = :03							
if wcli_usr_:02 = *blank 
	wcli_usr_:02 = *user
end
upd_sql client cli_usr_:02 = :wcli_usr_:02
sqlcode_mr = *sqlcode
:06 insert_mr BOL_TRC_:05('*DEBUG';'my beautiful MR, sqlCode : '//sqlcode_mr ;1)
:04 = sqlcode______

mr 

2 - Usage

To use a MR, we simply have to insert it with the INSERT_MR order

/* ___ DeclarationsCode _____________________________________________________________________
decl alpha( 50)              w:01_val
decl ref(cli_usr_:02 client) wCli_usr_:02
decl num_e(9,0)              sqlcode_mr

/* _____ Code _________________
insert_mr my_beautiful_mr(test;cre;'milkwater';mrReturnCode;C; )
insert_mr my_beautiful_mr(test;maj;*blank;mrReturnCode;S;*)

...

Graphical objects

1 - get an object from his object name

In order to get the handle of an object from the name of the object it's possible to use the predefined function &GET_OBJECT :

/* ___ Declarations ___________________________________________________
wcli_usr_:02  = :03							
if wcli_usr_:02 = *blank 
	wcli_usr_:02 = *user
end
upd_sql client cli_usr_:02 = :wcli_usr_:02
sqlcode_mr = *sqlcode
:06 insert_mr BOL_TRC_:05('*DEBUG';'my beautiful MR, sqlCode : '//sqlcode_mr ;1)
:04 = sqlcode_mr 

2 - Usage

To use a MR, we simply have to insert it with the INSERT_MR order

_______________
graphic_object(colonne) colObjVar

/* ___ Code _____________________________________________________________________________
insert_mr my_beautiful_mr(test;cre;'milkwater';mrReturnCode;C; )
insert_mr my_beautiful_mr(test;maj;*blank;mrReturnCode;S;*)

Graphical objects

1 - get an object from his object name

In order to get the handle of an object from the name of the object it's possible to use the predefined function &GET_OBJECT :

colObjVar = &get_object('col_01')
colObjVar:visibility = *true

...

Classes

Les classes sont utilisées notament pour consommer ou produire des services web

1 - JSON

Pour générer ou bien utiliser le format suivant dans un fichier JSON

{
...
   "BarCodeList":[
      "2205",
      "2206",
      "2207"
   ]
...
}

Il faudra effectuer la déclaration suivante dans la définition de la classe Adelia MA_CLASSE :

*attributs
{
...
alpha(   32)                BarCodeList()          *ser_nom('BarCodeList');
...
}

Puis le code adelia suivant pour pouvoir générer des données dans ce élément :

alpha(   32)                BarCodeList()          *ser_nom('BarCodeList');

/* ___ Declarations _____________________________________________________________________
graphic_object(colonne) colObjVar

/* ___ Code _____________________________________________________________________________
colObjVar = &get_object('col_01')
colObjVar:visibility = *true

...

Resources

Ressources are typically used to import "external" objects in the adelia environment.
The advantage to import an object in the adelia environment is that we don't need any more the external object to use it.
It will be saved also with the backup of the environment.

...

/* ___ Declarations _____________________________________________________________________
image wImage

/* ___ Declarations Code _____________________________________________________________________________
insert_mr bol______________________
image wImage

/* ___ Code _____________________________________________________________________________
insert_mr bol_trc_imagea('*DEBUG';'my text ';wImage;1)

BOL database scripts

1 - Set new PAPG values

PAPG example :

trc_imagea('*DEBUG';'my text ';wImage;1)

...

BOL database scripts

1 - Set new PAPG values

PAPG example :

-- Create program configuration option MYCONFIG
delete from wms.hlxprop where XPCPRG = 'MYCONFIG';
insert into wms.hlxprop values('MYCONFIG', 'My configuration', 'MYCONFIG', '007', '011', '0', '0', 0);

delete from wms.hlpgpap where GKCPRG = 'MYCONFIG';
insert into wms.hlpgpap values('MYCONFIG',' ','1','0',' ');

delete from wms.hlpapdp where GJCPRG = 'MYCONFIG';
insert into wms.hlpapdp values('MYCONFIG',1,'Code',3,' ',' ',' ')

-- Create program configuration option MYCONFIG
delete from wms.hlxprop where XPCPRG = 'MYCONFIG';
insert into wms.hlxprophlpapdp values('MYCONFIG', 'My configuration', 4,'Designation',100,' ',' ',' ');
insert into wms.hlpapdp values('MYCONFIG',104, '007Active',1,' '011,', '0,', '0', 0);

delete from wms.hlpgpap where GKCPRG = 'MYCONFIG';
insert into wms.hlpgpap values('MYCONFIG',' ','1','0',' ');

delete from wms.hlpapdp where GJCPRG = 'MYCONFIG';
insert into wms.hlpapdp values('MYCONFIG',1,'Code',3,' ',' ',' ');
insert into wms.hlpapdp values('MYCONFIG',4,'Designation',100,' ',' ',' ');
insert into wms.hlpapdp values('MYCONFIG',104,'Active',1,' ',' ',' ');

BOL REST services

1 - Call swagger REST API page

The url address of the swagger REST API page is :

• https://reflex.dev.bfc.bol.com/reflexWS/rest/api-docs?url=/reflexWS/rest/swagger.json

Image Removed

2 - Generate the JWT token

To generate the JWT token, you'll have to access to the following url, but replace XXX with your reflex login and YYY with your reflex password

• https://reflex.dev.bfc.bol.com/reflexWS/JWTServlet?login=XXX&password=YYY

Image Removed

3 - Apply the JWT token

To apply the JWT token to the rest call, press the Authorize button on top of the REST API page.

Image Removed

Then enter "JWT" , a space character AND the token generated for your user/pass informations.

Image Removed

 ');

...

BOL REST services

1 - Call swagger REST API page

The url address of the swagger REST API page is :

• https://reflex.dev.bfc.bol.com/reflexWS/rest/api-docs?url=/reflexWS/rest/swagger.json

Image Added

2 - Generate the JWT token

To generate the JWT token, you'll have to access to the following url, but replace XXX with your reflex login and YYY with your reflex password

• https://reflex.dev.bfc.bol.com/reflexWS/JWTServlet?login=XXX&password=YYY

Image Added

3 - Apply the JWT token

To apply the JWT token to the rest call, press the Authorize button on top of the REST API page.

Image Added

Then enter "JWT" , a space character AND the token generated for your user/pass informations.

Image Added

Then press Authorize button.

...

REFLEX REST services web

1 - Swagger et visualisation des web services spécifiques

Afin de pouvoir visualiser ses services web spécifiques dans l'interface de swagger, il faudra modifier le fichier de configuration wsRestConf.properties présent dans le répertoires de configuration reflex web (C:\Hardis\Reflex\conf en version windows)

On ajoutera la valeur ",com.hardis.reflex" à la ligne correspondant à la clef "SWAGGER2FEATURE.resourcePackage"

...
SWAGGER2FEATURE.resourcePackage=com.hardis.reflex.publicapi,com.hardis.adelia.webservice,com.hardis.reflex
...

2 - Swagger et chapitres

Afin de regrouper les web services par types de services sans avoir à mettre tous les services (procédures) dans le même programme, il suffira d'ajouter dans le code de configuration "sw_configurer *service _ws_rest_swag_description ..." pour que le service soit ajouté à un groupe de web services.

Par exemple afin de regrouper des services web de test sous le chapitre "XXX - Web services de test (STUB)", il faudra écrire le code suivant dans le paragraphe DECL_PGM du programme contenant le(s) service(s) :

DECL_PGM
...
sw_configurer *service _ws_rest_swag_description 'XXX - Web services de test (STUB)'
...

De cette façon, une fois le(s) service(s) généré(s), on verra le chapitre suivant dans swagger :

Image AddedThen press Authorize button.