Plugin core

Version: Not specified

Main configuration parameters detail

runtime.ametys.public

This parameter indicates if the instance of Ametys is a public instance.

Configuration:

<param id="runtime.ametys.public" type="boolean">
<label i18n="true">PLUGINS_CORE_PUBLIC_CONFIG_LABEL</label>
<description i18n="true">PLUGINS_CORE_PUBLIC_CONFIG_DESCRIPTION</description>
<validation>
<mandatory/>
</validation>
<default-value>false</default-value>
<category i18n="true">PLUGINS_CORE_SYSTEM_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_PRIVACY_CONFIG_GROUP</group>
<order>1</order>
</param>

runtime.captcha.recaptcha.publickey

This parameter contains the recaptcha public key.

Configuration:

<param type="string" id="runtime.captcha.recaptcha.publickey">
<label i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_PUBLIC_KEY</label>
<description i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_PUBLIC_KEY_DESCRIPTION</description>
<category i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_GROUP</group>
<order>2</order>
<disable-conditions>
<condition id="runtime.captcha.type" operator="neq">recaptcha</condition>
</disable-conditions>
</param>

runtime.captcha.recaptcha.secretkey

This parameter contains the recaptcha secret key.

Configuration:

<param type="string" id="runtime.captcha.recaptcha.secretkey">
<label i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_SECRET_KEY</label>
<description i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_SECRET_KEY_DESCRIPTION</description>
<category i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_GROUP</group>
<order>3</order>
<disable-conditions>
<condition id="runtime.captcha.type" operator="neq">recaptcha</condition>
</disable-conditions>
</param>

runtime.captcha.type

This parameter contains the type of captcha in use. Default to "jcaptcha".

Configuration:

<param type="string" id="runtime.captcha.type">
<label i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_TYPE_LABEL</label>
<description i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_TYPE_DESCRIPTION</description>
<enumeration>
<entry>
<label i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_TYPE_JCAPTCHA</label>
<value>jcaptcha</value>
</entry>
<entry>
<label i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_TYPE_RECAPTCHA</label>
<value>recaptcha</value>
</entry>
</enumeration>
<default-value>jcaptcha</default-value>
<category i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_CAPTCHA_CONFIG_GROUP</group>
<order>1</order>
</param>

runtime.google-api-key

This parameter stores the google maps API key to use in javascript applications (such as the geocode widget)

Configuration:

<param id="runtime.google-api-key" type="string">
<label i18n="true">PLUGINS_CORE_GOOGLE_API_KEY</label>
<description i18n="true">PLUGINS_CORE_GOOGLE_API_KEY_DESCRIPTION</description>
<category i18n="true">PLUGINS_CORE_APPLICATIONS_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_GOOGLE_API_KEY_CONFIG_GROUP</group>
<order>1</order>
</param>

runtime.log.abnormal.time

This parameter activates the trace of process taking an abnormal time in logs

Configuration:

<param id="runtime.log.abnormal.time" type="boolean">
<label i18n="true">PLUGINS_CORE_TRACE_LOG_ABNORMAL_TIME_LABEL</label>
<description i18n="true">PLUGINS_CORE_TRACE_LOG_ABNORMAL_TIME_DESCRIPTION</description>
<validation>
<mandatory/>
</validation>
<default-value>false</default-value>
<category i18n="true">PLUGINS_CORE_SYSTEM_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_LOGGING_GROUP</group>
<order>10</order>
</param>

runtime.mail.massive.sending

When false, if allowed users with a right on a context are any connected user, no user is returned. This can be considered as a security to avoid massive mail sending by mistake. Otherwise, all users (normal behavior) are returned in this case.

Configuration:

<param id="runtime.mail.massive.sending" type="boolean">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_ANYCONNECTED_USER_RETURN_ALL_LABEL</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_ANYCONNECTED_USER_RETURN_ALL_DESCRIPTION</description>
<validation>
<mandatory/>
</validation>
<default-value>false</default-value>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_ANYCONNECTED_USER_RETURN_ALL_GROUP</group>
</param>

runtime.scheduler.datasource

This parameter contains the datasource used for the Quartz scheduler

Configuration:

