From Documentation

(Difference between revisions)
Jump to: navigation, search
m (How to get Browser Performance Profile)
Line 1: Line 1:
=Getting prompt and efficient support from ZK=
=Getting prompt and efficient support from ZK=

Revision as of 07:36, 20 May 2020


Getting prompt and efficient support from ZK

When you run into 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. Instead of providing a screenshot, please follow the tips and instructions below when submitting your issue.

ZK MeetRpoblem01.png

Provide general information and reproducible samples

Please provide general information:

  1. the complete server-side error or the client-side error (if any)
  2. complete exception stack trace (if any)
  3. A runnable sample
  4. Precise and clear steps to reproduce the issue
  5. ZK version and edition
    e.g. ZK 9.0.1 PE
  6. Browser and its version
    e.g. Firefox 60
  7. If it is hard to create a sample, you can provide an URL so that the support team can access it. When providing this URL, remember to turn on the js debug in your zk.xml.
  8. Application servers (e.g. JBoss 6, if it's necessary).
  9. If your case happens only in your specific environment, it is recommended to provide a virtual machine as a copy of your actual environment. Or, request online debugging in the ticket.

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

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.

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

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


  • 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 narrow down the problem and eliminate differences caused by different environments, we often send you a sample maven project that tries to simulate and reproduce your issue. 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 if the path is incorrect, just visit http://localhost:8080. A browser will show a link with the correct context path:


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


How to get Browser Performance Profile

If you are running into a performance issue, you can first check out Step by Step Trouble Shooting and do a first step analysis using browser's developer tools.

By Chrome developer tool

By Firefox developer tool

By Edge developer tool

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