Most of the settings are applied via termweb.properties
file which is located in TermWeb home folder.
Key | Values | Comment | ||||||
---|---|---|---|---|---|---|---|---|
Minimal required settings | ||||||||
| Absolute path to TermWeb home folder | Command-line argument. Must be specified in Java options of running process (Tomcat) via key -Dtermweb.home=/opt/twhome. See TermWeb 4 install on Windows | ||||||
| https://example.termweb.eu | In case of scheduled jobs, like sending mail digest server need to know which URL to use for current installation | ||||||
|
| Database driver. Right now supported only MySQL | ||||||
| DB user name, empty by default | Database user for connection | ||||||
| DB user password, empty by default | Database user’s password for connection | ||||||
|
| JDBC URL for DB connection, don’t delete any of additional connection parameters | ||||||
|
| Elasticsearch index name prefix used for indices created by TermWeb, see limitations on name: ES Create index API | ||||||
|
| IP address or host name of Elasticsearch server | ||||||
|
| Elasticsearch server port for connection | ||||||
|
| |||||||
|
| |||||||
| SMTP user name, empty by default | |||||||
| SMTP user password, empty by default | |||||||
System settings | ||||||||
|
| The session timeout in seconds. This value determines how long a user can be logged on to TermWeb before she is logged out due to inactivity. A negative value indicates that the sessions should never expire. A value of 0 (zero) uses the servlet engine's default value, or the value specified in web.xml for TermWeb, e.g.
Note that the web.xml timeout value is specified in minutes. | ||||||
|
| Disables the auto-login functionality of the guest account. | ||||||
|
| Applies normalization of text values in filter criteria and term sorting in term list, in order to support double-byte search. | ||||||
|
|
| ||||||
API settings | ||||||||
|
| Specifies if TermWeb and XML-RPC sessions can work simultaneously for the same user. | ||||||
|
| Set the language code to ISO2 (639-1) for the API | ||||||
|
| Indication whether automatically created users will be client admins or single users | ||||||
| Empty by default | The name of the default group where automatically created single users will belong. | ||||||
|
| Option to update an existing concept instead of creating a new one when create concept method is called via the API. Specifically, when calling createFromJSON in concept endpoint, a check is being made if at least one of the concept's terms already exist in the database, in the section the concept is supposed to be added. If it exists, then the concept gets updated instead of creating a new one. Used to avoid concept/term duplicates when adding new terms via the API. | ||||||
|
| When using web services to get a decoration for a segment, there is a limit to how many terms are included in each term search. A quick test would be to write the first word of the term you wish to see in the decoration in TermWeb search and see in the term list if the term you wish to see appears in the first page of the list. If not you need to increase this limit to make it appear. | ||||||
|
| The limit of characters where a word should be considered as a stem during decoration. | ||||||
|
| The margin of characters allowed to be different at the end of a stem during stem comparison in decoration. | ||||||
|
| Default stemmer for German language. Default value is: "org.apache.lucene.analysis.de.GermanLightStemFilterFactory" | ||||||
|
| Handles hashtag terms as normal terms. Includes them in decoration for segments that contain or not, the hashtag. | ||||||
|
|
| ||||||
File operations settings | ||||||||
| The maximum size for import file uploads in Kb. Limited by server value for file upload. | |||||||
| The maximum size for attachment uploads in Kb. Limited by server value for file upload. | |||||||
|
| Escape caret symbol in import/export (it will remove circumflex char | ||||||
Mailing settings | ||||||||
|
| The character set to be used for all mail. | ||||||
|
| |||||||
|
| The address of the sender | ||||||
| Size in Kilobytes | The maximum size for email attachments in Kb. Note that the SMTP server may be configured to use a lower max size, and emails may bounce if attachments | ||||||
| empty by default | The address of technical support to which application errors should be mailed. If omitted no mails will be sent. | ||||||
|
| Number of tries to send mail | ||||||
Security settings | ||||||||
|
| Specifies if TermWeb is allowed to run in an iframe on another page. Required by XTM integration to be enabled. | ||||||
|
| List of allowed frame ancestors to use TermWeb in iframe. | ||||||
Other settings | ||||||||
| Integer number, | Maximum page size allowed by REST API which can be requested by user. Bigger values will be changed automatically to this value. | ||||||
|
| When is set to | ||||||
|
| Used with ES autostart, path to ES installation folder | ||||||
|
| Used with ES autostart, passes argument | ||||||
|
| Used with ES autostart, Time to wait for ES instance to start and stop in seconds | ||||||
|
|
|