Documentation Center

Delta configuration

WorldServer 11.0.1 consists of three components: the new web interface (ws), the new REST API (ws-api) and the legacy application (ws-legacy). As of WorldServer 11.0.1, a new mechanism for configuration enables you to specify the part of configuration files in different locations and their merge priority.

You need to set the WS_CONFIG system variable that will point to the configuration directory. There are 3 layers of configuration that will be merged when searching for a configuration key:
  • WS_CONFIG/<application-part-name> (where<application-part-name> is one of: ws, ws-rest, ws-legacy)
  • %WS_CONFIG%
  • classpath.

When trying to get a configuration value, the framework will search in the configuration files in the above order, returning the most specific value and ignoring the others.

Recommended configuration
  • The Tomcat application folder— the values are configured by default for all files.
  • %WS_CONFIG%/general.properties — the common general.properties. It should contain the database connection values (if you do not use Windows registry), temp_dir value, session_timeout and other configurations you want to change for the WorldServer engines. Also, this configuration should contain the navigation.panel.url = <link_to_new_ws_interface>.
  • %WS_CONFIG%/ws-api/general.properties — specific configurations for ws-api. The ws-api value should always be workflow_daemon=0 and disabled notification_engine and recurrence_engine (workflow daemon, notification_engine and recurrence_engine will only be serviced by ws-legacy) and at least one background_daemon.
  • %WS_CONFIG%/ws-legacy/general.properties — specific configurations for ws-legacy. ws-legacy should always have workflow_daemon number configured and notification_engine and recurrence_engine enabled.
  • %WS_CONFIG%/ws-api/api.properties — REST API configurations.
  • %WS_CONFIG%/ws/ui.properties — UI configurations. You must provide values for configurations: ws.legacy.url, ws.api.url, ws.api.version.
We do not recommend having specific general.properties for ws. Being decoupled from ws-legacy code, only the following configurations from general.properties will be read:
  • session_client_check
  • use_http_only_cookies
  • use_secure_urls
  • temp_file_path
  • password_autocomplete.
This is the minimal configuration that you need in order to run WorldServer. The other configuration values are set by default. If you want to customize other configuration files, we recommend putting them in %WS_CONFIG% so that ws-legacy and ws-api will be able to access it. We DO NOT recommend changing the configuration files in the classpath (the exploded war in Tomcat).