PeopleCode API Reference Preface

This preface introduces the PeopleCode Reference PeopleBook.

PeopleCode API Reference

This PeopleBook is the reference book for the PeopleCode APIs. PeopleCode is the proprietary language used in the development of PeopleSoft applications. Its chapters describe the syntax and fundamental elements of the PeopleCode APIs.

As a licensee of PeopleTools, you are licensed to use the base portal technology, which is limited to navigation to licensed PeopleSoft applications. If you want to register additional non-PeopleSoft content, customize your homepage, or create any pagelets, you must license PeopleSoft Enterprise Portal.

The “About These PeopleBooks” preface contains general product line information, such as related documentation, common page elements, and typographical conventions. This preface also contains a glossary with useful terms that are used in PeopleBooks.

See also Enterprise PeopleTools 8.46 PeopleBook: PeopleCode Developer's Guide and Enterprise PeopleTools 8.46 PeopleBook: PeopleCode Language Reference.

PeopleCode Typographical Conventions

Throughout this book, we use typographical conventions to distinguish between different elements of the PeopleCode language, such as bold to indicate function names, italics for arguments, and so on.

Please take a moment to review the following typographical cues:

Font Type	Description
monospace font	Indicates a PeopleCode program or other example
Keyword	In PeopleCode syntax, items in keyword font indicate function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call.
Variable	In PeopleCode syntax, items in variable font are placeholders for arguments that your program must supply.
...	In PeopleCode syntax, ellipses indicate that the preceding item or series can be repeated any number of times.
{Option1\|Option2}	In PeopleCode syntax, when there is a choice between two options, the options are enclosed in curly braces and separated by a pipe.
[ ]	In PeopleCode syntax optional items are enclosed in square brackets.
&Parameter	In PeopleCode syntax an ampersand before a parameter indicates that the parameter is an already instantiated object.

About These PeopleBooks

A companion PeopleBook called About These PeopleBooks contains general information, including:

Related documentation, common page elements, and typographical conventions for PeopleBooks.
Information about using PeopleBooks and managing the PeopleBooks Library.
Information on the International Organization for Standardization (ISO) country and currency codes used within PeopleBooks.
A glossary of useful PeopleSoft terms that are used in PeopleBooks.