Difference between revisions of "User:Jimmyshiau"
From Documentation
Jimmyshiau (talk | contribs) |
|||
| Line 1: | Line 1: | ||
| − | =How to report | + | =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 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). | ||
| − | :# | + | :#A sample with the steps so that the support team can reproduce the issue. |
| − | :# | + | :#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. |
| − | + | :#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 [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 | + | :*'''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.
Please provide the following information in addition to the screenshot:
- ZK version (EX: ZK 5.0.7.1 PE).
- Browser and Browser version (EX: Firefox 3.6).
- Servers (EX: JBoss 6).
- A sample with the steps so that the support team can reproduce the issue.
- 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.
- 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
2. Response
|
| Client side error |
|
If you cannot reproduce it with Firefox
Chrome
- Enable "Developer tools" by press F12
| Server side error |
1. Request
2. Response
|
| Client side error |
|
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 |
|
- Change Document mode to emulate IE6,7
- Quirks Mode: IE6
- Internet Explorer 7 Standards: IE7