Configuring optional settings in general.properties
In addition to the mandatory settings in general.properties, there are other settings that will improve your WorldServer experience, whether you installed WorldServer with the Windows installer or you installed it manually through Apache Tomcat 8.
| Property | Description |
|---|---|
url_of_origin |
Find this property and modify its value to include the URL to the root of the WorldServer application under the application server. For example:
This URL is used in various places in WorldServer, such as within email notifications and in translation kits. The hostname in the URL should be a host that can be resolved and that WorldServer users can access. Do not use If you do not configure this property, users will have to manually set it in their client every time they want to upload a project back to the server. |
zip_encoding | WorldServer uses UTF-8 encoding to encode file names in ZIP archives. However, some localized versions of Windows use different encodings to read ZIP archives. If the encodings do not match, the extracted file names may be corrupt. To avoid this issue, configure WorldServer to use the same encoding as your localized system. Search for the |
file_attribute_storage | By default, attachment attributes are stored in the WorldServer temp folder. You can configure WorldServer to store these wherever you want. You might not want them stored in the temp folder, because that folder gets cleaned up periodically. To configure WorldServer to store these attachments elsewhere, uncomment the
The line you should uncomment and modify is:
|
session_client_check | When you set it to As a security measure, in WorldServer 11.x, users always have to log in again if they copy the same valid URL into another browser. To enable the |
calculate_segment_length_in_bytes | This property determines whether WorldServer measures segment length in bytes or in characters. By default, the length is measured in characters. To enable length calculation in bytes, set the value of the property to
The line you should uncomment and modify is:
|
adhoc_asset_timeout | This property schedules the removal of obsolete data from your database when you create translation jobs from WorldServer Explorer. By default, this property is disabled (set at zero days). |
enable_live_translation_memory | This property allows WorldServer to operate in Live TM mode, which adds and tracks entries to the translation memory during the translation process. By default, this property is enabled. |
workbench_generate_target | This property manages the automatic generation of the target file.
By default, this property is enabled. To disable it, uncomment the following line:
|
absolute_session_timeout | This property manages the timeout of any login session.
The value of this property is expressed in seconds. For example, absolute_session_timeout=1200 means that every login session lasts only 1200 seconds (20 minutes).
You can disable this property by setting its value to |
session_timeout | This property manages the timeout of idle login sessions. The value of this property is expressed in seconds. For example,
The session timeout value you configure in the general.properties file should have the same value both in the ws-api and in the ws subfolders.
You cannot disable this property. However, to make sure that sessions almost never expire, you can set its value to a very large number such as If you set its value to |
security.password.encryption.algorithm | You can select another type of password encryption than the default PBKDF2 by configuring the security.password.encryption.algorithm=<value> property. |
ws.enforce.navigation.panel | You can enable or disable the slide-out navigation pane by setting the ws.enforce.navigation.panel parameter to true or false. Also, you must specify the URL to the new user interface as the value of the navigation.panel.url property. |
prefer_shallow_soap_objects | The By default, this property is disabled ( |
Read the comments in the general.properties file to see the entire range of available properties.
Enabling entity history
You can enable the entity history logging category, which adds information related to changes between users and groups to the task history log, by adding the following lines to the general.properties file in the ws-legacy folder:log4j.appender.history.File=<path-to-log-folder>\history.log
log4j.appender.history=org.apache.log4j.RollingFileAppender
log4j.appender.history.MaxFileSize=100000KB
log4j.appender.history.MaxBackupIndex=5
log4j.appender.history.layout=com.idiominc.ws.log.entityhistory.pattern.EntityEventPatternLayout
log4j.appender.history.layout.ConversionPattern=[%d] %E %O %u: %m%n
log4j.category.com.idiominc.ws.log.entityhistory.EntityHistoryLogger=debug, history
log4j.additivity.com.idiominc.ws.log.entityhistory=false, where E is the changed entity, O is the operation performed on the entity, and u is the user who performed the operation.
[2017-01-25 17:28:39,106] WORKGROUP_LINK DELETE (admin,1) : User 2219 was removed from workgroup 1002 [2017-01-25 17:28:39,151] ROLE_LINK DELETE (admin,1) : User 2219 was removed from workflow role 14 [2017-01-25 18:27:02,218] GROUP_LINK ADD (admin,1) : User 2125 was added to workflow role 11
ws application cannot access the legacy code base.
Enabling the stats engine
log4j.appender.stats.File=<path-to-log-folder>\stats.logand by uncommenting the following lines:
log4j.category.STATENG.EVENTS=debug, stats
log4j.additivity.STATENG.EVENTS=false
log4j.appender.stats=org.apache.log4j.RollingFileAppender
log4j.appender.stats.MaxFileSize=100000KB
log4j.appender.stats.MaxBackupIndex=5
log4j.appender.stats.layout=org.apache.log4j.PatternLayout
log4j.appender.stats.layout.ConversionPattern=[%d] %p %t %c: %m%n
where d stands for the date, p stands for the priority (such as debug, warning, error, info), t stands for the thread on which the login is performed, c stands for the category, m stands for the message displayed, and n stands for new line.
Further configurations
- Links on the WorldServer Home page.
- The way in which WorldServer is used in a cluster, with some machines serving as workflow engines and others as background processing engines.
- The URL of the reporting engine.
- Recurrence and notification engines.