ZK Developer's Reference/How to get Efficient Support

{{ZKDevelopersReferencePageHeader}}




=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.

[[File:ZK_MeetRpoblem01.png]]
==Provide general information and reproducible samples==


=== A runnable example is the best for us ===
You can:

# Use [http://zkfiddle.org zkfiddle]
# Zip  your maven project with pom.xml and include necessary source code
# Provide zul and its related Java source
# Provide a public URL that we can visit
# 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: ===
:#ZK version and edition (e.g. ZK 5.0.7.1 PE).
:#Browser and Browser version (e.g. Firefox 3.6).
:#Servers (e.g. 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 [[#If you cannot provide a reproducible 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.

==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
<source type="xml">
<client-config>
	<debug-js>true</debug-js>
</client-config>
</source>
:As Firefox has a very useful tool Firebug, it is recommended to log your issue with [http://getfirebug.com/ firebug] (Hot-key: F12) and snapshot the following images, then send to zk support team.
{| border="1px" | width="100%" | cellspacing="0"
|-
!style="width:100px"|
!|
|-
| Server side error
|
'''1. Request'''

[[File:ZK_MeetRpoblem_FF01.png]]
----

'''2. Response'''

[[File:ZK_MeetRpoblem_FF02.png]]
|-
|Client side error
|
[[File:ZK_MeetRpoblem_FF03.png]]
----

*Click the link (the blue text) then go to the line of error. 
[[File: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.
=== Chrome ===
*Enable "Developer tools" by F12
{| border="1px" | width="100%" | cellspacing="0"
|-
!style="width:100px"|
!|
|-
| Server side error
|
'''1. Request'''

[[File:ZK_MeetRpoblem_Chrome01.png]]
----

'''2. Response'''

[[File: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. 
[[File:ZK_MeetRpoblem_Chrome03.png]]

|}

=== IE ===
*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
{| border="1px" | width="100%" | cellspacing="0"
|-
!style="width:100px"|
!|
|-
| Client side error
|
[[File:ZK_MeetRpoblem_IE01.png]]
|}

*Change '''Document mode''' to emulate IE6,7 if the issue happens only in these versions
[[File: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 [http://maven.apache.org/download.cgi download maven ] and [http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html setup] first.

# Run your command line interface
# switch to the sample project's root folder that has a <tt>pom.xml</tt>
# Start jetty server with the command below
#:  <tt>mvn jetty:run</tt>
# 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:
[[File:jettyRoot.png | center | 800px]]

Click the link and it will list folders then you can navigate to find the zul.
[[File:listFolder.png | center]]

----
If you have any feedback regarding this book, please email to info@zkoss.org



= How to get Browser Performance Profile =

== Firefox==
# visit a web page
# open firefox developer tool (pressing F12)
# click Performance tab, click "clock" icon to start recording the browser performance
# do the action
# click "clock" icon to stop
# click save to json file

[[File:firefox-performance.png | center]]


{{ZKDevelopersReferencePageFooter}}