Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Introduction

As with XX-9311, plugins (that is any jar file placed in sipXconfig classpath - share/java/sipXecs/sipXconfig) can contribute with own menu items and pages to admin interface.

...

- add plugin Tapestry page class underĀ org.sipfoundry.sipxconfig.siteweb.plugin package

- add Tapestry page specification, page template and properties files under "plugin" directory inside jar file

...

------ sipxconfig

-------- siteweb

---------- plugin

------------ PluginTestPage.class

...

Code Block
<span jwcid="pluginMainMenu@Block">
  <li>
    <div class="roundedMainSectionBoxTopLeft"></div><div class="roundedMainSectionBoxTopRight"></div>
    <div class="roundedMainSectionBoxInside">
      <a class="heading"><span key="menu.plugin">Plugin Menu</span></a>
      <ul>
        <li><a jwcid="@PageLink" page="plugin/PluginTestPage">Menu1</a></li>
      </ul>
    </div>
  </li>
</span>

Plugin sample

The attached Eclipse project can be used to build a custom plugin - it contains a plugin page and plugin menu items samples and should be imported in the same workspace with the rest of sipXconfig projects. For deploying the plugin Right Click on project name, choose Export > Java > JAR file and on the Select the export destination specify INSTALL_DIR/share/java/sipXecs/sipXconfig/plugin.jar. Restart sipXconfig process in order to consider the plugin.
Plugin PluginProj.zip

For a quick demo you can copy the jar file below and restart sipXconfig:

plugin.jar