Overview
This report summarizes all configuration options useable on the project.
More information about ApplicationConfig
| Name of configuration | Description | Number of options | Number of actions |
|---|---|---|---|
| quadrige3-core-client | Configuration options for Quadrige3 client API | 31 | 9 |
| quadrige3-synchro-server | Configuration options for Quadrige :: Synchro server | 32 | 0 |
| quadrige3-core-shared | Configuration option available in Quadrige3 API (server and client) | 83 | 0 |
Detail of configurations
We give details of each configuration of the project
Configuration quadrige3-core-client
Name of configuration : quadrige3-core-client
Description : Configuration options for Quadrige3 client API
Configuration options
| Key | Description | Default Value | Can be modified | Can be saved | Type |
|---|---|---|---|---|---|
| quadrige3.config.directory | Configuration directory |
${quadrige3.basedir}/config |
No | No |
java.io.File |
| quadrige3.measurementGridPresets.directory | quadrige3.config.option.measurementGridPresets.directory.description |
${quadrige3.data.directory}/measurementGridPresets |
No | No |
java.io.File |
| quadrige3.extraction.directory | Directory for extraction filters |
${quadrige3.data.directory}/extraction |
No | No |
java.io.File |
| quadrige3.extractionConfig.directory | Directory where extraction filter configuration files are stored |
${quadrige3.data.directory}/extractionConfig |
No | No |
java.io.File |
| quadrige3.context.directory | Directory for context files |
${quadrige3.data.directory}/context |
No | No |
java.io.File |
| quadrige3.persistence.db.other.directories | quadrige3.config.option.persistence.db.other.directories.description |
${quadrige3.measurementGridPresets.directory};${quadrige3.extraction.directory};${quadrige3.extractionConfig.directory};${quadrige3.context.directory} |
No | No |
java.lang.String |
| quadrige3.update.application.url | quadrige3.config.option.update.application.url.description |
${quadrige3.site.url}/quadrige3-application.properties |
Yes | Yes |
java.lang.String |
| quadrige3.update.data.url | quadrige3.config.option.update.data.url.description |
${quadrige3.site.url}/quadrige3-data.properties |
Yes | Yes |
java.lang.String |
| quadrige3.install.db.url | quadrige3.config.option.install.db.url.description |
${quadrige3.update.data.url} |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.disabled | quadrige3.config.option.authentication.disabled.description |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.authentication.forced | Forces the authentication at application launch time |
true |
Yes | Yes |
java.lang.Boolean |
| quadrige3.authentication.mock.username | 'mock' user login |
demo |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.mock.password | 'mock' user password |
demo |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.mock.userId | 'mock' user internal identifier |
0 |
Yes | Yes |
java.lang.Integer |
| quadrige3.authentication.intranet.site.url | Intranet authentication website URL |
${quadrige3.site.url}/auth |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.intranet.site.timeout | Intranet authentication timeout |
5000 |
Yes | Yes |
java.lang.Integer |
| quadrige3.authentication.extranet.site.url | Extranet authentication website URL |
${quadrige3.site.url}/auth |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.extranet.site.timeout | Extranet authentication timeout |
5000 |
Yes | Yes |
java.lang.Integer |
| quadrige3.authentication.username | Default login |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.authentication.password | Default password |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchronization.period.enable | Activate the selection of the period to synchronize |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.synchro.zipFile.prefix | Default file prefix for database archive or temporary synchronization database |
quadrige3-db- |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.program.codes | Program codes list to synchronize (all if empty). Can be overridden by client application. |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.photo.enable.default | Enable default photo synchronization |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.synchro.photo.maxSize | Maximum size of a photo that can be imported into the system |
10000000 |
Yes | Yes |
java.lang.Long |
| quadrige3.synchro.photo.maxNumber.threshold | Threshold of the number of photos for which the warning on the synchronization time will be displayed |
100 |
Yes | Yes |
java.lang.Integer |
| quadrige3.launch.mode | Application execution mode |
No default value |
No | No |
java.lang.String |
| quadrige3.debug.mode | Activate debug mode |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.i18n.locale | Locale |
fr_FR |
Yes | Yes |
java.util.Locale |
| quadrige3.splashScreen.right.logos | List of logos to display on the right in the home screen |
logo-Ifremer.png |
Yes | Yes |
java.lang.String |
| quadrige3.splashScreen.left.logos | List of logos to display on the left in the home screen |
No default value |
Yes | Yes |
java.lang.String |
Configuration actions
| Description | Aliases | Action |
|---|---|---|
| Shows help | -h,--help | fr.ifremer.quadrige3.core.action.HelpAction#show |
| Updates the schema | --schema-update | fr.ifremer.quadrige3.core.action.DatabaseUpdateSchemaAction#run |
| Show schema status | --schema-status | fr.ifremer.quadrige3.core.action.DatabaseStatusAction#run |
| Show schema diff | --schema-diff | fr.ifremer.quadrige3.core.action.DatabaseDiffAction#run |
| Generate changelog file | --schema-changelog | fr.ifremer.quadrige3.core.action.DatabaseGenerateChangeLogAction#run |
| Create new database | --new-db | fr.ifremer.quadrige3.core.action.DatabaseNewDbAction#run |
| Import referential | --import-ref | fr.ifremer.quadrige3.synchro.action.ImportAction#importReferential |
| Import data | --import-data | fr.ifremer.quadrige3.synchro.action.ImportAction#importData |
| Import referential and data | --import | fr.ifremer.quadrige3.synchro.action.ImportAction#importReferentialAndData |
Configuration quadrige3-synchro-server
Name of configuration : quadrige3-synchro-server
Description : Configuration options for Quadrige :: Synchro server
Configuration options
| Key | Description | Default Value | Can be modified | Can be saved | Type |
|---|---|---|---|---|---|
| quadrige3.synchro.server.datasource.type | quadrige3.config.option.synchro.server.datasource.type.description |
local |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.username | quadrige3.config.option.synchro.server.jdbc.username.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.password | quadrige3.config.option.synchro.server.jdbc.password.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.schema | quadrige3.config.option.synchro.server.jdbc.schema.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.catalog | quadrige3.config.option.synchro.server.jdbc.catalog.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.url | quadrige3.config.option.synchro.server.jdbc.url.description |
jdbc:oracle:thin:@HOST:1521:SID |
No | No |
java.lang.String |
| quadrige3.synchro.server.jdbc.driver | quadrige3.config.option.synchro.server.jdbc.driver.description |
oracle.jdbc.driver.OracleDriver |
No | No |
java.lang.Class |
| quadrige3.synchro.server.hibernate.dialect | quadrige3.config.option.synchro.server.hibernate.dialect.description |
org.hibernate.spatial.dialect.oracle.OracleSpatial10gDialect |
No | No |
java.lang.Class |
| quadrige3.synchro.client.jdbc.username | quadrige3.config.option.synchro.client.jdbc.username.description |
sa |
No | No |
java.lang.String |
| quadrige3.synchro.client.jdbc.password | quadrige3.config.option.synchro.client.jdbc.password.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.client.jdbc.schema | quadrige3.config.option.synchro.client.jdbc.schema.description |
PUBLIC |
No | No |
java.lang.String |
| quadrige3.synchro.client.jdbc.catalog | quadrige3.config.option.synchro.client.jdbc.catalog.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.client.jdbc.url | quadrige3.config.option.synchro.client.jdbc.url.description |
jdbc:hsqldb:file:/tmp/quadrige3 |
No | No |
java.lang.String |
| quadrige3.synchro.client.jdbc.driver | quadrige3.config.option.synchro.client.jdbc.driver.description |
org.hsqldb.jdbcDriver |
No | No |
java.lang.Class |
| quadrige3.synchro.client.hibernate.dialect | quadrige3.config.option.synchro.client.hibernate.dialect.description |
org.hibernate.dialect.HSQLDialect |
No | No |
java.lang.Class |
| quadrige3.synchro.server.minCompatibleVersion | Minimal version required for clients, to be able to connect on server. If empty, same version as server is required. |
No default value |
Yes | Yes |
org.nuiton.version.Version |
| quadrige3.synchro.server.corePoolSize | quadrige3.synchro.server.config.option.corePoolSize.description |
${quadrige3.synchro.server.maxPoolSize} |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.server.maxPoolSize | quadrige3.synchro.server.config.option.maxPoolSize.description |
5 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.server.queueCapacity | quadrige3.synchro.server.config.option.queueCapacity.description |
50 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.server.status.timeToIdle | Sets the time to idle for an Job status before it expires, in seconds. [should be greater than one seconds - need for client] |
180 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.server.service.lazy | quadrige3.synchro.server.config.option.service.lazy.description |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.synchro.server.baseUrl | quadrige3.synchro.server.config.option.baseUrl.description |
http://localhost:8080/ |
Yes | Yes |
java.net.URL |
| quadrige3.synchro.server.security.type | quadrige3.synchro.server.config.option.security.type.description |
mock |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.server.security.ldap.baseDn | quadrige3.synchro.server.config.option.security.ldap.baseDn.description |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.server.security.ldap.url | quadrige3.synchro.server.config.option.security.ldap.url.description |
No default value |
Yes | Yes |
java.net.URL |
| quadrige3.synchro.server.security.ad.url | quadrige3.synchro.server.config.option.security.ad.url.description |
No default value |
Yes | Yes |
java.net.URL |
| quadrige3.synchro.server.security.ad.domain | quadrige3.synchro.server.config.option.security.ad.domain.description |
No default value |
Yes | Yes |
java.net.URL |
| quadrige3.synchro.server.security.mock.username | quadrige3.synchro.server.config.option.security.mock.username.description |
demo |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.server.security.mock.password | quadrige3.synchro.server.config.option.security.mock.password.description |
demo |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.server.security.mock.userId | quadrige3.synchro.server.config.option.security.mock.userId.description |
263 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.server.timezone | quadrige3.synchro.server.config.option.timezone.description |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.server.export.finalize.procedures | quadrige3.synchro.server.config.option.export.finalize.procedures.description |
No default value |
Yes | Yes |
java.lang.String |
Configuration actions
No action found for this configuration
Configuration quadrige3-core-shared
Name of configuration : quadrige3-core-shared
Description : Configuration option available in Quadrige3 API (server and client)
Configuration options
| Key | Description | Default Value | Can be modified | Can be saved | Type |
|---|---|---|---|---|---|
| quadrige3.basedir | Main directory |
${user.home}/.quadrige3 |
No | No |
java.io.File |
| quadrige3.data.directory | Date directory. You can use ${quadrige3.data.directory} property to reference it in other properties (ex: ${quadrige3.data.directory}/tmp) |
${quadrige3.basedir}/data |
No | No |
java.io.File |
| quadrige3.i18n.directory | Internationalization directory |
${quadrige3.basedir}/i18n |
No | No |
java.io.File |
| quadrige3.tmp.directory | Temporary directory (cleaned on each startup) |
${quadrige3.data.directory}/temp |
No | No |
java.io.File |
| quadrige3.persistence.db.directory | Database directory |
${quadrige3.data.directory}/db |
No | No |
java.io.File |
| quadrige3.persistence.db.attachment.directory | Attachment files directory |
${quadrige3.data.directory}/meas_files |
No | No |
java.io.File |
| quadrige3.persistence.db.photo.directory | quadrige3.config.option.persistence.db.photo.directory.description |
${quadrige3.data.directory}/photos |
No | No |
java.io.File |
| quadrige3.persistence.db.cache.directory | Database cache directory |
${quadrige3.data.directory}/dbcache |
No | No |
java.io.File |
| quadrige3.persistence.db.name | Database file name |
quadrige3 |
No | No |
java.lang.String |
| quadrige3.persistence.db.host | Hostname of database server |
No default value |
No | No |
java.lang.String |
| quadrige3.persistence.db.port | Port of database server |
No default value |
No | No |
java.lang.String |
| quadrige3.persistence.db.validation-query | Validation query used at database connection (mandatory if quadrige3.persistence.datasource.type=jndi) |
SELECT COUNT(*) FROM STATUS |
No | No |
java.lang.String |
| quadrige3.persistence.db.script | Directory for '.script' file (Mandatory for HsqlDB database) |
classpath:fr/ifremer/quadrige3/core/db/changelog/${quadrige3.persistence.dbms}/quadrige3.script |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.db.timezone | Reference timezone used in central server |
${user.timezone} |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.dbms | quadrige3.persistence.dbms.description |
hsqldb |
No | No |
java.lang.String |
| quadrige3.persistence.datasource.type | Datasource type [local,jndi] |
local |
No | No |
java.lang.String |
| quadrige3.persistence.jndi-name | Database JNDI name (mandatory, if quadrige3.persistence.datasource.type=jndi) |
quadrige3-ds |
No | No |
java.lang.String |
| quadrige3.persistence.jdbc.username | Database username |
sa |
No | No |
java.lang.String |
| quadrige3.persistence.jdbc.password | Database password |
No default value |
No | No |
java.lang.String |
| quadrige3.persistence.jdbc.url | Database connection URL |
jdbc:hsqldb:file:${quadrige3.persistence.db.directory}/${quadrige3.persistence.db.name} |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.jdbc.catalog | Database catalogue (optional) |
PUBLIC |
No | No |
java.lang.String |
| quadrige3.persistence.jdbc.schema | Database schema |
PUBLIC |
No | No |
java.lang.String |
| quadrige3.persistence.jdbc.driver | JDBC driver |
org.hsqldb.jdbcDriver |
No | No |
java.lang.Class |
| quadrige3.persistence.jdbc.batch-size | Number or lines in JDBC batch |
15 |
No | No |
java.lang.Integer |
| quadrige3.persistence.postgis.schema | quadrige3.config.option.persistence.postgis.schema.description |
postgis |
No | No |
java.lang.String |
| quadrige3.persistence.hibernate.dialect | Hibernate dialect used |
org.hibernate.dialect.HSQLDialect |
No | No |
java.lang.Class |
| quadrige3.persistence.hibernate.load.debug | Force consistency control of all constants used to fill Hibernate entities. Use to identify inconsistent constant values. |
false |
No | No |
boolean |
| quadrige3.version | Current version of Quadrige3 Core |
2.4.0 |
No | No |
org.nuiton.version.Version |
| quadrige3.site.url | Application website URL |
http://www.ifremer.fr/maven/reports/quadrige3 |
No | No |
java.net.URL |
| quadrige3.organizationName | Name of licenced organization |
Ifremer |
No | No |
java.lang.String |
| quadrige3.inceptionYear | Project inception year |
2011 |
No | No |
java.lang.Integer |
| quadrige3.enumeration.StatusCode.TEMPORARY | quadrige3.enumeration.StatusCode.TEMPORARY.description |
2 |
No | No |
java.lang.String |
| quadrige3.enumeration.StatusCode.ENABLE | quadrige3.enumeration.StatusCode.ENABLE.description |
1 |
No | No |
java.lang.String |
| quadrige3.persistence.db.backup.directory | Database backups directory |
${quadrige3.data.directory}/dbbackup |
Yes | Yes |
java.io.File |
| quadrige3.persistence.db.enumeration.resource | Properties files for configuration options for database constants. Used to override some UML model or Java constants. |
classpath*:quadrige3-db-enumerations.properties |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.hibernate.showSql | Show queries in log ? |
false |
Yes | Yes |
boolean |
| quadrige3.persistence.hibernate.useSqlComment | Add comments in generated SQL queries |
false |
Yes | Yes |
boolean |
| quadrige3.persistence.hibernate.formatSql | Format generated Hibernate queries in log |
false |
Yes | Yes |
boolean |
| quadrige3.persistence.hibernate.useSecondLevelCache | Enable second level cache ? |
false |
Yes | Yes |
boolean |
| quadrige3.persistence.hibernate.queriesFile | Queries file location |
queries-failsafe.hbm.xml |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.liquibase.should.run | Execute Liquibase patches at program startup ? |
false |
Yes | Yes |
boolean |
| quadrige3.persistence.liquibase.changelog.path | Liquibase patches script file. Can be prefixed by 'classpath:' or 'file:' |
classpath:fr/ifremer/quadrige3/core/db/changelog/${quadrige3.persistence.dbms}/db-changelog-master.xml |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.liquibase.diff.types | quadrige3.config.option.liquibase.diff.types.description |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.persistence.liquibase.output.file | Liquibase diff output file |
No default value |
Yes | Yes |
java.io.File |
| quadrige3.persistence.liquibase.output.force | Overwrite Liquibase output file |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.csv.separator | Separator character for csv file |
; |
Yes | Yes |
java.lang.String |
| quadrige3.value.separator | Separator character for values |
, |
Yes | Yes |
java.lang.String |
| quadrige3.attribute.separator | Separator character for attribute |
. |
Yes | Yes |
java.lang.String |
| quadrige3.i18n.locale | Locale |
fr_FR |
Yes | Yes |
java.util.Locale |
| quadrige3.server.port | Synchronization server port |
8888 |
Yes | Yes |
java.lang.Integer |
| quadrige3.admin.email | Administrator email (multiple emails if separated by ;) |
q2support@ifremer.fr |
Yes | Yes |
java.lang.String |
| quadrige3.synchronization.useServer | Use synchronization server ? |
true |
Yes | Yes |
java.lang.Boolean |
| quadrige3.synchronization.site.url | Synchronization server URL |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchronization.site.timeout | Maximum timeout response of synchronization |
30000 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchronization.refresh.timeout | Refresh timeout of synchronization server activity |
100 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchronization.retry.count | Number of retry attempts if connection lost (export only) |
10 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchronization.retry.timeout | Retry timeout (in milli-seconds) before a reconnection attempt |
5000 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.directory | Synchronization directory |
${quadrige3.data.directory}/synchro |
No | No |
java.io.File |
| quadrige3.synchro.zipFile.prefix | Default file prefix for database archive or temporary synchronization database |
${quadrige3.persistence.db.name}-db- |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.import.tables.data.includes | Data tables list to synchronize |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.import.tables.referential.includes | Referential tables list to synchronize |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.import.tables.rules.enable | Enable rules tables in synchronization |
true |
Yes | Yes |
boolean |
| quadrige3.synchro.import.pk.includes | Ids list (table + id) to import. Especially used to rollback local modifications during conflict resolution. |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.import.nbYearDataHistory | Amount of year of historical data to import by default |
2 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.import.data.maxRootRowCount | Maximum row number (of cluster heads, ie by SURVEY) to import before proceeding with an intermediate commit (necessary to limit the required RAM). '0' = no intermediate commit. |
-1 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.export.updateDate.offset | Time offset (in seconds) for UPDATE_DATE on data export. If positive, allow other users importing data to get the new data. |
300 |
No | No |
java.lang.Integer |
| quadrige3.synchro.export.updateDate.offset.short | Time offset (in seconds) for UPDATE_DATE on data export. |
30 |
Yes | Yes |
java.lang.Integer |
| quadrige3.synchro.export.data.file.maxUploadSize | Maximum size allowed (in bytes) for sending a single synchronization file, beyond this limit, the file is split into several parts before sending |
268435456 |
Yes | Yes |
java.lang.Long |
| quadrige3.synchro.import.updateDate.offset | Time offset (in seconds) of the last synchronization date. If negative, allow non committed data to be available sooner. |
60 |
No | No |
java.lang.Integer |
| quadrige3.synchro.import.referential.status.includes | STATUS_CD list used for referential import. (no filter if empty) |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.import.referential.transcribingItemType.label.includes | quadrige3.config.option.synchro.import.referential.transcribingItemType.label.includes.description |
No default value |
No | No |
java.lang.String |
| quadrige3.synchro.program.codes | Program codes list to synchronize (all if empty). Can be overridden by client application. |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.synchro.tempQueryParameter.generated | quadrige3.synchro.tempQueryParameter.generated.description |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.extraction.base.directory | Extraction base directory |
${quadrige3.data.directory}/extraction |
No | No |
java.io.File |
| quadrige3.extraction.sinp.directory | SINP extraction directory |
${quadrige3.extraction.base.directory}/sinp |
No | No |
java.io.File |
| quadrige3.extraction.pampa.directory | PAMPA extraction directory |
${quadrige3.extraction.base.directory}/pampa |
No | No |
java.io.File |
| quadrige3.smtp.host | SMTP server host |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.smtp.port | SMTP server port |
25 |
Yes | Yes |
java.lang.Integer |
| quadrige3.smtp.username | SMTP server login |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.smtp.password | SMTP server password |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.smtp.sender | Email sender |
No default value |
Yes | Yes |
java.lang.String |
| quadrige3.smtp.starttls.enable | Use of STARTTLS command for SMTP |
false |
Yes | Yes |
java.lang.Boolean |
| quadrige3.smtp.ssl.enable | Use of SSL protocol for SMTP |
false |
Yes | Yes |
java.lang.Boolean |
Configuration actions
No action found for this configuration