Cegid XRP Ultimate  |  
I3   Actualisé le 06/10/2022
XLinks - ETL
Thème "Paramètres"

Méthode "getIACHome()"
Méthode "getParameter(String)"
Méthode "getParameter(String, String)"
Méthode "setParameter(String, String)"
Méthode "removeParameter(String)"

   Ensemble des méthodes et macros disponibles dans le thème "Paramètres".

Méthode "getIACHome()"

Signature
File getIACHome()

Description
Récupère le répertoire correspondant au IAC_HOME du serveur de traitements (répertoire racine des composants).

Exemple :
report("IAC_HOME : [$1]", xtParam.getIACHome().getAbsolutePath());    // IAC_HOME : [/iacora]

Résultats
File - Le répertoire correspondant au IAC_HOME du serveur de traitements.

Depuis
1.0

Méthode "getParameter(String)"

Signature
void getParameter(String name)

Description
Récupère la valeur d'un paramètre applicatif. Pour mémoire, les paramètres applicatifs peuvent être positionnés :
  • Soit depuis la gestion "GPAR", pour le paramètre "QETL" ;
  • Soit depuis la gestion "GMNDQIN" pour le type "QIN" ;


Exemple :

xtParam.setParameter("test","a");
report("value of parameter [test] : [$1]", xtParam.getParameter("test"));    //value of parameter [test] : [a]

Paramètres
String name - Nom du paramètre recherché.

Résultats
String - Valeur du paramètre demandé.

Depuis
1.0

Méthode "getParameter(String, String)"

Signature
void getParameter(String name, String defaultValue)

Description
Récupère la valeur d'un paramètre applicatif. Si le paramètre n'existe pas, la valeur par défaut est retournée.
Pour mémoire, les paramètres applicatifs peuvent être positionnés :
  • Soit depuis la gestion "GPAR", pour le paramètre "QETL" ;
  • Soit depuis la gestion "GMNDQIN" pour le type "QIN" ;


Exemple :

report("value of test parameter : [$1]", xtParam.getParameter("test", "******"));    //value of test parameter : [*****]

Paramètres
String name - Nom du paramètre recherché.
String defaultValue - Valeur retournée si le paramètre n'existe pas.

Résultats
String - Valeur du paramètre demandé ou la valeur par défaut si le paramètre n'existe pas.

Depuis
1.0

Méthode "setParameter(String, String)"

Signature
void setParameter(String name, String value)

Description
Crée un paramètre applicatif ou modifie sa valeur si celui-ci existe déjà.

Exemple :

xtParam.setParameter("test","a");

report("Valeur du paramètre [test] : [$1]", xtParam.getParameter("test"));

Contenu du journal fonctionnel (compte rendu)

16:55:13 Valeur du paramètre [test] : [a]

Paramètres
String name - Nom du paramètre.
String value - Valeur à affecter.

Depuis
1.0

Méthode "removeParameter(String)"

Signature
void removeParameter(String name)

Description
Supprime le paramètre applicatif spécifié.

Exemple :
//Récupère le paramètre P1
String param1 = xtParam.getParameter("P1");

if (xtString.isNotEmpty(param1)) {
  //Affiche sa valeur
  report ("P1=[$1]", xtParam.getParameter("P1"));

  //Supprime le paramètre
  xtParam.removeParameter("P1");

  //Affiche de nouveau sa valeur
  report ("P1 (after remove) =[$1]", xtParam.getParameter("P1"));
}

Contenu du fichier journal fonctionnel (compte rendu)

16:45:10 P1=[Valeur de P1]
16:45:10 P1 (after remove) =[null]

Paramètres
String name - Nom du paramètre à supprimer.

Exceptions
XTException - Si la suppression du paramètre n'est pas possible.

Depuis
1.0