From Documentation

Revision as of 08:38, 19 May 2020 by Hawk (Talk | contribs)
Jump to: navigation, search


Getting prompt and efficient support from ZK

When you encounter an issue in ZK, following this document can help you to provide the support team with informative data, thus speeding up the investigation and get prompt and efficient feedback. Here is a sample screenshot of an error. However with only a screenshot, it is difficult for the support team to find enough clues and provide timely support. Please follow the tips and instructions below when submitting your issue.

ZK MeetRpoblem01.png

Provide general information and reproducible samples

A runnable example is the best for us

You can:

  1. Use zkfiddle
  2. Zip your maven project with pom.xml and include necessary source code
  3. Provide zul and its related Java source
  4. Provide a public URL that we can visit
  5. Remember to turn on the js debug in your zk.xml.

Tips for creating a reproducible example

  • Clone the original zul with the issue, remove irrelevant components
  • You could move your Java codes (mostly event listeners) into <zscript>
  • Replace your database data with static sample data in order to run without a database.

Please provide the following information:

  1. ZK version and edition (e.g. ZK 9.0.1 PE).
  2. Browser and its version (e.g. Firefox 60).
  3. A sample with the steps so that the support team can reproduce the issue.
  4. If it is not easy to come out with a sample, you can provide an URL so that the support team can access to and try to debug with it. When providing this URL, remember to turn on the js debug in your zk.xml.
  5. If your case happens only in your specific environment, it is recommended to provide a virtual machine as a copy of your actual environment.
  6. Servers (e.g. JBoss 6, if it's necessary).

If you cannot provide a reproducible sample

Snapshot the error, request and response with Browser. Remember to turn on js debug in your zk.xml

Open the developer tool (pressing F12) of your browser and snapshot the following images, then send to us.

Server side error

1. Request

ZK MeetRpoblem FF01.png

2. Response

ZK MeetRpoblem FF02.png

Client side error

ZK MeetRpoblem FF03.png

  • Click the link (the blue text) then go to the line of error.

ZK MeetRpoblem FF04.png

If you cannot reproduce it with Firefox

Some issues are browser-dependent. If the issue does not happen in your Firefox, please follow the instructions below and provide the support team with corresponding debug information.


  • Enable "Developer tools" by F12
Server side error

1. Request

ZK MeetRpoblem Chrome01.png

2. Response

ZK MeetRpoblem Chrome02.png

Client side error
  • Click the error icon in the lower right corner.
  • Click the link (test.zul:22) then go to the line where the error occurred.

ZK MeetRpoblem Chrome03.png


  • As there are less tools in IE6 and 7, it is recommended to reproduce and log the debug info with IE8 or 9.
  • With IE8 or later, enable "Developer tools" by F12
Client side error

ZK MeetRpoblem IE01.png

  • Change Document mode to emulate IE6,7 if the issue happens only in these versions

ZK MeetRpoblem IE02.png

Quirks Mode: IE6
Internet Explorer 7 Standards: IE7

How to Run a Sample Maven Project

In order to get rid of all your project's environment effect and narrow down problems, we send you a sample maven project that reproduces a case. To run the project, you need to download maven and setup first.

  1. Run your command line interface
  2. switch to the sample project's root folder that has a pom.xml
  3. Start jetty server with the command below
    mvn jetty:run
  4. Visit the project's pages with your browser.

If you don't know the zul's path or the path is incorrect, you can just visit http://localhost:8080, and the browser will show a link with correct context path:


Click the link and it will list folders then you can navigate to find the zul.


If you have any feedback regarding this book, please email to

How to get Browser Performance Profile


  1. visit a web page
  2. open firefox developer tool (pressing F12)
  3. click Performance tab, click "clock" icon to start recording the browser performance
  4. do the action
  5. click "clock" icon to stop
  6. click save to json file

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