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é2Interface 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.
Exemple : iWorkflowModule.getConfiguration().getStringProperty(IConfiguration.ServerKeys.MAIL_BASE_URL);
| Clef | Description | Défaut | Administration |
|---|---|---|---|
| ADMIN_EMAIL | Email de l’administrateur | Messaging | |
| DEFAULT_EMAIL_SENDER | Déprécié Expéditeur SMTP, par défaut “sender=mail.smtp.from, from=mail.smtp.from” Utilisateur :
|
default | |
| FORBIDDEN_FILE_EXTENSIONS | Extensions interdites dans les champs pièces jointes, supprimé en Process2025.0.0 | ||
| 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 |
||
| MAX_FILE_SIZE | Taille maximum de pièces jointes dans les champs pièces jointes | Attachments | |
| SENDER_EMAIL | Email de l’expéditeur | Messaging | |
| SMTP_ENCODING | Déprécié, non utilisée Encodage des caractères |
||
| SMTP_HOST | Serveur SMTP | Messaging | |
| SMTP_IS_AUTHENTICATION | Est ce que la connexion SMTP a besoin d’une authentification ? | Messaging | |
| SMTP_LOGIN | Login SMTP pour l’authentification | Messaging | |
| SMTP_PASSWORD | Mot de passe SMTP pour l’authentification | Messaging | |
| SMTP_PORT | Port du serveur SMTP | 25 | Messaging |
| SMTP_PROTOCOL | Protocole SMTP (SMTP ou SMTPS) | smtp | Messaging |
| SERVER_BASE_URL | URL de base pour l’accès serveur | Parameters | |
| SUPPORTED_FILE_EXTENSIONS | Extensions supportées dans les champs pièces jointes, supprimé en Process2025.0.0 | ||
| XLS_DATE_FORMAT | Format de date pour l’export Excel | Data export | |
| XLS_LINE_LIMIT | Nombre maximum de ligne à l’export Excel (pour ne pas saturer le serveur) | Data export |
CommonKeys
L’interface IConfiguration met à disposition une sous-interface nommée CommonKeys.
Exemple : iWorkflowModule.getConfiguration().getStringProperty(IConfiguration.CommonKeys.SUPPORTED_LANGUAGES);
| Clef | Description | Défaut | Administration |
|---|---|---|---|
| SUPPORTED_LANGUAGES | Liste des langages supportés sur l’instance | fr,en,de | Translations |
| DEFAULT_LANGUAGE | Langue par défaut configurée | fr | Translations |
Surcharge dans l’administration
Clefs Process
| Clef | Description | Défaut | Administration |
|---|---|---|---|
account.mail.recipient |
Default recipient for lost account actions | noreply@yourdomain.com | Messaging |
authentication.lock.autoUnlockDuration |
Time after which a locked account will be automatically unlocked, in minutes (0 : disables automatic account unlocking) | 30 | Session > Password |
authentication.lock.captcha.tries |
Number of password/captcha tries before an account is locked (0 : unlimited, disables account locking) | 1 | Session > Password |
authentication.lock.tries |
Number of password tries before an account is locked with captcha authentication (0 : unlimited, disables account locking) | 3 | Session > Password |
authentication.lock.tries.resetTime |
Time after which the number of tries is automatically reset to 0, in minutes (0 : unlimited, disables automatic number of tries reset) | 10 | Session > Password |
authentication.lock.sysadmin |
Enable account locking for sysadmin : if set to true, sysadmin may be locked like any other user account | true | Session > Password |
authentication.password.lowercaseChars |
Password must have at least one lower case character | true | Session > Password |
authentication.password.minChars |
Minimum password length (0 : no minimum length) | 12 | Session > Password |
authentication.password.numbers |
Password must have at least one number character | true | Session > Password |
authentication.password.uppercaseChars |
Password must have at least one upper case character | true | Session > Password |
authentication.password.specialChars |
Password must have at least one special character (not a letter and not a number) | true | Session > Password |
authentication.password.reset.request.timeout |
Number of minutes the reset request generated code is valid | 5 | Session > Password |
com.axemble.directory.defaultLocalization.name |
Default localization name | Localisation par défaut | |
com.axemble.directory.defaultOrganization.name |
Default organization name | Organisation par défaut | |
com.axemble.directory.defaultProject.name |
Default project name | Projet par défaut | |
com.axemble.directory.newaccount.token.validity |
Number of hours the new account mail token is valid (0 deactivate this function) | 24 | |
com.axemble.directory.password.history |
Number of passwords stored in user history | 0 | |
com.axemble.directory.password.validity |
Number of days a password is valid (0 deactivate this function) | 0 | |
com.axemble.directory.password.alert |
Number of days to display an information message before the end of the password validity (0 deactivate this function) | 0 | |
com.axemble.easysite.defaultSite.name |
Default site name | Site web par défaut | |
com.axemble.indexing.extensions.excluded |
Excluded extensions for indexing | ||
com.axemble.security.ExternalAuthenticationAction.allowedAddresses |
ExternalAuthenticationAction authorized addresses (separate with ; or duplicate key, empty value means no filter) | 127.0.0.1 | Parameters |
com.axemble.vdoc.redirectionAllowed |
External url authorized (separate with ; or duplicate key). Protocol is mandatory. | * | Parameters |
com.vdoc.connector.aspose.number.format |
Numbers format for Aspose | 00.00# | |
com.vdoc.connector.aspose.date.format |
Dates format for Aspose | dd/MM/yyyy à HH:mm:ss | |
com.vdoc.connector.aspose.period.format |
Periods format for Aspose | dd/MM/yyyy | |
com.vdoc.connector.aspose.collection.separator |
Collections items separator for Aspose | , | |
com.vdoc.connector.aspose.conversion.authorized.extensions |
Conversion authorizes extensions for Aspose | doc, docx, docm, odt, xls, xlsx, xlsm, ods, ppt, pptx, odp, txt, rtf, jpeg, jpg, png, gif, bmp, tiff, tif | |
import.repository.log |
Log folder for imports | /WEB-INF/logs | |
import.repository.tmp |
Temporary folder for imports | /WEB-INF/tmp | |
logout.redirect.url |
URL to redirect after logout (login page if not set) | ||
portal.authentication.register.visible |
Display “Sign up” button | true | |
portal.authentication.lostPassword.visible |
Display “Forgot your password” button | true | |
profile.account.visible |
Visible fields in profile (authorized fields: login; password; lastName; firstName; email; nickName; title; zipcode; city; country; userFunction; address1; address2; timeZone; birthday; phoneNumber; mobilePhoneNumber; faxNumber; zipcode; city; country; sex; skin; configLanguage; avatar. For extended attributes, use this format: extended:attributeName |
login; email; phoneNumber; mobilePhoneNumber; organization; hierarchicalManager; skin; configLanguage; password | Parameters |
profile.account.writable |
Writable fields in profile | skin; configLanguage; password | Parameters |
profile.account.visible.by.others |
Fields visible by others in profile | userFunction; email; phoneNumber; mobilePhoneNumber; organization; hierarchicalManager | Parameters |
reportWriter.report.storage |
Folder to store reports | /WEB-INF/logs | |
services.TranslationService.translation.available_languages |
Define available languages (CommonKeys.SUPPORTED_LANGUAGES) |
fr,en,de | Translations |
services.TranslationService.translation.default_country |
Define default country for Translation service | FR | Translations |
services.TranslationService.translation.default_language |
Define default language for Translation service (CommonKeys.DEFAULT_LANGUAGE) |
fr | Translations |
services.TranslationService.translation.anonymous.force.default_language |
Define if we must force default language in anonymous mode, browser language is used otherwise | false | |
session.loginPerUser.max |
Limit the maximum number of sessions a user can open with the same login (-1 = no limit) | -1 | Session |
session.loginPerUser.action.destroySession |
If a user has reached maximum session number for a user, destroy oldest session or prohibit access to the portal (1 = destroy the session with the max Inactive Interval, 0/empty = prohibit access) | 1 | Session |
session.loginPerUser.display.anonymous |
In session administration, display anonymous user (0/empty = not display, 1 = display) | 0 | |
temp.path |
Directory temporary folder | /WEB-INF/temp | |
upload.attachment.default.forbidden-extensions |
Extensions prohibited by default | exe;pif;vbs | Attachments |
upload.attachment.default.supported-extensions |
Extensions allowed by default | doc; docx; xls; xlsx; odt; ods; odp; ppt; pptx; txt; rtf; jpeg; jpg; png; gif; bmp; tiff; tif; pdf; zip; odg; sldprt; sldasm; slddrw; slddrt; rpt; rptdesign; csv | Attachments |
vdp.default.xls.date.format |
Format de date pour l’export Excel (CommonKeys.XLS_DATE_FORMAT) |
Data export | |
vdp.default.xls.line.limit |
Nombre maximum de ligne à l’export Excel (CommonKeys.XLS_LINE_LIMIT) |
Data export |
Clefs Workplace
| Clef | Description | Défaut | Administration |
|---|---|---|---|
profile.account.visible |
Overwrite Process key | login; email; phoneNumber; mobilePhoneNumber; organization; hierarchicalManager; language; password | |
profile.account.writable |
Overwrite Process key | language; password | |
profile.account.visible.by.others |
Overwrite Process key | userFunction; email; phoneNumber; mobilePhoneNumber; organization; hierarchicalManager | |
workplace.search.WorkplaceIndexUsers.quicksearch.fields |
Quicksearch fields for users | fullName; login; userFunction | |
workplace.search.WorkplaceIndexNews.quicksearch.fields |
Quicksearch fields for news | sys_Title; Resume; Contenu | |
workplace.search.WorkplaceIndexFaqs.quicksearch.fields |
Quicksearch fields for FAQ | sys_Title; ShortAnswer; sys_Creator.fullName | |
workplace.search.WorkplaceIndexDocuments.quicksearch.fields |
Quicksearch fields for documents | createdBy; name; categories.name | |
workplace.search.WorkplaceIndexCustomers.quicksearch.fields |
Quicksearch fields for customers | Name; Label; HeadOfficeAddress.Address1; HeadOfficeAddress.Address2; HeadOfficeAddress.Address3; HeadOfficeAddress.ZipCode; HeadOfficeAddress.City; HeadOfficeAddress.Country; HeadOfficeAddress.Description; ActivityClassificationSystemCode.ClassificationSystemCode; ActivityClassificationSystemCode.Name; CustomerNumber; CompanyRegistrationNumber |
Sources :