Difference between revisions of "User:Jimmyshiau"

From Documentation
Line 1: Line 1:
=How to report a ZK issue=
+
=How to report an ZK issue=
 +
When you encounter an issue in ZK, following this document can help you to provide the support team with informative data, thus speedup the resolving time. 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.
 
[[File:ZK_MeetRpoblem01.png]]
 
[[File:ZK_MeetRpoblem01.png]]
*Please provide the following information:
+
Please provide the following information in addition to the screenshot:
 
:#ZK version (EX: ZK 5.0.7.1 PE).
 
:#ZK version (EX: ZK 5.0.7.1 PE).
 
:#Browser and Browser version (EX: Firefox 3.6).
 
:#Browser and Browser version (EX: Firefox 3.6).
 
:#Servers (EX: JBoss 6).
 
:#Servers (EX: JBoss 6).
:#Reproducing Sample if possible.
+
:#A sample with the steps so that the support team can reproduce the issue.
:#Steps.
+
:#If it is not easy to come out 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 [[#Cannot extracting the issue to a reproducing sample | turn on]] the js debug in your zk.xml.
:#A website for ZK support team to access the page, and try to debug on the website  if possible, remember to [[#Cannot extracting the issue to a reproducing sample | turn on]] the js debug in your zk.xml.
+
:#If your case happens only in your specific environment, it is recommended to provide a virtual machine as a copy of your actual environment.
:#A VM with server and source code for debug  if possible. we can start the server in the VM, and debug the source code.
 
  
* How to create reproducing sample:
+
Tips for creating samples:
 +
Code snippet is not as useful as runnable samples when debugging an issue. Please follow these tips to create runnable samples.
 
:*Use [http://books.zkoss.org/wiki/ZK_Jet ZK Jet] extracting ZK 5 widget tree to a ZUL file (i.e., snapshot the browser into a ZUL file)
 
:*Use [http://books.zkoss.org/wiki/ZK_Jet ZK Jet] extracting ZK 5 widget tree to a ZUL file (i.e., snapshot the browser into a ZUL file)
:*'''Replace''' you data (EX: from database) with '''dummy data''' for run the reproducing sample.
+
:*'''Replace''' you DB data with 'dummy data' and make it a runnable sample.
  
  

Revision as of 08:57, 6 September 2011

How to report an ZK issue

When you encounter an issue in ZK, following this document can help you to provide the support team with informative data, thus speedup the resolving time. 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. ZK MeetRpoblem01.png Please provide the following information in addition to the screenshot:

  1. ZK version (EX: ZK 5.0.7.1 PE).
  2. Browser and Browser version (EX: Firefox 3.6).
  3. Servers (EX: JBoss 6).
  4. A sample with the steps so that the support team can reproduce the issue.
  5. If it is not easy to come out 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.
  6. If your case happens only in your specific environment, it is recommended to provide a virtual machine as a copy of your actual environment.

Tips for creating samples: Code snippet is not as useful as runnable samples when debugging an issue. Please follow these tips to create runnable samples.

  • Use ZK Jet extracting ZK 5 widget tree to a ZUL file (i.e., snapshot the browser into a ZUL file)
  • Replace you DB data with 'dummy data' and make it a runnable sample.


If you cannot provide a reproducible sample

  • Snapshot the error, request and response with Browser. remember to turn on the js debug in your zk.xml
<client-config>
	<debug-js>true</debug-js>
</client-config>
  • Using Firefox with firebug (enable firebug by press F12) to snapshot the following images, then mail to zk support team.
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

Chrome

  • Enable "Developer tools" by press 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 right-bottom corner.
  • Click the link (test.zul:22) then go to the line of error.

ZK MeetRpoblem Chrome03.png

IE

  • Due to IE6, 7 cannot check error line, we need to reproduce with IE8 or 9.
  • Enable "Developer tools" by press F12
Client side error

ZK MeetRpoblem IE01.png

  • Change Document mode to emulate IE6,7

ZK MeetRpoblem IE02.png

Quirks Mode: IE6
Internet Explorer 7 Standards: IE7