KGS application configuration files (.cfg)

Owned by Former user (Deleted)
Last updated: May 31, 2019

Our server components can be configured via our WebGUI or via traditional configuration files.

The configuration files use the XML format.

.cfg files default location

In the default installation all configuration files are located inside the "conf" directory inside the servlet directory.

For a Apache Tomcat on Windows installation that would be:

Each software bundle in your installation has it's own directory and .cfg files.

Changing configuration files location

In case you want to change location of the .cfg files, please open the web.xml file inside the servlet folder WEB-INF and set the env-entry-value for the Parameter KGSAdminConfigDir.

   	<env-entry>
		<env-entry-name>KGSAdminConfigDir</env-entry-name>
		<env-entry-type>java.lang.String</env-entry-type>
		<env-entry-value> set path to configuration directory here </env-entry-value>
   	</env-entry>

Edit configuration files

To configure our products via the .cfg files please open them with a text editor like Notepad (Windows) or vim (Linux).

(Following an example for the KGS ContentServer)

ContentServer.cfg
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>KGS Admin Bundle Configuration</comment>

...

<entry key="Common.Backend Read Timeout (s)">0</entry>
<entry key="Common.Backend Write Timeout (s)">0</entry>
<entry key="Common.Config Directory "/>
<entry key="Common.Config File">contentserver-conf.txt</entry>
<entry key="Common.Debug">4</entry>
<entry key="Common.Disable Delete Commands">0</entry>
<entry key="Common.Force Component Return">0</entry>
<entry key="Common.Max Process Count">0</entry>
<entry key="Common.Min Process Count">0</entry>
<entry key="Common.SAPMimeExtensionLookup">false</entry>
<entry key="Common.Support MTA Documents">false</entry>
<entry key="Common.Working Directory"/>
<entry key="License.ILMLicenseKey"/>
<entry key="License.IndexLicenseKey"/>
<entry key="License.License Key"/>

...

To change the configuration just edit the values between the <entry></entry> tags.

If there is no value and no closing </entry>, just create one.

e.g. for the License Key:

change

<entry key="License.License Key"/>

to

<entry key="License.License Key">mylicensekey</entry>

Passwords and other security credentials in .cfg files

Security credentials in the .cfg files are encoded the first time our software starts and reads the configuration file.

WebGUI configuration vs .cfg file configuration

From core bundle 1.5.3

All configuration changes in the WebGUI are synced with the configuration files.

Changes in the .cfg files are active & visible in the WebGUI after a webserver restart.

core bundle 1.5.2 and older

Configuration changes in the WebGUI aren't synced with the configuration files.

Changes in the .cfg files are active & visible in the WebGUI after a webserver restart, which means everything in the .cfg file overwrites the current WebGUI configuration.

Which core bundle am i using?

Check the plugins folder inside your servlet installation, to find out which core bundle you are using

or open your WebGUI and go to "OSGi → Bundles"