This guide describes how to develop and deploy portlets, portals, and their associated components (pages, page groups, catalogs, and so on).
This book is for anyone developing portals and portlets for Sybase® Enterprise Portal.
Chapter 1, “Introduction,” introduces Enterprise Portal and explains how to get started using Portal Studio.
Chapter 2, “Managing Portal Studio Security,” describes how Enterprise Portal is integrated with Enterprise Security to implement role-based authentication in the portal.
Chapter 3, “Auditing Enterprise Portal,” explains how to set up auditing in Portal Studio for Portal Interface.
Chapter 4, “Building Portlets,” describes how to build and manage a variety of portlets.
Chapter 5, “Advanced Portlet Creation,” has advanced topics for portlet development, including creating messaging and application portlets.
Chapter 6, “Charting Portlets,” explains how to create bar, pie, and line charts from portlet contents.
Chapter 7, “Personalizing Portlet Content,” describes how to create input fields for portlet values and how users can personalize these values to fit the content they want to see.
Chapter 8, “Building Templates,” explains how to build and manage templates. Every portlet is placed on either a default HTML template, or a user-defined HTML template.
Chapter 9, “Building Catalogs,” explains how to build and manage catalogs that contain portlets. Portal Interface has one default display catalog from which users can select and add portlets to their user pages.
Chapter 10, “Building Pages,” describes how to build predefined pages, from which portal users can select.
Chapter 11, “Building Page Groups,” explains how to add pages to page groups.
Chapter 12, “Using Enterprise Portal Agents,” describes how use agents to schedule or externally trigger automatic processing of a portlet’s content.
Chapter 13, “Importing, Exporting, and Deploying Portal Objects,” explains how to copy Portal Studio objects from one Portal Studio installation to another and how to update Portal Interface with updated Portal Studio pages, catalogs, and portlets.
Chapter 14, “Creating Co-brands,” explains how to create multiple portals that can be accessed from the same Web browser and are associated with a single Enterprise Portal installation. This chapter also explains how to customize colors, images, and text for each portal.
Chapter 15, “Changing the Portal’s Look And Feel,” describes the portal’s primary configuration files and explains how to alter the look and feel of your portal.
Appendix A, “Configuring Global Properties,” lists the properties in the portal master configuration file—global.properties.xml.
Appendix B, “Using the Search Services,” describes how to integrate the search services available with Enterprise Portal into client applications and your enterprise’s portal.
Appendix C, “Setting Up Automatic Indexing and Search Functionality,” explains how to set up automatic indexing and search functionality using the portal search engine.
Appendix D, “Using the Enterprise Portal Samples,” describes how to use the samples included with Enterprise Portal.
Appendix E, “Accessing Portal Interface Content with Pocket PC,” explains how to set up a Pocket PC to view Enterprise Portal content.
Appendix F, “Troubleshooting,” provides possible solutions to common portal problems.
Enterprise Portal printed documentation The following Enterprise Portal documents are available on the Getting Started with Enterprise Portal CD:
The Enterprise Portal installation guide for your platform explains how to install the Enterprise Portal software.
The Enterprise Portal release bulletin for your platform contains last-minute information not documented elsewhere. You can also access the release bulletin from the Enterprise Portal installer.
Enterprise Portal online documentation The following Enterprise Portal documents are available in PDF and DynaText format on the Enterprise Portal 6.0 Technical Library CD:
The Enterprise Portal Developer’s Guide (this book) includes development topics for Enterprise Portal components, Portal Interface portlets, and Java Template Framework pages.
The Portal Interface User’s Guide describes the Portal Interface user interface and how to use Portal Interface to build and manage your enterprise’s portal.
The Enterprise Security Administration Guide explains Enterprise Portal security architecture and describes how to set up both basic and advanced security models in Enterprise Portal and Portal Interface.
The Enterprise Portal Administration Guide is
not being released for EP 6.0. Many functional changes have occurred
in EP 6.0, and much of the Administration Guide’s content was either
obsolete or has been incorporated into other books in the EP 6.0
documentation collection. An EP-specific administration guide may
be released at a future date with new content (for example, performance
and tuning information).
EAServer documentation EAServer is one of the applications servers into which you can install Enterprise Security, and it is included with Enterprise Portal. These EAServer documents are available in HTML format in your EAServer software installation, and in PDF and DynaText format on the EAServer Technical Library CD.
What’s New in EAServer summarizes new functionality in the latest version of EAServer.
The EAServer Feature Guide explains application server concepts and architecture, such as components, transactions, and Web applications. This book also explains how to use the optional EAServer products such as Message Bridge for Java™, Web Services Toolkit, Application Integrators, and so on.
The EAServer Programmer’s Guide explains how to create, deploy, and configure component-based applications, Web applications, Java servlets, JavaServer Pages, and how to use CORBA and Java APIs.
The EAServer System Administration Guide explains how to manage EAServer with the Jaguar Manager plug-in, create new application servers, monitor servers and application components, define connection caches, and so on.
The EAServer Security Administration and Programming Guide explains how to configure role-based security, configure SSL certificate based-security, implement custom security services for authentication, authorization and role-membership, and so on.
The EAServer Cookbook contains tutorials and explains how to use the sample applications included with your EAServer software.
The EAServer API Reference Manual contains reference pages for proprietary EAServer Java classes, ActiveX interfaces, and C routines. This document is available only online.
The EAServer Installation Guide for your platform explains how to install the EAServer software; it is available on the Getting Started CD.
The EAServer Troubleshooting Guide describes problems you may encounter running EAServer and possible solutions; it is available online—see the EAServer Troubleshooting Guide.
jConnect™ for JDBC™ documents Enterprise Portal 6.0 includes the jConnect for JDBC driver to allow JDBC access to Sybase database servers and gateways. The Programmer’s Reference jConnect for JDBC is included on the Enterprise Portal Technical Library CD.
See the Technical Library Installation Guide in
your documentation package for instructions on installing and starting
the Technical Library.
Use the Sybase Getting Started CD, the Sybase Technical Library CD and the Technical Library Product Manuals Web site to learn more about your product:
The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the Technical Library CD. It is included with your software. To read or print documents on the Getting Started CD you need Adobe Acrobat Reader (downloadable at no charge from the Adobe Web site, using a link provided on the CD).
The Technical Library CD contains product manuals and is included with your software. The DynaText reader (included on the Technical Library CD) allows you to access technical information about your product in an easy-to-use format.
Refer to the Technical Library Installation Guide in your documentation package for instructions on installing and starting the Technical Library.
The Technical Library Product Manuals Web site is an HTML version of the Technical Library CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Updates, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.
To access the Technical Library Product Manuals Web site, go to Product Manuals.
Technical documentation at the Sybase Web site is updated frequently.
Finding the latest information on product certifications
Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list and click Go.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.
Creating a personalized view of the Sybase Web
site (including support pages)
Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.
Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.
Finding the latest information on EBFs and software
updates
Point your Web browser to the Sybase Support Page.
Select EBFs/Updates. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).
Select a product.
Specify a time frame and click Go.
Click the Info icon to display the EBF/Update report, or click the product description to download the software.
The formatting conventions used in this manual are:
Formatting example |
To indicate |
|---|---|
commands and methods |
When used in descriptive text, this font indicates keywords such as:
|
variable, package, or component |
Italic font indicates:
|
File | Save |
Menu names and menu items are displayed in plain text. The vertical bar shows you how to navigate menu selections. For example, File | Save indicates “select Save from the File menu.” |
|
Monospace font indicates:
|
The variables used in this manual to represent software installation directories are:
Variable |
Represents |
|---|---|
SYBASE |
The Sybase installation directory. |
JAGUAR |
The EAServer installation directory |
SECURITY |
The Enterprise Security installation directory |
Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.
