Preface

The preface explains:

• The structure of the PeopleBook you are reading.

• Common elements that are used in the PeopleBook, if applicable.

• Additional resources.

Getting Started With…

(Optional) This chapter discusses product implementation guidelines. It explains:

• The business processes that are documented within the book.

• Integrations between the product being discussed and other products.

• A high-level overview of how the documentation maps to the overall implementation process; it doesn't offer step-by-step guidance on how to perform an actual implementation.

Setup and Implementation

This can be one or more chapters. These chapters contain documentation to assist you in setting up and implementing the product. For example, if functionality X is part of a product, these chapters explain how to set up functionality X, not necessarily how to use functionality X. The corresponding business process chapters explain how to use the functionality.

Note. A small amount of business process information might be included in a setup chapter if the amount of business process documentation is insufficient to require a separate section in the book.

Business Process

This can be one or more chapters in the application PeopleBooks. These chapters contain documentation that addresses specific business processes, with each chapter generally devoted to a specific functional area. For example, if functionality X is part of a product, these chapters explain how the functionality works, not necessarily how to set up functionality X. The corresponding setup and implementation chapters explain how to set up the functionality.

Note. A small amount of setup and implementation information might be included in a business process chapter if the amount of setup and implementation documentation is insufficient to require a separate chapter in the book.

Appendixes

(Optional) One or more appendixes might be included in the book. Appendixes contain information that is supplemental to the primary documentation.

Delivered Workflow Appendix

(Optional) The delivered workflow appendix describes all of the workflows that are delivered with the application.

Note. Not all applications have delivered workflows.

Reports Appendix

(Optional) This appendix contains an abbreviated list of all of the product's reports. The detailed documentation on the use of these reports usually appears in the related business process chapters.

Bold

Indicates PeopleCode function names, business function names, event names, system function names, method names, language constructs, and PeopleCode reserved words that must be included literally in the function call.

Italics

Indicates field values, emphasis, and PeopleSoft or other book-length publication titles. In PeopleCode syntax, italic items are placeholders for arguments that your program must supply.

Italics also identify references to words or letters, as in the following example: Enter the letter O.

Key+Key

Indicates a key combination action. For example, a plus sign (+) between keys means that you must hold down the first key while you press the second key. For Alt+W, hold down the Alt key while you press the W key.

Monospace font

Indicates a PeopleCode program or other code example.

" " (quotation marks)

Indicate chapter titles in cross-references and words that are used differently from their intended meanings.

. . . (ellipses)

Indicate that the preceding item or series can be repeated any number of times in PeopleCode syntax.

{ } (curly braces)

Indicate a choice between two options in PeopleCode syntax. Options are separated by a pipe ( | ).

[ ] (square brackets)

Indicate optional items in PeopleCode syntax.

& (ampersand)

When placed before a parameter in PeopleCode syntax, an ampersand indicates that the parameter is an already instantiated object.

Ampersands also precede all PeopleCode variables.

As of Date

The last date for which a report or process includes data.

Business Unit

An ID that represents a high-level organization of business information. You can use a business unit to define regional or departmental units within a larger organization.

Description

Enter up to 30 characters of text.

Effective Date

The date on which a table row becomes effective; the date that an action begins. For example, to close out a ledger on June 30, the effective date for the ledger closing would be July 1. This date also determines when you can view and change the information. Pages or panels and batch processes that use the information use the current row.

Once, Always, and Don't Run

Select Once to run the request the next time the batch process runs. After the batch process runs, the process frequency is automatically set to Don't Run.

Select Always to run the request every time the batch process runs.

Select Don't Run to ignore the request when the batch process runs.

Process Monitor

Click to access the Process List page, where you can view the status of submitted process requests.

Report Manager

Click to access the Report List page, where you can view report content, check the status of a report, and see content detail messages (which show you a description of the report and the distribution list).

Request ID

An ID that represents a set of selection criteria for a report or process.

Run

Click to access the Process Scheduler request page, where you can specify the location where a process or job runs and the process output format.

SetID

An ID that represents a set of control table information, or TableSets. TableSets enable you to share control table information and processing options among business units. The goal is to minimize redundant data and system maintenance tasks. When you assign a setID to a record group in a business unit, you indicate that all of the tables in the record group are shared between that business unit and any other business unit that also assigns that setID to that record group. For example, you can define a group of common job codes that are shared between several business units. Each business unit that shares the job codes is assigned the same setID for that record group.

Short Description

Enter up to 15 characters of text.

User ID

An ID that represents the person who generates a transaction.