CBookmarks Installation and Publishing

Peter Kharchenko

Interactive Business Solutions

Table of Contents

Requirements
Directory Structure
Building CBookmarks
Deploying CBookmarks
Publishing

Requirements

The CBookmarks channel requires an existing installation of uPortal (version 2.x or later). This implies that uPortal has been installed in a servlet container environment such as Jakarta-Tomcat and that an SQL database has been deployed.

The CBookmarks channel build and deployment process requires the use of the ant application and a JDK (version 1.3 or later). As uPortal also requires the use of ant and a JDK, the installation of uPortal satisfies these requirements.

Directory Structure

The CBookmarks channel build directory checks out from the CVS repository into portal_channels/Bookmarks. The directory contains the following...

  • docs - directory containing documentation about the channel (this file).
  • src - hierarchy for the source code for the CBookmarks channel.
  • webpages/stylesheets - hierarchy which contains stylesheets for the CBookmarks channel.
  • webpages/media - hierarchy which contains images and other necessary files for the CBookmarks channel.

...and the following files

  • build.xml - build file for use by Ant.
  • build.properies - properties file for use by Ant.

Building CBookmarks

To build (compile) the CBookmarks channel into uPortal 2.0, follow these steps:

  1. Modify the deploy.home path in the build.properties file to point to your uPortal installation directory.

  2. Type “ant”

This process will only compile the CBookmarks classes and copy other necessary files into a temporary build directory. In order to publish the channel you must deploy the channel into the servlet container.

Deploying CBookmarks

To Deploy the CBookmarks channel into uPortal 2.0, follow these steps:

  1. Modify the deploy.home path in the build.properties file to point to your uPortal installation directory.

  2. Type “ant deploy”

  3. Restart your servlet container or reload the uPortal application.

You are now ready to publish the CBookmarks channel.

Publishing

  1. Connect to your uPortal site and log into an account which has publishing priviledges.

  2. Enter the uPortal channel manager by clicking on “Channel Admin”.

  3. Click “Publish a new channel” and follow through the Channel Publishing workflow screens.

  4. Channel Type:

    • Select “Custom”
    • Click “Next”.

  5. General Settings:

    • Enter a title, name, description, and timeout value.
    • Enter org.jasig.portal.channels.bookmarks.CBookmarks as the channel class.
    • Click “Next”.

  6. Channel Parameters:

    You do not need to enter channel parameters.

  7. Channel Controls:

    You do not need to select any channel controls. Click “Next”.

  8. Categories:

    Add one or more channel categories.
    • Select categories from drop down list
    • Click “Add” to select or “Go” to expand category.
    • Click “Next”.

  9. Groups:

    • If you want to restrict access to this channel, add one or more groups.
    • If you do not want to restrict access set the group to 'everyone'.
    • Click “Next”.

  10. Review:

    Confirm that you have entered all the information properly and click “Finish”.

Users should now be able to subscribe to CBookmarks!.