Configuration
Clés de configuration
Niveau de définition des clés
L’interface SDK IConfiguration permet de récupérer les valeurs des clés.
La définition des clés dépend de deux aspects :
- Niveau d’accès : clés modifiables via l’interface ou uniquement sur le serveur
- Spectre : global du serveur ou plus restreint
En fonction de ces deux spectres, les clés doivent être manipulées différemment.
Niveau d’accès | Spectre | Code SDK d’exemple | Déclaration des clés |
---|---|---|---|
Interface d’administration | Global | iWorkflowModule.getConfiguration().get...UserProperty() |
Dans la configuration global du serveur, onglet “Paramètres utlisateurs” |
Interface d’administration | Groupe de processus | iCatalog.getConfiguration().get...UserProperty() |
Dans les propriétés de votre groupe de processus, onglet “Paramètres utlisateurs” |
Interface d’administration | Réservoir de données | iCatalog.getConfiguration().get...UserProperty() |
Dans les propriétés de votre réservoir de données, onglet “Paramètres utlisateurs” |
Sur le serveur | Global | iWorkflowModule.getConfiguration().get...Property() |
Dans un fichier “.properties” situé dans le dossier “custom/configuration” |
Définition des propriétés
La définition des propriétés est très simple :
clé1=propriété1
clé2=propriété2
Interface IConfiguration
Exemple : int value = iConfiguration.getIntegerUserProperty("ma.cle.entiere", 123);
Dans l’exemple ci-dessus, la valeur entière présente dans la clé est directement récupérée. Si la clé n’est pas trouvée ou qu’elle contient une valeur vide, la valeur par défaut 123 est automatiquement retournée.
ServerKeys
L’interface IConfiguration met à disposition une sous-interface nommée ServerKeys. Cette interface renvoie toutes les clefs pour les différentes informations.
Exemple : iWorkflowModule.getConfiguration().getStringProperty(IConfiguration.ServerKeys.MAIL_BASE_URL);
Clef | Description |
---|---|
SMTP_HOST | Serveur SMTP |
SMTP_PORT | Port du serveur SMTP |
ADMIN_EMAIL | Email de l’administrateur |
SENDER_EMAIL | Email de l’expéditeur |
SMTP_ENCODING | Encodage des caractères |
SMTP_PROTOCOL | Protocole SMTP (SMTP ou SMTPS) |
SMTP_IS_AUTHENTICATION | Est ce que la connexion SMTP a besoin d’une authentification ? |
SMTP_LOGIN | Login SMTP pour l’authentification |
SMTP_PASSWORD | Mot de passe SMTP pour l’authentification |
DEFAULT_EMAIL_SENDER | Déprécié Expéditeur SMTP, par défaut “sender=mail.smtp.from, from=mail.smtp.from” Utilisateur :
|
MAIL_BASE_URL | Déprécié depuis la version 18.0.0, utiliser SERVER_BASE_URL Début d’URL pour les envois d’emails |
SERVER_BASE_URL | URL de base pour l’accès serveur |
MAX_FILE_SIZE | Taille maximum de pièces jointes dans les champs pièces jointes |
SUPPORTED_FILE_EXTENSIONS | Extensions supportées dans les champs pièces jointes |
FORBIDDEN_FILE_EXTENSIONS | Extensions interdites dans les champs pièces jointes |
XLS_DATE_FORMAT | Format de date pour l’export Excel |
CommonKeys
L’interface IConfiguration met à disposition une sous-interface nommée CommonKeys.
Clef | Description |
---|---|
SUPPORTED_LANGUAGES | Liste des langages supportés sur l’instance |
DEFAULT_LANGUAGE | Langue par défaut configurée |
Sources :