Preface

The Technical Reference Guide provides detailed information on the Sun Java^TM System Portal Server technical concepts (such as Display Profile, Rewriter), command line utilities, tag libraries (in the software), and files (such as templates and JSPs). Use this book in conjunction with the other books in the Portal Server documentation set (see Books in This Documentation Set.)

Who Should Use This Book

The Technical Reference Guide is intended for use by administrators and individuals responsible for:

Administering and configuring the Portal Server software

Customizing pieces of the software

Readers should have admin-level permissions to the software. This guide is not intended for end users.

Administrators and individuals using this guide must be familiar with basic Solaris™ administrative procedures and must understand the following technologies:

Lightweight Directory Access Protocol (LDAP)

Java™ technology

JavaServer Pages™ (JSP™) technology

Hypertext Transfer Protocol (HTTP)

Hypertext Markup Language (HTML)

Extensible Markup Language (XML)

Before You Read This Book

Portal Server is a component of Sun Java Enterprise System, a software infrastructure that supports enterprise applications distributed across a network or Internet environment. You should be familiar with the documentation provided with Sun Java Enterprise System, which can be accessed online at http://docs.sun.com/coll/entsys_05q1.

Because the Portal Server software components work together with Sun Java^TM System Access Manager for user, service, and policy management and authentication, single sign-on, and logging services, you should be familiar with the documentation provided with that product. Access Manager software documentation can be accessed online at http://docs.sun.com/doc.

Because Sun Java^TM System Directory Server is used as the data store for primary configuration information and user profile data in a Portal Server deployment, you should be familiar with the documentation provided with that product. Directory Server software documentation can be accessed online at http://docs.sun.com/coll/DirectoryServer_05q1.

How This Book Is Organized

The first chapter of this book provides an overview of the entire Portal Server product. The rest of the book is divided into parts; each part includes multiple chapters detailing a concept. The following table summarizes the various parts of this book.

Table 0-1 How This Book Is Organized
Part Title	Part Description
Part I, "Attributes"	Describes the various attributes in the Portal Server software.
Part II, "Command Line Utilities"	Describes the various command line utilities in the Portal Server software.
Part III, "Configuration Files"	Describes properties in the properties file for the Desktop and Search service.
Part IV, "Display Profile"	Describes the display profile document, objects, priorities, merge semantics, and properties.
Part V, "Desktop JavaServer Pages"	Describes the various JSPs installed in the default and sampleportal directories.
Part VI, "Rewriter"	Describes the supported URLs and provide background information on defining rules and rulesets.
Part VII, "Sample Portal"	Describes the software Sample Portal and its associated containers and themes. The sample portal is an authentication-less desktop that consists of of sample containers, channels, portlets, services, and templates which demonstrates the Portal Server software’s capabilities.
Part VIII, "Search Engine Robot"	Describes the Search engine robot and its application functions. The Search Engine robot is included to discover, convert, and summarize document resources. Users can then locate or browse content contained in the database.
Part IX, "Desktop Tag Library"	Describes the tag libraries used by the Desktop and Search service.
Part X, "Desktop Templates"	Describes the Desktop templates installed in the default and sampleportal directories.

Conventions Used in This Book

The tables in this section describe the conventions used in this book.

Typographic Conventions

The following table describes the typographic changes used in this book.

Table 2 Typographic Conventions
Typeface	Meaning	Examples
AaBbCc123 (Monospace)	API and language elements, HTML tags, web site URLs, command names, file names, directory path names, onscreen computer output, sample code.	Edit your.login file. Use ls -a to list all files. % You have mail.
AaBbCc123 (Monospace bold)	What you type, when contrasted with onscreen computer output.	% su Password:
AaBbCc123 (Italic)	Book titles, new terms, words to be emphasized. A placeholder in a command or path name to be replaced with a real name or value.	Read Chapter 6 in the User’s Guide. These are called class options. Do not save the file. The file is located in the install-dir/bin directory.

Symbols

The following table describes the symbol conventions used in this book.

Table 3 Symbol Conventions
Symbol	Description	Example	Meaning
[ ]	Contains optional command options.	ls [-l]	The -l option is not required.
{ \| }	Contains a set of choices for a required command option.	-d {y\|n}	The -d option requires that you use either the y argument or the n argument.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
>	Indicates menu item selection in a graphical user interface.	File > New > Templates	From the File menu, choose New. From the New submenu, choose Templates.

Default Paths and File Names

The following table describes the default paths and file names used in this book.

Table 0-4 Default Paths and File Names
Term	Description
PortalServer-base	Represents the base installation directory for Sun Java System Portal Server software. The Portal Server software default base installation and product directory depends on your specific platform: Solaris™ systems: /opt/SUNWps
AccessManager-base	Represents the base installation directory for Sun Java System Access Manager software. The Access Manager software default base installation and product directory depends on your specific platform: Solaris™ systems: /opt/SUNWam
DirectoryServer-base	Represents the base installation directory for Sun Java System Directory Server software. The Directory Server software default base installation is /var/opt/mps/serverroot.
ApplicationServer-base	Represents the base installation directory for Sun Java^TM System Application Server software. The Application Server software default base installation is /opt/SUNWappserver8.
WebServer-base	Represents the base installation directory for Sun Java^TM System Web Server software. The Web Server software default base installation is /opt/SUNWwbsvr.
PortalServer-ContentFiles	Represents the directory where JSPs, templates and property files, and tag libraries are installed. By default, this is /etc/opt/SUNWps.
PortalServer-SEdb	Represents the Portal Server software Search Engine database. By default, this is /var/opt/SUNWps.

Shell Prompts

The following table describes the shell prompts used in this book.

Table 5 Shell Prompts
Shell	Prompt
C shell on UNIX or Linux	machine-name%
C shell superuser on UNIX or Linux	machine-name#
Bourne shell and Korn shell on UNIX or Linux	$
Bourne shell and Korn shell superuser on UNIX or Linux	#
Windows command line	C:\

Table 0-6 Books in This Documentation Set
Book Title	Description
Portal Server Administration Guide http://docs.sun.com/db/doc/817-7691	Describes how to administer the Portal Server software using the administration console and the command line.
Portal Server Secure Remote Access Administration Guide http://docs.sun.com/db/doc/817-7693	Describes how to administer Portal Server Secure Remote Access software.
Sun Java System Portal Server Desktop Customization Guide http://docs.sun.com/db/doc/817-7694	Describes how to customize the Portal Server software Desktop.
Portal Server Developer’s Guide http://docs.sun.com/db/doc/817-7695	Describes how to extend the Portal Server software APIs.
Portal Server Deployment Planning Guide http://docs.sun.com/db/doc/817-7697	Describes how to plan for and deploy Portal Server software.
Portal Server Migration Guide http://docs.sun.com/db/doc/817-7698	Describes how to migrate from previous releases of the Portal Server software to this release.

Contacting Sun Technical Support

If you have technical questions about this product that are not answered in the product documentation, go to http://www.sun.com/service/contacting.

Related Third-Party Web Site References

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions.

To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document. For example, the title of this book is Sun Java System 6 2005Q1 Technical Reference Guide and the part number is 817-7696.

Previous Contents Index Next