<param id="runtime.scheduler.datasource" type="datasource">
<label i18n="true">PLUGINS_CORE_SCHEDULER_CONFIG_DATASOURCE_LABEL</label>
<description i18n="true">PLUGINS_CORE_SCHEDULER_CONFIG_DATASOURCE_DESCRIPTION</description>
<widget>edition.datasource-sql</widget>
<widget-params>
<param name="allowCreation">true</param>
<param name="allowPrivate">true</param>
<param name="allowInternal">true</param>
<param name="allowedDbTypes">derby,mysql,oracle,postgresql,hsqldb</param>
</widget-params>
<validation>
<custom-validator class="org.ametys.core.datasource.SQLDatabaseTypeValidator">
<mandatory/>
<allowed-dbtypes>derby,mysql,oracle,postgresql,hsqldb</allowed-dbtypes>
</custom-validator>
</validation>
<category i18n="true">PLUGINS_CORE_SCHEDULER_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_SCHEDULER_CONFIG_GROUP</group>
</param>

runtime.upload.max-size

The max size of uploaded files.

Configuration:

<param id="runtime.upload.max-size" type="long">
<label i18n="true">PLUGINS_CORE_UPLOAD_CONFIG_MAXSIZE_LABEL</label>
<description i18n="true">PLUGINS_CORE_UPLOAD_CONFIG_MAXSIZE_DESCRIPTION</description>
<validation>
<mandatory/>
</validation>
<default-value>10485760</default-value>
<category i18n="true">PLUGINS_CORE_SYSTEM_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_UPLOAD_CONFIG_GROUP</group>
<order>10</order>
</param>

smtp.mail.from

This parameter contains the "from" address used as default sender

Configuration:

<param type="string" id="smtp.mail.from">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_FROM_ADDRESS</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_FROM_ADDRESS_DESCRIPTION</description>
<validation>
<mandatory/>
<regexp>^((\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z0-9][A-Za-z0-9]+))|([^<]+<(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z0-9][A-Za-z0-9]+)>)$</regexp>
<invalidText i18n="true">PLUGINS_CORE_REGEXP_INVALID_MAIL</invalidText>
</validation>
<default-value>sender@ametys.org</default-value>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_ADDRESS_GROUP</group>
<order>1</order>
</param>

smtp.mail.host

This parameter contains the server name for sending mail

Configuration:

<param type="string" id="smtp.mail.host">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_HOST</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_HOST_DESCRIPTION</description>
<validation>
<mandatory/>
</validation>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_GROUP</group>
<order>1</order>
</param>

smtp.mail.password

This parameter contains the user's password for sending mail

Configuration:

<param type="password" id="smtp.mail.password">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_PASSWORD</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_PASSWORD_DESCRIPTION</description>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_GROUP</group>
<order>5</order>
</param>

smtp.mail.port

This parameter contains the server port for sending mail. Defaults to 25.

Configuration:

<param type="long" id="smtp.mail.port">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_PORT</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_PORT_DESCRIPTION</description>
<default-value>25</default-value>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_GROUP</group>
<order>2</order>
</param>

smtp.mail.security.protocol

This parameter contains the security protocol to be used to send e-mails. Defaults to None.

Configuration:

<param type="string" id="smtp.mail.security.protocol">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_SECURITY_LABEL</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_SECURITY_DESCRIPTION</description>
<enumeration>
<entry>
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_SECURITY_NONE</label>
<value>none</value>
</entry>
<entry>
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_SECURITY_STARTTLS</label>
<value>starttls</value>
</entry>
<entry>
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_SECURITY_TLSSSL</label>
<value>tlsssl</value>
</entry>
</enumeration>
<default-value>none</default-value>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_GROUP</group>
<order>3</order>
</param>

smtp.mail.sysadminto

This parameter contains the email address of the system administrator for alert purposes

Configuration:

<param type="string" id="smtp.mail.sysadminto">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_SYSADMINTO_ADDRESS</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_SYSADMINTO_ADDRESS_DESCRIPTION</description>
<validation>
<regexp>^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z0-9][A-Za-z0-9]+)$</regexp>
<invalidText i18n="true">PLUGINS_CORE_REGEXP_INVALID_MAIL</invalidText>
</validation>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_ADDRESS_GROUP</group>
<order>2</order>
</param>

smtp.mail.user

This parameter contains the user's login for sending mail

Configuration:

<param type="string" id="smtp.mail.user">
<label i18n="true">PLUGINS_CORE_MAIL_CONFIG_USER</label>
<description i18n="true">PLUGINS_CORE_MAIL_CONFIG_USER_DESCRIPTION</description>
<category i18n="true">PLUGINS_CORE_MAIL_CONFIG_CATEGORY</category>
<group i18n="true">PLUGINS_CORE_MAIL_CONFIG_GROUP</group>
<order>4</order>
</param>