Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this section, we will see a brief overview of the UCW Portal plugin. The UCW Portal plugin is a JAR file that has a mandatory plugin descriptor and some optional Java classes and templates such as velocity. The velocity templates are used to render the HTML pages associated with the plugin.

The plugin descriptor, the only mandatory part of a plugin, is an XML file which must be named nsys-plugin.xml. The file is located at the root of the plugin. The nsys-plugin.xml file defines the various modules in a plugin. It has the similar structure as daemon plugin. The difference is in the kind of modules which are available only for the portal.

 

Suppose you have a Dashboard and Dashboard Gadget module in the plugin, it will look as follows:

Code Block
languagexml
themeRDark
titlensys-plugin.xml
linenumberstrue
<dashboard key="ucw-dashboard_dashboard" name="UCW Dashboard">
    <description>This dashboard provides an overview about UCW Dashboard.</description>
    <label>UCW Dashboard</label>
    <viewId>ucw-dashboard</viewId>
    <imageUri>${portalResourcesUrl}/resources/images/ucw_logo.png</imageUri>
    <actionButtons>ucw.tutorial.dashboard.header.actions</actionButtons>
</dashboard>

<dashboard-gadget key="ucw-dashboard_data-measurement-gadget1" name="Data Measurement Gadget # 1" class="com.unitycloudware.portal.tutorial.dashboard.gadget.DataMeasurementGadget">
    <description>Provides information about data measurement.</description>
    <label>Data Measurement</label>
    <column>left</column>
    <order>0</order>
    <view>ucw-dashboard</view>
</dashboard-gadget>


List of available plugin modules can be found here and for UCW platform specific here.