ZK Configuration Reference/zk.xml

WEB-INF/zk.xml is the configuration descriptor of ZK. This file optional. If you need to configure ZK differently from the default, you could provide a file called zk.xml under the WEB-INF directory.

The root element must be <zk>. Then, you could specify any combination of the following element under the root element.

File Location

You can place zk.xml in either a WAR file or a JAR file.

WEB-INF/zk.xml

zk.xml is usually packed with a Web application and it shall be located under WEB-INF.

metainfo/zk/zk.xml

[since 3.6.0]

For library providers, zk.xml is better to be packed with a JAR file. It can be done by placing zk.xml in the metainfo/zk directory identifiable by classpath (i.e., in a JAR file).

Notice that zk.xml found in the classpath is parsed first. It means WEB-INF/zk.xml has higher priority.

List of Elements

• The richlet and richlet-mapping Elements
• The listener Element
• The log Element
• The client-config Element
• The desktop-config Element
• The xel-config Element
• The language-config Element
• The session-config Element
• The system-config Element
• The zscript-config Element
• The device-config Element
• The error-page Element
• The preference Element
• The library-property Element
  • Library Properties
• The system-property Element