Zimlet Developers Guide:Troubleshooting: Difference between revisions
No edit summary |
|||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{BC|Community Sandbox}} | |||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
= Zimlet Developers Guide: Troubleshooting = | |||
{{KB|{{Unsupported}}|{{ZCS 8.0}}|{{ZCS 7.0}}|}} | |||
{{Archive}} | |||
{| cellspacing="0" cellpadding="5" style="border: 1px solid rgb(153, 153, 170); margin: 0pt 0.5em 0.5em 0pt; float: none; background-color: rgb(249, 249, 255);" | {| cellspacing="0" cellpadding="5" style="border: 1px solid rgb(153, 153, 170); margin: 0pt 0.5em 0.5em 0pt; float: none; background-color: rgb(249, 249, 255);" | ||
|[[Image:zdg-6-menu-icon-zimbra.jpg|20px]] | |[[Image:zdg-6-menu-icon-zimbra.jpg|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Introduction|Introduction]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-green-flag.png|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-green-flag.png|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Getting Started|Getting Started]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-terminal.png|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-terminal.png|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Dev Environment Setup|Dev Environment Setup]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-gear.png|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-gear.png|20px]] | ||
| | | | ||
{| | {| | ||
|[[ | |[[Zimlet Developers Guide:Developing Zimlets|Developing Zimlets]] | ||
|- | |- | ||
|[[ | |[[Zimlet Developers Guide:Proxy Servlet Setup|Proxy Servlet Setup]] | ||
|- | |- | ||
|[[ | |[[Zimlet Developers Guide:Firefox and Firebug|Firefox and Firebug]] | ||
|- | |- | ||
|'''Troubleshooting''' | |'''Troubleshooting''' | ||
Line 19: | Line 26: | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-advanced.jpg|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-advanced.jpg|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Advanced Concepts|Advanced Concepts]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-library.jpg|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-library.jpg|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Zimlet API Specifications|API Specifications]] | ||
|style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-checkbox.jpg|20px]] | |style="border-left: 1px solid rgb(153, 153, 170);"|[[Image:zdg-6-menu-icon-checkbox.jpg|20px]] | ||
|[[ | |[[Zimlet Developers Guide:Example Zimlets|Example Zimlets]] | ||
|} | |} | ||
== Zimlet fails to deploy == | |||
{| cellpadding="20" cellspacing="0" border="1" width="80%" | {| cellpadding="20" cellspacing="0" border="1" width="80%" | ||
Line 47: | Line 54: | ||
</ul> | </ul> | ||
See [[ | See [[Zimlet_Developers_Guide:Developing_Zimlets#Zimlet_Definition_File|Zimlet Definition File]] for more information. | ||
|- | |- | ||
|- | |- | ||
Line 69: | Line 76: | ||
|Be sure the zimlet version number as specified in the Zimlet Definition File and Zimlet Configuration File <code>version</code> attribute is higher than the older zimlet. | |Be sure the zimlet version number as specified in the Zimlet Definition File and Zimlet Configuration File <code>version</code> attribute is higher than the older zimlet. | ||
See [[ | See [[Zimlet_Developers_Guide:Zimlet Definition File Reference|Zimlet Definition File Reference]] and [[Zimlet_Developers_Guide:Zimlet Configuration File Reference|Zimlet Configuration File Reference]] for more information. | ||
|- | |- | ||
Line 96: | Line 103: | ||
|- | |- | ||
|style="background-color:#ffffcc;" |'''Solution #2''' | |style="background-color:#ffffcc;" |'''Solution #2''' | ||
|Make sure you do not have any <code>debugger</code> or <code>console.log()</code> statements in your zimlet. See [[ | |Make sure you do not have any <code>debugger</code> or <code>console.log()</code> statements in your zimlet. See [[Zimlet_Developers_Guide:Firefox and Firebug|Firefox and Firebug]] for more information. | ||
|- | |- | ||
|style="background-color:#ffffcc;" |'''Solution #3''' | |style="background-color:#ffffcc;" |'''Solution #3''' |
Latest revision as of 12:24, 16 July 2015
Zimlet Developers Guide: Troubleshooting
- This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
Introduction | Getting Started | Dev Environment Setup |
|
Advanced Concepts | API Specifications | Example Zimlets |
Zimlet fails to deploy
Problem | Zimlet fails to deploy and FileNotFoundException in {zcs-install-dir}/log/mailbox.log .
|
Summary | The Zimlet failed to deploy and the zimlet definition file {zimlet-name}.xml could not be found in the zimlet package.
|
Solution #1 | Check that your zimlet ZIP package has the zimlet content at the top-level (i.e. directly in the ZIP). |
Solution #2 | Check that your zimlet name matches in the following locations:
<zimlet name={zimlet-name}” ... >
See Zimlet Definition File for more information. |
Solution #3 | If you create your zimlet ZIP archive on a Mac and use the “Compress” feature from the Mac UI, additional Mac-specific files (e.g. directory __MACOSX/* ) are added to the ZIP. Either remove these files manually or use the “zip” command line instead of Compress.
|
Solution #4 | Check that your zimlet name is all lower case. For example "com_zimbra_helloworld" is valid. "COM_zimbra_HelloWorld" is not. |
Cannot upgrade zimlet
Problem | Cannot upgrade Zimlet or latest changes are not shown. |
Solution #1 | Uninstall (i.e. undeploy) old zimlet prior to installing new zimlet. |
Solution #2 | Be sure the zimlet version number as specified in the Zimlet Definition File and Zimlet Configuration File version attribute is higher than the older zimlet.
See Zimlet Definition File Reference and Zimlet Configuration File Reference for more information. |
Solution #3 | Flush the zimlet cache using:
zmprov fc zimlet |
Solution #4 | Clear the browser cache. |
Zimlet not showing up
Problem | Zimlet installed but not showing up in browser. |
Solution #1 | Check the browser error console for JavaScript errors:
|
Solution #2 | Make sure you do not have any debugger or console.log() statements in your zimlet. See Firefox and Firebug for more information.
|
Solution #3 | Check that your zimlet is enabled. In the Zimbra Web Client, browser to the Preferences tab. Click on the Zimlets section and confirm your zimlet is checked. |