This preface includes typographical conventions used in PeopleCode and discusses the uses of this book.
This PeopleBook covers the language elements of PeopleCode, such as the built-in functions, meta-SQL, system variables, and so on. PeopleCode is the proprietary language used in the development of PeopleSoft applications. Its chapters contain reference material for the PeopleCode language.
There are two accompanying books, the PeopleCode API Reference and the PeopleCode Developer's Guide. The API reference contains information about the classes delivered with PeopleCode, for example, all the methods and properties of the rowset class, the field class, and so on. Its chapters describe the syntax and fundamental elements of this part of the PeopleCode language. The PeopleCode Developer's Guide contains conceptual information about the PeopleCode language, the PeopleCode APIs, the component processor, and so on.
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 PeopleTools 8.50 PeopleBook: PeopleCode API Reference and PeopleTools 8.50 PeopleBook: PeopleCode Developer's Guide.
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 |
|
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. |
A companion PeopleBook called PeopleBooks and the Online PeopleSoft Library contains general information, including:
Understanding the PeopleSoft online library and related documentation.
How to send PeopleSoft documentation comments and suggestions to Oracle.
How to access hosted PeopleBooks, downloadable HTML PeopleBooks, and downloadable PDF PeopleBooks as well as documentation updates.
Understanding PeopleBook structure.
Typographical conventions and visual cues used in PeopleBooks.
ISO country codes and currency codes.
PeopleBooks that are common across multiple applications.
Common elements used in PeopleBooks.
Navigating the PeopleBooks interface and searching the PeopleSoft online library.
Displaying and printing screen shots and graphics in PeopleBooks.
How to manage the PeopleSoft online library including full-text searching and configuring a reverse proxy server.
Understanding documentation integration and how to integrate customized documentation into the library.
Glossary of useful PeopleSoft terms that are used in PeopleBooks.
See Also
PeopleBooks and the PeopleSoft Online Library Preface
Accessing PeopleBooks and the PeopleSoft Online Library
Managing the PeopleSoft Online Library and PeopleBooks
Customizing the PeopleSoft Online Library
Glossary of PeopleSoft Enterprise Terms