Difference between revisions of "Portlet"

Revision as of 20:58, 24 November 2010

About the Portlet App

The Portlet application is built in the Application Development Framework (ADF).

Overview

The Portlet application provides a drag and drop user interface utilizing content pods to allow users the ability to build their own personalized page. Pods can be configured with predefined content or user selected content. Via RSS, pods contain external content such as news and weather feeds or by using CommonSpot's out of the box RSS feed capability content from Global Custom elements can be displayed. Each pod has properties such has dragable, editable, deletable and collapsible. These properties can be locked so pre-defined pods are locked from user control.

Requirements

ADF Library components that are required for the Portlet application:

• CEData_1_0
• CSData_1_0
• Data_1_0
• Date_1_0
• Forms_1_0
• Scripts_1_0
• CCAPI

The ADF must be configured correctly for your site. The Site Configuration (ADF.cfc) wiki page has instructions for configuration.

Contents

The Portlet application contains the following:

• Custom Coding - various components and scripts.
• CommonSpot Components:
  • Portlet App Elements
    • Portlet_Columns
    • PortletPodInstances
    • PortletPodUserData
    • ptPortlet Configuration
  • Portlet Pod Types
    • Links
    • RSS_Feeds
    • Simple_Content
    • Weather
    • Custom_File
  • Portlet Pod Content
    • Link Items (optional)
    • RSS Formatted Content

Note: Elements may contain one or more: Render Handlers or Custom Field Types. They do NOT use Display Templates.

Pre-installation Considerations

The ADF must be setup and configured on the server for the site that will be implementing the Profile application. For detailed instructions follow the ADF Overview wiki page for Site Configurations.

This installation guide assumes that you have no Custom Elements and/or Metadata Forms with the names above. Before the install, remove any Custom Elements/Metadata Forms with the names listed in the "Contents" section above. (If you do not remove existing elements with these names, you may have difficulties during the installation.)

Installation/Setup

Each of the following steps should be completed fully and in the order presented:

1. Download/Extract PT Portlet Application
2. PT Portlet ADF Configuration
3. Styles
4. Import Custom Elements
5. Site Configuration
6. Build Subsites, Templates and Pages

Known Issues/Bugs

Found a bug? View the PT Portlet Issues page. Your issue not on the list? Post it so the issue can be addressed.