Difference between revisions of "Zimlet Developers Guide:Troubleshooting"

(New page: == Common Problems and Solutions == {| cellpadding="20" cellspacing="0" border="1" |style="background-color:#ffffcc;" width="15%" |'''Problem''' |Zimlet fails to deploy and FileNotFound...)
 
m (Zimlet Developers Guide: Troubleshooting)
 
(26 intermediate revisions by 5 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);"
 +
|[[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]]
 +
|[[Zimlet Developers Guide:Getting Started|Getting Started]]
 +
|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]]
 +
|
 +
    {|
 +
    |[[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'''
 +
    |}
  
== Common Problems and Solutions ==
+
|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]]
 +
|[[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]]
 +
|[[Zimlet Developers Guide:Example Zimlets|Example Zimlets]]
 +
|}
  
{| cellpadding="20" cellspacing="0" border="1"
+
== Zimlet fails to deploy ==
 +
 
 +
{| cellpadding="20" cellspacing="0" border="1" width="80%"
 
|style="background-color:#ffffcc;" width="15%" |'''Problem'''
 
|style="background-color:#ffffcc;" width="15%" |'''Problem'''
 
|Zimlet fails to deploy and FileNotFoundException in <code>{zcs-install-dir}/log/mailbox.log</code>.
 
|Zimlet fails to deploy and FileNotFoundException in <code>{zcs-install-dir}/log/mailbox.log</code>.
Line 21: Line 53:
 
<li>The Zimlet Package zip file is named <code>{zimlet-name}.zip</code></li>
 
<li>The Zimlet Package zip file is named <code>{zimlet-name}.zip</code></li>
 
</ul>
 
</ul>
 +
 +
See [[Zimlet_Developers_Guide:Developing_Zimlets#Zimlet_Definition_File|Zimlet Definition File]] for more information.
 +
|-
 
|-
 
|-
 
|style="background-color:#ffffcc;" |'''Solution #3'''
 
|style="background-color:#ffffcc;" |'''Solution #3'''
Line 28: Line 63:
 
|Check that your zimlet name is all lower case. For example "com_zimbra_helloworld" is valid. "COM_zimbra_HelloWorld" is not.
 
|Check that your zimlet name is all lower case. For example "com_zimbra_helloworld" is valid. "COM_zimbra_HelloWorld" is not.
 
|}
 
|}
 +
 +
== Cannot upgrade zimlet ==
 +
 +
{| cellpadding="20" cellspacing="0" border="1" width="80%"
 +
|style="background-color:#ffffcc;" width="15%" |'''Problem'''
 +
|Cannot upgrade Zimlet or latest changes are not shown.
 +
|-
 +
|style="background-color:#ffffcc;" |'''Solution #1'''
 +
|Uninstall (i.e. undeploy) old zimlet prior to installing new zimlet.
 +
|-
 +
|style="background-color:#ffffcc;" |'''Solution #2'''
 +
|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 [[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.
 +
 +
|-
 +
|style="background-color:#ffffcc;" |'''Solution #3'''
 +
|Flush the zimlet cache using:
 +
<pre>
 +
zmprov fc zimlet
 +
</pre>
 +
|-
 +
|style="background-color:#ffffcc;" |'''Solution #4'''
 +
|Clear the browser cache.
 +
|}
 +
 +
== Zimlet not showing up ==
 +
 +
{| cellpadding="20" cellspacing="0" border="1" width="80%"
 +
|style="background-color:#ffffcc;" width="15%" |'''Problem'''
 +
|Zimlet installed but not showing up in browser.
 +
|-
 +
|style="background-color:#ffffcc;" |'''Solution #1'''
 +
|Check the browser error console for JavaScript errors:
 +
<ul>
 +
<li>On Firefox, browse to "Tools > Error Console"</li>
 +
<li>On Internet Explorer, browse to "Tools > Internet Options" and choose "Advanced" tab. Check the "Display a notification for every script error".
 +
</ul>
 +
|-
 +
|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 [[Zimlet_Developers_Guide:Firefox and Firebug|Firefox and Firebug]] for more information.
 +
|-
 +
|style="background-color:#ffffcc;" |'''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.
 +
|}
 +
 +
 +
 +
{{Article Footer|Zimbra Collaboration Server 7.0|12/22/2009}}
 +
 +
 +
[[Category:Developers]]
 +
[[Category:Troubleshooting Zimlets]]
 +
[[Category:Zimlets]]
 +
[[Category:ZCS 7.0]]
 +
[[Category:ZCS 6.0]]

Latest revision as of 12:24, 16 July 2015

Zimlet Developers Guide: Troubleshooting

   KB 3242        Last updated on 2015-07-16  




0.00
(0 votes)


Zdg-6-menu-icon-zimbra.jpg Introduction Zdg-6-menu-icon-green-flag.png Getting Started Zdg-6-menu-icon-terminal.png Dev Environment Setup Zdg-6-menu-icon-gear.png
Developing Zimlets
Proxy Servlet Setup
Firefox and Firebug
Troubleshooting
Zdg-6-menu-icon-advanced.jpg Advanced Concepts Zdg-6-menu-icon-library.jpg API Specifications Zdg-6-menu-icon-checkbox.jpg 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:
  • The name of the Zimlet Definition File {zimlet-name}.xml
  • The Zimlet Definition File <zimlet> name attribute
  • <zimlet name={zimlet-name}” ... >
  • The Zimlet Package zip file is named {zimlet-name}.zip

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:
  • On Firefox, browse to "Tools > Error Console"
  • On Internet Explorer, browse to "Tools > Internet Options" and choose "Advanced" tab. Check the "Display a notification for every script error".
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.


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 12/22/2009
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Developers_Guide:Troubleshooting Date Modified: 2015-07-16



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search