... |
... |
@@ -95,11 +95,11 @@ |
95 |
95 |
|
96 |
96 |
{{table dataTypeAlpha="0" preSort="0-asc" caption="Various settings regarding the application"}} |
97 |
97 |
|= Property|= Default value|= Explanation |
98 |
|
-|bot.field.name|x-i-m-a-5536-required|Name of the hidden input field [[for detecting bots.>>doc:Formcycle.SystemSettings.ErrorMessageTemplates]] |
|
98 |
+|bot.field.name|x-i-m-a-5536-required|Name of the hidden input field [[for detecting bots>>doc:Formcycle.SystemSettings.ErrorMessageTemplates]]. Since V7, the field name is automatically renewed when the form is opened. |
99 |
99 |
|defaults.systemeinstellung.loginName|sadmin|Login name for the super administrator of the system. |
100 |
100 |
|defaults.systemeinstellung.passwort|hash(admin)|Login name for the super administrator of the system. Should be changed after installing the application. The password is stored hashed, it should not be set manually in the configuration file, but only via the user interface. |
101 |
101 |
|cluster.implementation|jgroups|The implementation used for [[clustering>>doc:Formcycle.SystemSettings.UserInterface.Cluster.WebHome]]. Allowed options are [[jgroups>>http://www.jgroups.org/||target="_blank"]] and [[shoal>>https://javaee.github.io/shoal/||target="_blank"]]. |
102 |
|
-|system.server.id {{version major="6" minor="6" patch="5"/}}|(generated)|Unique ID of the server which can be included in the HTTP header and attached to the submit URL of a form for the use of load balancers. See //HTTP//. |
|
102 |
+|system.server.id |(generated)|Unique ID of the server which can be included in the HTTP header and attached to the submit URL of a form for the use of load balancers. See //HTTP//. |
103 |
103 |
{{/table}} |
104 |
104 |
|
105 |
105 |
== Limits == |
... |
... |
@@ -131,7 +131,7 @@ |
131 |
131 |
|= Property|= Default value|= Explanation |
132 |
132 |
|ldap.override.filter.user|(~|(objectclass=user)(objectclass=person)(objectclass=inetOrgPerson)(objectclass=organizationalPerson))|LDAP filter for searching for available [[LDAP users>>doc:Formcycle.UserInterface.UserSettings.LDAP]]. By default, finds all objects with the object class {{code language="none"}}user{{/code}}, {{code language="none"}}person{{/code}}, {{code language="none"}}inetOrgPerson{{/code}}, or {{code language="none"}}organinsationalPerson{{/code}}. |
133 |
133 |
|ldap.override.filter.user.login|(~|(sAMAccountName={0})(userPrincipalName={0})(uid={0}))|LDAP-Filter for locating a user with a given login name. Specify the login name with the placeholder {{code language="none"}}{0}{{/code}}. By default, finds all users if the attribute {{code language="none"}}sAMAccountName{{/code}}, {{code language="none"}}userPrincipalName{{/code}} or {{code language="none"}}uid{{/code}} matches the login name. |
134 |
|
-|ldap.override.filter.kerberos.user {{version major="6" minor="6" patch="5"/}}|//Value of the user query see above.//|LDAP filter for searching a user after Kerberos authentication. The available login corresponds to the pattern {{code language="none"}}<username>(/<instance>)@<REALM>{{/code}} where the {{code language="none"}}/<instance>{{/code}} part is optional. Using the example {{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, the individual components are available in the corresponding filter as follows: {{code language="none"}}{0}{{/code}}={{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, {{code language="none"}}{1}{{/code}}={{code language="none"}}test/admin{{/code}}, {{code language="none"}}{2}{{/code}}={{code language="none"}}test{{/code}},{{code language="none"}}{3}{{/code}}={{code language="none"}}admin{{/code}},{{code language="none"}}{4}{{/code}}={{code language="none"}}EXAMPLE.COM{{/code}}. For example, to perform a user search within a single-domain environment with a non-standard {{code language="none"}}userPrincipalName{{/code}}, the query could be defined as follows: {{code language="none"}}(sAMAccountName={2}){{/code}} |
|
134 |
+|ldap.override.filter.kerberos.user |//Value of the user query see above.//|LDAP filter for searching a user after Kerberos authentication. The available login corresponds to the pattern {{code language="none"}}<username>(/<instance>)@<REALM>{{/code}} where the {{code language="none"}}/<instance>{{/code}} part is optional. Using the example {{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, the individual components are available in the corresponding filter as follows: {{code language="none"}}{0}{{/code}}={{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, {{code language="none"}}{1}{{/code}}={{code language="none"}}test/admin{{/code}}, {{code language="none"}}{2}{{/code}}={{code language="none"}}test{{/code}},{{code language="none"}}{3}{{/code}}={{code language="none"}}admin{{/code}},{{code language="none"}}{4}{{/code}}={{code language="none"}}EXAMPLE.COM{{/code}}. For example, to perform a user search within a single-domain environment with a non-standard {{code language="none"}}userPrincipalName{{/code}}, the query could be defined as follows: {{code language="none"}}(sAMAccountName={2}){{/code}} |
135 |
135 |
|ldap.override.filter.group|(~|(objectclass=group)(objectclass=groupofnames)(objectclass=groupofuniquenames))|LDAP filter for searching for [[LDAP groups>>doc:Formcycle.UserInterface.UserSettings.LDAPGroups]]. By default, searches for all objects with the object class {{code language="none"}}group{{/code}}, {{code language="none"}}groupofnames{{/code}}, or {{code language="none"}}groupofuniquenames{{/code}}. |
136 |
136 |
{{/table}} |
137 |
137 |
|
... |
... |
@@ -139,12 +139,11 @@ |
139 |
139 |
|
140 |
140 |
{{table dataTypeAlpha="0" preSort="0-asc" caption="Settings for HTTP requests and responses"}} |
141 |
141 |
|= Property|= Default value|= Explanation |
142 |
|
-|http.header.server.id (migrated to system.server.id as of {{version major="6" minor="6" patch="5"/}})|(empty)|Value of the HTTP header //XFC-Server-Id//. It is set on each response and identifies the {{formcycle/}} server. If this property is not set at all, a randomly generated UUID is used. If this property is empty, the header is not set. |
143 |
143 |
|http.header.referer|same-origin|The referre policy for HTTP responses. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]]. |
144 |
144 |
|http.header.hsts.max|(empty)|The value for the //max-age// of the HTTP Strict Transport Security. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]]. |
145 |
145 |
|http.header.hsts.sub|false|Whether the HTTP Strict Transport Security should be applied to sub domains as well. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]]. |
146 |
|
-|http.header.serverid.name {{version major="6" minor="6" patch="5"/}}|(not available)|Specifies the header name with which the //system.server.id// is written to all requests. If this entry exists but is empty the corresponding header will not be set. If the entry does not exist the default //XFC-Server-Id// is used. |
147 |
|
-|http.param.serverid.name {{version major="6" minor="6" patch="5"/}}|(not available)|Specifies the name of the URL parameter used to append the //system.server.id// to the form submission URL. If the value is empty or not available, no parameter will be appended. |
|
145 |
+|http.header.serverid.name |(not available)|Specifies the header name with which the //system.server.id// is written to all requests. If this entry exists but is empty the corresponding header will not be set. If the entry does not exist the default //XFC-Server-Id// is used. |
|
146 |
+|http.param.serverid.name |(not available)|Specifies the name of the URL parameter used to append the //system.server.id// to the form submission URL. If the value is empty or not available, no parameter will be appended. |
148 |
148 |
{{/table}} |
149 |
149 |
|
150 |
150 |
== Debug == |
... |
... |
@@ -160,4 +160,80 @@ |
160 |
160 |
|= Property|= Default value|= Explanation |
161 |
161 |
|cleanup.worker.active|true|Whether the system cleanup job is active and run periodically. The system clean up jobs, for example, checks for unconfirmed form records waitning for a double opt-in confirmation, and deletes them when they are expired. |
162 |
162 |
|cleanup.worker.cronexpression|0 0,15,30,45 * ? * *|The cron expression for the system clean up job that indicates when and how often that job is run. The system clean up jobs, for example, checks for unconfirmed form records waitning for a double opt-in confirmation, and deletes them when they are expired. |
|
162 |
+|quartz.threadpool.thread.count {{version major="7" minor="0" patch="10" /}}|10|The number of threads for the scheduler. Default value is 10. When set to 0, new jobs are created, but no jobs are executed. This is useful in scenarios when the jobs should be run by another server. |
|
163 |
+|quartz.scheduler.check.interval {{version major="7" minor="0" patch="10" /}}|30000|Is the amount of time in milliseconds that the scheduler will wait before re-queries for available triggers when the scheduler is otherwise idle. Normally you should not have to 'tune' this parameter, unless you’re using XA transactions, and are having problems with delayed firings of triggers that should fire immediately. Values less than 5000 ms are not recommended as it will cause excessive database querying. Values less than 1000 are not legal. |
|
164 |
+|quartz.jobstore.misfire.threshold {{version major="7" minor="0" patch="10" /}}|60000|The number of milliseconds the scheduler will 'tolerate' a trigger to pass its next-fire-time by, before being considered "misfired". The default value (if you don’t make an entry of this property in your configuration) is 60000 (60 seconds). |
163 |
163 |
{{/table}} |
|
166 |
+ |
|
167 |
+== Sending of emails == |
|
168 |
+ |
|
169 |
+{{table dataTypeAlpha="0" preSort="0-asc" caption="Settings for the sending of emails"}} |
|
170 |
+|= Eigenschaft |= Standardwert |= Beschreibung |
|
171 |
+|mail.smtp.connectiontimeout {{version major="7" minor="0" patch="4" /}}|300000|SMTP Socket connection timeout value in milliseconds. |
|
172 |
+|mail.smtp.timeout {{version major="7" minor="0" patch="4" /}}|300000|SMTP Socket I/O timeout value in milliseconds. |
|
173 |
+{{/table}} |
|
174 |
+ |
|
175 |
+== Workflow == |
|
176 |
+ |
|
177 |
+The following properties can be used to selectively enable or disable certain events or actions of the new workflow. |
|
178 |
+ |
|
179 |
+The properties for events share the following pattern: |
|
180 |
+ |
|
181 |
+{{code language="text"}} |
|
182 |
+trigger.<technical_name_of_the_event>.enable=false |
|
183 |
+{{/code}} |
|
184 |
+ |
|
185 |
+The properties for actions share the following pattern: |
|
186 |
+ |
|
187 |
+{{code language="text"}} |
|
188 |
+processing.<technical_name_of_the_action>.enable=false |
|
189 |
+{{/code}} |
|
190 |
+ |
|
191 |
+The technical event names are as follows: |
|
192 |
+ |
|
193 |
+* //fc_catch_error//: Workflow error |
|
194 |
+* //fc_doi_verified//: Double opt-in confirmed |
|
195 |
+* //fc_form_submit_button//: Technical name |
|
196 |
+* //fc_invitation_error//: Invitation failed |
|
197 |
+* //fc_invitation_sent//: Invitation sent |
|
198 |
+* //fc_manual//: Custom |
|
199 |
+* //fc_qualified_form_submit_button//: Submit button |
|
200 |
+* //fc_state_timer//: After state change |
|
201 |
+* //fc_time_point//: Date and time |
|
202 |
+ |
|
203 |
+The technical action names are as follows: |
|
204 |
+ |
|
205 |
+* //fc_change_form_availability//: Change availability |
|
206 |
+* //fc_change_form_value//: Change form values |
|
207 |
+* //fc_change_state//: Set state |
|
208 |
+* //fc_compress_as_zip//: Compress files |
|
209 |
+* //fc_copy_form_record//: Copy form record |
|
210 |
+* //fc_counter//: Change counter |
|
211 |
+* //fc_create_text_file//: Create text file |
|
212 |
+* //fc_delete_form_record//: Delete form record |
|
213 |
+* //fc_doi_init//: Send double opt-in email |
|
214 |
+* //fc_email//: Email |
|
215 |
+* //fc_empty//: Empty statement |
|
216 |
+* //fc_experiment//: Handle errors |
|
217 |
+* //fc_export_to_persistence//: Export to persistence file |
|
218 |
+* //fc_export_to_xml//: Export as XML |
|
219 |
+* //fc_fill_pdf//: Fill PDF document |
|
220 |
+* //fc_fill_word//: Fill word document |
|
221 |
+* //fc_import_form_value_from_xml//: Import from XML |
|
222 |
+* //fc_ldap_query//: LDAP query |
|
223 |
+* //fc_move_form_record_to_inbox//: Move to inbox |
|
224 |
+* //fc_multiple_condition//: Condition (Check value) |
|
225 |
+* //fc_post_request//: HTTP request |
|
226 |
+* //fc_provide_resource//: Provide file |
|
227 |
+* //fc_queue_task//: Queue custom event |
|
228 |
+* //fc_redirect//: Redirect |
|
229 |
+* //fc_renew_process_id//: Create new process ID |
|
230 |
+* //fc_return//: Stop processing chain |
|
231 |
+* //fc_return_file//: File download |
|
232 |
+* //fc_save_to_file_system//: Save to file system |
|
233 |
+* //fc_set_saved_flag//: Save |
|
234 |
+* //fc_show_template//: HTML response page |
|
235 |
+* //fc_sql_statement//: Database query |
|
236 |
+* //fc_throw_exception//: Throw error |
|
237 |
+* //fc_write_form_record_attributes//: Set server attribute |
|
238 |
+* //sequence//: Block statement |