From Documentation

Jump to: navigation, search








Property:

org.zkoss.zk.config.path
Applicable:
Dndsmalltalk-check-icon.png globally in zk.xml via <library-property>
Dndsmalltalk-cross-icon.png not as <custom-attribute>
Default: none
[since 5.0.7]

It specifies another configuration file in addition to WEB-INF/zk.xml. This is useful if you have two or more environments, such as testing and production. Then, you could put the different configuration into separate files and load the required files based on the requirement.

The value could be one of the following:

  • A servlet path, such as /WEB-INF/config/zk-extra.xml
  • A file path, such as file:///home/http/zk.xml and file:///C:/test/zk.xml, if you use Windows. Notice it must start with file://[1].
  • A URL, such as http://foo.com/config/zk.xml. Notice it must starts with http://, https://, and ftp://.

Notice that WEB-INF/zk.xml is always loaded, and it is loaded before the configuration file specified in this system property. Thus, you could put the configurations common to each environment in WEB-INF/zk.xml, and put the difference to the extra configuration file.

For example, assume you put the configuration in a file called /configs/zk-production.xml, then you could specify -Dorg.zkoss.zk.config.path=file:/configs/zk-production.xml as one of the arguments when starting the Web server.

Another example is to provide an ID generator for the testing purpose. For more information, please refer to ZK Developer's Reference: Testing Tips.


  1. For more information about the URI of a file, please refer to File URI scheme.

Version History

Last Update : 2017/5/12


Version Date Content
5.0.7 April, 2011 Introduced



Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.



Help us improve!
Let us know how we can improve this page (e.g. typo or out of date)
Not what you are looking for? Ask us in forum or contact form