Portlets are compact objects used to display a wide range of commonly accessed information on a single screen. They are normally configured at the top level of the application or the top level of a space and form the basis of a work area which highlights key information, they can however be added to any Item in the application.
Portlet objects intelligently position themselves on the screen. A Member simply specifies the order of the Portlets and they draw themselves on the screen left to right, top to bottom according to the available space. Each Portlet has a set of properties which define what the Portlet displays, these are described below.
Portlets
- Activities
- Displays internal and external Items which have been shared with you.
Properties
- Title
- The text to be displayed in the Portlet title bar.
- Display
- How the Items are to be displayed: List, Icons, List With Big Icons, List With Small Icons.
- Show Internal
- Show all (top level) Items in the Members internal space.
- Show External
- Show all shared Items outside the current location.
- Combine
- Combine the internal and external items into the one set.
- Bookmark
- Allows a Member to easily create Link items in the folder the portlet is added to. The portlet displays a "bookmarklet" to the Member which can be copied to the toolbar of the browser. This bookmarklet can then be used to create Link items in the Folder.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Calendar
- Displays all Events from the application in which the Member is a participant and all the Tasks assigned to the Member.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Create Icon
- Displays a form which allows the Member to create an Item anywhere in the application. The Member must have Create permissions on the parent item.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Parent Item
- The Node ID of the parent item where the new Item will be created. To obtain the ID, browse to the Parent Item, edit the Item and take note of the ID value in the URL displayed in your web browser (e.g. http://www.webserver.com/nodeEdit.asp?id=1234).
- Type
- The typoe of Item to be created.
- Redirect Type
- Where the page is redirected to once the new Item has been created: Parent, Received, Custom. Parent redirects back to the original page containing the Portlet. Received displays a intermediate page in the application that displays a custom message (Received response) with links to the location where the Item is created and back to the portlet. Custom allows the specification of a specified URL.
- Custom Redirect
- When the Redirect Type is set to Custom, this is the URL applied to the Custom Redirect.
- Title
- When the Redirect Type is set to Received, this is the custom message displayed on the Received Page.
- Events
- Displays all Events in the application that the Member is a participant of.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Display
- How the Items are to be displayed: List, Icons, List With Big Icons, List With Small Icons.
- Page Size
- The number of Items per page.
- Groups
- Displays groups that the Member owns and external groups which the Member belongs to.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Invite
- Displays a link to an ivitation page where an email can be sent to other people inviting them to join the application.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Latest Members
- Displays the user's recent contacts.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Latest Messages
- Displays a list of messages that have been sent to the Member.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Show Received Alerts
- Shows received Email Alerts.
- Show Received Notifications
- Shows received Notifications.
- Show Received Signups
- Shows recieved Signups.
- Show Received Newsletter Mailouts
- Shows received Newsletters.
- Show Received Password Reminders
- Shows received Password Reminders.
- Show Received Invitations
- Shows received Invitations.
- Show Received Event Replies
- Shows received Event Replies.
- Show Received Contacts
- Shows received Contacts.
- Show Received
- Shows messages that have been received by you.
- Show Sent
- Shows messages that have been sent by you.
- Shared Items
- Displays items which have been shared with you beneath the current location. Similar the Activities portlet, but only deals with a discete set of shared Items beneath the current location.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Slideshow
- Displays a picture slideshow for jpg, gif and png files in the current Folder.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Email
- Displays the contents of a POP3 inbox. Links for each mail then launches a new email window where the user can manage (list, view, delete, compose, send) their email.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Email
- The Email Address.
- POP3 Server
- The address of the POP3 server.
- POP3 Port
- The port number of the POP3 server (default is 110).
- Username
- The username for the email account.
- Password
- The password for the email account.
- SMTP Server
- The address of the SMTP (outgoing) email server. Required if sending email through the portlet. Note that many ISPs will block connections to their outgoing SMTP servers from computers outside of their network.
- SMTP Port
- The port number of the SMTP server (default is 25).
- Page Size
- The number of items per page.
- HTML
- Displays HTML. The HTML can be selected from several templates or can be custom made.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Custom HTML
- If the Template type is set to Custom, this HTML source code is displayed in the Portlet.
- Template
- Predefined Templates including:
- Custom - use the HTML source code in the Custom HTML field.
- Google - search using www.google.com site.
- Google News - search using the news.google.com site.
- Google Images - search using the images.google.com site.
- Google Maps - search using the maps.google.com site.
- Google Maps Local - seach businesses using the maps.google.com site.
- Google UK - search using the www.google.co.uk site.
- Google Maps UK - search using the maps.google.co.uk site.
- Google Maps Local UK - search businesses using the maps.google.co.uk site.
- Google Translate - translate text using the translate.google.com site.
- Yahoo - search using the www.yahoo.com site.
- Multimap - search using the www.multimap.com site.
- Amazon - search using the www.amazon.com site.
- Amazon UK - search using the www.amazon.co.uk site.
- Feed
- Displays an RSS (0.91, 1.0, 2.0) or Atom channel.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Preset Feeds
- A list of predefined common RSS feeds.
- Custom URL
- When the Preset Feeds option is set to Custom, this is the URL of the feed displayed.
- Max Items
- The maximum number of items to display from the feed.
- Age
- The maximum age in minutes of the cache. RSS feeds are internally cached, the feed is refreshed if it is older than this time.
- Render Style
- Defines how the items are displayed: Verical or Hozizontal.
- Show Feed Info
- Shows the feed title and description.
- Show Item Description
- Shows the description of each of the items.
- Transform
- Transforms an XML file (located by a URL) to HTML by an XSL file (located by a URL). Allows caching of the result for efficiency.
This portlet takes an XML file available at a URL and transforms it with an XSLT file also available at a URL. The source XML and resulting HTML can be cached for a certain period of minutes. Caching allows the portlet to return the HTML more quickly as the web server doesn't have to retrieve the XML document everytime a portlet is viewed. The portlet comes with a number of preset XSL transformation files. This means that you do not have to write your own XSL files and put them on a website if one from the list is appropriate. If you have an XSL file that you think would be helpful for other users please contact Sosius and we might be able to include it as a preset file.
Properties - Title
- The text to be displayed in the Portlet title bar.
- Source XML URL
- The URL of the source XML document that will be transformed.
- Preset XSL Stylesheets
- The preset XSL documents. If you would like to use a custom XSL then select "Custom" and fill in the "Custom XSL URL" field below.
- Custom XSL URL
- The URL of the custom XSL document that will do the transformation.
- Age
- The age in minutes of the cache. The minimum allowed value is 30 mins.
- Params
- This is an advanced feature which allows you to pass parameters into the XSL stylesheet. In order for them to work the stylesheet must have the parameters defined like so, <xsl:param name="paramName">paramDefault</xsl:param>. You can specify the parameters in the form by seperating the name and value with an "=" and by placing each pair on a new line. The Amazon Web Service preset stylesheet accepts "dev-tag-value" and "tag-value" parameters.