Zimlet Developers Guide:Portal

Revision as of 17:10, 2 January 2010 by Sposetti (talk | contribs) (Enabling the Portal Feature)

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 Zdg-6-menu-icon-advanced.jpg
Advanced Concepts
Application Context
Templates
Java & JSP
Portal
Internationalization
Zdg-6-menu-icon-library.jpg API Specifications Zdg-6-menu-icon-checkbox.jpg 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:

  1. Open a terminal.
  2. Change to the zimbra user:
    su - zimbra
    
  3. Set the portal feature COS to TRUE:
    zmprov ma user@domain.com zimbraFeaturePortalEnabled TRUE
    
  4. Set the portal for the user to id "example":
    zmprov ma user@domain.com zimbraPortalName example
    

Portal Files

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 {zcs-install-dir}/jetty/webapps/zimbra/portals/{portal-id} directory.

An example portal (where id="example") is provided at:

{zcs-install-dir}/jetty/webapps/zimbra/portals/example

Portal Manifest File Reference

The following

<portal>

<portal>

Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 12/29/2009
Article ID: https://wiki.zimbra.com/index.php?title=Zimlet_Developers_Guide:Portal Date Modified: 2010-01-02



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