Zimlet Developers Guide:Portal
|Introduction||Getting Started||Dev Environment Setup||Developing Zimlets||
|API Specifications||Example Zimlets|
By enabling the Zimbra portal feature, a Home tab (is created that can be used as a portal landing-page in the Zimbra web client. This portal page can be configured to display zimlets as "portlets".
Enabling the Portal Feature
The portal feature can be enabled by setting the
zimbraFeaturePortalEnabled CoS to
TRUE using the
zmprov command. Additionally, you can set the portal name to be used.
To enable portal for a specific user:
- Open a terminal.
- Change to the zimbra user:
su - zimbra
- Set the portal feature COS to TRUE:
zmprov ma firstname.lastname@example.org zimbraFeaturePortalEnabled TRUE
- Set the portal for the user to id "example":
zmprov ma email@example.com zimbraPortalName example
A portal consists primarily of a
manifest.xml file that configures the portal "id" and defines which zimlets are used in the portal. The manifest also includes the base HTML layout for the portal page.
The manifest is file should be located in a directory name that matches the portal id and placed in the
An example portal (where id="example") is provided at:
Portal Manifest File Reference
The following provides a reference for the elements in the Portal Manifest File.
<portal> element is the enclosing element in the Manifest File. The
<portal> element has the following attributes:
|Attribute||Required / Optional||Range of Values||Default Value||Description|
|id||Required||A valid portal id.||N/A||The id attribute is the portal id (or "portal name") and is a required attribute. This must be the same as the directory name for the portal. For example, |
The following table describes the elements you can define within a
|Order||Element||Required / Optional||Description|
|1||portlets||Required (1 allowed)||The element that describes the portlets to be used with the portal. See <portlets> for more information.|
|2||html||Required (1 allowed)||Describes the portal layout. See <html> for more information.|