How to get Efficient Support"

From Documentation
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{ZKDevelopersReferencePageHeader}}
 
{{ZKDevelopersReferencePageHeader}}
 +
 +
=Support Channel=
 +
If you are a ZK customer and your package comes with remote consulting hours, you can contact mailto:[email protected] to request technical support. Please include your Invoice Number or License Certificate number when you submit your question so that we can associate you with the right company.
 +
 +
If you do not have remote consulting hours or if you are not sure, please read [https://www.zkoss.org/wiki/Customers/FAQ#What_is_my_current_ZK_Package.3F Customer FAQ] or contact us at [email protected].
 +
 +
= [http://tracker.zkoss.org/ Issue Tracker]=
 +
If you think you encounter a bug,  you can search for the bug in [http://tracker.zkoss.org/ our tracker]. If it's a known bug, there is sometimes a workaround mentioned in the tracker. You can apply the workaround before you get the official release.
  
 
=Getting prompt and efficient support from ZK=
 
=Getting prompt and efficient support from ZK=
Line 10: Line 18:
  
 
=== The Sufficient Information Includes: ===
 
=== The Sufficient Information Includes: ===
# the complete server-side error or the client-side error if any (read [[#Get JavaScript Error]])
+
# the complete server-side error or the client-side error if any (read [[#Check JavaScript Error]])
 
# complete exception stack trace (if any)
 
# complete exception stack trace (if any)
 
# A reproducible sample (please read [[#Tips for creating a reproducible sample]]
 
# A reproducible sample (please read [[#Tips for creating a reproducible sample]]
Line 20: Line 28:
 
# 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 [https://www.zkoss.org/wiki/ZK%20Configuration%20Reference/zk.xml/The%20client-config%20Element/The%20debug-js%20Element  turn on the js debug] in your zk.xml.
 
# 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 [https://www.zkoss.org/wiki/ZK%20Configuration%20Reference/zk.xml/The%20client-config%20Element/The%20debug-js%20Element  turn on the js debug] in your zk.xml.
 
# Application servers (e.g. JBoss 6, if it's necessary).
 
# Application servers (e.g. JBoss 6, if it's necessary).
# If your case happens only in your specific environment, it is recommended to request an online meeting or provide a virtual machine as a copy of your actual environment,
+
# If your case happens only in your specific environment, it is recommended to request an online meeting or provide a virtual machine as a copy of your actual environment
 +
# anything else that can help us understand your issue better
  
 
=== Tips for creating a reproducible sample ===
 
=== Tips for creating a reproducible sample ===
Line 30: Line 39:
 
# Provide a public URL that we can visit
 
# Provide a public URL that we can visit
  
 +
Steps:
 +
1. Clone the original zul with the issue, remove irrelevant components.
 +
2. Replace your database data with static sample data in order to run without a database.
  
* Clone the original zul with the issue, remove irrelevant components
+
=== Check JavaScript Error ===
* You could move your Java codes (mostly event listeners) into <tt><zscript></tt>
 
* Replace your database data with static sample data in order to run without a database.
 
 
 
=== Get JavaScript Error ===
 
 
You can check if there is any JavaScript error by opening the developer tool.
 
You can check if there is any JavaScript error by opening the developer tool.
For example, the chrome developer tool/ Console tab
+
For example, press F12 to open the chrome developer tool/ Console tab:
  
[[File:chrome-js-error.png]]
+
[[File:chrome-js-error.png | center]]
  
 
You can extract the error message by:
 
You can extract the error message by:
Line 52: Line 60:
  
 
=== Provide ZK AU Request/Response Details ===
 
=== Provide ZK AU Request/Response Details ===
 +
# open developer tool before start to reproduce your issue
 +
# do the steps to reproduce your bug
 +
# Send request details as HAR to us
 +
#: * [https://developers.google.com/web/tools/chrome-devtools/network/reference#save-as-har Save all network requests to a HAR file in Chrome]
 +
#: * Save request details as HAR in Firefox [[File:save-har-firefox.png| center]]
 +
#: * [https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide/network Save request details as HAR in Edge]
  
:Snapshot the ''error'', ''request'' and ''response'' with Browser. Remember to''' turn on''' js debug in your zk.xml
+
If your browser doesn't support to save as HAR, or just 1 request is related, you can also send us the screenshot of AU request like:
<source type="xml">
 
<client-config>
 
<debug-js>true</debug-js>
 
</client-config>
 
</source>
 
<!--
 
Open the developer tool (pressing F12) of your browser and snapshot the following images, then send to us.
 
 
 
{| 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 ==
+
[[File:au-request.png | center]]
  
-->
+
=== Provide Related Source ===
 +
By checking your zul and Java source, we can try to simulate your case. This is better than inferring what you describe in natural language.
  
Please follow the instructions below and provide the support team with corresponding debug information.
+
= How to Include a JavaScript file =  
==== Chrome ====
+
When you need to apply a js patch or include a 3rd-party js library, you have to include the js file in your application. This section describes how you can include the js file for different scopes.
*Enable "Developer tools" by F12
 
{| border="1px" | width="100%" | cellspacing="0"
 
|-
 
!style="width:100px"|
 
!|
 
|-
 
| Server side error
 
|
 
'''1. Request'''
 
  
[[File:ZK_MeetRpoblem_Chrome01.png]]
+
== Page-Scope==
----
+
* Use the script directive [[ZUML%20Reference/ZUML/Processing%20Instructions/script | <?script?>]]
 +
* Use the script component [[ZK%20Component%20Reference/Essential%20Components/Script | <script>]]
  
'''2. Response'''
+
== Application-Scope ==
 +
If you need to include a javascript file on every zul, there are 2 ways:
  
[[File:ZK_MeetRpoblem_Chrome02.png]]
+
=== Use language addon===
|-
 
|Client side error
 
|
 
  
*Click the error icon in the lower right corner.
+
1. Put a javascript file under ZK classpath web resource path
*Click the link (test.zul:22) then go to the line where the error occurred.
+
2. Create a <code>lang-addon.xml</code>  according to [[ZK_Client-side_Reference/Language_Definition#Language_Addon | ZK Client-side Reference/Language Definition#Language_Addon]] and include the javascript file with <code><javascript></code>. For example:
[[File:ZK_MeetRpoblem_Chrome03.png]]
 
  
|}
+
<syntaxhighlight lang='xml' line highlight='4,5'>
 +
<language-addon>
 +
    <addon-name>patch-addon</addon-name><!-- give a meaningful name -->
 +
    <language-name>xul/html</language-name>
 +
    <javascript src="~./mypatch.js" />
 +
    <javascript src="/zkpatch/mypatch2.js"/>
 +
</language-addon>
 +
</syntaxhighlight>
  
==== IE ====
+
* Line 4: a path starting with <code>~./</code> is a [[ZK_Developer%27s_Reference/UI_Composing/ZUML/Include_a_Page#Classpath_Web_Resource_Path | classpath web resource path]] which is a special folder accessed by ZK
*With IE8 or later, enable "Developer tools" by F12
+
* Line 5: You can also link a file under your web application context root
{| 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
+
=== Use [[ZK_Configuration_Reference/zk.xml/The_device-config_Element/The_embed_Element | <embed>]] ===
[[File:ZK_MeetRpoblem_IE02.png]]
 
:'''Quirks Mode''': IE6
 
:'''Internet Explorer 7 Standards''': IE7
 
  
 
= How to Run a Sample Maven Project =
 
= How to Run a Sample Maven Project =
Line 140: Line 107:
  
 
# Run your command line interface
 
# Run your command line interface
# switch to the sample project's root folder that has a <tt>pom.xml</tt>
+
# switch to the sample project's root folder that has a <code>pom.xml</code>
 
# Start jetty server with the command below
 
# Start jetty server with the command below
#:  <tt>mvn jetty:run</tt>
+
#:  <code>mvn jetty:run</code>
 
# Visit the project's pages with your browser
 
# Visit the project's pages with your browser
  

Revision as of 02:56, 13 May 2022


DocumentationZK Developer's ReferenceHow to get Efficient Support
How to get Efficient Support


Support Channel

If you are a ZK customer and your package comes with remote consulting hours, you can contact mailto:[email protected] to request technical support. Please include your Invoice Number or License Certificate number when you submit your question so that we can associate you with the right company.

If you do not have remote consulting hours or if you are not sure, please read Customer FAQ or contact us at [email protected].

Issue Tracker

If you think you encounter a bug, you can search for the bug in our tracker. If it's a known bug, there is sometimes a workaround mentioned in the tracker. You can apply the workaround before you get the official release.

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 sufficient 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 us 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 Sufficient information

Providing sufficient information helps us support you more efficiently.

The Sufficient Information Includes:

  1. the complete server-side error or the client-side error if any (read #Check JavaScript Error)
  2. complete exception stack trace (if any)
  3. A reproducible sample (please read #Tips for creating a reproducible 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 request an online meeting or provide a virtual machine as a copy of your actual environment
  10. anything else that can help us understand your issue better

Tips for creating a reproducible sample

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

Steps: 1. Clone the original zul with the issue, remove irrelevant components. 2. Replace your database data with static sample data in order to run without a database.

Check JavaScript Error

You can check if there is any JavaScript error by opening the developer tool. For example, press F12 to open the chrome developer tool/ Console tab:

Chrome-js-error.png

You can extract the error message by:

  • select and copy the whole text or
  • right-click, select "Save as..."

If you cannot provide a reproducible sample

Then you can choose the following alternatives:

Provide a Public URL of Your Web Application

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.

Provide ZK AU Request/Response Details

  1. open developer tool before start to reproduce your issue
  2. do the steps to reproduce your bug
  3. Send request details as HAR to us
    * Save all network requests to a HAR file in Chrome
    * Save request details as HAR in Firefox
    Save-har-firefox.png
    * Save request details as HAR in Edge

If your browser doesn't support to save as HAR, or just 1 request is related, you can also send us the screenshot of AU request like:

Au-request.png

Provide Related Source

By checking your zul and Java source, we can try to simulate your case. This is better than inferring what you describe in natural language.

How to Include a JavaScript file

When you need to apply a js patch or include a 3rd-party js library, you have to include the js file in your application. This section describes how you can include the js file for different scopes.

Page-Scope

Application-Scope

If you need to include a javascript file on every zul, there are 2 ways:

Use language addon

1. Put a javascript file under ZK classpath web resource path 2. Create a lang-addon.xml according to ZK Client-side Reference/Language Definition#Language_Addon and include the javascript file with <javascript>. For example:

1 <language-addon>
2     <addon-name>patch-addon</addon-name><!-- give a meaningful name -->
3     <language-name>xul/html</language-name>
4     <javascript src="~./mypatch.js" />
5     <javascript src="/zkpatch/mypatch2.js"/>
6 </language-addon>
  • Line 4: a path starting with ~./ is a classpath web resource path which is a special folder accessed by ZK
  • Line 5: You can also link a file under your web application context root

Use <embed>

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:

JettyRoot.png

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

ListFolder.png

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


Last Update : 2022/05/13

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